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 common functions needed for auto test.
  21 # Specific test function are defined in scripts  XXXX_functions.sh
  22
  23 . ../common/api_curl.sh
  24 . ../common/testengine_config.sh
  25
  26 __print_args() {
  27         echo "Args: remote|remote-remove docker|kube --env-file <environment-filename> [release] [auto-clean] [--stop-at-error] "
  28         echo "      [--ricsim-prefix <prefix> ] [--use-local-image <app-nam>+]  [--use-snapshot-image <app-nam>+]"
  29         echo "      [--use-staging-image <app-nam>+] [--use-release-image <app-nam>+] [--image-repo <repo-address]"
  30         echo "      [--repo-policy local|remote] [--cluster-timeout <timeout-in seconds>] [--print-stats]"
  31         echo "      [--override <override-environment-filename> --pre-clean --gen-stats]"
  32 }
  33
  34 if [ $# -eq 1 ] && [ "$1" == "help" ]; then
  35
  36         if [ ! -z "$TC_ONELINE_DESCR" ]; then
  37                 echo "Test script description:"
  38                 echo $TC_ONELINE_DESCR
  39                 echo ""
  40         fi
  41         __print_args
  42         echo ""
  43         echo "remote                -  Use images from remote repositories. Can be overridden for individual images using the '--use_xxx' flags"
  44         echo "remote-remove         -  Same as 'remote' but will also try to pull fresh images from remote repositories"
  45         echo "docker                -  Test executed in docker environment"
  46         echo "kube                  -  Test executed in kubernetes environment - requires an already started kubernetes environment"
  47         echo "--env-file  <file>    -  The script will use the supplied file to read environment variables from"
  48         echo "release               -  If this flag is given the script will use release version of the images"
  49         echo "auto-clean            -  If the function 'auto_clean_containers' is present in the end of the test script then all containers will be stopped and removed. If 'auto-clean' is not given then the function has no effect."
  50     echo "--stop-at-error       -  The script will stop when the first failed test or configuration"
  51         echo "--ricsim-prefix       -  The a1 simulator will use the supplied string as container prefix instead of 'ricsim'"
  52         echo "--use-local-image     -  The script will use local images for the supplied apps, space separated list of app short names"
  53         echo "--use-snapshot-image  -  The script will use images from the nexus snapshot repo for the supplied apps, space separated list of app short names"
  54         echo "--use-staging-image   -  The script will use images from the nexus staging repo for the supplied apps, space separated list of app short names"
  55         echo "--use-release-image   -  The script will use images from the nexus release repo for the supplied apps, space separated list of app short names"
  56         echo "--image-repo          -  Url to optional image repo. Only locally built images will be re-tagged and pushed to this repo"
  57         echo "--repo-policy         -  Policy controlling which images to re-tag and push if param --image-repo is set. Default is 'local'"
  58         echo "--cluster-timeout     -  Optional timeout for cluster where it takes time to obtain external ip/host-name. Timeout in seconds. "
  59         echo "--print-stats         -  Print current test stats after each test."
  60         echo "--override <file>     -  Override setting from the file supplied by --env-file"
  61         echo "--pre-clean           -  Will clean kube resouces when running docker and vice versa"
  62         echo "--gen-stats           -  Collect container/pod runtime statistics"
  63
  64         echo ""
  65         echo "List of app short names supported: "$APP_SHORT_NAMES
  66         exit 0
  67 fi
  68
  69 AUTOTEST_HOME=$PWD
  70 # Create a test case id, ATC (Auto Test Case), from the name of the test case script.
  71 # FTC1.sh -> ATC == FTC1
  72 ATC=$(basename "${BASH_SOURCE[$i+1]}" .sh)
  73
  74 #Create result file (containing '1' for error) for this test case
  75 #Will be replaced with a file containing '0' if all test cases pass
  76 echo "1" > "$PWD/.result$ATC.txt"
  77
  78 #Formatting for 'echo' cmd
  79 BOLD="\033[1m"
  80 EBOLD="\033[0m"
  81 RED="\033[31m\033[1m"
  82 ERED="\033[0m"
  83 GREEN="\033[32m\033[1m"
  84 EGREEN="\033[0m"
  85 YELLOW="\033[33m\033[1m"
  86 EYELLOW="\033[0m"
  87 SAMELINE="\033[0K\r"
  88
  89 # Just resetting any previous echo formatting...
  90 echo -ne $EBOLD
  91
  92 # default test environment variables
  93 TEST_ENV_VAR_FILE=""
  94 #Override env file, will be added on top of the above file
  95 TEST_ENV_VAR_FILE_OVERRIDE=""
  96
  97 echo "Test case started as: ${BASH_SOURCE[$i+1]} "$@
  98
  99 #Localhost constants
 100 LOCALHOST_NAME="localhost"
 101 LOCALHOST_HTTP="http://localhost"
 102 LOCALHOST_HTTPS="https://localhost"
 103
 104 # Var to hold 'auto' in case containers shall be stopped when test case ends
 105 AUTO_CLEAN=""
 106
 107 # Var to indicate pre clean, if flag --pre-clean is set the script will clean kube resouces when running docker and vice versa
 108 PRE_CLEAN="0"
 109
 110 # Var to hold the app names to use local images for
 111 USE_LOCAL_IMAGES=""
 112
 113 # Var to hold the app names to use remote snapshot images for
 114 USE_SNAPSHOT_IMAGES=""
 115
 116 # Var to hold the app names to use remote staging images for
 117 USE_STAGING_IMAGES=""
 118
 119 # Var to hold the app names to use remote release images for
 120 USE_RELEASE_IMAGES=""
 121
 122
 123 # 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
 124 STOP_AT_ERROR=0
 125
 126 # The default value "DEV" indicate that development image tags (SNAPSHOT) and nexus repos (nexus port 10002) are used.
 127 # The value "RELEASE" indicate that relase image tag and nexus repos (nexus port) are used
 128 # Applies only to images defined in the test-env files with image names and tags defined as XXXX_RELEASE
 129 IMAGE_CATEGORY="DEV"
 130
 131 #Var to indicate docker-compose version, V1 or V2
 132 #V1 names replicated containers <proj-name>_<service-name>_<index>
 133 #V2 names replicated containers <proj-name>-<service-name>-<index>
 134 DOCKER_COMPOSE_VERION="V1"
 135
 136 # Function to indent cmd output with one space
 137 indent1() { sed 's/^/ /'; }
 138
 139 # Function to indent cmd output with two spaces
 140 indent2() { sed 's/^/  /'; }
 141
 142 # Set a description string for the test case
 143 if [ -z "$TC_ONELINE_DESCR" ]; then
 144         TC_ONELINE_DESCR="<no-description>"
 145         echo "No test case description found, TC_ONELINE_DESCR should be set on in the test script , using "$TC_ONELINE_DESCR
 146 fi
 147
 148 # Counter for test suites
 149 if [ -f .tmp_tcsuite_ctr ]; then
 150         tmpval=$(< .tmp_tcsuite_ctr)
 151         ((tmpval++))
 152         echo $tmpval > .tmp_tcsuite_ctr
 153 fi
 154
 155 # Create the logs dir if not already created in the current dir
 156 if [ ! -d "logs" ]; then
 157     mkdir logs
 158 fi
 159 TESTLOGS=$PWD/logs
 160
 161 # Create the tmp dir for temporary files that is not needed after the test
 162 # hidden files for the test env is still stored in the current dir
 163 # files in the ./tmp is moved to ./tmp/prev when a new test is started
 164 if [ ! -d "tmp" ]; then
 165     mkdir tmp
 166 fi
 167 curdir=$PWD
 168 cd tmp
 169 if [ $? -ne 0 ]; then
 170         echo "Cannot cd to $PWD/tmp"
 171         echo "Dir cannot be created. Exiting...."
 172 fi
 173 if [ ! -d "prev" ]; then
 174     mkdir prev
 175 fi
 176 cd $curdir
 177 mv ./tmp/* ./tmp/prev 2> /dev/null
 178
 179 # Create a http message log for this testcase
 180 HTTPLOG=$PWD"/.httplog_"$ATC".txt"
 181 echo "" > $HTTPLOG
 182
 183 # Create a log dir for the test case
 184 mkdir -p $TESTLOGS/$ATC
 185
 186 # Save create for current logs
 187 mkdir -p $TESTLOGS/$ATC/previous
 188
 189 rm $TESTLOGS/$ATC/previous/*.log &> /dev/null
 190 rm $TESTLOGS/$ATC/previous/*.txt &> /dev/null
 191 rm $TESTLOGS/$ATC/previous/*.json &> /dev/null
 192
 193 mv  $TESTLOGS/$ATC/*.log $TESTLOGS/$ATC/previous &> /dev/null
 194 mv  $TESTLOGS/$ATC/*.txt $TESTLOGS/$ATC/previous &> /dev/null
 195 mv  $TESTLOGS/$ATC/*.txt $TESTLOGS/$ATC/previous &> /dev/null
 196
 197 # Clear the log dir for the test case
 198 rm $TESTLOGS/$ATC/*.log &> /dev/null
 199 rm $TESTLOGS/$ATC/*.txt &> /dev/null
 200 rm $TESTLOGS/$ATC/*.json &> /dev/null
 201
 202 # Log all output from the test case to a TC log
 203 TCLOG=$TESTLOGS/$ATC/TC.log
 204 exec &>  >(tee ${TCLOG})
 205
 206 #Variables for counting tests as well as passed and failed tests
 207 RES_TEST=0
 208 RES_PASS=0
 209 RES_FAIL=0
 210 RES_CONF_FAIL=0
 211 RES_DEVIATION=0
 212
 213 #Var to control if current stats shall be printed
 214 PRINT_CURRENT_STATS=0
 215
 216 #Var to control if container/pod runtim statistics shall be collected
 217 COLLECT_RUNTIME_STATS=0
 218
 219 #File to keep deviation messages
 220 DEVIATION_FILE=".tmp_deviations"
 221 rm $DEVIATION_FILE &> /dev/null
 222
 223 # Trap "command not found" and make the script fail
 224 trap_fnc() {
 225
 226         if [ $? -eq 127 ]; then
 227                 echo -e $RED"Function not found, setting script to FAIL"$ERED
 228                 ((RES_CONF_FAIL++))
 229                 __print_current_stats
 230         fi
 231 }
 232 trap trap_fnc ERR
 233
 234 # Trap to kill subprocesses
 235 trap "kill 0" EXIT
 236
 237 # Counter for tests
 238 TEST_SEQUENCE_NR=1
 239
 240 # Function to log the start of a test case
 241 __log_test_start() {
 242         TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
 243         echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${FUNCNAME[1]}" $@ $EBOLD
 244     echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${FUNCNAME[1]}" $@ >> $HTTPLOG
 245         ((RES_TEST++))
 246         ((TEST_SEQUENCE_NR++))
 247 }
 248
 249 # Function to print current statistics
 250 __print_current_stats() {
 251         if [ $PRINT_CURRENT_STATS -ne 0 ]; then
 252                 echo " Current stats - exe-time, tests, passes, fails, conf fails, deviations: $(($SECONDS-$TCTEST_START)), $RES_TEST, $RES_PASS, $RES_FAIL, $RES_CONF_FAIL, $RES_DEVIATION"
 253         fi
 254 }
 255
 256 # General function to log a failed test case
 257 __log_test_fail_general() {
 258         echo -e $RED" FAIL."$1 $ERED
 259         ((RES_FAIL++))
 260         __print_current_stats
 261         __check_stop_at_error
 262 }
 263
 264 # Function to log a test case failed due to incorrect response code
 265 __log_test_fail_status_code() {
 266         echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
 267         ((RES_FAIL++))
 268         __print_current_stats
 269         __check_stop_at_error
 270 }
 271
 272 # Function to log a test case failed due to incorrect response body
 273 __log_test_fail_body() {
 274         echo -e $RED" FAIL, returned body not correct"$ERED
 275         ((RES_FAIL++))
 276         __print_current_stats
 277         __check_stop_at_error
 278 }
 279
 280 # Function to log a test case that is not supported
 281 __log_test_fail_not_supported() {
 282         echo -e $RED" FAIL, function not supported"$ERED
 283         ((RES_FAIL++))
 284         __print_current_stats
 285         __check_stop_at_error
 286 }
 287
 288 # General function to log a passed test case
 289 __log_test_pass() {
 290         if [ $# -gt 0 ]; then
 291                 echo $@
 292         fi
 293         ((RES_PASS++))
 294         echo -e $GREEN" PASS"$EGREEN
 295         __print_current_stats
 296 }
 297
 298 #Counter for configurations
 299 CONF_SEQUENCE_NR=1
 300
 301 # Function to log the start of a configuration setup
 302 __log_conf_start() {
 303         TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
 304         echo -e $BOLD"CONF $CONF_SEQUENCE_NR (${BASH_LINENO[1]}): "${FUNCNAME[1]} $@ $EBOLD
 305         echo "CONF $CONF_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): "${FUNCNAME[1]} $@  >> $HTTPLOG
 306         ((CONF_SEQUENCE_NR++))
 307 }
 308
 309 # Function to log a failed configuration setup
 310 __log_conf_fail_general() {
 311         echo -e $RED" FAIL."$1 $ERED
 312         ((RES_CONF_FAIL++))
 313         __print_current_stats
 314         __check_stop_at_error
 315 }
 316
 317 # Function to log a failed configuration setup due to incorrect response code
 318 __log_conf_fail_status_code() {
 319         echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
 320         ((RES_CONF_FAIL++))
 321         __print_current_stats
 322         __check_stop_at_error
 323 }
 324
 325 # Function to log a failed configuration setup due to incorrect response body
 326 __log_conf_fail_body() {
 327         echo -e $RED" FAIL, returned body not correct"$ERED
 328         ((RES_CONF_FAIL++))
 329         __print_current_stats
 330         __check_stop_at_error
 331 }
 332
 333 # Function to log a configuration that is not supported
 334 __log_conf_fail_not_supported() {
 335         echo -e $RED" FAIL, function not supported"$ERED$@
 336         ((RES_CONF_FAIL++))
 337         __print_current_stats
 338         __check_stop_at_error
 339 }
 340
 341 # Function to log a passed configuration setup
 342 __log_conf_ok() {
 343         if [ $# -gt 0 ]; then
 344                 echo $@
 345         fi
 346         echo -e $GREEN" OK"$EGREEN
 347         __print_current_stats
 348 }
 349
 350 #Var for measuring execution time
 351 TCTEST_START=$SECONDS
 352
 353 #Vars to hold the start time and timer text for a custom timer
 354 TC_TIMER_STARTTIME=""
 355 TC_TIMER_TIMER_TEXT=""
 356 TC_TIMER_CURRENT_FAILS="" # Then numer of failed test when timer starts.
 357                           # Compared with the current number of fails at timer stop
 358                                                   # to judge the measurement reliability
 359
 360 #File to save timer measurement results
 361 TIMER_MEASUREMENTS=".timer_measurement.txt"
 362 echo -e "Activity \t Duration \t Info" > $TIMER_MEASUREMENTS
 363
 364 # If this is set, some images (control by the parameter repo-polcy) will be re-tagged and pushed to this repo before any
 365 IMAGE_REPO_ADR=""
 366 IMAGE_REPO_POLICY="local"
 367 CLUSTER_TIME_OUT=0
 368
 369 echo "-------------------------------------------------------------------------------------------------"
 370 echo "-----------------------------------      Test case: "$ATC
 371 echo "-----------------------------------      Started:   "$(date)
 372 echo "-------------------------------------------------------------------------------------------------"
 373 echo "-- Description: "$TC_ONELINE_DESCR
 374 echo "-------------------------------------------------------------------------------------------------"
 375 echo "-----------------------------------      Test case setup      -----------------------------------"
 376
 377 echo "Setting AUTOTEST_HOME="$AUTOTEST_HOME
 378 START_ARG=$1
 379 paramerror=0
 380 paramerror_str=""
 381 if [ $# -lt 1 ]; then
 382         paramerror=1
 383 fi
 384 if [ $paramerror -eq 0 ]; then
 385         if [ "$1" != "remote" ] && [ "$1" != "remote-remove" ]; then
 386                 paramerror=1
 387                 if [ -z "$paramerror_str" ]; then
 388                         paramerror_str="First arg shall be 'remote' or 'remote-remove'"
 389                 fi
 390         else
 391                 shift;
 392         fi
 393 fi
 394 if [ $paramerror -eq 0 ]; then
 395         if [ "$1" != "docker" ] && [ "$1" != "kube" ]; then
 396                 paramerror=1
 397                 if [ -z "$paramerror_str" ]; then
 398                         paramerror_str="Second arg shall be 'docker' or 'kube'"
 399                 fi
 400         else
 401                 if [ $1 == "docker" ]; then
 402                         RUNMODE="DOCKER"
 403                         echo "Setting RUNMODE=DOCKER"
 404                 fi
 405                 if [ $1 == "kube" ]; then
 406                         RUNMODE="KUBE"
 407                         echo "Setting RUNMODE=KUBE"
 408                 fi
 409                 shift;
 410         fi
 411 fi
 412 foundparm=0
 413 while [ $paramerror -eq 0 ] && [ $foundparm -eq 0 ]; do
 414         foundparm=1
 415         if [ $paramerror -eq 0 ]; then
 416                 if [ "$1" == "release" ]; then
 417                         IMAGE_CATEGORY="RELEASE"
 418                         echo "Option set - Release image tags used for applicable images "
 419                         shift;
 420                         foundparm=0
 421                 fi
 422         fi
 423         if [ $paramerror -eq 0 ]; then
 424                 if [ "$1" == "auto-clean" ]; then
 425                         AUTO_CLEAN="auto"
 426                         echo "Option set - Auto clean at end of test script"
 427                         shift;
 428                         foundparm=0
 429                 fi
 430         fi
 431         if [ $paramerror -eq 0 ]; then
 432                 if [ "$1" == "--stop-at-error" ]; then
 433                         STOP_AT_ERROR=1
 434                         echo "Option set - Stop at first error"
 435                         shift;
 436                         foundparm=0
 437                 fi
 438         fi
 439         if [ $paramerror -eq 0 ]; then
 440                 if [ "$1" == "--ricsim-prefix" ]; then
 441                         shift;
 442                         TMP_RIC_SIM_PREFIX=$1  #RIC_SIM_PREFIX need to be updated after sourcing of the env file
 443                         if [ -z "$1" ]; then
 444                                 paramerror=1
 445                                 if [ -z "$paramerror_str" ]; then
 446                                         paramerror_str="No prefix found for flag: '--ricsim-prefix'"
 447                                 fi
 448                         else
 449                                 echo "Option set - Overriding RIC_SIM_PREFIX with: "$1
 450                                 shift;
 451                                 foundparm=0
 452                         fi
 453                 fi
 454         fi
 455         if [ $paramerror -eq 0 ]; then
 456                 if [ "$1" == "--env-file" ]; then
 457                         shift;
 458                         TEST_ENV_VAR_FILE=$1
 459                         if [ -z "$1" ]; then
 460                                 paramerror=1
 461                                 if [ -z "$paramerror_str" ]; then
 462                                         paramerror_str="No env file found for flag: '--env-file'"
 463                                 fi
 464                         else
 465                                 echo "Option set - Reading test env from: "$1
 466                                 shift;
 467                                 foundparm=0
 468                         fi
 469                 fi
 470         fi
 471         if [ $paramerror -eq 0 ]; then
 472                 if [ "$1" == "--use-local-image" ]; then
 473                         USE_LOCAL_IMAGES=""
 474                         shift
 475                         while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
 476                                 USE_LOCAL_IMAGES=$USE_LOCAL_IMAGES" "$1
 477                                 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
 478                                         paramerror=1
 479                                         if [ -z "$paramerror_str" ]; then
 480                                                 paramerror_str="App name $1 is not available for local override for flag: '--use-local-image'"
 481                                         fi
 482                                 fi
 483                                 shift;
 484                         done
 485                         foundparm=0
 486                         if [ -z "$USE_LOCAL_IMAGES" ]; then
 487                                 paramerror=1
 488                                 if [ -z "$paramerror_str" ]; then
 489                                         paramerror_str="No app name found for flag: '--use-local-image'"
 490                                 fi
 491                         else
 492                                 echo "Option set - Overriding with local images for app(s):"$USE_LOCAL_IMAGES
 493                         fi
 494                 fi
 495         fi
 496         if [ $paramerror -eq 0 ]; then
 497                 if [ "$1" == "--use-snapshot-image" ]; then
 498                         USE_SNAPSHOT_IMAGES=""
 499                         shift
 500                         while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
 501                                 USE_SNAPSHOT_IMAGES=$USE_SNAPSHOT_IMAGES" "$1
 502                                 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
 503                                         paramerror=1
 504                                         if [ -z "$paramerror_str" ]; then
 505                                                 paramerror_str="App name $1 is not available for snapshot override for flag: '--use-snapshot-image'"
 506                                         fi
 507                                 fi
 508                                 shift;
 509                         done
 510                         foundparm=0
 511                         if [ -z "$USE_SNAPSHOT_IMAGES" ]; then
 512                                 paramerror=1
 513                                 if [ -z "$paramerror_str" ]; then
 514                                         paramerror_str="No app name found for flag: '--use-snapshot-image'"
 515                                 fi
 516                         else
 517                                 echo "Option set - Overriding with snapshot images for app(s):"$USE_SNAPSHOT_IMAGES
 518                         fi
 519                 fi
 520         fi
 521         if [ $paramerror -eq 0 ]; then
 522                 if [ "$1" == "--use-staging-image" ]; then
 523                         USE_STAGING_IMAGES=""
 524                         shift
 525                         while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
 526                                 USE_STAGING_IMAGES=$USE_STAGING_IMAGES" "$1
 527                                 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
 528                                         paramerror=1
 529                                         if [ -z "$paramerror_str" ]; then
 530                                                 paramerror_str="App name $1 is not available for staging override for flag: '--use-staging-image'"
 531                                         fi
 532                                 fi
 533                                 shift;
 534                         done
 535                         foundparm=0
 536                         if [ -z "$USE_STAGING_IMAGES" ]; then
 537                                 paramerror=1
 538                                 if [ -z "$paramerror_str" ]; then
 539                                         paramerror_str="No app name found for flag: '--use-staging-image'"
 540                                 fi
 541                         else
 542                                 echo "Option set - Overriding with staging images for app(s):"$USE_STAGING_IMAGES
 543                         fi
 544                 fi
 545         fi
 546         if [ $paramerror -eq 0 ]; then
 547                 if [ "$1" == "--use-release-image" ]; then
 548                         USE_RELEASE_IMAGES=""
 549                         shift
 550                         while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
 551                                 USE_RELEASE_IMAGES=$USE_RELEASE_IMAGES" "$1
 552                                 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
 553                                         paramerror=1
 554                                         if [ -z "$paramerror_str" ]; then
 555                                                 paramerror_str="App name $1 is not available for release override for flag: '--use-release-image'"
 556                                         fi
 557                                 fi
 558                                 shift;
 559                         done
 560                         foundparm=0
 561                         if [ -z "$USE_RELEASE_IMAGES" ]; then
 562                                 paramerror=1
 563                                 if [ -z "$paramerror_str" ]; then
 564                                         paramerror_str="No app name found for flag: '--use-release-image'"
 565                                 fi
 566                         else
 567                                 echo "Option set - Overriding with release images for app(s):"$USE_RELEASE_IMAGES
 568                         fi
 569                 fi
 570         fi
 571         if [ $paramerror -eq 0 ]; then
 572                 if [ "$1" == "--image-repo" ]; then
 573                         shift;
 574                         IMAGE_REPO_ADR=$1
 575                         if [ -z "$1" ]; then
 576                                 paramerror=1
 577                                 if [ -z "$paramerror_str" ]; then
 578                                         paramerror_str="No image repo url found for : '--image-repo'"
 579                                 fi
 580                         else
 581                                 echo "Option set - Image repo url: "$1
 582                                 shift;
 583                                 foundparm=0
 584                         fi
 585                 fi
 586         fi
 587         if [ $paramerror -eq 0 ]; then
 588                 if [ "$1" == "--repo-policy" ]; then
 589                         shift;
 590                         IMAGE_REPO_POLICY=$1
 591                         if [ -z "$1" ]; then
 592                                 paramerror=1
 593                                 if [ -z "$paramerror_str" ]; then
 594                                         paramerror_str="No policy found for : '--repo-policy'"
 595                                 fi
 596                         else
 597                             if [ "$1" == "local" ] || [ "$1" == "remote" ]; then
 598                                         echo "Option set - Image repo policy: "$1
 599                                         shift;
 600                                         foundparm=0
 601                                 else
 602                                         paramerror=1
 603                                         if [ -z "$paramerror_str" ]; then
 604                                                 paramerror_str="Repo policy shall be 'local' or 'remote'"
 605                                         fi
 606                                 fi
 607                         fi
 608                 fi
 609         fi
 610         if [ $paramerror -eq 0 ]; then
 611                 if [ "$1" == "--cluster-timeout" ]; then
 612                         shift;
 613                         CLUSTER_TIME_OUT=$1
 614                         if [ -z "$1" ]; then
 615                                 paramerror=1
 616                                 if [ -z "$paramerror_str" ]; then
 617                                         paramerror_str="No timeout value found for : '--cluster-timeout'"
 618                                 fi
 619                         else
 620                                 #Check if positive int
 621                                 case ${CLUSTER_TIME_OUT#[+]} in
 622                                         *[!0-9]* | '')
 623                                                 paramerror=1
 624                                                 if [ -z "$paramerror_str" ]; then
 625                                                         paramerror_str="Value for '--cluster-timeout' not an int : "$CLUSTER_TIME_OUT
 626                                                 fi
 627                                                 ;;
 628                                         * ) ;; # Ok
 629                                 esac
 630                                 echo "Option set - Cluster timeout: "$1
 631                                 shift;
 632                                 foundparm=0
 633                         fi
 634                 fi
 635         fi
 636         if [ $paramerror -eq 0 ]; then
 637                 if [ "$1" == "--override" ]; then
 638                         shift;
 639                         TEST_ENV_VAR_FILE_OVERRIDE=$1
 640                         if [ -z "$1" ]; then
 641                                 paramerror=1
 642                                 if [ -z "$paramerror_str" ]; then
 643                                         paramerror_str="No env file found for flag: '--override'"
 644                                 fi
 645                         else
 646                                 if [ ! -f $TEST_ENV_VAR_FILE_OVERRIDE ]; then
 647                                         paramerror=1
 648                                         if [ -z "$paramerror_str" ]; then
 649                                                 paramerror_str="File for '--override' does not exist : "$TEST_ENV_VAR_FILE_OVERRIDE
 650                                         fi
 651                                 fi
 652                                 echo "Option set - Override env from: "$1
 653                                 shift;
 654                                 foundparm=0
 655                         fi
 656                 fi
 657         fi
 658         if [ $paramerror -eq 0 ]; then
 659                 if [ "$1" == "--pre-clean" ]; then
 660                         PRE_CLEAN=1
 661                         echo "Option set - Pre-clean of kube/docker resouces"
 662                         shift;
 663                         foundparm=0
 664                 fi
 665         fi
 666         if [ $paramerror -eq 0 ]; then
 667                 if [ "$1" == "--print-stats" ]; then
 668                         PRINT_CURRENT_STATS=1
 669                         echo "Option set - Print stats"
 670                         shift;
 671                         foundparm=0
 672                 fi
 673         fi
 674         if [ $paramerror -eq 0 ]; then
 675                 if [ "$1" == "--gen-stats" ]; then
 676                         COLLECT_RUNTIME_STATS=1
 677                         echo "Option set - Collect runtime statistics"
 678                         shift;
 679                         foundparm=0
 680                 fi
 681         fi
 682
 683 done
 684 echo ""
 685
 686 #Still params left?
 687 if [ $paramerror -eq 0 ] && [ $# -gt 0 ]; then
 688         paramerror=1
 689         if [ -z "$paramerror_str" ]; then
 690                 paramerror_str="Unknown parameter(s): "$@
 691         fi
 692 fi
 693
 694 if [ $paramerror -eq 1 ]; then
 695         echo -e $RED"Incorrect arg list: "$paramerror_str$ERED
 696         __print_args
 697         exit 1
 698 fi
 699
 700 # sourcing the selected env variables for the test case
 701 if [ -f "$TEST_ENV_VAR_FILE" ]; then
 702         echo -e $BOLD"Sourcing env vars from: "$TEST_ENV_VAR_FILE$EBOLD
 703         . $TEST_ENV_VAR_FILE
 704         if [ ! -z "$TEST_ENV_VAR_FILE_OVERRIDE" ]; then
 705                 echo -e $BOLD"Sourcing override env vars from: "$TEST_ENV_VAR_FILE_OVERRIDE$EBOLD
 706                 . $TEST_ENV_VAR_FILE_OVERRIDE
 707         fi
 708
 709         if [ -z "$TEST_ENV_PROFILE" ] || [ -z "$SUPPORTED_PROFILES" ]; then
 710                 echo -e $YELLOW"This test case may not work with selected test env file. TEST_ENV_PROFILE is missing in test_env file or SUPPORTED_PROFILES is missing in test case file"$EYELLOW
 711         else
 712                 found_profile=0
 713                 for prof in $SUPPORTED_PROFILES; do
 714                         if [ "$TEST_ENV_PROFILE" == "$prof" ]; then
 715                                 echo -e $GREEN"Test case supports the selected test env file"$EGREEN
 716                                 found_profile=1
 717                         fi
 718                 done
 719                 if [ $found_profile -ne 1 ]; then
 720                         echo -e $RED"Test case does not support the selected test env file"$ERED
 721                         echo "Profile: "$TEST_ENV_PROFILE"     Supported profiles: "$SUPPORTED_PROFILES
 722                         echo -e $RED"Exiting...."$ERED
 723                         exit 1
 724                 fi
 725         fi
 726 else
 727         echo -e $RED"Selected env var file does not exist: "$TEST_ENV_VAR_FILE$ERED
 728         echo " Select one of following env var file matching the intended target of the test"
 729         echo " Restart the test using the flag '--env-file <path-to-env-file>"
 730         ls $AUTOTEST_HOME/../common/test_env* | indent1
 731         exit 1
 732 fi
 733
 734 #This var need be preserved from the command line option, if set, when env var is sourced.
 735 if [ ! -z "$TMP_RIC_SIM_PREFIX" ]; then
 736         RIC_SIM_PREFIX=$TMP_RIC_SIM_PREFIX
 737 fi
 738
 739 if [ -z "$PROJECT_IMAGES_APP_NAMES" ]; then
 740         echo -e $RED"Var PROJECT_IMAGES_APP_NAMES must be defined in: "$TEST_ENV_VAR_FILE $ERED
 741         exit 1
 742 fi
 743
 744 if [[ $SUPPORTED_RUNMODES != *"$RUNMODE"* ]]; then
 745         echo -e $RED"This test script does not support RUNMODE $RUNMODE"$ERED
 746         echo "Supported RUNMODEs: "$SUPPORTED_RUNMODES
 747         exit 1
 748 fi
 749
 750 # Choose list of included apps depending on run-mode
 751 if [ $RUNMODE == "KUBE" ]; then
 752         INCLUDED_IMAGES=$KUBE_INCLUDED_IMAGES
 753 else
 754         INCLUDED_IMAGES=$DOCKER_INCLUDED_IMAGES
 755 fi
 756
 757 echo ""
 758 # auto adding system apps
 759 echo -e $BOLD"Auto adding system apps"$EBOLD
 760 if [ $RUNMODE == "KUBE" ]; then
 761         INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_KUBE_SYSTEM_APPS
 762         TMP_APPS=$TESTENV_KUBE_SYSTEM_APPS
 763 else
 764         INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_DOCKER_SYSTEM_APPS
 765         TMP_APPS=$TESTENV_DOCKER_SYSTEM_APPS
 766 fi
 767 if [ ! -z "$TMP_APPS" ]; then
 768         for iapp in "$TMP_APPS"; do
 769                 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
 770                 file_pointer="../common/"$file_pointer"_api_functions.sh"
 771                 echo " Auto-adding system app $iapp.  Sourcing $file_pointer"
 772                 . $file_pointer
 773         done
 774 else
 775         echo " None"
 776 fi
 777
 778 echo -e $BOLD"Auto adding included apps"$EBOLD
 779         for iapp in $INCLUDED_IMAGES; do
 780                 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
 781                 file_pointer="../common/"$file_pointer"_api_functions.sh"
 782                 echo " Auto-adding included app $iapp.  Sourcing $file_pointer"
 783                 . $file_pointer
 784                 if [ ! -f "$file_pointer" ]; then
 785                         echo " Include file $file_pointer for app $iapp does not exist"
 786                         exit 1
 787                 fi
 788         done
 789 echo ""
 790
 791 echo -e $BOLD"Test environment info"$EBOLD
 792
 793 # Check needed installed sw
 794
 795 tmp=$(which bash)
 796 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
 797         echo -e $RED"bash is required to run the test environment, pls install"$ERED
 798         exit 1
 799 fi
 800 echo " bash is installed and using version:"
 801 echo "$(bash --version)" | indent2
 802
 803 tmp=$(which python3)
 804 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
 805         echo -e $RED"python3 is required to run the test environment, pls install"$ERED
 806         exit 1
 807 fi
 808 echo " python3 is installed and using version: $(python3 --version)"
 809
 810 tmp=$(which docker)
 811 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
 812         echo -e $RED"docker is required to run the test environment, pls install"$ERED
 813         exit 1
 814 fi
 815 echo " docker is installed and using versions:"
 816 echo  "  $(docker version --format 'Client version {{.Client.Version}} Server version {{.Server.Version}}')"
 817
 818 tmp=$(which docker-compose)
 819 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
 820         if [ $RUNMODE == "DOCKER" ]; then
 821                 echo -e $RED"docker-compose is required to run the test environment, pls install"$ERED
 822                 exit 1
 823         fi
 824 fi
 825 tmp=$(docker-compose version --short)
 826 echo " docker-compose installed and using version $tmp"
 827 if [[ "$tmp" == *'v2'* ]]; then
 828         DOCKER_COMPOSE_VERION="V2"
 829 fi
 830
 831 tmp=$(which kubectl)
 832 if [ $? -ne 0 ] || [ -z tmp ]; then
 833         if [ $RUNMODE == "KUBE" ]; then
 834                 echo -e $RED"kubectl is required to run the test environment in kubernetes mode, pls install"$ERED
 835                 exit 1
 836         fi
 837 else
 838         if [ $RUNMODE == "KUBE" ]; then
 839                 echo " kubectl is installed and using versions:"
 840                 echo $(kubectl version --short=true) | indent2
 841                 res=$(kubectl cluster-info 2>&1)
 842                 if [ $? -ne 0 ]; then
 843                         echo -e "$BOLD$RED############################################# $ERED$EBOLD"
 844                         echo -e  $BOLD$RED"Command 'kubectl cluster-info' returned error $ERED$EBOLD"
 845                         echo -e "$BOLD$RED############################################# $ERED$EBOLD"
 846                         echo " "
 847                         echo "kubectl response:"
 848                         echo $res
 849                         echo " "
 850                         echo "This script may have been started with user with no permission to run kubectl"
 851                         echo "Try running with 'sudo' or set 'KUBECONFIG'"
 852                         echo "Do either 1, 2 or 3 "
 853                         echo " "
 854                         echo "1"
 855                         echo "Run with sudo"
 856                         echo -e $BOLD"sudo <test-script-and-parameters>"$EBOLD
 857                         echo " "
 858                         echo "2"
 859                         echo "Export KUBECONFIG and pass env to sudo - (replace user)"
 860                         echo -e $BOLD"export KUBECONFIG='/home/<user>/.kube/config'"$EBOLD
 861                         echo -e $BOLD"sudo -E <test-script-and-parameters>"$EBOLD
 862                         echo " "
 863                         echo "3"
 864                         echo "Set KUBECONFIG inline (replace user)"
 865                         echo -e $BOLD"sudo  KUBECONFIG='/home/<user>/.kube/config' <test-script-and-parameters>"$EBOLD
 866
 867                         exit 1
 868                 fi
 869         fi
 870 fi
 871
 872 echo ""
 873
 874 echo -e $BOLD"Checking configured image setting for this test case"$EBOLD
 875
 876 #Temp var to check for image variable name errors
 877 IMAGE_ERR=0
 878 #Create a file with image info for later printing as a table
 879 image_list_file="./tmp/.image-list"
 880 echo -e "Application\tApp short name\tImage\ttag\ttag-switch" > $image_list_file
 881
 882 # Check if image env var is set and if so export the env var with image to use (used by docker compose files)
 883 # arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>
 884 __check_and_create_image_var() {
 885
 886         if [ $# -ne 6 ]; then
 887                 echo "Expected arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>"
 888                 ((IMAGE_ERR++))
 889                 return
 890         fi
 891
 892         __check_included_image $1
 893         if [ $? -ne 0 ]; then
 894                 echo -e "$6\t$1\t<image-excluded>\t<no-tag>"  >> $image_list_file
 895                 # Image is excluded since the corresponding app is not used in this test
 896                 return
 897         fi
 898         tmp=${6}"\t"${1}"\t"
 899         #Create var from the input var names
 900         image="${!3}"
 901         tmptag=$4"_"$5
 902         tag="${!tmptag}"
 903
 904         optional_image_repo_target=""
 905
 906         if [ -z $image ]; then
 907                 __check_ignore_image $1
 908                 if [ $? -eq 0 ]; then
 909                         app_ds=$6
 910                         if [ -z "$6" ]; then
 911                                 app_ds="<app ignored>"
 912                         fi
 913                         echo -e "$app_ds\t$1\t<image-ignored>\t<no-tag>"  >> $image_list_file
 914                         # Image is ignored since the corresponding the images is not set in the env file
 915                         __remove_included_image $1   # Remove the image from the list of included images
 916                         return
 917                 fi
 918                 echo -e $RED"\$"$3" not set in $TEST_ENV_VAR_FILE"$ERED
 919                 ((IMAGE_ERR++))
 920                 echo ""
 921                 tmp=$tmp"<no-image>\t"
 922         else
 923
 924                 optional_image_repo_target=$image
 925
 926                 #Add repo depending on image type
 927                 if [ "$5" == "REMOTE_RELEASE" ]; then
 928                         image=$NEXUS_RELEASE_REPO$image
 929                 fi
 930                 if [ "$5" == "REMOTE" ]; then
 931                         image=$NEXUS_STAGING_REPO$image
 932                 fi
 933                 if [ "$5" == "REMOTE_SNAPSHOT" ]; then
 934                         image=$NEXUS_SNAPSHOT_REPO$image
 935                 fi
 936                 if [ "$5" == "REMOTE_PROXY" ]; then
 937                         image=$NEXUS_PROXY_REPO$image
 938                 fi
 939                 if [ "$5" == "REMOTE_RELEASE_ONAP" ]; then
 940                         image=$NEXUS_RELEASE_REPO_ONAP$image
 941                 fi
 942                 if [ "$5" == "REMOTE_RELEASE_ORAN" ]; then
 943                         image=$NEXUS_RELEASE_REPO_ORAN$image
 944                 fi
 945                 #No nexus repo added for local images, tag: LOCAL
 946                 tmp=$tmp$image"\t"
 947         fi
 948         if [ -z $tag ]; then
 949                 echo -e $RED"\$"$tmptag" not set in $TEST_ENV_VAR_FILE"$ERED
 950                 ((IMAGE_ERR++))
 951                 echo ""
 952                 tmp=$tmp"<no-tag>\t"
 953         else
 954                 tmp=$tmp$tag
 955         fi
 956         tmp=$tmp"\t"$5
 957         echo -e "$tmp" >> $image_list_file
 958         #Export the env var
 959         export "${2}"=$image":"$tag  #Note, this var may be set to the value of the target value below in __check_and_pull_image
 960
 961         remote_or_local_push=false
 962         if [ ! -z "$IMAGE_REPO_ADR" ] && [[ $5 != *"PROXY"* ]]; then
 963                 if [ $5 == "LOCAL" ]; then
 964                         remote_or_local_push=true
 965                 fi
 966                 if [[ $5 == *"REMOTE"* ]]; then
 967                         if [ "$IMAGE_REPO_POLICY" == "remote" ]; then
 968                                 remote_or_local_push=true
 969                         fi
 970                 fi
 971         fi
 972         if $remote_or_local_push; then    # Only re-tag and push images according to policy, if repo is given
 973                 export "${2}_SOURCE"=$image":"$tag  #Var to keep the actual source image
 974                 if [[ $optional_image_repo_target == *"/"* ]]; then # Replace all / with _ for images to push to external repo
 975                         optional_image_repo_target_tmp=${optional_image_repo_target//\//_}
 976                         optional_image_repo_target=$optional_image_repo_target_tmp
 977                 fi
 978                 export "${2}_TARGET"=$IMAGE_REPO_ADR"/"$optional_image_repo_target":"$tag  #Create image + tag for optional image repo - pushed later if needed
 979         else
 980                 export "${2}_SOURCE"=""
 981                 export "${2}_TARGET"=""
 982         fi
 983 }
 984
 985 # Check if app uses image included in this test run
 986 # Returns 0 if image is included, 1 if not
 987 __check_included_image() {
 988         for im in $INCLUDED_IMAGES; do
 989                 if [ "$1" == "$im" ]; then
 990                         return 0
 991                 fi
 992         done
 993         return 1
 994 }
 995
 996 # Check if app uses a project image
 997 # Returns 0 if image is included, 1 if not
 998 __check_project_image() {
 999         for im in $PROJECT_IMAGES; do
1000                 if [ "$1" == "$im" ]; then
1001                         return 0
1002                 fi
1003         done
1004         return 1
1005 }
1006
1007 # Check if app uses image built by the test script
1008 # Returns 0 if image is included, 1 if not
1009 __check_image_local_build() {
1010         for im in $LOCAL_IMAGE_BUILD; do
1011                 if [ "$1" == "$im" ]; then
1012                         return 0
1013                 fi
1014         done
1015         return 1
1016 }
1017
1018 # Check if app image is conditionally ignored in this test run
1019 # Returns 0 if image is conditionally ignored, 1 if not
1020 __check_ignore_image() {
1021         for im in $CONDITIONALLY_IGNORED_IMAGES; do
1022                 if [ "$1" == "$im" ]; then
1023                         return 0
1024                 fi
1025         done
1026         return 1
1027 }
1028
1029 # Removed image from included list of included images
1030 # Used when an image is marked as conditionally ignored
1031 __remove_included_image() {
1032         tmp_img_rem_list=""
1033         for im in $INCLUDED_IMAGES; do
1034                 if [ "$1" != "$im" ]; then
1035                         tmp_img_rem_list=$tmp_img_rem_list" "$im
1036                 fi
1037         done
1038         INCLUDED_IMAGES=$tmp_img_rem_list
1039         return 0
1040 }
1041
1042 # Check if app is included in the prestarted set of apps
1043 # Returns 0 if image is included, 1 if not
1044 __check_prestarted_image() {
1045         for im in $KUBE_PRESTARTED_IMAGES; do
1046                 if [ "$1" == "$im" ]; then
1047                         return 0
1048                 fi
1049         done
1050         return 1
1051 }
1052
1053 # Check if an app shall use a local image, based on the cmd parameters
1054 __check_image_local_override() {
1055         for im in $USE_LOCAL_IMAGES; do
1056                 if [ "$1" == "$im" ]; then
1057                         return 1
1058                 fi
1059         done
1060         return 0
1061 }
1062
1063 # Check if app uses image override
1064 # Returns the image/tag suffix LOCAL for local image or REMOTE/REMOTE_RELEASE/REMOTE_SNAPSHOT for staging/release/snapshot image
1065 __check_image_override() {
1066
1067         for im in $ORAN_IMAGES_APP_NAMES; do
1068                 if [ "$1" == "$im" ]; then
1069                         echo "REMOTE_RELEASE_ORAN"
1070                         return 0
1071                 fi
1072         done
1073
1074         for im in $ONAP_IMAGES_APP_NAMES; do
1075                 if [ "$1" == "$im" ]; then
1076                         echo "REMOTE_RELEASE_ONAP"
1077                         return 0
1078                 fi
1079         done
1080
1081         found=0
1082         for im in $PROJECT_IMAGES_APP_NAMES; do
1083                 if [ "$1" == "$im" ]; then
1084                         found=1
1085                 fi
1086         done
1087
1088         if [ $found -eq 0 ]; then
1089                 echo "REMOTE_PROXY"
1090                 return 0
1091         fi
1092
1093         suffix=""
1094         if [ $IMAGE_CATEGORY == "RELEASE" ]; then
1095                 suffix="REMOTE_RELEASE"
1096         fi
1097         if [ $IMAGE_CATEGORY == "DEV" ]; then
1098                 suffix="REMOTE"
1099         fi
1100         CTR=0
1101         for im in $USE_STAGING_IMAGES; do
1102                 if [ "$1" == "$im" ]; then
1103                         suffix="REMOTE"
1104                         ((CTR++))
1105                 fi
1106         done
1107         for im in $USE_RELEASE_IMAGES; do
1108                 if [ "$1" == "$im" ]; then
1109                         suffix="REMOTE_RELEASE"
1110                         ((CTR++))
1111                 fi
1112         done
1113         for im in $USE_SNAPSHOT_IMAGES; do
1114                 if [ "$1" == "$im" ]; then
1115                         suffix="REMOTE_SNAPSHOT"
1116                         ((CTR++))
1117                 fi
1118         done
1119         for im in $USE_LOCAL_IMAGES; do
1120                 if [ "$1" == "$im" ]; then
1121                         suffix="LOCAL"
1122                         ((CTR++))
1123                 fi
1124         done
1125         echo $suffix
1126         if [ $CTR -gt 1 ]; then
1127                 exit 1
1128         fi
1129         return 0
1130 }
1131
1132 # Function to re-tag and image and push to another image repo
1133 __retag_and_push_image() {
1134         if [ ! -z "$IMAGE_REPO_ADR" ]; then
1135                 source_image="${!1}"
1136                 trg_var_name=$1_"TARGET" # This var is created in func __check_and_create_image_var
1137                 target_image="${!trg_var_name}"
1138
1139                 if [ -z $target_image ]; then
1140                         return 0  # Image with no target shall not be pushed
1141                 fi
1142
1143                 echo -ne "  Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1144                 tmp=$(docker image tag $source_image ${target_image} )
1145                 if [ $? -ne 0 ]; then
1146                         docker stop $tmp &> ./tmp/.dockererr
1147                         ((IMAGE_ERR++))
1148                         echo ""
1149                         echo -e "  Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1150                         cat ./tmp/.dockererr
1151                         return 1
1152                 else
1153                         echo -e "  Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1154                 fi
1155                 echo -ne "  Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1156                 tmp=$(docker push ${target_image} )
1157                 if [ $? -ne 0 ]; then
1158                         docker stop $tmp &> ./tmp/.dockererr
1159                         ((IMAGE_ERR++))
1160                         echo ""
1161                         echo -e "  Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1162                         cat ./tmp/.dockererr
1163                         return 1
1164                 else
1165                         echo -e "  Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1166                 fi
1167                 export "${1}"=$target_image
1168         fi
1169         return 0
1170 }
1171
1172 #Function to check if image exist and stop+remove the container+pull new images as needed
1173 #args <script-start-arg> <descriptive-image-name> <container-base-name> <image-with-tag-var-name>
1174 __check_and_pull_image() {
1175
1176         source_image="${!4}"
1177
1178         echo -e " Checking $BOLD$2$EBOLD container(s) with basename: $BOLD$3$EBOLD using image: $BOLD$source_image$EBOLD"
1179         format_string="\"{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\""
1180         tmp_im=$(docker images --format $format_string $source_image)
1181
1182         if [ $1 == "local" ]; then
1183                 if [ -z "$tmp_im" ]; then
1184                         echo -e "  "$2" (local image): \033[1m"$source_image"\033[0m $RED does not exist in local registry, need to be built (or manually pulled)"$ERED
1185                         ((IMAGE_ERR++))
1186                         return 1
1187                 else
1188                         echo -e "  "$2" (local image): \033[1m"$source_image"\033[0m "$GREEN"OK"$EGREEN
1189                 fi
1190         elif [ $1 == "remote" ] || [ $1 == "remote-remove" ]; then
1191                 if [ $1 == "remote-remove" ]; then
1192                         if [ $RUNMODE == "DOCKER" ]; then
1193                                 echo -ne "  Attempt to stop and remove container(s), if running - ${SAMELINE}"
1194                                 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME})
1195                                 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1196                                         docker stop $tmp &> ./tmp/.dockererr
1197                                         if [ $? -ne 0 ]; then
1198                                                 ((IMAGE_ERR++))
1199                                                 echo ""
1200                                                 echo -e $RED"  Container(s) could not be stopped - try manual stopping the container(s)"$ERED
1201                                                 cat ./tmp/.dockererr
1202                                                 return 1
1203                                         fi
1204                                 fi
1205                                 echo -ne "  Attempt to stop and remove container(s), if running - "$GREEN"stopped"$EGREEN"${SAMELINE}"
1206                                 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME}) &> /dev/null
1207                                 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1208                                         docker rm $tmp &> ./tmp/.dockererr
1209                                         if [ $? -ne 0 ]; then
1210                                                 ((IMAGE_ERR++))
1211                                                 echo ""
1212                                                 echo -e $RED"  Container(s) could not be removed - try manual removal of the container(s)"$ERED
1213                                                 cat ./tmp/.dockererr
1214                                                 return 1
1215                                         fi
1216                                 fi
1217                                 echo -e "  Attempt to stop and remove container(s), if running - "$GREEN"stopped removed"$EGREEN
1218                                 tmp_im=""
1219                         else
1220                                 tmp_im=""
1221                         fi
1222                 fi
1223                 if [ -z "$tmp_im" ]; then
1224                         echo -ne "  Pulling image${SAMELINE}"
1225                         out=$(docker pull $source_image)
1226                         if [ $? -ne 0 ]; then
1227                                 echo ""
1228                                 echo -e "  Pulling image -$RED could not be pulled"$ERED
1229                                 ((IMAGE_ERR++))
1230                                 echo $out > ./tmp/.dockererr
1231                                 echo $out
1232                                 return 1
1233                         fi
1234                         echo $out > ./tmp/.dockererr
1235                         if [[ $out == *"up to date"* ]]; then
1236                                 echo -e "  Pulling image -$GREEN Image is up to date $EGREEN"
1237                         elif [[ $out == *"Downloaded newer image"* ]]; then
1238                                 echo -e "  Pulling image -$GREEN Newer image pulled $EGREEN"
1239                         else
1240                                 echo -e "  Pulling image -$GREEN Pulled $EGREEN"
1241                         fi
1242                 else
1243                         echo -e "  Pulling image -$GREEN OK $EGREEN(exists in local repository)"
1244                 fi
1245         fi
1246
1247         __retag_and_push_image $4
1248
1249         return $?
1250 }
1251
1252 setup_testenvironment() {
1253         # Check that image env setting are available
1254         echo ""
1255
1256         # Image var setup for all project images included in the test
1257         for imagename in $APP_SHORT_NAMES; do
1258                 __check_included_image $imagename
1259                 incl=$?
1260                 __check_project_image $imagename
1261                 proj=$?
1262                 if [ $incl -eq 0 ]; then
1263                         if [ $proj -eq 0 ]; then
1264                                 IMAGE_SUFFIX=$(__check_image_override $imagename)
1265                                 if [ $? -ne 0 ]; then
1266                                         echo -e $RED"Image setting from cmd line not consistent for $imagename."$ERED
1267                                         ((IMAGE_ERR++))
1268                                 fi
1269                         else
1270                                 IMAGE_SUFFIX="none"
1271                         fi
1272                         # A function name is created from the app short name
1273                         # for example app short name 'ECS' -> produce the function
1274                         # name __ECS_imagesetup
1275                         # This function is called and is expected to exist in the imported
1276                         # file for the ecs test functions
1277                         # The resulting function impl will call '__check_and_create_image_var' function
1278                         # with appropriate parameters
1279                         # If the image suffix is none, then the component decides the suffix
1280                         function_pointer="__"$imagename"_imagesetup"
1281                         $function_pointer $IMAGE_SUFFIX
1282                 fi
1283         done
1284
1285         #Errors in image setting - exit
1286         if [ $IMAGE_ERR -ne 0 ]; then
1287                 exit 1
1288         fi
1289
1290         #Print a tables of the image settings
1291         echo -e $BOLD"Images configured for start arg: "$START_ARG $EBOLD
1292         column -t -s $'\t' $image_list_file | indent1
1293
1294         echo ""
1295
1296         #Set the SIM_GROUP var
1297         echo -e $BOLD"Setting var to main dir of all container/simulator scripts"$EBOLD
1298         if [ -z "$SIM_GROUP" ]; then
1299                 SIM_GROUP=$AUTOTEST_HOME/../simulator-group
1300                 if [ ! -d  $SIM_GROUP ]; then
1301                         echo "Trying to set env var SIM_GROUP to dir 'simulator-group' in the nontrtric repo, but failed."
1302                         echo -e $RED"Please set the SIM_GROUP manually in the applicable $TEST_ENV_VAR_FILE"$ERED
1303                         exit 1
1304                 else
1305                         echo " SIM_GROUP auto set to: " $SIM_GROUP
1306                 fi
1307         elif [ $SIM_GROUP = *simulator_group ]; then
1308                 echo -e $RED"Env var SIM_GROUP does not seem to point to dir 'simulator-group' in the repo, check $TEST_ENV_VAR_FILE"$ERED
1309                 exit 1
1310         else
1311                 echo " SIM_GROUP env var already set to: " $SIM_GROUP
1312         fi
1313
1314         echo ""
1315
1316         #Temp var to check for image pull errors
1317         IMAGE_ERR=0
1318
1319         # The following sequence pull the configured images
1320
1321
1322         echo -e $BOLD"Pulling configured images, if needed"$EBOLD
1323         if [ ! -z "$IMAGE_REPO_ADR" ] && [ $IMAGE_REPO_POLICY == "local" ]; then
1324                 echo -e $YELLOW" Excluding all remote image check/pull when running with image repo: $IMAGE_REPO_ADR and image policy $IMAGE_REPO_POLICY"$EYELLOW
1325         else
1326                 for imagename in $APP_SHORT_NAMES; do
1327                         __check_included_image $imagename
1328                         incl=$?
1329                         __check_project_image $imagename
1330                         proj=$?
1331                         if [ $incl -eq 0 ]; then
1332                                 if [ $proj -eq 0 ]; then
1333                                         START_ARG_MOD=$START_ARG
1334                                         __check_image_local_override $imagename
1335                                         if [ $? -eq 1 ]; then
1336                                                 START_ARG_MOD="local"
1337                                         fi
1338                                 else
1339                                         START_ARG_MOD=$START_ARG
1340                                 fi
1341                                 __check_image_local_build $imagename
1342                                 #No pull of images built locally
1343                                 if [ $? -ne 0 ]; then
1344                                         # A function name is created from the app short name
1345                                         # for example app short name 'HTTPPROXY' -> produce the function
1346                                         # name __HTTPPROXY_imagesetup
1347                                         # This function is called and is expected to exist in the imported
1348                                         # file for the httpproxy test functions
1349                                         # The resulting function impl will call '__check_and_pull_image' function
1350                                         # with appropriate parameters
1351                                         function_pointer="__"$imagename"_imagepull"
1352                                         $function_pointer $START_ARG_MOD $START_ARG
1353                                 fi
1354                         else
1355                                 echo -e $YELLOW" Excluding $imagename image from image check/pull"$EYELLOW
1356                         fi
1357                 done
1358         fi
1359
1360         #Errors in image setting - exit
1361         if [ $IMAGE_ERR -ne 0 ]; then
1362                 echo ""
1363                 echo "#################################################################################################"
1364                 echo -e $RED"One or more images could not be pulled or containers using the images could not be stopped/removed"$ERED
1365                 echo -e $RED"Or local image, overriding remote image, does not exist"$ERED
1366                 if [ $IMAGE_CATEGORY == "DEV" ]; then
1367                     echo ""
1368                         echo -e $RED"Note that SNAPSHOT and staging images may be purged from nexus after a certain period."$ERED
1369                         echo -e $RED"In addition, the image may not have been updated in the current release so no SNAPSHOT or staging image exists"$ERED
1370                         echo -e $RED"In these cases, switch to use a released image instead, use the flag '--use-release-image <App-short-name>'"$ERED
1371                         echo -e $RED"Use the 'App-short-name' for the applicable image from the above table: 'Images configured for start arg'."$ERED
1372                 fi
1373                 echo "#################################################################################################"
1374                 echo ""
1375                 exit 1
1376         fi
1377
1378         echo ""
1379
1380         echo -e $BOLD"Building images needed for test"$EBOLD
1381
1382         for imagename in $APP_SHORT_NAMES; do
1383                 cd $AUTOTEST_HOME #Always reset to orig dir
1384                 __check_image_local_build $imagename
1385                 if [ $? -eq 0 ]; then
1386                         __check_included_image $imagename
1387                         if [ $? -eq 0 ]; then
1388                                 # A function name is created from the app short name
1389                                 # for example app short name 'MR' -> produce the function
1390                                 # name __MR_imagebuild
1391                                 # This function is called and is expected to exist in the imported
1392                                 # file for the mr test functions
1393                                 # The resulting function impl shall build the imagee
1394                                 function_pointer="__"$imagename"_imagebuild"
1395                                 $function_pointer
1396
1397                         else
1398                                 echo -e $YELLOW" Excluding image for app $imagename from image build"$EYELLOW
1399                         fi
1400                 fi
1401         done
1402
1403         cd $AUTOTEST_HOME # Just to make sure...
1404
1405         echo ""
1406
1407         # Create a table of the images used in the script - from local repo
1408         echo -e $BOLD"Local docker registry images used in this test script"$EBOLD
1409
1410         docker_tmp_file=./tmp/.docker-images-table
1411         format_string="{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\\t{{.CreatedAt}}"
1412         echo -e "Application\tRepository\tTag\tCreated since\tSize\tCreated at" > $docker_tmp_file
1413
1414         for imagename in $APP_SHORT_NAMES; do
1415                 __check_included_image $imagename
1416                 if [ $? -eq 0 ]; then
1417                         # Only print image data if image repo is null, or if image repo is set and image is local
1418                         print_image_data=0
1419                         if [ -z "$IMAGE_REPO_ADR" ]; then
1420                                 print_image_data=1
1421                         else
1422                                 __check_image_local_build $imagename
1423                                 if [ $? -eq 0 ]; then
1424                                         print_image_data=1
1425                                 fi
1426                         fi
1427                         if [ $print_image_data -eq 1 ]; then
1428                                 # A function name is created from the app short name
1429                                 # for example app short name 'MR' -> produce the function
1430                                 # name __MR_imagebuild
1431                                 # This function is called and is expected to exist in the imported
1432                                 # file for the mr test functions
1433                                 # The resulting function impl shall build the imagee
1434                                 function_pointer="__"$imagename"_image_data"
1435                                 $function_pointer "$format_string" $docker_tmp_file
1436                         fi
1437                 fi
1438         done
1439
1440         column -t -s $'\t' $docker_tmp_file | indent1
1441
1442         echo ""
1443
1444         if [ ! -z "$IMAGE_REPO_ADR" ]; then
1445
1446                 # Create a table of the images used in the script - from remote repo
1447                 echo -e $BOLD"Remote repo images used in this test script"$EBOLD
1448                 echo -e $YELLOW"-- Note: These image will be pulled when the container starts. Images not managed by the test engine --"$EYELLOW
1449
1450                 docker_tmp_file=./tmp/.docker-images-table
1451                 format_string="{{.Repository}}\\t{{.Tag}}"
1452                 echo -e "Application\tRepository\tTag" > $docker_tmp_file
1453
1454                 for imagename in $APP_SHORT_NAMES; do
1455                         __check_included_image $imagename
1456                         if [ $? -eq 0 ]; then
1457                                 # Only print image data if image repo is null, or if image repo is set and image is local
1458                                 __check_image_local_build $imagename
1459                                 if [ $? -ne 0 ]; then
1460                                         # A function name is created from the app short name
1461                                         # for example app short name 'MR' -> produce the function
1462                                         # name __MR_imagebuild
1463                                         # This function is called and is expected to exist in the imported
1464                                         # file for the mr test functions
1465                                         # The resulting function impl shall build the imagee
1466                                         function_pointer="__"$imagename"_image_data"
1467                                         $function_pointer "$format_string" $docker_tmp_file
1468                                 fi
1469                         fi
1470                 done
1471
1472                 column -t -s $'\t' $docker_tmp_file | indent1
1473
1474                 echo ""
1475         fi
1476
1477         if [ $RUNMODE == "KUBE" ]; then
1478
1479                 echo "================================================================================="
1480                 echo "================================================================================="
1481
1482                 if [ -z "$IMAGE_REPO_ADR" ]; then
1483                         echo -e $YELLOW" The image pull policy is set to 'Never' - assuming a local image repo is available for all images"$EYELLOW
1484                         echo -e " This setting only works on single node clusters on the local machine"
1485                         echo -e " It does not work with multi-node clusters or remote clusters. "
1486                         export KUBE_IMAGE_PULL_POLICY="Never"
1487                 else
1488                         echo -e $YELLOW" The image pull policy is set to 'Always'"$EYELLOW
1489                         echo -e " This setting work on local clusters, multi-node clusters and remote cluster. "
1490                         echo -e " Only locally built images are managed. Remote images are always pulled from remote repos"
1491                         echo -e " Pulling remote snapshot or staging images my in some case result in pulling newer image versions outside the control of the test engine"
1492                         export KUBE_IMAGE_PULL_POLICY="Always"
1493                 fi
1494                 CLUSTER_IP=$(kubectl config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
1495                 echo -e $YELLOW" The cluster hostname/ip is: $CLUSTER_IP"$EYELLOW
1496
1497                 echo "================================================================================="
1498                 echo "================================================================================="
1499                 echo ""
1500         fi
1501
1502         echo -e $BOLD"======================================================="$EBOLD
1503         echo -e $BOLD"== Common test setup completed -  test script begins =="$EBOLD
1504         echo -e $BOLD"======================================================="$EBOLD
1505         echo ""
1506
1507         LOG_STAT_ARGS=""
1508
1509         for imagename in $APP_SHORT_NAMES; do
1510                 __check_included_image $imagename
1511                 retcode_i=$?
1512                 __check_prestarted_image $imagename
1513                 retcode_p=$?
1514                 if [ $retcode_i -eq 0 ] || [ $retcode_p -eq 0 ]; then
1515                         # A function name is created from the app short name
1516                         # for example app short name 'RICMSIM' -> produce the function
1517                         # name __RICSIM__initial_setup
1518                         # This function is called and is expected to exist in the imported
1519                         # file for the ricsim test functions
1520                         # The resulting function impl shall perform initial setup of port, host etc
1521
1522                         function_pointer="__"$imagename"_initial_setup"
1523                         $function_pointer
1524
1525                         function_pointer="__"$imagename"_statisics_setup"
1526                         LOG_STAT_ARGS=$LOG_STAT_ARGS" "$($function_pointer)
1527                 fi
1528         done
1529
1530         if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1531                 ../common/genstat.sh $RUNMODE $SECONDS $TESTLOGS/$ATC/stat_data.csv $LOG_STAT_ARGS &
1532         fi
1533
1534 }
1535
1536 # Function to print the test result, shall be the last cmd in a test script
1537 # args: -
1538 # (Function for test scripts)
1539 print_result() {
1540
1541         TCTEST_END=$SECONDS
1542         duration=$((TCTEST_END-TCTEST_START))
1543
1544         echo "-------------------------------------------------------------------------------------------------"
1545         echo "-------------------------------------     Test case: "$ATC
1546         echo "-------------------------------------     Ended:     "$(date)
1547         echo "-------------------------------------------------------------------------------------------------"
1548         echo "-- Description: "$TC_ONELINE_DESCR
1549         echo "-- Execution time: " $duration " seconds"
1550         echo "-- Used env file: "$TEST_ENV_VAR_FILE
1551         echo "-------------------------------------------------------------------------------------------------"
1552         echo "-------------------------------------     RESULTS"
1553         echo ""
1554
1555
1556         if [ $RES_DEVIATION -gt 0 ]; then
1557                 echo "Test case deviations"
1558                 echo "===================================="
1559                 cat $DEVIATION_FILE
1560         fi
1561         echo ""
1562         echo "Timer measurement in the test script"
1563         echo "===================================="
1564         column -t -s $'\t' $TIMER_MEASUREMENTS
1565         if [ $RES_PASS != $RES_TEST ]; then
1566                 echo -e $RED"Measurement may not be reliable when there are failed test - failures may cause long measurement values due to timeouts etc."$ERED
1567         fi
1568         echo ""
1569
1570         if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1571                 echo "Runtime statistics collected in file: "$TESTLOGS/$ATC/stat_data.csv
1572                 echo ""
1573         fi
1574
1575         total=$((RES_PASS+RES_FAIL))
1576         if [ $RES_TEST -eq 0 ]; then
1577                 echo -e "\033[1mNo tests seem to have been executed. Check the script....\033[0m"
1578                 echo -e "\033[31m\033[1m ___  ___ ___ ___ ___ _____   ___ _   ___ _   _   _ ___ ___ \033[0m"
1579                 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_   _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1580                 echo -e "\033[31m\033[1m\__ \ (__|   /| ||  _/ | |   | _/ _ \ | || |_| |_| |   / _| \033[0m"
1581                 echo -e "\033[31m\033[1m|___/\___|_|_\___|_|   |_|   |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1582         elif [ $total != $RES_TEST ]; then
1583                 echo -e "\033[1mTotal number of tests does not match the sum of passed and failed tests. Check the script....\033[0m"
1584                 echo -e "\033[31m\033[1m ___  ___ ___ ___ ___ _____   ___ _   ___ _   _   _ ___ ___ \033[0m"
1585                 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_   _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1586                 echo -e "\033[31m\033[1m\__ \ (__|   /| ||  _/ | |   | _/ _ \ | || |_| |_| |   / _| \033[0m"
1587                 echo -e "\033[31m\033[1m|___/\___|_|_\___|_|   |_|   |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1588         elif [ $RES_CONF_FAIL -ne 0 ]; then
1589                 echo -e "\033[1mOne or more configurations has failed. Check the script log....\033[0m"
1590                 echo -e "\033[31m\033[1m ___  ___ ___ ___ ___ _____   ___ _   ___ _   _   _ ___ ___ \033[0m"
1591                 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_   _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1592                 echo -e "\033[31m\033[1m\__ \ (__|   /| ||  _/ | |   | _/ _ \ | || |_| |_| |   / _| \033[0m"
1593                 echo -e "\033[31m\033[1m|___/\___|_|_\___|_|   |_|   |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1594         elif [ $RES_PASS = $RES_TEST ]; then
1595                 echo -e "All tests \033[32m\033[1mPASS\033[0m"
1596                 echo -e "\033[32m\033[1m  ___  _   ___ ___ \033[0m"
1597                 echo -e "\033[32m\033[1m | _ \/_\ / __/ __| \033[0m"
1598                 echo -e "\033[32m\033[1m |  _/ _ \\__ \__ \\ \033[0m"
1599                 echo -e "\033[32m\033[1m |_|/_/ \_\___/___/ \033[0m"
1600                 echo ""
1601
1602                 # Update test suite counter
1603                 if [ -f .tmp_tcsuite_pass_ctr ]; then
1604                         tmpval=$(< .tmp_tcsuite_pass_ctr)
1605                         ((tmpval++))
1606                         echo $tmpval > .tmp_tcsuite_pass_ctr
1607                 fi
1608                 if [ -f .tmp_tcsuite_pass ]; then
1609                         echo " - "$ATC " -- "$TC_ONELINE_DESCR"  Execution time: "$duration" seconds" >> .tmp_tcsuite_pass
1610                 fi
1611                 #Create file with OK exit code
1612                 echo "0" > "$AUTOTEST_HOME/.result$ATC.txt"
1613         else
1614                 echo -e "One or more tests with status  \033[31m\033[1mFAIL\033[0m "
1615                 echo -e "\033[31m\033[1m  ___ _   ___ _    \033[0m"
1616                 echo -e "\033[31m\033[1m | __/_\ |_ _| |   \033[0m"
1617                 echo -e "\033[31m\033[1m | _/ _ \ | || |__ \033[0m"
1618                 echo -e "\033[31m\033[1m |_/_/ \_\___|____|\033[0m"
1619                 echo ""
1620                 # Update test suite counter
1621                 if [ -f .tmp_tcsuite_fail_ctr ]; then
1622                         tmpval=$(< .tmp_tcsuite_fail_ctr)
1623                         ((tmpval++))
1624                         echo $tmpval > .tmp_tcsuite_fail_ctr
1625                 fi
1626                 if [ -f .tmp_tcsuite_fail ]; then
1627                         echo " - "$ATC " -- "$TC_ONELINE_DESCR"  Execution time: "$duration" seconds" >> .tmp_tcsuite_fail
1628                 fi
1629         fi
1630
1631         echo "++++ Number of tests:          "$RES_TEST
1632         echo "++++ Number of passed tests:   "$RES_PASS
1633         echo "++++ Number of failed tests:   "$RES_FAIL
1634         echo ""
1635         echo "++++ Number of failed configs: "$RES_CONF_FAIL
1636         echo ""
1637         echo "++++ Number of test case deviations: "$RES_DEVIATION
1638         echo ""
1639         echo "-------------------------------------     Test case complete    ---------------------------------"
1640         echo "-------------------------------------------------------------------------------------------------"
1641         echo ""
1642 }
1643
1644 #####################################################################
1645 ###### Functions for start, configuring, stoping, cleaning etc ######
1646 #####################################################################
1647
1648 # Start timer for time measurement
1649 # args:  <timer message to print>  -  timer value and message will be printed both on screen
1650 #                                     and in the timer measurement report - if at least one "print_timer is called"
1651 start_timer() {
1652         echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
1653         TC_TIMER_STARTTIME=$SECONDS
1654         TC_TIMER_TIMER_TEXT="${@:1}"
1655         if [ $# -ne 1 ]; then
1656                 __print_err "need 1 arg,  <timer message to print>" $@
1657                 TC_TIMER_TIMER_TEXT=${FUNCNAME[0]}":"${BASH_LINENO[0]}
1658                 echo " Assigning timer name: "$TC_TIMER_TIMER_TEXT
1659         fi
1660         TC_TIMER_CURRENT_FAILS=$(($RES_FAIL+$RES_CONF_FAIL))
1661         echo " Timer started: $(date)"
1662 }
1663
1664 # Print the running timer  the value of the time (in seconds)
1665 # Timer value and message will be printed both on screen and in the timer measurement report
1666 print_timer() {
1667         echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $TC_TIMER_TIMER_TEXT $EBOLD
1668         if [ -z  "$TC_TIMER_STARTTIME" ]; then
1669                 __print_err "timer not started" $@
1670                 return 1
1671         fi
1672         duration=$(($SECONDS-$TC_TIMER_STARTTIME))
1673         if [ $duration -eq 0 ]; then
1674                 duration="<1 second"
1675         else
1676                 duration=$duration" seconds"
1677         fi
1678         echo " Timer duration :" $duration
1679         res="-"
1680         if [ $(($RES_FAIL+$RES_CONF_FAIL)) -ne $TC_TIMER_CURRENT_FAILS ]; then
1681                 res="Failures occured during test - timer not reliabled"
1682         fi
1683
1684         echo -e "$TC_TIMER_TIMER_TEXT \t $duration \t $res" >> $TIMER_MEASUREMENTS
1685 }
1686
1687 # Print info about a deviations from intended tests
1688 # Each deviation counted is also printed in the testreport
1689 # args <deviation message to print>
1690 deviation() {
1691         echo -e $BOLD"DEVIATION(${BASH_LINENO[0]}): "${FUNCNAME[0]} $EBOLD
1692         if [ $# -lt 1 ]; then
1693                 ((RES_CONF_FAIL++))
1694                 __print_err "need 1 or more args,  <deviation message to print>" $@
1695                 exit 1
1696         fi
1697         ((RES_DEVIATION++))
1698         echo -e $BOLD$YELLOW" Test case deviation: ${@:1}"$EYELLOW$EBOLD
1699         echo "Line: ${BASH_LINENO[0]} - ${@:1}" >> $DEVIATION_FILE
1700         __print_current_stats
1701         echo ""
1702 }
1703
1704 # Stop at first FAIL test case and take all logs - only for debugging/trouble shooting
1705 __check_stop_at_error() {
1706         if [ $STOP_AT_ERROR -eq 1 ]; then
1707                 echo -e $RED"Test script configured to stop at first FAIL, taking all logs and stops"$ERED
1708                 store_logs "STOP_AT_ERROR"
1709                 exit 1
1710         fi
1711         return 0
1712 }
1713
1714 # Stop and remove all containers
1715 # args: -
1716 # (Not for test scripts)
1717 __clean_containers() {
1718
1719         echo -e $BOLD"Docker clean and stopping and removing all running containers, by container name"$EBOLD
1720
1721         #Create empty file
1722         running_contr_file="./tmp/running_contr.txt"
1723         > $running_contr_file
1724
1725         # Get list of all containers started by the test script
1726         for imagename in $APP_SHORT_NAMES; do
1727                 docker ps -a --filter "label=nrttest_app=$imagename"  --filter "network=$DOCKER_SIM_NWNAME" --format ' {{.Label "nrttest_dp"}}\n{{.Label "nrttest_app"}}\n{{.Names}}' >> $running_contr_file
1728         done
1729         running_contr_file_empty="No docker containers running, started by previous test execution"
1730         if [ -s $running_contr_file ]; then
1731                 running_contr_file_empty=""
1732         fi
1733
1734         # Kill all containers started by the test env - to speed up shut down
1735     docker kill $(docker ps -a  --filter "label=nrttest_app" --format '{{.Names}}') &> /dev/null
1736
1737         tab_heading1="App display name"
1738         tab_heading2="App short name"
1739         tab_heading3="Container name"
1740
1741         tab_heading1_len=${#tab_heading1}
1742         tab_heading2_len=${#tab_heading2}
1743         tab_heading3_len=${#tab_heading3}
1744         cntr=0
1745         #Calc field lengths of each item in the list of containers
1746         while read p; do
1747                 if (( $cntr % 3 == 0 ));then
1748                         if [ ${#p} -gt $tab_heading1_len ]; then
1749                                 tab_heading1_len=${#p}
1750                         fi
1751                 fi
1752                 if (( $cntr % 3 == 1));then
1753                         if [ ${#p} -gt $tab_heading2_len ]; then
1754                                 tab_heading2_len=${#p}
1755                         fi
1756                 fi
1757                 if (( $cntr % 3 == 2));then
1758                         if [ ${#p} -gt $tab_heading3_len ]; then
1759                                 tab_heading3_len=${#p}
1760                         fi
1761                 fi
1762                 let cntr=cntr+1
1763         done <$running_contr_file
1764
1765         let tab_heading1_len=tab_heading1_len+2
1766         while (( ${#tab_heading1} < $tab_heading1_len)); do
1767                 tab_heading1="$tab_heading1"" "
1768         done
1769
1770         let tab_heading2_len=tab_heading2_len+2
1771         while (( ${#tab_heading2} < $tab_heading2_len)); do
1772                 tab_heading2="$tab_heading2"" "
1773         done
1774
1775         let tab_heading3_len=tab_heading3_len+2
1776         while (( ${#tab_heading3} < $tab_heading3_len)); do
1777                 tab_heading3="$tab_heading3"" "
1778         done
1779
1780         if [ ! -z "$running_contr_file_empty" ]; then
1781                 echo $running_contr_file_empty | indent1
1782         else
1783                 echo " $tab_heading1$tab_heading2$tab_heading3"" Actions"
1784                 cntr=0
1785                 while read p; do
1786                         if (( $cntr % 3 == 0 ));then
1787                                 row=""
1788                                 heading=$p
1789                                 heading_len=$tab_heading1_len
1790                         fi
1791                         if (( $cntr % 3 == 1));then
1792                                 heading=$p
1793                                 heading_len=$tab_heading2_len
1794                         fi
1795                         if (( $cntr % 3 == 2));then
1796                                 contr=$p
1797                                 heading=$p
1798                                 heading_len=$tab_heading3_len
1799                         fi
1800                         while (( ${#heading} < $heading_len)); do
1801                                 heading="$heading"" "
1802                         done
1803                         row=$row$heading
1804                         if (( $cntr % 3 == 2));then
1805                                 echo -ne $row$SAMELINE
1806                                 echo -ne " $row ${GREEN}stopping...${EGREEN}${SAMELINE}"
1807                                 docker stop $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
1808                                 echo -ne " $row ${GREEN}stopped removing...${EGREEN}${SAMELINE}"
1809                                 docker rm --force $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
1810                                 echo -e  " $row ${GREEN}stopped removed     ${EGREEN}"
1811                         fi
1812                         let cntr=cntr+1
1813                 done <$running_contr_file
1814         fi
1815
1816         echo ""
1817
1818         echo -e $BOLD" Removing docker network"$EBOLD
1819         TMP=$(docker network ls -q --filter name=$DOCKER_SIM_NWNAME)
1820         if [ "$TMP" ==  $DOCKER_SIM_NWNAME ]; then
1821                 docker network rm $DOCKER_SIM_NWNAME | indent2
1822                 if [ $? -ne 0 ];  then
1823                         echo -e $RED" Cannot remove docker network. Manually remove or disconnect containers from $DOCKER_SIM_NWNAME"$ERED
1824                         exit 1
1825                 fi
1826         fi
1827         echo -e "$GREEN  Done$EGREEN"
1828
1829         echo -e $BOLD" Removing all unused docker neworks"$EBOLD
1830         docker network prune --force | indent2
1831         echo -e "$GREEN  Done$EGREEN"
1832
1833         echo -e $BOLD" Removing all unused docker volumes"$EBOLD
1834         docker volume prune --force | indent2
1835         echo -e "$GREEN  Done$EGREEN"
1836
1837         echo -e $BOLD" Removing all dangling/untagged docker images"$EBOLD
1838     docker rmi --force $(docker images -q -f dangling=true) &> /dev/null
1839         echo -e "$GREEN  Done$EGREEN"
1840         echo ""
1841
1842         CONTRS=$(docker ps | awk '$1 != "CONTAINER" { n++ }; END { print n+0 }')
1843         if [ $? -eq 0 ]; then
1844                 if [ $CONTRS -ne 0 ]; then
1845                         echo -e $RED"Containers running, may cause distubance to the test case"$ERED
1846                         docker ps -a | indent1
1847                         echo ""
1848                 fi
1849         fi
1850 }
1851
1852 ###################################
1853 ### Functions for kube management
1854 ###################################
1855
1856 # Get resource type for scaling
1857 # args: <resource-name> <namespace>
1858 __kube_get_resource_type() {
1859         kubectl get deployment $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
1860         if [ $? -eq 0 ]; then
1861                 echo "deployment"
1862                 return 0
1863         fi
1864         kubectl get sts $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
1865         if [ $? -eq 0 ]; then
1866                 echo "sts"
1867                 return 0
1868         fi
1869         echo "unknown-resource-type"
1870         return 1
1871 }
1872
1873 # Scale a kube resource to a specific count
1874 # args: <resource-type> <resource-name> <namespace> <target-count>
1875 # (Not for test scripts)
1876 __kube_scale() {
1877         echo -ne "  Setting $1 $2 replicas=$4 in namespace $3"$SAMELINE
1878         kubectl scale  $1 $2  -n $3 --replicas=$4 1> /dev/null 2> ./tmp/kubeerr
1879         if [ $? -ne 0 ]; then
1880                 echo -e "  Setting $1 $2 replicas=$4 in namespace $3 $RED Failed $ERED"
1881                 ((RES_CONF_FAIL++))
1882                 echo "  Message: $(<./tmp/kubeerr)"
1883                 return 1
1884         else
1885                 echo -e "  Setting $1 $2 replicas=$4 in namespace $3 $GREEN OK $EGREEN"
1886         fi
1887
1888         TSTART=$SECONDS
1889
1890         for i in {1..500}; do
1891                 count=$(kubectl get $1/$2  -n $3 -o jsonpath='{.status.replicas}' 2> /dev/null)
1892                 retcode=$?
1893                 if [ -z "$count" ]; then
1894                         #No value is sometimes returned for some reason, in case the resource has replica 0
1895                         count=0
1896                 fi
1897                 if [ $retcode -ne 0 ]; then
1898                         echo -e "$RED  Cannot fetch current replica count for $1 $2 in namespace $3 $ERED"
1899                         ((RES_CONF_FAIL++))
1900                         return 1
1901                 fi
1902                 #echo ""
1903                 if [ $count -ne $4 ]; then
1904                         echo -ne "  Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds $SAMELINE"
1905                         sleep $i
1906                 else
1907                         echo -e "  Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds"
1908                         echo -e "  Replicas=$4 after $(($SECONDS-$TSTART)) seconds $GREEN OK $EGREEN"
1909                         echo ""
1910                         return 0
1911                 fi
1912         done
1913         echo ""
1914         echo -e "$RED  Replica count did not reach target replicas=$4. Failed with replicas=$count $ERED"
1915         ((RES_CONF_FAIL++))
1916         return 0
1917 }
1918
1919 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and label-id
1920 # This function does not wait for the resource to reach 0
1921 # args: <namespace> <label-name> <label-id>
1922 # (Not for test scripts)
1923 __kube_scale_all_resources() {
1924         namespace=$1
1925         labelname=$2
1926         labelid=$3
1927         resources="deployment replicaset statefulset"
1928         for restype in $resources; do
1929                 result=$(kubectl get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
1930                 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
1931                         for resid in $result; do
1932                                 echo -ne "  Ordered caling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"$SAMELINE
1933                                 kubectl scale  $restype $resid  -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
1934                                 echo -e "  Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0 $GREEN OK $EGREEN"
1935                         done
1936                 fi
1937         done
1938 }
1939
1940 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and an optional label-id
1941 # This function do wait for the resource to reach 0
1942 # args: <namespace> <label-name> [ <label-id> ]
1943 # (Not for test scripts)
1944 __kube_scale_and_wait_all_resources() {
1945         namespace=$1
1946         labelname=$2
1947         labelid=$3
1948         if [ -z "$3" ]; then
1949                 echo "  Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname"
1950         else
1951                 echo "  Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname=$labelid"
1952         fi
1953         resources="deployment replicaset statefulset"
1954         scaled_all=1
1955         while [ $scaled_all -ne 0 ]; do
1956                 scaled_all=0
1957                 for restype in $resources; do
1958                     if [ -z "$3" ]; then
1959                                 result=$(kubectl get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname')].metadata.name}')
1960                         else
1961                                 result=$(kubectl get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
1962                         fi
1963                         if [ $? -eq 0 ] && [ ! -z "$result" ]; then
1964                                 for resid in $result; do
1965                                         echo -e "   Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"
1966                                         kubectl scale  $restype $resid  -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
1967                                         count=1
1968                                         T_START=$SECONDS
1969                                         while [ $count -ne 0 ]; do
1970                                                 count=$(kubectl get $restype $resid  -n $namespace -o jsonpath='{.status.replicas}' 2> /dev/null)
1971                                                 echo -ne "    Scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count"$SAMELINE
1972                                                 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
1973                                                         sleep 0.5
1974                                                 else
1975                                                         count=0
1976                                                 fi
1977                                                 duration=$(($SECONDS-$T_START))
1978                                                 if [ $duration -gt 100 ]; then
1979                                                         #Forcring count 0, to avoid hanging for failed scaling
1980                                                         scaled_all=1
1981                                                         count=0
1982                                                 fi
1983                                         done
1984                                         echo -e "    Scaled $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
1985                                 done
1986                         fi
1987                 done
1988         done
1989 }
1990
1991 # Remove all kube resources in a namespace for resources having a certain label and label-id
1992 # This function wait until the resources are gone. Scaling to 0 must have been ordered previously
1993 # args: <namespace> <label-name> <label-id>
1994 # (Not for test scripts)
1995 __kube_delete_all_resources() {
1996         namespace=$1
1997         labelname=$2
1998         labelid=$3
1999         resources="deployments replicaset statefulset services pods configmaps persistentvolumeclaims persistentvolumes"
2000         deleted_resourcetypes=""
2001         for restype in $resources; do
2002                 ns_flag="-n $namespace"
2003                 ns_text="in namespace $namespace"
2004                 if [ $restype == "persistentvolumes" ]; then
2005                         ns_flag=""
2006                         ns_text=""
2007                 fi
2008                 result=$(kubectl get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2009                 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2010                         deleted_resourcetypes=$deleted_resourcetypes" "$restype
2011                         for resid in $result; do
2012                                 if [ $restype == "replicaset" ] || [ $restype == "statefulset" ]; then
2013                                         count=1
2014                                         while [ $count -ne 0 ]; do
2015                                                 count=$(kubectl get $restype $resid  $ns_flag -o jsonpath='{.status.replicas}' 2> /dev/null)
2016                                                 echo -ne "  Scaling $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count"$SAMELINE
2017                                                 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
2018                                                         sleep 0.5
2019                                                 else
2020                                                         count=0
2021                                                 fi
2022                                         done
2023                                         echo -e "  Scaled $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
2024                                 fi
2025                                 echo -ne "  Deleting $restype $resid $ns_text with label $labelname=$labelid "$SAMELINE
2026                                 kubectl delete --grace-period=1 $restype $resid $ns_flag 1> /dev/null 2> ./tmp/kubeerr
2027                                 if [ $? -eq 0 ]; then
2028                                         echo -e "  Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN OK $EGREEN"
2029                                 else
2030                                         echo -e "  Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN Does not exist - OK $EGREEN"
2031                                 fi
2032                                 #fi
2033                         done
2034                 fi
2035         done
2036         if [ ! -z "$deleted_resourcetypes" ]; then
2037                 for restype in $deleted_resources; do
2038                         ns_flag="-n $namespace"
2039                         ns_text="in namespace $namespace"
2040                         if [ $restype == "persistentvolumes" ]; then
2041                                 ns_flag=""
2042                                 ns_text=""
2043                         fi
2044                         echo -ne "  Waiting for $restype $ns_text with label $labelname=$labelid to be deleted..."$SAMELINE
2045                         T_START=$SECONDS
2046                         result="dummy"
2047                         while [ ! -z "$result" ]; do
2048                                 sleep 0.5
2049                                 result=$(kubectl get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2050                                 echo -ne "  Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds "$SAMELINE
2051                                 if [ -z "$result" ]; then
2052                                         echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $GREEN OK $EGREEN"
2053                                 elif [ $(($SECONDS-$T_START)) -gt 300 ]; then
2054                                         echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $RED Failed $ERED"
2055                                         result=""
2056                                 fi
2057                         done
2058                 done
2059         fi
2060 }
2061
2062 # Creates a namespace if it does not exists
2063 # args: <namespace>
2064 # (Not for test scripts)
2065 __kube_create_namespace() {
2066
2067         #Check if test namespace exists, if not create it
2068         kubectl get namespace $1 1> /dev/null 2> ./tmp/kubeerr
2069         if [ $? -ne 0 ]; then
2070                 echo -ne " Creating namespace "$1 $SAMELINE
2071                 kubectl create namespace $1 1> /dev/null 2> ./tmp/kubeerr
2072                 if [ $? -ne 0 ]; then
2073                         echo -e " Creating namespace $1 $RED$BOLD FAILED $EBOLD$ERED"
2074                         ((RES_CONF_FAIL++))
2075                         echo "  Message: $(<./tmp/kubeerr)"
2076                         return 1
2077                 else
2078                         echo -e " Creating namespace $1 $GREEN$BOLD OK $EBOLD$EGREEN"
2079                 fi
2080         else
2081                 echo -e " Creating namespace $1 $GREEN$BOLD Already exists, OK $EBOLD$EGREEN"
2082         fi
2083         return 0
2084 }
2085
2086 # Find the host ip of an app (using the service resource)
2087 # args: <app-name> <namespace>
2088 # (Not for test scripts)
2089 __kube_get_service_host() {
2090         if [ $# -ne 2 ]; then
2091                 ((RES_CONF_FAIL++))
2092         __print_err "need 2 args, <app-name> <namespace>" $@
2093                 exit 1
2094         fi
2095         for timeout in {1..60}; do
2096                 host=$(kubectl get svc $1  -n $2 -o jsonpath='{.spec.clusterIP}')
2097                 if [ $? -eq 0 ]; then
2098                         if [ ! -z "$host" ]; then
2099                                 echo $host
2100                                 return 0
2101                         fi
2102                 fi
2103                 sleep 0.5
2104         done
2105         ((RES_CONF_FAIL++))
2106         echo "host-not-found-fatal-error"
2107         return 1
2108 }
2109
2110 # Find the named port to an app (using the service resource)
2111 # args: <app-name> <namespace> <port-name>
2112 # (Not for test scripts)
2113 __kube_get_service_port() {
2114         if [ $# -ne 3 ]; then
2115                 ((RES_CONF_FAIL++))
2116         __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2117                 exit 1
2118         fi
2119
2120         for timeout in {1..60}; do
2121                 port=$(kubectl get svc $1  -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].port}')
2122                 if [ $? -eq 0 ]; then
2123                         if [ ! -z "$port" ]; then
2124                                 echo $port
2125                                 return 0
2126                         fi
2127                 fi
2128                 sleep 0.5
2129         done
2130         ((RES_CONF_FAIL++))
2131         echo "0"
2132         return 1
2133 }
2134
2135 # Find the named node port to an app (using the service resource)
2136 # args: <app-name> <namespace> <port-name>
2137 # (Not for test scripts)
2138 __kube_get_service_nodeport() {
2139         if [ $# -ne 3 ]; then
2140                 ((RES_CONF_FAIL++))
2141         __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2142                 exit 1
2143         fi
2144
2145         for timeout in {1..60}; do
2146                 port=$(kubectl get svc $1  -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].nodePort}')
2147                 if [ $? -eq 0 ]; then
2148                         if [ ! -z "$port" ]; then
2149                                 echo $port
2150                                 return 0
2151                         fi
2152                 fi
2153                 sleep 0.5
2154         done
2155         ((RES_CONF_FAIL++))
2156         echo "0"
2157         return 1
2158 }
2159
2160 # Create a kube resource from a yaml template
2161 # args: <resource-type> <resource-name> <template-yaml> <output-yaml>
2162 # (Not for test scripts)
2163 __kube_create_instance() {
2164         echo -ne " Creating $1 $2"$SAMELINE
2165         envsubst < $3 > $4
2166         kubectl apply -f $4 1> /dev/null 2> ./tmp/kubeerr
2167         if [ $? -ne 0 ]; then
2168                 ((RES_CONF_FAIL++))
2169                 echo -e " Creating $1 $2 $RED Failed $ERED"
2170                 echo "  Message: $(<./tmp/kubeerr)"
2171                 return 1
2172         else
2173                 echo -e " Creating $1 $2 $GREEN OK $EGREEN"
2174         fi
2175 }
2176
2177 # Function to create a configmap in kubernetes
2178 # args: <configmap-name> <namespace> <labelname> <labelid> <path-to-data-file> <path-to-output-yaml>
2179 # (Not for test scripts)
2180 __kube_create_configmap() {
2181         echo -ne " Creating configmap $1 "$SAMELINE
2182         envsubst < $5 > $5"_tmp"
2183         cp $5"_tmp" $5  #Need to copy back to orig file name since create configmap neeed the original file name
2184         kubectl create configmap $1  -n $2 --from-file=$5 --dry-run=client -o yaml > $6
2185         if [ $? -ne 0 ]; then
2186                 echo -e " Creating configmap $1 $RED Failed $ERED"
2187                 ((RES_CONF_FAIL++))
2188                 return 1
2189         fi
2190
2191         kubectl apply -f $6 1> /dev/null 2> ./tmp/kubeerr
2192         if [ $? -ne 0 ]; then
2193                 echo -e " Creating configmap $1 $RED Apply failed $ERED"
2194                 echo "  Message: $(<./tmp/kubeerr)"
2195                 ((RES_CONF_FAIL++))
2196                 return 1
2197         fi
2198         kubectl label configmap $1 -n $2 $3"="$4 --overwrite 1> /dev/null 2> ./tmp/kubeerr
2199         if [ $? -ne 0 ]; then
2200                 echo -e " Creating configmap $1 $RED Labeling failed $ERED"
2201                 echo "  Message: $(<./tmp/kubeerr)"
2202                 ((RES_CONF_FAIL++))
2203                 return 1
2204         fi
2205         # Log the resulting map
2206         kubectl get configmap $1 -n $2 -o yaml > $6
2207
2208         echo -e " Creating configmap $1 $GREEN OK $EGREEN"
2209         return 0
2210 }
2211
2212 # This function runs a kubectl cmd where a single output value is expected, for example get ip with jsonpath filter.
2213 # The function retries up to the timeout given in the cmd flag '--cluster-timeout'
2214 # args: <full kubectl cmd with parameters>
2215 # (Not for test scripts)
2216 __kube_cmd_with_timeout() {
2217         TS_TMP=$(($SECONDS+$CLUSTER_TIME_OUT))
2218
2219         while true; do
2220                 kube_cmd_result=$($@)
2221                 if [ $? -ne 0 ]; then
2222                         kube_cmd_result=""
2223                 fi
2224                 if [ $SECONDS -ge $TS_TMP ] || [ ! -z "$kube_cmd_result" ] ; then
2225                         echo $kube_cmd_result
2226                         return 0
2227                 fi
2228                 sleep 1
2229         done
2230 }
2231
2232 # This function starts a pod that cleans a the contents of a path mounted as a pvc
2233 # After this action the pod should terminate
2234 # This should only be executed when the pod owning the pvc is not running
2235 # args: <appname> <namespace> <pvc-name> <path-to remove>
2236 # (Not for test scripts)
2237 __kube_clean_pvc() {
2238
2239         #using env vars setup in pvccleaner_api_functions.sh
2240
2241         export PVC_CLEANER_NAMESPACE=$2
2242         export PVC_CLEANER_CLAIMNAME=$3
2243         export PVC_CLEANER_RM_PATH=$4
2244         input_yaml=$SIM_GROUP"/"$PVC_CLEANER_COMPOSE_DIR"/"pvc-cleaner.yaml
2245         output_yaml=$PWD/tmp/$2-pvc-cleaner.yaml
2246
2247         envsubst < $input_yaml > $output_yaml
2248
2249         kubectl delete -f $output_yaml 1> /dev/null 2> /dev/null   # Delete the previous terminated pod - if existing
2250
2251         __kube_create_instance pod $PVC_CLEANER_APP_NAME $input_yaml $output_yaml
2252         if [ $? -ne 0 ]; then
2253                 echo $YELLOW" Could not clean pvc for app: $1 - persistent storage not clean - tests may not work"
2254                 return 1
2255         fi
2256
2257         term_ts=$(($SECONDS+30))
2258         while [ $term_ts -gt $SECONDS ]; do
2259                 pod_status=$(kubectl get pod pvc-cleaner -n $PVC_CLEANER_NAMESPACE --no-headers -o custom-columns=":status.phase")
2260                 if [ "$pod_status" == "Succeeded" ]; then
2261                         return 0
2262                 fi
2263         done
2264         return 1
2265 }
2266
2267 # This function scales or deletes all resources for app selected by the testcase.
2268 # args: -
2269 # (Not for test scripts)
2270 __clean_kube() {
2271         echo -e $BOLD"Initialize kube pods/statefulsets/replicaset to initial state"$EBOLD
2272
2273         # Scale prestarted or managed apps
2274         for imagename in $APP_SHORT_NAMES; do
2275                 # A function name is created from the app short name
2276                 # for example app short name 'RICMSIM' -> produce the function
2277                 # name __RICSIM_kube_scale_zero or __RICSIM_kube_scale_zero_and_wait
2278                 # This function is called and is expected to exist in the imported
2279                 # file for the ricsim test functions
2280                 # The resulting function impl shall scale the resources to 0
2281                 # For prestarted apps, the function waits until the resources are 0
2282                 # For included (not prestated) apps, the scaling is just ordered
2283                 __check_prestarted_image $imagename
2284                 if [ $? -eq 0 ]; then
2285                         function_pointer="__"$imagename"_kube_scale_zero_and_wait"
2286                         echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2287                         $function_pointer
2288                 else
2289                         __check_included_image $imagename
2290                         if [ $? -eq 0 ]; then
2291                                 function_pointer="__"$imagename"_kube_scale_zero"
2292                                 echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2293                                 $function_pointer
2294                         fi
2295                 fi
2296         done
2297
2298         # Delete managed apps
2299         for imagename in $APP_SHORT_NAMES; do
2300                 __check_included_image $imagename
2301                 if [ $? -eq 0 ]; then
2302                         __check_prestarted_image $imagename
2303                         if [ $? -ne 0 ]; then
2304                                 # A function name is created from the app short name
2305                                 # for example app short name 'RICMSIM' -> produce the function
2306                                 # name __RICSIM__kube_delete_all
2307                                 # This function is called and is expected to exist in the imported
2308                                 # file for the ricsim test functions
2309                                 # The resulting function impl shall delete all its resources
2310                                 function_pointer="__"$imagename"_kube_delete_all"
2311                                 echo -e " Deleting all kube resources for app $BOLD $imagename $EBOLD"
2312                                 $function_pointer
2313                         fi
2314                 fi
2315         done
2316
2317         echo ""
2318 }
2319
2320 # Function stop and remove all containers (docker) and services/deployments etc(kube)
2321 # args: -
2322 # Function for test script
2323 clean_environment() {
2324         if [ $RUNMODE == "KUBE" ]; then
2325                 __clean_kube
2326                 if [ $PRE_CLEAN -eq 1 ]; then
2327                         echo " Cleaning docker resouces to free up resources, may take time..."
2328                         ../common/clean_docker.sh 2&>1 /dev/null
2329                         echo ""
2330                 fi
2331         else
2332                 __clean_containers
2333                 if [ $PRE_CLEAN -eq 1 ]; then
2334                         echo " Cleaning kubernetes resouces to free up resources, may take time..."
2335                         ../common/clean_kube.sh 2&>1 /dev/null
2336                         echo ""
2337                 fi
2338         fi
2339 }
2340
2341 # Function stop and remove all containers (docker) and services/deployments etc(kube) in the end of the test script, if the arg 'auto-clean' is given at test script start
2342 # args: -
2343 # (Function for test scripts)
2344 auto_clean_environment() {
2345         echo
2346         if [ "$AUTO_CLEAN" == "auto" ]; then
2347                 echo -e $BOLD"Initiating automatic cleaning of environment"$EBOLD
2348                 clean_environment
2349         fi
2350 }
2351
2352 # Function to sleep a test case for a numner of seconds. Prints the optional text args as info
2353 # args: <sleep-time-in-sec> [any-text-in-quotes-to-be-printed]
2354 # (Function for test scripts)
2355 sleep_wait() {
2356
2357         echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
2358         if [ $# -lt 1 ]; then
2359                 ((RES_CONF_FAIL++))
2360                 __print_err "need at least one arg, <sleep-time-in-sec> [any-text-to-printed]" $@
2361                 exit 1
2362         fi
2363         #echo "---- Sleep for " $1 " seconds ---- "$2
2364         start=$SECONDS
2365         duration=$((SECONDS-start))
2366         while [ $duration -lt $1 ]; do
2367                 echo -ne "  Slept for ${duration} seconds${SAMELINE}"
2368                 sleep 1
2369                 duration=$((SECONDS-start))
2370         done
2371         echo -ne "  Slept for ${duration} seconds${SAMELINE}"
2372         echo ""
2373 }
2374
2375 # Print error info for the call in the parent script (test case). Arg: <error-message-to-print>
2376 # Not to be called from the test script itself.
2377 __print_err() {
2378     echo -e $RED ${FUNCNAME[1]} " "$1" " ${BASH_SOURCE[2]} " line" ${BASH_LINENO[1]} $ERED
2379         if [ $# -gt 1 ]; then
2380                 echo -e $RED" Got: "${FUNCNAME[1]} ${@:2} $ERED
2381         fi
2382         ((RES_CONF_FAIL++))
2383 }
2384
2385 # Function to create the docker network for the test
2386 # Not to be called from the test script itself.
2387 __create_docker_network() {
2388         tmp=$(docker network ls --format={{.Name}} --filter name=$DOCKER_SIM_NWNAME)
2389         if [ $? -ne 0 ]; then
2390                 echo -e $RED" Could not check if docker network $DOCKER_SIM_NWNAME exists"$ERED
2391                 return 1
2392         fi
2393         if [ "$tmp" != $DOCKER_SIM_NWNAME ]; then
2394                 echo -e " Creating docker network:$BOLD $DOCKER_SIM_NWNAME $EBOLD"
2395                 docker network create $DOCKER_SIM_NWNAME | indent2
2396                 if [ $? -ne 0 ]; then
2397                         echo -e $RED" Could not create docker network $DOCKER_SIM_NWNAME"$ERED
2398                         return 1
2399                 else
2400                         echo -e "$GREEN  Done$EGREEN"
2401                 fi
2402         else
2403                 echo -e " Docker network $DOCKER_SIM_NWNAME already exists$GREEN OK $EGREEN"
2404         fi
2405 }
2406
2407 # Function to start container with docker-compose and wait until all are in state running.
2408 # If the <docker-compose-file> is empty, the default 'docker-compose.yml' is assumed.
2409 #args: <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+
2410 # (Not for test scripts)
2411 __start_container() {
2412
2413         if [ $# -lt 5 ]; then
2414                 ((RES_CONF_FAIL++))
2415         __print_err "need 5 or more args, <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+" $@
2416                 exit 1
2417         fi
2418
2419         __create_docker_network
2420
2421         curdir=$PWD
2422         cd $SIM_GROUP
2423         compose_dir=$1
2424         cd $1
2425         shift
2426         compose_file=$1
2427         if [ -z "$compose_file" ]; then
2428                 compose_file="docker-compose.yml"
2429         fi
2430         shift
2431         compose_args=$1
2432         shift
2433         appcount=$1
2434         shift
2435
2436         envsubst < $compose_file > "gen_"$compose_file
2437         compose_file="gen_"$compose_file
2438
2439         if [ "$compose_args" == "NODOCKERARGS" ]; then
2440                 docker-compose -f $compose_file up -d &> .dockererr
2441                 if [ $? -ne 0 ]; then
2442                         echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2443                         cat .dockererr
2444                         echo -e $RED"Stopping script...."$ERED
2445                         exit 1
2446                 fi
2447         else
2448                 docker-compose -f $compose_file up -d $compose_args &> .dockererr
2449                 if [ $? -ne 0 ]; then
2450                         echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2451                         cat .dockererr
2452                         echo -e $RED"Stopping script...."$ERED
2453                         exit 1
2454                 fi
2455         fi
2456
2457         cd $curdir
2458
2459         appindex=0
2460         while [ $appindex -lt $appcount ]; do
2461                 appname=$1
2462                 shift
2463                 app_started=0
2464                 for i in {1..10}; do
2465                         if [ "$(docker inspect --format '{{ .State.Running }}' $appname)" == "true" ]; then
2466                                         echo -e " Container $BOLD${appname}$EBOLD$GREEN running$EGREEN on$BOLD image $(docker inspect --format '{{ .Config.Image }}' ${appname}) $EBOLD"
2467                                         app_started=1
2468                                         break
2469                                 else
2470                                         sleep $i
2471                         fi
2472                 done
2473                 if [ $app_started -eq 0 ]; then
2474                         ((RES_CONF_FAIL++))
2475                         echo ""
2476                         echo -e $RED" Container $BOLD${appname}$EBOLD could not be started"$ERED
2477                         echo -e $RED" Stopping script..."$ERED
2478                         exit 1
2479                 fi
2480                 let appindex=appindex+1
2481         done
2482         return 0
2483 }
2484
2485 # Function to check if container/service is responding to http/https
2486 # args: <container-name>|<service-name> url
2487 # (Not for test scripts)
2488 __check_service_start() {
2489
2490         if [ $# -ne 2 ]; then
2491                 ((RES_CONF_FAIL++))
2492                 __print_err "need 2 args, <container-name>|<service-name> url" $@
2493                 return 1
2494         fi
2495
2496         if [ $RUNMODE == "KUBE" ]; then
2497                 ENTITY="service/set/deployment"
2498         else
2499                 ENTITY="container"
2500         fi
2501         appname=$1
2502         url=$2
2503         echo -ne " Container $BOLD${appname}$EBOLD starting${SAMELINE}"
2504
2505
2506         pa_st=false
2507         echo -ne " Waiting for ${ENTITY} ${appname} service status...${SAMELINE}"
2508         TSTART=$SECONDS
2509         loop_ctr=0
2510         while (( $TSTART+600 > $SECONDS )); do
2511                 result="$(__do_curl -m 10 $url)"
2512                 if [ $? -eq 0 ]; then
2513                         if [ ${#result} -gt 15 ]; then
2514                                 #If response is too long, truncate
2515                                 result="...response text too long, omitted"
2516                         fi
2517                         echo -ne " Waiting for {ENTITY} $BOLD${appname}$EBOLD service status on ${3}, result: $result${SAMELINE}"
2518                         echo -ne " The ${ENTITY} $BOLD${appname}$EBOLD$GREEN is alive$EGREEN, responds to service status:$GREEN $result $EGREEN on ${url} after $(($SECONDS-$TSTART)) seconds"
2519                         pa_st=true
2520                         break
2521                 else
2522                         TS_TMP=$SECONDS
2523                         TS_OFFSET=$loop_ctr
2524                         if (( $TS_OFFSET > 5 )); then
2525                                 TS_OFFSET=5
2526                         fi
2527                         while [ $(($TS_TMP+$TS_OFFSET)) -gt $SECONDS ]; do
2528                                 echo -ne " Waiting for ${ENTITY} ${appname} service status on ${url}...$(($SECONDS-$TSTART)) seconds, retrying in $(($TS_TMP+$TS_OFFSET-$SECONDS)) seconds   ${SAMELINE}"
2529                                 sleep 1
2530                         done
2531                 fi
2532                 let loop_ctr=loop_ctr+1
2533         done
2534
2535         if [ "$pa_st" = "false"  ]; then
2536                 ((RES_CONF_FAIL++))
2537                 echo -e $RED" The ${ENTITY} ${appname} did not respond to service status on ${url} in $(($SECONDS-$TSTART)) seconds"$ERED
2538                 return 1
2539         fi
2540
2541         echo ""
2542         return 0
2543 }
2544
2545
2546 #################
2547 ### Log functions
2548 #################
2549
2550 __check_container_logs() {
2551
2552         dispname=$1
2553         appname=$2
2554         logpath=$3
2555         warning=$4
2556         error=$5
2557
2558         echo -e $BOLD"Checking $dispname container $appname log ($logpath) for WARNINGs and ERRORs"$EBOLD
2559
2560         if [ $RUNMODE == "KUBE" ]; then
2561                 echo -e $YELLOW" Internal log for $dispname not checked in kube"$EYELLOW
2562                 return
2563         fi
2564
2565         #tmp=$(docker ps | grep $appname)
2566         tmp=$(docker ps -q --filter name=$appname) #get the container id
2567         if [ -z "$tmp" ]; then  #Only check logs for running Policy Agent apps
2568                 echo " "$dispname" is not running, no check made"
2569                 return
2570         fi
2571         foundentries="$(docker exec -t $tmp grep $warning $logpath | wc -l)"
2572         if [ $? -ne  0 ];then
2573                 echo "  Problem to search $appname log $logpath"
2574         else
2575                 if [ $foundentries -eq 0 ]; then
2576                         echo "  No WARN entries found in $appname log $logpath"
2577                 else
2578                         echo -e "  Found \033[1m"$foundentries"\033[0m WARN entries in $appname log $logpath"
2579                 fi
2580         fi
2581         foundentries="$(docker exec -t $tmp grep $error $logpath | wc -l)"
2582         if [ $? -ne  0 ];then
2583                 echo "  Problem to search $appname log $logpath"
2584         else
2585                 if [ $foundentries -eq 0 ]; then
2586                         echo "  No ERR entries found in $appname log $logpath"
2587                 else
2588                         echo -e $RED"  Found \033[1m"$foundentries"\033[0m"$RED" ERR entries in $appname log $logpath"$ERED
2589                 fi
2590         fi
2591         echo ""
2592 }
2593
2594 # Store all container logs and other logs in the log dir for the script
2595 # Logs are stored with a prefix in case logs should be stored several times during a test
2596 # args: <logfile-prefix>
2597 # (Function for test scripts)
2598 store_logs() {
2599         if [ $# != 1 ]; then
2600                 ((RES_CONF_FAIL++))
2601         __print_err "need one arg, <file-prefix>" $@
2602                 exit 1
2603         fi
2604         echo -e $BOLD"Storing all docker/kube container logs and other test logs in $TESTLOGS/$ATC using prefix: "$1$EBOLD
2605
2606         docker stats --no-stream > $TESTLOGS/$ATC/$1_docker_stats.log 2>&1
2607
2608         docker ps -a  > $TESTLOGS/$ATC/$1_docker_ps.log 2>&1
2609
2610         cp .httplog_${ATC}.txt $TESTLOGS/$ATC/$1_httplog_${ATC}.txt 2>&1
2611
2612         if [ $RUNMODE == "DOCKER" ]; then
2613
2614                 # Store docker logs for all container
2615                 for imagename in $APP_SHORT_NAMES; do
2616                         __check_included_image $imagename
2617                         if [ $? -eq 0 ]; then
2618                                 # A function name is created from the app short name
2619                                 # for example app short name 'RICMSIM' -> produce the function
2620                                 # name __RICSIM__store_docker_logs
2621                                 # This function is called and is expected to exist in the imported
2622                                 # file for the ricsim test functions
2623                                 # The resulting function impl shall store the docker logs for each container
2624                                 function_pointer="__"$imagename"_store_docker_logs"
2625                                 $function_pointer "$TESTLOGS/$ATC/" $1
2626                         fi
2627                 done
2628         fi
2629         if [ $RUNMODE == "KUBE" ]; then
2630                 namespaces=$(kubectl  get namespaces -o jsonpath='{.items[?(@.metadata.name)].metadata.name}')
2631                 for nsid in $namespaces; do
2632                         pods=$(kubectl get pods -n $nsid -o jsonpath='{.items[?(@.metadata.labels.autotest)].metadata.name}')
2633                         for podid in $pods; do
2634                                 kubectl logs -n $nsid $podid > $TESTLOGS/$ATC/$1_${podid}.log
2635                         done
2636                 done
2637         fi
2638         echo ""
2639 }
2640
2641 ###############
2642 ## Generic curl
2643 ###############
2644 # Generic curl function, assumes all 200-codes are ok
2645 # args: <valid-curl-args-including full url>
2646 # returns: <returned response (without respose code)>  or "<no-response-from-server>" or "<not found, <http-code>>""
2647 # returns: The return code is 0 for ok and 1 for not ok
2648 __do_curl() {
2649         echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
2650         proxyflag=""
2651         if [ ! -z "$KUBE_PROXY_PATH" ]; then
2652                 if [ $KUBE_PROXY_HTTPX == "http" ]; then
2653                         proxyflag=" --proxy $KUBE_PROXY_PATH"
2654                 else
2655                         proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
2656                 fi
2657         fi
2658         curlString="curl -skw %{http_code} $proxyflag $@"
2659         echo " CMD: $curlString" >> $HTTPLOG
2660         res=$($curlString)
2661         retcode=$?
2662         echo " RESP: $res" >> $HTTPLOG
2663         echo " RETCODE: $retcode" >> $HTTPLOG
2664         if [ $retcode -ne 0 ]; then
2665                 echo "<no-response-from-server>"
2666                 return 1
2667         fi
2668         http_code="${res:${#res}-3}"
2669         if [ ${#res} -eq 3 ]; then
2670                 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
2671                         echo "<no-response-from-server>"
2672                         return 1
2673                 else
2674                         return 0
2675                 fi
2676         else
2677                 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
2678                         echo "<not found, resp:${http_code}>"
2679                         return 1
2680                 fi
2681                 if [ $# -eq 2 ]; then
2682                         echo "${res:0:${#res}-3}" | xargs
2683                 else
2684                         echo "${res:0:${#res}-3}"
2685                 fi
2686
2687                 return 0
2688         fi
2689 }
2690
2691 #######################################
2692 ### Basic helper function for test cases
2693 #######################################
2694
2695 # Test a simulator container variable value towards target value using an condition operator with an optional timeout.
2696 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value>  - This test is done
2697 # immediately and sets pass or fail depending on the result of comparing variable and target using the operator.
2698 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> <timeout>  - This test waits up to the timeout
2699 # before setting pass or fail depending on the result of comparing variable and target using the operator.
2700 # 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.
2701 # Not to be called from test script.
2702
2703 __var_test() {
2704         checkjsonarraycount=0
2705         TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
2706         if [ $# -eq 6 ]; then
2707                 if [[ $3 == "json:"* ]]; then
2708                         checkjsonarraycount=1
2709                 fi
2710
2711                 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds"$EBOLD
2712         echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds" >> $HTTPLOG
2713
2714                 ((RES_TEST++))
2715                 ((TEST_SEQUENCE_NR++))
2716                 start=$SECONDS
2717                 ctr=0
2718                 for (( ; ; )); do
2719                         if [ $checkjsonarraycount -eq 0 ]; then
2720                                 result="$(__do_curl $2$3)"
2721                                 retcode=$?
2722                                 result=${result//[[:blank:]]/} #Strip blanks
2723                         else
2724                                 path=${3:5}
2725                                 result="$(__do_curl $2$path)"
2726                                 retcode=$?
2727                                 echo "$result" > ./tmp/.tmp.curl.json
2728                                 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
2729                         fi
2730                         duration=$((SECONDS-start))
2731                         echo -ne " Result=${result} after ${duration} seconds${SAMELINE}"
2732                         let ctr=ctr+1
2733                         if [ $retcode -ne 0 ]; then
2734                                 if [ $duration -gt $6 ]; then
2735                                         ((RES_FAIL++))
2736                                         echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
2737                                         __print_current_stats
2738                                         __check_stop_at_error
2739                                         return
2740                                 fi
2741                         elif [ $4 = "=" ] && [ "$result" -eq $5 ]; then
2742                                 ((RES_PASS++))
2743                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2744                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2745                                 __print_current_stats
2746                                 return
2747                         elif [ $4 = ">" ] && [ "$result" -gt $5 ]; then
2748                                 ((RES_PASS++))
2749                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2750                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2751                                 __print_current_stats
2752                                 return
2753                         elif [ $4 = "<" ] && [ "$result" -lt $5 ]; then
2754                                 ((RES_PASS++))
2755                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2756                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2757                                 __print_current_stats
2758                                 return
2759                         elif [ $4 = "contain_str" ] && [[ $result =~ $5 ]]; then
2760                                 ((RES_PASS++))
2761                                 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
2762                                 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
2763                                 __print_current_stats
2764                                 return
2765                         else
2766                                 if [ $duration -gt $6 ]; then
2767                                         ((RES_FAIL++))
2768                                         echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
2769                                         __print_current_stats
2770                                         __check_stop_at_error
2771                                         return
2772                                 fi
2773                         fi
2774                         sleep 1
2775                 done
2776         elif [ $# -eq 5 ]; then
2777                 if [[ $3 == "json:"* ]]; then
2778                         checkjsonarraycount=1
2779                 fi
2780
2781                 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}"$EBOLD
2782                 echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}" >> $HTTPLOG
2783                 ((RES_TEST++))
2784                 ((TEST_SEQUENCE_NR++))
2785                 if [ $checkjsonarraycount -eq 0 ]; then
2786                         result="$(__do_curl $2$3)"
2787                         retcode=$?
2788                         result=${result//[[:blank:]]/} #Strip blanks
2789                 else
2790                         path=${3:5}
2791                         result="$(__do_curl $2$path)"
2792                         retcode=$?
2793                         echo "$result" > ./tmp/.tmp.curl.json
2794                         result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
2795                 fi
2796                 if [ $retcode -ne 0 ]; then
2797                         ((RES_FAIL++))
2798                         echo -e $RED" FAIL ${ERED}- ${3} ${4} ${5} not reached, result = ${result}"
2799                         __print_current_stats
2800                         __check_stop_at_error
2801                 elif [ $4 = "=" ] && [ "$result" -eq $5 ]; then
2802                         ((RES_PASS++))
2803                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2804                         __print_current_stats
2805                 elif [ $4 = ">" ] && [ "$result" -gt $5 ]; then
2806                         ((RES_PASS++))
2807                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2808                         __print_current_stats
2809                 elif [ $4 = "<" ] && [ "$result" -lt $5 ]; then
2810                         ((RES_PASS++))
2811                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2812                         __print_current_stats
2813                 elif [ $4 = "contain_str" ] && [[ $result =~ $5 ]]; then
2814                         ((RES_PASS++))
2815                         echo -e $GREEN" PASS${EGREEN} - Result=${result}"
2816                         __print_current_stats
2817                 else
2818                         ((RES_FAIL++))
2819                         echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached, result = ${result}"
2820                         __print_current_stats
2821                         __check_stop_at_error
2822                 fi
2823         else
2824                 echo "Wrong args to __var_test, needs five or six args: <simulator-name> <host> <variable-name> <condition-operator> <target-value> [ <timeout> ]"
2825                 echo "Got:" $@
2826                 exit 1
2827         fi
2828 }