test/common/ricsimulator_api_functions.sh

   1 #!/bin/bash
   2
   3 #  ============LICENSE_START===============================================
   4 #  Copyright (C) 2020 Nordix Foundation. All rights reserved.
   5 #  ========================================================================
   6 #  Licensed under the Apache License, Version 2.0 (the "License");
   7 #  you may not use this file except in compliance with the License.
   8 #  You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #  Unless required by applicable law or agreed to in writing, software
  13 #  distributed under the License is distributed on an "AS IS" BASIS,
  14 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #  See the License for the specific language governing permissions and
  16 #  limitations under the License.
  17 #  ============LICENSE_END=================================================
  18 #
  19
  20 # This is a script that contains container/service management functions and test functions for RICSIM A1 simulators
  21
  22 ################ Test engine functions ################
  23
  24 # Create the image var used during the test
  25 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
  26 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
  27 __RICSIM_imagesetup() {
  28         __check_and_create_image_var RICSIM "RIC_SIM_IMAGE" "RIC_SIM_IMAGE_BASE" "RIC_SIM_IMAGE_TAG" $1 "$RIC_SIM_DISPLAY_NAME"
  29 }
  30
  31 # Pull image from remote repo or use locally built image
  32 # arg: <pull-policy-override> <pull-policy-original>
  33 # <pull-policy-override> Shall be used for images allowing overriding. For example use a local image when test is started to use released images
  34 # <pull-policy-original> Shall be used for images that does not allow overriding
  35 # Both var may contain: 'remote', 'remote-remove' or 'local'
  36 __RICSIM_imagepull() {
  37         __check_and_pull_image $1 "$RIC_SIM_DISPLAY_NAME" $RIC_SIM_PREFIX"_"$RIC_SIM_BASE RIC_SIM_IMAGE
  38 }
  39
  40 # Generate a string for each included image using the app display name and a docker images format string
  41 # If a custom image repo is used then also the source image from the local repo is listed
  42 # arg: <docker-images-format-string> <file-to-append>
  43 __RICSIM_image_data() {
  44         echo -e "$RIC_SIM_DISPLAY_NAME\t$(docker images --format $1 $RIC_SIM_IMAGE)" >>   $2
  45         if [ ! -z "$RIC_SIM_IMAGE_SOURCE" ]; then
  46                 echo -e "-- source image --\t$(docker images --format $1 $RIC_SIM_IMAGE_SOURCE)" >>   $2
  47         fi
  48 }
  49
  50 # Scale kubernetes resources to zero
  51 # All resources shall be ordered to be scaled to 0, if relevant. If not relevant to scale, then do no action.
  52 # This function is called for apps fully managed by the test script
  53 __RICSIM_kube_scale_zero() {
  54         __kube_scale_all_resources $KUBE_A1SIM_NAMESPACE autotest RICSIM
  55 }
  56
  57 # Scale kubernetes resources to zero and wait until this has been accomplished, if relevant. If not relevant to scale, then do no action.
  58 # This function is called for prestarted apps not managed by the test script.
  59 __RICSIM_kube_scale_zero_and_wait() {
  60         #__kube_scale_and_wait_all_resources $KUBE_A1SIM_NAMESPACE app $KUBE_A1SIM_NAMESPACE"-"$RIC_SIM_PREFIX
  61         __kube_scale_and_wait_all_resources $KUBE_A1SIM_NAMESPACE app # the values of the app label is not known
  62 }
  63
  64 # Delete all kube resouces for the app
  65 # This function is called for apps managed by the test script.
  66 __RICSIM_kube_delete_all() {
  67         __kube_delete_all_resources $KUBE_A1SIM_NAMESPACE autotest RICSIM
  68 }
  69
  70 # Store docker logs
  71 # This function is called for apps managed by the test script.
  72 # args: <log-dir> <file-prexix>
  73 __RICSIM_store_docker_logs() {
  74         if [ $RUNMODE == "KUBE" ]; then
  75                 for podname in $(kubectl get pods -n $KUBE_A1SIM_NAMESPACE -l "autotest=RICSIM" -o custom-columns=":metadata.name"); do
  76                         kubectl logs -n $KUBE_A1SIM_NAMESPACE $podname --tail=-1 > $1$2_$podname.log 2>&1
  77                 done
  78         else
  79
  80                 rics=$(docker ps --filter "name=$RIC_SIM_PREFIX" --filter "network=$DOCKER_SIM_NWNAME" --filter "status=running" --format {{.Names}})
  81                 for ric in $rics; do
  82                         docker logs $ric > $1$2_$ric.log 2>&1
  83                 done
  84         fi
  85 }
  86
  87 # Initial setup of protocol, host and ports
  88 # This function is called for apps managed by the test script.
  89 # args: -
  90 __RICSIM_initial_setup() {
  91         use_simulator_http
  92 }
  93
  94 # Set app short-name, app name and namespace for logging runtime statistics of kubernets pods or docker containers
  95 # For docker, the namespace shall be excluded
  96 # This function is called for apps managed by the test script as well as for prestarted apps.
  97 # args: -
  98 __RICSIM_statisics_setup() {
  99         if [ $RUNMODE == "KUBE" ]; then
 100                 echo ""
 101         else
 102                 echo ""
 103         fi
 104 }
 105
 106 #######################################################
 107
 108
 109 RIC_SIM_HTTPX="http"
 110 RIC_SIM_HOST=$RIC_SIM_HTTPX"://"$LOCALHOST_NAME
 111 RIC_SIM_PORT=$RIC_SIM_INTERNAL_PORT
 112
 113
 114 #Vars for A1 interface version and container count
 115 G1_A1_VERSION=""
 116 G2_A1_VERSION=""
 117 G3_A1_VERSION=""
 118 G4_A1_VERSION=""
 119 G5_A1_VERSION=""
 120 G1_COUNT=0
 121 G2_COUNT=0
 122 G3_COUNT=0
 123 G4_COUNT=0
 124 G5_COUNT=0
 125
 126
 127 ###########################
 128 ### RIC Simulator functions
 129 ###########################
 130
 131 use_simulator_http() {
 132         echo -e $BOLD"RICSIM protocol setting"$EBOLD
 133         echo -e " Using $BOLD http $EBOLD towards the simulators"
 134         RIC_SIM_HTTPX="http"
 135         RIC_SIM_HOST=$RIC_SIM_HTTPX"://"$LOCALHOST_NAME
 136         RIC_SIM_PORT=$RIC_SIM_INTERNAL_PORT
 137         echo ""
 138 }
 139
 140 use_simulator_https() {
 141         echo -e $BOLD"RICSIM protocol setting"$EBOLD
 142         echo -e " Using $BOLD https $EBOLD towards the simulators"
 143         RIC_SIM_HTTPX="https"
 144         RIC_SIM_HOST=$RIC_SIM_HTTPX"://"$LOCALHOST_NAME
 145         RIC_SIM_PORT=$RIC_SIM_INTERNAL_SECURE_PORT
 146         echo ""
 147 }
 148
 149 # Start one group (ricsim_g1, ricsim_g2 .. ricsim_g5) with a number of RIC Simulators using a given A interface
 150 # 'ricsim' may be set on command line to other prefix
 151 # args:  ricsim_g1|ricsim_g2|ricsim_g3|ricsim_g4|ricsim_g5 <count> <interface-id>
 152 # (Function for test scripts)
 153 start_ric_simulators() {
 154
 155         echo -e $BOLD"Starting $RIC_SIM_DISPLAY_NAME"$EBOLD
 156
 157         if [ $RUNMODE == "KUBE" ]; then
 158
 159                 # Check if app shall be fully managed by the test script
 160                 __check_included_image "RICSIM"
 161                 retcode_i=$?
 162
 163                 # Check if app shall only be used by the testscipt
 164                 __check_prestarted_image "RICSIM"
 165                 retcode_p=$?
 166
 167                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
 168                         echo -e $RED"The $1 app is not included as managed nor prestarted in this test script"$ERED
 169                         echo -e $RED"The $1 will not be started"$ERED
 170                         exit
 171                 fi
 172                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
 173                         echo -e $RED"The $1 stub app is included both as managed and prestarted in this test script"$ERED
 174                         echo -e $RED"The $1 will not be started"$ERED
 175                         exit
 176                 fi
 177
 178                 if [ $retcode_p -eq 0 ]; then
 179                         echo -e " Using existing $1 statefulset and service"
 180                         echo " Using existing simulator deployment and service for statefulset $1"
 181                         echo " Setting $1 replicas=$2"
 182                         __kube_scale statefulset $1 $KUBE_A1SIM_NAMESPACE $2
 183                         echo ""
 184                         return
 185                 fi
 186         fi
 187
 188         RIC1=$RIC_SIM_PREFIX"_g1"
 189         RIC2=$RIC_SIM_PREFIX"_g2"
 190         RIC3=$RIC_SIM_PREFIX"_g3"
 191         RIC4=$RIC_SIM_PREFIX"_g4"
 192         RIC5=$RIC_SIM_PREFIX"_g5"
 193
 194         if [ $# != 3 ]; then
 195                 ((RES_CONF_FAIL++))
 196                 __print_err "need three args,  $RIC1|$RIC2|$RIC3|$RIC4|$RIC5 <count> <interface-id>" $@
 197                 exit 1
 198         fi
 199
 200         echo " $2 simulators using basename: $1 on interface: $3"
 201         #Set env var for simulator count and A1 interface vesion for the given group
 202         if [ $1 == "$RIC1" ]; then
 203                 G1_COUNT=$2
 204                 G1_A1_VERSION=$3
 205         elif [ $1 == "$RIC2" ]; then
 206                 G2_COUNT=$2
 207                 G2_A1_VERSION=$3
 208         elif [ $1 == "$RIC3" ]; then
 209                 G3_COUNT=$2
 210                 G3_A1_VERSION=$3
 211         elif [ $1 == "$RIC4" ]; then
 212                 G4_COUNT=$2
 213                 G4_A1_VERSION=$3
 214         elif [ $1 == "$RIC5" ]; then
 215                 G5_COUNT=$2
 216                 G5_A1_VERSION=$3
 217         else
 218                 ((RES_CONF_FAIL++))
 219                 __print_err "need three args, $RIC1|$RIC2|$RIC3|$RIC4|$RIC5 <count> <interface-id>" $@
 220                 exit 1
 221         fi
 222
 223         if [ $RUNMODE == "KUBE" ]; then
 224
 225                 if [ $retcode_i -eq 0 ]; then
 226
 227                         #export needed env var for statefulset
 228                         export RIC_SIM_SET_NAME=$(echo "$1" | tr '_' '-')  #kube does not accept underscore in names
 229                         export KUBE_A1SIM_NAMESPACE
 230                         export RIC_SIM_IMAGE
 231                         #Adding 1 more instance, instance 0 is never used. This is done to keep test scripts compatible
 232                         # with docker that starts instance index on 1.....
 233                         export RIC_SIM_COUNT=$(($2+1))
 234                         export A1_VERSION=$3
 235                         export RIC_SIM_INTERNAL_PORT
 236                         export RIC_SIM_INTERNAL_SECURE_PORT
 237
 238                         echo -e " Creating $POLICY_AGENT_APP_NAME app and expose service"
 239
 240                         #Check if nonrtric namespace exists, if not create it
 241                         __kube_create_namespace $KUBE_A1SIM_NAMESPACE
 242
 243                         # Create service
 244                         input_yaml=$SIM_GROUP"/"$RIC_SIM_COMPOSE_DIR"/"svc.yaml
 245                         output_yaml=$PWD/tmp/ric_${1}_svc.yaml
 246                         __kube_create_instance service $RIC_SIM_SET_NAME $input_yaml $output_yaml
 247
 248                         # Create app
 249                         input_yaml=$SIM_GROUP"/"$RIC_SIM_COMPOSE_DIR"/"app.yaml
 250                         output_yaml=$PWD/tmp/pa_${1}_app.yaml
 251                         __kube_create_instance app $RIC_SIM_SET_NAME $input_yaml $output_yaml
 252
 253                         #Using only instance from index 1 to keep compatability with docker
 254                         for (( count=1; count<${RIC_SIM_COUNT}; count++ )); do
 255                                 host=$(__find_sim_host $RIC_SIM_SET_NAME"-"$count)
 256                                 __check_service_start $RIC_SIM_SET_NAME"-"$count $host"/"
 257                         done
 258                 fi
 259         else
 260
 261                 __check_included_image 'RICSIM'
 262                 if [ $? -eq 1 ]; then
 263                         echo -e $RED"The Near-RT RIC Simulator app is not included as managed in this test script"$ERED
 264                         echo -e $RED"Near-RT RIC Simulator will not be started"$ERED
 265                         exit 1
 266                 fi
 267
 268                 # Create .env file to compose project, all ric container will get this prefix
 269                 echo "COMPOSE_PROJECT_NAME="$RIC_SIM_PREFIX > $SIM_GROUP/$RIC_SIM_COMPOSE_DIR/.env
 270
 271                 export G1_A1_VERSION
 272                 export G2_A1_VERSION
 273                 export G3_A1_VERSION
 274                 export G4_A1_VERSION
 275                 export G5_A1_VERSION
 276                 export RIC_SIM_INTERNAL_PORT
 277                 export RIC_SIM_INTERNAL_SECURE_PORT
 278                 export RIC_SIM_CERT_MOUNT_DIR
 279                 export DOCKER_SIM_NWNAME
 280                 export RIC_SIM_DISPLAY_NAME
 281
 282                 docker_args="--scale g1=$G1_COUNT --scale g2=$G2_COUNT --scale g3=$G3_COUNT --scale g4=$G4_COUNT --scale g5=$G5_COUNT"
 283                 app_data=""
 284                 cntr=1
 285                 while [ $cntr -le $2 ]; do
 286                         app=$1"_"$cntr
 287                         app_data="$app_data $app"
 288                         let cntr=cntr+1
 289                 done
 290
 291                 __start_container $RIC_SIM_COMPOSE_DIR "" "$docker_args" $2 $app_data
 292
 293                 cntr=1
 294                 while [ $cntr -le $2 ]; do
 295                         app=$1"_"$cntr
 296                         __check_service_start $app $RIC_SIM_HTTPX"://"$app:$RIC_SIM_PORT$RIC_SIM_ALIVE_URL
 297                         let cntr=cntr+1
 298                 done
 299
 300         fi
 301         echo ""
 302         return 0
 303 }
 304
 305 # Translate ric name to kube host name
 306 # args: <ric-name>
 307 # For test scripts
 308 get_kube_sim_host() {
 309         name=$(echo "$1" | tr '_' '-')  #kube does not accept underscore in names
 310         #example gnb_1_2 -> gnb-1-2
 311         set_name=$(echo $name | rev | cut -d- -f2- | rev) # Cut index part of ric name to get the name of statefulset
 312         # example gnb-g1-2 -> gnb-g1 where gnb-g1-2 is the ric name and gnb-g1 is the set name
 313         echo $name"."$set_name"."$KUBE_A1SIM_NAMESPACE
 314 }
 315
 316 # Helper function to get a the port and host name of a specific ric simulator
 317 # args: <ric-id>
 318 # (Not for test scripts)
 319 __find_sim_host() {
 320         if [ $RUNMODE == "KUBE" ]; then
 321                 ricname=$(echo "$1" | tr '_' '-') # Kube does not accept underscore in names as docker do
 322                 ric_setname="${ricname%-*}"  #Extract the stateful set name
 323                 echo $RIC_SIM_HTTPX"://"$ricname.$ric_setname.$KUBE_A1SIM_NAMESPACE":"$RIC_SIM_PORT
 324         else
 325                 echo $RIC_SIM_HTTPX"://"$1":"$RIC_SIM_PORT
 326
 327         fi
 328 }
 329
 330 # Generate a UUID to use as prefix for policy ids
 331 generate_policy_uuid() {
 332         UUID=$(python3 -c 'import sys,uuid; sys.stdout.write(uuid.uuid4().hex)')
 333         #Reduce length to make space for serial id, uses 'a' as marker where the serial id is added
 334         UUID=${UUID:0:${#UUID}-4}"a"
 335 }
 336
 337 # Excute a curl cmd towards a ricsimulator and check the response code.
 338 # args: <expected-response-code> <curl-cmd-string>
 339 __execute_curl_to_sim() {
 340         echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
 341         proxyflag=""
 342         if [ ! -z "$KUBE_PROXY_PATH" ]; then
 343                 if [ $KUBE_PROXY_HTTPX == "http" ]; then
 344                         proxyflag=" --proxy $KUBE_PROXY_PATH"
 345                 else
 346                         proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
 347                 fi
 348         fi
 349         echo " CMD: $2 $proxyflag" >> $HTTPLOG
 350         res="$($2 $proxyflag)"
 351         echo " RESP: $res" >> $HTTPLOG
 352         retcode=$?
 353     if [ $retcode -ne 0 ]; then
 354                 ((RES_CONF_FAIL++))
 355                 echo " RETCODE: "$retcode
 356         echo -e $RED" FAIL - fatal error when executing curl."$ERED
 357         return 1
 358     fi
 359     status=${res:${#res}-3}
 360     if [ $status -eq $1 ]; then
 361         echo -e $GREEN" OK"$EGREEN
 362         return 0
 363     fi
 364     echo -e $RED" FAIL - expected http response: "$1" but got http response: "$status $ERED
 365         ((RES_CONF_FAIL++))
 366     return 1
 367 }
 368
 369 # Tests if a variable value in the ricsimulator is equal to a target value and and optional timeout.
 370 # Arg: <ric-id> <variable-name> <target-value> - This test set pass or fail depending on if the variable is
 371 # equal to the target or not.
 372 # Arg: <ric-id> <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
 373 # before setting pass or fail depending on if the variable value becomes equal to the target
 374 # value or not.
 375 # (Function for test scripts)
 376 sim_equal() {
 377
 378         if [ $# -eq 3 ] || [ $# -eq 4 ]; then
 379                 host=$(__find_sim_host $1)
 380                 __var_test $1 "$host/counter/" $2 "=" $3 $4
 381                 return 0
 382         else
 383                 __print_err "needs three or four args: <ric-id> <sim-param> <target-value> [ timeout ]"
 384                 return 1
 385         fi
 386 }
 387
 388 # Print a variable value from the RIC sim.
 389 # args: <ric-id> <variable-name>
 390 # (Function for test scripts)
 391 sim_print() {
 392
 393         if [ $# != 2 ]; then
 394         __print_err "need two args, <ric-id> <sim-param>" $@
 395                 exit 1
 396         fi
 397         host=$(__find_sim_host $1)
 398         echo -e $BOLD"INFO(${BASH_LINENO[0]}): $1, $2 = $(__do_curl $host/counter/$2)"$EBOLD
 399 }
 400
 401 # Tests if a variable value in the RIC simulator contains the target string and and optional timeout
 402 # Arg: <ric-id> <variable-name> <target-value> - This test set pass or fail depending on if the variable contains
 403 # the target or not.
 404 # Arg: <ric-id> <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
 405 # before setting pass or fail depending on if the variable value contains the target
 406 # value or not.
 407 # (Function for test scripts)
 408 sim_contains_str() {
 409
 410         if [ $# -eq 3 ] || [ $# -eq 4 ]; then
 411                 host=$(__find_sim_host $1)
 412                 __var_test $1 "$host/counter/" $2 "contain_str" $3 $4
 413                 return 0
 414         else
 415                 __print_err "needs three or four args: <ric-id> <sim-param> <target-value> [ timeout ]"
 416                 return 1
 417         fi
 418 }
 419
 420 # Simulator API: Put a policy type in a ric
 421 # args: <response-code> <ric-id> <policy-type-id> <policy-type-file>
 422 # (Function for test scripts)
 423 sim_put_policy_type() {
 424         __log_conf_start $@
 425         if [ $# -ne 4 ]; then
 426                 __print_err "<response-code> <ric-id> <policy-type-id> <policy-type-file>" $@
 427                 return 1
 428         fi
 429         host=$(__find_sim_host $2)
 430     curlString="curl -X PUT -skw %{http_code} "$host"/policytype?id="$3" -H Content-Type:application/json --data-binary @"$4
 431         __execute_curl_to_sim $1 "$curlString"
 432         return $?
 433 }
 434
 435 # Simulator API: Delete a policy type in a ric
 436 # <response-code> <ric-id> <policy-type-id>
 437 # (Function for test scripts)
 438 sim_delete_policy_type() {
 439         __log_conf_start $@
 440         if [ $# -ne 3 ]; then
 441                 __print_err "<response-code> <ric-id> <policy_type_id>" $@
 442                 return 1
 443         fi
 444         host=$(__find_sim_host $2)
 445     curlString="curl -X DELETE -skw %{http_code} "$host"/policytype?id="$3
 446     __execute_curl_to_sim $1 "$curlString"
 447         return $?
 448 }
 449
 450 # Simulator API: Delete instances (and status), for one ric
 451 # <response-code> <ric-id>
 452 # (Function for test scripts)
 453 sim_post_delete_instances() {
 454         __log_conf_start $@
 455         if [ $# -ne 2 ]; then
 456                 __print_err "<response-code> <ric-id>" $@
 457                 return 1
 458         fi
 459         host=$(__find_sim_host $2)
 460     curlString="curl -X POST -skw %{http_code} "$host"/deleteinstances"
 461     __execute_curl_to_sim $1 "$curlString"
 462         return $?
 463 }
 464
 465 # Simulator API: Delete all (instances/types/statuses/settings), for one ric
 466 # <response-code> <ric-id>
 467 # (Function for test scripts)
 468 sim_post_delete_all() {
 469         __log_conf_start $@
 470         if [ $# -ne 2 ]; then
 471                 __print_err "<response-code> <numericic-id>" $@
 472                 return 1
 473         fi
 474         host=$(__find_sim_host $2)
 475     curlString="curl -X POST -skw %{http_code} "$host"/deleteall"
 476     __execute_curl_to_sim $1 "$curlString"
 477         return $?
 478 }
 479
 480 # Simulator API: Set (or reset) response code for next A1 message, for one ric
 481 # <response-code> <ric-id> [<forced_response_code>]
 482 # (Function for test scripts)
 483 sim_post_forcedresponse() {
 484         __log_conf_start $@
 485         if [ $# -ne 3 ]; then
 486                 __print_err "<response-code> <ric-id> <forced_response_code>" $@
 487                 return 1
 488         fi
 489         host=$(__find_sim_host $2)
 490     curlString="curl -X POST -skw %{http_code} "$host"/forceresponse"
 491         if [ $# -eq 3 ]; then
 492                 curlString=$curlString"?code="$3
 493         fi
 494     __execute_curl_to_sim $1 "$curlString"
 495         return $?
 496 }
 497
 498 # Simulator API: Set (or reset) A1 response delay, for one ric
 499 # <response-code> <ric-id> [<delay-in-seconds>]
 500 # (Function for test scripts)
 501 sim_post_forcedelay() {
 502         __log_conf_start $@
 503         if [ $# -ne 3 ]; then
 504                 __print_err "<response-code> <ric-id> [<delay-in-seconds>]" $@
 505                 return 1
 506         fi
 507         host=$(__find_sim_host $2)
 508     curlString="curl -X POST -skw %{http_code} $host/forcedelay"
 509         if [ $# -eq 3 ]; then
 510                 curlString=$curlString"?delay="$3
 511         fi
 512     __execute_curl_to_sim $1 "$curlString"
 513         return $?
 514 }