test/common/testcase_common.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 all the functions needed for auto test
  21 # Arg: local|remote|remote-remove [auto-clean] [--stop-at-error] [--ricsim-prefix <prefix> ] [ --env-file <environment-filename> ] [--use-local-image <app-nam> [<app-name>]*]
  22
  23
  24 # Create a test case id, ATC (Auto Test Case), from the name of the test case script.
  25 # FTC1.sh -> ATC == FTC1
  26 ATC=$(basename "${BASH_SOURCE[$i+1]}" .sh)
  27
  28 #Create result file (containing '1' for error) for this test case
  29 #Will be replaced with a file containing '0' if all test cases pass
  30 echo "1" > "$PWD/.result$ATC.txt"
  31
  32 #Formatting for 'echo' cmd
  33 BOLD="\033[1m"
  34 EBOLD="\033[0m"
  35 RED="\033[31m\033[1m"
  36 ERED="\033[0m"
  37 GREEN="\033[32m\033[1m"
  38 EGREEN="\033[0m"
  39 YELLOW="\033[33m\033[1m"
  40 EYELLOW="\033[0m"
  41 SAMELINE="\033[0K\r"
  42
  43 tmp=$(which python3)
  44 if [ $? -ne 0 ] || [ -z tmp ]; then
  45         echo -e $RED"python3 is required to run the test environment, pls install"$ERED
  46         exit 1
  47 fi
  48 tmp=$(which docker)
  49 if [ $? -ne 0 ] || [ -z tmp ]; then
  50         echo -e $RED"docker is required to run the test environment, pls install"$ERED
  51         exit 1
  52 fi
  53
  54 tmp=$(which docker-compose)
  55 if [ $? -ne 0 ] || [ -z tmp ]; then
  56         echo -e $RED"docker-compose is required to run the test environment, pls install"$ERED
  57         exit 1
  58 fi
  59
  60 # Just resetting any previous echo formatting...
  61 echo -ne $EBOLD
  62
  63 # default test environment variables
  64 TEST_ENV_VAR_FILE="../common/test_env.sh"
  65
  66 echo "Test case started as: ${BASH_SOURCE[$i+1]} "$@
  67
  68 #Localhost constant
  69 LOCALHOST="http://localhost:"
  70
  71 # Make curl retries towards ECS for http response codes set in this env var, space separated list of codes
  72 ECS_RETRY_CODES=""
  73
  74 # Make curl retries towards the agent for http response codes set in this env var, space separated list of codes
  75 AGENT_RETRY_CODES=""
  76
  77 # Var to contol if the agent runs in a container (normal = 0) or as application on the local machine ( = 1)
  78 AGENT_STAND_ALONE=0
  79
  80 # Var to hold 'auto' in case containers shall be stopped when test case ends
  81 AUTO_CLEAN=""
  82
  83 # Var to hold the app names to use local image for when running 'remote' or 'remote-remove'
  84 USE_LOCAL_IMAGES=""
  85
  86 # List of available apps to override with local image
  87 AVAILABLE_LOCAL_IMAGES_OVERRIDE="PA ECS CP SDNC RICSIM"
  88
  89 # Use this var (STOP_AT_ERROR=1 in the test script) for debugging/trouble shooting to take all logs and exit at first FAIL test case
  90 STOP_AT_ERROR=0
  91
  92 # Function to indent cmd output with one space
  93 indent1() { sed 's/^/ /'; }
  94
  95 # Function to indent cmd output with two spaces
  96 indent2() { sed 's/^/  /'; }
  97
  98 # Set a description string for the test case
  99 if [ -z "$TC_ONELINE_DESCR" ]; then
 100         TC_ONELINE_DESCR="<no-description>"
 101         echo "No test case description found, TC_ONELINE_DESCR should be set on in the test script , using "$TC_ONELINE_DESCR
 102 fi
 103
 104 # Counter for test suites
 105 if [ -f .tmp_tcsuite_ctr ]; then
 106         tmpval=$(< .tmp_tcsuite_ctr)
 107         ((tmpval++))
 108         echo $tmpval > .tmp_tcsuite_ctr
 109 fi
 110
 111 # Create the logs dir if not already created in the current dir
 112 if [ ! -d "logs" ]; then
 113     mkdir logs
 114 fi
 115 TESTLOGS=$PWD/logs
 116
 117 # Create the tmp dir for temporary files that is not needed after the test
 118 # hidden files for the test env is still stored in the current dir
 119 if [ ! -d "tmp" ]; then
 120     mkdir tmp
 121 fi
 122
 123 # Create a http message log for this testcase
 124 HTTPLOG=$PWD"/.httplog_"$ATC".txt"
 125 echo "" > $HTTPLOG
 126
 127
 128 # Create a log dir for the test case
 129 mkdir -p $TESTLOGS/$ATC
 130
 131 # Clear the log dir for the test case
 132 rm $TESTLOGS/$ATC/*.log &> /dev/null
 133 rm $TESTLOGS/$ATC/*.txt &> /dev/null
 134 rm $TESTLOGS/$ATC/*.json &> /dev/null
 135
 136 # Log all output from the test case to a TC log
 137 TCLOG=$TESTLOGS/$ATC/TC.log
 138 exec &>  >(tee ${TCLOG})
 139
 140 #Variables for counting tests as well as passed and failed tests
 141 RES_TEST=0
 142 RES_PASS=0
 143 RES_FAIL=0
 144 RES_CONF_FAIL=0
 145 RES_DEVIATION=0
 146
 147 #File to keep deviation messages
 148 DEVIATION_FILE=".tmp_deviations"
 149 rm $DEVIATION_FILE &> /dev/null
 150
 151 #Var for measuring execution time
 152 TCTEST_START=$SECONDS
 153
 154 #File to save timer measurement results
 155 TIMER_MEASUREMENTS=".timer_measurement.txt"
 156 echo -e "Activity \t Duration" > $TIMER_MEASUREMENTS
 157
 158
 159 echo "-------------------------------------------------------------------------------------------------"
 160 echo "-----------------------------------      Test case: "$ATC
 161 echo "-----------------------------------      Started:   "$(date)
 162 echo "-------------------------------------------------------------------------------------------------"
 163 echo "-- Description: "$TC_ONELINE_DESCR
 164 echo "-------------------------------------------------------------------------------------------------"
 165 echo "-----------------------------------      Test case setup      -----------------------------------"
 166
 167 START_ARG=$1
 168 paramerror=0
 169 if [ $# -lt 1 ]; then
 170         paramerror=1
 171 fi
 172 if [ $paramerror -eq 0 ]; then
 173         if [ "$1" != "remote" ] && [ "$1" != "remote-remove" ] && [ "$1" != "local" ]; then
 174                 paramerror=1
 175         else
 176                 shift;
 177         fi
 178 fi
 179 foundparm=0
 180 while [ $paramerror -eq 0 ] && [ $foundparm -eq 0 ]; do
 181         foundparm=1
 182         if [ $paramerror -eq 0 ]; then
 183                 if [ "$1" == "auto-clean" ]; then
 184                         AUTO_CLEAN="auto"
 185                         echo "Option set - Auto clean at end of test script"
 186                         shift;
 187                         foundparm=0
 188                 fi
 189         fi
 190         if [ $paramerror -eq 0 ]; then
 191                 if [ "$1" == "--stop-at-error" ]; then
 192                         STOP_AT_ERROR=1
 193                         echo "Option set - Stop at first error"
 194                         shift;
 195                         foundparm=0
 196                 fi
 197         fi
 198         if [ $paramerror -eq 0 ]; then
 199                 if [ "$1" == "--ricsim-prefix" ]; then
 200                         shift;
 201                         RIC_SIM_PREFIX=$1
 202                         if [ -z "$1" ]; then
 203                                 paramerror=1
 204                         else
 205                                 echo "Option set - Overriding RIC_SIM_PREFIX with: "$1
 206                                 shift;
 207                                 foundparm=0
 208                         fi
 209                 fi
 210         fi
 211         if [ $paramerror -eq 0 ]; then
 212                 if [ "$1" == "--env-file" ]; then
 213                         shift;
 214                         TEST_ENV_VAR_FILE=$1
 215                         if [ -z "$1" ]; then
 216                                 paramerror=1
 217                         else
 218                                 echo "Option set - Overriding test_env.sh with: "$1
 219                                 shift;
 220                                 foundparm=0
 221                         fi
 222                 fi
 223         fi
 224         if [ $paramerror -eq 0 ]; then
 225                 if [ "$1" == "--use-local-image" ]; then
 226                         USE_LOCAL_IMAGES=""
 227                         shift
 228                         while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
 229                                 USE_LOCAL_IMAGES=$USE_LOCAL_IMAGES" "$1
 230                                 if [[ "$AVAILABLE_LOCAL_IMAGES_OVERRIDE" != *"$1"* ]]; then
 231                                         paramerror=1
 232                                 fi
 233                                 shift;
 234                         done
 235                         foundparm=0
 236                         if [ -z "$USE_LOCAL_IMAGES" ]; then
 237                                 paramerror=1
 238                         else
 239                                 echo "Option set - Override remote images for app(s):"$USE_LOCAL_IMAGES
 240                         fi
 241                 fi
 242         fi
 243 done
 244 echo ""
 245
 246 #Still params left?
 247 if [ $paramerror -eq 0 ] && [ $# -gt 0 ]; then
 248         paramerror=1
 249 fi
 250
 251 if [ $paramerror -eq 1 ]; then
 252         echo -e $RED"Expected arg: local|remote|remote-remove [auto-clean] [--stop-at-error] [--ricsim-prefix <prefix> ] [ --env-file <environment-filename> ] [--use-local-image <app-nam> [<app-name>]*]"$ERED
 253         exit 1
 254 fi
 255
 256 # sourcing the selected env variables for the test case
 257 if [ -f "$TEST_ENV_VAR_FILE" ]; then
 258         echo -e $BOLD"Sourcing env vars from: "$TEST_ENV_VAR_FILE$EBOLD
 259         . $TEST_ENV_VAR_FILE
 260 else
 261         echo -e $RED"Selected env var file does not exist: "$TEST_ENV_VAR_FILE$ERED
 262         exit 1
 263 fi
 264
 265 #Vars for A1 interface version and container count
 266 G1_A1_VERSION=""
 267 G2_A1_VERSION=""
 268 G3_A1_VERSION=""
 269 G1_COUNT=0
 270 G2_COUNT=0
 271 G3_COUNT=0
 272
 273 # Vars to switch between http and https. Extra curl flag needed for https
 274 export RIC_SIM_HTTPX="http"
 275 export RIC_SIM_LOCALHOST=$RIC_SIM_HTTPX"://localhost:"
 276 export RIC_SIM_PORT=$RIC_SIM_INTERNAL_PORT
 277 export RIC_SIM_CERT_MOUNT_DIR="./cert"
 278
 279 export MR_HTTPX="http"
 280 export MR_PORT=$MR_INTERNAL_PORT
 281 export MR_LOCAL_PORT=$MR_EXTERNAL_PORT #When agent is running outside the docker net
 282
 283 export CR_HTTPX="http"
 284 export CR_PORT=$CR_INTERNAL_PORT
 285 export CR_LOCAL_PORT=$CR_EXTERNAL_PORT #When CR is running outside the docker net
 286
 287 export PROD_STUB_HTTPX="http"
 288 export PROD_STUB_PORT=$PROD_STUB_INTERNAL_PORT
 289 export PROD_STUB_LOCAL_PORT=$PROD_STUB_EXTERNAL_PORT #When CR is running outside the docker net
 290 export PROD_STUB_LOCALHOST=$PROD_STUB_HTTPX"://localhost:"$PROD_STUB_LOCAL_PORT
 291
 292 export SDNC_HTTPX="http"
 293 export SDNC_PORT=$SDNC_INTERNAL_PORT
 294 export SDNC_LOCAL_PORT=$SDNC_EXTERNAL_PORT #When agent is running outside the docker net
 295
 296 echo -e $BOLD"Checking configured image setting for this test case"$EBOLD
 297
 298 #Temp var to check for image variable name errors
 299 IMAGE_ERR=0
 300 #Create a file with image info for later printing as a table
 301 image_list_file="./tmp/.image-list"
 302 echo -e " Container\tImage\ttag" > $image_list_file
 303
 304 # Check if image env var is set and if so export the env var with image to use (used by docker compose files)
 305 # arg: <image name> <script start-arg> <target-variable-name> <image-variable-name> <image-tag-variable-name> <app-short-name>
 306 __check_image_var() {
 307         if [ $# -ne 6 ]; then
 308                 echo "Expected arg: <image name> <script start-arg> <target-variable-name> <image-variable-name> <image-tag-variable-name> <app-short-name>"
 309                 ((IMAGE_ERR++))
 310                 return
 311         fi
 312         __check_included_image $6
 313         if [ $? -ne 0 ]; then
 314                 echo -e "$1\t<image-excluded>\t<no-tag>"  >> $image_list_file
 315                 # Image is excluded since the corresponding app is not used in this test
 316                 return
 317         fi
 318         tmp=${1}"\t"
 319         #Create var from the input var names
 320         image="${!4}"
 321         tag="${!5}"
 322
 323         if [ -z $image ]; then
 324                 echo -e $RED"\$"$4" not set in test_env"$ERED
 325                 ((IMAGE_ERR++))
 326                 echo ""
 327                 tmp=$tmp"<no-image>\t"
 328         else
 329                 tmp=$tmp$image"\t"
 330         fi
 331         if [ -z $tag ]; then
 332                 echo -e $RED"\$"$5" not set in test_env"$ERED
 333                 ((IMAGE_ERR++))
 334                 echo ""
 335                 tmp=$tmp"<no-tag>\t"
 336         else
 337                 tmp=$tmp$tag
 338         fi
 339         echo -e "$tmp" >> $image_list_file
 340         #Export the env var
 341         export "${3}"=$image":"$tag
 342
 343         #echo " Configured image for ${1} (script start arg=${2}): "$image":"$tag
 344 }
 345
 346
 347 #Check if app local image shall override remote image
 348 # Possible IDs for local image override: PA, CP, SDNC, RICSIM, ECS
 349 __check_image_local_override() {
 350         for im in $USE_LOCAL_IMAGES; do
 351                 if [ "$1" == "$im" ]; then
 352                         return 1
 353                 fi
 354         done
 355         return 0
 356 }
 357
 358 # Check if app uses image included in this test run
 359 # Returns 0 if image is included, 1 if not
 360 # Possible IDs for image inclusion: CBS, CONSUL, CP, CR, ECS, MR, PA, PRODSTUB, RICSIM, SDNC
 361 __check_included_image() {
 362         for im in $INCLUDED_IMAGES; do
 363                 if [ "$1" == "$im" ]; then
 364                         return 0
 365                 fi
 366         done
 367         return 1
 368 }
 369
 370 # Check that image env setting are available
 371 echo ""
 372
 373 if [ $START_ARG == "local" ]; then
 374
 375         #Local agent image
 376         __check_image_var " Policy Agent" $START_ARG "POLICY_AGENT_IMAGE" "POLICY_AGENT_LOCAL_IMAGE" "POLICY_AGENT_LOCAL_IMAGE_TAG" PA
 377
 378         #Local Control Panel image
 379         __check_image_var " Control Panel" $START_ARG "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_LOCAL_IMAGE" "CONTROL_PANEL_LOCAL_IMAGE_TAG" CP
 380
 381         #Local SNDC image
 382         __check_image_var " SDNC A1 Controller" $START_ARG "SDNC_A1_CONTROLLER_IMAGE" "SDNC_A1_CONTROLLER_LOCAL_IMAGE" "SDNC_A1_CONTROLLER_LOCAL_IMAGE_TAG" SDNC
 383
 384         #Local ric sim image
 385         __check_image_var " RIC Simulator" $START_ARG "RIC_SIM_IMAGE" "RIC_SIM_LOCAL_IMAGE" "RIC_SIM_LOCAL_IMAGE_TAG" RICSIM
 386
 387 elif [ $START_ARG == "remote" ] || [ $START_ARG == "remote-remove" ]; then
 388
 389         __check_image_local_override 'PA'
 390         if [ $? -eq 0 ]; then
 391                 #Remote agent image
 392                 __check_image_var " Policy Agent" $START_ARG "POLICY_AGENT_IMAGE" "POLICY_AGENT_REMOTE_IMAGE" "POLICY_AGENT_REMOTE_IMAGE_TAG" PA
 393         else
 394                 #Local agent image
 395                 __check_image_var " Policy Agent" $START_ARG "POLICY_AGENT_IMAGE" "POLICY_AGENT_LOCAL_IMAGE" "POLICY_AGENT_LOCAL_IMAGE_TAG" PA
 396         fi
 397
 398         __check_image_local_override 'CP'
 399         if [ $? -eq 0 ]; then
 400                 #Remote Control Panel image
 401                 __check_image_var " Control Panel" $START_ARG "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_REMOTE_IMAGE" "CONTROL_PANEL_REMOTE_IMAGE_TAG" CP
 402         else
 403                 #Local Control Panel image
 404                 __check_image_var " Control Panel" $START_ARG "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_LOCAL_IMAGE" "CONTROL_PANEL_LOCAL_IMAGE_TAG" CP
 405         fi
 406
 407         __check_image_local_override 'SDNC'
 408         if [ $? -eq 0 ]; then
 409                 #Remote SDNC image
 410                 __check_image_var " SDNC A1 Controller" $START_ARG "SDNC_A1_CONTROLLER_IMAGE" "SDNC_A1_CONTROLLER_REMOTE_IMAGE" "SDNC_A1_CONTROLLER_REMOTE_IMAGE_TAG" SDNC
 411         else
 412                 #Local SNDC image
 413                 __check_image_var " SDNC A1 Controller" $START_ARG "SDNC_A1_CONTROLLER_IMAGE" "SDNC_A1_CONTROLLER_LOCAL_IMAGE" "SDNC_A1_CONTROLLER_LOCAL_IMAGE_TAG" SDNC
 414         fi
 415
 416         __check_image_local_override 'RICSIM'
 417         if [ $? -eq 0 ]; then
 418                 #Remote ric sim image
 419                 __check_image_var " RIC Simulator" $START_ARG "RIC_SIM_IMAGE" "RIC_SIM_REMOTE_IMAGE" "RIC_SIM_REMOTE_IMAGE_TAG" RICSIM
 420         else
 421                 #Local ric sim image
 422                 __check_image_var " RIC Simulator" $START_ARG "RIC_SIM_IMAGE" "RIC_SIM_LOCAL_IMAGE" "RIC_SIM_LOCAL_IMAGE_TAG" RICSIM
 423         fi
 424
 425         __check_image_local_override 'ECS'
 426         if [ $? -eq 0 ]; then
 427                 #Remote ecs image
 428                 __check_image_var " ECS" $START_ARG "ECS_IMAGE" "ECS_REMOTE_IMAGE" "ECS_REMOTE_IMAGE_TAG" ECS
 429         else
 430                 #Local ecs image
 431                 __check_image_var " ECS" $START_ARG "ECS_IMAGE" "ECS_LOCAL_IMAGE" "ECS_LOCAL_IMAGE_TAG" ECS
 432         fi
 433
 434 else
 435         #Should never get here....
 436         echo "Unknow args: "$@
 437         exit 1
 438 fi
 439
 440
 441 # These images are not built as part of this project official images, just check that env vars are set correctly
 442 __check_image_var " Message Router" $START_ARG "MRSTUB_IMAGE" "MRSTUB_LOCAL_IMAGE" "MRSTUB_LOCAL_IMAGE_TAG" MR
 443 __check_image_var " Callback Receiver" $START_ARG "CR_IMAGE" "CR_LOCAL_IMAGE" "CR_LOCAL_IMAGE_TAG" CR
 444 __check_image_var " Producer stub" $START_ARG "PROD_STUB_IMAGE" "PROD_STUB_LOCAL_IMAGE" "PROD_STUB_LOCAL_IMAGE_TAG" PRODSTUB
 445 __check_image_var " Consul" $START_ARG "CONSUL_IMAGE" "CONSUL_REMOTE_IMAGE" "CONSUL_REMOTE_IMAGE_TAG" CONSUL
 446 __check_image_var " CBS" $START_ARG "CBS_IMAGE" "CBS_REMOTE_IMAGE" "CBS_REMOTE_IMAGE_TAG" CBS
 447 __check_image_var " SDNC DB" $START_ARG "SDNC_DB_IMAGE" "SDNC_DB_REMOTE_IMAGE" "SDNC_DB_REMOTE_IMAGE_TAG" SDNC #Uses sdnc app name
 448
 449 #Errors in image setting - exit
 450 if [ $IMAGE_ERR -ne 0 ]; then
 451         exit 1
 452 fi
 453
 454 #Print a tables of the image settings
 455 echo -e $BOLD"Images configured for start arg: "$START $EBOLD
 456 column -t -s $'\t' $image_list_file
 457
 458 echo ""
 459
 460
 461 #Set the SIM_GROUP var
 462 echo -e $BOLD"Setting var to main dir of all container/simulator scripts"$EBOLD
 463 if [ -z "$SIM_GROUP" ]; then
 464         SIM_GROUP=$PWD/../simulator-group
 465         if [ ! -d  $SIM_GROUP ]; then
 466                 echo "Trying to set env var SIM_GROUP to dir 'simulator-group' in the nontrtric repo, but failed."
 467                 echo -e $RED"Please set the SIM_GROUP manually in the test_env.sh"$ERED
 468                 exit 1
 469         else
 470                 echo " SIM_GROUP auto set to: " $SIM_GROUP
 471         fi
 472 elif [ $SIM_GROUP = *simulator_group ]; then
 473         echo -e $RED"Env var SIM_GROUP does not seem to point to dir 'simulator-group' in the repo, check common/test_env.sh"$ERED
 474         exit 1
 475 else
 476         echo " SIM_GROUP env var already set to: " $SIM_GROUP
 477 fi
 478
 479 echo ""
 480
 481 #Temp var to check for image pull errors
 482 IMAGE_ERR=0
 483
 484 #Function to check if image exist and stop+remove the container+pull new images as needed
 485 #args <script-start-arg> <descriptive-image-name> <container-base-name> <image-with-tag>
 486 __check_and_pull_image() {
 487
 488         echo -e " Checking $BOLD$2$EBOLD container(s) with basename: $BOLD$3$EBOLD using image: $BOLD$4$EBOLD"
 489         format_string="\"{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\""
 490         tmp_im=$(docker images --format $format_string ${4})
 491
 492         if [ $1 == "local" ]; then
 493                 if [ -z "$tmp_im" ]; then
 494                         echo -e "  "$2" (local image): \033[1m"$4"\033[0m $RED does not exist in local registry, need to be built (or manually pulled)"$ERED
 495                         ((IMAGE_ERR++))
 496                         return 1
 497                 else
 498                         echo -e "  "$2" (local image): \033[1m"$4"\033[0m "$GREEN"OK"$EGREEN
 499                 fi
 500         elif [ $1 == "remote" ] || [ $1 == "remote-remove" ]; then
 501                 if [ $1 == "remote-remove" ]; then
 502                         echo -ne "  Attempt to stop and remove container(s), if running - ${SAMELINE}"
 503                         tmp="$(docker ps -aq --filter name=${3})"
 504                         if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
 505                                 docker stop $tmp &> ./tmp/.dockererr
 506                                 if [ $? -ne 0 ]; then
 507                                         ((IMAGE_ERR++))
 508                                         echo ""
 509                                         echo -e $RED"  Container(s) could not be stopped - try manual stopping the container(s)"$ERED
 510                                         cat ./tmp/.dockererr
 511                                         return 1
 512                                 fi
 513                         fi
 514                         echo -ne "  Attempt to stop and remove container(s), if running - "$GREEN"stopped"$EGREEN"${SAMELINE}"
 515                         tmp="$(docker ps -aq --filter name=${3})" &> /dev/null
 516                         if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
 517                                 docker rm $tmp &> ./tmp/.dockererr
 518                                 if [ $? -ne 0 ]; then
 519                                         ((IMAGE_ERR++))
 520                                         echo ""
 521                                         echo -e $RED"  Container(s) could not be removed - try manual removal of the container(s)"$ERED
 522                                         cat ./tmp/.dockererr
 523                                         return 1
 524                                 fi
 525                         fi
 526                         echo -e "  Attempt to stop and remove container(s), if running - "$GREEN"stopped removed"$EGREEN
 527                         echo -ne "  Removing image - ${SAMELINE}"
 528                         tmp="$(docker images -q ${4})" &> /dev/null
 529                         if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
 530                                 docker rmi --force $4 &> ./tmp/.dockererr
 531                                 if [ $? -ne 0 ]; then
 532                                         ((IMAGE_ERR++))
 533                                         echo ""
 534                                         echo -e $RED"  Image could not be removed - try manual removal of the image"$ERED
 535                                         cat ./tmp/.dockererr
 536                                         return 1
 537                                 fi
 538                                 echo -e "  Removing image - "$GREEN"removed"$EGREEN
 539                         else
 540                                 echo -e "  Removing image - "$GREEN"image not in repository"$EGREEN
 541                         fi
 542                         tmp_im=""
 543                 fi
 544                 if [ -z "$tmp_im" ]; then
 545                         echo -ne "  Pulling image${SAMELINE}"
 546                         docker pull $4  &> ./tmp/.dockererr
 547                         tmp_im=$(docker images ${4} | grep -v REPOSITORY)
 548                         if [ -z "$tmp_im" ]; then
 549                                 echo ""
 550                                 echo -e "  Pulling image -$RED could not be pulled"$ERED
 551                                 ((IMAGE_ERR++))
 552                                 cat ./tmp/.dockererr
 553                                 return 1
 554                         fi
 555                         echo -e "  Pulling image -$GREEN Pulled $EGREEN"
 556                 else
 557                         echo -e "  Pulling image -$GREEN OK $EGREEN(exists in local repository)"
 558                 fi
 559         fi
 560         return 0
 561 }
 562
 563
 564 echo -e $BOLD"Pulling configured images, if needed"$EBOLD
 565
 566 __check_included_image 'PA'
 567 if [ $? -eq 0 ]; then
 568         START_ARG_MOD=$START_ARG
 569         __check_image_local_override 'PA'
 570         if [ $? -eq 1 ]; then
 571                 START_ARG_MOD="local"
 572         fi
 573         app="Policy Agent";             __check_and_pull_image $START_ARG_MOD "$app" $POLICY_AGENT_APP_NAME $POLICY_AGENT_IMAGE
 574 else
 575         echo -e $YELLOW" Excluding PA image from image check/pull"$EYELLOW
 576 fi
 577
 578 __check_included_image 'ECS'
 579 if [ $? -eq 0 ]; then
 580         START_ARG_MOD=$START_ARG
 581         __check_image_local_override 'ECS'
 582         if [ $? -eq 1 ]; then
 583                 START_ARG_MOD="local"
 584         fi
 585         app="ECS";             __check_and_pull_image $START_ARG_MOD "$app" $ECS_APP_NAME $ECS_IMAGE
 586 else
 587         echo -e $YELLOW" Excluding ECS image from image check/pull"$EYELLOW
 588 fi
 589
 590 __check_included_image 'CP'
 591 if [ $? -eq 0 ]; then
 592         START_ARG_MOD=$START_ARG
 593         __check_image_local_override 'CP'
 594         if [ $? -eq 1 ]; then
 595                 START_ARG_MOD="local"
 596         fi
 597         app="Non-RT RIC Control Panel"; __check_and_pull_image $START_ARG_MOD "$app" $CONTROL_PANEL_APP_NAME $CONTROL_PANEL_IMAGE
 598 else
 599         echo -e $YELLOW" Excluding Non-RT RIC Control Panel image from image check/pull"$EYELLOW
 600 fi
 601
 602 __check_included_image 'RICSIM'
 603 if [ $? -eq 0 ]; then
 604         START_ARG_MOD=$START_ARG
 605         __check_image_local_override 'RICSIM'
 606         if [ $? -eq 1 ]; then
 607                 START_ARG_MOD="local"
 608         fi
 609         app="Near-RT RIC Simulator";    __check_and_pull_image $START_ARG_MOD "$app" $RIC_SIM_PREFIX"_"$RIC_SIM_BASE $RIC_SIM_IMAGE
 610 else
 611         echo -e $YELLOW" Excluding Near-RT RIC Simulator image from image check/pull"$EYELLOW
 612 fi
 613
 614
 615 __check_included_image 'CONSUL'
 616 if [ $? -eq 0 ]; then
 617         app="Consul";                   __check_and_pull_image $START_ARG "$app" $CONSUL_APP_NAME $CONSUL_IMAGE
 618 else
 619         echo -e $YELLOW" Excluding Consul image from image check/pull"$EYELLOW
 620 fi
 621
 622 __check_included_image 'CBS'
 623 if [ $? -eq 0 ]; then
 624         app="CBS";                      __check_and_pull_image $START_ARG "$app" $CBS_APP_NAME $CBS_IMAGE
 625 else
 626         echo -e $YELLOW" Excluding CBS image from image check/pull"$EYELLOW
 627 fi
 628
 629 __check_included_image 'SDNC'
 630 if [ $? -eq 0 ]; then
 631         START_ARG_MOD=$START_ARG
 632         __check_image_local_override 'SDNC'
 633         if [ $? -eq 1 ]; then
 634                 START_ARG_MOD="local"
 635         fi
 636         app="SDNC A1 Controller";       __check_and_pull_image $START_ARG_MOD "$app" $SDNC_APP_NAME $SDNC_A1_CONTROLLER_IMAGE
 637         app="SDNC DB";                  __check_and_pull_image $START_ARG "$app" $SDNC_APP_NAME $SDNC_DB_IMAGE
 638 else
 639         echo -e $YELLOW" Excluding SDNC image and related DB image from image check/pull"$EYELLOW
 640 fi
 641
 642 #Errors in image setting - exit
 643 if [ $IMAGE_ERR -ne 0 ]; then
 644         echo ""
 645         echo "#################################################################################################"
 646         echo -e $RED"One or more images could not be pulled or containers using the images could not be stopped/removed"$ERED
 647         echo -e $RED"Or local image, overriding remote image, does not exist"$ERED
 648         echo "#################################################################################################"
 649         echo ""
 650         exit 1
 651 fi
 652
 653 echo ""
 654
 655 echo -e $BOLD"Building images needed for test"$EBOLD
 656
 657 curdir=$PWD
 658 __check_included_image 'MR'
 659 if [ $? -eq 0 ]; then
 660         cd $curdir
 661         cd ../mrstub
 662         echo " Building mrstub image: $MRSTUB_LOCAL_IMAGE:$MRSTUB_LOCAL_IMAGE_TAG"
 663         docker build -t $MRSTUB_LOCAL_IMAGE . &> .dockererr
 664         if [ $? -eq 0 ]; then
 665                 echo -e  $GREEN" Build Ok"$EGREEN
 666         else
 667                 echo -e $RED" Build Failed"$ERED
 668                 ((RES_CONF_FAIL++))
 669                 cat .dockererr
 670         fi
 671         cd $curdir
 672 else
 673         echo -e $YELLOW" Excluding mrstub from image build"$EYELLOW
 674 fi
 675
 676 __check_included_image 'CR'
 677 if [ $? -eq 0 ]; then
 678         cd ../cr
 679         echo " Building Callback Receiver image: $CR_LOCAL_IMAGE:$CR_IMAGE_TAG"
 680         docker build -t $CR_LOCAL_IMAGE . &> .dockererr
 681         if [ $? -eq 0 ]; then
 682                 echo -e  $GREEN" Build Ok"$EGREEN
 683         else
 684                 echo -e $RED" Build Failed"$ERED
 685                 ((RES_CONF_FAIL++))
 686                 cat .dockererr
 687         fi
 688         cd $curdir
 689 else
 690         echo -e $YELLOW" Excluding Callback Receiver from image build"$EYELLOW
 691 fi
 692
 693 __check_included_image 'PRODSTUB'
 694 if [ $? -eq 0 ]; then
 695         cd ../prodstub
 696         echo " Building Producer stub image: $PROD_STUB_LOCAL_IMAGE:$PROD_STUB_LOCAL_IMAGE_TAG"
 697         docker build -t $PROD_STUB_LOCAL_IMAGE . &> .dockererr
 698         if [ $? -eq 0 ]; then
 699                 echo -e  $GREEN" Build Ok"$EGREEN
 700         else
 701                 echo -e $RED" Build Failed"$ERED
 702                 ((RES_CONF_FAIL++))
 703                 cat .dockererr
 704         fi
 705         cd $curdir
 706 else
 707         echo -e $YELLOW" Excluding Producer stub from image build"$EYELLOW
 708 fi
 709
 710 echo ""
 711
 712 # Create a table of the images used in the script
 713 echo -e $BOLD"Local docker registry images used in the this test script"$EBOLD
 714
 715 docker_tmp_file=./tmp/.docker-images-table
 716 format_string="{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\\t{{.CreatedAt}}"
 717 echo -e " Application\tRepository\tTag\tCreated since\tSize\tCreated at" > $docker_tmp_file
 718 __check_included_image 'PA'
 719 if [ $? -eq 0 ]; then
 720         echo -e " Policy Agent\t$(docker images --format $format_string $POLICY_AGENT_IMAGE)" >>   $docker_tmp_file
 721 fi
 722 __check_included_image 'ECS'
 723 if [ $? -eq 0 ]; then
 724         echo -e " ECS\t$(docker images --format $format_string $ECS_IMAGE)" >>   $docker_tmp_file
 725 fi
 726 __check_included_image 'CP'
 727 if [ $? -eq 0 ]; then
 728         echo -e " Control Panel\t$(docker images --format $format_string $CONTROL_PANEL_IMAGE)" >>   $docker_tmp_file
 729 fi
 730 __check_included_image 'RICSIM'
 731 if [ $? -eq 0 ]; then
 732         echo -e " RIC Simulator\t$(docker images --format $format_string $RIC_SIM_IMAGE)" >>   $docker_tmp_file
 733 fi
 734 __check_included_image 'MR'
 735 if [ $? -eq 0 ]; then
 736         echo -e " Message Router\t$(docker images --format $format_string $MRSTUB_IMAGE)" >>   $docker_tmp_file
 737 fi
 738 __check_included_image 'CR'
 739 if [ $? -eq 0 ]; then
 740         echo -e " Callback Receiver\t$(docker images --format $format_string $CR_IMAGE)" >>   $docker_tmp_file
 741 fi
 742 __check_included_image 'PRODSTUB'
 743 if [ $? -eq 0 ]; then
 744         echo -e " Produccer stub\t$(docker images --format $format_string $PROD_STUB_IMAGE)" >>   $docker_tmp_file
 745 fi
 746 __check_included_image 'CONSUL'
 747 if [ $? -eq 0 ]; then
 748         echo -e " Consul\t$(docker images --format $format_string $CONSUL_IMAGE)" >>   $docker_tmp_file
 749 fi
 750 __check_included_image 'CBS'
 751 if [ $? -eq 0 ]; then
 752         echo -e " CBS\t$(docker images --format $format_string $CBS_IMAGE)" >>   $docker_tmp_file
 753 fi
 754 __check_included_image 'SDNC'
 755 if [ $? -eq 0 ]; then
 756         echo -e " SDNC A1 Controller\t$(docker images --format $format_string $SDNC_A1_CONTROLLER_IMAGE)" >>   $docker_tmp_file
 757         echo -e " SDNC DB\t$(docker images --format $format_string $SDNC_DB_IMAGE)" >>   $docker_tmp_file
 758 fi
 759
 760 column -t -s $'\t' $docker_tmp_file
 761
 762 echo ""
 763
 764 echo -e $BOLD"======================================================="$EBOLD
 765 echo -e $BOLD"== Common test setup completed -  test script begins =="$EBOLD
 766 echo -e $BOLD"======================================================="$EBOLD
 767 echo ""
 768
 769 # Function to print the test result, shall be the last cmd in a test script
 770 # args: -
 771 # (Function for test scripts)
 772 print_result() {
 773
 774         TCTEST_END=$SECONDS
 775         duration=$((TCTEST_END-TCTEST_START))
 776
 777         echo "-------------------------------------------------------------------------------------------------"
 778         echo "-------------------------------------     Test case: "$ATC
 779         echo "-------------------------------------     Ended:     "$(date)
 780         echo "-------------------------------------------------------------------------------------------------"
 781         echo "-- Description: "$TC_ONELINE_DESCR
 782         echo "-- Execution time: " $duration " seconds"
 783         echo "-------------------------------------------------------------------------------------------------"
 784         echo "-------------------------------------     RESULTS"
 785         echo ""
 786
 787
 788         if [ $RES_DEVIATION -gt 0 ]; then
 789                 echo "Test case deviations"
 790                 echo "===================================="
 791                 cat $DEVIATION_FILE
 792         fi
 793         echo ""
 794         echo "Timer measurement in the test script"
 795         echo "===================================="
 796         column -t -s $'\t' $TIMER_MEASUREMENTS
 797         echo ""
 798
 799         total=$((RES_PASS+RES_FAIL))
 800         if [ $RES_TEST -eq 0 ]; then
 801                 echo -e "\033[1mNo tests seem to have been executed. Check the script....\033[0m"
 802                 echo -e "\033[31m\033[1m ___  ___ ___ ___ ___ _____   ___ _   ___ _   _   _ ___ ___ \033[0m"
 803                 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_   _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
 804                 echo -e "\033[31m\033[1m\__ \ (__|   /| ||  _/ | |   | _/ _ \ | || |_| |_| |   / _| \033[0m"
 805                 echo -e "\033[31m\033[1m|___/\___|_|_\___|_|   |_|   |_/_/ \_\___|____\___/|_|_\___|\033[0m"
 806         elif [ $total != $RES_TEST ]; then
 807                 echo -e "\033[1mTotal number of tests does not match the sum of passed and failed tests. Check the script....\033[0m"
 808                 echo -e "\033[31m\033[1m ___  ___ ___ ___ ___ _____   ___ _   ___ _   _   _ ___ ___ \033[0m"
 809                 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_   _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
 810                 echo -e "\033[31m\033[1m\__ \ (__|   /| ||  _/ | |   | _/ _ \ | || |_| |_| |   / _| \033[0m"
 811                 echo -e "\033[31m\033[1m|___/\___|_|_\___|_|   |_|   |_/_/ \_\___|____\___/|_|_\___|\033[0m"
 812         elif [ $RES_CONF_FAIL -ne 0 ]; then
 813                 echo -e "\033[1mOne or more configure regest has failed. Check the script log....\033[0m"
 814                 echo -e "\033[31m\033[1m ___  ___ ___ ___ ___ _____   ___ _   ___ _   _   _ ___ ___ \033[0m"
 815                 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_   _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
 816                 echo -e "\033[31m\033[1m\__ \ (__|   /| ||  _/ | |   | _/ _ \ | || |_| |_| |   / _| \033[0m"
 817                 echo -e "\033[31m\033[1m|___/\___|_|_\___|_|   |_|   |_/_/ \_\___|____\___/|_|_\___|\033[0m"
 818         elif [ $RES_PASS = $RES_TEST ]; then
 819                 echo -e "All tests \033[32m\033[1mPASS\033[0m"
 820                 echo -e "\033[32m\033[1m  ___  _   ___ ___ \033[0m"
 821                 echo -e "\033[32m\033[1m | _ \/_\ / __/ __| \033[0m"
 822                 echo -e "\033[32m\033[1m |  _/ _ \\__ \__ \\ \033[0m"
 823                 echo -e "\033[32m\033[1m |_|/_/ \_\___/___/ \033[0m"
 824                 echo ""
 825
 826                 # Update test suite counter
 827                 if [ -f .tmp_tcsuite_pass_ctr ]; then
 828                         tmpval=$(< .tmp_tcsuite_pass_ctr)
 829                         ((tmpval++))
 830                         echo $tmpval > .tmp_tcsuite_pass_ctr
 831                 fi
 832                 if [ -f .tmp_tcsuite_pass ]; then
 833                         echo " - "$ATC " -- "$TC_ONELINE_DESCR"  Execution time: "$duration" seconds" >> .tmp_tcsuite_pass
 834                 fi
 835                 #Create file with OK exit code
 836                 echo "0" > "$PWD/.result$ATC.txt"
 837         else
 838                 echo -e "One or more tests with status  \033[31m\033[1mFAIL\033[0m "
 839                 echo -e "\033[31m\033[1m  ___ _   ___ _    \033[0m"
 840                 echo -e "\033[31m\033[1m | __/_\ |_ _| |   \033[0m"
 841                 echo -e "\033[31m\033[1m | _/ _ \ | || |__ \033[0m"
 842                 echo -e "\033[31m\033[1m |_/_/ \_\___|____|\033[0m"
 843                 echo ""
 844                 # Update test suite counter
 845                 if [ -f .tmp_tcsuite_fail_ctr ]; then
 846                         tmpval=$(< .tmp_tcsuite_fail_ctr)
 847                         ((tmpval++))
 848                         echo $tmpval > .tmp_tcsuite_fail_ctr
 849                 fi
 850                 if [ -f .tmp_tcsuite_fail ]; then
 851                         echo " - "$ATC " -- "$TC_ONELINE_DESCR"  Execution time: "$duration" seconds" >> .tmp_tcsuite_fail
 852                 fi
 853         fi
 854
 855         echo "++++ Number of tests:          "$RES_TEST
 856         echo "++++ Number of passed tests:   "$RES_PASS
 857         echo "++++ Number of failed tests:   "$RES_FAIL
 858         echo ""
 859         echo "++++ Number of failed configs: "$RES_CONF_FAIL
 860         echo ""
 861         echo "++++ Number of test case deviations: "$RES_DEVIATION
 862         echo ""
 863         echo "-------------------------------------     Test case complete    ---------------------------------"
 864         echo "-------------------------------------------------------------------------------------------------"
 865         echo ""
 866 }
 867
 868 #####################################################################
 869 ###### Functions for start, configuring, stoping, cleaning etc ######
 870 #####################################################################
 871
 872 # Start timer for time measurement
 873 # args - (any args will be printed though)
 874 start_timer() {
 875         echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
 876         TC_TIMER=$SECONDS
 877         echo " Timer started"
 878 }
 879
 880 # Print the value of the time (in seconds)
 881 # args - <timer message to print>  -  timer value and message will be printed both on screen
 882 #                                     and in the timer measurement report
 883 print_timer() {
 884         echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
 885         if [ $# -lt 1 ]; then
 886                 ((RES_CONF_FAIL++))
 887         __print_err "need 1 or more args,  <timer message to print>" $@
 888                 exit 1
 889         fi
 890         duration=$(($SECONDS-$TC_TIMER))
 891         if [ $duration -eq 0 ]; then
 892                 duration="<1 second"
 893         else
 894                 duration=$duration" seconds"
 895         fi
 896         echo " Timer duration :" $duration
 897
 898         echo -e "${@:1} \t $duration" >> $TIMER_MEASUREMENTS
 899 }
 900
 901 # Print the value of the time (in seconds) and reset the timer
 902 # args - <timer message to print>  -  timer value and message will be printed both on screen
 903 #                                     and in the timer measurement report
 904 print_and_reset_timer() {
 905         echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
 906         if [ $# -lt 1 ]; then
 907                 ((RES_CONF_FAIL++))
 908         __print_err "need 1 or more args,  <timer message to print>" $@
 909                 exit 1
 910         fi
 911         duration=$(($SECONDS-$TC_TIMER))" seconds"
 912         if [ $duration -eq 0 ]; then
 913                 duration="<1 second"
 914         else
 915                 duration=$duration" seconds"
 916         fi
 917         echo " Timer duration :" $duration
 918         TC_TIMER=$SECONDS
 919         echo " Timer reset"
 920
 921         echo -e "${@:1} \t $duration" >> $TIMER_MEASUREMENTS
 922
 923 }
 924 # Print info about a deviations from intended tests
 925 # Each deviation counted is also printed in the testreport
 926 # args <deviation message to print>
 927 deviation() {
 928         echo -e $BOLD"DEVIATION(${BASH_LINENO[0]}): "${FUNCNAME[0]} $EBOLD
 929         if [ $# -lt 1 ]; then
 930                 ((RES_CONF_FAIL++))
 931                 __print_err "need 1 or more args,  <deviation message to print>" $@
 932                 exit 1
 933         fi
 934         ((RES_DEVIATION++))
 935         echo -e $BOLD$YELLOW" Test case deviation: ${@:1}"$EYELLOW$EBOLD
 936         echo "Line: ${BASH_LINENO[0]} - ${@:1}" >> $DEVIATION_FILE
 937         echo ""
 938 }
 939
 940 # Stop at first FAIL test case and take all logs - only for debugging/trouble shooting
 941 __check_stop_at_error() {
 942         if [ $STOP_AT_ERROR -eq 1 ]; then
 943                 echo -e $RED"Test script configured to stop at first FAIL, taking all logs and stops"$ERED
 944                 store_logs "STOP_AT_ERROR"
 945                 exit 1
 946         fi
 947         return 0
 948 }
 949
 950 # Check if app name var is set. If so return the app name otherwise return "NOTSET"
 951 __check_app_name() {
 952         if [ $# -eq 1 ]; then
 953                 echo $1
 954         else
 955                 echo "NOTSET"
 956         fi
 957 }
 958
 959 # Stop and remove all containers
 960 # args: -
 961 # (Function for test scripts)
 962 clean_containers() {
 963
 964         echo -e $BOLD"Stopping and removing all running containers, by container name"$EBOLD
 965
 966         CONTAINTER_NAMES=("Policy Agent           " $(__check_app_name $POLICY_AGENT_APP_NAME)\
 967                                           "ECS                    " $(__check_app_name $ECS_APP_NAME)\
 968                                           "Non-RT RIC Simulator(s)" $(__check_app_name $RIC_SIM_PREFIX)\
 969                                           "Message Router         " $(__check_app_name $MR_APP_NAME)\
 970                                           "Callback Receiver      " $(__check_app_name $CR_APP_NAME)\
 971                                           "Producer stub          " $(__check_app_name $PROD_STUB_APP_NAME)\
 972                                           "Control Panel          " $(__check_app_name $CONTROL_PANEL_APP_NAME)\
 973                                           "SDNC A1 Controller     " $(__check_app_name $SDNC_APP_NAME)\
 974                                           "SDNC DB                " $(__check_app_name $SDNC_DB_APP_NAME)\
 975                                           "CBS                    " $(__check_app_name $CBS_APP_NAME)\
 976                                           "Consul                 " $(__check_app_name $CONSUL_APP_NAME))
 977
 978         nw=0 # Calc max width of container name, to make a nice table
 979         for (( i=1; i<${#CONTAINTER_NAMES[@]} ; i+=2 )) ; do
 980
 981                 if [ ${#CONTAINTER_NAMES[i]} -gt $nw ]; then
 982                         nw=${#CONTAINTER_NAMES[i]}
 983                 fi
 984         done
 985
 986         for (( i=0; i<${#CONTAINTER_NAMES[@]} ; i+=2 )) ; do
 987                 APP="${CONTAINTER_NAMES[i]}"
 988                 CONTR="${CONTAINTER_NAMES[i+1]}"
 989                 if [ $CONTR != "NOTSET" ]; then
 990                         for((w=${#CONTR}; w<$nw; w=w+1)); do
 991                                 CONTR="$CONTR "
 992                         done
 993                         echo -ne " $APP: $CONTR - ${GREEN}stopping${EGREEN}${SAMELINE}"
 994                         docker stop $(docker ps -qa --filter name=${CONTR}) &> /dev/null
 995                         echo -ne " $APP: $CONTR - ${GREEN}stopped${EGREEN}${SAMELINE}"
 996                         docker rm --force $(docker ps -qa --filter name=${CONTR}) &> /dev/null
 997                         echo -e  " $APP: $CONTR - ${GREEN}stopped removed${EGREEN}"
 998                 fi
 999         done
1000
1001         echo ""
1002
1003         echo -e $BOLD" Removing docker network"$EBOLD
1004         TMP=$(docker network ls -q --filter name=$DOCKER_SIM_NWNAME)
1005         if [ "$TMP" ==  $DOCKER_SIM_NWNAME ]; then
1006                 docker network rm $DOCKER_SIM_NWNAME | indent2
1007                 if [ $? -ne 0 ];  then
1008                         echo -e $RED" Cannot remove docker network. Manually remove or disconnect containers from $DOCKER_SIM_NWNAME"$ERED
1009                         exit 1
1010                 fi
1011         fi
1012         echo -e "$GREEN  Done$EGREEN"
1013
1014         echo -e $BOLD" Removing all unused docker neworks"$EBOLD
1015         docker network prune --force | indent2
1016         echo -e "$GREEN  Done$EGREEN"
1017
1018         echo -e $BOLD" Removing all unused docker volumes"$EBOLD
1019         docker volume prune --force | indent2
1020         echo -e "$GREEN  Done$EGREEN"
1021
1022         echo -e $BOLD" Removing all dangling/untagged docker images"$EBOLD
1023     docker rmi --force $(docker images -q -f dangling=true) &> /dev/null
1024         echo -e "$GREEN  Done$EGREEN"
1025         echo ""
1026
1027         CONTRS=$(docker ps | awk '$1 != "CONTAINER" { n++ }; END { print n+0 }')
1028         if [ $? -eq 0 ]; then
1029                 if [ $CONTRS -ne 0 ]; then
1030                         echo -e $RED"Containers running, may cause distubance to the test case"$ERED
1031                         docker ps -a
1032                 fi
1033         fi
1034 }
1035
1036 # Function stop and remove all container in the end of the test script, if the arg 'auto-clean' is given at test script start
1037 # args: -
1038 # (Function for test scripts)
1039 auto_clean_containers() {
1040         echo
1041         if [ "$AUTO_CLEAN" == "auto" ]; then
1042                 echo -e $BOLD"Initiating automatic cleaning of started containers"$EBOLD
1043                 clean_containers
1044         fi
1045 }
1046
1047 # Function to sleep a test case for a numner of seconds. Prints the optional text args as info
1048 # args: <sleep-time-in-sec> [any-text-in-quotes-to-be-printed]
1049 # (Function for test scripts)
1050 sleep_wait() {
1051
1052         echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
1053         if [ $# -lt 1 ]; then
1054                 ((RES_CONF_FAIL++))
1055                 __print_err "need at least one arg, <sleep-time-in-sec> [any-text-to-printed]" $@
1056                 exit 1
1057         fi
1058         #echo "---- Sleep for " $1 " seconds ---- "$2
1059         start=$SECONDS
1060         duration=$((SECONDS-start))
1061         while [ $duration -lt $1 ]; do
1062                 echo -ne "  Slept for ${duration} seconds${SAMELINE}"
1063                 sleep 1
1064                 duration=$((SECONDS-start))
1065         done
1066         echo -ne "  Slept for ${duration} seconds${SAMELINE}"
1067         echo ""
1068 }
1069
1070 # Print error info for the call in the parent script (test case). Arg: <error-message-to-print>
1071 # Not to be called from the test script itself.
1072 __print_err() {
1073     echo -e $RED ${FUNCNAME[1]} " "$1" " ${BASH_SOURCE[2]} " line" ${BASH_LINENO[1]} $ERED
1074         if [ $# -gt 1 ]; then
1075                 echo -e $RED" Got: "${FUNCNAME[1]} ${@:2} $ERED
1076         fi
1077 }
1078
1079
1080 # Helper function to get a the port of a specific ric simulatpor
1081 # args: <ric-id>
1082 # (Not for test scripts)
1083 __find_sim_port() {
1084     name=$1" " #Space appended to prevent matching 10 if 1 is desired....
1085     cmdstr="docker inspect --format='{{(index (index .NetworkSettings.Ports \"$RIC_SIM_PORT/tcp\") 0).HostPort}}' ${name}"
1086     res=$(eval $cmdstr)
1087         if [[ "$res" =~ ^[0-9]+$ ]]; then
1088                 echo $res
1089         else
1090                 echo "0"
1091     fi
1092 }
1093
1094 # Function to create the docker network for the test
1095 # Not to be called from the test script itself.
1096 __create_docker_network() {
1097         tmp=$(docker network ls --format={{.Name}} --filter name=$DOCKER_SIM_NWNAME)
1098         if [ $? -ne 0 ]; then
1099                 echo -e $RED" Could not check if docker network $DOCKER_SIM_NWNAME exists"$ERED
1100                 return 1
1101         fi
1102         if [ "$tmp" != $DOCKER_SIM_NWNAME ]; then
1103                 echo -e " Creating docker network:$BOLD $DOCKER_SIM_NWNAME $EBOLD"
1104                 docker network create $DOCKER_SIM_NWNAME | indent2
1105                 if [ $? -ne 0 ]; then
1106                         echo -e $RED" Could not create docker network $DOCKER_SIM_NWNAME"$ERED
1107                         return 1
1108                 else
1109                         echo -e "$GREEN  Done$EGREEN"
1110                 fi
1111         else
1112                 echo -e " Docker network $DOCKER_SIM_NWNAME already exists$GREEN OK $EGREEN"
1113         fi
1114 }
1115
1116 # Check if container is started by calling url on localhost using a port, expects response code 2XX
1117 # args: <container-name> <port> <url> https|https
1118 # Not to be called from the test script itself.
1119 __check_container_start() {
1120         paramError=0
1121         if [ $# -ne 4 ]; then
1122                 paramError=1
1123         elif [ $4 != "http" ] && [ $4 != "https" ]; then
1124                 paramError=1
1125         fi
1126         if [ $paramError -ne 0 ]; then
1127                 ((RES_CONF_FAIL++))
1128                 __print_err "need 3 args, <container-name> <port> <url> https|https" $@
1129                 return 1
1130         fi
1131         echo -ne " Container $BOLD$1$EBOLD starting${SAMELINE}"
1132         appname=$1
1133         localport=$2
1134         url=$3
1135         if [[ $appname != "STANDALONE_"* ]]     ; then
1136                 app_started=0
1137                 for i in {1..10}; do
1138                         if [ "$(docker inspect --format '{{ .State.Running }}' $appname)" == "true" ]; then
1139                                         echo -e " Container $BOLD$1$EBOLD$GREEN running$EGREEN on$BOLD image $(docker inspect --format '{{ .Config.Image }}' ${appname}) $EBOLD"
1140                                         app_started=1
1141                                         break
1142                                 else
1143                                         sleep $i
1144                         fi
1145                 done
1146                 if [ $app_started -eq 0 ]; then
1147                         ((RES_CONF_FAIL++))
1148                         echo ""
1149                         echo -e $RED" Container $BOLD${appname}$EBOLD could not be started"$ERED
1150                         return 1
1151                 fi
1152                 if [ $localport -eq 0 ]; then
1153                         while [ $localport -eq 0 ]; do
1154                                 echo -ne " Waiting for container ${appname} to publish its ports...${SAMELINE}"
1155                                 localport=$(__find_sim_port $appname)
1156                                 sleep 1
1157                                 echo -ne " Waiting for container ${appname} to publish its ports...retrying....${SAMELINE}"
1158                         done
1159                         echo -ne " Waiting for container ${appname} to publish its ports...retrying....$GREEN OK $EGREEN"
1160                         echo ""
1161                 fi
1162         fi
1163
1164         pa_st=false
1165         echo -ne " Waiting for container ${appname} service status...${SAMELINE}"
1166         TSTART=$SECONDS
1167         for i in {1..50}; do
1168                 if [ $4 == "https" ]; then
1169                         result="$(__do_curl "-k https://localhost:"${localport}${url})"
1170                 else
1171                         result="$(__do_curl $LOCALHOST${localport}${url})"
1172                 fi
1173                 if [ $? -eq 0 ]; then
1174                         if [ ${#result} -gt 15 ]; then
1175                                 #If response is too long, truncate
1176                                 result="...response text too long, omitted"
1177                         fi
1178                         echo -ne " Waiting for container $BOLD${appname}$EBOLD service status, result: $result${SAMELINE}"
1179                         echo -ne " Container $BOLD${appname}$EBOLD$GREEN is alive$EGREEN, responds to service status:$GREEN $result $EGREEN after $(($SECONDS-$TSTART)) seconds"
1180                         pa_st=true
1181                         break
1182                 else
1183                         TS_TMP=$SECONDS
1184                         while [ $(($TS_TMP+$i)) -gt $SECONDS ]; do
1185                                 echo -ne " Waiting for container ${appname} service status...retrying in $(($TS_TMP+$i-$SECONDS)) seconds   ${SAMELINE}"
1186                                 sleep 1
1187                         done
1188                 fi
1189         done
1190
1191         if [ "$pa_st" = "false"  ]; then
1192                 ((RES_CONF_FAIL++))
1193                 echo -e $RED" Container ${appname} did not respond to service status"$ERED
1194                 return 0
1195         fi
1196
1197         echo ""
1198         return 0
1199 }
1200
1201
1202 # Function to start a container and wait until it responds on the given port and url.
1203 #args: <docker-compose-dir> NODOCKERARGS|<docker-compose-arg> <app-name> <port-number> <alive-url> [<app-name> <port-number> <alive-url>]*
1204 __start_container() {
1205
1206         variableArgCount=$(($#-2))
1207         if [ $# -lt 6 ] && [ [ $(($variableArgCount%4)) -ne 0 ]; then
1208                 ((RES_CONF_FAIL++))
1209         __print_err "need 6 or more args,  <docker-compose-dir> NODOCKERARGS|<docker-compose-arg> <app-name> <port-number> <alive-url> http|https [<app-name> <port-number> <alive-url> http|https ]*" $@
1210                 exit 1
1211         fi
1212
1213         __create_docker_network
1214
1215         curdir=$PWD
1216         cd $SIM_GROUP
1217         cd $1
1218
1219         if [ "$2" == "NODOCKERARGS" ]; then
1220                 docker-compose up -d &> .dockererr
1221                 if [ $? -ne 0 ]; then
1222                         echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
1223                         cat .dockererr
1224                 fi
1225         elif [ "$2" == "STANDALONE" ]; then
1226                 echo "Skipping docker-compose"
1227         else
1228                 docker-compose up -d $2 &> .dockererr
1229                 if [ $? -ne 0 ]; then
1230                         echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
1231                         cat .dockererr
1232                 fi
1233         fi
1234         app_prefix=""
1235         if [ "$2" == "STANDALONE" ]; then
1236                 app_prefix="STANDALONE_"
1237         fi
1238         shift; shift;
1239         cntr=0
1240         while [ $cntr -lt $variableArgCount ]; do
1241                 app=$app_prefix$1; shift;
1242                 port=$1; shift;
1243                 url=$1; shift;
1244                 httpx=$1; shift;
1245                 let cntr=cntr+4
1246
1247                 __check_container_start "$app" "$port" "$url" $httpx
1248         done
1249
1250         cd $curdir
1251         echo ""
1252         return 0
1253 }
1254
1255 # Generate a UUID to use as prefix for policy ids
1256 generate_uuid() {
1257         UUID=$(python3 -c 'import sys,uuid; sys.stdout.write(uuid.uuid4().hex)')
1258         #Reduce length to make space for serial id, us 'a' as marker where the serial id is added
1259         UUID=${UUID:0:${#UUID}-4}"a"
1260 }
1261
1262 ####################
1263 ### Consul functions
1264 ####################
1265
1266 # Function to load config from a file into consul for the Policy Agent
1267 # arg: <json-config-file>
1268 # (Function for test scripts)
1269 consul_config_app() {
1270
1271         echo -e $BOLD"Configuring Consul"$EBOLD
1272
1273         if [ $# -ne 1 ]; then
1274                 ((RES_CONF_FAIL++))
1275         __print_err "need one arg,  <json-config-file>" $@
1276                 exit 1
1277         fi
1278
1279         echo " Loading config for "$POLICY_AGENT_APP_NAME" from "$1
1280
1281         curlString="$LOCALHOST${CONSUL_EXTERNAL_PORT}/v1/kv/${POLICY_AGENT_APP_NAME}?dc=dc1 -X PUT -H Accept:application/json -H Content-Type:application/json -H X-Requested-With:XMLHttpRequest --data-binary @"$1
1282         result=$(__do_curl "$curlString")
1283         if [ $? -ne 0 ]; then
1284                 echo -e $RED" FAIL - json config could not be loaded to consul" $ERED
1285                 ((RES_CONF_FAIL++))
1286                 return 1
1287         fi
1288         body="$(__do_curl $LOCALHOST$CBS_EXTERNAL_PORT/service_component_all/$POLICY_AGENT_APP_NAME)"
1289         echo $body > "./tmp/.output"$1
1290
1291         if [ $? -ne 0 ]; then
1292                 echo -e $RED" FAIL - json config could not be loaded from consul/cbs, contents cannot be checked." $ERED
1293                 ((RES_CONF_FAIL++))
1294                 return 1
1295         else
1296                 targetJson=$(< $1)
1297                 targetJson="{\"config\":"$targetJson"}"
1298                 echo "TARGET JSON: $targetJson" >> $HTTPLOG
1299                 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
1300                 if [ $res -ne 0 ]; then
1301                         echo -e $RED" FAIL - policy json config read from consul/cbs is not equal to the intended json config...." $ERED
1302                         ((RES_CONF_FAIL++))
1303                         return 1
1304                 else
1305                         echo -e $GREEN" Config loaded ok to consul"$EGREEN
1306                 fi
1307         fi
1308
1309         echo ""
1310
1311 }
1312
1313 # Function to perpare the consul configuration according to the current simulator configuration
1314 # args: SDNC|NOSDNC <output-file>
1315 # (Function for test scripts)
1316 prepare_consul_config() {
1317         echo -e $BOLD"Prepare Consul config"$EBOLD
1318
1319         echo " Writing consul config for "$POLICY_AGENT_APP_NAME" to file: "$2
1320
1321         if [ $# != 2 ];  then
1322                 ((RES_CONF_FAIL++))
1323         __print_err "need two args,  SDNC|NOSDNC <output-file>" $@
1324                 exit 1
1325         fi
1326
1327         if [ $1 == "SDNC" ]; then
1328                 echo -e " Config$BOLD including SDNC$EBOLD configuration"
1329         elif [ $1 == "NOSDNC" ];  then
1330                 echo -e " Config$BOLD excluding SDNC$EBOLD configuration"
1331         else
1332                 ((RES_CONF_FAIL++))
1333         __print_err "need two args,  SDNC|NOSDNC <output-file>" $@
1334                 exit 1
1335         fi
1336
1337         config_json="\n            {"
1338         if [ $1 == "SDNC" ]; then
1339                 config_json=$config_json"\n   \"controller\": ["
1340                 config_json=$config_json"\n                     {"
1341                 config_json=$config_json"\n                       \"name\": \"$SDNC_APP_NAME\","
1342                 if [ $AGENT_STAND_ALONE -eq 0 ]; then
1343                         config_json=$config_json"\n                       \"baseUrl\": \"$SDNC_HTTPX://$SDNC_APP_NAME:$SDNC_PORT\","
1344                 else
1345                         config_json=$config_json"\n                       \"baseUrl\": \"$SDNC_HTTPX://localhost:$SDNC_LOCAL_PORT\","
1346                 fi
1347                 config_json=$config_json"\n                       \"userName\": \"$SDNC_USER\","
1348                 config_json=$config_json"\n                       \"password\": \"$SDNC_PWD\""
1349                 config_json=$config_json"\n                     }"
1350                 config_json=$config_json"\n   ],"
1351         fi
1352
1353         config_json=$config_json"\n   \"streams_publishes\": {"
1354         config_json=$config_json"\n                            \"dmaap_publisher\": {"
1355         config_json=$config_json"\n                              \"type\": \"$MR_APP_NAME\","
1356         config_json=$config_json"\n                              \"dmaap_info\": {"
1357         if [ $AGENT_STAND_ALONE -eq 0 ]; then
1358                 config_json=$config_json"\n                                \"topic_url\": \"$MR_HTTPX://$MR_APP_NAME:$MR_PORT$MR_WRITE_URL\""
1359         else
1360                 config_json=$config_json"\n                                \"topic_url\": \"$MR_HTTPX://localhost:$MR_LOCAL_PORT$MR_WRITE_URL\""
1361         fi
1362         config_json=$config_json"\n                              }"
1363         config_json=$config_json"\n                            }"
1364         config_json=$config_json"\n   },"
1365         config_json=$config_json"\n   \"streams_subscribes\": {"
1366         config_json=$config_json"\n                             \"dmaap_subscriber\": {"
1367         config_json=$config_json"\n                               \"type\": \"$MR_APP_NAME\","
1368         config_json=$config_json"\n                               \"dmaap_info\": {"
1369         if [ $AGENT_STAND_ALONE -eq 0 ]; then
1370                 config_json=$config_json"\n                                   \"topic_url\": \"$MR_HTTPX://$MR_APP_NAME:$MR_PORT$MR_READ_URL\""
1371         else
1372                 config_json=$config_json"\n                                   \"topic_url\": \"$MR_HTTPX://localhost:$MR_LOCAL_PORT$MR_READ_URL\""
1373         fi
1374         config_json=$config_json"\n                                 }"
1375         config_json=$config_json"\n                               }"
1376         config_json=$config_json"\n   },"
1377
1378         config_json=$config_json"\n   \"ric\": ["
1379
1380         rics=$(docker ps | grep $RIC_SIM_PREFIX | awk '{print $NF}')
1381
1382         if [ $? -ne 0 ] || [ -z "$rics" ]; then
1383                 echo -e $RED" FAIL - the names of the running RIC Simulator cannot be retrieved." $ERED
1384                 ((RES_CONF_FAIL++))
1385                 return 1
1386         fi
1387
1388         cntr=0
1389         for ric in $rics; do
1390                 if [ $cntr -gt 0 ]; then
1391                         config_json=$config_json"\n          ,"
1392                 fi
1393                 config_json=$config_json"\n          {"
1394                 config_json=$config_json"\n            \"name\": \"$ric\","
1395                 if [ $AGENT_STAND_ALONE -eq 0 ]; then
1396                         config_json=$config_json"\n            \"baseUrl\": \"$RIC_SIM_HTTPX://$ric:$RIC_SIM_PORT\","
1397                 else
1398                         config_json=$config_json"\n            \"baseUrl\": \"$RIC_SIM_HTTPX://localhost:$(__find_sim_port $ric)\","
1399                 fi
1400                 if [ $1 == "SDNC" ]; then
1401                         config_json=$config_json"\n            \"controller\": \"$SDNC_APP_NAME\","
1402                 fi
1403                 config_json=$config_json"\n            \"managedElementIds\": ["
1404                 config_json=$config_json"\n              \"me1_$ric\","
1405                 config_json=$config_json"\n              \"me2_$ric\""
1406                 config_json=$config_json"\n            ]"
1407                 config_json=$config_json"\n          }"
1408                 let cntr=cntr+1
1409         done
1410
1411         config_json=$config_json"\n           ]"
1412         config_json=$config_json"\n}"
1413
1414
1415         printf "$config_json">$2
1416
1417         echo ""
1418 }
1419
1420
1421 # Start Consul and CBS
1422 # args: -
1423 # (Function for test scripts)
1424 start_consul_cbs() {
1425
1426         echo -e $BOLD"Starting Consul and CBS"$EBOLD
1427         __check_included_image 'CONSUL'
1428         if [ $? -eq 1 ]; then
1429                 echo -e $RED"The Consul image has not been checked for this test run due to arg to the test script"$ERED
1430                 echo -e $RED"Consul will not be started"$ERED
1431                 exit
1432         fi
1433         __start_container consul_cbs NODOCKERARGS  "$CONSUL_APP_NAME" "$CONSUL_EXTERNAL_PORT" "/ui/dc1/kv" "http" \
1434                                                      "$CBS_APP_NAME" "$CBS_EXTERNAL_PORT" "/healthcheck" "http"
1435 }
1436
1437 ###########################
1438 ### RIC Simulator functions
1439 ###########################
1440
1441 use_simulator_http() {
1442         echo -e "Using $BOLD http $EBOLD towards the simulators"
1443         export RIC_SIM_HTTPX="http"
1444         export RIC_SIM_LOCALHOST=$RIC_SIM_HTTPX"://localhost:"
1445         export RIC_SIM_PORT=$RIC_SIM_INTERNAL_PORT
1446         echo ""
1447 }
1448
1449 use_simulator_https() {
1450         echo -e "Using $BOLD https $EBOLD towards the simulators"
1451         export RIC_SIM_HTTPX="https"
1452         export RIC_SIM_LOCALHOST=$RIC_SIM_HTTPX"://localhost:"
1453         export RIC_SIM_PORT=$RIC_SIM_INTERNAL_SECURE_PORT
1454         echo ""
1455 }
1456
1457 # Start one group (ricsim_g1, ricsim_g2 or ricsim_g3) with a number of RIC Simulators using a given A interface
1458 # 'ricsim' may be set on command line to other prefix
1459 # args:  ricsim_g1|ricsim_g2|ricsim_g3 <count> <interface-id>
1460 # (Function for test scripts)
1461 start_ric_simulators() {
1462
1463         echo -e $BOLD"Starting RIC Simulators"$EBOLD
1464
1465         __check_included_image 'RICSIM'
1466         if [ $? -eq 1 ]; then
1467                 echo -e $RED"The Near-RT RIC Simulator image has not been checked for this test run due to arg to the test script"$ERED
1468                 echo -e $RED"The Near-RT RIC Simulartor(s) will not be started"$ERED
1469                 exit
1470         fi
1471
1472         RIC1=$RIC_SIM_PREFIX"_g1"
1473         RIC2=$RIC_SIM_PREFIX"_g2"
1474         RIC3=$RIC_SIM_PREFIX"_g3"
1475
1476         if [ $# != 3 ]; then
1477                 ((RES_CONF_FAIL++))
1478         __print_err "need three args,  $RIC1|$RIC2|$RIC3 <count> <interface-id>" $@
1479                 exit 1
1480         fi
1481         echo " $2 simulators using basename: $1 on interface: $3"
1482         #Set env var for simulator count and A1 interface vesion for the given group
1483         if [ $1 == "$RIC1" ]; then
1484                 G1_COUNT=$2
1485                 G1_A1_VERSION=$3
1486         elif [ $1 == "$RIC2" ]; then
1487                 G2_COUNT=$2
1488                 G2_A1_VERSION=$3
1489         elif [ $1 == "$RIC3" ]; then
1490                 G3_COUNT=$2
1491                 G3_A1_VERSION=$3
1492         else
1493                 ((RES_CONF_FAIL++))
1494         __print_err "need three args, $RIC1|$RIC2|$RIC3 <count> <interface-id>" $@
1495                 exit 1
1496         fi
1497
1498         # Create .env file to compose project, all ric container will get this prefix
1499         echo "COMPOSE_PROJECT_NAME="$RIC_SIM_PREFIX > $SIM_GROUP/ric/.env
1500
1501         export G1_A1_VERSION
1502         export G2_A1_VERSION
1503         export G3_A1_VERSION
1504
1505         docker_args="--scale g1=$G1_COUNT --scale g2=$G2_COUNT --scale g3=$G3_COUNT"
1506         app_data=""
1507         cntr=1
1508         while [ $cntr -le $2 ]; do
1509                 app=$1"_"$cntr
1510                 port=0
1511                 app_data="$app_data $app $port / "$RIC_SIM_HTTPX
1512                 let cntr=cntr+1
1513         done
1514         __start_container ric "$docker_args" $app_data
1515
1516 }
1517
1518 ###########################
1519 ### Control Panel functions
1520 ###########################
1521
1522 # Start the Control Panel container
1523 # args: -
1524 # (Function for test scripts)
1525 start_control_panel() {
1526
1527         echo -e $BOLD"Starting Control Panel"$EBOLD
1528         __check_included_image 'CP'
1529         if [ $? -eq 1 ]; then
1530                 echo -e $RED"The Control Panel image has not been checked for this test run due to arg to the test script"$ERED
1531                 echo -e $RED"The Control Panel will not be started"$ERED
1532                 exit
1533         fi
1534         __start_container control_panel NODOCKERARGS $CONTROL_PANEL_APP_NAME $CONTROL_PANEL_EXTERNAL_PORT "/" "http"
1535
1536 }
1537
1538 ##################
1539 ### SDNC functions
1540 ##################
1541
1542 # Start the SDNC A1 Controller
1543 # args: -
1544 # (Function for test scripts)
1545 start_sdnc() {
1546
1547         echo -e $BOLD"Starting SDNC A1 Controller"$EBOLD
1548
1549         __check_included_image 'SDNC'
1550         if [ $? -eq 1 ]; then
1551                 echo -e $RED"The image for SDNC and the related DB has not been checked for this test run due to arg to the test script"$ERED
1552                 echo -e $RED"SDNC will not be started"$ERED
1553                 exit
1554         fi
1555
1556         __start_container sdnc NODOCKERARGS $SDNC_APP_NAME $SDNC_EXTERNAL_PORT $SDNC_ALIVE_URL "http"
1557
1558 }
1559
1560 use_sdnc_http() {
1561         echo -e "Using $BOLD http $EBOLD towards SDNC"
1562         export SDNC_HTTPX="http"
1563         export SDNC_PORT=$SDNC_INTERNAL_PORT
1564         export SDNC_LOCAL_PORT=$SDNC_EXTERNAL_PORT
1565         echo ""
1566 }
1567
1568 use_sdnc_https() {
1569         echo -e "Using $BOLD https $EBOLD towards SDNC"
1570         export SDNC_HTTPX="https"
1571         export SDNC_PORT=$SDNC_INTERNAL_SECURE_PORT
1572         export SDNC_LOCAL_PORT=$SDNC_EXTERNAL_SECURE_PORT
1573         echo ""
1574 }
1575
1576 #####################
1577 ### MR stub functions
1578 #####################
1579
1580 # Start the Message Router stub interface in the simulator group
1581 # args: -
1582 # (Function for test scripts)
1583 start_mr() {
1584
1585         echo -e $BOLD"Starting Message Router 'mrstub'"$EBOLD
1586         __check_included_image 'MR'
1587         if [ $? -eq 1 ]; then
1588                 echo -e $RED"The Message Router image has not been checked for this test run due to arg to the test script"$ERED
1589                 echo -e $RED"The Message Router will not be started"$ERED
1590                 exit
1591         fi
1592         export MR_CERT_MOUNT_DIR="./cert"
1593         __start_container mr NODOCKERARGS $MR_APP_NAME $MR_EXTERNAL_PORT "/" "http"
1594 }
1595
1596 use_mr_http() {
1597         echo -e "Using $BOLD http $EBOLD towards MR"
1598         export MR_HTTPX="http"
1599         export MR_PORT=$MR_INTERNAL_PORT
1600         export MR_LOCAL_PORT=$MR_EXTERNAL_PORT
1601         echo ""
1602 }
1603
1604 use_mr_https() {
1605         echo -e "Using $BOLD https $EBOLD towards MR"
1606         export MR_HTTPX="https"
1607         export MR_PORT=$MR_INTERNAL_SECURE_PORT
1608         export MR_LOCAL_PORT=$MR_EXTERNAL_SECURE_PORT
1609         echo ""
1610 }
1611
1612
1613 ################
1614 ### CR functions
1615 ################
1616
1617 # Start the Callback reciver in the simulator group
1618 # args: -
1619 # (Function for test scripts)
1620 start_cr() {
1621
1622         echo -e $BOLD"Starting Callback Receiver"$EBOLD
1623         __check_included_image 'CR'
1624         if [ $? -eq 1 ]; then
1625                 echo -e $RED"The Callback Receiver image has not been checked for this test run due to arg to the test script"$ERED
1626                 echo -e $RED"The Callback Receiver will not be started"$ERED
1627                 exit
1628         fi
1629         __start_container cr NODOCKERARGS $CR_APP_NAME $CR_EXTERNAL_PORT "/" "http"
1630
1631 }
1632
1633 use_cr_http() {
1634         echo -e "Using $BOLD http $EBOLD towards CR"
1635         export CR_HTTPX="http"
1636         export CR_PORT=$CR_INTERNAL_PORT
1637         export CR_LOCAL_PORT=$CR_EXTERNAL_PORT
1638         echo ""
1639 }
1640
1641 use_cr_https() {
1642         echo -e "Using $BOLD https $EBOLD towards CR"
1643         export CR_HTTPX="https"
1644         export CR_PORT=$CR_INTERNAL_SECURE_PORT
1645         export CR_LOCAL_PORT=$CR_EXTERNAL_SECURE_PORT
1646         echo ""
1647 }
1648
1649 ###########################
1650 ### Producer stub functions
1651 ###########################
1652
1653 # Start the Producer stub in the simulator group
1654 # args: -
1655 # (Function for test scripts)
1656 start_prod_stub() {
1657
1658         echo -e $BOLD"Starting Producer stub"$EBOLD
1659         __check_included_image 'PRODSTUB'
1660         if [ $? -eq 1 ]; then
1661                 echo -e $RED"The Producer stub image has not been checked for this test run due to arg to the test script"$ERED
1662                 echo -e $RED"The Producer stub will not be started"$ERED
1663                 exit
1664         fi
1665         __start_container prodstub NODOCKERARGS $PROD_STUB_APP_NAME $PROD_STUB_EXTERNAL_PORT "/" "http"
1666
1667 }
1668
1669 use_prod_stub_http() {
1670         echo -e "Using $BOLD http $EBOLD towards Producer stub"
1671         export PROD_STUB_HTTPX="http"
1672         export PROD_STUB_PORT=$PROD_STUB_INTERNAL_PORT
1673         export PROD_STUB_LOCAL_PORT=$PROD_STUB_EXTERNAL_PORT
1674         export PROD_STUB_LOCALHOST=$PROD_STUB_HTTPX"://localhost:"$PROD_STUB_LOCAL_PORT
1675         echo ""
1676 }
1677
1678 use_prod_stub_https() {
1679         echo -e "Using $BOLD https $EBOLD towards Producer stub"
1680         export PROD_STUB_HTTPX="https"
1681         export PROD_STUB_PORT=$PROD_STUB_INTERNAL_SECURE_PORT
1682         export PROD_STUB_LOCAL_PORT=$PROD_STUB_EXTERNAL_SECURE_PORT
1683         export PROD_STUB_LOCALHOST=$PROD_STUB_HTTPX"://localhost:"$PROD_STUB_LOCAL_PORT
1684         echo ""
1685 }
1686
1687 ###########################
1688 ### Policy Agents functions
1689 ###########################
1690
1691 # Use an agent on the local machine instead of container
1692 use_agent_stand_alone() {
1693         AGENT_STAND_ALONE=1
1694 }
1695
1696 # Start the policy agent
1697 # args: -
1698 # (Function for test scripts)
1699 start_policy_agent() {
1700
1701         echo -e $BOLD"Starting Policy Agent"$EBOLD
1702
1703         if [ $AGENT_STAND_ALONE -eq 0 ]; then
1704                 __check_included_image 'PA'
1705                 if [ $? -eq 1 ]; then
1706                         echo -e $RED"The Policy Agent image has not been checked for this test run due to arg to the test script"$ERED
1707                         echo -e $RED"The Policy Agent will not be started"$ERED
1708                         exit
1709                 fi
1710                 __start_container policy_agent NODOCKERARGS $POLICY_AGENT_APP_NAME $POLICY_AGENT_EXTERNAL_PORT "/status" "http"
1711         else
1712                 echo -e $RED"The consul config produced by this test script (filename '<fullpath-to-autotest-dir>.output<file-name>"$ERED
1713                 echo -e $RED"where the file name is the file in the consul_config_app command in this script) must be pointed out by the agent "$ERED
1714                 echo -e $RED"application.yaml"$ERED
1715                 echo -e $RED"The application jar may need to be built before continuing"$ERED
1716                 echo -e $RED"The agent shall now be running on port $POLICY_AGENT_EXTERNAL_PORT for http"$ERED
1717
1718                 read -p "<press any key to continue>"
1719                 __start_container policy_agent "STANDALONE" $POLICY_AGENT_APP_NAME $POLICY_AGENT_EXTERNAL_PORT "/status" "http"
1720         fi
1721
1722 }
1723
1724 # All calls to the agent will be directed to the agent REST interface from now on
1725 # args: -
1726 # (Function for test scripts)
1727 use_agent_rest_http() {
1728         echo -e "Using $BOLD http $EBOLD and $BOLD REST $EBOLD towards the agent"
1729         export ADAPTER=$RESTBASE
1730         echo ""
1731 }
1732
1733 # All calls to the agent will be directed to the agent REST interface from now on
1734 # args: -
1735 # (Function for test scripts)
1736 use_agent_rest_https() {
1737         echo -e "Using $BOLD https $EBOLD and $BOLD REST $EBOLD towards the agent"
1738         export ADAPTER=$RESTBASE_SECURE
1739         echo ""
1740         return 0
1741 }
1742
1743 # All calls to the agent will be directed to the agent dmaap interface over http from now on
1744 # args: -
1745 # (Function for test scripts)
1746 use_agent_dmaap_http() {
1747         echo -e "Using $BOLD http $EBOLD and $BOLD DMAAP $EBOLD towards the agent"
1748         export ADAPTER=$DMAAPBASE
1749         echo ""
1750         return 0
1751 }
1752
1753 # All calls to the agent will be directed to the agent dmaap interface over https from now on
1754 # args: -
1755 # (Function for test scripts)
1756 use_agent_dmaap_https() {
1757         echo -e "Using $BOLD https $EBOLD and $BOLD REST $EBOLD towards the agent"
1758         export ADAPTER=$DMAAPBASE_SECURE
1759         echo ""
1760         return 0
1761 }
1762
1763 # Turn on debug level tracing in the agent
1764 # args: -
1765 # (Function for test scripts)
1766 set_agent_debug() {
1767         echo -e $BOLD"Setting agent debug"$EBOLD
1768         curlString="$LOCALHOST$POLICY_AGENT_EXTERNAL_PORT/actuator/loggers/org.oransc.policyagent -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"debug\"}"
1769         result=$(__do_curl "$curlString")
1770         if [ $? -ne 0 ]; then
1771                 __print_err "could not set debug mode" $@
1772                 ((RES_CONF_FAIL++))
1773                 return 1
1774         fi
1775         echo ""
1776         return 0
1777 }
1778
1779 # Turn on trace level tracing in the agent
1780 # args: -
1781 # (Function for test scripts)
1782 set_agent_trace() {
1783         echo -e $BOLD"Setting agent trace"$EBOLD
1784         curlString="$LOCALHOST$POLICY_AGENT_EXTERNAL_PORT/actuator/loggers/org.oransc.policyagent -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"trace\"}"
1785         result=$(__do_curl "$curlString")
1786         if [ $? -ne 0 ]; then
1787                 __print_err "could not set trace mode" $@
1788                 ((RES_CONF_FAIL++))
1789                 return 1
1790         fi
1791         echo ""
1792         return 0
1793 }
1794
1795 # Perform curl retries when making direct call to the agent for the specified http response codes
1796 # Speace separated list of http response codes
1797 # args: [<response-code>]*
1798 use_agent_retries() {
1799         echo -e $BOLD"Do curl retries to the agent REST inteface for these response codes:$@"$EBOLD
1800         AGENT_RETRY_CODES=$@
1801         echo ""
1802         return
1803 }
1804
1805 ###########################
1806 ### ECS functions
1807 ###########################
1808
1809 # Start the ECS
1810 # args: -
1811 # (Function for test scripts)
1812 start_ecs() {
1813
1814         echo -e $BOLD"Starting ECS"$EBOLD
1815         __check_included_image 'ECS'
1816         if [ $? -eq 1 ]; then
1817                 echo -e $RED"The ECS image has not been checked for this test run due to arg to the test script"$ERED
1818                 echo -e $RED"ECS will not be started"$ERED
1819                 exit
1820         fi
1821         export ECS_CERT_MOUNT_DIR="./cert"
1822         __start_container ecs NODOCKERARGS $ECS_APP_NAME $ECS_EXTERNAL_PORT "/status" "http"
1823 }
1824
1825 # All calls to ECS will be directed to the ECS REST interface from now on
1826 # args: -
1827 # (Function for test scripts)
1828 use_ecs_rest_http() {
1829         echo -e "Using $BOLD http $EBOLD and $BOLD REST $EBOLD towards ECS"
1830         export ECS_ADAPTER=$ECS_RESTBASE
1831         echo ""
1832 }
1833
1834 # All calls to ECS will be directed to the ECS REST interface from now on
1835 # args: -
1836 # (Function for test scripts)
1837 use_ecs_rest_https() {
1838         echo -e "Using $BOLD https $EBOLD and $BOLD REST $EBOLD towards ECS"
1839         export ECS_ADAPTER=$ECS_RESTBASE_SECURE
1840         echo ""
1841         return 0
1842 }
1843
1844 # All calls to ECS will be directed to the ECS dmaap interface over http from now on
1845 # args: -
1846 # (Function for test scripts)
1847 use_ecs_dmaap_http() {
1848         echo -e "Using $BOLD http $EBOLD and $BOLD DMAAP $EBOLD towards ECS"
1849         export ECS_ADAPTER=$ECS_DMAAPBASE
1850         echo ""
1851         return 0
1852 }
1853
1854 # All calls to ECS will be directed to the ECS dmaap interface over https from now on
1855 # args: -
1856 # (Function for test scripts)
1857 use_ecs_dmaap_https() {
1858         echo -e "Using $BOLD https $EBOLD and $BOLD REST $EBOLD towards ECS"
1859         export ECS_ADAPTER=$ECS_DMAAPBASE_SECURE
1860         echo ""
1861         return 0
1862 }
1863
1864 # Turn on debug level tracing in ECS
1865 # args: -
1866 # (Function for test scripts)
1867 set_ecs_debug() {
1868         echo -e $BOLD"Setting ecs debug"$EBOLD
1869         curlString="$LOCALHOST$ECS_EXTERNAL_PORT/actuator/loggers/org.oransc.enrichment -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"debug\"}"
1870         result=$(__do_curl "$curlString")
1871         if [ $? -ne 0 ]; then
1872                 __print_err "Could not set debug mode" $@
1873                 ((RES_CONF_FAIL++))
1874                 return 1
1875         fi
1876         echo ""
1877         return 0
1878 }
1879
1880 # Turn on trace level tracing in ECS
1881 # args: -
1882 # (Function for test scripts)
1883 set_ecs_trace() {
1884         echo -e $BOLD"Setting ecs trace"$EBOLD
1885         curlString="$LOCALHOST$ECS_EXTERNAL_PORT/actuator/loggers/org.oransc.enrichment -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"trace\"}"
1886         result=$(__do_curl "$curlString")
1887         if [ $? -ne 0 ]; then
1888                 __print_err "Could not set trace mode" $@
1889                 ((RES_CONF_FAIL++))
1890                 return 1
1891         fi
1892         echo ""
1893         return 0
1894 }
1895
1896 # Perform curl retries when making direct call to ECS for the specified http response codes
1897 # Speace separated list of http response codes
1898 # args: [<response-code>]*
1899 use_agent_retries() {
1900         echo -e $BOLD"Do curl retries to the ECS REST inteface for these response codes:$@"$EBOLD
1901         ECS_AGENT_RETRY_CODES=$@
1902         echo ""
1903         return
1904 }
1905
1906 #################
1907 ### Log functions
1908 #################
1909
1910 # Check the agent logs for WARNINGs and ERRORs
1911 # args: -
1912 # (Function for test scripts)
1913
1914 check_policy_agent_logs() {
1915         __check_container_logs "Policy Agent" $POLICY_AGENT_APP_NAME $POLICY_AGENT_LOGPATH WARN ERR
1916 }
1917
1918 check_ecs_logs() {
1919         __check_container_logs "ECS" $ECS_APP_NAME $ECS_LOGPATH WARN ERR
1920 }
1921
1922 check_control_panel_logs() {
1923         __check_container_logs "Control Panel" $CONTROL_PANEL_APP_NAME $CONTROL_PANEL_LOGPATH WARN ERR
1924 }
1925
1926 check_sdnc_logs() {
1927         __check_container_logs "SDNC A1 Controller" $SDNC_APP_NAME $SDNC_KARAF_LOG WARN ERROR
1928 }
1929
1930 __check_container_logs() {
1931         dispname=$1
1932         appname=$2
1933         logpath=$3
1934         warning=$4
1935         error=$5
1936
1937         echo -e $BOLD"Checking $dispname container $appname log ($logpath) for WARNINGs and ERRORs"$EBOLD
1938
1939         #tmp=$(docker ps | grep $appname)
1940         tmp=$(docker ps -q --filter name=$appname) #get the container id
1941         if [ -z "$tmp" ]; then  #Only check logs for running Policy Agent apps
1942                 echo $dispname" is not running, no check made"
1943                 return
1944         fi
1945         foundentries="$(docker exec -t $tmp grep $warning $logpath | wc -l)"
1946         if [ $? -ne  0 ];then
1947                 echo "  Problem to search $appname log $logpath"
1948         else
1949                 if [ $foundentries -eq 0 ]; then
1950                         echo "  No WARN entries found in $appname log $logpath"
1951                 else
1952                         echo -e "  Found \033[1m"$foundentries"\033[0m WARN entries in $appname log $logpath"
1953                 fi
1954         fi
1955         foundentries="$(docker exec -t $tmp grep $error $logpath | wc -l)"
1956         if [ $? -ne  0 ];then
1957                 echo "  Problem to search $appname log $logpath"
1958         else
1959                 if [ $foundentries -eq 0 ]; then
1960                         echo "  No ERR entries found in $appname log $logpath"
1961                 else
1962                         echo -e $RED"  Found \033[1m"$foundentries"\033[0m"$RED" ERR entries in $appname log $logpath"$ERED
1963                 fi
1964         fi
1965         echo ""
1966 }
1967
1968 # Store all container logs and other logs in the log dir for the script
1969 # Logs are stored with a prefix in case logs should be stored several times during a test
1970 # args: <logfile-prefix>
1971 # (Function for test scripts)
1972 store_logs() {
1973         if [ $# != 1 ]; then
1974                 ((RES_CONF_FAIL++))
1975         __print_err "need one arg, <file-prefix>" $@
1976                 exit 1
1977         fi
1978         echo -e $BOLD"Storing all container logs using prefix: "$1$EBOLD
1979
1980         docker stats --no-stream > $TESTLOGS/$ATC/$1_docker_stats.log 2>&1
1981
1982         __check_included_image 'CONSUL'
1983         if [ $? -eq 0 ]; then
1984                 docker logs $CONSUL_APP_NAME > $TESTLOGS/$ATC/$1_consul.log 2>&1
1985         fi
1986
1987         __check_included_image 'CBS'
1988         if [ $? -eq 0 ]; then
1989                 docker logs $CBS_APP_NAME > $TESTLOGS/$ATC/$1_cbs.log 2>&1
1990                 body="$(__do_curl $LOCALHOST$CBS_EXTERNAL_PORT/service_component_all/$POLICY_AGENT_APP_NAME)"
1991                 echo "$body" > $TESTLOGS/$ATC/$1_consul_config.json 2>&1
1992         fi
1993
1994         __check_included_image 'PA'
1995         if [ $? -eq 0 ]; then
1996                 docker logs $POLICY_AGENT_APP_NAME > $TESTLOGS/$ATC/$1_policy-agent.log 2>&1
1997         fi
1998
1999         __check_included_image 'ECS'
2000         if [ $? -eq 0 ]; then
2001                 docker logs $ECS_APP_NAME > $TESTLOGS/$ATC/$1_ecs.log 2>&1
2002         fi
2003
2004         __check_included_image 'CP'
2005         if [ $? -eq 0 ]; then
2006                 docker logs $CONTROL_PANEL_APP_NAME > $TESTLOGS/$ATC/$1_control-panel.log 2>&1
2007         fi
2008
2009         __check_included_image 'MR'
2010         if [ $? -eq 0 ]; then
2011                 docker logs $MR_APP_NAME > $TESTLOGS/$ATC/$1_mr.log 2>&1
2012         fi
2013
2014         __check_included_image 'CR'
2015         if [ $? -eq 0 ]; then
2016                 docker logs $CR_APP_NAME > $TESTLOGS/$ATC/$1_cr.log 2>&1
2017         fi
2018
2019         cp .httplog_${ATC}.txt $TESTLOGS/$ATC/$1_httplog_${ATC}.txt 2>&1
2020
2021         __check_included_image 'SDNC'
2022         if [ $? -eq 0 ]; then
2023                 docker exec -t $SDNC_APP_NAME cat $SDNC_KARAF_LOG> $TESTLOGS/$ATC/$1_SDNC_karaf.log 2>&1
2024         fi
2025
2026         __check_included_image 'RICSIM'
2027         if [ $? -eq 0 ]; then
2028                 rics=$(docker ps -f "name=$RIC_SIM_PREFIX" --format "{{.Names}}")
2029                 for ric in $rics; do
2030                         docker logs $ric > $TESTLOGS/$ATC/$1_$ric.log 2>&1
2031                 done
2032         fi
2033
2034         echo ""
2035 }
2036
2037 ###############
2038 ## Generic curl
2039 ###############
2040 # Generic curl function, assumes all 200-codes are ok
2041 # args: <valid-curl-args-including full url>
2042 # returns: <returned response (without respose code)>  or "<no-response-from-server>" or "<not found, <http-code>>""
2043 # returns: The return code is 0 for ok and 1 for not ok
2044 __do_curl() {
2045         echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
2046         curlString="curl -skw %{http_code} $@"
2047         echo " CMD: $curlString" >> $HTTPLOG
2048         res=$($curlString)
2049         echo " RESP: $res" >> $HTTPLOG
2050         http_code="${res:${#res}-3}"
2051         if [ ${#res} -eq 3 ]; then
2052                 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
2053                         echo "<no-response-from-server>"
2054                         return 1
2055                 else
2056                         echo "X2" >> $HTTPLOG
2057                         return 0
2058                 fi
2059         else
2060                 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
2061                         echo "<not found, resp:${http_code}>"
2062                         return 1
2063                 fi
2064                 if [ $# -eq 2 ]; then
2065                         echo "${res:0:${#res}-3}" | xargs
2066                 else
2067                         echo "${res:0:${#res}-3}"
2068                 fi
2069
2070                 return 0
2071         fi
2072 }
2073
2074 #######################################
2075 ### Basic helper function for test cases
2076 #######################################
2077
2078 # Test a simulator container variable value towards target value using an condition operator with an optional timeout.
2079 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value>  - This test is done
2080 # immediately and sets pass or fail depending on the result of comparing variable and target using the operator.
2081 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> <timeout>  - This test waits up to the timeout
2082 # before setting pass or fail depending on the result of comparing variable and target using the operator.
2083 # If the <variable-name> has the 'json:' prefix, the the variable will be used as url and the <target-value> will be compared towards the length of the json array in the response.
2084 # Not to be called from test script.
2085
2086 __var_test() {
2087         checkjsonarraycount=0
2088
2089         if [ $# -eq 6 ]; then
2090                 if [[ $3 == "json:"* ]]; then
2091                         checkjsonarraycount=1
2092                 fi
2093
2094                 echo -e $BOLD"TEST(${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds"$EBOLD
2095                 ((RES_TEST++))
2096                 start=$SECONDS
2097                 ctr=0
2098                 for (( ; ; )); do
2099                         if [ $checkjsonarraycount -eq 0 ]; then
2100                                 result="$(__do_curl $2$3)"
2101                                 retcode=$?
2102                                 result=${result//[[:blank:]]/} #Strip blanks
2103                         else
2104                                 path=${3:5}
2105                                 result="$(__do_curl $2$path)"
2106                                 retcode=$?
2107                                 echo "$result" > ./tmp/.tmp.curl.json
2108                                 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
2109                         fi
2110                         duration=$((SECONDS-start))
2111                         echo -ne " Result=${result} after ${duration} seconds${SAMELINE}"
2112                         let ctr=ctr+1
2113                         if [ $retcode -ne 0 ]; then
2114                                 if [ $duration -gt $6 ]; then
2115                                         ((RES_FAIL++))
2116                                         echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
2117                                         __check_stop_at_error
2118                                         return
2119                                 fi
2120                         elif [ $4 = "=" ] && [ "$result" -eq $5 ]; then
2121                                 ((RES_PASS++))
2122                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2123                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2124                                 return
2125                         elif [ $4 = ">" ] && [ "$result" -gt $5 ]; then
2126                                 ((RES_PASS++))
2127                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2128                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2129                                 return
2130                         elif [ $4 = "<" ] && [ "$result" -lt $5 ]; then
2131                                 ((RES_PASS++))
2132                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2133                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2134                                 return
2135                         elif [ $4 = "contain_str" ] && [[ $result =~ $5 ]]; then
2136                                 ((RES_PASS++))
2137                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2138                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2139                                 return
2140                         else
2141                                 if [ $duration -gt $6 ]; then
2142                                         ((RES_FAIL++))
2143                                         echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
2144                                         __check_stop_at_error
2145                                         return
2146                                 fi
2147                         fi
2148                         sleep 1
2149                 done
2150         elif [ $# -eq 5 ]; then
2151                 if [[ $3 == "json:"* ]]; then
2152                         checkjsonarraycount=1
2153                 fi
2154
2155                 echo -e $BOLD"TEST(${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}"$EBOLD
2156                 ((RES_TEST++))
2157                 if [ $checkjsonarraycount -eq 0 ]; then
2158                         result="$(__do_curl $2$3)"
2159                         retcode=$?
2160                         result=${result//[[:blank:]]/} #Strip blanks
2161                 else
2162                         path=${3:5}
2163                         result="$(__do_curl $2$path)"
2164                         retcode=$?
2165                         echo "$result" > ./tmp/.tmp.curl.json
2166                         result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
2167                 fi
2168                 if [ $retcode -ne 0 ]; then
2169                         ((RES_FAIL++))
2170                         echo -e $RED" FAIL ${ERED}- ${3} ${4} ${5} not reached, result = ${result}"
2171                         __check_stop_at_error
2172                 elif [ $4 = "=" ] && [ "$result" -eq $5 ]; then
2173                         ((RES_PASS++))
2174                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2175                 elif [ $4 = ">" ] && [ "$result" -gt $5 ]; then
2176                         ((RES_PASS++))
2177                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2178                 elif [ $4 = "<" ] && [ "$result" -lt $5 ]; then
2179                         ((RES_PASS++))
2180                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2181                 elif [ $4 = "contain_str" ] && [[ $result =~ $5 ]]; then
2182                         ((RES_PASS++))
2183                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2184                 else
2185                         ((RES_FAIL++))
2186                         echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached, result = ${result}"
2187                         __check_stop_at_error
2188                 fi
2189         else
2190                 echo "Wrong args to __var_test, needs five or six args: <simulator-name> <host> <variable-name> <condition-operator> <target-value> [ <timeout> ]"
2191                 echo "Got:" $@
2192                 exit 1
2193         fi
2194 }
2195
2196
2197 ### Generic test cases for varaible checking
2198
2199 # Tests if a variable value in the CR is equal to a target value and and optional timeout.
2200 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
2201 # equal to the target or not.
2202 # Arg: <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
2203 # before setting pass or fail depending on if the variable value becomes equal to the target
2204 # value or not.
2205 # (Function for test scripts)
2206 cr_equal() {
2207         if [ $# -eq 2 ] || [ $# -eq 3 ]; then
2208                 __var_test "CR" "$LOCALHOST$CR_EXTERNAL_PORT/counter/" $1 "=" $2 $3
2209         else
2210                 ((RES_CONF_FAIL++))
2211                 __print_err "Wrong args to cr_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
2212         fi
2213 }
2214
2215 # Tests if a variable value in the MR stub is equal to a target value and and optional timeout.
2216 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
2217 # equal to the target or not.
2218 # Arg: <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
2219 # before setting pass or fail depending on if the variable value becomes equal to the target
2220 # value or not.
2221 # (Function for test scripts)
2222 mr_equal() {
2223         if [ $# -eq 2 ] || [ $# -eq 3 ]; then
2224                 __var_test "MR" "$LOCALHOST$MR_EXTERNAL_PORT/counter/" $1 "=" $2 $3
2225         else
2226                 ((RES_CONF_FAIL++))
2227                 __print_err "Wrong args to mr_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
2228         fi
2229 }
2230
2231 # Tests if a variable value in the MR stub is greater than a target value and and optional timeout.
2232 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
2233 # greater than the target or not.
2234 # Arg: <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
2235 # before setting pass or fail depending on if the variable value becomes greater than the target
2236 # value or not.
2237 # (Function for test scripts)
2238 mr_greater() {
2239         if [ $# -eq 2 ] || [ $# -eq 3 ]; then
2240                 __var_test "MR" "$LOCALHOST$MR_EXTERNAL_PORT/counter/" $1 ">" $2 $3
2241         else
2242                 ((RES_CONF_FAIL++))
2243                 __print_err "Wrong args to mr_greater, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
2244         fi
2245 }
2246
2247 # Read a variable value from MR sim and send to stdout. Arg: <variable-name>
2248 mr_read() {
2249         echo "$(__do_curl $LOCALHOST$MR_EXTERNAL_PORT/counter/$1)"
2250 }
2251
2252 # Print a variable value from the MR stub.
2253 # arg: <variable-name>
2254 # (Function for test scripts)
2255 mr_print() {
2256         if [ $# != 1 ]; then
2257                 ((RES_CONF_FAIL++))
2258         __print_err "need one arg, <mr-param>" $@
2259                 exit 1
2260         fi
2261         echo -e $BOLD"INFO(${BASH_LINENO[0]}): mrstub, $1 = $(__do_curl $LOCALHOST$MR_EXTERNAL_PORT/counter/$1)"$EBOLD
2262 }