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