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