3 # ============LICENSE_START===============================================
4 # Copyright (C) 2020-22023 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
10 # http://www.apache.org/licenses/LICENSE-2.0
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=================================================
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
23 . ../common/api_curl.sh
24 . ../common/testengine_config.sh
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>]"
36 if [ $# -eq 1 ] && [ "$1" == "help" ]; then
38 if [ ! -z "$TC_ONELINE_DESCR" ]; then
39 echo "Test script description:"
40 echo $TC_ONELINE_DESCR
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"
75 echo "List of app short names supported: "$APP_SHORT_NAMES
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)
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"
88 #Formatting for 'echo' cmd
93 GREEN="\033[32m\033[1m"
95 YELLOW="\033[33m\033[1m"
99 # Just resetting any previous echo formatting...
102 # default test environment variables
104 #Override env file, will be added on top of the above file
105 TEST_ENV_VAR_FILE_OVERRIDE=""
107 echo "Test case started as: ${BASH_SOURCE[$i+1]} "$@
109 # Var to hold 'auto' in case containers shall be stopped when test case ends
112 # Var to indicate pre clean, if flag --pre-clean is set the script will clean kube resouces when running docker and vice versa
115 # Var to hold the app names to use local images for
118 # Var to hold the app names to use remote snapshot images for
119 USE_SNAPSHOT_IMAGES=""
121 # Var to hold the app names to use remote staging images for
122 USE_STAGING_IMAGES=""
124 # Var to hold the app names to use remote release images for
125 USE_RELEASE_IMAGES=""
127 # Var to hold the app names to use external release images for
128 USE_EXTERNAL_IMAGES=""
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
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
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"
143 # Function to indent cmd output with one space
144 indent1() { sed 's/^/ /'; }
146 # Function to indent cmd output with two spaces
147 indent2() { sed 's/^/ /'; }
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
155 # Counter for test suites
156 if [ -f .tmp_tcsuite_ctr ]; then
157 tmpval=$(< .tmp_tcsuite_ctr)
159 echo $tmpval > .tmp_tcsuite_ctr
162 # Create the logs dir if not already created in the current dir
163 if [ ! -d "logs" ]; then
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
173 if [ $? -ne 0 ]; then
174 echo "Cannot create dir for temp files, $PWD/tmp"
181 if [ $? -ne 0 ]; then
182 echo "Cannot cd to $PWD/tmp"
187 TESTENV_TEMP_FILES=$PWD
189 if [ ! -d "prev" ]; then
191 if [ $? -ne 0 ]; then
192 echo "Cannot create dir for previous temp files, $PWD/prev"
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"
206 if [ $(pwd | xargs basename) == "tmp" ]; then #Check that current dir is tmp...for safety
208 rm -rf $TMPFILES # Remove all temp files
213 if [ $? -ne 0 ]; then
214 echo "Cannot cd to $curdir"
220 # Create a http message log for this testcase
221 HTTPLOG=$PWD"/.httplog_"$ATC".txt"
224 # Create a log dir for the test case
225 mkdir -p $TESTLOGS/$ATC
227 # Save create for current logs
228 mkdir -p $TESTLOGS/$ATC/previous
230 rm $TESTLOGS/$ATC/previous/*.log &> /dev/null
231 rm $TESTLOGS/$ATC/previous/*.txt &> /dev/null
232 rm $TESTLOGS/$ATC/previous/*.json &> /dev/null
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
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
243 #Create result file in the log dir
244 echo "1" > "$TESTLOGS/$ATC/.result$ATC.txt"
246 # Log all output from the test case to a TC log
247 TCLOG=$TESTLOGS/$ATC/TC.log
248 exec &> >(tee ${TCLOG})
250 echo $(date) > $TESTLOGS/$ATC/endpoint_tc_start.log
251 echo "$TC_ONELINE_DESCR" > $TESTLOGS/$ATC/endpoint_tc_slogan.log
252 echo "Test failed" > $TESTLOGS/$ATC/endpoint_tc_end.log # Will be overritten if test is ok
254 #Variables for counting tests as well as passed and failed tests
261 #Var to control if current stats shall be printed
262 PRINT_CURRENT_STATS=0
264 #Var to control if container/pod runtim statistics shall be collected
265 COLLECT_RUNTIME_STATS=0
266 COLLECT_RUNTIME_STATS_PID=0
268 #Var to control if endpoint statistics shall be collected
269 COLLECT_ENDPOINT_STATS=0
271 #Var to control if namespaces shall be delete before test setup
272 DELETE_KUBE_NAMESPACES=0
274 #Var to control if containers shall be delete before test setup
277 #Var to configure kubectl from a config file or context
280 #Localhost, may be set to another host/ip by cmd parameter
281 LOCALHOST_NAME="localhost"
283 #Reseting vars related to token/keys used by kubeproxy when istio is enabled
284 #The vars are populated if istio is used in the testcase
285 KUBE_PROXY_CURL_JWT=""
286 KUBE_PROXY_ISTIO_JWKS_KEYS=""
288 #Var pointing to dir mounted to each kubernetes node (master and workers)
289 #Persistent volumes using "hostpath" are allocated beneath the point.
290 #Typically it is a dir on local host mounted to each VM running the master and worker.
291 #So the intention is make this dir available so the PODs can be restarted on any
292 #node and still access the persistent data
293 #If not set from cmd line, the path is defaults to "/tmp"
294 HOST_PATH_BASE_DIR=""
296 #File to keep deviation messages
297 DEVIATION_FILE=".tmp_deviations"
298 rm $DEVIATION_FILE &> /dev/null
300 # Trap "command not found" and make the script fail
303 if [ $? -eq 127 ]; then
304 echo -e $RED"Function not found, setting script to FAIL"$ERED
306 __print_current_stats
311 # Trap to kill subprocess for stats collection (if running)
313 if [ $COLLECT_RUNTIME_STATS_PID -ne 0 ]; then
314 kill $COLLECT_RUNTIME_STATS_PID
322 # Function to log the start of a test case
324 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
325 echo -e $BOLD"TEST $TEST_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: ${FUNCNAME[1]}" $@ $EBOLD
326 echo "TEST $TEST_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: ${FUNCNAME[1]}" $@ >> $HTTPLOG
328 ((TEST_SEQUENCE_NR++))
331 # Function to print current statistics
332 __print_current_stats() {
333 if [ $PRINT_CURRENT_STATS -ne 0 ]; then
334 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"
338 # General function to log a failed test case
339 __log_test_fail_general() {
340 echo -e $RED" FAIL."$1 $ERED
342 __print_current_stats
343 __check_stop_at_error
346 # Function to log a test case failed due to incorrect response code
347 __log_test_fail_status_code() {
348 echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
350 __print_current_stats
351 __check_stop_at_error
354 # Function to log a test case failed due to incorrect response body
355 __log_test_fail_body() {
356 echo -e $RED" FAIL, returned body not correct"$ERED
358 __print_current_stats
359 __check_stop_at_error
362 # Function to log a test case that is not supported
363 __log_test_fail_not_supported() {
364 echo -e $RED" FAIL, function not supported"$ERED
366 __print_current_stats
367 __check_stop_at_error
370 # Function to log a test case that is not supported but will not fail
371 __log_test_info_not_supported() {
372 echo -e $YELLOW" INFO, function not supported"$YELLOW
373 __print_current_stats
376 # General function to log a passed test case
378 if [ $# -gt 0 ]; then
382 echo -e $GREEN" PASS"$EGREEN
383 __print_current_stats
386 #Counter for configurations
389 # Function to log the start of a configuration setup
391 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
392 echo -e $BOLD"CONF $CONF_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: "${FUNCNAME[1]} $@ $EBOLD
393 echo "CONF $CONF_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: "${FUNCNAME[1]} $@ >> $HTTPLOG
394 ((CONF_SEQUENCE_NR++))
397 # Function to log a failed configuration setup
398 __log_conf_fail_general() {
399 echo -e $RED" FAIL."$1 $ERED
401 __print_current_stats
402 __check_stop_at_error
405 # Function to log a failed configuration setup due to incorrect response code
406 __log_conf_fail_status_code() {
407 echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
409 __print_current_stats
410 __check_stop_at_error
413 # Function to log a failed configuration setup due to incorrect response body
414 __log_conf_fail_body() {
415 echo -e $RED" FAIL, returned body not correct"$ERED
417 __print_current_stats
418 __check_stop_at_error
421 # Function to log a configuration that is not supported
422 __log_conf_fail_not_supported() {
423 echo -e $RED" FAIL, function not supported"$ERED$@
425 __print_current_stats
426 __check_stop_at_error
429 # Function to log a passed configuration setup
431 if [ $# -gt 0 ]; then
434 echo -e $GREEN" OK"$EGREEN
435 __print_current_stats
438 # Function to collect stats on endpoints
439 # args: <app-id> <end-point-no> <http-operation> <end-point-url> <http-status> [<count>]
440 __collect_endpoint_stats() {
441 if [ $COLLECT_ENDPOINT_STATS -eq 0 ]; then
445 if [ $# -gt 5 ]; then
448 ENDPOINT_STAT_FILE=$TESTLOGS/$ATC/endpoint_$ATC_$1_$2".log"
451 if [ -f $ENDPOINT_STAT_FILE ]; then
452 ENDPOINT_VAL=$(< $ENDPOINT_STAT_FILE)
453 ENDPOINT_POS=$(echo $ENDPOINT_VAL | cut -f4 -d ' ' | cut -f1 -d '/')
454 ENDPOINT_NEG=$(echo $ENDPOINT_VAL | cut -f5 -d ' ' | cut -f1 -d '/')
457 if [ $5 -ge 200 ] && [ $5 -lt 300 ]; then
458 let ENDPOINT_POS=ENDPOINT_POS+$ENDPOINT_COUNT
460 let ENDPOINT_NEG=ENDPOINT_NEG+$ENDPOINT_COUNT
463 printf '%-2s %-10s %-45s %-16s %-16s' "#" "$3" "$4" "$ENDPOINT_POS/$ENDPOINT_POS" "$ENDPOINT_NEG/$ENDPOINT_NEG" > $ENDPOINT_STAT_FILE
466 # Function to collect stats on endpoints
467 # args: <app-id> <image-info>
468 __collect_endpoint_stats_image_info() {
469 if [ $COLLECT_ENDPOINT_STATS -eq 0 ]; then
472 ENDPOINT_STAT_FILE=$TESTLOGS/$ATC/imageinfo_$ATC_$1".log"
473 echo $A1PMS_IMAGE > $ENDPOINT_STAT_FILE
476 #Var for measuring execution time
477 TCTEST_START=$SECONDS
479 #Vars to hold the start time and timer text for a custom timer
480 TC_TIMER_STARTTIME=""
481 TC_TIMER_TIMER_TEXT=""
482 TC_TIMER_CURRENT_FAILS="" # Then numer of failed test when timer starts.
483 # Compared with the current number of fails at timer stop
484 # to judge the measurement reliability
486 #File to save timer measurement results
487 TIMER_MEASUREMENTS=".timer_measurement.txt"
488 echo -e "Activity \t Duration \t Info" > $TIMER_MEASUREMENTS
490 # If this is set, some images (controlled by the parameter repo-policy) will be re-tagged and pushed to this repo before any
492 IMAGE_REPO_POLICY="local"
495 echo "-------------------------------------------------------------------------------------------------"
496 echo "----------------------------------- Test case: "$ATC
497 echo "----------------------------------- Started: "$(date)
498 echo "-------------------------------------------------------------------------------------------------"
499 echo "-- Description: "$TC_ONELINE_DESCR
500 echo "-------------------------------------------------------------------------------------------------"
501 echo "----------------------------------- Test case setup -----------------------------------"
503 echo "Setting AUTOTEST_HOME="$AUTOTEST_HOME
507 if [ $# -lt 1 ]; then
510 if [ $paramerror -eq 0 ]; then
511 if [ "$1" != "remote" ] && [ "$1" != "remote-remove" ]; then
513 if [ -z "$paramerror_str" ]; then
514 paramerror_str="First arg shall be 'remote' or 'remote-remove'"
520 if [ $paramerror -eq 0 ]; then
521 if [ "$1" != "docker" ] && [ "$1" != "kube" ]; then
523 if [ -z "$paramerror_str" ]; then
524 paramerror_str="Second arg shall be 'docker' or 'kube'"
527 if [ $1 == "docker" ]; then
529 echo "Setting RUNMODE=DOCKER"
531 if [ $1 == "kube" ]; then
533 echo "Setting RUNMODE=KUBE"
539 while [ $paramerror -eq 0 ] && [ $foundparm -eq 0 ]; do
541 if [ $paramerror -eq 0 ]; then
542 if [ "$1" == "release" ]; then
543 IMAGE_CATEGORY="RELEASE"
544 echo "Option set - Release image tags used for applicable images "
549 if [ $paramerror -eq 0 ]; then
550 if [ "$1" == "auto-clean" ]; then
552 echo "Option set - Auto clean at end of test script"
557 if [ $paramerror -eq 0 ]; then
558 if [ "$1" == "--stop-at-error" ]; then
560 echo "Option set - Stop at first error"
565 if [ $paramerror -eq 0 ]; then
566 if [ "$1" == "--ricsim-prefix" ]; then
568 TMP_RIC_SIM_PREFIX=$1 #RIC_SIM_PREFIX need to be updated after sourcing of the env file
571 if [ -z "$paramerror_str" ]; then
572 paramerror_str="No prefix found for flag: '--ricsim-prefix'"
575 echo "Option set - Overriding RIC_SIM_PREFIX with: "$1
581 if [ $paramerror -eq 0 ]; then
582 if [ "$1" == "--env-file" ]; then
587 if [ -z "$paramerror_str" ]; then
588 paramerror_str="No env file found for flag: '--env-file'"
591 echo "Option set - Reading test env from: "$1
597 if [ $paramerror -eq 0 ]; then
598 if [ "$1" == "--use-local-image" ]; then
601 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
602 USE_LOCAL_IMAGES=$USE_LOCAL_IMAGES" "$1
603 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
605 if [ -z "$paramerror_str" ]; then
606 paramerror_str="App name $1 is not available for local override for flag: '--use-local-image'"
612 if [ -z "$USE_LOCAL_IMAGES" ]; then
614 if [ -z "$paramerror_str" ]; then
615 paramerror_str="No app name found for flag: '--use-local-image'"
618 echo "Option set - Overriding with local images for app(s):"$USE_LOCAL_IMAGES
622 if [ $paramerror -eq 0 ]; then
623 if [ "$1" == "--use-snapshot-image" ]; then
624 USE_SNAPSHOT_IMAGES=""
626 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
627 USE_SNAPSHOT_IMAGES=$USE_SNAPSHOT_IMAGES" "$1
628 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
630 if [ -z "$paramerror_str" ]; then
631 paramerror_str="App name $1 is not available for snapshot override for flag: '--use-snapshot-image'"
637 if [ -z "$USE_SNAPSHOT_IMAGES" ]; then
639 if [ -z "$paramerror_str" ]; then
640 paramerror_str="No app name found for flag: '--use-snapshot-image'"
643 echo "Option set - Overriding with snapshot images for app(s):"$USE_SNAPSHOT_IMAGES
647 if [ $paramerror -eq 0 ]; then
648 if [ "$1" == "--use-staging-image" ]; then
649 USE_STAGING_IMAGES=""
651 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
652 USE_STAGING_IMAGES=$USE_STAGING_IMAGES" "$1
653 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
655 if [ -z "$paramerror_str" ]; then
656 paramerror_str="App name $1 is not available for staging override for flag: '--use-staging-image'"
662 if [ -z "$USE_STAGING_IMAGES" ]; then
664 if [ -z "$paramerror_str" ]; then
665 paramerror_str="No app name found for flag: '--use-staging-image'"
668 echo "Option set - Overriding with staging images for app(s):"$USE_STAGING_IMAGES
672 if [ $paramerror -eq 0 ]; then
673 if [ "$1" == "--use-release-image" ]; then
674 USE_RELEASE_IMAGES=""
676 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
677 USE_RELEASE_IMAGES=$USE_RELEASE_IMAGES" "$1
678 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
680 if [ -z "$paramerror_str" ]; then
681 paramerror_str="App name $1 is not available for release override for flag: '--use-release-image'"
687 if [ -z "$USE_RELEASE_IMAGES" ]; then
689 if [ -z "$paramerror_str" ]; then
690 paramerror_str="No app name found for flag: '--use-release-image'"
693 echo "Option set - Overriding with release images for app(s):"$USE_RELEASE_IMAGES
697 if [ $paramerror -eq 0 ]; then
698 if [ "$1" == "--use-external-image" ]; then
699 USE_EXTERNAL_IMAGES=""
701 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
702 USE_EXTERNAL_IMAGES=$USE_EXTERNAL_IMAGES" "$1
703 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
705 if [ -z "$paramerror_str" ]; then
706 paramerror_str="App name $1 is not available for release override for flag: '--use-external-image'"
712 if [ -z "$USE_EXTERNAL_IMAGES" ]; then
714 if [ -z "$paramerror_str" ]; then
715 paramerror_str="No app name found for flag: '--use-use-external-image'"
718 echo "Option set - Overriding with external images for app(s):"$USE_EXTERNAL_IMAGES
722 if [ $paramerror -eq 0 ]; then
723 if [ "$1" == "--image-repo" ]; then
728 if [ -z "$paramerror_str" ]; then
729 paramerror_str="No image repo url found for : '--image-repo'"
732 echo "Option set - Image repo url: "$1
738 if [ $paramerror -eq 0 ]; then
739 if [ "$1" == "--repo-policy" ]; then
744 if [ -z "$paramerror_str" ]; then
745 paramerror_str="No policy found for : '--repo-policy'"
748 if [ "$1" == "local" ] || [ "$1" == "remote" ]; then
749 echo "Option set - Image repo policy: "$1
754 if [ -z "$paramerror_str" ]; then
755 paramerror_str="Repo policy shall be 'local' or 'remote'"
761 if [ $paramerror -eq 0 ]; then
762 if [ "$1" == "--cluster-timeout" ]; then
767 if [ -z "$paramerror_str" ]; then
768 paramerror_str="No timeout value found for : '--cluster-timeout'"
771 #Check if positive int
772 case ${CLUSTER_TIME_OUT#[+]} in
775 if [ -z "$paramerror_str" ]; then
776 paramerror_str="Value for '--cluster-timeout' not an int : "$CLUSTER_TIME_OUT
781 echo "Option set - Cluster timeout: "$1
787 if [ $paramerror -eq 0 ]; then
788 if [ "$1" == "--override" ]; then
790 TEST_ENV_VAR_FILE_OVERRIDE=$1
793 if [ -z "$paramerror_str" ]; then
794 paramerror_str="No env file found for flag: '--override'"
797 if [ ! -f $TEST_ENV_VAR_FILE_OVERRIDE ]; then
799 if [ -z "$paramerror_str" ]; then
800 paramerror_str="File for '--override' does not exist : "$TEST_ENV_VAR_FILE_OVERRIDE
803 echo "Option set - Override env from: "$1
809 if [ $paramerror -eq 0 ]; then
810 if [ "$1" == "--pre-clean" ]; then
812 echo "Option set - Pre-clean of kube/docker resouces"
817 if [ $paramerror -eq 0 ]; then
818 if [ "$1" == "--print-stats" ]; then
819 PRINT_CURRENT_STATS=1
820 echo "Option set - Print stats after every test-case and config"
825 if [ $paramerror -eq 0 ]; then
826 if [ "$1" == "--gen-stats" ]; then
827 COLLECT_RUNTIME_STATS=1
828 echo "Option set - Collect runtime statistics"
833 if [ $paramerror -eq 0 ]; then
834 if [ "$1" == "--delete-namespaces" ]; then
835 if [ $RUNMODE == "DOCKER" ]; then
836 DELETE_KUBE_NAMESPACES=0
837 echo "Option ignored - Delete namespaces (ignored when running docker)"
839 if [ -z "KUBE_PRESTARTED_IMAGES" ]; then
840 DELETE_KUBE_NAMESPACES=0
841 echo "Option ignored - Delete namespaces (ignored when using prestarted apps)"
843 DELETE_KUBE_NAMESPACES=1
844 echo "Option set - Delete namespaces"
851 if [ $paramerror -eq 0 ]; then
852 if [ "$1" == "--delete-containers" ]; then
853 if [ $RUNMODE == "DOCKER" ]; then
855 echo "Option set - Delete containers started by previous test(s)"
857 echo "Option ignored - Delete containers (ignored when running kube)"
863 if [ $paramerror -eq 0 ]; then
864 if [ "$1" == "--endpoint-stats" ]; then
865 COLLECT_ENDPOINT_STATS=1
866 echo "Option set - Collect endpoint statistics"
871 if [ $paramerror -eq 0 ]; then
872 if [ "$1" == "--kubeconfig" ]; then
876 if [ -z "$paramerror_str" ]; then
877 paramerror_str="No path found for : '--kubeconfig'"
881 if [ ! -z "$KUBECONF" ]; then
883 if [ -z "$paramerror_str" ]; then
884 paramerror_str="Only one of --kubeconfig/--kubecontext can be set"
887 KUBECONF="--kubeconfig $1"
888 echo "Option set - Kubeconfig path: "$1
894 if [ -z "$paramerror_str" ]; then
895 paramerror_str="File $1 for --kubeconfig not found"
901 if [ $paramerror -eq 0 ]; then
902 if [ "$1" == "--kubecontext" ]; then
906 if [ -z "$paramerror_str" ]; then
907 paramerror_str="No context-name found for : '--kubecontext'"
910 if [ ! -z "$KUBECONF" ]; then
912 if [ -z "$paramerror_str" ]; then
913 paramerror_str="Only one of --kubeconfig or --kubecontext can be set"
916 KUBECONF="--context $1"
917 echo "Option set - Kubecontext name: "$1
924 if [ $paramerror -eq 0 ]; then
925 if [ "$1" == "--host-path-dir" ]; then
929 if [ -z "$paramerror_str" ]; then
930 paramerror_str="No path found for : '--host-path-dir'"
933 HOST_PATH_BASE_DIR=$1
934 echo "Option set - Host path for kube set to: "$1
940 if [ $paramerror -eq 0 ]; then
941 if [ "$1" == "--docker-host" ]; then
945 if [ -z "$paramerror_str" ]; then
946 paramerror_str="No url found for : '--docker-host'"
949 export DOCKER_HOST="$1"
950 echo "Option set - DOCKER_HOST set to: "$1
956 if [ $paramerror -eq 0 ]; then
957 if [ "$1" == "--docker-host" ]; then
961 if [ -z "$paramerror_str" ]; then
962 paramerror_str="No url found for : '--docker-host'"
965 export DOCKER_HOST="$1"
966 echo "Option set - DOCKER_HOST set to: "$1
972 if [ $paramerror -eq 0 ]; then
973 if [ "$1" == "--docker-proxy" ]; then
977 if [ -z "$paramerror_str" ]; then
978 paramerror_str="No ip/host found for : '--docker-proxy'"
981 export LOCALHOST_NAME=$1
982 echo "Option set - docker proxy set to: "$1
992 if [ $paramerror -eq 0 ] && [ $# -gt 0 ]; then
994 if [ -z "$paramerror_str" ]; then
995 paramerror_str="Unknown parameter(s): "$@
999 if [ $paramerror -eq 1 ]; then
1000 echo -e $RED"Incorrect arg list: "$paramerror_str$ERED
1005 LOCALHOST_HTTP="http://$LOCALHOST_NAME"
1006 LOCALHOST_HTTPS="https://$LOCALHOST_NAME"
1008 # sourcing the selected env variables for the test case
1009 if [ -f "$TEST_ENV_VAR_FILE" ]; then
1010 echo -e $BOLD"Sourcing env vars from: "$TEST_ENV_VAR_FILE$EBOLD
1011 . $TEST_ENV_VAR_FILE
1012 if [ ! -z "$TEST_ENV_VAR_FILE_OVERRIDE" ]; then
1013 echo -e $BOLD"Sourcing override env vars from: "$TEST_ENV_VAR_FILE_OVERRIDE$EBOLD
1014 . $TEST_ENV_VAR_FILE_OVERRIDE
1017 if [ -z "$TEST_ENV_PROFILE" ] || [ -z "$SUPPORTED_PROFILES" ]; then
1018 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
1021 for prof in $SUPPORTED_PROFILES; do
1022 if [ "$TEST_ENV_PROFILE" == "$prof" ]; then
1023 echo -e $GREEN"Test case supports the selected test env file"$EGREEN
1027 if [ $found_profile -ne 1 ]; then
1028 echo -e $RED"Test case does not support the selected test env file"$ERED
1029 echo "Profile: "$TEST_ENV_PROFILE" Supported profiles: "$SUPPORTED_PROFILES
1030 echo -e $RED"Exiting...."$ERED
1035 echo -e $RED"Selected env var file does not exist: "$TEST_ENV_VAR_FILE$ERED
1036 echo " Select one of following env var file matching the intended target of the test"
1037 echo " Restart the test using the flag '--env-file <path-to-env-file>"
1038 ls $AUTOTEST_HOME/../common/test_env* | indent1
1042 #This var need be preserved from the command line option, if set, when env var is sourced.
1043 if [ ! -z "$TMP_RIC_SIM_PREFIX" ]; then
1044 RIC_SIM_PREFIX=$TMP_RIC_SIM_PREFIX
1047 if [ -z "$PROJECT_IMAGES_APP_NAMES" ]; then
1048 echo -e $RED"Var PROJECT_IMAGES_APP_NAMES must be defined in: "$TEST_ENV_VAR_FILE $ERED
1052 if [[ $SUPPORTED_RUNMODES != *"$RUNMODE"* ]]; then
1053 echo -e $RED"This test script does not support RUNMODE $RUNMODE"$ERED
1054 echo "Supported RUNMODEs: "$SUPPORTED_RUNMODES
1058 # Choose list of included apps depending on run-mode
1059 if [ $RUNMODE == "KUBE" ]; then
1060 INCLUDED_IMAGES=$KUBE_INCLUDED_IMAGES
1062 INCLUDED_IMAGES=$DOCKER_INCLUDED_IMAGES
1066 # auto adding system apps
1068 echo -e $BOLD"Auto adding system apps"$EBOLD
1069 if [ $RUNMODE == "KUBE" ]; then
1070 INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_KUBE_SYSTEM_APPS
1071 TMP_APPS=$TESTENV_KUBE_SYSTEM_APPS
1073 INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_DOCKER_SYSTEM_APPS
1074 TMP_APPS=$TESTENV_DOCKER_SYSTEM_APPS
1076 if [ ! -z "$TMP_APPS" ]; then
1077 for iapp in "$TMP_APPS"; do
1078 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
1079 file_pointer="../common/"$file_pointer"_api_functions.sh"
1081 while [ ${#padded_iapp} -lt 16 ]; do
1082 padded_iapp=$padded_iapp" "
1084 echo " Auto-adding system app $padded_iapp Sourcing $file_pointer"
1086 if [ $? -ne 0 ]; then
1087 echo " Include file $file_pointer contain errors. Exiting..."
1090 __added_apps=" $iapp "$__added_apps
1096 if [ $RUNMODE == "KUBE" ]; then
1097 TMP_APPS=$INCLUDED_IMAGES" "$KUBE_PRESTARTED_IMAGES
1099 TMP_APPS=$INCLUDED_IMAGES
1102 echo -e $BOLD"Auto adding included apps"$EBOLD
1103 for iapp in $TMP_APPS; do
1104 if [[ "$__added_apps" != *"$iapp"* ]]; then
1105 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
1106 file_pointer="../common/"$file_pointer"_api_functions.sh"
1108 while [ ${#padded_iapp} -lt 16 ]; do
1109 padded_iapp=$padded_iapp" "
1111 echo " Auto-adding included app $padded_iapp Sourcing $file_pointer"
1112 if [ ! -f "$file_pointer" ]; then
1113 echo " Include file $file_pointer for app $iapp does not exist"
1117 if [ $? -ne 0 ]; then
1118 echo " Include file $file_pointer contain errors. Exiting..."
1125 echo -e $BOLD"Test environment info"$EBOLD
1127 # Check needed installed sw
1130 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1131 echo -e $RED"bash is required to run the test environment, pls install"$ERED
1134 echo " bash is installed and using version:"
1135 echo "$(bash --version)" | indent2
1137 tmp=$(which python3)
1138 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1139 echo -e $RED"python3 is required to run the test environment, pls install"$ERED
1142 echo " python3 is installed and using version: $(python3 --version)"
1145 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1146 echo -e $RED"docker is required to run the test environment, pls install"$ERED
1149 echo " docker is installed and using versions:"
1150 echo " $(docker version --format 'Client version {{.Client.Version}} Server version {{.Server.Version}}')"
1152 if [ $RUNMODE == "DOCKER" ]; then
1153 tmp=$(which docker-compose)
1154 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1155 echo -e $RED"docker-compose is required to run the test environment, pls install"$ERED
1158 tmp=$(docker-compose version)
1159 echo " docker-compose installed and using version $tmp"
1160 if [[ "$tmp" == *'v2'* ]]; then
1161 DOCKER_COMPOSE_VERSION="V2"
1165 if [ $RUNMODE == "KUBE" ]; then
1166 tmp=$(which kubectl)
1167 if [ $? -ne 0 ] || [ -z tmp ]; then
1168 echo -e $RED"kubectl is required to run the test environment in kubernetes mode, pls install"$ERED
1171 echo " kubectl is installed and using versions:"
1172 echo $(kubectl $KUBECONF version --short=true) | indent2
1173 res=$(kubectl $KUBECONF cluster-info 2>&1)
1174 if [ $? -ne 0 ]; then
1175 echo -e "$BOLD$RED############################################# $ERED$EBOLD"
1176 echo -e $BOLD$RED"Command 'kubectl '$KUBECONF' cluster-info' returned error $ERED$EBOLD"
1177 echo -e "$BOLD$RED############################################# $ERED$EBOLD"
1179 echo "kubectl response:"
1182 echo "This script may have been started with user with no permission to run kubectl"
1183 echo "Try running with 'sudo', set env KUBECONFIG or set '--kubeconfig' parameter"
1184 echo "Do either 1, 2 or 3 "
1187 echo "Run with sudo"
1188 echo -e $BOLD"sudo <test-script-and-parameters>"$EBOLD
1191 echo "Export KUBECONFIG and pass env to sudo - (replace user)"
1192 echo -e $BOLD"export KUBECONFIG='/home/<user>/.kube/config'"$EBOLD
1193 echo -e $BOLD"sudo -E <test-script-and-parameters>"$EBOLD
1196 echo "Set KUBECONFIG via script parameter"
1197 echo -e $BOLD"sudo ... --kubeconfig /home/<user>/.kube/<config-file> ...."$EBOLD
1198 echo "The config file need to downloaded from the cluster"
1202 echo " Node(s) and container runtime config"
1203 kubectl $KUBECONF get nodes -o wide | indent2
1205 if [ -z "$HOST_PATH_BASE_DIR" ]; then
1206 HOST_PATH_BASE_DIR="/tmp"
1207 echo " Persistent volumes will be mounted to $HOST_PATH_BASE_DIR on applicable node"
1208 echo " No guarantee that persistent volume data is available on all nodes in the cluster"
1210 echo "Persistent volumes will be mounted to base dir: $HOST_PATH_BASE_DIR"
1211 echo "Assuming this dir is mounted from each node to a dir on the localhost or other"
1212 echo "file system available to all nodes"
1219 echo -e $BOLD"Checking configured image setting for this test case"$EBOLD
1221 #Temp var to check for image variable name errors
1223 #Create a file with image info for later printing as a table
1224 image_list_file="./tmp/.image-list"
1225 echo -e "Application\tApp short name\tImage\ttag\ttag-switch" > $image_list_file
1227 # Check if image env var is set and if so export the env var with image to use (used by docker compose files)
1228 # arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>
1229 __check_and_create_image_var() {
1231 if [ $# -ne 6 ]; then
1232 echo "Expected arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>"
1237 __check_included_image $1
1238 if [ $? -ne 0 ]; then
1239 echo -e "$6\t$1\t<image-excluded>\t<no-tag>" >> $image_list_file
1240 # Image is excluded since the corresponding app is not used in this test
1243 tmp=${6}"\t"${1}"\t"
1244 #Create var from the input var names
1249 optional_image_repo_target=""
1251 if [ -z $image ]; then
1252 __check_ignore_image $1
1253 if [ $? -eq 0 ]; then
1255 if [ -z "$6" ]; then
1256 app_ds="<app ignored>"
1258 echo -e "$app_ds\t$1\t<image-ignored>\t<no-tag>" >> $image_list_file
1259 # Image is ignored since the corresponding the images is not set in the env file
1260 __remove_included_image $1 # Remove the image from the list of included images
1263 echo -e $RED"\$"$3" not set in $TEST_ENV_VAR_FILE"$ERED
1266 tmp=$tmp"<no-image>\t"
1269 optional_image_repo_target=$image
1271 #Add repo depending on image type
1272 if [ "$5" == "REMOTE_RELEASE" ]; then
1273 image=$NEXUS_RELEASE_REPO$image
1275 if [ "$5" == "REMOTE" ]; then
1276 image=$NEXUS_STAGING_REPO$image
1278 if [ "$5" == "REMOTE_SNAPSHOT" ]; then
1279 image=$NEXUS_SNAPSHOT_REPO$image
1281 if [ "$5" == "REMOTE_PROXY" ]; then
1282 image=$NEXUS_PROXY_REPO$image
1284 if [ "$5" == "REMOTE_RELEASE_ONAP" ]; then
1285 image=$NEXUS_RELEASE_REPO_ONAP$image
1287 if [ "$5" == "REMOTE_RELEASE_ORAN" ]; then
1288 image=$NEXUS_RELEASE_REPO_ORAN$image
1290 #No nexus repo added for local images, tag: LOCAL and other tags
1293 if [ -z $tag ]; then
1294 echo -e $RED"\$"$tmptag" not set in $TEST_ENV_VAR_FILE"$ERED
1297 tmp=$tmp"<no-tag>\t"
1302 echo -e "$tmp" >> $image_list_file
1304 export "${2}"=$image":"$tag #Note, this var may be set to the value of the target value below in __check_and_pull_image
1306 remote_or_local_push=false
1307 if [ ! -z "$IMAGE_REPO_ADR" ] && [[ $5 != *"PROXY"* ]]; then
1308 if [ $5 == "LOCAL" ]; then
1309 remote_or_local_push=true
1311 if [[ $5 == *"REMOTE"* ]]; then
1312 if [ "$IMAGE_REPO_POLICY" == "remote" ]; then
1313 remote_or_local_push=true
1317 if $remote_or_local_push; then # Only re-tag and push images according to policy, if repo is given
1318 export "${2}_SOURCE"=$image":"$tag #Var to keep the actual source image
1319 if [[ $optional_image_repo_target == *"/"* ]]; then # Replace all / with _ for images to push to external repo
1320 optional_image_repo_target_tmp=${optional_image_repo_target//\//_}
1321 optional_image_repo_target=$optional_image_repo_target_tmp
1323 export "${2}_TARGET"=$IMAGE_REPO_ADR"/"$optional_image_repo_target":"$tag #Create image + tag for optional image repo - pushed later if needed
1325 export "${2}_SOURCE"=""
1326 export "${2}_TARGET"=""
1330 # Check if app uses image included in this test run
1331 # Returns 0 if image is included, 1 if not
1332 __check_included_image() {
1333 for im in $INCLUDED_IMAGES; do
1334 if [ "$1" == "$im" ]; then
1341 # Check if app uses a project image
1342 # Returns 0 if image is included, 1 if not
1343 __check_project_image() {
1344 for im in $PROJECT_IMAGES; do
1345 if [ "$1" == "$im" ]; then
1352 # Check if app uses image built by the test script
1353 # Returns 0 if image is included, 1 if not
1354 __check_image_local_build() {
1355 for im in $LOCAL_IMAGE_BUILD; do
1356 if [ "$1" == "$im" ]; then
1363 # Check if app image is conditionally ignored in this test run
1364 # Returns 0 if image is conditionally ignored, 1 if not
1365 __check_ignore_image() {
1366 for im in $CONDITIONALLY_IGNORED_IMAGES; do
1367 if [ "$1" == "$im" ]; then
1374 # Removed image from included list of included images
1375 # Used when an image is marked as conditionally ignored
1376 __remove_included_image() {
1378 for im in $INCLUDED_IMAGES; do
1379 if [ "$1" != "$im" ]; then
1380 tmp_img_rem_list=$tmp_img_rem_list" "$im
1383 INCLUDED_IMAGES=$tmp_img_rem_list
1387 # Check if app is included in the prestarted set of apps
1388 # Returns 0 if image is included, 1 if not
1389 __check_prestarted_image() {
1390 for im in $KUBE_PRESTARTED_IMAGES; do
1391 if [ "$1" == "$im" ]; then
1398 # Check if an app shall use a local image, based on the cmd parameters
1399 __check_image_local_override() {
1400 for im in $USE_LOCAL_IMAGES; do
1401 if [ "$1" == "$im" ]; then
1408 # Check if app uses image override
1409 # Returns the image/tag suffix LOCAL for local image or REMOTE/REMOTE_RELEASE/REMOTE_SNAPSHOT for staging/release/snapshot image
1410 __check_image_override() {
1412 for im in $ORAN_IMAGES_APP_NAMES; do
1413 if [ "$1" == "$im" ]; then
1414 echo "REMOTE_RELEASE_ORAN"
1419 for im in $ONAP_IMAGES_APP_NAMES; do
1420 if [ "$1" == "$im" ]; then
1421 echo "REMOTE_RELEASE_ONAP"
1427 for im in $PROJECT_IMAGES_APP_NAMES; do
1428 if [ "$1" == "$im" ]; then
1433 if [ $found -eq 0 ]; then
1439 if [ $IMAGE_CATEGORY == "RELEASE" ]; then
1440 suffix="REMOTE_RELEASE"
1442 if [ $IMAGE_CATEGORY == "DEV" ]; then
1446 for im in $USE_STAGING_IMAGES; do
1447 if [ "$1" == "$im" ]; then
1452 for im in $USE_RELEASE_IMAGES; do
1453 if [ "$1" == "$im" ]; then
1454 suffix="REMOTE_RELEASE"
1458 for im in $USE_SNAPSHOT_IMAGES; do
1459 if [ "$1" == "$im" ]; then
1460 suffix="REMOTE_SNAPSHOT"
1464 for im in $USE_LOCAL_IMAGES; do
1465 if [ "$1" == "$im" ]; then
1470 for im in $USE_EXTERNAL_IMAGES; do
1471 if [ "$1" == "$im" ]; then
1477 if [ $CTR -gt 1 ]; then
1483 # Function to re-tag and image and push to another image repo
1484 __retag_and_push_image() {
1485 if [ ! -z "$IMAGE_REPO_ADR" ]; then
1486 source_image="${!1}"
1487 trg_var_name=$1_"TARGET" # This var is created in func __check_and_create_image_var
1488 target_image="${!trg_var_name}"
1490 if [ -z $target_image ]; then
1491 return 0 # Image with no target shall not be pushed
1494 echo -ne " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1495 tmp=$(docker image tag $source_image ${target_image} )
1496 if [ $? -ne 0 ]; then
1497 docker stop $tmp &> ./tmp/.dockererr
1500 echo -e " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1501 cat ./tmp/.dockererr
1504 echo -e " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1506 echo -ne " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1507 tmp=$(docker push ${target_image} )
1508 if [ $? -ne 0 ]; then
1509 docker stop $tmp &> ./tmp/.dockererr
1512 echo -e " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1513 cat ./tmp/.dockererr
1516 echo -e " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1518 export "${1}"=$target_image
1523 #Function to check if image exist and stop+remove the container+pull new images as needed
1524 #args <script-start-arg> <descriptive-image-name> <container-base-name> <image-with-tag-var-name>
1525 __check_and_pull_image() {
1527 source_image="${!4}"
1529 echo -e " Checking $BOLD$2$EBOLD container(s) with basename: $BOLD$3$EBOLD using image: $BOLD$source_image$EBOLD"
1530 format_string="\"{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\""
1531 tmp_im=$(docker images --format $format_string $source_image)
1533 if [ $1 == "local" ]; then
1534 if [ -z "$tmp_im" ]; then
1535 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
1539 echo -e " "$2" (local image): \033[1m"$source_image"\033[0m "$GREEN"OK"$EGREEN
1541 elif [ $1 == "remote" ] || [ $1 == "remote-remove" ]; then
1542 if [ $1 == "remote-remove" ]; then
1543 if [ $RUNMODE == "DOCKER" ]; then
1545 echo -ne " Attempt to stop and remove container(s), if running - ${SAMELINE}"
1546 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME})
1547 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1548 docker stop -t 0 $tmp &> ./tmp/.dockererr
1549 if [ $? -ne 0 ]; then
1552 echo -e $RED" Container(s) could not be stopped - try manual stopping the container(s)"$ERED
1553 cat ./tmp/.dockererr
1557 echo -ne " Attempt to stop and remove container(s), if running - "$GREEN"stopped"$EGREEN"${SAMELINE}"
1558 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME}) &> /dev/null
1559 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1560 docker rm -f $tmp &> ./tmp/.dockererr
1561 if [ $? -ne 0 ]; then
1564 echo -e $RED" Container(s) could not be removed - try manual removal of the container(s)"$ERED
1565 cat ./tmp/.dockererr
1569 echo -e " Attempt to stop and remove container(s), if running - "$GREEN"stopped removed"$EGREEN
1575 if [ -z "$tmp_im" ]; then
1576 echo -ne " Pulling image${SAMELINE}"
1577 out=$(docker pull $source_image)
1578 if [ $? -ne 0 ]; then
1580 echo -e " Pulling image -$RED could not be pulled"$ERED
1582 echo $out > ./tmp/.dockererr
1586 echo $out > ./tmp/.dockererr
1587 if [[ $out == *"up to date"* ]]; then
1588 echo -e " Pulling image -$GREEN Image is up to date $EGREEN"
1589 elif [[ $out == *"Downloaded newer image"* ]]; then
1590 echo -e " Pulling image -$GREEN Newer image pulled $EGREEN"
1592 echo -e " Pulling image -$GREEN Pulled $EGREEN"
1595 echo -e " Pulling image -$GREEN OK $EGREEN(exists in local repository)"
1599 __retag_and_push_image $4
1604 setup_testenvironment() {
1605 # Check that image env setting are available
1608 # Image var setup for all project images included in the test
1609 for imagename in $APP_SHORT_NAMES; do
1610 __check_included_image $imagename
1612 __check_project_image $imagename
1614 if [ $incl -eq 0 ]; then
1615 if [ $proj -eq 0 ]; then
1616 IMAGE_SUFFIX=$(__check_image_override $imagename)
1617 if [ $? -ne 0 ]; then
1618 echo -e $RED"Image setting from cmd line not consistent for $imagename."$ERED
1624 # A function name is created from the app short name
1625 # for example app short name 'ICS' -> produce the function
1626 # name __ICS_imagesetup
1627 # This function is called and is expected to exist in the imported
1628 # file for the ics test functions
1629 # The resulting function impl will call '__check_and_create_image_var' function
1630 # with appropriate parameters
1631 # If the image suffix is none, then the component decides the suffix
1632 function_pointer="__"$imagename"_imagesetup"
1633 $function_pointer $IMAGE_SUFFIX
1635 function_pointer="__"$imagename"_test_requirements"
1640 #Errors in image setting - exit
1641 if [ $IMAGE_ERR -ne 0 ]; then
1645 #Print a tables of the image settings
1646 echo -e $BOLD"Images configured for start arg: "$START_ARG $EBOLD
1647 column -t -s $'\t' $image_list_file | indent1
1651 #Set the SIM_GROUP var
1652 echo -e $BOLD"Setting var to main dir of all container/simulator scripts"$EBOLD
1653 if [ -z "$SIM_GROUP" ]; then
1654 SIM_GROUP=$AUTOTEST_HOME/../simulator-group
1655 if [ ! -d $SIM_GROUP ]; then
1656 echo "Trying to set env var SIM_GROUP to dir 'simulator-group' in the nontrtric repo, but failed."
1657 echo -e $RED"Please set the SIM_GROUP manually in the applicable $TEST_ENV_VAR_FILE"$ERED
1660 echo " SIM_GROUP auto set to: " $SIM_GROUP
1662 elif [ $SIM_GROUP = *simulator_group ]; then
1663 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
1666 echo " SIM_GROUP env var already set to: " $SIM_GROUP
1671 #Temp var to check for image pull errors
1675 echo -e $BOLD"Deleting namespaces"$EBOLD
1678 if [ "$DELETE_KUBE_NAMESPACES" -eq 1 ]; then
1679 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
1680 if [ $? -ne 0 ]; then
1681 echo " Cannot get list of namespaces...ignoring delete"
1683 for test_env_ns in $test_env_namespaces; do
1684 __kube_delete_namespace $test_env_ns
1688 echo " Namespace delete option not set or ignored"
1693 echo -e $BOLD"Deleting containers"$EBOLD
1695 if [ "$DELETE_CONTAINERS" -eq 1 ]; then
1696 echo " Stopping containers label 'nrttest_app'..."
1697 docker stop $(docker ps -qa --filter "label=nrttest_app") 2> /dev/null
1698 echo " Removing stopped containers..."
1699 docker rm $(docker ps -qa --filter "label=nrttest_app") 2> /dev/null
1701 echo " Contatiner delete option not set or ignored"
1705 # The following sequence pull the configured images
1706 echo -e $BOLD"Pulling configured images, if needed"$EBOLD
1708 if [ ! -z "$IMAGE_REPO_ADR" ] && [ $IMAGE_REPO_POLICY == "local" ]; then
1709 echo -e $YELLOW" Excluding all remote image check/pull (unless local override) when running with image repo: $IMAGE_REPO_ADR and image policy: $IMAGE_REPO_POLICY"$EYELLOW
1712 for imagename in $APP_SHORT_NAMES; do
1713 __check_included_image $imagename
1715 __check_project_image $imagename
1717 if [ $incl -eq 0 ]; then
1718 if [ $proj -eq 0 ]; then
1719 START_ARG_MOD=$START_ARG
1720 __check_image_local_override $imagename
1721 if [ $? -eq 1 ]; then
1722 START_ARG_MOD="local"
1725 START_ARG_MOD=$START_ARG
1727 __exclude_image_check=0
1728 if [ $__exclude_check == 1 ] && [ "$START_ARG_MOD" != "local" ]; then
1729 # For to handle locally built images, overriding remote images
1730 __exclude_image_check=1
1732 if [ $__exclude_image_check == 0 ]; then
1733 __check_image_local_build $imagename
1734 #No pull of images built locally
1735 if [ $? -ne 0 ]; then
1736 # A function name is created from the app short name
1737 # for example app short name 'HTTPPROXY' -> produce the function
1738 # name __HTTPPROXY_imagesetup
1739 # This function is called and is expected to exist in the imported
1740 # file for the httpproxy test functions
1741 # The resulting function impl will call '__check_and_pull_image' function
1742 # with appropriate parameters
1743 function_pointer="__"$imagename"_imagepull"
1744 $function_pointer $START_ARG_MOD $START_ARG
1748 echo -e $YELLOW" Excluding $imagename image from image check/pull"$EYELLOW
1753 #Errors in image setting - exit
1754 if [ $IMAGE_ERR -ne 0 ]; then
1756 echo "#################################################################################################"
1757 echo -e $RED"One or more images could not be pulled or containers using the images could not be stopped/removed"$ERED
1758 echo -e $RED"Or local image, overriding remote image, does not exist"$ERED
1759 if [ $IMAGE_CATEGORY == "DEV" ]; then
1761 echo -e $RED"Note that SNAPSHOT and staging images may be purged from nexus after a certain period."$ERED
1762 echo -e $RED"In addition, the image may not have been updated in the current release so no SNAPSHOT or staging image exists"$ERED
1763 echo -e $RED"In these cases, switch to use a released image instead, use the flag '--use-release-image <App-short-name>'"$ERED
1764 echo -e $RED"Use the 'App-short-name' for the applicable image from the above table: 'Images configured for start arg'."$ERED
1766 echo "#################################################################################################"
1773 echo -e $BOLD"Building images needed for test"$EBOLD
1775 for imagename in $APP_SHORT_NAMES; do
1776 cd $AUTOTEST_HOME #Always reset to orig dir
1777 __check_image_local_build $imagename
1778 if [ $? -eq 0 ]; then
1779 __check_included_image $imagename
1780 if [ $? -eq 0 ]; then
1781 # A function name is created from the app short name
1782 # for example app short name 'MR' -> produce the function
1783 # name __MR_imagebuild
1784 # This function is called and is expected to exist in the imported
1785 # file for the mr test functions
1786 # The resulting function impl shall build the imagee
1787 function_pointer="__"$imagename"_imagebuild"
1791 echo -e $YELLOW" Excluding image for app $imagename from image build"$EYELLOW
1796 cd $AUTOTEST_HOME # Just to make sure...
1800 # Create a table of the images used in the script - from local repo
1801 echo -e $BOLD"Local docker registry images used in this test script"$EBOLD
1803 docker_tmp_file=./tmp/.docker-images-table
1804 format_string="{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\\t{{.CreatedAt}}"
1805 echo -e "Application\tRepository\tTag\tCreated since\tSize\tCreated at" > $docker_tmp_file
1807 for imagename in $APP_SHORT_NAMES; do
1808 __check_included_image $imagename
1809 if [ $? -eq 0 ]; then
1810 # Only print image data if image repo is null, or if image repo is set and image is local
1812 if [ -z "$IMAGE_REPO_ADR" ]; then
1815 __check_image_local_build $imagename
1816 if [ $? -eq 0 ]; then
1820 if [ $print_image_data -eq 1 ]; then
1821 # A function name is created from the app short name
1822 # for example app short name 'MR' -> produce the function
1823 # name __MR_imagebuild
1824 # This function is called and is expected to exist in the imported
1825 # file for the mr test functions
1826 # The resulting function impl shall build the imagee
1827 function_pointer="__"$imagename"_image_data"
1828 $function_pointer "$format_string" $docker_tmp_file
1833 column -t -s $'\t' $docker_tmp_file | indent1
1837 if [ ! -z "$IMAGE_REPO_ADR" ]; then
1839 # Create a table of the images used in the script - from remote repo
1840 echo -e $BOLD"Remote repo images used in this test script"$EBOLD
1841 echo -e $YELLOW"-- Note: These image will be pulled when the container starts. Images not managed by the test engine "$EYELLOW
1842 echo -e $YELLOW"-- Note: Images with local override will however be re-tagged and managed by the test engine "$EYELLOW
1843 docker_tmp_file=./tmp/.docker-images-table
1844 format_string="{{.Repository}}\\t{{.Tag}}"
1845 echo -e "Application\tRepository\tTag" > $docker_tmp_file
1847 for imagename in $APP_SHORT_NAMES; do
1848 __check_included_image $imagename
1849 if [ $? -eq 0 ]; then
1850 # Only print image data if image repo is null, or if image repo is set and image is local
1851 __check_image_local_build $imagename
1852 if [ $? -ne 0 ]; then
1853 # A function name is created from the app short name
1854 # for example app short name 'MR' -> produce the function
1855 # name __MR_imagebuild
1856 # This function is called and is expected to exist in the imported
1857 # file for the mr test functions
1858 # The resulting function impl shall build the imagee
1859 function_pointer="__"$imagename"_image_data"
1860 $function_pointer "$format_string" $docker_tmp_file
1865 column -t -s $'\t' $docker_tmp_file | indent1
1870 if [ $RUNMODE == "KUBE" ]; then
1872 echo "================================================================================="
1873 echo "================================================================================="
1875 if [ -z "$IMAGE_REPO_ADR" ]; then
1876 echo -e $YELLOW" The image pull policy is set to 'Never' - assuming a local image repo is available for all images"$EYELLOW
1877 echo -e " This setting only works on single node clusters on the local machine"
1878 echo -e " It does not work with multi-node clusters or remote clusters. "
1879 export KUBE_IMAGE_PULL_POLICY="Never"
1881 echo -e $YELLOW" The image pull policy is set to 'Always'"$EYELLOW
1882 echo -e " This setting work on local clusters, multi-node clusters and remote cluster. "
1883 echo -e " Only locally built images are managed. Remote images are always pulled from remote repos"
1884 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"
1885 export KUBE_IMAGE_PULL_POLICY="Always"
1887 #CLUSTER_IP=$(kubectl $KUBECONF config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
1888 #echo -e $YELLOW" The cluster hostname/ip is: $CLUSTER_IP"$EYELLOW
1890 echo "================================================================================="
1891 echo "================================================================================="
1895 echo -e $BOLD"======================================================="$EBOLD
1896 echo -e $BOLD"== Common test setup completed - test script begins =="$EBOLD
1897 echo -e $BOLD"======================================================="$EBOLD
1902 for imagename in $APP_SHORT_NAMES; do
1903 __check_included_image $imagename
1905 __check_prestarted_image $imagename
1907 if [ $retcode_i -eq 0 ] || [ $retcode_p -eq 0 ]; then
1908 # A function name is created from the app short name
1909 # for example app short name 'RICMSIM' -> produce the function
1910 # name __RICSIM__initial_setup
1911 # This function is called and is expected to exist in the imported
1912 # file for the ricsim test functions
1913 # The resulting function impl shall perform initial setup of port, host etc
1915 function_pointer="__"$imagename"_initial_setup"
1918 function_pointer="__"$imagename"_statisics_setup"
1919 LOG_STAT_ARGS=$LOG_STAT_ARGS" "$($function_pointer)
1923 if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1924 ../common/genstat.sh $RUNMODE $SECONDS $TESTLOGS/$ATC/stat_data.csv $LOG_STAT_ARGS &
1925 COLLECT_RUNTIME_STATS_PID=$!
1930 # Function to print the test result, shall be the last cmd in a test script
1932 # (Function for test scripts)
1936 duration=$((TCTEST_END-TCTEST_START))
1938 echo "-------------------------------------------------------------------------------------------------"
1939 echo "------------------------------------- Test case: "$ATC
1940 echo "------------------------------------- Ended: "$(date)
1941 echo "-------------------------------------------------------------------------------------------------"
1942 echo "-- Description: "$TC_ONELINE_DESCR
1943 echo "-- Execution time: " $duration " seconds"
1944 echo "-- Used env file: "$TEST_ENV_VAR_FILE
1945 echo "-------------------------------------------------------------------------------------------------"
1946 echo "------------------------------------- RESULTS"
1950 if [ $RES_DEVIATION -gt 0 ]; then
1951 echo "Test case deviations"
1952 echo "===================================="
1956 echo "Timer measurement in the test script"
1957 echo "===================================="
1958 column -t -s $'\t' $TIMER_MEASUREMENTS
1959 if [ $RES_PASS != $RES_TEST ]; then
1960 echo -e $RED"Measurement may not be reliable when there are failed test - failures may cause long measurement values due to timeouts etc."$ERED
1964 if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1965 echo "Runtime statistics collected in file: "$TESTLOGS/$ATC/stat_data.csv
1968 TMP_FLAG_FAIL_PASS=0
1969 total=$((RES_PASS+RES_FAIL))
1970 if [ $RES_TEST -eq 0 ]; then
1971 TMP_FLAG_FAIL_PASS=1
1972 echo -e "\033[1mNo tests seem to have been executed. Check the script....\033[0m"
1973 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1974 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1975 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1976 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1977 elif [ $total != $RES_TEST ]; then
1978 TMP_FLAG_FAIL_PASS=1
1979 echo -e "\033[1mTotal number of tests does not match the sum of passed and failed tests. Check the script....\033[0m"
1980 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1981 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1982 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1983 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1984 elif [ $RES_CONF_FAIL -ne 0 ]; then
1985 TMP_FLAG_FAIL_PASS=1
1986 echo -e "\033[1mOne or more configurations has failed. Check the script log....\033[0m"
1987 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1988 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1989 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1990 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1991 elif [ $RES_PASS = $RES_TEST ]; then
1992 TMP_FLAG_FAIL_PASS=0
1993 echo -e "All tests \033[32m\033[1mPASS\033[0m"
1994 echo -e "\033[32m\033[1m ___ _ ___ ___ \033[0m"
1995 echo -e "\033[32m\033[1m | _ \/_\ / __/ __| \033[0m"
1996 echo -e "\033[32m\033[1m | _/ _ \\__ \__ \\ \033[0m"
1997 echo -e "\033[32m\033[1m |_|/_/ \_\___/___/ \033[0m"
2000 # Update test suite counter
2001 if [ -f .tmp_tcsuite_pass_ctr ]; then
2002 tmpval=$(< .tmp_tcsuite_pass_ctr)
2004 echo $tmpval > .tmp_tcsuite_pass_ctr
2006 if [ -f .tmp_tcsuite_pass ]; then
2007 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_pass
2009 #Create file with OK exit code
2010 echo "0" > "$AUTOTEST_HOME/.result$ATC.txt"
2011 echo "0" > "$TESTLOGS/$ATC/.result$ATC.txt"
2012 echo $(date) > $TESTLOGS/$ATC/endpoint_tc_end.log
2014 TMP_FLAG_FAIL_PASS=1
2015 echo -e "One or more tests with status \033[31m\033[1mFAIL\033[0m "
2016 echo -e "\033[31m\033[1m ___ _ ___ _ \033[0m"
2017 echo -e "\033[31m\033[1m | __/_\ |_ _| | \033[0m"
2018 echo -e "\033[31m\033[1m | _/ _ \ | || |__ \033[0m"
2019 echo -e "\033[31m\033[1m |_/_/ \_\___|____|\033[0m"
2023 if [ $TMP_FLAG_FAIL_PASS -ne 0 ]; then
2024 # Update test suite counter
2025 if [ -f .tmp_tcsuite_fail_ctr ]; then
2026 tmpval=$(< .tmp_tcsuite_fail_ctr)
2028 echo $tmpval > .tmp_tcsuite_fail_ctr
2030 if [ -f .tmp_tcsuite_fail ]; then
2031 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_fail
2035 echo "++++ Number of tests: "$RES_TEST
2036 echo "++++ Number of passed tests: "$RES_PASS
2037 echo "++++ Number of failed tests: "$RES_FAIL
2039 echo "++++ Number of failed configs: "$RES_CONF_FAIL
2041 echo "++++ Number of test case deviations: "$RES_DEVIATION
2043 echo "------------------------------------- Test case complete ---------------------------------"
2044 echo "-------------------------------------------------------------------------------------------------"
2048 #####################################################################
2049 ###### Functions for start, configuring, stoping, cleaning etc ######
2050 #####################################################################
2052 # Start timer for time measurement
2053 # args: <timer message to print> - timer value and message will be printed both on screen
2054 # and in the timer measurement report - if at least one "print_timer is called"
2056 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
2057 TC_TIMER_STARTTIME=$SECONDS
2058 TC_TIMER_TIMER_TEXT="${@:1}"
2059 if [ $# -ne 1 ]; then
2060 __print_err "need 1 arg, <timer message to print>" $@
2061 TC_TIMER_TIMER_TEXT=${FUNCNAME[0]}":"${BASH_LINENO[0]}
2062 echo " Assigning timer name: "$TC_TIMER_TIMER_TEXT
2064 TC_TIMER_CURRENT_FAILS=$(($RES_FAIL+$RES_CONF_FAIL))
2065 echo " Timer started: $(date)"
2068 # Print the running timer the value of the time (in seconds)
2069 # Timer value and message will be printed both on screen and in the timer measurement report
2071 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $TC_TIMER_TIMER_TEXT $EBOLD
2072 if [ -z "$TC_TIMER_STARTTIME" ]; then
2073 __print_err "timer not started" $@
2076 duration=$(($SECONDS-$TC_TIMER_STARTTIME))
2077 if [ $duration -eq 0 ]; then
2078 duration="<1 second"
2080 duration=$duration" seconds"
2082 echo " Timer duration :" $duration
2084 if [ $(($RES_FAIL+$RES_CONF_FAIL)) -ne $TC_TIMER_CURRENT_FAILS ]; then
2085 res="Failures occured during test - timer not reliabled"
2088 echo -e "$TC_TIMER_TIMER_TEXT \t $duration \t $res" >> $TIMER_MEASUREMENTS
2091 # Print info about a deviations from intended tests
2092 # Each deviation counted is also printed in the testreport
2093 # args <deviation message to print>
2095 echo -e $BOLD"DEVIATION(${BASH_LINENO[0]}): "${FUNCNAME[0]} $EBOLD
2096 if [ $# -lt 1 ]; then
2098 __print_err "need 1 or more args, <deviation message to print>" $@
2102 echo -e $BOLD$YELLOW" Test case deviation: ${@:1}"$EYELLOW$EBOLD
2103 echo "Line: ${BASH_LINENO[0]} - ${@:1}" >> $DEVIATION_FILE
2104 __print_current_stats
2108 # Stop at first FAIL test case and take all logs - only for debugging/trouble shooting
2109 __check_stop_at_error() {
2110 if [ $STOP_AT_ERROR -eq 1 ]; then
2111 echo -e $RED"Test script configured to stop at first FAIL, taking all logs and stops"$ERED
2112 store_logs "STOP_AT_ERROR"
2114 # Update test suite counter
2115 if [ -f .tmp_tcsuite_fail_ctr ]; then
2116 tmpval=$(< .tmp_tcsuite_fail_ctr)
2118 echo $tmpval > .tmp_tcsuite_fail_ctr
2120 if [ -f .tmp_tcsuite_fail ]; then
2121 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution stopped due to error" >> .tmp_tcsuite_fail
2128 # Stop and remove all containers
2130 # (Not for test scripts)
2131 __clean_containers() {
2133 echo -e $BOLD"Docker clean and stopping and removing all running containers, by container name"$EBOLD
2136 running_contr_file="./tmp/running_contr.txt"
2137 > $running_contr_file
2139 # Get list of all containers started by the test script
2140 for imagename in $APP_SHORT_NAMES; do
2141 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
2143 running_contr_file_empty="No docker containers running, started by previous test execution"
2144 if [ -s $running_contr_file ]; then
2145 running_contr_file_empty=""
2148 # Kill all containers started by the test env - to speed up shut down
2149 docker kill $(docker ps -a --filter "label=nrttest_app" --format '{{.Names}}') &> /dev/null
2151 tab_heading1="App display name"
2152 tab_heading2="App short name"
2153 tab_heading3="Container name"
2155 tab_heading1_len=${#tab_heading1}
2156 tab_heading2_len=${#tab_heading2}
2157 tab_heading3_len=${#tab_heading3}
2159 #Calc field lengths of each item in the list of containers
2161 if (( $cntr % 3 == 0 ));then
2162 if [ ${#p} -gt $tab_heading1_len ]; then
2163 tab_heading1_len=${#p}
2166 if (( $cntr % 3 == 1));then
2167 if [ ${#p} -gt $tab_heading2_len ]; then
2168 tab_heading2_len=${#p}
2171 if (( $cntr % 3 == 2));then
2172 if [ ${#p} -gt $tab_heading3_len ]; then
2173 tab_heading3_len=${#p}
2177 done <$running_contr_file
2179 let tab_heading1_len=tab_heading1_len+2
2180 while (( ${#tab_heading1} < $tab_heading1_len)); do
2181 tab_heading1="$tab_heading1"" "
2184 let tab_heading2_len=tab_heading2_len+2
2185 while (( ${#tab_heading2} < $tab_heading2_len)); do
2186 tab_heading2="$tab_heading2"" "
2189 let tab_heading3_len=tab_heading3_len+2
2190 while (( ${#tab_heading3} < $tab_heading3_len)); do
2191 tab_heading3="$tab_heading3"" "
2194 if [ ! -z "$running_contr_file_empty" ]; then
2195 echo $running_contr_file_empty | indent1
2197 echo " $tab_heading1$tab_heading2$tab_heading3"" Actions"
2200 if (( $cntr % 3 == 0 ));then
2203 heading_len=$tab_heading1_len
2205 if (( $cntr % 3 == 1));then
2207 heading_len=$tab_heading2_len
2209 if (( $cntr % 3 == 2));then
2212 heading_len=$tab_heading3_len
2214 while (( ${#heading} < $heading_len)); do
2215 heading="$heading"" "
2218 if (( $cntr % 3 == 2));then
2219 echo -ne $row$SAMELINE
2220 echo -ne " $row ${GREEN}stopping...${EGREEN}${SAMELINE}"
2221 docker stop $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
2222 echo -ne " $row ${GREEN}stopped removing...${EGREEN}${SAMELINE}"
2223 docker rm --force $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
2224 echo -e " $row ${GREEN}stopped removed ${EGREEN}"
2227 done <$running_contr_file
2232 echo -e $BOLD" Removing docker network"$EBOLD
2233 TMP=$(docker network ls -q --filter name=$DOCKER_SIM_NWNAME)
2234 if [ "$TMP" == $DOCKER_SIM_NWNAME ]; then
2235 docker network rm $DOCKER_SIM_NWNAME | indent2
2236 if [ $? -ne 0 ]; then
2237 echo -e $RED" Cannot remove docker network. Manually remove or disconnect containers from $DOCKER_SIM_NWNAME"$ERED
2241 echo -e "$GREEN Done$EGREEN"
2243 echo -e $BOLD" Removing all unused docker neworks"$EBOLD
2244 docker network prune --force | indent2
2245 echo -e "$GREEN Done$EGREEN"
2247 echo -e $BOLD" Removing all unused docker volumes"$EBOLD
2248 docker volume prune --force | indent2
2249 echo -e "$GREEN Done$EGREEN"
2251 echo -e $BOLD" Removing all dangling/untagged docker images"$EBOLD
2252 docker rmi --force $(docker images -q -f dangling=true) &> /dev/null
2253 echo -e "$GREEN Done$EGREEN"
2256 CONTRS=$(docker ps | awk '$1 != "CONTAINER" { n++ }; END { print n+0 }')
2257 if [ $? -eq 0 ]; then
2258 if [ $CONTRS -ne 0 ]; then
2259 echo -e $RED"Containers running, may cause distubance to the test case"$ERED
2260 docker ps -a | indent1
2266 ###################################
2267 ### Functions for kube management
2268 ###################################
2270 # Get resource type for scaling
2271 # args: <resource-name> <namespace>
2272 __kube_get_resource_type() {
2273 kubectl $KUBECONF get deployment $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
2274 if [ $? -eq 0 ]; then
2278 kubectl $KUBECONF get sts $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
2279 if [ $? -eq 0 ]; then
2283 echo "unknown-resource-type"
2287 # Scale a kube resource to a specific count
2288 # args: <resource-type> <resource-name> <namespace> <target-count>
2289 # (Not for test scripts)
2291 echo -ne " Setting $1 $2 replicas=$4 in namespace $3"$SAMELINE
2292 kubectl $KUBECONF scale $1 $2 -n $3 --replicas=$4 1> /dev/null 2> ./tmp/kubeerr
2293 if [ $? -ne 0 ]; then
2294 echo -e " Setting $1 $2 replicas=$4 in namespace $3 $RED Failed $ERED"
2296 echo " Message: $(<./tmp/kubeerr)"
2299 echo -e " Setting $1 $2 replicas=$4 in namespace $3 $GREEN OK $EGREEN"
2304 for i in {1..500}; do
2305 count=$(kubectl $KUBECONF get $1/$2 -n $3 -o jsonpath='{.status.replicas}' 2> /dev/null)
2307 if [ -z "$count" ]; then
2308 #No value is sometimes returned for some reason, in case the resource has replica 0
2311 if [ $retcode -ne 0 ]; then
2312 echo -e "$RED Cannot fetch current replica count for $1 $2 in namespace $3 $ERED"
2317 if [ $count -ne $4 ]; then
2318 echo -ne " Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds $SAMELINE"
2321 echo -e " Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds"
2322 echo -e " Replicas=$4 after $(($SECONDS-$TSTART)) seconds $GREEN OK $EGREEN"
2328 echo -e "$RED Replica count did not reach target replicas=$4. Failed with replicas=$count $ERED"
2333 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and label-id
2334 # This function does not wait for the resource to reach 0
2335 # args: <namespace> <label-name> <label-id>
2336 # (Not for test scripts)
2337 __kube_scale_all_resources() {
2341 resources="deployment replicaset statefulset"
2342 for restype in $resources; do
2343 result=$(kubectl $KUBECONF get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2344 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2345 for resid in $result; do
2346 echo -ne " Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"$SAMELINE
2347 kubectl $KUBECONF scale $restype $resid -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
2348 echo -e " Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0 $GREEN OK $EGREEN"
2354 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and an optional label-id
2355 # This function do wait for the resource to reach 0
2356 # args: <namespace> <label-name> [ <label-id> ]
2357 # (Not for test scripts)
2358 __kube_scale_and_wait_all_resources() {
2362 if [ -z "$3" ]; then
2363 echo " Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname"
2365 echo " Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname=$labelid"
2367 resources="deployment replicaset statefulset"
2369 while [ $scaled_all -ne 0 ]; do
2371 for restype in $resources; do
2372 if [ -z "$3" ]; then
2373 result=$(kubectl $KUBECONF get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname')].metadata.name}')
2375 result=$(kubectl $KUBECONF get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2377 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2378 for resid in $result; do
2379 echo -e " Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"
2380 kubectl $KUBECONF scale $restype $resid -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
2383 while [ $count -ne 0 ]; do
2384 count=$(kubectl $KUBECONF get $restype $resid -n $namespace -o jsonpath='{.status.replicas}' 2> /dev/null)
2385 echo -ne " Scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count"$SAMELINE
2386 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
2391 duration=$(($SECONDS-$T_START))
2392 if [ $duration -gt 100 ]; then
2393 #Forcring count 0, to avoid hanging for failed scaling
2398 echo -e " Scaled $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
2405 # Remove all kube resources in a namespace for resources having a certain label and label-id
2406 # This function wait until the resources are gone. Scaling to 0 must have been ordered previously
2407 # args: <namespace> <label-name> <label-id>
2408 # (Not for test scripts)
2409 __kube_delete_all_resources() {
2413 resources="deployments replicaset statefulset services pods configmaps persistentvolumeclaims persistentvolumes serviceaccounts clusterrolebindings secrets authorizationpolicies requestauthentications"
2414 deleted_resourcetypes=""
2415 for restype in $resources; do
2416 ns_flag="-n $namespace"
2417 ns_text="in namespace $namespace"
2418 if [ $restype == "persistentvolumes" ]; then
2422 if [ $restype == "clusterrolebindings" ]; then
2426 result=$(kubectl $KUBECONF get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}' 2> /dev/null)
2427 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2428 deleted_resourcetypes=$deleted_resourcetypes" "$restype
2429 for resid in $result; do
2430 if [ $restype == "replicaset" ] || [ $restype == "statefulset" ]; then
2432 while [ $count -ne 0 ]; do
2433 count=$(kubectl $KUBECONF get $restype $resid $ns_flag -o jsonpath='{.status.replicas}' 2> /dev/null)
2434 echo -ne " Scaling $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count"$SAMELINE
2435 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
2441 echo -e " Scaled $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
2443 echo -ne " Deleting $restype $resid $ns_text with label $labelname=$labelid "$SAMELINE
2444 kubectl $KUBECONF delete --grace-period=1 $restype $resid $ns_flag 1> /dev/null 2> ./tmp/kubeerr
2445 if [ $? -eq 0 ]; then
2446 echo -e " Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN OK $EGREEN"
2448 echo -e " Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN Does not exist - OK $EGREEN"
2454 if [ ! -z "$deleted_resourcetypes" ]; then
2455 for restype in $deleted_resources; do
2456 ns_flag="-n $namespace"
2457 ns_text="in namespace $namespace"
2458 if [ $restype == "persistentvolumes" ]; then
2462 echo -ne " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted..."$SAMELINE
2465 while [ ! -z "$result" ]; do
2467 result=$(kubectl $KUBECONF get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2468 echo -ne " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds "$SAMELINE
2469 if [ -z "$result" ]; then
2470 echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $GREEN OK $EGREEN"
2471 elif [ $(($SECONDS-$T_START)) -gt 300 ]; then
2472 echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $RED Failed $ERED"
2480 # Creates a namespace if it does not exists
2482 # (Not for test scripts)
2483 __kube_create_namespace() {
2485 #Check if test namespace exists, if not create it
2486 kubectl $KUBECONF get namespace $1 1> /dev/null 2> ./tmp/kubeerr
2487 if [ $? -ne 0 ]; then
2488 echo -ne " Creating namespace "$1 $SAMELINE
2489 kubectl $KUBECONF create namespace $1 1> /dev/null 2> ./tmp/kubeerr
2490 if [ $? -ne 0 ]; then
2491 echo -e " Creating namespace $1 $RED$BOLD FAILED $EBOLD$ERED"
2493 echo " Message: $(<./tmp/kubeerr)"
2496 kubectl $KUBECONF label ns $1 autotest=engine > /dev/null
2497 echo -e " Creating namespace $1 $GREEN$BOLD OK $EBOLD$EGREEN"
2500 echo -e " Creating namespace $1 $GREEN$BOLD Already exists, OK $EBOLD$EGREEN"
2505 # Removes a namespace if it exists
2507 # (Not for test scripts)
2508 __kube_delete_namespace() {
2510 #Check if test namespace exists, if so remove it
2511 kubectl $KUBECONF get namespace $1 1> /dev/null 2> ./tmp/kubeerr
2512 if [ $? -eq 0 ]; then
2513 echo -ne " Removing namespace "$1 $SAMELINE
2514 kubectl $KUBECONF delete namespace $1 1> /dev/null 2> ./tmp/kubeerr
2515 if [ $? -ne 0 ]; then
2516 echo -e " Removing namespace $1 $RED$BOLD FAILED $EBOLD$ERED"
2518 echo " Message: $(<./tmp/kubeerr)"
2521 echo -e " Removing namespace $1 $GREEN$BOLD OK $EBOLD$EGREEN"
2524 echo -e " Namespace $1 $GREEN$BOLD does not exist, OK $EBOLD$EGREEN"
2529 # Removes and re-create a namespace
2531 # (Not for test scripts)
2532 clean_and_create_namespace() {
2535 if [ $# -ne 1 ]; then
2536 __print_err "<namespace>" $@
2539 __kube_delete_namespace $1
2540 if [ $? -ne 0 ]; then
2543 __kube_create_namespace $1
2544 if [ $? -ne 0 ]; then
2549 # Add/remove label on non-namespaced kube object
2550 # args: <api> <instance> <label>
2551 # (Not for test scripts)
2552 __kube_label_non_ns_instance() {
2553 kubectl $KUBECONF label $1 $2 "$3" 1> /dev/null 2> ./tmp/kubeerr
2557 # Add/remove label on namespaced kube object
2558 # args: <api> <instance> <namespace> <label>
2559 # (Not for test scripts)
2560 __kube_label_ns_instance() {
2561 kubectl $KUBECONF label $1 $2 -n $3 "$4" 1> /dev/null 2> ./tmp/kubeerr
2565 # Find the host ip of an app (using the service resource)
2566 # args: <app-name> <namespace>
2567 # (Not for test scripts)
2568 __kube_get_service_host() {
2569 if [ $# -ne 2 ]; then
2571 __print_err "need 2 args, <app-name> <namespace>" $@
2574 for timeout in {1..60}; do
2575 host=$(kubectl $KUBECONF get svc $1 -n $2 -o jsonpath='{.spec.clusterIP}')
2576 if [ $? -eq 0 ]; then
2577 if [ ! -z "$host" ]; then
2585 echo "host-not-found-fatal-error"
2589 # Find the named port to an app (using the service resource)
2590 # args: <app-name> <namespace> <port-name>
2591 # (Not for test scripts)
2592 __kube_get_service_port() {
2593 if [ $# -ne 3 ]; then
2595 __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2599 for timeout in {1..60}; do
2600 port=$(kubectl $KUBECONF get svc $1 -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].port}')
2601 if [ $? -eq 0 ]; then
2602 if [ ! -z "$port" ]; then
2614 # Find the named node port to an app (using the service resource)
2615 # args: <app-name> <namespace> <port-name>
2616 # (Not for test scripts)
2617 __kube_get_service_nodeport() {
2618 if [ $# -ne 3 ]; then
2620 __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2624 for timeout in {1..60}; do
2625 port=$(kubectl $KUBECONF get svc $1 -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].nodePort}')
2626 if [ $? -eq 0 ]; then
2627 if [ ! -z "$port" ]; then
2639 # Create a kube resource from a yaml template
2640 # args: <resource-type> <resource-name> <template-yaml> <output-yaml>
2641 # (Not for test scripts)
2642 __kube_create_instance() {
2643 echo -ne " Creating $1 $2"$SAMELINE
2645 kubectl $KUBECONF apply -f $4 1> /dev/null 2> ./tmp/kubeerr
2646 if [ $? -ne 0 ]; then
2648 echo -e " Creating $1 $2 $RED Failed $ERED"
2649 echo " Message: $(<./tmp/kubeerr)"
2652 echo -e " Creating $1 $2 $GREEN OK $EGREEN"
2656 # Function to create a configmap in kubernetes
2657 # args: <configmap-name> <namespace> <labelname> <labelid> <path-to-data-file> <path-to-output-yaml>
2658 # (Not for test scripts)
2659 __kube_create_configmap() {
2660 echo -ne " Creating configmap $1 "$SAMELINE
2661 envsubst < $5 > $5"_tmp"
2662 cp $5"_tmp" $5 #Need to copy back to orig file name since create configmap neeed the original file name
2663 kubectl $KUBECONF create configmap $1 -n $2 --from-file=$5 --dry-run=client -o yaml > $6
2664 if [ $? -ne 0 ]; then
2665 echo -e " Creating configmap $1 $RED Failed $ERED"
2670 kubectl $KUBECONF apply -f $6 1> /dev/null 2> ./tmp/kubeerr
2671 if [ $? -ne 0 ]; then
2672 echo -e " Creating configmap $1 $RED Apply failed $ERED"
2673 echo " Message: $(<./tmp/kubeerr)"
2677 kubectl $KUBECONF label configmap $1 -n $2 $3"="$4 --overwrite 1> /dev/null 2> ./tmp/kubeerr
2678 if [ $? -ne 0 ]; then
2679 echo -e " Creating configmap $1 $RED Labeling failed $ERED"
2680 echo " Message: $(<./tmp/kubeerr)"
2684 # Log the resulting map
2685 kubectl $KUBECONF get configmap $1 -n $2 -o yaml > $6
2687 echo -e " Creating configmap $1 $GREEN OK $EGREEN"
2691 # This function runs a kubectl cmd where a single output value is expected, for example get ip with jsonpath filter.
2692 # The function retries up to the timeout given in the cmd flag '--cluster-timeout'
2693 # args: <full kubectl cmd with parameters>
2694 # (Not for test scripts)
2695 __kube_cmd_with_timeout() {
2696 TS_TMP=$(($SECONDS+$CLUSTER_TIME_OUT))
2699 kube_cmd_result=$($@)
2700 if [ $? -ne 0 ]; then
2703 if [ $SECONDS -ge $TS_TMP ] || [ ! -z "$kube_cmd_result" ] ; then
2704 echo $kube_cmd_result
2711 # This function starts a pod that cleans a the contents of a path mounted as a pvc
2712 # After this action the pod should terminate
2713 # This should only be executed when the pod owning the pvc is not running
2714 # args: <appname> <namespace> <pvc-name> <path-to remove>
2715 # (Not for test scripts)
2716 __kube_clean_pvc() {
2718 #using env vars setup in pvccleaner_api_functions.sh
2720 export PVC_CLEANER_NAMESPACE=$2
2721 export PVC_CLEANER_CLAIMNAME=$3
2722 export PVC_CLEANER_RM_PATH=$4
2723 export PVC_CLEANER_APP_NAME
2724 input_yaml=$SIM_GROUP"/"$PVC_CLEANER_COMPOSE_DIR"/"pvc-cleaner.yaml
2725 output_yaml=$PWD/tmp/$2-pvc-cleaner.yaml
2727 envsubst < $input_yaml > $output_yaml
2729 kubectl $KUBECONF delete -f $output_yaml 1> /dev/null 2> /dev/null # Delete the previous terminated pod - if existing
2731 __kube_create_instance pod $PVC_CLEANER_APP_NAME $input_yaml $output_yaml
2732 if [ $? -ne 0 ]; then
2733 echo $YELLOW" Could not clean pvc for app: $1 - persistent storage not clean - tests may not work"
2737 term_ts=$(($SECONDS+30))
2738 while [ $term_ts -gt $SECONDS ]; do
2739 pod_status=$(kubectl $KUBECONF get pod pvc-cleaner -n $PVC_CLEANER_NAMESPACE --no-headers -o custom-columns=":status.phase")
2740 if [ "$pod_status" == "Succeeded" ]; then
2747 # This function scales or deletes all resources for app selected by the testcase.
2749 # (Not for test scripts)
2751 echo -e $BOLD"Initialize kube pods/statefulsets/replicaset to initial state"$EBOLD
2753 # Scale prestarted or managed apps
2754 for imagename in $APP_SHORT_NAMES; do
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_scale_zero or __RICSIM_kube_scale_zero_and_wait
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 scale the resources to 0
2761 # For prestarted apps, the function waits until the resources are 0
2762 # For included (not prestated) apps, the scaling is just ordered
2763 __check_prestarted_image $imagename
2764 if [ $? -eq 0 ]; then
2765 function_pointer="__"$imagename"_kube_scale_zero_and_wait"
2766 echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2769 __check_included_image $imagename
2770 if [ $? -eq 0 ]; then
2771 function_pointer="__"$imagename"_kube_scale_zero"
2772 echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2778 # Delete managed apps
2779 for imagename in $APP_SHORT_NAMES; do
2780 __check_included_image $imagename
2781 if [ $? -eq 0 ]; then
2782 __check_prestarted_image $imagename
2783 if [ $? -ne 0 ]; then
2784 # A function name is created from the app short name
2785 # for example app short name 'RICMSIM' -> produce the function
2786 # name __RICSIM__kube_delete_all
2787 # This function is called and is expected to exist in the imported
2788 # file for the ricsim test functions
2789 # The resulting function impl shall delete all its resources
2790 function_pointer="__"$imagename"_kube_delete_all"
2791 echo -e " Deleting all kube resources for app $BOLD $imagename $EBOLD"
2797 # Remove istio label on namespaces
2798 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
2799 if [ $? -ne 0 ]; then
2800 echo " Cannot get list of namespaces...continues.."
2802 for test_env_ns in $test_env_namespaces; do
2803 echo " Removing istio label on ns: "$test_env_ns
2804 __kube_label_non_ns_instance ns $test_env_ns "istio-injection-"
2811 # Function stop and remove all containers (docker) and services/deployments etc(kube)
2813 # Function for test script
2814 clean_environment() {
2815 if [ $RUNMODE == "KUBE" ]; then
2817 if [ $PRE_CLEAN -eq 1 ]; then
2818 echo " Cleaning docker resouces to free up resources, may take time..."
2819 ../common/clean_docker.sh 2>&1 > /dev/null
2824 if [ $PRE_CLEAN -eq 1 ]; then
2825 echo " Cleaning kubernetes resouces to free up resources, may take time..."
2826 ../common/clean_kube.sh $KUBECONF 2>&1 > /dev/null
2832 # 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
2834 # (Function for test scripts)
2835 auto_clean_environment() {
2837 if [ "$AUTO_CLEAN" == "auto" ]; then
2838 echo -e $BOLD"Initiating automatic cleaning of environment"$EBOLD
2843 # Function to sleep a test case for a numner of seconds. Prints the optional text args as info
2844 # args: <sleep-time-in-sec> [any-text-in-quotes-to-be-printed]
2845 # (Function for test scripts)
2848 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
2849 if [ $# -lt 1 ]; then
2851 __print_err "need at least one arg, <sleep-time-in-sec> [any-text-to-printed]" $@
2854 #echo "---- Sleep for " $1 " seconds ---- "$2
2856 duration=$((SECONDS-start))
2857 while [ $duration -lt $1 ]; do
2858 echo -ne " Slept for ${duration} seconds${SAMELINE}"
2860 duration=$((SECONDS-start))
2862 echo -ne " Slept for ${duration} seconds${SAMELINE}"
2866 # Print error info for the call in the parent script (test case). Arg: <error-message-to-print>
2867 # Not to be called from the test script itself.
2869 echo -e $RED ${FUNCNAME[1]} " "$1" " ${BASH_SOURCE[2]} " line" ${BASH_LINENO[1]} $ERED
2870 if [ $# -gt 1 ]; then
2871 echo -e $RED" Got: "${FUNCNAME[1]} ${@:2} $ERED
2874 __check_stop_at_error
2877 # Function to create the docker network for the test
2878 # Not to be called from the test script itself.
2879 __create_docker_network() {
2880 tmp=$(docker network ls --format={{.Name}} --filter name=$DOCKER_SIM_NWNAME)
2881 if [ $? -ne 0 ]; then
2882 echo -e $RED" Could not check if docker network $DOCKER_SIM_NWNAME exists"$ERED
2885 if [ "$tmp" != $DOCKER_SIM_NWNAME ]; then
2886 echo -e " Creating docker network:$BOLD $DOCKER_SIM_NWNAME $EBOLD"
2887 docker network create $DOCKER_SIM_NWNAME | indent2
2888 if [ $? -ne 0 ]; then
2889 echo -e $RED" Could not create docker network $DOCKER_SIM_NWNAME"$ERED
2892 echo -e "$GREEN Done$EGREEN"
2895 echo -e " Docker network $DOCKER_SIM_NWNAME already exists$GREEN OK $EGREEN"
2899 # Function to start container with docker-compose and wait until all are in state running.
2900 # If the <docker-compose-file> is empty, the default 'docker-compose.yml' is assumed.
2901 #args: <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+
2902 # (Not for test scripts)
2903 __start_container() {
2905 if [ $# -lt 5 ]; then
2907 __print_err "need 5 or more args, <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+" $@
2911 __create_docker_network
2919 if [ -z "$compose_file" ]; then
2920 compose_file="docker-compose.yml"
2928 envsubst < $compose_file > "gen_"$compose_file
2929 compose_file="gen_"$compose_file
2930 if [ $DOCKER_COMPOSE_VERSION == "V1" ]; then
2931 docker_compose_cmd="docker-compose"
2933 docker_compose_cmd="docker compose"
2936 if [ "$compose_args" == "NODOCKERARGS" ]; then
2937 $docker_compose_cmd -f $compose_file up -d &> .dockererr
2938 if [ $? -ne 0 ]; then
2939 echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2941 echo -e $RED"Stopping script...."$ERED
2945 $docker_compose_cmd -f $compose_file up -d $compose_args &> .dockererr
2946 if [ $? -ne 0 ]; then
2947 echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2949 echo -e $RED"Stopping script...."$ERED
2957 while [ $appindex -lt $appcount ]; do
2961 for i in {1..10}; do
2962 if [ "$(docker inspect --format '{{ .State.Running }}' $appname)" == "true" ]; then
2963 echo -e " Container $BOLD${appname}$EBOLD$GREEN running$EGREEN on$BOLD image $(docker inspect --format '{{ .Config.Image }}' ${appname}) $EBOLD"
2970 if [ $app_started -eq 0 ]; then
2973 echo -e $RED" Container $BOLD${appname}$EBOLD could not be started"$ERED
2974 echo -e $RED" Stopping script..."$ERED
2977 let appindex=appindex+1
2982 # Function to check if container/service is responding to http/https
2983 # args: <container-name>|<service-name> url
2984 # (Not for test scripts)
2985 __check_service_start() {
2987 if [ $# -ne 2 ]; then
2989 __print_err "need 2 args, <container-name>|<service-name> url" $@
2993 if [ $RUNMODE == "KUBE" ]; then
2994 ENTITY="service/set/deployment"
3000 echo -ne " Container $BOLD${appname}$EBOLD starting${SAMELINE}"
3004 echo -ne " Waiting for ${ENTITY} ${appname} service status...${SAMELINE}"
3007 while (( $TSTART+600 > $SECONDS )); do
3008 result="$(__do_curl -m 10 $url)"
3009 if [ $? -eq 0 ]; then
3010 if [ ${#result} -gt 15 ]; then
3011 #If response is too long, truncate
3012 result="...response text too long, omitted"
3014 echo -ne " Waiting for {ENTITY} $BOLD${appname}$EBOLD service status on ${3}, result: $result${SAMELINE}"
3015 echo -ne " The ${ENTITY} $BOLD${appname}$EBOLD$GREEN is alive$EGREEN, responds to service status:$GREEN $result $EGREEN on ${url} after $(($SECONDS-$TSTART)) seconds"
3021 if (( $TS_OFFSET > 5 )); then
3024 while [ $(($TS_TMP+$TS_OFFSET)) -gt $SECONDS ]; do
3025 echo -ne " Waiting for ${ENTITY} ${appname} service status on ${url}...$(($SECONDS-$TSTART)) seconds, retrying in $(($TS_TMP+$TS_OFFSET-$SECONDS)) seconds ${SAMELINE}"
3029 let loop_ctr=loop_ctr+1
3032 if [ "$a1pmsst" = "false" ]; then
3034 echo -e $RED" The ${ENTITY} ${appname} did not respond to service status on ${url} in $(($SECONDS-$TSTART)) seconds"$ERED
3047 __check_container_logs() {
3055 echo -e $BOLD"Checking $dispname container $appname log ($logpath) for WARNINGs and ERRORs"$EBOLD
3057 if [ $RUNMODE == "KUBE" ]; then
3058 echo -e $YELLOW" Internal log for $dispname not checked in kube"$EYELLOW
3062 #tmp=$(docker ps | grep $appname)
3063 tmp=$(docker ps -q --filter name=$appname) #get the container id
3064 if [ -z "$tmp" ]; then #Only check logs for running A1PMS apps
3065 echo " "$dispname" is not running, no check made"
3068 foundentries="$(docker exec -t $tmp grep $warning $logpath | wc -l)"
3069 if [ $? -ne 0 ];then
3070 echo " Problem to search $appname log $logpath"
3072 if [ $foundentries -eq 0 ]; then
3073 echo " No WARN entries found in $appname log $logpath"
3075 echo -e " Found \033[1m"$foundentries"\033[0m WARN entries in $appname log $logpath"
3078 foundentries="$(docker exec -t $tmp grep $error $logpath | wc -l)"
3079 if [ $? -ne 0 ];then
3080 echo " Problem to search $appname log $logpath"
3082 if [ $foundentries -eq 0 ]; then
3083 echo " No ERR entries found in $appname log $logpath"
3085 echo -e $RED" Found \033[1m"$foundentries"\033[0m"$RED" ERR entries in $appname log $logpath"$ERED
3091 # Store all container logs and other logs in the log dir for the script
3092 # Logs are stored with a prefix in case logs should be stored several times during a test
3093 # args: <logfile-prefix>
3094 # (Function for test scripts)
3096 if [ $# != 1 ]; then
3098 __print_err "need one arg, <file-prefix>" $@
3101 echo -e $BOLD"Storing all docker/kube container logs and other test logs in $TESTLOGS/$ATC using prefix: "$1$EBOLD
3103 docker stats --no-stream > $TESTLOGS/$ATC/$1_docker_stats.log 2>&1
3105 docker ps -a > $TESTLOGS/$ATC/$1_docker_ps.log 2>&1
3107 cp .httplog_${ATC}.txt $TESTLOGS/$ATC/$1_httplog_${ATC}.txt 2>&1
3109 if [ $RUNMODE == "DOCKER" ]; then
3111 # Store docker logs for all container
3112 for imagename in $APP_SHORT_NAMES; do
3113 __check_included_image $imagename
3114 if [ $? -eq 0 ]; then
3115 # A function name is created from the app short name
3116 # for example app short name 'RICMSIM' -> produce the function
3117 # name __RICSIM__store_docker_logs
3118 # This function is called and is expected to exist in the imported
3119 # file for the ricsim test functions
3120 # The resulting function impl shall store the docker logs for each container
3121 function_pointer="__"$imagename"_store_docker_logs"
3122 $function_pointer "$TESTLOGS/$ATC/" $1
3126 if [ $RUNMODE == "KUBE" ]; then
3127 namespaces=$(kubectl $KUBECONF get namespaces -o jsonpath='{.items[?(@.metadata.name)].metadata.name}')
3128 for nsid in $namespaces; do
3129 pods=$(kubectl $KUBECONF get pods -n $nsid -o jsonpath='{.items[?(@.metadata.labels.autotest)].metadata.name}')
3130 for podid in $pods; do
3131 kubectl $KUBECONF logs -n $nsid $podid > $TESTLOGS/$ATC/$1_${podid}.log
3141 # Generic curl function, assumes all 200-codes are ok
3143 # args: <valid-curl-args-including full url>
3144 # returns: <returned response (without respose code)> or "<no-response-from-server>" or "<not found, <http-code>>""
3145 # returns: The return code is 0 for ok and 1 for not ok
3147 echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
3149 if [ ! -z "$KUBE_PROXY_PATH" ]; then
3150 if [ $KUBE_PROXY_HTTPX == "http" ]; then
3151 proxyflag=" --proxy $KUBE_PROXY_PATH"
3153 proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
3157 if [ ! -z "$KUBE_PROXY_CURL_JWT" ]; then
3158 jwt="-H "\""Authorization: Bearer $KUBE_PROXY_CURL_JWT"\"
3159 curlString="curl -skw %{http_code} $proxyflag $@"
3160 echo " CMD: $curlString $jwt" >> $HTTPLOG
3161 res=$($curlString -H "Authorization: Bearer $KUBE_PROXY_CURL_JWT")
3164 curlString="curl -skw %{http_code} $proxyflag $@"
3165 echo " CMD: $curlString" >> $HTTPLOG
3169 echo " RESP: $res" >> $HTTPLOG
3170 echo " RETCODE: $retcode" >> $HTTPLOG
3171 if [ $retcode -ne 0 ]; then
3172 echo "<no-response-from-server>"
3175 http_code="${res:${#res}-3}"
3176 if [ ${#res} -eq 3 ]; then
3177 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3178 echo "<no-response-from-server>"
3184 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3185 echo "<not found, resp:${http_code}>"
3188 if [ $# -eq 2 ]; then
3189 echo "${res:0:${#res}-3}" | xargs
3191 echo "${res:0:${#res}-3}"
3199 # Generic curl function, assumes all 200-codes are ok
3200 # Uses no proxy, even if it is set
3201 # args: <valid-curl-args-including full url>
3202 # returns: <returned response (without respose code)> or "<no-response-from-server>" or "<not found, <http-code>>""
3203 # returns: The return code is 0 for ok and 1 for not ok
3204 __do_curl_no_proxy() {
3205 echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
3206 curlString="curl -skw %{http_code} $@"
3207 echo " CMD: $curlString" >> $HTTPLOG
3210 echo " RESP: $res" >> $HTTPLOG
3211 echo " RETCODE: $retcode" >> $HTTPLOG
3212 if [ $retcode -ne 0 ]; then
3213 echo "<no-response-from-server>"
3216 http_code="${res:${#res}-3}"
3217 if [ ${#res} -eq 3 ]; then
3218 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3219 echo "<no-response-from-server>"
3225 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3226 echo "<not found, resp:${http_code}>"
3229 if [ $# -eq 2 ]; then
3230 echo "${res:0:${#res}-3}" | xargs
3232 echo "${res:0:${#res}-3}"
3239 #######################################
3240 ### Basic helper function for test cases
3241 #######################################
3243 # Test a simulator container variable value towards target value using an condition operator with an optional timeout.
3244 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> - This test is done
3245 # immediately and sets pass or fail depending on the result of comparing variable and target using the operator.
3246 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> <timeout> - This test waits up to the timeout
3247 # before setting pass or fail depending on the result of comparing variable and target using the operator.
3248 # 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.
3249 # Not to be called from test script.
3252 checkjsonarraycount=0
3253 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
3254 if [ $# -eq 6 ]; then
3255 if [[ $3 == "json:"* ]]; then
3256 checkjsonarraycount=1
3259 echo -e $BOLD"TEST $TEST_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: ${1}, ${3} ${4} ${5} within ${6} seconds"$EBOLD
3260 echo "TEST $TEST_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: ${1}, ${3} ${4} ${5} within ${6} seconds" >> $HTTPLOG
3263 ((TEST_SEQUENCE_NR++))
3267 if [ $checkjsonarraycount -eq 0 ]; then
3268 result="$(__do_curl $2$3)"
3270 result=${result//[[:blank:]]/} #Strip blanks
3273 result="$(__do_curl $2$path)"
3275 echo "$result" > ./tmp/.tmp.curl.json
3276 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
3278 duration=$((SECONDS-start))
3279 echo -ne " Result=${result} after ${duration} seconds${SAMELINE}"
3281 if [ $retcode -ne 0 ]; then
3282 if [ $duration -gt $6 ]; then
3284 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
3285 __print_current_stats
3286 __check_stop_at_error
3289 elif [ "$4" == "=" ] && [ "$result" -eq $5 ]; then
3291 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3292 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3293 __print_current_stats
3295 elif [ "$4" == ">" ] && [ "$result" -gt $5 ]; then
3297 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3298 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3299 __print_current_stats
3301 elif [ "$4" == "<" ] && [ "$result" -lt $5 ]; then
3303 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3304 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3305 __print_current_stats
3307 elif [ "$4" == ">=" ] && [ "$result" -ge $5 ]; then
3309 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3310 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3311 __print_current_stats
3313 elif [ "$4" == "contain_str" ] && [[ $result =~ $5 ]]; then
3315 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3316 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3317 __print_current_stats
3320 if [ $duration -gt $6 ]; then
3322 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
3323 __print_current_stats
3324 __check_stop_at_error
3330 elif [ $# -eq 5 ]; then
3331 if [[ $3 == "json:"* ]]; then
3332 checkjsonarraycount=1
3335 echo -e $BOLD"TEST $TEST_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: ${1}, ${3} ${4} ${5}"$EBOLD
3336 echo "TEST $TEST_SEQUENCE_NR - (${BASH_LINENO[1]}) - ${TIMESTAMP}: ${1}, ${3} ${4} ${5}" >> $HTTPLOG
3338 ((TEST_SEQUENCE_NR++))
3339 if [ $checkjsonarraycount -eq 0 ]; then
3340 result="$(__do_curl $2$3)"
3342 result=${result//[[:blank:]]/} #Strip blanks
3345 result="$(__do_curl $2$path)"
3347 echo "$result" > ./tmp/.tmp.curl.json
3348 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
3350 if [ $retcode -ne 0 ]; then
3352 echo -e $RED" FAIL ${ERED}- ${3} ${4} ${5} not reached, result = ${result}"
3353 __print_current_stats
3354 __check_stop_at_error
3355 elif [ "$4" == "=" ] && [ "$result" -eq $5 ]; then
3357 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3358 __print_current_stats
3359 elif [ "$4" == ">" ] && [ "$result" -gt $5 ]; then
3361 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3362 __print_current_stats
3363 elif [ "$4" == "<" ] && [ "$result" -lt $5 ]; then
3365 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3366 __print_current_stats
3367 elif [ "$4" == ">=" ] && [ "$result" -ge $5 ]; then
3369 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3370 __print_current_stats
3371 elif [ "$4" == "contain_str" ] && [[ $result =~ $5 ]]; then
3373 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3374 __print_current_stats
3377 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached, result = ${result}"
3378 __print_current_stats
3379 __check_stop_at_error
3382 echo "Wrong args to __var_test, needs five or six args: <simulator-name> <host> <variable-name> <condition-operator> <target-value> [ <timeout> ]"