3 # ============LICENSE_START===============================================
4 # Copyright (C) 2020 Nordix Foundation. All rights reserved.
5 # ========================================================================
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
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 #Variables for counting tests as well as passed and failed tests
257 #Var to control if current stats shall be printed
258 PRINT_CURRENT_STATS=0
260 #Var to control if container/pod runtim statistics shall be collected
261 COLLECT_RUNTIME_STATS=0
262 COLLECT_RUNTIME_STATS_PID=0
264 #Var to control if endpoint statistics shall be collected
265 COLLECT_ENDPOINT_STATS=0
267 #Var to control if namespaces shall be delete before test setup
268 DELETE_KUBE_NAMESPACES=0
270 #Var to control if containers shall be delete before test setup
273 #Var to configure kubectl from a config file or context
276 #Localhost, may be set to another host/ip by cmd parameter
277 LOCALHOST_NAME="localhost"
279 #Reseting vars related to token/keys used by kubeproxy when istio is enabled
280 #The vars are populated if istio is used in the testcase
281 KUBE_PROXY_CURL_JWT=""
282 KUBE_PROXY_ISTIO_JWKS_KEYS=""
284 #Var pointing to dir mounted to each kubernetes node (master and workers)
285 #Persistent volumes using "hostpath" are allocated beneath the point.
286 #Typically it is a dir on local host mounted to each VM running the master and worker.
287 #So the intention is make this dir available so the PODs can be restarted on any
288 #node and still access the persistent data
289 #If not set from cmd line, the path is defaults to "/tmp"
290 HOST_PATH_BASE_DIR=""
292 #File to keep deviation messages
293 DEVIATION_FILE=".tmp_deviations"
294 rm $DEVIATION_FILE &> /dev/null
296 # Trap "command not found" and make the script fail
299 if [ $? -eq 127 ]; then
300 echo -e $RED"Function not found, setting script to FAIL"$ERED
302 __print_current_stats
307 # Trap to kill subprocess for stats collection (if running)
309 if [ $COLLECT_RUNTIME_STATS_PID -ne 0 ]; then
310 kill $COLLECT_RUNTIME_STATS_PID
318 # Function to log the start of a test case
320 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
321 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${FUNCNAME[1]}" $@ $EBOLD
322 echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${FUNCNAME[1]}" $@ >> $HTTPLOG
324 ((TEST_SEQUENCE_NR++))
327 # Function to print current statistics
328 __print_current_stats() {
329 if [ $PRINT_CURRENT_STATS -ne 0 ]; then
330 echo " Current stats - exe-time, tests, passes, fails, conf fails, deviations: $(($SECONDS-$TCTEST_START)), $RES_TEST, $RES_PASS, $RES_FAIL, $RES_CONF_FAIL, $RES_DEVIATION"
334 # General function to log a failed test case
335 __log_test_fail_general() {
336 echo -e $RED" FAIL."$1 $ERED
338 __print_current_stats
339 __check_stop_at_error
342 # Function to log a test case failed due to incorrect response code
343 __log_test_fail_status_code() {
344 echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
346 __print_current_stats
347 __check_stop_at_error
350 # Function to log a test case failed due to incorrect response body
351 __log_test_fail_body() {
352 echo -e $RED" FAIL, returned body not correct"$ERED
354 __print_current_stats
355 __check_stop_at_error
358 # Function to log a test case that is not supported
359 __log_test_fail_not_supported() {
360 echo -e $RED" FAIL, function not supported"$ERED
362 __print_current_stats
363 __check_stop_at_error
366 # General function to log a passed test case
368 if [ $# -gt 0 ]; then
372 echo -e $GREEN" PASS"$EGREEN
373 __print_current_stats
376 #Counter for configurations
379 # Function to log the start of a configuration setup
381 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
382 echo -e $BOLD"CONF $CONF_SEQUENCE_NR (${BASH_LINENO[1]}): "${FUNCNAME[1]} $@ $EBOLD
383 echo "CONF $CONF_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): "${FUNCNAME[1]} $@ >> $HTTPLOG
384 ((CONF_SEQUENCE_NR++))
387 # Function to log a failed configuration setup
388 __log_conf_fail_general() {
389 echo -e $RED" FAIL."$1 $ERED
391 __print_current_stats
392 __check_stop_at_error
395 # Function to log a failed configuration setup due to incorrect response code
396 __log_conf_fail_status_code() {
397 echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
399 __print_current_stats
400 __check_stop_at_error
403 # Function to log a failed configuration setup due to incorrect response body
404 __log_conf_fail_body() {
405 echo -e $RED" FAIL, returned body not correct"$ERED
407 __print_current_stats
408 __check_stop_at_error
411 # Function to log a configuration that is not supported
412 __log_conf_fail_not_supported() {
413 echo -e $RED" FAIL, function not supported"$ERED$@
415 __print_current_stats
416 __check_stop_at_error
419 # Function to log a passed configuration setup
421 if [ $# -gt 0 ]; then
424 echo -e $GREEN" OK"$EGREEN
425 __print_current_stats
428 # Function to collect stats on endpoints
429 # args: <app-id> <end-point-no> <http-operation> <end-point-url> <http-status> [<count>]
430 __collect_endpoint_stats() {
431 if [ $COLLECT_ENDPOINT_STATS -eq 0 ]; then
435 if [ $# -gt 5 ]; then
438 ENDPOINT_STAT_FILE=$TESTLOGS/$ATC/endpoint_$ATC_$1_$2".log"
441 if [ -f $ENDPOINT_STAT_FILE ]; then
442 ENDPOINT_VAL=$(< $ENDPOINT_STAT_FILE)
443 ENDPOINT_POS=$(echo $ENDPOINT_VAL | cut -f4 -d ' ' | cut -f1 -d '/')
444 ENDPOINT_NEG=$(echo $ENDPOINT_VAL | cut -f5 -d ' ' | cut -f1 -d '/')
447 if [ $5 -ge 200 ] && [ $5 -lt 300 ]; then
448 let ENDPOINT_POS=ENDPOINT_POS+$ENDPOINT_COUNT
450 let ENDPOINT_NEG=ENDPOINT_NEG+$ENDPOINT_COUNT
453 printf '%-2s %-10s %-45s %-16s %-16s' "#" "$3" "$4" "$ENDPOINT_POS/$ENDPOINT_POS" "$ENDPOINT_NEG/$ENDPOINT_NEG" > $ENDPOINT_STAT_FILE
456 # Function to collect stats on endpoints
457 # args: <app-id> <image-info>
458 __collect_endpoint_stats_image_info() {
459 if [ $COLLECT_ENDPOINT_STATS -eq 0 ]; then
462 ENDPOINT_STAT_FILE=$TESTLOGS/$ATC/imageinfo_$ATC_$1".log"
463 echo $A1PMS_IMAGE > $ENDPOINT_STAT_FILE
466 #Var for measuring execution time
467 TCTEST_START=$SECONDS
469 #Vars to hold the start time and timer text for a custom timer
470 TC_TIMER_STARTTIME=""
471 TC_TIMER_TIMER_TEXT=""
472 TC_TIMER_CURRENT_FAILS="" # Then numer of failed test when timer starts.
473 # Compared with the current number of fails at timer stop
474 # to judge the measurement reliability
476 #File to save timer measurement results
477 TIMER_MEASUREMENTS=".timer_measurement.txt"
478 echo -e "Activity \t Duration \t Info" > $TIMER_MEASUREMENTS
480 # If this is set, some images (controlled by the parameter repo-policy) will be re-tagged and pushed to this repo before any
482 IMAGE_REPO_POLICY="local"
485 echo "-------------------------------------------------------------------------------------------------"
486 echo "----------------------------------- Test case: "$ATC
487 echo "----------------------------------- Started: "$(date)
488 echo "-------------------------------------------------------------------------------------------------"
489 echo "-- Description: "$TC_ONELINE_DESCR
490 echo "-------------------------------------------------------------------------------------------------"
491 echo "----------------------------------- Test case setup -----------------------------------"
493 echo "Setting AUTOTEST_HOME="$AUTOTEST_HOME
497 if [ $# -lt 1 ]; then
500 if [ $paramerror -eq 0 ]; then
501 if [ "$1" != "remote" ] && [ "$1" != "remote-remove" ]; then
503 if [ -z "$paramerror_str" ]; then
504 paramerror_str="First arg shall be 'remote' or 'remote-remove'"
510 if [ $paramerror -eq 0 ]; then
511 if [ "$1" != "docker" ] && [ "$1" != "kube" ]; then
513 if [ -z "$paramerror_str" ]; then
514 paramerror_str="Second arg shall be 'docker' or 'kube'"
517 if [ $1 == "docker" ]; then
519 echo "Setting RUNMODE=DOCKER"
521 if [ $1 == "kube" ]; then
523 echo "Setting RUNMODE=KUBE"
529 while [ $paramerror -eq 0 ] && [ $foundparm -eq 0 ]; do
531 if [ $paramerror -eq 0 ]; then
532 if [ "$1" == "release" ]; then
533 IMAGE_CATEGORY="RELEASE"
534 echo "Option set - Release image tags used for applicable images "
539 if [ $paramerror -eq 0 ]; then
540 if [ "$1" == "auto-clean" ]; then
542 echo "Option set - Auto clean at end of test script"
547 if [ $paramerror -eq 0 ]; then
548 if [ "$1" == "--stop-at-error" ]; then
550 echo "Option set - Stop at first error"
555 if [ $paramerror -eq 0 ]; then
556 if [ "$1" == "--ricsim-prefix" ]; then
558 TMP_RIC_SIM_PREFIX=$1 #RIC_SIM_PREFIX need to be updated after sourcing of the env file
561 if [ -z "$paramerror_str" ]; then
562 paramerror_str="No prefix found for flag: '--ricsim-prefix'"
565 echo "Option set - Overriding RIC_SIM_PREFIX with: "$1
571 if [ $paramerror -eq 0 ]; then
572 if [ "$1" == "--env-file" ]; then
577 if [ -z "$paramerror_str" ]; then
578 paramerror_str="No env file found for flag: '--env-file'"
581 echo "Option set - Reading test env from: "$1
587 if [ $paramerror -eq 0 ]; then
588 if [ "$1" == "--use-local-image" ]; then
591 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
592 USE_LOCAL_IMAGES=$USE_LOCAL_IMAGES" "$1
593 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
595 if [ -z "$paramerror_str" ]; then
596 paramerror_str="App name $1 is not available for local override for flag: '--use-local-image'"
602 if [ -z "$USE_LOCAL_IMAGES" ]; then
604 if [ -z "$paramerror_str" ]; then
605 paramerror_str="No app name found for flag: '--use-local-image'"
608 echo "Option set - Overriding with local images for app(s):"$USE_LOCAL_IMAGES
612 if [ $paramerror -eq 0 ]; then
613 if [ "$1" == "--use-snapshot-image" ]; then
614 USE_SNAPSHOT_IMAGES=""
616 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
617 USE_SNAPSHOT_IMAGES=$USE_SNAPSHOT_IMAGES" "$1
618 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
620 if [ -z "$paramerror_str" ]; then
621 paramerror_str="App name $1 is not available for snapshot override for flag: '--use-snapshot-image'"
627 if [ -z "$USE_SNAPSHOT_IMAGES" ]; then
629 if [ -z "$paramerror_str" ]; then
630 paramerror_str="No app name found for flag: '--use-snapshot-image'"
633 echo "Option set - Overriding with snapshot images for app(s):"$USE_SNAPSHOT_IMAGES
637 if [ $paramerror -eq 0 ]; then
638 if [ "$1" == "--use-staging-image" ]; then
639 USE_STAGING_IMAGES=""
641 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
642 USE_STAGING_IMAGES=$USE_STAGING_IMAGES" "$1
643 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
645 if [ -z "$paramerror_str" ]; then
646 paramerror_str="App name $1 is not available for staging override for flag: '--use-staging-image'"
652 if [ -z "$USE_STAGING_IMAGES" ]; then
654 if [ -z "$paramerror_str" ]; then
655 paramerror_str="No app name found for flag: '--use-staging-image'"
658 echo "Option set - Overriding with staging images for app(s):"$USE_STAGING_IMAGES
662 if [ $paramerror -eq 0 ]; then
663 if [ "$1" == "--use-release-image" ]; then
664 USE_RELEASE_IMAGES=""
666 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
667 USE_RELEASE_IMAGES=$USE_RELEASE_IMAGES" "$1
668 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
670 if [ -z "$paramerror_str" ]; then
671 paramerror_str="App name $1 is not available for release override for flag: '--use-release-image'"
677 if [ -z "$USE_RELEASE_IMAGES" ]; then
679 if [ -z "$paramerror_str" ]; then
680 paramerror_str="No app name found for flag: '--use-release-image'"
683 echo "Option set - Overriding with release images for app(s):"$USE_RELEASE_IMAGES
687 if [ $paramerror -eq 0 ]; then
688 if [ "$1" == "--use-external-image" ]; then
689 USE_EXTERNAL_IMAGES=""
691 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
692 USE_EXTERNAL_IMAGES=$USE_EXTERNAL_IMAGES" "$1
693 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
695 if [ -z "$paramerror_str" ]; then
696 paramerror_str="App name $1 is not available for release override for flag: '--use-external-image'"
702 if [ -z "$USE_EXTERNAL_IMAGES" ]; then
704 if [ -z "$paramerror_str" ]; then
705 paramerror_str="No app name found for flag: '--use-use-external-image'"
708 echo "Option set - Overriding with external images for app(s):"$USE_EXTERNAL_IMAGES
712 if [ $paramerror -eq 0 ]; then
713 if [ "$1" == "--image-repo" ]; then
718 if [ -z "$paramerror_str" ]; then
719 paramerror_str="No image repo url found for : '--image-repo'"
722 echo "Option set - Image repo url: "$1
728 if [ $paramerror -eq 0 ]; then
729 if [ "$1" == "--repo-policy" ]; then
734 if [ -z "$paramerror_str" ]; then
735 paramerror_str="No policy found for : '--repo-policy'"
738 if [ "$1" == "local" ] || [ "$1" == "remote" ]; then
739 echo "Option set - Image repo policy: "$1
744 if [ -z "$paramerror_str" ]; then
745 paramerror_str="Repo policy shall be 'local' or 'remote'"
751 if [ $paramerror -eq 0 ]; then
752 if [ "$1" == "--cluster-timeout" ]; then
757 if [ -z "$paramerror_str" ]; then
758 paramerror_str="No timeout value found for : '--cluster-timeout'"
761 #Check if positive int
762 case ${CLUSTER_TIME_OUT#[+]} in
765 if [ -z "$paramerror_str" ]; then
766 paramerror_str="Value for '--cluster-timeout' not an int : "$CLUSTER_TIME_OUT
771 echo "Option set - Cluster timeout: "$1
777 if [ $paramerror -eq 0 ]; then
778 if [ "$1" == "--override" ]; then
780 TEST_ENV_VAR_FILE_OVERRIDE=$1
783 if [ -z "$paramerror_str" ]; then
784 paramerror_str="No env file found for flag: '--override'"
787 if [ ! -f $TEST_ENV_VAR_FILE_OVERRIDE ]; then
789 if [ -z "$paramerror_str" ]; then
790 paramerror_str="File for '--override' does not exist : "$TEST_ENV_VAR_FILE_OVERRIDE
793 echo "Option set - Override env from: "$1
799 if [ $paramerror -eq 0 ]; then
800 if [ "$1" == "--pre-clean" ]; then
802 echo "Option set - Pre-clean of kube/docker resouces"
807 if [ $paramerror -eq 0 ]; then
808 if [ "$1" == "--print-stats" ]; then
809 PRINT_CURRENT_STATS=1
810 echo "Option set - Print stats after every test-case and config"
815 if [ $paramerror -eq 0 ]; then
816 if [ "$1" == "--gen-stats" ]; then
817 COLLECT_RUNTIME_STATS=1
818 echo "Option set - Collect runtime statistics"
823 if [ $paramerror -eq 0 ]; then
824 if [ "$1" == "--delete-namespaces" ]; then
825 if [ $RUNMODE == "DOCKER" ]; then
826 DELETE_KUBE_NAMESPACES=0
827 echo "Option ignored - Delete namespaces (ignored when running docker)"
829 if [ -z "KUBE_PRESTARTED_IMAGES" ]; then
830 DELETE_KUBE_NAMESPACES=0
831 echo "Option ignored - Delete namespaces (ignored when using prestarted apps)"
833 DELETE_KUBE_NAMESPACES=1
834 echo "Option set - Delete namespaces"
841 if [ $paramerror -eq 0 ]; then
842 if [ "$1" == "--delete-containers" ]; then
843 if [ $RUNMODE == "DOCKER" ]; then
845 echo "Option set - Delete containers started by previous test(s)"
847 echo "Option ignored - Delete containers (ignored when running kube)"
853 if [ $paramerror -eq 0 ]; then
854 if [ "$1" == "--endpoint-stats" ]; then
855 COLLECT_ENDPOINT_STATS=1
856 echo "Option set - Collect endpoint statistics"
861 if [ $paramerror -eq 0 ]; then
862 if [ "$1" == "--kubeconfig" ]; then
866 if [ -z "$paramerror_str" ]; then
867 paramerror_str="No path found for : '--kubeconfig'"
871 if [ ! -z "$KUBECONF" ]; then
873 if [ -z "$paramerror_str" ]; then
874 paramerror_str="Only one of --kubeconfig/--kubecontext can be set"
877 KUBECONF="--kubeconfig $1"
878 echo "Option set - Kubeconfig path: "$1
884 if [ -z "$paramerror_str" ]; then
885 paramerror_str="File $1 for --kubeconfig not found"
891 if [ $paramerror -eq 0 ]; then
892 if [ "$1" == "--kubecontext" ]; then
896 if [ -z "$paramerror_str" ]; then
897 paramerror_str="No context-name found for : '--kubecontext'"
900 if [ ! -z "$KUBECONF" ]; then
902 if [ -z "$paramerror_str" ]; then
903 paramerror_str="Only one of --kubeconfig or --kubecontext can be set"
906 KUBECONF="--context $1"
907 echo "Option set - Kubecontext name: "$1
914 if [ $paramerror -eq 0 ]; then
915 if [ "$1" == "--host-path-dir" ]; then
919 if [ -z "$paramerror_str" ]; then
920 paramerror_str="No path found for : '--host-path-dir'"
923 HOST_PATH_BASE_DIR=$1
924 echo "Option set - Host path for kube set to: "$1
930 if [ $paramerror -eq 0 ]; then
931 if [ "$1" == "--docker-host" ]; then
935 if [ -z "$paramerror_str" ]; then
936 paramerror_str="No url found for : '--docker-host'"
939 export DOCKER_HOST="$1"
940 echo "Option set - DOCKER_HOST set to: "$1
946 if [ $paramerror -eq 0 ]; then
947 if [ "$1" == "--docker-host" ]; then
951 if [ -z "$paramerror_str" ]; then
952 paramerror_str="No url found for : '--docker-host'"
955 export DOCKER_HOST="$1"
956 echo "Option set - DOCKER_HOST set to: "$1
962 if [ $paramerror -eq 0 ]; then
963 if [ "$1" == "--docker-proxy" ]; then
967 if [ -z "$paramerror_str" ]; then
968 paramerror_str="No ip/host found for : '--docker-proxy'"
971 export LOCALHOST_NAME=$1
972 echo "Option set - docker proxy set to: "$1
982 if [ $paramerror -eq 0 ] && [ $# -gt 0 ]; then
984 if [ -z "$paramerror_str" ]; then
985 paramerror_str="Unknown parameter(s): "$@
989 if [ $paramerror -eq 1 ]; then
990 echo -e $RED"Incorrect arg list: "$paramerror_str$ERED
995 LOCALHOST_HTTP="http://$LOCALHOST_NAME"
996 LOCALHOST_HTTPS="https://$LOCALHOST_NAME"
998 # sourcing the selected env variables for the test case
999 if [ -f "$TEST_ENV_VAR_FILE" ]; then
1000 echo -e $BOLD"Sourcing env vars from: "$TEST_ENV_VAR_FILE$EBOLD
1001 . $TEST_ENV_VAR_FILE
1002 if [ ! -z "$TEST_ENV_VAR_FILE_OVERRIDE" ]; then
1003 echo -e $BOLD"Sourcing override env vars from: "$TEST_ENV_VAR_FILE_OVERRIDE$EBOLD
1004 . $TEST_ENV_VAR_FILE_OVERRIDE
1007 if [ -z "$TEST_ENV_PROFILE" ] || [ -z "$SUPPORTED_PROFILES" ]; then
1008 echo -e $YELLOW"This test case may not work with selected test env file. TEST_ENV_PROFILE is missing in test_env file or SUPPORTED_PROFILES is missing in test case file"$EYELLOW
1011 for prof in $SUPPORTED_PROFILES; do
1012 if [ "$TEST_ENV_PROFILE" == "$prof" ]; then
1013 echo -e $GREEN"Test case supports the selected test env file"$EGREEN
1017 if [ $found_profile -ne 1 ]; then
1018 echo -e $RED"Test case does not support the selected test env file"$ERED
1019 echo "Profile: "$TEST_ENV_PROFILE" Supported profiles: "$SUPPORTED_PROFILES
1020 echo -e $RED"Exiting...."$ERED
1025 echo -e $RED"Selected env var file does not exist: "$TEST_ENV_VAR_FILE$ERED
1026 echo " Select one of following env var file matching the intended target of the test"
1027 echo " Restart the test using the flag '--env-file <path-to-env-file>"
1028 ls $AUTOTEST_HOME/../common/test_env* | indent1
1032 #This var need be preserved from the command line option, if set, when env var is sourced.
1033 if [ ! -z "$TMP_RIC_SIM_PREFIX" ]; then
1034 RIC_SIM_PREFIX=$TMP_RIC_SIM_PREFIX
1037 if [ -z "$PROJECT_IMAGES_APP_NAMES" ]; then
1038 echo -e $RED"Var PROJECT_IMAGES_APP_NAMES must be defined in: "$TEST_ENV_VAR_FILE $ERED
1042 if [[ $SUPPORTED_RUNMODES != *"$RUNMODE"* ]]; then
1043 echo -e $RED"This test script does not support RUNMODE $RUNMODE"$ERED
1044 echo "Supported RUNMODEs: "$SUPPORTED_RUNMODES
1048 # Choose list of included apps depending on run-mode
1049 if [ $RUNMODE == "KUBE" ]; then
1050 INCLUDED_IMAGES=$KUBE_INCLUDED_IMAGES
1052 INCLUDED_IMAGES=$DOCKER_INCLUDED_IMAGES
1056 # auto adding system apps
1058 echo -e $BOLD"Auto adding system apps"$EBOLD
1059 if [ $RUNMODE == "KUBE" ]; then
1060 INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_KUBE_SYSTEM_APPS
1061 TMP_APPS=$TESTENV_KUBE_SYSTEM_APPS
1063 INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_DOCKER_SYSTEM_APPS
1064 TMP_APPS=$TESTENV_DOCKER_SYSTEM_APPS
1066 if [ ! -z "$TMP_APPS" ]; then
1067 for iapp in "$TMP_APPS"; do
1068 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
1069 file_pointer="../common/"$file_pointer"_api_functions.sh"
1071 while [ ${#padded_iapp} -lt 16 ]; do
1072 padded_iapp=$padded_iapp" "
1074 echo " Auto-adding system app $padded_iapp Sourcing $file_pointer"
1076 if [ $? -ne 0 ]; then
1077 echo " Include file $file_pointer contain errors. Exiting..."
1080 __added_apps=" $iapp "$__added_apps
1086 if [ $RUNMODE == "KUBE" ]; then
1087 TMP_APPS=$INCLUDED_IMAGES" "$KUBE_PRESTARTED_IMAGES
1089 TMP_APPS=$INCLUDED_IMAGES
1092 echo -e $BOLD"Auto adding included apps"$EBOLD
1093 for iapp in $TMP_APPS; do
1094 if [[ "$__added_apps" != *"$iapp"* ]]; then
1095 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
1096 file_pointer="../common/"$file_pointer"_api_functions.sh"
1098 while [ ${#padded_iapp} -lt 16 ]; do
1099 padded_iapp=$padded_iapp" "
1101 echo " Auto-adding included app $padded_iapp Sourcing $file_pointer"
1102 if [ ! -f "$file_pointer" ]; then
1103 echo " Include file $file_pointer for app $iapp does not exist"
1107 if [ $? -ne 0 ]; then
1108 echo " Include file $file_pointer contain errors. Exiting..."
1115 echo -e $BOLD"Test environment info"$EBOLD
1117 # Check needed installed sw
1120 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1121 echo -e $RED"bash is required to run the test environment, pls install"$ERED
1124 echo " bash is installed and using version:"
1125 echo "$(bash --version)" | indent2
1127 tmp=$(which python3)
1128 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1129 echo -e $RED"python3 is required to run the test environment, pls install"$ERED
1132 echo " python3 is installed and using version: $(python3 --version)"
1135 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1136 echo -e $RED"docker is required to run the test environment, pls install"$ERED
1139 echo " docker is installed and using versions:"
1140 echo " $(docker version --format 'Client version {{.Client.Version}} Server version {{.Server.Version}}')"
1142 if [ $RUNMODE == "DOCKER" ]; then
1143 tmp=$(which docker-compose)
1144 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
1145 echo -e $RED"docker-compose is required to run the test environment, pls install"$ERED
1148 tmp=$(docker-compose version)
1149 echo " docker-compose installed and using version $tmp"
1150 if [[ "$tmp" == *'v2'* ]]; then
1151 DOCKER_COMPOSE_VERSION="V2"
1155 if [ $RUNMODE == "KUBE" ]; then
1156 tmp=$(which kubectl)
1157 if [ $? -ne 0 ] || [ -z tmp ]; then
1158 echo -e $RED"kubectl is required to run the test environment in kubernetes mode, pls install"$ERED
1161 echo " kubectl is installed and using versions:"
1162 echo $(kubectl $KUBECONF version --short=true) | indent2
1163 res=$(kubectl $KUBECONF cluster-info 2>&1)
1164 if [ $? -ne 0 ]; then
1165 echo -e "$BOLD$RED############################################# $ERED$EBOLD"
1166 echo -e $BOLD$RED"Command 'kubectl '$KUBECONF' cluster-info' returned error $ERED$EBOLD"
1167 echo -e "$BOLD$RED############################################# $ERED$EBOLD"
1169 echo "kubectl response:"
1172 echo "This script may have been started with user with no permission to run kubectl"
1173 echo "Try running with 'sudo', set env KUBECONFIG or set '--kubeconfig' parameter"
1174 echo "Do either 1, 2 or 3 "
1177 echo "Run with sudo"
1178 echo -e $BOLD"sudo <test-script-and-parameters>"$EBOLD
1181 echo "Export KUBECONFIG and pass env to sudo - (replace user)"
1182 echo -e $BOLD"export KUBECONFIG='/home/<user>/.kube/config'"$EBOLD
1183 echo -e $BOLD"sudo -E <test-script-and-parameters>"$EBOLD
1186 echo "Set KUBECONFIG via script parameter"
1187 echo -e $BOLD"sudo ... --kubeconfig /home/<user>/.kube/<config-file> ...."$EBOLD
1188 echo "The config file need to downloaded from the cluster"
1192 echo " Node(s) and container runtime config"
1193 kubectl $KUBECONF get nodes -o wide | indent2
1195 if [ -z "$HOST_PATH_BASE_DIR" ]; then
1196 HOST_PATH_BASE_DIR="/tmp"
1197 echo " Persistent volumes will be mounted to $HOST_PATH_BASE_DIR on applicable node"
1198 echo " No guarantee that persistent volume data is available on all nodes in the cluster"
1200 echo "Persistent volumes will be mounted to base dir: $HOST_PATH_BASE_DIR"
1201 echo "Assuming this dir is mounted from each node to a dir on the localhost or other"
1202 echo "file system available to all nodes"
1209 echo -e $BOLD"Checking configured image setting for this test case"$EBOLD
1211 #Temp var to check for image variable name errors
1213 #Create a file with image info for later printing as a table
1214 image_list_file="./tmp/.image-list"
1215 echo -e "Application\tApp short name\tImage\ttag\ttag-switch" > $image_list_file
1217 # Check if image env var is set and if so export the env var with image to use (used by docker compose files)
1218 # arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>
1219 __check_and_create_image_var() {
1221 if [ $# -ne 6 ]; then
1222 echo "Expected arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>"
1227 __check_included_image $1
1228 if [ $? -ne 0 ]; then
1229 echo -e "$6\t$1\t<image-excluded>\t<no-tag>" >> $image_list_file
1230 # Image is excluded since the corresponding app is not used in this test
1233 tmp=${6}"\t"${1}"\t"
1234 #Create var from the input var names
1239 optional_image_repo_target=""
1241 if [ -z $image ]; then
1242 __check_ignore_image $1
1243 if [ $? -eq 0 ]; then
1245 if [ -z "$6" ]; then
1246 app_ds="<app ignored>"
1248 echo -e "$app_ds\t$1\t<image-ignored>\t<no-tag>" >> $image_list_file
1249 # Image is ignored since the corresponding the images is not set in the env file
1250 __remove_included_image $1 # Remove the image from the list of included images
1253 echo -e $RED"\$"$3" not set in $TEST_ENV_VAR_FILE"$ERED
1256 tmp=$tmp"<no-image>\t"
1259 optional_image_repo_target=$image
1261 #Add repo depending on image type
1262 if [ "$5" == "REMOTE_RELEASE" ]; then
1263 image=$NEXUS_RELEASE_REPO$image
1265 if [ "$5" == "REMOTE" ]; then
1266 image=$NEXUS_STAGING_REPO$image
1268 if [ "$5" == "REMOTE_SNAPSHOT" ]; then
1269 image=$NEXUS_SNAPSHOT_REPO$image
1271 if [ "$5" == "REMOTE_PROXY" ]; then
1272 image=$NEXUS_PROXY_REPO$image
1274 if [ "$5" == "REMOTE_RELEASE_ONAP" ]; then
1275 image=$NEXUS_RELEASE_REPO_ONAP$image
1277 if [ "$5" == "REMOTE_RELEASE_ORAN" ]; then
1278 image=$NEXUS_RELEASE_REPO_ORAN$image
1280 #No nexus repo added for local images, tag: LOCAL and other tags
1283 if [ -z $tag ]; then
1284 echo -e $RED"\$"$tmptag" not set in $TEST_ENV_VAR_FILE"$ERED
1287 tmp=$tmp"<no-tag>\t"
1292 echo -e "$tmp" >> $image_list_file
1294 export "${2}"=$image":"$tag #Note, this var may be set to the value of the target value below in __check_and_pull_image
1296 remote_or_local_push=false
1297 if [ ! -z "$IMAGE_REPO_ADR" ] && [[ $5 != *"PROXY"* ]]; then
1298 if [ $5 == "LOCAL" ]; then
1299 remote_or_local_push=true
1301 if [[ $5 == *"REMOTE"* ]]; then
1302 if [ "$IMAGE_REPO_POLICY" == "remote" ]; then
1303 remote_or_local_push=true
1307 if $remote_or_local_push; then # Only re-tag and push images according to policy, if repo is given
1308 export "${2}_SOURCE"=$image":"$tag #Var to keep the actual source image
1309 if [[ $optional_image_repo_target == *"/"* ]]; then # Replace all / with _ for images to push to external repo
1310 optional_image_repo_target_tmp=${optional_image_repo_target//\//_}
1311 optional_image_repo_target=$optional_image_repo_target_tmp
1313 export "${2}_TARGET"=$IMAGE_REPO_ADR"/"$optional_image_repo_target":"$tag #Create image + tag for optional image repo - pushed later if needed
1315 export "${2}_SOURCE"=""
1316 export "${2}_TARGET"=""
1320 # Check if app uses image included in this test run
1321 # Returns 0 if image is included, 1 if not
1322 __check_included_image() {
1323 for im in $INCLUDED_IMAGES; do
1324 if [ "$1" == "$im" ]; then
1331 # Check if app uses a project image
1332 # Returns 0 if image is included, 1 if not
1333 __check_project_image() {
1334 for im in $PROJECT_IMAGES; do
1335 if [ "$1" == "$im" ]; then
1342 # Check if app uses image built by the test script
1343 # Returns 0 if image is included, 1 if not
1344 __check_image_local_build() {
1345 for im in $LOCAL_IMAGE_BUILD; do
1346 if [ "$1" == "$im" ]; then
1353 # Check if app image is conditionally ignored in this test run
1354 # Returns 0 if image is conditionally ignored, 1 if not
1355 __check_ignore_image() {
1356 for im in $CONDITIONALLY_IGNORED_IMAGES; do
1357 if [ "$1" == "$im" ]; then
1364 # Removed image from included list of included images
1365 # Used when an image is marked as conditionally ignored
1366 __remove_included_image() {
1368 for im in $INCLUDED_IMAGES; do
1369 if [ "$1" != "$im" ]; then
1370 tmp_img_rem_list=$tmp_img_rem_list" "$im
1373 INCLUDED_IMAGES=$tmp_img_rem_list
1377 # Check if app is included in the prestarted set of apps
1378 # Returns 0 if image is included, 1 if not
1379 __check_prestarted_image() {
1380 for im in $KUBE_PRESTARTED_IMAGES; do
1381 if [ "$1" == "$im" ]; then
1388 # Check if an app shall use a local image, based on the cmd parameters
1389 __check_image_local_override() {
1390 for im in $USE_LOCAL_IMAGES; do
1391 if [ "$1" == "$im" ]; then
1398 # Check if app uses image override
1399 # Returns the image/tag suffix LOCAL for local image or REMOTE/REMOTE_RELEASE/REMOTE_SNAPSHOT for staging/release/snapshot image
1400 __check_image_override() {
1402 for im in $ORAN_IMAGES_APP_NAMES; do
1403 if [ "$1" == "$im" ]; then
1404 echo "REMOTE_RELEASE_ORAN"
1409 for im in $ONAP_IMAGES_APP_NAMES; do
1410 if [ "$1" == "$im" ]; then
1411 echo "REMOTE_RELEASE_ONAP"
1417 for im in $PROJECT_IMAGES_APP_NAMES; do
1418 if [ "$1" == "$im" ]; then
1423 if [ $found -eq 0 ]; then
1429 if [ $IMAGE_CATEGORY == "RELEASE" ]; then
1430 suffix="REMOTE_RELEASE"
1432 if [ $IMAGE_CATEGORY == "DEV" ]; then
1436 for im in $USE_STAGING_IMAGES; do
1437 if [ "$1" == "$im" ]; then
1442 for im in $USE_RELEASE_IMAGES; do
1443 if [ "$1" == "$im" ]; then
1444 suffix="REMOTE_RELEASE"
1448 for im in $USE_SNAPSHOT_IMAGES; do
1449 if [ "$1" == "$im" ]; then
1450 suffix="REMOTE_SNAPSHOT"
1454 for im in $USE_LOCAL_IMAGES; do
1455 if [ "$1" == "$im" ]; then
1460 for im in $USE_EXTERNAL_IMAGES; do
1461 if [ "$1" == "$im" ]; then
1467 if [ $CTR -gt 1 ]; then
1473 # Function to re-tag and image and push to another image repo
1474 __retag_and_push_image() {
1475 if [ ! -z "$IMAGE_REPO_ADR" ]; then
1476 source_image="${!1}"
1477 trg_var_name=$1_"TARGET" # This var is created in func __check_and_create_image_var
1478 target_image="${!trg_var_name}"
1480 if [ -z $target_image ]; then
1481 return 0 # Image with no target shall not be pushed
1484 echo -ne " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1485 tmp=$(docker image tag $source_image ${target_image} )
1486 if [ $? -ne 0 ]; then
1487 docker stop $tmp &> ./tmp/.dockererr
1490 echo -e " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1491 cat ./tmp/.dockererr
1494 echo -e " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1496 echo -ne " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1497 tmp=$(docker push ${target_image} )
1498 if [ $? -ne 0 ]; then
1499 docker stop $tmp &> ./tmp/.dockererr
1502 echo -e " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1503 cat ./tmp/.dockererr
1506 echo -e " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1508 export "${1}"=$target_image
1513 #Function to check if image exist and stop+remove the container+pull new images as needed
1514 #args <script-start-arg> <descriptive-image-name> <container-base-name> <image-with-tag-var-name>
1515 __check_and_pull_image() {
1517 source_image="${!4}"
1519 echo -e " Checking $BOLD$2$EBOLD container(s) with basename: $BOLD$3$EBOLD using image: $BOLD$source_image$EBOLD"
1520 format_string="\"{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\""
1521 tmp_im=$(docker images --format $format_string $source_image)
1523 if [ $1 == "local" ]; then
1524 if [ -z "$tmp_im" ]; then
1525 echo -e " "$2" (local image): \033[1m"$source_image"\033[0m $RED does not exist in local registry, need to be built (or manually pulled)"$ERED
1529 echo -e " "$2" (local image): \033[1m"$source_image"\033[0m "$GREEN"OK"$EGREEN
1531 elif [ $1 == "remote" ] || [ $1 == "remote-remove" ]; then
1532 if [ $1 == "remote-remove" ]; then
1533 if [ $RUNMODE == "DOCKER" ]; then
1534 echo -ne " Attempt to stop and remove container(s), if running - ${SAMELINE}"
1535 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME})
1536 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1537 docker stop $tmp &> ./tmp/.dockererr
1538 if [ $? -ne 0 ]; then
1541 echo -e $RED" Container(s) could not be stopped - try manual stopping the container(s)"$ERED
1542 cat ./tmp/.dockererr
1546 echo -ne " Attempt to stop and remove container(s), if running - "$GREEN"stopped"$EGREEN"${SAMELINE}"
1547 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME}) &> /dev/null
1548 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1549 docker rm $tmp &> ./tmp/.dockererr
1550 if [ $? -ne 0 ]; then
1553 echo -e $RED" Container(s) could not be removed - try manual removal of the container(s)"$ERED
1554 cat ./tmp/.dockererr
1558 echo -e " Attempt to stop and remove container(s), if running - "$GREEN"stopped removed"$EGREEN
1564 if [ -z "$tmp_im" ]; then
1565 echo -ne " Pulling image${SAMELINE}"
1566 out=$(docker pull $source_image)
1567 if [ $? -ne 0 ]; then
1569 echo -e " Pulling image -$RED could not be pulled"$ERED
1571 echo $out > ./tmp/.dockererr
1575 echo $out > ./tmp/.dockererr
1576 if [[ $out == *"up to date"* ]]; then
1577 echo -e " Pulling image -$GREEN Image is up to date $EGREEN"
1578 elif [[ $out == *"Downloaded newer image"* ]]; then
1579 echo -e " Pulling image -$GREEN Newer image pulled $EGREEN"
1581 echo -e " Pulling image -$GREEN Pulled $EGREEN"
1584 echo -e " Pulling image -$GREEN OK $EGREEN(exists in local repository)"
1588 __retag_and_push_image $4
1593 setup_testenvironment() {
1594 # Check that image env setting are available
1597 # Image var setup for all project images included in the test
1598 for imagename in $APP_SHORT_NAMES; do
1599 __check_included_image $imagename
1601 __check_project_image $imagename
1603 if [ $incl -eq 0 ]; then
1604 if [ $proj -eq 0 ]; then
1605 IMAGE_SUFFIX=$(__check_image_override $imagename)
1606 if [ $? -ne 0 ]; then
1607 echo -e $RED"Image setting from cmd line not consistent for $imagename."$ERED
1613 # A function name is created from the app short name
1614 # for example app short name 'ICS' -> produce the function
1615 # name __ICS_imagesetup
1616 # This function is called and is expected to exist in the imported
1617 # file for the ics test functions
1618 # The resulting function impl will call '__check_and_create_image_var' function
1619 # with appropriate parameters
1620 # If the image suffix is none, then the component decides the suffix
1621 function_pointer="__"$imagename"_imagesetup"
1622 $function_pointer $IMAGE_SUFFIX
1624 function_pointer="__"$imagename"_test_requirements"
1629 #Errors in image setting - exit
1630 if [ $IMAGE_ERR -ne 0 ]; then
1634 #Print a tables of the image settings
1635 echo -e $BOLD"Images configured for start arg: "$START_ARG $EBOLD
1636 column -t -s $'\t' $image_list_file | indent1
1640 #Set the SIM_GROUP var
1641 echo -e $BOLD"Setting var to main dir of all container/simulator scripts"$EBOLD
1642 if [ -z "$SIM_GROUP" ]; then
1643 SIM_GROUP=$AUTOTEST_HOME/../simulator-group
1644 if [ ! -d $SIM_GROUP ]; then
1645 echo "Trying to set env var SIM_GROUP to dir 'simulator-group' in the nontrtric repo, but failed."
1646 echo -e $RED"Please set the SIM_GROUP manually in the applicable $TEST_ENV_VAR_FILE"$ERED
1649 echo " SIM_GROUP auto set to: " $SIM_GROUP
1651 elif [ $SIM_GROUP = *simulator_group ]; then
1652 echo -e $RED"Env var SIM_GROUP does not seem to point to dir 'simulator-group' in the repo, check $TEST_ENV_VAR_FILE"$ERED
1655 echo " SIM_GROUP env var already set to: " $SIM_GROUP
1660 #Temp var to check for image pull errors
1664 echo -e $BOLD"Deleting namespaces"$EBOLD
1667 if [ "$DELETE_KUBE_NAMESPACES" -eq 1 ]; then
1668 test_env_namespaces=$(kubectl $KUBECONF get ns --no-headers -o custom-columns=":metadata.name" -l autotest=engine) #Get list of ns created by the test env
1669 if [ $? -ne 0 ]; then
1670 echo " Cannot get list of namespaces...ignoring delete"
1672 for test_env_ns in $test_env_namespaces; do
1673 __kube_delete_namespace $test_env_ns
1677 echo " Namespace delete option not set or ignored"
1682 echo -e $BOLD"Deleting containers"$EBOLD
1684 if [ "$DELETE_CONTAINERS" -eq 1 ]; then
1685 echo " Stopping containers label 'nrttest_app'..."
1686 docker stop $(docker ps -qa --filter "label=nrttest_app") 2> /dev/null
1687 echo " Removing stopped containers..."
1688 docker rm $(docker ps -qa --filter "label=nrttest_app") 2> /dev/null
1690 echo " Contatiner delete option not set or ignored"
1694 # The following sequence pull the configured images
1695 echo -e $BOLD"Pulling configured images, if needed"$EBOLD
1696 if [ ! -z "$IMAGE_REPO_ADR" ] && [ $IMAGE_REPO_POLICY == "local" ]; then
1697 echo -e $YELLOW" Excluding all remote image check/pull when running with image repo: $IMAGE_REPO_ADR and image policy $IMAGE_REPO_POLICY"$EYELLOW
1699 for imagename in $APP_SHORT_NAMES; do
1700 __check_included_image $imagename
1702 __check_project_image $imagename
1704 if [ $incl -eq 0 ]; then
1705 if [ $proj -eq 0 ]; then
1706 START_ARG_MOD=$START_ARG
1707 __check_image_local_override $imagename
1708 if [ $? -eq 1 ]; then
1709 START_ARG_MOD="local"
1712 START_ARG_MOD=$START_ARG
1714 __check_image_local_build $imagename
1715 #No pull of images built locally
1716 if [ $? -ne 0 ]; then
1717 # A function name is created from the app short name
1718 # for example app short name 'HTTPPROXY' -> produce the function
1719 # name __HTTPPROXY_imagesetup
1720 # This function is called and is expected to exist in the imported
1721 # file for the httpproxy test functions
1722 # The resulting function impl will call '__check_and_pull_image' function
1723 # with appropriate parameters
1724 function_pointer="__"$imagename"_imagepull"
1725 $function_pointer $START_ARG_MOD $START_ARG
1728 echo -e $YELLOW" Excluding $imagename image from image check/pull"$EYELLOW
1733 #Errors in image setting - exit
1734 if [ $IMAGE_ERR -ne 0 ]; then
1736 echo "#################################################################################################"
1737 echo -e $RED"One or more images could not be pulled or containers using the images could not be stopped/removed"$ERED
1738 echo -e $RED"Or local image, overriding remote image, does not exist"$ERED
1739 if [ $IMAGE_CATEGORY == "DEV" ]; then
1741 echo -e $RED"Note that SNAPSHOT and staging images may be purged from nexus after a certain period."$ERED
1742 echo -e $RED"In addition, the image may not have been updated in the current release so no SNAPSHOT or staging image exists"$ERED
1743 echo -e $RED"In these cases, switch to use a released image instead, use the flag '--use-release-image <App-short-name>'"$ERED
1744 echo -e $RED"Use the 'App-short-name' for the applicable image from the above table: 'Images configured for start arg'."$ERED
1746 echo "#################################################################################################"
1753 echo -e $BOLD"Building images needed for test"$EBOLD
1755 for imagename in $APP_SHORT_NAMES; do
1756 cd $AUTOTEST_HOME #Always reset to orig dir
1757 __check_image_local_build $imagename
1758 if [ $? -eq 0 ]; then
1759 __check_included_image $imagename
1760 if [ $? -eq 0 ]; then
1761 # A function name is created from the app short name
1762 # for example app short name 'MR' -> produce the function
1763 # name __MR_imagebuild
1764 # This function is called and is expected to exist in the imported
1765 # file for the mr test functions
1766 # The resulting function impl shall build the imagee
1767 function_pointer="__"$imagename"_imagebuild"
1771 echo -e $YELLOW" Excluding image for app $imagename from image build"$EYELLOW
1776 cd $AUTOTEST_HOME # Just to make sure...
1780 # Create a table of the images used in the script - from local repo
1781 echo -e $BOLD"Local docker registry images used in this test script"$EBOLD
1783 docker_tmp_file=./tmp/.docker-images-table
1784 format_string="{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\\t{{.CreatedAt}}"
1785 echo -e "Application\tRepository\tTag\tCreated since\tSize\tCreated at" > $docker_tmp_file
1787 for imagename in $APP_SHORT_NAMES; do
1788 __check_included_image $imagename
1789 if [ $? -eq 0 ]; then
1790 # Only print image data if image repo is null, or if image repo is set and image is local
1792 if [ -z "$IMAGE_REPO_ADR" ]; then
1795 __check_image_local_build $imagename
1796 if [ $? -eq 0 ]; then
1800 if [ $print_image_data -eq 1 ]; then
1801 # A function name is created from the app short name
1802 # for example app short name 'MR' -> produce the function
1803 # name __MR_imagebuild
1804 # This function is called and is expected to exist in the imported
1805 # file for the mr test functions
1806 # The resulting function impl shall build the imagee
1807 function_pointer="__"$imagename"_image_data"
1808 $function_pointer "$format_string" $docker_tmp_file
1813 column -t -s $'\t' $docker_tmp_file | indent1
1817 if [ ! -z "$IMAGE_REPO_ADR" ]; then
1819 # Create a table of the images used in the script - from remote repo
1820 echo -e $BOLD"Remote repo images used in this test script"$EBOLD
1821 echo -e $YELLOW"-- Note: These image will be pulled when the container starts. Images not managed by the test engine --"$EYELLOW
1823 docker_tmp_file=./tmp/.docker-images-table
1824 format_string="{{.Repository}}\\t{{.Tag}}"
1825 echo -e "Application\tRepository\tTag" > $docker_tmp_file
1827 for imagename in $APP_SHORT_NAMES; do
1828 __check_included_image $imagename
1829 if [ $? -eq 0 ]; then
1830 # Only print image data if image repo is null, or if image repo is set and image is local
1831 __check_image_local_build $imagename
1832 if [ $? -ne 0 ]; then
1833 # A function name is created from the app short name
1834 # for example app short name 'MR' -> produce the function
1835 # name __MR_imagebuild
1836 # This function is called and is expected to exist in the imported
1837 # file for the mr test functions
1838 # The resulting function impl shall build the imagee
1839 function_pointer="__"$imagename"_image_data"
1840 $function_pointer "$format_string" $docker_tmp_file
1845 column -t -s $'\t' $docker_tmp_file | indent1
1850 if [ $RUNMODE == "KUBE" ]; then
1852 echo "================================================================================="
1853 echo "================================================================================="
1855 if [ -z "$IMAGE_REPO_ADR" ]; then
1856 echo -e $YELLOW" The image pull policy is set to 'Never' - assuming a local image repo is available for all images"$EYELLOW
1857 echo -e " This setting only works on single node clusters on the local machine"
1858 echo -e " It does not work with multi-node clusters or remote clusters. "
1859 export KUBE_IMAGE_PULL_POLICY="Never"
1861 echo -e $YELLOW" The image pull policy is set to 'Always'"$EYELLOW
1862 echo -e " This setting work on local clusters, multi-node clusters and remote cluster. "
1863 echo -e " Only locally built images are managed. Remote images are always pulled from remote repos"
1864 echo -e " Pulling remote snapshot or staging images my in some case result in pulling newer image versions outside the control of the test engine"
1865 export KUBE_IMAGE_PULL_POLICY="Always"
1867 #CLUSTER_IP=$(kubectl $KUBECONF config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
1868 #echo -e $YELLOW" The cluster hostname/ip is: $CLUSTER_IP"$EYELLOW
1870 echo "================================================================================="
1871 echo "================================================================================="
1875 echo -e $BOLD"======================================================="$EBOLD
1876 echo -e $BOLD"== Common test setup completed - test script begins =="$EBOLD
1877 echo -e $BOLD"======================================================="$EBOLD
1882 for imagename in $APP_SHORT_NAMES; do
1883 __check_included_image $imagename
1885 __check_prestarted_image $imagename
1887 if [ $retcode_i -eq 0 ] || [ $retcode_p -eq 0 ]; then
1888 # A function name is created from the app short name
1889 # for example app short name 'RICMSIM' -> produce the function
1890 # name __RICSIM__initial_setup
1891 # This function is called and is expected to exist in the imported
1892 # file for the ricsim test functions
1893 # The resulting function impl shall perform initial setup of port, host etc
1895 function_pointer="__"$imagename"_initial_setup"
1898 function_pointer="__"$imagename"_statisics_setup"
1899 LOG_STAT_ARGS=$LOG_STAT_ARGS" "$($function_pointer)
1903 if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1904 ../common/genstat.sh $RUNMODE $SECONDS $TESTLOGS/$ATC/stat_data.csv $LOG_STAT_ARGS &
1905 COLLECT_RUNTIME_STATS_PID=$!
1910 # Function to print the test result, shall be the last cmd in a test script
1912 # (Function for test scripts)
1916 duration=$((TCTEST_END-TCTEST_START))
1918 echo "-------------------------------------------------------------------------------------------------"
1919 echo "------------------------------------- Test case: "$ATC
1920 echo "------------------------------------- Ended: "$(date)
1921 echo "-------------------------------------------------------------------------------------------------"
1922 echo "-- Description: "$TC_ONELINE_DESCR
1923 echo "-- Execution time: " $duration " seconds"
1924 echo "-- Used env file: "$TEST_ENV_VAR_FILE
1925 echo "-------------------------------------------------------------------------------------------------"
1926 echo "------------------------------------- RESULTS"
1930 if [ $RES_DEVIATION -gt 0 ]; then
1931 echo "Test case deviations"
1932 echo "===================================="
1936 echo "Timer measurement in the test script"
1937 echo "===================================="
1938 column -t -s $'\t' $TIMER_MEASUREMENTS
1939 if [ $RES_PASS != $RES_TEST ]; then
1940 echo -e $RED"Measurement may not be reliable when there are failed test - failures may cause long measurement values due to timeouts etc."$ERED
1944 if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1945 echo "Runtime statistics collected in file: "$TESTLOGS/$ATC/stat_data.csv
1949 total=$((RES_PASS+RES_FAIL))
1950 if [ $RES_TEST -eq 0 ]; then
1951 echo -e "\033[1mNo tests seem to have been executed. Check the script....\033[0m"
1952 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1953 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1954 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1955 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1956 elif [ $total != $RES_TEST ]; then
1957 echo -e "\033[1mTotal number of tests does not match the sum of passed and failed tests. Check the script....\033[0m"
1958 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1959 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1960 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1961 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1962 elif [ $RES_CONF_FAIL -ne 0 ]; then
1963 echo -e "\033[1mOne or more configurations has failed. Check the script log....\033[0m"
1964 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1965 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1966 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1967 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1968 elif [ $RES_PASS = $RES_TEST ]; then
1969 echo -e "All tests \033[32m\033[1mPASS\033[0m"
1970 echo -e "\033[32m\033[1m ___ _ ___ ___ \033[0m"
1971 echo -e "\033[32m\033[1m | _ \/_\ / __/ __| \033[0m"
1972 echo -e "\033[32m\033[1m | _/ _ \\__ \__ \\ \033[0m"
1973 echo -e "\033[32m\033[1m |_|/_/ \_\___/___/ \033[0m"
1976 # Update test suite counter
1977 if [ -f .tmp_tcsuite_pass_ctr ]; then
1978 tmpval=$(< .tmp_tcsuite_pass_ctr)
1980 echo $tmpval > .tmp_tcsuite_pass_ctr
1982 if [ -f .tmp_tcsuite_pass ]; then
1983 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_pass
1985 #Create file with OK exit code
1986 echo "0" > "$AUTOTEST_HOME/.result$ATC.txt"
1987 echo "0" > "$TESTLOGS/$ATC/.result$ATC.txt"
1989 echo -e "One or more tests with status \033[31m\033[1mFAIL\033[0m "
1990 echo -e "\033[31m\033[1m ___ _ ___ _ \033[0m"
1991 echo -e "\033[31m\033[1m | __/_\ |_ _| | \033[0m"
1992 echo -e "\033[31m\033[1m | _/ _ \ | || |__ \033[0m"
1993 echo -e "\033[31m\033[1m |_/_/ \_\___|____|\033[0m"
1995 # Update test suite counter
1996 if [ -f .tmp_tcsuite_fail_ctr ]; then
1997 tmpval=$(< .tmp_tcsuite_fail_ctr)
1999 echo $tmpval > .tmp_tcsuite_fail_ctr
2001 if [ -f .tmp_tcsuite_fail ]; then
2002 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_fail
2006 echo "++++ Number of tests: "$RES_TEST
2007 echo "++++ Number of passed tests: "$RES_PASS
2008 echo "++++ Number of failed tests: "$RES_FAIL
2010 echo "++++ Number of failed configs: "$RES_CONF_FAIL
2012 echo "++++ Number of test case deviations: "$RES_DEVIATION
2014 echo "------------------------------------- Test case complete ---------------------------------"
2015 echo "-------------------------------------------------------------------------------------------------"
2019 #####################################################################
2020 ###### Functions for start, configuring, stoping, cleaning etc ######
2021 #####################################################################
2023 # Start timer for time measurement
2024 # args: <timer message to print> - timer value and message will be printed both on screen
2025 # and in the timer measurement report - if at least one "print_timer is called"
2027 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
2028 TC_TIMER_STARTTIME=$SECONDS
2029 TC_TIMER_TIMER_TEXT="${@:1}"
2030 if [ $# -ne 1 ]; then
2031 __print_err "need 1 arg, <timer message to print>" $@
2032 TC_TIMER_TIMER_TEXT=${FUNCNAME[0]}":"${BASH_LINENO[0]}
2033 echo " Assigning timer name: "$TC_TIMER_TIMER_TEXT
2035 TC_TIMER_CURRENT_FAILS=$(($RES_FAIL+$RES_CONF_FAIL))
2036 echo " Timer started: $(date)"
2039 # Print the running timer the value of the time (in seconds)
2040 # Timer value and message will be printed both on screen and in the timer measurement report
2042 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $TC_TIMER_TIMER_TEXT $EBOLD
2043 if [ -z "$TC_TIMER_STARTTIME" ]; then
2044 __print_err "timer not started" $@
2047 duration=$(($SECONDS-$TC_TIMER_STARTTIME))
2048 if [ $duration -eq 0 ]; then
2049 duration="<1 second"
2051 duration=$duration" seconds"
2053 echo " Timer duration :" $duration
2055 if [ $(($RES_FAIL+$RES_CONF_FAIL)) -ne $TC_TIMER_CURRENT_FAILS ]; then
2056 res="Failures occured during test - timer not reliabled"
2059 echo -e "$TC_TIMER_TIMER_TEXT \t $duration \t $res" >> $TIMER_MEASUREMENTS
2062 # Print info about a deviations from intended tests
2063 # Each deviation counted is also printed in the testreport
2064 # args <deviation message to print>
2066 echo -e $BOLD"DEVIATION(${BASH_LINENO[0]}): "${FUNCNAME[0]} $EBOLD
2067 if [ $# -lt 1 ]; then
2069 __print_err "need 1 or more args, <deviation message to print>" $@
2073 echo -e $BOLD$YELLOW" Test case deviation: ${@:1}"$EYELLOW$EBOLD
2074 echo "Line: ${BASH_LINENO[0]} - ${@:1}" >> $DEVIATION_FILE
2075 __print_current_stats
2079 # Stop at first FAIL test case and take all logs - only for debugging/trouble shooting
2080 __check_stop_at_error() {
2081 if [ $STOP_AT_ERROR -eq 1 ]; then
2082 echo -e $RED"Test script configured to stop at first FAIL, taking all logs and stops"$ERED
2083 store_logs "STOP_AT_ERROR"
2085 # Update test suite counter
2086 if [ -f .tmp_tcsuite_fail_ctr ]; then
2087 tmpval=$(< .tmp_tcsuite_fail_ctr)
2089 echo $tmpval > .tmp_tcsuite_fail_ctr
2091 if [ -f .tmp_tcsuite_fail ]; then
2092 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution stopped due to error" >> .tmp_tcsuite_fail
2099 # Stop and remove all containers
2101 # (Not for test scripts)
2102 __clean_containers() {
2104 echo -e $BOLD"Docker clean and stopping and removing all running containers, by container name"$EBOLD
2107 running_contr_file="./tmp/running_contr.txt"
2108 > $running_contr_file
2110 # Get list of all containers started by the test script
2111 for imagename in $APP_SHORT_NAMES; do
2112 docker ps -a --filter "label=nrttest_app=$imagename" --filter "network=$DOCKER_SIM_NWNAME" --format ' {{.Label "nrttest_dp"}}\n{{.Label "nrttest_app"}}\n{{.Names}}' >> $running_contr_file
2114 running_contr_file_empty="No docker containers running, started by previous test execution"
2115 if [ -s $running_contr_file ]; then
2116 running_contr_file_empty=""
2119 # Kill all containers started by the test env - to speed up shut down
2120 docker kill $(docker ps -a --filter "label=nrttest_app" --format '{{.Names}}') &> /dev/null
2122 tab_heading1="App display name"
2123 tab_heading2="App short name"
2124 tab_heading3="Container name"
2126 tab_heading1_len=${#tab_heading1}
2127 tab_heading2_len=${#tab_heading2}
2128 tab_heading3_len=${#tab_heading3}
2130 #Calc field lengths of each item in the list of containers
2132 if (( $cntr % 3 == 0 ));then
2133 if [ ${#p} -gt $tab_heading1_len ]; then
2134 tab_heading1_len=${#p}
2137 if (( $cntr % 3 == 1));then
2138 if [ ${#p} -gt $tab_heading2_len ]; then
2139 tab_heading2_len=${#p}
2142 if (( $cntr % 3 == 2));then
2143 if [ ${#p} -gt $tab_heading3_len ]; then
2144 tab_heading3_len=${#p}
2148 done <$running_contr_file
2150 let tab_heading1_len=tab_heading1_len+2
2151 while (( ${#tab_heading1} < $tab_heading1_len)); do
2152 tab_heading1="$tab_heading1"" "
2155 let tab_heading2_len=tab_heading2_len+2
2156 while (( ${#tab_heading2} < $tab_heading2_len)); do
2157 tab_heading2="$tab_heading2"" "
2160 let tab_heading3_len=tab_heading3_len+2
2161 while (( ${#tab_heading3} < $tab_heading3_len)); do
2162 tab_heading3="$tab_heading3"" "
2165 if [ ! -z "$running_contr_file_empty" ]; then
2166 echo $running_contr_file_empty | indent1
2168 echo " $tab_heading1$tab_heading2$tab_heading3"" Actions"
2171 if (( $cntr % 3 == 0 ));then
2174 heading_len=$tab_heading1_len
2176 if (( $cntr % 3 == 1));then
2178 heading_len=$tab_heading2_len
2180 if (( $cntr % 3 == 2));then
2183 heading_len=$tab_heading3_len
2185 while (( ${#heading} < $heading_len)); do
2186 heading="$heading"" "
2189 if (( $cntr % 3 == 2));then
2190 echo -ne $row$SAMELINE
2191 echo -ne " $row ${GREEN}stopping...${EGREEN}${SAMELINE}"
2192 docker stop $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
2193 echo -ne " $row ${GREEN}stopped removing...${EGREEN}${SAMELINE}"
2194 docker rm --force $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
2195 echo -e " $row ${GREEN}stopped removed ${EGREEN}"
2198 done <$running_contr_file
2203 echo -e $BOLD" Removing docker network"$EBOLD
2204 TMP=$(docker network ls -q --filter name=$DOCKER_SIM_NWNAME)
2205 if [ "$TMP" == $DOCKER_SIM_NWNAME ]; then
2206 docker network rm $DOCKER_SIM_NWNAME | indent2
2207 if [ $? -ne 0 ]; then
2208 echo -e $RED" Cannot remove docker network. Manually remove or disconnect containers from $DOCKER_SIM_NWNAME"$ERED
2212 echo -e "$GREEN Done$EGREEN"
2214 echo -e $BOLD" Removing all unused docker neworks"$EBOLD
2215 docker network prune --force | indent2
2216 echo -e "$GREEN Done$EGREEN"
2218 echo -e $BOLD" Removing all unused docker volumes"$EBOLD
2219 docker volume prune --force | indent2
2220 echo -e "$GREEN Done$EGREEN"
2222 echo -e $BOLD" Removing all dangling/untagged docker images"$EBOLD
2223 docker rmi --force $(docker images -q -f dangling=true) &> /dev/null
2224 echo -e "$GREEN Done$EGREEN"
2227 CONTRS=$(docker ps | awk '$1 != "CONTAINER" { n++ }; END { print n+0 }')
2228 if [ $? -eq 0 ]; then
2229 if [ $CONTRS -ne 0 ]; then
2230 echo -e $RED"Containers running, may cause distubance to the test case"$ERED
2231 docker ps -a | indent1
2237 ###################################
2238 ### Functions for kube management
2239 ###################################
2241 # Get resource type for scaling
2242 # args: <resource-name> <namespace>
2243 __kube_get_resource_type() {
2244 kubectl $KUBECONF get deployment $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
2245 if [ $? -eq 0 ]; then
2249 kubectl $KUBECONF get sts $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
2250 if [ $? -eq 0 ]; then
2254 echo "unknown-resource-type"
2258 # Scale a kube resource to a specific count
2259 # args: <resource-type> <resource-name> <namespace> <target-count>
2260 # (Not for test scripts)
2262 echo -ne " Setting $1 $2 replicas=$4 in namespace $3"$SAMELINE
2263 kubectl $KUBECONF scale $1 $2 -n $3 --replicas=$4 1> /dev/null 2> ./tmp/kubeerr
2264 if [ $? -ne 0 ]; then
2265 echo -e " Setting $1 $2 replicas=$4 in namespace $3 $RED Failed $ERED"
2267 echo " Message: $(<./tmp/kubeerr)"
2270 echo -e " Setting $1 $2 replicas=$4 in namespace $3 $GREEN OK $EGREEN"
2275 for i in {1..500}; do
2276 count=$(kubectl $KUBECONF get $1/$2 -n $3 -o jsonpath='{.status.replicas}' 2> /dev/null)
2278 if [ -z "$count" ]; then
2279 #No value is sometimes returned for some reason, in case the resource has replica 0
2282 if [ $retcode -ne 0 ]; then
2283 echo -e "$RED Cannot fetch current replica count for $1 $2 in namespace $3 $ERED"
2288 if [ $count -ne $4 ]; then
2289 echo -ne " Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds $SAMELINE"
2292 echo -e " Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds"
2293 echo -e " Replicas=$4 after $(($SECONDS-$TSTART)) seconds $GREEN OK $EGREEN"
2299 echo -e "$RED Replica count did not reach target replicas=$4. Failed with replicas=$count $ERED"
2304 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and label-id
2305 # This function does not wait for the resource to reach 0
2306 # args: <namespace> <label-name> <label-id>
2307 # (Not for test scripts)
2308 __kube_scale_all_resources() {
2312 resources="deployment replicaset statefulset"
2313 for restype in $resources; do
2314 result=$(kubectl $KUBECONF get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2315 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2316 for resid in $result; do
2317 echo -ne " Ordered caling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"$SAMELINE
2318 kubectl $KUBECONF scale $restype $resid -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
2319 echo -e " Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0 $GREEN OK $EGREEN"
2325 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and an optional label-id
2326 # This function do wait for the resource to reach 0
2327 # args: <namespace> <label-name> [ <label-id> ]
2328 # (Not for test scripts)
2329 __kube_scale_and_wait_all_resources() {
2333 if [ -z "$3" ]; then
2334 echo " Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname"
2336 echo " Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname=$labelid"
2338 resources="deployment replicaset statefulset"
2340 while [ $scaled_all -ne 0 ]; do
2342 for restype in $resources; do
2343 if [ -z "$3" ]; then
2344 result=$(kubectl $KUBECONF get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname')].metadata.name}')
2346 result=$(kubectl $KUBECONF get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2348 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2349 for resid in $result; do
2350 echo -e " Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"
2351 kubectl $KUBECONF scale $restype $resid -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
2354 while [ $count -ne 0 ]; do
2355 count=$(kubectl $KUBECONF get $restype $resid -n $namespace -o jsonpath='{.status.replicas}' 2> /dev/null)
2356 echo -ne " Scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count"$SAMELINE
2357 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
2362 duration=$(($SECONDS-$T_START))
2363 if [ $duration -gt 100 ]; then
2364 #Forcring count 0, to avoid hanging for failed scaling
2369 echo -e " Scaled $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
2376 # Remove all kube resources in a namespace for resources having a certain label and label-id
2377 # This function wait until the resources are gone. Scaling to 0 must have been ordered previously
2378 # args: <namespace> <label-name> <label-id>
2379 # (Not for test scripts)
2380 __kube_delete_all_resources() {
2384 resources="deployments replicaset statefulset services pods configmaps persistentvolumeclaims persistentvolumes serviceaccounts clusterrolebindings secrets authorizationpolicies requestauthentications"
2385 deleted_resourcetypes=""
2386 for restype in $resources; do
2387 ns_flag="-n $namespace"
2388 ns_text="in namespace $namespace"
2389 if [ $restype == "persistentvolumes" ]; then
2393 if [ $restype == "clusterrolebindings" ]; then
2397 result=$(kubectl $KUBECONF get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}' 2> /dev/null)
2398 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2399 deleted_resourcetypes=$deleted_resourcetypes" "$restype
2400 for resid in $result; do
2401 if [ $restype == "replicaset" ] || [ $restype == "statefulset" ]; then
2403 while [ $count -ne 0 ]; do
2404 count=$(kubectl $KUBECONF get $restype $resid $ns_flag -o jsonpath='{.status.replicas}' 2> /dev/null)
2405 echo -ne " Scaling $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count"$SAMELINE
2406 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
2412 echo -e " Scaled $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
2414 echo -ne " Deleting $restype $resid $ns_text with label $labelname=$labelid "$SAMELINE
2415 kubectl $KUBECONF delete --grace-period=1 $restype $resid $ns_flag 1> /dev/null 2> ./tmp/kubeerr
2416 if [ $? -eq 0 ]; then
2417 echo -e " Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN OK $EGREEN"
2419 echo -e " Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN Does not exist - OK $EGREEN"
2425 if [ ! -z "$deleted_resourcetypes" ]; then
2426 for restype in $deleted_resources; do
2427 ns_flag="-n $namespace"
2428 ns_text="in namespace $namespace"
2429 if [ $restype == "persistentvolumes" ]; then
2433 echo -ne " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted..."$SAMELINE
2436 while [ ! -z "$result" ]; do
2438 result=$(kubectl $KUBECONF get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2439 echo -ne " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds "$SAMELINE
2440 if [ -z "$result" ]; then
2441 echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $GREEN OK $EGREEN"
2442 elif [ $(($SECONDS-$T_START)) -gt 300 ]; then
2443 echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $RED Failed $ERED"
2451 # Creates a namespace if it does not exists
2453 # (Not for test scripts)
2454 __kube_create_namespace() {
2456 #Check if test namespace exists, if not create it
2457 kubectl $KUBECONF get namespace $1 1> /dev/null 2> ./tmp/kubeerr
2458 if [ $? -ne 0 ]; then
2459 echo -ne " Creating namespace "$1 $SAMELINE
2460 kubectl $KUBECONF create namespace $1 1> /dev/null 2> ./tmp/kubeerr
2461 if [ $? -ne 0 ]; then
2462 echo -e " Creating namespace $1 $RED$BOLD FAILED $EBOLD$ERED"
2464 echo " Message: $(<./tmp/kubeerr)"
2467 kubectl $KUBECONF label ns $1 autotest=engine > /dev/null
2468 echo -e " Creating namespace $1 $GREEN$BOLD OK $EBOLD$EGREEN"
2471 echo -e " Creating namespace $1 $GREEN$BOLD Already exists, OK $EBOLD$EGREEN"
2476 # Removes a namespace if it exists
2478 # (Not for test scripts)
2479 __kube_delete_namespace() {
2481 #Check if test namespace exists, if so remove it
2482 kubectl $KUBECONF get namespace $1 1> /dev/null 2> ./tmp/kubeerr
2483 if [ $? -eq 0 ]; then
2484 echo -ne " Removing namespace "$1 $SAMELINE
2485 kubectl $KUBECONF delete namespace $1 1> /dev/null 2> ./tmp/kubeerr
2486 if [ $? -ne 0 ]; then
2487 echo -e " Removing namespace $1 $RED$BOLD FAILED $EBOLD$ERED"
2489 echo " Message: $(<./tmp/kubeerr)"
2492 echo -e " Removing namespace $1 $GREEN$BOLD OK $EBOLD$EGREEN"
2495 echo -e " Namespace $1 $GREEN$BOLD does not exist, OK $EBOLD$EGREEN"
2500 # Removes and re-create a namespace
2502 # (Not for test scripts)
2503 clean_and_create_namespace() {
2506 if [ $# -ne 1 ]; then
2507 __print_err "<namespace>" $@
2510 __kube_delete_namespace $1
2511 if [ $? -ne 0 ]; then
2514 __kube_create_namespace $1
2515 if [ $? -ne 0 ]; then
2520 # Add/remove label on non-namespaced kube object
2521 # args: <api> <instance> <label>
2522 # (Not for test scripts)
2523 __kube_label_non_ns_instance() {
2524 kubectl $KUBECONF label $1 $2 "$3" 1> /dev/null 2> ./tmp/kubeerr
2528 # Add/remove label on namespaced kube object
2529 # args: <api> <instance> <namespace> <label>
2530 # (Not for test scripts)
2531 __kube_label_ns_instance() {
2532 kubectl $KUBECONF label $1 $2 -n $3 "$4" 1> /dev/null 2> ./tmp/kubeerr
2536 # Find the host ip of an app (using the service resource)
2537 # args: <app-name> <namespace>
2538 # (Not for test scripts)
2539 __kube_get_service_host() {
2540 if [ $# -ne 2 ]; then
2542 __print_err "need 2 args, <app-name> <namespace>" $@
2545 for timeout in {1..60}; do
2546 host=$(kubectl $KUBECONF get svc $1 -n $2 -o jsonpath='{.spec.clusterIP}')
2547 if [ $? -eq 0 ]; then
2548 if [ ! -z "$host" ]; then
2556 echo "host-not-found-fatal-error"
2560 # Find the named port to an app (using the service resource)
2561 # args: <app-name> <namespace> <port-name>
2562 # (Not for test scripts)
2563 __kube_get_service_port() {
2564 if [ $# -ne 3 ]; then
2566 __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2570 for timeout in {1..60}; do
2571 port=$(kubectl $KUBECONF get svc $1 -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].port}')
2572 if [ $? -eq 0 ]; then
2573 if [ ! -z "$port" ]; then
2585 # Find the named node port to an app (using the service resource)
2586 # args: <app-name> <namespace> <port-name>
2587 # (Not for test scripts)
2588 __kube_get_service_nodeport() {
2589 if [ $# -ne 3 ]; then
2591 __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2595 for timeout in {1..60}; do
2596 port=$(kubectl $KUBECONF get svc $1 -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].nodePort}')
2597 if [ $? -eq 0 ]; then
2598 if [ ! -z "$port" ]; then
2610 # Create a kube resource from a yaml template
2611 # args: <resource-type> <resource-name> <template-yaml> <output-yaml>
2612 # (Not for test scripts)
2613 __kube_create_instance() {
2614 echo -ne " Creating $1 $2"$SAMELINE
2616 kubectl $KUBECONF apply -f $4 1> /dev/null 2> ./tmp/kubeerr
2617 if [ $? -ne 0 ]; then
2619 echo -e " Creating $1 $2 $RED Failed $ERED"
2620 echo " Message: $(<./tmp/kubeerr)"
2623 echo -e " Creating $1 $2 $GREEN OK $EGREEN"
2627 # Function to create a configmap in kubernetes
2628 # args: <configmap-name> <namespace> <labelname> <labelid> <path-to-data-file> <path-to-output-yaml>
2629 # (Not for test scripts)
2630 __kube_create_configmap() {
2631 echo -ne " Creating configmap $1 "$SAMELINE
2632 envsubst < $5 > $5"_tmp"
2633 cp $5"_tmp" $5 #Need to copy back to orig file name since create configmap neeed the original file name
2634 kubectl $KUBECONF create configmap $1 -n $2 --from-file=$5 --dry-run=client -o yaml > $6
2635 if [ $? -ne 0 ]; then
2636 echo -e " Creating configmap $1 $RED Failed $ERED"
2641 kubectl $KUBECONF apply -f $6 1> /dev/null 2> ./tmp/kubeerr
2642 if [ $? -ne 0 ]; then
2643 echo -e " Creating configmap $1 $RED Apply failed $ERED"
2644 echo " Message: $(<./tmp/kubeerr)"
2648 kubectl $KUBECONF label configmap $1 -n $2 $3"="$4 --overwrite 1> /dev/null 2> ./tmp/kubeerr
2649 if [ $? -ne 0 ]; then
2650 echo -e " Creating configmap $1 $RED Labeling failed $ERED"
2651 echo " Message: $(<./tmp/kubeerr)"
2655 # Log the resulting map
2656 kubectl $KUBECONF get configmap $1 -n $2 -o yaml > $6
2658 echo -e " Creating configmap $1 $GREEN OK $EGREEN"
2662 # This function runs a kubectl cmd where a single output value is expected, for example get ip with jsonpath filter.
2663 # The function retries up to the timeout given in the cmd flag '--cluster-timeout'
2664 # args: <full kubectl cmd with parameters>
2665 # (Not for test scripts)
2666 __kube_cmd_with_timeout() {
2667 TS_TMP=$(($SECONDS+$CLUSTER_TIME_OUT))
2670 kube_cmd_result=$($@)
2671 if [ $? -ne 0 ]; then
2674 if [ $SECONDS -ge $TS_TMP ] || [ ! -z "$kube_cmd_result" ] ; then
2675 echo $kube_cmd_result
2682 # This function starts a pod that cleans a the contents of a path mounted as a pvc
2683 # After this action the pod should terminate
2684 # This should only be executed when the pod owning the pvc is not running
2685 # args: <appname> <namespace> <pvc-name> <path-to remove>
2686 # (Not for test scripts)
2687 __kube_clean_pvc() {
2689 #using env vars setup in pvccleaner_api_functions.sh
2691 export PVC_CLEANER_NAMESPACE=$2
2692 export PVC_CLEANER_CLAIMNAME=$3
2693 export PVC_CLEANER_RM_PATH=$4
2694 export PVC_CLEANER_APP_NAME
2695 input_yaml=$SIM_GROUP"/"$PVC_CLEANER_COMPOSE_DIR"/"pvc-cleaner.yaml
2696 output_yaml=$PWD/tmp/$2-pvc-cleaner.yaml
2698 envsubst < $input_yaml > $output_yaml
2700 kubectl $KUBECONF delete -f $output_yaml 1> /dev/null 2> /dev/null # Delete the previous terminated pod - if existing
2702 __kube_create_instance pod $PVC_CLEANER_APP_NAME $input_yaml $output_yaml
2703 if [ $? -ne 0 ]; then
2704 echo $YELLOW" Could not clean pvc for app: $1 - persistent storage not clean - tests may not work"
2708 term_ts=$(($SECONDS+30))
2709 while [ $term_ts -gt $SECONDS ]; do
2710 pod_status=$(kubectl $KUBECONF get pod pvc-cleaner -n $PVC_CLEANER_NAMESPACE --no-headers -o custom-columns=":status.phase")
2711 if [ "$pod_status" == "Succeeded" ]; then
2718 # This function scales or deletes all resources for app selected by the testcase.
2720 # (Not for test scripts)
2722 echo -e $BOLD"Initialize kube pods/statefulsets/replicaset to initial state"$EBOLD
2724 # Scale prestarted or managed apps
2725 for imagename in $APP_SHORT_NAMES; do
2726 # A function name is created from the app short name
2727 # for example app short name 'RICMSIM' -> produce the function
2728 # name __RICSIM_kube_scale_zero or __RICSIM_kube_scale_zero_and_wait
2729 # This function is called and is expected to exist in the imported
2730 # file for the ricsim test functions
2731 # The resulting function impl shall scale the resources to 0
2732 # For prestarted apps, the function waits until the resources are 0
2733 # For included (not prestated) apps, the scaling is just ordered
2734 __check_prestarted_image $imagename
2735 if [ $? -eq 0 ]; then
2736 function_pointer="__"$imagename"_kube_scale_zero_and_wait"
2737 echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2740 __check_included_image $imagename
2741 if [ $? -eq 0 ]; then
2742 function_pointer="__"$imagename"_kube_scale_zero"
2743 echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2749 # Delete managed apps
2750 for imagename in $APP_SHORT_NAMES; do
2751 __check_included_image $imagename
2752 if [ $? -eq 0 ]; then
2753 __check_prestarted_image $imagename
2754 if [ $? -ne 0 ]; then
2755 # A function name is created from the app short name
2756 # for example app short name 'RICMSIM' -> produce the function
2757 # name __RICSIM__kube_delete_all
2758 # This function is called and is expected to exist in the imported
2759 # file for the ricsim test functions
2760 # The resulting function impl shall delete all its resources
2761 function_pointer="__"$imagename"_kube_delete_all"
2762 echo -e " Deleting all kube resources for app $BOLD $imagename $EBOLD"
2768 # Remove istio label on namespaces
2769 test_env_namespaces=$(kubectl $KUBECONF get ns --no-headers -o custom-columns=":metadata.name" -l autotest=engine -l istio-injection=enabled) #Get list of ns created by the test env
2770 if [ $? -ne 0 ]; then
2771 echo " Cannot get list of namespaces...continues.."
2773 for test_env_ns in $test_env_namespaces; do
2774 echo " Removing istio label on ns: "$test_env_ns
2775 __kube_label_non_ns_instance ns $test_env_ns "istio-injection-"
2782 # Function stop and remove all containers (docker) and services/deployments etc(kube)
2784 # Function for test script
2785 clean_environment() {
2786 if [ $RUNMODE == "KUBE" ]; then
2788 if [ $PRE_CLEAN -eq 1 ]; then
2789 echo " Cleaning docker resouces to free up resources, may take time..."
2790 ../common/clean_docker.sh 2>&1 > /dev/null
2795 if [ $PRE_CLEAN -eq 1 ]; then
2796 echo " Cleaning kubernetes resouces to free up resources, may take time..."
2797 ../common/clean_kube.sh $KUBECONF 2>&1 > /dev/null
2803 # Function stop and remove all containers (docker) and services/deployments etc(kube) in the end of the test script, if the arg 'auto-clean' is given at test script start
2805 # (Function for test scripts)
2806 auto_clean_environment() {
2808 if [ "$AUTO_CLEAN" == "auto" ]; then
2809 echo -e $BOLD"Initiating automatic cleaning of environment"$EBOLD
2814 # Function to sleep a test case for a numner of seconds. Prints the optional text args as info
2815 # args: <sleep-time-in-sec> [any-text-in-quotes-to-be-printed]
2816 # (Function for test scripts)
2819 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
2820 if [ $# -lt 1 ]; then
2822 __print_err "need at least one arg, <sleep-time-in-sec> [any-text-to-printed]" $@
2825 #echo "---- Sleep for " $1 " seconds ---- "$2
2827 duration=$((SECONDS-start))
2828 while [ $duration -lt $1 ]; do
2829 echo -ne " Slept for ${duration} seconds${SAMELINE}"
2831 duration=$((SECONDS-start))
2833 echo -ne " Slept for ${duration} seconds${SAMELINE}"
2837 # Print error info for the call in the parent script (test case). Arg: <error-message-to-print>
2838 # Not to be called from the test script itself.
2840 echo -e $RED ${FUNCNAME[1]} " "$1" " ${BASH_SOURCE[2]} " line" ${BASH_LINENO[1]} $ERED
2841 if [ $# -gt 1 ]; then
2842 echo -e $RED" Got: "${FUNCNAME[1]} ${@:2} $ERED
2845 __check_stop_at_error
2848 # Function to create the docker network for the test
2849 # Not to be called from the test script itself.
2850 __create_docker_network() {
2851 tmp=$(docker network ls --format={{.Name}} --filter name=$DOCKER_SIM_NWNAME)
2852 if [ $? -ne 0 ]; then
2853 echo -e $RED" Could not check if docker network $DOCKER_SIM_NWNAME exists"$ERED
2856 if [ "$tmp" != $DOCKER_SIM_NWNAME ]; then
2857 echo -e " Creating docker network:$BOLD $DOCKER_SIM_NWNAME $EBOLD"
2858 docker network create $DOCKER_SIM_NWNAME | indent2
2859 if [ $? -ne 0 ]; then
2860 echo -e $RED" Could not create docker network $DOCKER_SIM_NWNAME"$ERED
2863 echo -e "$GREEN Done$EGREEN"
2866 echo -e " Docker network $DOCKER_SIM_NWNAME already exists$GREEN OK $EGREEN"
2870 # Function to start container with docker-compose and wait until all are in state running.
2871 # If the <docker-compose-file> is empty, the default 'docker-compose.yml' is assumed.
2872 #args: <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+
2873 # (Not for test scripts)
2874 __start_container() {
2876 if [ $# -lt 5 ]; then
2878 __print_err "need 5 or more args, <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+" $@
2882 __create_docker_network
2890 if [ -z "$compose_file" ]; then
2891 compose_file="docker-compose.yml"
2899 envsubst < $compose_file > "gen_"$compose_file
2900 compose_file="gen_"$compose_file
2901 if [ $DOCKER_COMPOSE_VERSION == "V1" ]; then
2902 docker_compose_cmd="docker-compose"
2904 docker_compose_cmd="docker compose"
2907 if [ "$compose_args" == "NODOCKERARGS" ]; then
2908 $docker_compose_cmd -f $compose_file up -d &> .dockererr
2909 if [ $? -ne 0 ]; then
2910 echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2912 echo -e $RED"Stopping script...."$ERED
2916 $docker_compose_cmd -f $compose_file up -d $compose_args &> .dockererr
2917 if [ $? -ne 0 ]; then
2918 echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2920 echo -e $RED"Stopping script...."$ERED
2928 while [ $appindex -lt $appcount ]; do
2932 for i in {1..10}; do
2933 if [ "$(docker inspect --format '{{ .State.Running }}' $appname)" == "true" ]; then
2934 echo -e " Container $BOLD${appname}$EBOLD$GREEN running$EGREEN on$BOLD image $(docker inspect --format '{{ .Config.Image }}' ${appname}) $EBOLD"
2941 if [ $app_started -eq 0 ]; then
2944 echo -e $RED" Container $BOLD${appname}$EBOLD could not be started"$ERED
2945 echo -e $RED" Stopping script..."$ERED
2948 let appindex=appindex+1
2953 # Function to check if container/service is responding to http/https
2954 # args: <container-name>|<service-name> url
2955 # (Not for test scripts)
2956 __check_service_start() {
2958 if [ $# -ne 2 ]; then
2960 __print_err "need 2 args, <container-name>|<service-name> url" $@
2964 if [ $RUNMODE == "KUBE" ]; then
2965 ENTITY="service/set/deployment"
2971 echo -ne " Container $BOLD${appname}$EBOLD starting${SAMELINE}"
2975 echo -ne " Waiting for ${ENTITY} ${appname} service status...${SAMELINE}"
2978 while (( $TSTART+600 > $SECONDS )); do
2979 result="$(__do_curl -m 10 $url)"
2980 if [ $? -eq 0 ]; then
2981 if [ ${#result} -gt 15 ]; then
2982 #If response is too long, truncate
2983 result="...response text too long, omitted"
2985 echo -ne " Waiting for {ENTITY} $BOLD${appname}$EBOLD service status on ${3}, result: $result${SAMELINE}"
2986 echo -ne " The ${ENTITY} $BOLD${appname}$EBOLD$GREEN is alive$EGREEN, responds to service status:$GREEN $result $EGREEN on ${url} after $(($SECONDS-$TSTART)) seconds"
2992 if (( $TS_OFFSET > 5 )); then
2995 while [ $(($TS_TMP+$TS_OFFSET)) -gt $SECONDS ]; do
2996 echo -ne " Waiting for ${ENTITY} ${appname} service status on ${url}...$(($SECONDS-$TSTART)) seconds, retrying in $(($TS_TMP+$TS_OFFSET-$SECONDS)) seconds ${SAMELINE}"
3000 let loop_ctr=loop_ctr+1
3003 if [ "$a1pmsst" = "false" ]; then
3005 echo -e $RED" The ${ENTITY} ${appname} did not respond to service status on ${url} in $(($SECONDS-$TSTART)) seconds"$ERED
3018 __check_container_logs() {
3026 echo -e $BOLD"Checking $dispname container $appname log ($logpath) for WARNINGs and ERRORs"$EBOLD
3028 if [ $RUNMODE == "KUBE" ]; then
3029 echo -e $YELLOW" Internal log for $dispname not checked in kube"$EYELLOW
3033 #tmp=$(docker ps | grep $appname)
3034 tmp=$(docker ps -q --filter name=$appname) #get the container id
3035 if [ -z "$tmp" ]; then #Only check logs for running A1PMS apps
3036 echo " "$dispname" is not running, no check made"
3039 foundentries="$(docker exec -t $tmp grep $warning $logpath | wc -l)"
3040 if [ $? -ne 0 ];then
3041 echo " Problem to search $appname log $logpath"
3043 if [ $foundentries -eq 0 ]; then
3044 echo " No WARN entries found in $appname log $logpath"
3046 echo -e " Found \033[1m"$foundentries"\033[0m WARN entries in $appname log $logpath"
3049 foundentries="$(docker exec -t $tmp grep $error $logpath | wc -l)"
3050 if [ $? -ne 0 ];then
3051 echo " Problem to search $appname log $logpath"
3053 if [ $foundentries -eq 0 ]; then
3054 echo " No ERR entries found in $appname log $logpath"
3056 echo -e $RED" Found \033[1m"$foundentries"\033[0m"$RED" ERR entries in $appname log $logpath"$ERED
3062 # Store all container logs and other logs in the log dir for the script
3063 # Logs are stored with a prefix in case logs should be stored several times during a test
3064 # args: <logfile-prefix>
3065 # (Function for test scripts)
3067 if [ $# != 1 ]; then
3069 __print_err "need one arg, <file-prefix>" $@
3072 echo -e $BOLD"Storing all docker/kube container logs and other test logs in $TESTLOGS/$ATC using prefix: "$1$EBOLD
3074 docker stats --no-stream > $TESTLOGS/$ATC/$1_docker_stats.log 2>&1
3076 docker ps -a > $TESTLOGS/$ATC/$1_docker_ps.log 2>&1
3078 cp .httplog_${ATC}.txt $TESTLOGS/$ATC/$1_httplog_${ATC}.txt 2>&1
3080 if [ $RUNMODE == "DOCKER" ]; then
3082 # Store docker logs for all container
3083 for imagename in $APP_SHORT_NAMES; do
3084 __check_included_image $imagename
3085 if [ $? -eq 0 ]; then
3086 # A function name is created from the app short name
3087 # for example app short name 'RICMSIM' -> produce the function
3088 # name __RICSIM__store_docker_logs
3089 # This function is called and is expected to exist in the imported
3090 # file for the ricsim test functions
3091 # The resulting function impl shall store the docker logs for each container
3092 function_pointer="__"$imagename"_store_docker_logs"
3093 $function_pointer "$TESTLOGS/$ATC/" $1
3097 if [ $RUNMODE == "KUBE" ]; then
3098 namespaces=$(kubectl $KUBECONF get namespaces -o jsonpath='{.items[?(@.metadata.name)].metadata.name}')
3099 for nsid in $namespaces; do
3100 pods=$(kubectl $KUBECONF get pods -n $nsid -o jsonpath='{.items[?(@.metadata.labels.autotest)].metadata.name}')
3101 for podid in $pods; do
3102 kubectl $KUBECONF logs -n $nsid $podid > $TESTLOGS/$ATC/$1_${podid}.log
3112 # Generic curl function, assumes all 200-codes are ok
3114 # args: <valid-curl-args-including full url>
3115 # returns: <returned response (without respose code)> or "<no-response-from-server>" or "<not found, <http-code>>""
3116 # returns: The return code is 0 for ok and 1 for not ok
3118 echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
3120 if [ ! -z "$KUBE_PROXY_PATH" ]; then
3121 if [ $KUBE_PROXY_HTTPX == "http" ]; then
3122 proxyflag=" --proxy $KUBE_PROXY_PATH"
3124 proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
3128 if [ ! -z "$KUBE_PROXY_CURL_JWT" ]; then
3129 jwt="-H "\""Authorization: Bearer $KUBE_PROXY_CURL_JWT"\"
3130 curlString="curl -skw %{http_code} $proxyflag $@"
3131 echo " CMD: $curlString $jwt" >> $HTTPLOG
3132 res=$($curlString -H "Authorization: Bearer $KUBE_PROXY_CURL_JWT")
3135 curlString="curl -skw %{http_code} $proxyflag $@"
3136 echo " CMD: $curlString" >> $HTTPLOG
3140 echo " RESP: $res" >> $HTTPLOG
3141 echo " RETCODE: $retcode" >> $HTTPLOG
3142 if [ $retcode -ne 0 ]; then
3143 echo "<no-response-from-server>"
3146 http_code="${res:${#res}-3}"
3147 if [ ${#res} -eq 3 ]; then
3148 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3149 echo "<no-response-from-server>"
3155 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3156 echo "<not found, resp:${http_code}>"
3159 if [ $# -eq 2 ]; then
3160 echo "${res:0:${#res}-3}" | xargs
3162 echo "${res:0:${#res}-3}"
3170 # Generic curl function, assumes all 200-codes are ok
3171 # Uses no proxy, even if it is set
3172 # args: <valid-curl-args-including full url>
3173 # returns: <returned response (without respose code)> or "<no-response-from-server>" or "<not found, <http-code>>""
3174 # returns: The return code is 0 for ok and 1 for not ok
3175 __do_curl_no_proxy() {
3176 echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
3177 curlString="curl -skw %{http_code} $@"
3178 echo " CMD: $curlString" >> $HTTPLOG
3181 echo " RESP: $res" >> $HTTPLOG
3182 echo " RETCODE: $retcode" >> $HTTPLOG
3183 if [ $retcode -ne 0 ]; then
3184 echo "<no-response-from-server>"
3187 http_code="${res:${#res}-3}"
3188 if [ ${#res} -eq 3 ]; then
3189 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3190 echo "<no-response-from-server>"
3196 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
3197 echo "<not found, resp:${http_code}>"
3200 if [ $# -eq 2 ]; then
3201 echo "${res:0:${#res}-3}" | xargs
3203 echo "${res:0:${#res}-3}"
3210 #######################################
3211 ### Basic helper function for test cases
3212 #######################################
3214 # Test a simulator container variable value towards target value using an condition operator with an optional timeout.
3215 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> - This test is done
3216 # immediately and sets pass or fail depending on the result of comparing variable and target using the operator.
3217 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> <timeout> - This test waits up to the timeout
3218 # before setting pass or fail depending on the result of comparing variable and target using the operator.
3219 # If the <variable-name> has the 'json:' prefix, the the variable will be used as url and the <target-value> will be compared towards the length of the json array in the response.
3220 # Not to be called from test script.
3223 checkjsonarraycount=0
3224 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
3225 if [ $# -eq 6 ]; then
3226 if [[ $3 == "json:"* ]]; then
3227 checkjsonarraycount=1
3230 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds"$EBOLD
3231 echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds" >> $HTTPLOG
3234 ((TEST_SEQUENCE_NR++))
3238 if [ $checkjsonarraycount -eq 0 ]; then
3239 result="$(__do_curl $2$3)"
3241 result=${result//[[:blank:]]/} #Strip blanks
3244 result="$(__do_curl $2$path)"
3246 echo "$result" > ./tmp/.tmp.curl.json
3247 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
3249 duration=$((SECONDS-start))
3250 echo -ne " Result=${result} after ${duration} seconds${SAMELINE}"
3252 if [ $retcode -ne 0 ]; then
3253 if [ $duration -gt $6 ]; then
3255 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
3256 __print_current_stats
3257 __check_stop_at_error
3260 elif [ "$4" == "=" ] && [ "$result" -eq $5 ]; then
3262 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3263 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3264 __print_current_stats
3266 elif [ "$4" == ">" ] && [ "$result" -gt $5 ]; then
3268 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3269 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3270 __print_current_stats
3272 elif [ "$4" == "<" ] && [ "$result" -lt $5 ]; then
3274 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3275 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3276 __print_current_stats
3278 elif [ "$4" == ">=" ] && [ "$result" -ge $5 ]; then
3280 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3281 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3282 __print_current_stats
3284 elif [ "$4" == "contain_str" ] && [[ $result =~ $5 ]]; then
3286 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3287 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3288 __print_current_stats
3291 if [ $duration -gt $6 ]; then
3293 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
3294 __print_current_stats
3295 __check_stop_at_error
3301 elif [ $# -eq 5 ]; then
3302 if [[ $3 == "json:"* ]]; then
3303 checkjsonarraycount=1
3306 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}"$EBOLD
3307 echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}" >> $HTTPLOG
3309 ((TEST_SEQUENCE_NR++))
3310 if [ $checkjsonarraycount -eq 0 ]; then
3311 result="$(__do_curl $2$3)"
3313 result=${result//[[:blank:]]/} #Strip blanks
3316 result="$(__do_curl $2$path)"
3318 echo "$result" > ./tmp/.tmp.curl.json
3319 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
3321 if [ $retcode -ne 0 ]; then
3323 echo -e $RED" FAIL ${ERED}- ${3} ${4} ${5} not reached, result = ${result}"
3324 __print_current_stats
3325 __check_stop_at_error
3326 elif [ "$4" == "=" ] && [ "$result" -eq $5 ]; then
3328 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3329 __print_current_stats
3330 elif [ "$4" == ">" ] && [ "$result" -gt $5 ]; then
3332 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3333 __print_current_stats
3334 elif [ "$4" == "<" ] && [ "$result" -lt $5 ]; then
3336 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3337 __print_current_stats
3338 elif [ "$4" == ">=" ] && [ "$result" -ge $5 ]; then
3340 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3341 __print_current_stats
3342 elif [ "$4" == "contain_str" ] && [[ $result =~ $5 ]]; then
3344 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3345 __print_current_stats
3348 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached, result = ${result}"
3349 __print_current_stats
3350 __check_stop_at_error
3353 echo "Wrong args to __var_test, needs five or six args: <simulator-name> <host> <variable-name> <condition-operator> <target-value> [ <timeout> ]"