| #!/bin/bash |
| |
| # ============LICENSE_START=============================================== |
| # Copyright (C) 2020 Nordix Foundation. All rights reserved. |
| # ======================================================================== |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # ============LICENSE_END================================================= |
| # |
| |
| # This is a script that contains container/service management functions and test functions for RICSIM A1 simulators |
| |
| RIC_SIM_HTTPX="http" |
| RIC_SIM_HOST=$RIC_SIM_HTTPX"://"$LOCALHOST_NAME |
| RIC_SIM_PORT=$RIC_SIM_INTERNAL_PORT |
| |
| |
| #Vars for A1 interface version and container count |
| G1_A1_VERSION="" |
| G2_A1_VERSION="" |
| G3_A1_VERSION="" |
| G4_A1_VERSION="" |
| G5_A1_VERSION="" |
| G1_COUNT=0 |
| G2_COUNT=0 |
| G3_COUNT=0 |
| G4_COUNT=0 |
| G5_COUNT=0 |
| |
| |
| ########################### |
| ### RIC Simulator functions |
| ########################### |
| |
| use_simulator_http() { |
| echo -e $BOLD"RICSIM protocol setting"$EBOLD |
| echo -e " Using $BOLD http $EBOLD towards the simulators" |
| RIC_SIM_HTTPX="http" |
| RIC_SIM_HOST=$RIC_SIM_HTTPX"://"$LOCALHOST_NAME |
| RIC_SIM_PORT=$RIC_SIM_INTERNAL_PORT |
| echo "" |
| } |
| |
| use_simulator_https() { |
| echo -e $BOLD"RICSIM protocol setting"$EBOLD |
| echo -e " Using $BOLD https $EBOLD towards the simulators" |
| RIC_SIM_HTTPX="https" |
| RIC_SIM_HOST=$RIC_SIM_HTTPX"://"$LOCALHOST_NAME |
| RIC_SIM_PORT=$RIC_SIM_INTERNAL_SECURE_PORT |
| echo "" |
| } |
| |
| # Start one group (ricsim_g1, ricsim_g2 .. ricsim_g5) with a number of RIC Simulators using a given A interface |
| # 'ricsim' may be set on command line to other prefix |
| # args: ricsim_g1|ricsim_g2|ricsim_g3|ricsim_g4|ricsim_g5 <count> <interface-id> |
| # (Function for test scripts) |
| start_ric_simulators() { |
| |
| echo -e $BOLD"Starting $RIC_SIM_DISPLAY_NAME"$EBOLD |
| |
| if [ $RUNMODE == "KUBE" ]; then |
| |
| # Check if app shall be fully managed by the test script |
| __check_included_image "RICSIM" |
| retcode_i=$? |
| |
| # Check if app shall only be used by the testscipt |
| __check_prestarted_image "RICSIM" |
| retcode_p=$? |
| |
| if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then |
| echo -e $RED"The $1 app is not included as managed nor prestarted in this test script"$ERED |
| echo -e $RED"The $1 will not be started"$ERED |
| exit |
| fi |
| if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then |
| echo -e $RED"The $1 stub app is included both as managed and prestarted in this test script"$ERED |
| echo -e $RED"The $1 will not be started"$ERED |
| exit |
| fi |
| |
| if [ $retcode_p -eq 0 ]; then |
| echo -e " Using existing $1 statefulset and service" |
| echo " Using existing simulator deployment and service for statefulset $1" |
| echo " Setting $1 replicas=$2" |
| __kube_scale statefulset $1 $KUBE_NONRTRIC_NAMESPACE $2 |
| echo "" |
| return |
| fi |
| fi |
| |
| RIC1=$RIC_SIM_PREFIX"_g1" |
| RIC2=$RIC_SIM_PREFIX"_g2" |
| RIC3=$RIC_SIM_PREFIX"_g3" |
| RIC4=$RIC_SIM_PREFIX"_g4" |
| RIC5=$RIC_SIM_PREFIX"_g5" |
| |
| if [ $# != 3 ]; then |
| ((RES_CONF_FAIL++)) |
| __print_err "need three args, $RIC1|$RIC2|$RIC3|$RIC4|$RIC5 <count> <interface-id>" $@ |
| exit 1 |
| fi |
| |
| echo " $2 simulators using basename: $1 on interface: $3" |
| #Set env var for simulator count and A1 interface vesion for the given group |
| if [ $1 == "$RIC1" ]; then |
| G1_COUNT=$2 |
| G1_A1_VERSION=$3 |
| elif [ $1 == "$RIC2" ]; then |
| G2_COUNT=$2 |
| G2_A1_VERSION=$3 |
| elif [ $1 == "$RIC3" ]; then |
| G3_COUNT=$2 |
| G3_A1_VERSION=$3 |
| elif [ $1 == "$RIC4" ]; then |
| G4_COUNT=$2 |
| G4_A1_VERSION=$3 |
| elif [ $1 == "$RIC5" ]; then |
| G5_COUNT=$2 |
| G5_A1_VERSION=$3 |
| else |
| ((RES_CONF_FAIL++)) |
| __print_err "need three args, $RIC1|$RIC2|$RIC3|$RIC4|$RIC5 <count> <interface-id>" $@ |
| exit 1 |
| fi |
| |
| if [ $RUNMODE == "KUBE" ]; then |
| |
| if [ $retcode_i -eq 0 ]; then |
| |
| #export needed env var for statefulset |
| export RIC_SIM_SET_NAME=$(echo "$1" | tr '_' '-') #kube does not accept underscore in names |
| export KUBE_NONRTRIC_NAMESPACE |
| export RIC_SIM_IMAGE |
| #Adding 1 more instance, instance 0 is never used. This is done to keep test scripts compatible |
| # with docker that starts instance index on 1..... |
| export RIC_SIM_COUNT=$(($2+1)) |
| export A1_VERSION=$3 |
| export RIC_SIM_INTERNAL_PORT |
| export RIC_SIM_INTERNAL_SECURE_PORT |
| |
| echo -e " Creating $POLICY_AGENT_APP_NAME app and expose service" |
| |
| #Check if nonrtric namespace exists, if not create it |
| __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE |
| |
| # Create service |
| input_yaml=$SIM_GROUP"/"$RIC_SIM_COMPOSE_DIR"/"svc.yaml |
| output_yaml=$PWD/tmp/ric_${1}_svc.yaml |
| __kube_create_instance service $RIC_SIM_SET_NAME $input_yaml $output_yaml |
| |
| # Create app |
| input_yaml=$SIM_GROUP"/"$RIC_SIM_COMPOSE_DIR"/"app.yaml |
| output_yaml=$PWD/tmp/pa_${1}_app.yaml |
| __kube_create_instance app $RIC_SIM_SET_NAME $input_yaml $output_yaml |
| |
| #Using only instance from index 1 to keep compatability with docker |
| for (( count=1; count<${RIC_SIM_COUNT}; count++ )); do |
| host=$(__find_sim_host $RIC_SIM_SET_NAME"-"$count) |
| __check_service_start $RIC_SIM_SET_NAME"-"$count $host"/" |
| done |
| fi |
| else |
| |
| __check_included_image 'RICSIM' |
| if [ $? -eq 1 ]; then |
| echo -e $RED"The Near-RT RIC Simulator app is not included as managed in this test script"$ERED |
| echo -e $RED"Near-RT RIC Simulator will not be started"$ERED |
| exit 1 |
| fi |
| |
| # Create .env file to compose project, all ric container will get this prefix |
| echo "COMPOSE_PROJECT_NAME="$RIC_SIM_PREFIX > $SIM_GROUP/$RIC_SIM_COMPOSE_DIR/.env |
| |
| export G1_A1_VERSION |
| export G2_A1_VERSION |
| export G3_A1_VERSION |
| export G4_A1_VERSION |
| export G5_A1_VERSION |
| export RIC_SIM_INTERNAL_PORT |
| export RIC_SIM_INTERNAL_SECURE_PORT |
| export RIC_SIM_CERT_MOUNT_DIR |
| export DOCKER_SIM_NWNAME |
| |
| docker_args="--scale g1=$G1_COUNT --scale g2=$G2_COUNT --scale g3=$G3_COUNT --scale g4=$G4_COUNT --scale g5=$G5_COUNT" |
| app_data="" |
| cntr=1 |
| while [ $cntr -le $2 ]; do |
| app=$1"_"$cntr |
| app_data="$app_data $app" |
| let cntr=cntr+1 |
| done |
| |
| __start_container $RIC_SIM_COMPOSE_DIR "$docker_args" $2 $app_data |
| |
| cntr=1 |
| while [ $cntr -le $2 ]; do |
| app=$1"_"$cntr |
| localport=0 |
| |
| while [ $localport -eq 0 ]; do |
| echo -ne " Waiting for container ${app} to publish its ports...${SAMELINE}" |
| localport=$(__find_sim_port $app) |
| sleep 0.5 |
| echo -ne " Waiting for container ${app} to publish its ports...retrying....${SAMELINE}" |
| done |
| echo -e " Waiting for container ${app} to publish its ports...retrying....$GREEN OK $EGREEN" |
| __check_service_start $app $RIC_SIM_HOST":"$localport$RIC_SIM_ALIVE_URL |
| let cntr=cntr+1 |
| done |
| fi |
| echo "" |
| return 0 |
| } |
| |
| |
| |
| # Excute a curl cmd towards a ricsimulator and check the response code. |
| # args: <expected-response-code> <curl-cmd-string> |
| __execute_curl_to_sim() { |
| echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG |
| echo " CMD: $2" >> $HTTPLOG |
| res="$($2)" |
| echo " RESP: $res" >> $HTTPLOG |
| retcode=$? |
| if [ $retcode -ne 0 ]; then |
| ((RES_CONF_FAIL++)) |
| echo " RETCODE: "$retcode |
| echo -e $RED" FAIL - fatal error when executing curl."$ERED |
| return 1 |
| fi |
| status=${res:${#res}-3} |
| if [ $status -eq $1 ]; then |
| echo -e $GREEN" OK"$EGREEN |
| return 0 |
| fi |
| echo -e $RED" FAIL - expected http response: "$1" but got http response: "$status $ERED |
| ((RES_CONF_FAIL++)) |
| return 1 |
| } |
| |
| # Tests if a variable value in the ricsimulator is equal to a target value and and optional timeout. |
| # Arg: <ric-id> <variable-name> <target-value> - This test set pass or fail depending on if the variable is |
| # equal to the target or not. |
| # Arg: <ric-id> <variable-name> <target-value> <timeout-in-sec> - This test waits up to the timeout seconds |
| # before setting pass or fail depending on if the variable value becomes equal to the target |
| # value or not. |
| # (Function for test scripts) |
| sim_equal() { |
| |
| if [ $# -eq 3 ] || [ $# -eq 4 ]; then |
| host=$(__find_sim_host $1) |
| __var_test $1 "$host/counter/" $2 "=" $3 $4 |
| return 0 |
| else |
| __print_err "needs three or four args: <ric-id> <sim-param> <target-value> [ timeout ]" |
| return 1 |
| fi |
| } |
| |
| # Print a variable value from the RIC sim. |
| # args: <ric-id> <variable-name> |
| # (Function for test scripts) |
| sim_print() { |
| |
| if [ $# != 2 ]; then |
| __print_err "need two args, <ric-id> <sim-param>" $@ |
| exit 1 |
| fi |
| host=$(__find_sim_host $1) |
| echo -e $BOLD"INFO(${BASH_LINENO[0]}): $1, $2 = $(__do_curl $host/counter/$2)"$EBOLD |
| } |
| |
| # Tests if a variable value in the RIC simulator contains the target string and and optional timeout |
| # Arg: <ric-id> <variable-name> <target-value> - This test set pass or fail depending on if the variable contains |
| # the target or not. |
| # Arg: <ric-id> <variable-name> <target-value> <timeout-in-sec> - This test waits up to the timeout seconds |
| # before setting pass or fail depending on if the variable value contains the target |
| # value or not. |
| # (Function for test scripts) |
| sim_contains_str() { |
| |
| if [ $# -eq 3 ] || [ $# -eq 4 ]; then |
| host=$(__find_sim_host $1) |
| __var_test $1 "$host/counter/" $2 "contain_str" $3 $4 |
| return 0 |
| else |
| __print_err "needs three or four args: <ric-id> <sim-param> <target-value> [ timeout ]" |
| return 1 |
| fi |
| } |
| |
| # Simulator API: Put a policy type in a ric |
| # args: <response-code> <ric-id> <policy-type-id> <policy-type-file> |
| # (Function for test scripts) |
| sim_put_policy_type() { |
| __log_conf_start $@ |
| if [ $# -ne 4 ]; then |
| __print_err "<response-code> <ric-id> <policy-type-id> <policy-type-file>" $@ |
| return 1 |
| fi |
| host=$(__find_sim_host $2) |
| curlString="curl -X PUT -skw %{http_code} "$host"/policytype?id="$3" -H Content-Type:application/json --data-binary @"$4 |
| __execute_curl_to_sim $1 "$curlString" |
| return $? |
| } |
| |
| # Simulator API: Delete a policy type in a ric |
| # <response-code> <ric-id> <policy-type-id> |
| # (Function for test scripts) |
| sim_delete_policy_type() { |
| __log_conf_start $@ |
| if [ $# -ne 3 ]; then |
| __print_err "<response-code> <ric-id> <policy_type_id>" $@ |
| return 1 |
| fi |
| host=$(__find_sim_host $2) |
| curlString="curl -X DELETE -skw %{http_code} "$host"/policytype?id="$3 |
| __execute_curl_to_sim $1 "$curlString" |
| return $? |
| } |
| |
| # Simulator API: Delete instances (and status), for one ric |
| # <response-code> <ric-id> |
| # (Function for test scripts) |
| sim_post_delete_instances() { |
| __log_conf_start $@ |
| if [ $# -ne 2 ]; then |
| __print_err "<response-code> <ric-id>" $@ |
| return 1 |
| fi |
| host=$(__find_sim_host $2) |
| curlString="curl -X POST -skw %{http_code} "$host"/deleteinstances" |
| __execute_curl_to_sim $1 "$curlString" |
| return $? |
| } |
| |
| # Simulator API: Delete all (instances/types/statuses/settings), for one ric |
| # <response-code> <ric-id> |
| # (Function for test scripts) |
| sim_post_delete_all() { |
| __log_conf_start $@ |
| if [ $# -ne 3 ]; then |
| __print_err "<response-code> <numericic-id>" $@ |
| return 1 |
| fi |
| host=$(__find_sim_host $2) |
| curlString="curl -X POST -skw %{http_code} "$host"/deleteall" |
| __execute_curl_to_sim $1 "$curlString" |
| return $? |
| } |
| |
| # Simulator API: Set (or reset) response code for next A1 message, for one ric |
| # <response-code> <ric-id> [<forced_response_code>] |
| # (Function for test scripts) |
| sim_post_forcedresponse() { |
| __log_conf_start $@ |
| if [ $# -ne 3 ]; then |
| __print_err "<response-code> <ric-id> <forced_response_code>" $@ |
| return 1 |
| fi |
| host=$(__find_sim_host $2) |
| curlString="curl -X POST -skw %{http_code} "$host"/forceresponse" |
| if [ $# -eq 3 ]; then |
| curlString=$curlString"?code="$3 |
| fi |
| __execute_curl_to_sim $1 "$curlString" |
| return $? |
| } |
| |
| # Simulator API: Set (or reset) A1 response delay, for one ric |
| # <response-code> <ric-id> [<delay-in-seconds>] |
| # (Function for test scripts) |
| sim_post_forcedelay() { |
| __log_conf_start $@ |
| if [ $# -ne 3 ]; then |
| __print_err "<response-code> <ric-id> [<delay-in-seconds>]" $@ |
| return 1 |
| fi |
| host=$(__find_sim_host $2) |
| curlString="curl -X POST -skw %{http_code} $host/forcedelay" |
| if [ $# -eq 3 ]; then |
| curlString=$curlString"?delay="$3 |
| fi |
| __execute_curl_to_sim $1 "$curlString" |
| return $? |
| } |