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>+] [--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]"
35 if [ $# -eq 1 ] && [ "$1" == "help" ]; then
37 if [ ! -z "$TC_ONELINE_DESCR" ]; then
38 echo "Test script description:"
39 echo $TC_ONELINE_DESCR
44 echo "remote - Use images from remote repositories. Can be overridden for individual images using the '--use_xxx' flags"
45 echo "remote-remove - Same as 'remote' but will also try to pull fresh images from remote repositories"
46 echo "docker - Test executed in docker environment"
47 echo "kube - Test executed in kubernetes environment - requires an already started kubernetes environment"
48 echo "--env-file <file> - The script will use the supplied file to read environment variables from"
49 echo "release - If this flag is given the script will use release version of the images"
50 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."
51 echo "--stop-at-error - The script will stop when the first failed test or configuration"
52 echo "--ricsim-prefix - The a1 simulator will use the supplied string as container prefix instead of 'ricsim'"
53 echo "--use-local-image - The script will use local images for the supplied apps, space separated list of app short names"
54 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"
55 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"
56 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"
57 echo "--image-repo - Url to optional image repo. Only locally built images will be re-tagged and pushed to this repo"
58 echo "--repo-policy - Policy controlling which images to re-tag and push if param --image-repo is set. Default is 'local'"
59 echo "--cluster-timeout - Optional timeout for cluster where it takes time to obtain external ip/host-name. Timeout in seconds. "
60 echo "--print-stats - Print current test stats after each test."
61 echo "--override <file> - Override setting from the file supplied by --env-file"
62 echo "--pre-clean - Will clean kube resouces when running docker and vice versa"
63 echo "--gen-stats - Collect container/pod runtime statistics"
64 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."
65 echo "--delete-containers - Delete docker containers before starting tests - but only those created by the test scripts. Docker mode only."
66 echo "--endpoint-stats - Collect endpoint statistics"
68 echo "List of app short names supported: "$APP_SHORT_NAMES
73 # Create a test case id, ATC (Auto Test Case), from the name of the test case script.
74 # FTC1.sh -> ATC == FTC1
75 ATC=$(basename "${BASH_SOURCE[$i+1]}" .sh)
77 #Create result file (containing '1' for error) for this test case
78 #Will be replaced with a file containing '0' if all test cases pass
79 echo "1" > "$PWD/.result$ATC.txt"
81 #Formatting for 'echo' cmd
86 GREEN="\033[32m\033[1m"
88 YELLOW="\033[33m\033[1m"
92 # Just resetting any previous echo formatting...
95 # default test environment variables
97 #Override env file, will be added on top of the above file
98 TEST_ENV_VAR_FILE_OVERRIDE=""
100 echo "Test case started as: ${BASH_SOURCE[$i+1]} "$@
103 LOCALHOST_NAME="localhost"
104 LOCALHOST_HTTP="http://localhost"
105 LOCALHOST_HTTPS="https://localhost"
107 # Var to hold 'auto' in case containers shall be stopped when test case ends
110 # Var to indicate pre clean, if flag --pre-clean is set the script will clean kube resouces when running docker and vice versa
113 # Var to hold the app names to use local images for
116 # Var to hold the app names to use remote snapshot images for
117 USE_SNAPSHOT_IMAGES=""
119 # Var to hold the app names to use remote staging images for
120 USE_STAGING_IMAGES=""
122 # Var to hold the app names to use remote release images for
123 USE_RELEASE_IMAGES=""
126 # 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
129 # The default value "DEV" indicate that development image tags (SNAPSHOT) and nexus repos (nexus port 10002) are used.
130 # The value "RELEASE" indicate that relase image tag and nexus repos (nexus port) are used
131 # Applies only to images defined in the test-env files with image names and tags defined as XXXX_RELEASE
134 #Var to indicate docker-compose version, V1 or V2
135 #V1 names replicated containers <proj-name>_<service-name>_<index>
136 #V2 names replicated containers <proj-name>-<service-name>-<index>
137 DOCKER_COMPOSE_VERION="V1"
139 # Function to indent cmd output with one space
140 indent1() { sed 's/^/ /'; }
142 # Function to indent cmd output with two spaces
143 indent2() { sed 's/^/ /'; }
145 # Set a description string for the test case
146 if [ -z "$TC_ONELINE_DESCR" ]; then
147 TC_ONELINE_DESCR="<no-description>"
148 echo "No test case description found, TC_ONELINE_DESCR should be set on in the test script , using "$TC_ONELINE_DESCR
151 # Counter for test suites
152 if [ -f .tmp_tcsuite_ctr ]; then
153 tmpval=$(< .tmp_tcsuite_ctr)
155 echo $tmpval > .tmp_tcsuite_ctr
158 # Create the logs dir if not already created in the current dir
159 if [ ! -d "logs" ]; then
164 # Create the tmp dir for temporary files that is not needed after the test
165 # hidden files for the test env is still stored in the current dir
166 # files in the ./tmp is moved to ./tmp/prev when a new test is started
167 if [ ! -d "tmp" ]; then
169 if [ $? -ne 0 ]; then
170 echo "Cannot create dir for temp files, $PWD/tmp"
177 if [ $? -ne 0 ]; then
178 echo "Cannot cd to $PWD/tmp"
183 TESTENV_TEMP_FILES=$PWD
185 if [ ! -d "prev" ]; then
187 if [ $? -ne 0 ]; then
188 echo "Cannot create dir for previous temp files, $PWD/prev"
194 TMPFILES=$(ls -A | grep -vw prev)
195 if [ ! -z "$TMPFILES" ]; then
196 cp -r $TMPFILES prev #Move all temp files to prev dir
197 if [ $? -ne 0 ]; then
198 echo "Cannot move temp files in $PWD to previous temp files in, $PWD/prev"
202 if [ $(pwd | xargs basename) == "tmp" ]; then #Check that current dir is tmp...for safety
204 rm -rf $TMPFILES # Remove all temp files
209 if [ $? -ne 0 ]; then
210 echo "Cannot cd to $curdir"
216 # Create a http message log for this testcase
217 HTTPLOG=$PWD"/.httplog_"$ATC".txt"
220 # Create a log dir for the test case
221 mkdir -p $TESTLOGS/$ATC
223 # Save create for current logs
224 mkdir -p $TESTLOGS/$ATC/previous
226 rm $TESTLOGS/$ATC/previous/*.log &> /dev/null
227 rm $TESTLOGS/$ATC/previous/*.txt &> /dev/null
228 rm $TESTLOGS/$ATC/previous/*.json &> /dev/null
230 mv $TESTLOGS/$ATC/*.log $TESTLOGS/$ATC/previous &> /dev/null
231 mv $TESTLOGS/$ATC/*.txt $TESTLOGS/$ATC/previous &> /dev/null
232 mv $TESTLOGS/$ATC/*.txt $TESTLOGS/$ATC/previous &> /dev/null
234 # Clear the log dir for the test case
235 rm $TESTLOGS/$ATC/*.log &> /dev/null
236 rm $TESTLOGS/$ATC/*.txt &> /dev/null
237 rm $TESTLOGS/$ATC/*.json &> /dev/null
239 #Create result file in the log dir
240 echo "1" > "$TESTLOGS/$ATC/.result$ATC.txt"
242 # Log all output from the test case to a TC log
243 TCLOG=$TESTLOGS/$ATC/TC.log
244 exec &> >(tee ${TCLOG})
246 #Variables for counting tests as well as passed and failed tests
253 #Var to control if current stats shall be printed
254 PRINT_CURRENT_STATS=0
256 #Var to control if container/pod runtim statistics shall be collected
257 COLLECT_RUNTIME_STATS=0
258 COLLECT_RUNTIME_STATS_PID=0
260 #Var to control if endpoint statistics shall be collected
261 COLLECT_ENDPOINT_STATS=0
263 #Var to control if namespaces shall be delete before test setup
264 DELETE_KUBE_NAMESPACES=0
266 #Var to control if containers shall be delete before test setup
269 #File to keep deviation messages
270 DEVIATION_FILE=".tmp_deviations"
271 rm $DEVIATION_FILE &> /dev/null
273 # Trap "command not found" and make the script fail
276 if [ $? -eq 127 ]; then
277 echo -e $RED"Function not found, setting script to FAIL"$ERED
279 __print_current_stats
284 # Trap to kill subprocess for stats collection (if running)
286 if [ $COLLECT_RUNTIME_STATS_PID -ne 0 ]; then
287 kill $COLLECT_RUNTIME_STATS_PID
295 # Function to log the start of a test case
297 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
298 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${FUNCNAME[1]}" $@ $EBOLD
299 echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${FUNCNAME[1]}" $@ >> $HTTPLOG
301 ((TEST_SEQUENCE_NR++))
304 # Function to print current statistics
305 __print_current_stats() {
306 if [ $PRINT_CURRENT_STATS -ne 0 ]; then
307 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"
311 # General function to log a failed test case
312 __log_test_fail_general() {
313 echo -e $RED" FAIL."$1 $ERED
315 __print_current_stats
316 __check_stop_at_error
319 # Function to log a test case failed due to incorrect response code
320 __log_test_fail_status_code() {
321 echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
323 __print_current_stats
324 __check_stop_at_error
327 # Function to log a test case failed due to incorrect response body
328 __log_test_fail_body() {
329 echo -e $RED" FAIL, returned body not correct"$ERED
331 __print_current_stats
332 __check_stop_at_error
335 # Function to log a test case that is not supported
336 __log_test_fail_not_supported() {
337 echo -e $RED" FAIL, function not supported"$ERED
339 __print_current_stats
340 __check_stop_at_error
343 # General function to log a passed test case
345 if [ $# -gt 0 ]; then
349 echo -e $GREEN" PASS"$EGREEN
350 __print_current_stats
353 #Counter for configurations
356 # Function to log the start of a configuration setup
358 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
359 echo -e $BOLD"CONF $CONF_SEQUENCE_NR (${BASH_LINENO[1]}): "${FUNCNAME[1]} $@ $EBOLD
360 echo "CONF $CONF_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): "${FUNCNAME[1]} $@ >> $HTTPLOG
361 ((CONF_SEQUENCE_NR++))
364 # Function to log a failed configuration setup
365 __log_conf_fail_general() {
366 echo -e $RED" FAIL."$1 $ERED
368 __print_current_stats
369 __check_stop_at_error
372 # Function to log a failed configuration setup due to incorrect response code
373 __log_conf_fail_status_code() {
374 echo -e $RED" FAIL. Exepected status "$1", got "$2 $3 $ERED
376 __print_current_stats
377 __check_stop_at_error
380 # Function to log a failed configuration setup due to incorrect response body
381 __log_conf_fail_body() {
382 echo -e $RED" FAIL, returned body not correct"$ERED
384 __print_current_stats
385 __check_stop_at_error
388 # Function to log a configuration that is not supported
389 __log_conf_fail_not_supported() {
390 echo -e $RED" FAIL, function not supported"$ERED$@
392 __print_current_stats
393 __check_stop_at_error
396 # Function to log a passed configuration setup
398 if [ $# -gt 0 ]; then
401 echo -e $GREEN" OK"$EGREEN
402 __print_current_stats
405 # Function to collect stats on endpoints
406 # args: <app-id> <end-point-no> <http-operation> <end-point-url> <http-status> [<count>]
407 __collect_endpoint_stats() {
408 if [ $COLLECT_ENDPOINT_STATS -eq 0 ]; then
412 if [ $# -gt 5 ]; then
415 ENDPOINT_STAT_FILE=$TESTLOGS/$ATC/endpoint_$ATC_$1_$2".log"
418 if [ -f $ENDPOINT_STAT_FILE ]; then
419 ENDPOINT_VAL=$(< $ENDPOINT_STAT_FILE)
420 ENDPOINT_POS=$(echo $ENDPOINT_VAL | cut -f4 -d ' ' | cut -f1 -d '/')
421 ENDPOINT_NEG=$(echo $ENDPOINT_VAL | cut -f5 -d ' ' | cut -f1 -d '/')
424 if [ $5 -ge 200 ] && [ $5 -lt 300 ]; then
425 let ENDPOINT_POS=ENDPOINT_POS+$ENDPOINT_COUNT
427 let ENDPOINT_NEG=ENDPOINT_NEG+$ENDPOINT_COUNT
430 printf '%-2s %-10s %-45s %-16s %-16s' "#" "$3" "$4" "$ENDPOINT_POS/$ENDPOINT_POS" "$ENDPOINT_NEG/$ENDPOINT_NEG" > $ENDPOINT_STAT_FILE
433 # Function to collect stats on endpoints
434 # args: <app-id> <image-info>
435 __collect_endpoint_stats_image_info() {
436 if [ $COLLECT_ENDPOINT_STATS -eq 0 ]; then
439 ENDPOINT_STAT_FILE=$TESTLOGS/$ATC/imageinfo_$ATC_$1".log"
440 echo $POLICY_AGENT_IMAGE > $ENDPOINT_STAT_FILE
443 #Var for measuring execution time
444 TCTEST_START=$SECONDS
446 #Vars to hold the start time and timer text for a custom timer
447 TC_TIMER_STARTTIME=""
448 TC_TIMER_TIMER_TEXT=""
449 TC_TIMER_CURRENT_FAILS="" # Then numer of failed test when timer starts.
450 # Compared with the current number of fails at timer stop
451 # to judge the measurement reliability
453 #File to save timer measurement results
454 TIMER_MEASUREMENTS=".timer_measurement.txt"
455 echo -e "Activity \t Duration \t Info" > $TIMER_MEASUREMENTS
457 # If this is set, some images (controlled by the parameter repo-policy) will be re-tagged and pushed to this repo before any
459 IMAGE_REPO_POLICY="local"
462 echo "-------------------------------------------------------------------------------------------------"
463 echo "----------------------------------- Test case: "$ATC
464 echo "----------------------------------- Started: "$(date)
465 echo "-------------------------------------------------------------------------------------------------"
466 echo "-- Description: "$TC_ONELINE_DESCR
467 echo "-------------------------------------------------------------------------------------------------"
468 echo "----------------------------------- Test case setup -----------------------------------"
470 echo "Setting AUTOTEST_HOME="$AUTOTEST_HOME
474 if [ $# -lt 1 ]; then
477 if [ $paramerror -eq 0 ]; then
478 if [ "$1" != "remote" ] && [ "$1" != "remote-remove" ]; then
480 if [ -z "$paramerror_str" ]; then
481 paramerror_str="First arg shall be 'remote' or 'remote-remove'"
487 if [ $paramerror -eq 0 ]; then
488 if [ "$1" != "docker" ] && [ "$1" != "kube" ]; then
490 if [ -z "$paramerror_str" ]; then
491 paramerror_str="Second arg shall be 'docker' or 'kube'"
494 if [ $1 == "docker" ]; then
496 echo "Setting RUNMODE=DOCKER"
498 if [ $1 == "kube" ]; then
500 echo "Setting RUNMODE=KUBE"
506 while [ $paramerror -eq 0 ] && [ $foundparm -eq 0 ]; do
508 if [ $paramerror -eq 0 ]; then
509 if [ "$1" == "release" ]; then
510 IMAGE_CATEGORY="RELEASE"
511 echo "Option set - Release image tags used for applicable images "
516 if [ $paramerror -eq 0 ]; then
517 if [ "$1" == "auto-clean" ]; then
519 echo "Option set - Auto clean at end of test script"
524 if [ $paramerror -eq 0 ]; then
525 if [ "$1" == "--stop-at-error" ]; then
527 echo "Option set - Stop at first error"
532 if [ $paramerror -eq 0 ]; then
533 if [ "$1" == "--ricsim-prefix" ]; then
535 TMP_RIC_SIM_PREFIX=$1 #RIC_SIM_PREFIX need to be updated after sourcing of the env file
538 if [ -z "$paramerror_str" ]; then
539 paramerror_str="No prefix found for flag: '--ricsim-prefix'"
542 echo "Option set - Overriding RIC_SIM_PREFIX with: "$1
548 if [ $paramerror -eq 0 ]; then
549 if [ "$1" == "--env-file" ]; then
554 if [ -z "$paramerror_str" ]; then
555 paramerror_str="No env file found for flag: '--env-file'"
558 echo "Option set - Reading test env from: "$1
564 if [ $paramerror -eq 0 ]; then
565 if [ "$1" == "--use-local-image" ]; then
568 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
569 USE_LOCAL_IMAGES=$USE_LOCAL_IMAGES" "$1
570 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
572 if [ -z "$paramerror_str" ]; then
573 paramerror_str="App name $1 is not available for local override for flag: '--use-local-image'"
579 if [ -z "$USE_LOCAL_IMAGES" ]; then
581 if [ -z "$paramerror_str" ]; then
582 paramerror_str="No app name found for flag: '--use-local-image'"
585 echo "Option set - Overriding with local images for app(s):"$USE_LOCAL_IMAGES
589 if [ $paramerror -eq 0 ]; then
590 if [ "$1" == "--use-snapshot-image" ]; then
591 USE_SNAPSHOT_IMAGES=""
593 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
594 USE_SNAPSHOT_IMAGES=$USE_SNAPSHOT_IMAGES" "$1
595 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
597 if [ -z "$paramerror_str" ]; then
598 paramerror_str="App name $1 is not available for snapshot override for flag: '--use-snapshot-image'"
604 if [ -z "$USE_SNAPSHOT_IMAGES" ]; then
606 if [ -z "$paramerror_str" ]; then
607 paramerror_str="No app name found for flag: '--use-snapshot-image'"
610 echo "Option set - Overriding with snapshot images for app(s):"$USE_SNAPSHOT_IMAGES
614 if [ $paramerror -eq 0 ]; then
615 if [ "$1" == "--use-staging-image" ]; then
616 USE_STAGING_IMAGES=""
618 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
619 USE_STAGING_IMAGES=$USE_STAGING_IMAGES" "$1
620 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
622 if [ -z "$paramerror_str" ]; then
623 paramerror_str="App name $1 is not available for staging override for flag: '--use-staging-image'"
629 if [ -z "$USE_STAGING_IMAGES" ]; then
631 if [ -z "$paramerror_str" ]; then
632 paramerror_str="No app name found for flag: '--use-staging-image'"
635 echo "Option set - Overriding with staging images for app(s):"$USE_STAGING_IMAGES
639 if [ $paramerror -eq 0 ]; then
640 if [ "$1" == "--use-release-image" ]; then
641 USE_RELEASE_IMAGES=""
643 while [ $# -gt 0 ] && [[ "$1" != "--"* ]]; do
644 USE_RELEASE_IMAGES=$USE_RELEASE_IMAGES" "$1
645 if [[ "$AVAILABLE_IMAGES_OVERRIDE" != *"$1"* ]]; then
647 if [ -z "$paramerror_str" ]; then
648 paramerror_str="App name $1 is not available for release override for flag: '--use-release-image'"
654 if [ -z "$USE_RELEASE_IMAGES" ]; then
656 if [ -z "$paramerror_str" ]; then
657 paramerror_str="No app name found for flag: '--use-release-image'"
660 echo "Option set - Overriding with release images for app(s):"$USE_RELEASE_IMAGES
664 if [ $paramerror -eq 0 ]; then
665 if [ "$1" == "--image-repo" ]; then
670 if [ -z "$paramerror_str" ]; then
671 paramerror_str="No image repo url found for : '--image-repo'"
674 echo "Option set - Image repo url: "$1
680 if [ $paramerror -eq 0 ]; then
681 if [ "$1" == "--repo-policy" ]; then
686 if [ -z "$paramerror_str" ]; then
687 paramerror_str="No policy found for : '--repo-policy'"
690 if [ "$1" == "local" ] || [ "$1" == "remote" ]; then
691 echo "Option set - Image repo policy: "$1
696 if [ -z "$paramerror_str" ]; then
697 paramerror_str="Repo policy shall be 'local' or 'remote'"
703 if [ $paramerror -eq 0 ]; then
704 if [ "$1" == "--cluster-timeout" ]; then
709 if [ -z "$paramerror_str" ]; then
710 paramerror_str="No timeout value found for : '--cluster-timeout'"
713 #Check if positive int
714 case ${CLUSTER_TIME_OUT#[+]} in
717 if [ -z "$paramerror_str" ]; then
718 paramerror_str="Value for '--cluster-timeout' not an int : "$CLUSTER_TIME_OUT
723 echo "Option set - Cluster timeout: "$1
729 if [ $paramerror -eq 0 ]; then
730 if [ "$1" == "--override" ]; then
732 TEST_ENV_VAR_FILE_OVERRIDE=$1
735 if [ -z "$paramerror_str" ]; then
736 paramerror_str="No env file found for flag: '--override'"
739 if [ ! -f $TEST_ENV_VAR_FILE_OVERRIDE ]; then
741 if [ -z "$paramerror_str" ]; then
742 paramerror_str="File for '--override' does not exist : "$TEST_ENV_VAR_FILE_OVERRIDE
745 echo "Option set - Override env from: "$1
751 if [ $paramerror -eq 0 ]; then
752 if [ "$1" == "--pre-clean" ]; then
754 echo "Option set - Pre-clean of kube/docker resouces"
759 if [ $paramerror -eq 0 ]; then
760 if [ "$1" == "--print-stats" ]; then
761 PRINT_CURRENT_STATS=1
762 echo "Option set - Print stats after every test-case and config"
767 if [ $paramerror -eq 0 ]; then
768 if [ "$1" == "--gen-stats" ]; then
769 COLLECT_RUNTIME_STATS=1
770 echo "Option set - Collect runtime statistics"
775 if [ $paramerror -eq 0 ]; then
776 if [ "$1" == "--delete-namespaces" ]; then
777 if [ $RUNMODE == "DOCKER" ]; then
778 DELETE_KUBE_NAMESPACES=0
779 echo "Option ignored - Delete namespaces (ignored when running docker)"
781 if [ -z "KUBE_PRESTARTED_IMAGES" ]; then
782 DELETE_KUBE_NAMESPACES=0
783 echo "Option ignored - Delete namespaces (ignored when using prestarted apps)"
785 DELETE_KUBE_NAMESPACES=1
786 echo "Option set - Delete namespaces"
793 if [ $paramerror -eq 0 ]; then
794 if [ "$1" == "--delete-containers" ]; then
795 if [ $RUNMODE == "DOCKER" ]; then
797 echo "Option set - Delete containers started by previous test(s)"
799 echo "Option ignored - Delete containers (ignored when running kube)"
805 if [ $paramerror -eq 0 ]; then
806 if [ "$1" == "--endpoint-stats" ]; then
807 COLLECT_ENDPOINT_STATS=1
808 echo "Option set - Collect endpoint statistics"
818 if [ $paramerror -eq 0 ] && [ $# -gt 0 ]; then
820 if [ -z "$paramerror_str" ]; then
821 paramerror_str="Unknown parameter(s): "$@
825 if [ $paramerror -eq 1 ]; then
826 echo -e $RED"Incorrect arg list: "$paramerror_str$ERED
831 # sourcing the selected env variables for the test case
832 if [ -f "$TEST_ENV_VAR_FILE" ]; then
833 echo -e $BOLD"Sourcing env vars from: "$TEST_ENV_VAR_FILE$EBOLD
835 if [ ! -z "$TEST_ENV_VAR_FILE_OVERRIDE" ]; then
836 echo -e $BOLD"Sourcing override env vars from: "$TEST_ENV_VAR_FILE_OVERRIDE$EBOLD
837 . $TEST_ENV_VAR_FILE_OVERRIDE
840 if [ -z "$TEST_ENV_PROFILE" ] || [ -z "$SUPPORTED_PROFILES" ]; then
841 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
844 for prof in $SUPPORTED_PROFILES; do
845 if [ "$TEST_ENV_PROFILE" == "$prof" ]; then
846 echo -e $GREEN"Test case supports the selected test env file"$EGREEN
850 if [ $found_profile -ne 1 ]; then
851 echo -e $RED"Test case does not support the selected test env file"$ERED
852 echo "Profile: "$TEST_ENV_PROFILE" Supported profiles: "$SUPPORTED_PROFILES
853 echo -e $RED"Exiting...."$ERED
858 echo -e $RED"Selected env var file does not exist: "$TEST_ENV_VAR_FILE$ERED
859 echo " Select one of following env var file matching the intended target of the test"
860 echo " Restart the test using the flag '--env-file <path-to-env-file>"
861 ls $AUTOTEST_HOME/../common/test_env* | indent1
865 #This var need be preserved from the command line option, if set, when env var is sourced.
866 if [ ! -z "$TMP_RIC_SIM_PREFIX" ]; then
867 RIC_SIM_PREFIX=$TMP_RIC_SIM_PREFIX
870 if [ -z "$PROJECT_IMAGES_APP_NAMES" ]; then
871 echo -e $RED"Var PROJECT_IMAGES_APP_NAMES must be defined in: "$TEST_ENV_VAR_FILE $ERED
875 if [[ $SUPPORTED_RUNMODES != *"$RUNMODE"* ]]; then
876 echo -e $RED"This test script does not support RUNMODE $RUNMODE"$ERED
877 echo "Supported RUNMODEs: "$SUPPORTED_RUNMODES
881 # Choose list of included apps depending on run-mode
882 if [ $RUNMODE == "KUBE" ]; then
883 INCLUDED_IMAGES=$KUBE_INCLUDED_IMAGES
885 INCLUDED_IMAGES=$DOCKER_INCLUDED_IMAGES
889 # auto adding system apps
891 echo -e $BOLD"Auto adding system apps"$EBOLD
892 if [ $RUNMODE == "KUBE" ]; then
893 INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_KUBE_SYSTEM_APPS
894 TMP_APPS=$TESTENV_KUBE_SYSTEM_APPS
896 INCLUDED_IMAGES=$INCLUDED_IMAGES" "$TESTENV_DOCKER_SYSTEM_APPS
897 TMP_APPS=$TESTENV_DOCKER_SYSTEM_APPS
899 if [ ! -z "$TMP_APPS" ]; then
900 for iapp in "$TMP_APPS"; do
901 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
902 file_pointer="../common/"$file_pointer"_api_functions.sh"
904 while [ ${#padded_iapp} -lt 16 ]; do
905 padded_iapp=$padded_iapp" "
907 echo " Auto-adding system app $padded_iapp Sourcing $file_pointer"
909 if [ $? -ne 0 ]; then
910 echo " Include file $file_pointer contain errors. Exiting..."
913 __added_apps=" $iapp "$__added_apps
919 if [ $RUNMODE == "KUBE" ]; then
920 TMP_APPS=$INCLUDED_IMAGES" "$KUBE_PRESTARTED_IMAGES
922 TMP_APPS=$INCLUDED_IMAGES
925 echo -e $BOLD"Auto adding included apps"$EBOLD
926 for iapp in $TMP_APPS; do
927 if [[ "$__added_apps" != *"$iapp"* ]]; then
928 file_pointer=$(echo $iapp | tr '[:upper:]' '[:lower:]')
929 file_pointer="../common/"$file_pointer"_api_functions.sh"
931 while [ ${#padded_iapp} -lt 16 ]; do
932 padded_iapp=$padded_iapp" "
934 echo " Auto-adding included app $padded_iapp Sourcing $file_pointer"
935 if [ ! -f "$file_pointer" ]; then
936 echo " Include file $file_pointer for app $iapp does not exist"
940 if [ $? -ne 0 ]; then
941 echo " Include file $file_pointer contain errors. Exiting..."
948 echo -e $BOLD"Test environment info"$EBOLD
950 # Check needed installed sw
953 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
954 echo -e $RED"bash is required to run the test environment, pls install"$ERED
957 echo " bash is installed and using version:"
958 echo "$(bash --version)" | indent2
961 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
962 echo -e $RED"python3 is required to run the test environment, pls install"$ERED
965 echo " python3 is installed and using version: $(python3 --version)"
968 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
969 echo -e $RED"docker is required to run the test environment, pls install"$ERED
972 echo " docker is installed and using versions:"
973 echo " $(docker version --format 'Client version {{.Client.Version}} Server version {{.Server.Version}}')"
975 tmp=$(which docker-compose)
976 if [ $? -ne 0 ] || [ -z "$tmp" ]; then
977 if [ $RUNMODE == "DOCKER" ]; then
978 echo -e $RED"docker-compose is required to run the test environment, pls install"$ERED
982 tmp=$(docker-compose version --short)
983 echo " docker-compose installed and using version $tmp"
984 if [[ "$tmp" == *'v2'* ]]; then
985 DOCKER_COMPOSE_VERION="V2"
989 if [ $? -ne 0 ] || [ -z tmp ]; then
990 if [ $RUNMODE == "KUBE" ]; then
991 echo -e $RED"kubectl is required to run the test environment in kubernetes mode, pls install"$ERED
995 if [ $RUNMODE == "KUBE" ]; then
996 echo " kubectl is installed and using versions:"
997 echo $(kubectl version --short=true) | indent2
998 res=$(kubectl cluster-info 2>&1)
999 if [ $? -ne 0 ]; then
1000 echo -e "$BOLD$RED############################################# $ERED$EBOLD"
1001 echo -e $BOLD$RED"Command 'kubectl cluster-info' returned error $ERED$EBOLD"
1002 echo -e "$BOLD$RED############################################# $ERED$EBOLD"
1004 echo "kubectl response:"
1007 echo "This script may have been started with user with no permission to run kubectl"
1008 echo "Try running with 'sudo' or set 'KUBECONFIG'"
1009 echo "Do either 1, 2 or 3 "
1012 echo "Run with sudo"
1013 echo -e $BOLD"sudo <test-script-and-parameters>"$EBOLD
1016 echo "Export KUBECONFIG and pass env to sudo - (replace user)"
1017 echo -e $BOLD"export KUBECONFIG='/home/<user>/.kube/config'"$EBOLD
1018 echo -e $BOLD"sudo -E <test-script-and-parameters>"$EBOLD
1021 echo "Set KUBECONFIG inline (replace user)"
1022 echo -e $BOLD"sudo KUBECONFIG='/home/<user>/.kube/config' <test-script-and-parameters>"$EBOLD
1026 echo " Node(s) and container runtime config"
1027 kubectl get nodes -o wide | indent2
1033 echo -e $BOLD"Checking configured image setting for this test case"$EBOLD
1035 #Temp var to check for image variable name errors
1037 #Create a file with image info for later printing as a table
1038 image_list_file="./tmp/.image-list"
1039 echo -e "Application\tApp short name\tImage\ttag\ttag-switch" > $image_list_file
1041 # Check if image env var is set and if so export the env var with image to use (used by docker compose files)
1042 # arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>
1043 __check_and_create_image_var() {
1045 if [ $# -ne 6 ]; then
1046 echo "Expected arg: <app-short-name> <target-variable-name> <image-variable-name> <image-tag-variable-name> <tag-suffix> <image name>"
1051 __check_included_image $1
1052 if [ $? -ne 0 ]; then
1053 echo -e "$6\t$1\t<image-excluded>\t<no-tag>" >> $image_list_file
1054 # Image is excluded since the corresponding app is not used in this test
1057 tmp=${6}"\t"${1}"\t"
1058 #Create var from the input var names
1063 optional_image_repo_target=""
1065 if [ -z $image ]; then
1066 __check_ignore_image $1
1067 if [ $? -eq 0 ]; then
1069 if [ -z "$6" ]; then
1070 app_ds="<app ignored>"
1072 echo -e "$app_ds\t$1\t<image-ignored>\t<no-tag>" >> $image_list_file
1073 # Image is ignored since the corresponding the images is not set in the env file
1074 __remove_included_image $1 # Remove the image from the list of included images
1077 echo -e $RED"\$"$3" not set in $TEST_ENV_VAR_FILE"$ERED
1080 tmp=$tmp"<no-image>\t"
1083 optional_image_repo_target=$image
1085 #Add repo depending on image type
1086 if [ "$5" == "REMOTE_RELEASE" ]; then
1087 image=$NEXUS_RELEASE_REPO$image
1089 if [ "$5" == "REMOTE" ]; then
1090 image=$NEXUS_STAGING_REPO$image
1092 if [ "$5" == "REMOTE_SNAPSHOT" ]; then
1093 image=$NEXUS_SNAPSHOT_REPO$image
1095 if [ "$5" == "REMOTE_PROXY" ]; then
1096 image=$NEXUS_PROXY_REPO$image
1098 if [ "$5" == "REMOTE_RELEASE_ONAP" ]; then
1099 image=$NEXUS_RELEASE_REPO_ONAP$image
1101 if [ "$5" == "REMOTE_RELEASE_ORAN" ]; then
1102 image=$NEXUS_RELEASE_REPO_ORAN$image
1104 #No nexus repo added for local images, tag: LOCAL
1107 if [ -z $tag ]; then
1108 echo -e $RED"\$"$tmptag" not set in $TEST_ENV_VAR_FILE"$ERED
1111 tmp=$tmp"<no-tag>\t"
1116 echo -e "$tmp" >> $image_list_file
1118 export "${2}"=$image":"$tag #Note, this var may be set to the value of the target value below in __check_and_pull_image
1120 remote_or_local_push=false
1121 if [ ! -z "$IMAGE_REPO_ADR" ] && [[ $5 != *"PROXY"* ]]; then
1122 if [ $5 == "LOCAL" ]; then
1123 remote_or_local_push=true
1125 if [[ $5 == *"REMOTE"* ]]; then
1126 if [ "$IMAGE_REPO_POLICY" == "remote" ]; then
1127 remote_or_local_push=true
1131 if $remote_or_local_push; then # Only re-tag and push images according to policy, if repo is given
1132 export "${2}_SOURCE"=$image":"$tag #Var to keep the actual source image
1133 if [[ $optional_image_repo_target == *"/"* ]]; then # Replace all / with _ for images to push to external repo
1134 optional_image_repo_target_tmp=${optional_image_repo_target//\//_}
1135 optional_image_repo_target=$optional_image_repo_target_tmp
1137 export "${2}_TARGET"=$IMAGE_REPO_ADR"/"$optional_image_repo_target":"$tag #Create image + tag for optional image repo - pushed later if needed
1139 export "${2}_SOURCE"=""
1140 export "${2}_TARGET"=""
1144 # Check if app uses image included in this test run
1145 # Returns 0 if image is included, 1 if not
1146 __check_included_image() {
1147 for im in $INCLUDED_IMAGES; do
1148 if [ "$1" == "$im" ]; then
1155 # Check if app uses a project image
1156 # Returns 0 if image is included, 1 if not
1157 __check_project_image() {
1158 for im in $PROJECT_IMAGES; do
1159 if [ "$1" == "$im" ]; then
1166 # Check if app uses image built by the test script
1167 # Returns 0 if image is included, 1 if not
1168 __check_image_local_build() {
1169 for im in $LOCAL_IMAGE_BUILD; do
1170 if [ "$1" == "$im" ]; then
1177 # Check if app image is conditionally ignored in this test run
1178 # Returns 0 if image is conditionally ignored, 1 if not
1179 __check_ignore_image() {
1180 for im in $CONDITIONALLY_IGNORED_IMAGES; do
1181 if [ "$1" == "$im" ]; then
1188 # Removed image from included list of included images
1189 # Used when an image is marked as conditionally ignored
1190 __remove_included_image() {
1192 for im in $INCLUDED_IMAGES; do
1193 if [ "$1" != "$im" ]; then
1194 tmp_img_rem_list=$tmp_img_rem_list" "$im
1197 INCLUDED_IMAGES=$tmp_img_rem_list
1201 # Check if app is included in the prestarted set of apps
1202 # Returns 0 if image is included, 1 if not
1203 __check_prestarted_image() {
1204 for im in $KUBE_PRESTARTED_IMAGES; do
1205 if [ "$1" == "$im" ]; then
1212 # Check if an app shall use a local image, based on the cmd parameters
1213 __check_image_local_override() {
1214 for im in $USE_LOCAL_IMAGES; do
1215 if [ "$1" == "$im" ]; then
1222 # Check if app uses image override
1223 # Returns the image/tag suffix LOCAL for local image or REMOTE/REMOTE_RELEASE/REMOTE_SNAPSHOT for staging/release/snapshot image
1224 __check_image_override() {
1226 for im in $ORAN_IMAGES_APP_NAMES; do
1227 if [ "$1" == "$im" ]; then
1228 echo "REMOTE_RELEASE_ORAN"
1233 for im in $ONAP_IMAGES_APP_NAMES; do
1234 if [ "$1" == "$im" ]; then
1235 echo "REMOTE_RELEASE_ONAP"
1241 for im in $PROJECT_IMAGES_APP_NAMES; do
1242 if [ "$1" == "$im" ]; then
1247 if [ $found -eq 0 ]; then
1253 if [ $IMAGE_CATEGORY == "RELEASE" ]; then
1254 suffix="REMOTE_RELEASE"
1256 if [ $IMAGE_CATEGORY == "DEV" ]; then
1260 for im in $USE_STAGING_IMAGES; do
1261 if [ "$1" == "$im" ]; then
1266 for im in $USE_RELEASE_IMAGES; do
1267 if [ "$1" == "$im" ]; then
1268 suffix="REMOTE_RELEASE"
1272 for im in $USE_SNAPSHOT_IMAGES; do
1273 if [ "$1" == "$im" ]; then
1274 suffix="REMOTE_SNAPSHOT"
1278 for im in $USE_LOCAL_IMAGES; do
1279 if [ "$1" == "$im" ]; then
1285 if [ $CTR -gt 1 ]; then
1291 # Function to re-tag and image and push to another image repo
1292 __retag_and_push_image() {
1293 if [ ! -z "$IMAGE_REPO_ADR" ]; then
1294 source_image="${!1}"
1295 trg_var_name=$1_"TARGET" # This var is created in func __check_and_create_image_var
1296 target_image="${!trg_var_name}"
1298 if [ -z $target_image ]; then
1299 return 0 # Image with no target shall not be pushed
1302 echo -ne " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1303 tmp=$(docker image tag $source_image ${target_image} )
1304 if [ $? -ne 0 ]; then
1305 docker stop $tmp &> ./tmp/.dockererr
1308 echo -e " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1309 cat ./tmp/.dockererr
1312 echo -e " Attempt to re-tag image to: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1314 echo -ne " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD}${SAMELINE}"
1315 tmp=$(docker push ${target_image} )
1316 if [ $? -ne 0 ]; then
1317 docker stop $tmp &> ./tmp/.dockererr
1320 echo -e " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${RED}Failed${ERED}"
1321 cat ./tmp/.dockererr
1324 echo -e " Attempt to push re-tagged image: ${BOLD}${target_image}${EBOLD} - ${GREEN}OK${EGREEN}"
1326 export "${1}"=$target_image
1331 #Function to check if image exist and stop+remove the container+pull new images as needed
1332 #args <script-start-arg> <descriptive-image-name> <container-base-name> <image-with-tag-var-name>
1333 __check_and_pull_image() {
1335 source_image="${!4}"
1337 echo -e " Checking $BOLD$2$EBOLD container(s) with basename: $BOLD$3$EBOLD using image: $BOLD$source_image$EBOLD"
1338 format_string="\"{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\""
1339 tmp_im=$(docker images --format $format_string $source_image)
1341 if [ $1 == "local" ]; then
1342 if [ -z "$tmp_im" ]; then
1343 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
1347 echo -e " "$2" (local image): \033[1m"$source_image"\033[0m "$GREEN"OK"$EGREEN
1349 elif [ $1 == "remote" ] || [ $1 == "remote-remove" ]; then
1350 if [ $1 == "remote-remove" ]; then
1351 if [ $RUNMODE == "DOCKER" ]; then
1352 echo -ne " Attempt to stop and remove container(s), if running - ${SAMELINE}"
1353 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME})
1354 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1355 docker stop $tmp &> ./tmp/.dockererr
1356 if [ $? -ne 0 ]; then
1359 echo -e $RED" Container(s) could not be stopped - try manual stopping the container(s)"$ERED
1360 cat ./tmp/.dockererr
1364 echo -ne " Attempt to stop and remove container(s), if running - "$GREEN"stopped"$EGREEN"${SAMELINE}"
1365 tmp=$(docker ps -aq --filter name=${3} --filter network=${DOCKER_SIM_NWNAME}) &> /dev/null
1366 if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
1367 docker rm $tmp &> ./tmp/.dockererr
1368 if [ $? -ne 0 ]; then
1371 echo -e $RED" Container(s) could not be removed - try manual removal of the container(s)"$ERED
1372 cat ./tmp/.dockererr
1376 echo -e " Attempt to stop and remove container(s), if running - "$GREEN"stopped removed"$EGREEN
1382 if [ -z "$tmp_im" ]; then
1383 echo -ne " Pulling image${SAMELINE}"
1384 out=$(docker pull $source_image)
1385 if [ $? -ne 0 ]; then
1387 echo -e " Pulling image -$RED could not be pulled"$ERED
1389 echo $out > ./tmp/.dockererr
1393 echo $out > ./tmp/.dockererr
1394 if [[ $out == *"up to date"* ]]; then
1395 echo -e " Pulling image -$GREEN Image is up to date $EGREEN"
1396 elif [[ $out == *"Downloaded newer image"* ]]; then
1397 echo -e " Pulling image -$GREEN Newer image pulled $EGREEN"
1399 echo -e " Pulling image -$GREEN Pulled $EGREEN"
1402 echo -e " Pulling image -$GREEN OK $EGREEN(exists in local repository)"
1406 __retag_and_push_image $4
1411 setup_testenvironment() {
1412 # Check that image env setting are available
1415 # Image var setup for all project images included in the test
1416 for imagename in $APP_SHORT_NAMES; do
1417 __check_included_image $imagename
1419 __check_project_image $imagename
1421 if [ $incl -eq 0 ]; then
1422 if [ $proj -eq 0 ]; then
1423 IMAGE_SUFFIX=$(__check_image_override $imagename)
1424 if [ $? -ne 0 ]; then
1425 echo -e $RED"Image setting from cmd line not consistent for $imagename."$ERED
1431 # A function name is created from the app short name
1432 # for example app short name 'ICS' -> produce the function
1433 # name __ICS_imagesetup
1434 # This function is called and is expected to exist in the imported
1435 # file for the ics test functions
1436 # The resulting function impl will call '__check_and_create_image_var' function
1437 # with appropriate parameters
1438 # If the image suffix is none, then the component decides the suffix
1439 function_pointer="__"$imagename"_imagesetup"
1440 $function_pointer $IMAGE_SUFFIX
1442 function_pointer="__"$imagename"_test_requirements"
1447 #Errors in image setting - exit
1448 if [ $IMAGE_ERR -ne 0 ]; then
1452 #Print a tables of the image settings
1453 echo -e $BOLD"Images configured for start arg: "$START_ARG $EBOLD
1454 column -t -s $'\t' $image_list_file | indent1
1458 #Set the SIM_GROUP var
1459 echo -e $BOLD"Setting var to main dir of all container/simulator scripts"$EBOLD
1460 if [ -z "$SIM_GROUP" ]; then
1461 SIM_GROUP=$AUTOTEST_HOME/../simulator-group
1462 if [ ! -d $SIM_GROUP ]; then
1463 echo "Trying to set env var SIM_GROUP to dir 'simulator-group' in the nontrtric repo, but failed."
1464 echo -e $RED"Please set the SIM_GROUP manually in the applicable $TEST_ENV_VAR_FILE"$ERED
1467 echo " SIM_GROUP auto set to: " $SIM_GROUP
1469 elif [ $SIM_GROUP = *simulator_group ]; then
1470 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
1473 echo " SIM_GROUP env var already set to: " $SIM_GROUP
1478 #Temp var to check for image pull errors
1482 echo -e $BOLD"Deleting namespaces"$EBOLD
1485 if [ "$DELETE_KUBE_NAMESPACES" -eq 1 ]; then
1486 test_env_namespaces=$(kubectl get ns --no-headers -o custom-columns=":metadata.name" -l autotest=engine) #Get list of ns created by the test env
1487 if [ $? -ne 0 ]; then
1488 echo " Cannot get list of namespaces...ignoring delete"
1490 for test_env_ns in $test_env_namespaces; do
1491 __kube_delete_namespace $test_env_ns
1495 echo " Namespace delete option not set"
1500 echo -e $BOLD"Deleting containers"$EBOLD
1502 if [ "$DELETE_CONTAINERS" -eq 1 ]; then
1503 echo " Stopping containers label 'nrttest_app'..."
1504 docker stop $(docker ps -qa --filter "label=nrttest_app") 2> /dev/null
1505 echo " Removing stopped containers..."
1506 docker rm $(docker ps -qa --filter "label=nrttest_app") 2> /dev/null
1508 echo " Contatiner delete option not set"
1512 # The following sequence pull the configured images
1513 echo -e $BOLD"Pulling configured images, if needed"$EBOLD
1514 if [ ! -z "$IMAGE_REPO_ADR" ] && [ $IMAGE_REPO_POLICY == "local" ]; then
1515 echo -e $YELLOW" Excluding all remote image check/pull when running with image repo: $IMAGE_REPO_ADR and image policy $IMAGE_REPO_POLICY"$EYELLOW
1517 for imagename in $APP_SHORT_NAMES; do
1518 __check_included_image $imagename
1520 __check_project_image $imagename
1522 if [ $incl -eq 0 ]; then
1523 if [ $proj -eq 0 ]; then
1524 START_ARG_MOD=$START_ARG
1525 __check_image_local_override $imagename
1526 if [ $? -eq 1 ]; then
1527 START_ARG_MOD="local"
1530 START_ARG_MOD=$START_ARG
1532 __check_image_local_build $imagename
1533 #No pull of images built locally
1534 if [ $? -ne 0 ]; then
1535 # A function name is created from the app short name
1536 # for example app short name 'HTTPPROXY' -> produce the function
1537 # name __HTTPPROXY_imagesetup
1538 # This function is called and is expected to exist in the imported
1539 # file for the httpproxy test functions
1540 # The resulting function impl will call '__check_and_pull_image' function
1541 # with appropriate parameters
1542 function_pointer="__"$imagename"_imagepull"
1543 $function_pointer $START_ARG_MOD $START_ARG
1546 echo -e $YELLOW" Excluding $imagename image from image check/pull"$EYELLOW
1551 #Errors in image setting - exit
1552 if [ $IMAGE_ERR -ne 0 ]; then
1554 echo "#################################################################################################"
1555 echo -e $RED"One or more images could not be pulled or containers using the images could not be stopped/removed"$ERED
1556 echo -e $RED"Or local image, overriding remote image, does not exist"$ERED
1557 if [ $IMAGE_CATEGORY == "DEV" ]; then
1559 echo -e $RED"Note that SNAPSHOT and staging images may be purged from nexus after a certain period."$ERED
1560 echo -e $RED"In addition, the image may not have been updated in the current release so no SNAPSHOT or staging image exists"$ERED
1561 echo -e $RED"In these cases, switch to use a released image instead, use the flag '--use-release-image <App-short-name>'"$ERED
1562 echo -e $RED"Use the 'App-short-name' for the applicable image from the above table: 'Images configured for start arg'."$ERED
1564 echo "#################################################################################################"
1571 echo -e $BOLD"Building images needed for test"$EBOLD
1573 for imagename in $APP_SHORT_NAMES; do
1574 cd $AUTOTEST_HOME #Always reset to orig dir
1575 __check_image_local_build $imagename
1576 if [ $? -eq 0 ]; then
1577 __check_included_image $imagename
1578 if [ $? -eq 0 ]; then
1579 # A function name is created from the app short name
1580 # for example app short name 'MR' -> produce the function
1581 # name __MR_imagebuild
1582 # This function is called and is expected to exist in the imported
1583 # file for the mr test functions
1584 # The resulting function impl shall build the imagee
1585 function_pointer="__"$imagename"_imagebuild"
1589 echo -e $YELLOW" Excluding image for app $imagename from image build"$EYELLOW
1594 cd $AUTOTEST_HOME # Just to make sure...
1598 # Create a table of the images used in the script - from local repo
1599 echo -e $BOLD"Local docker registry images used in this test script"$EBOLD
1601 docker_tmp_file=./tmp/.docker-images-table
1602 format_string="{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\\t{{.CreatedAt}}"
1603 echo -e "Application\tRepository\tTag\tCreated since\tSize\tCreated at" > $docker_tmp_file
1605 for imagename in $APP_SHORT_NAMES; do
1606 __check_included_image $imagename
1607 if [ $? -eq 0 ]; then
1608 # Only print image data if image repo is null, or if image repo is set and image is local
1610 if [ -z "$IMAGE_REPO_ADR" ]; then
1613 __check_image_local_build $imagename
1614 if [ $? -eq 0 ]; then
1618 if [ $print_image_data -eq 1 ]; then
1619 # A function name is created from the app short name
1620 # for example app short name 'MR' -> produce the function
1621 # name __MR_imagebuild
1622 # This function is called and is expected to exist in the imported
1623 # file for the mr test functions
1624 # The resulting function impl shall build the imagee
1625 function_pointer="__"$imagename"_image_data"
1626 $function_pointer "$format_string" $docker_tmp_file
1631 column -t -s $'\t' $docker_tmp_file | indent1
1635 if [ ! -z "$IMAGE_REPO_ADR" ]; then
1637 # Create a table of the images used in the script - from remote repo
1638 echo -e $BOLD"Remote repo images used in this test script"$EBOLD
1639 echo -e $YELLOW"-- Note: These image will be pulled when the container starts. Images not managed by the test engine --"$EYELLOW
1641 docker_tmp_file=./tmp/.docker-images-table
1642 format_string="{{.Repository}}\\t{{.Tag}}"
1643 echo -e "Application\tRepository\tTag" > $docker_tmp_file
1645 for imagename in $APP_SHORT_NAMES; do
1646 __check_included_image $imagename
1647 if [ $? -eq 0 ]; then
1648 # Only print image data if image repo is null, or if image repo is set and image is local
1649 __check_image_local_build $imagename
1650 if [ $? -ne 0 ]; then
1651 # A function name is created from the app short name
1652 # for example app short name 'MR' -> produce the function
1653 # name __MR_imagebuild
1654 # This function is called and is expected to exist in the imported
1655 # file for the mr test functions
1656 # The resulting function impl shall build the imagee
1657 function_pointer="__"$imagename"_image_data"
1658 $function_pointer "$format_string" $docker_tmp_file
1663 column -t -s $'\t' $docker_tmp_file | indent1
1668 if [ $RUNMODE == "KUBE" ]; then
1670 echo "================================================================================="
1671 echo "================================================================================="
1673 if [ -z "$IMAGE_REPO_ADR" ]; then
1674 echo -e $YELLOW" The image pull policy is set to 'Never' - assuming a local image repo is available for all images"$EYELLOW
1675 echo -e " This setting only works on single node clusters on the local machine"
1676 echo -e " It does not work with multi-node clusters or remote clusters. "
1677 export KUBE_IMAGE_PULL_POLICY="Never"
1679 echo -e $YELLOW" The image pull policy is set to 'Always'"$EYELLOW
1680 echo -e " This setting work on local clusters, multi-node clusters and remote cluster. "
1681 echo -e " Only locally built images are managed. Remote images are always pulled from remote repos"
1682 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"
1683 export KUBE_IMAGE_PULL_POLICY="Always"
1685 CLUSTER_IP=$(kubectl config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
1686 echo -e $YELLOW" The cluster hostname/ip is: $CLUSTER_IP"$EYELLOW
1688 echo "================================================================================="
1689 echo "================================================================================="
1693 echo -e $BOLD"======================================================="$EBOLD
1694 echo -e $BOLD"== Common test setup completed - test script begins =="$EBOLD
1695 echo -e $BOLD"======================================================="$EBOLD
1700 for imagename in $APP_SHORT_NAMES; do
1701 __check_included_image $imagename
1703 __check_prestarted_image $imagename
1705 if [ $retcode_i -eq 0 ] || [ $retcode_p -eq 0 ]; then
1706 # A function name is created from the app short name
1707 # for example app short name 'RICMSIM' -> produce the function
1708 # name __RICSIM__initial_setup
1709 # This function is called and is expected to exist in the imported
1710 # file for the ricsim test functions
1711 # The resulting function impl shall perform initial setup of port, host etc
1713 function_pointer="__"$imagename"_initial_setup"
1716 function_pointer="__"$imagename"_statisics_setup"
1717 LOG_STAT_ARGS=$LOG_STAT_ARGS" "$($function_pointer)
1721 if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1722 ../common/genstat.sh $RUNMODE $SECONDS $TESTLOGS/$ATC/stat_data.csv $LOG_STAT_ARGS &
1723 COLLECT_RUNTIME_STATS_PID=$!
1728 # Function to print the test result, shall be the last cmd in a test script
1730 # (Function for test scripts)
1734 duration=$((TCTEST_END-TCTEST_START))
1736 echo "-------------------------------------------------------------------------------------------------"
1737 echo "------------------------------------- Test case: "$ATC
1738 echo "------------------------------------- Ended: "$(date)
1739 echo "-------------------------------------------------------------------------------------------------"
1740 echo "-- Description: "$TC_ONELINE_DESCR
1741 echo "-- Execution time: " $duration " seconds"
1742 echo "-- Used env file: "$TEST_ENV_VAR_FILE
1743 echo "-------------------------------------------------------------------------------------------------"
1744 echo "------------------------------------- RESULTS"
1748 if [ $RES_DEVIATION -gt 0 ]; then
1749 echo "Test case deviations"
1750 echo "===================================="
1754 echo "Timer measurement in the test script"
1755 echo "===================================="
1756 column -t -s $'\t' $TIMER_MEASUREMENTS
1757 if [ $RES_PASS != $RES_TEST ]; then
1758 echo -e $RED"Measurement may not be reliable when there are failed test - failures may cause long measurement values due to timeouts etc."$ERED
1762 if [ $COLLECT_RUNTIME_STATS -eq 1 ]; then
1763 echo "Runtime statistics collected in file: "$TESTLOGS/$ATC/stat_data.csv
1767 total=$((RES_PASS+RES_FAIL))
1768 if [ $RES_TEST -eq 0 ]; then
1769 echo -e "\033[1mNo tests seem to have been executed. Check the script....\033[0m"
1770 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1771 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1772 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1773 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1774 elif [ $total != $RES_TEST ]; then
1775 echo -e "\033[1mTotal number of tests does not match the sum of passed and failed tests. Check the script....\033[0m"
1776 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1777 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1778 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1779 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1780 elif [ $RES_CONF_FAIL -ne 0 ]; then
1781 echo -e "\033[1mOne or more configurations has failed. Check the script log....\033[0m"
1782 echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
1783 echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
1784 echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
1785 echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
1786 elif [ $RES_PASS = $RES_TEST ]; then
1787 echo -e "All tests \033[32m\033[1mPASS\033[0m"
1788 echo -e "\033[32m\033[1m ___ _ ___ ___ \033[0m"
1789 echo -e "\033[32m\033[1m | _ \/_\ / __/ __| \033[0m"
1790 echo -e "\033[32m\033[1m | _/ _ \\__ \__ \\ \033[0m"
1791 echo -e "\033[32m\033[1m |_|/_/ \_\___/___/ \033[0m"
1794 # Update test suite counter
1795 if [ -f .tmp_tcsuite_pass_ctr ]; then
1796 tmpval=$(< .tmp_tcsuite_pass_ctr)
1798 echo $tmpval > .tmp_tcsuite_pass_ctr
1800 if [ -f .tmp_tcsuite_pass ]; then
1801 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_pass
1803 #Create file with OK exit code
1804 echo "0" > "$AUTOTEST_HOME/.result$ATC.txt"
1805 echo "0" > "$TESTLOGS/$ATC/.result$ATC.txt"
1807 echo -e "One or more tests with status \033[31m\033[1mFAIL\033[0m "
1808 echo -e "\033[31m\033[1m ___ _ ___ _ \033[0m"
1809 echo -e "\033[31m\033[1m | __/_\ |_ _| | \033[0m"
1810 echo -e "\033[31m\033[1m | _/ _ \ | || |__ \033[0m"
1811 echo -e "\033[31m\033[1m |_/_/ \_\___|____|\033[0m"
1813 # Update test suite counter
1814 if [ -f .tmp_tcsuite_fail_ctr ]; then
1815 tmpval=$(< .tmp_tcsuite_fail_ctr)
1817 echo $tmpval > .tmp_tcsuite_fail_ctr
1819 if [ -f .tmp_tcsuite_fail ]; then
1820 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_fail
1824 echo "++++ Number of tests: "$RES_TEST
1825 echo "++++ Number of passed tests: "$RES_PASS
1826 echo "++++ Number of failed tests: "$RES_FAIL
1828 echo "++++ Number of failed configs: "$RES_CONF_FAIL
1830 echo "++++ Number of test case deviations: "$RES_DEVIATION
1832 echo "------------------------------------- Test case complete ---------------------------------"
1833 echo "-------------------------------------------------------------------------------------------------"
1837 #####################################################################
1838 ###### Functions for start, configuring, stoping, cleaning etc ######
1839 #####################################################################
1841 # Start timer for time measurement
1842 # args: <timer message to print> - timer value and message will be printed both on screen
1843 # and in the timer measurement report - if at least one "print_timer is called"
1845 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
1846 TC_TIMER_STARTTIME=$SECONDS
1847 TC_TIMER_TIMER_TEXT="${@:1}"
1848 if [ $# -ne 1 ]; then
1849 __print_err "need 1 arg, <timer message to print>" $@
1850 TC_TIMER_TIMER_TEXT=${FUNCNAME[0]}":"${BASH_LINENO[0]}
1851 echo " Assigning timer name: "$TC_TIMER_TIMER_TEXT
1853 TC_TIMER_CURRENT_FAILS=$(($RES_FAIL+$RES_CONF_FAIL))
1854 echo " Timer started: $(date)"
1857 # Print the running timer the value of the time (in seconds)
1858 # Timer value and message will be printed both on screen and in the timer measurement report
1860 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $TC_TIMER_TIMER_TEXT $EBOLD
1861 if [ -z "$TC_TIMER_STARTTIME" ]; then
1862 __print_err "timer not started" $@
1865 duration=$(($SECONDS-$TC_TIMER_STARTTIME))
1866 if [ $duration -eq 0 ]; then
1867 duration="<1 second"
1869 duration=$duration" seconds"
1871 echo " Timer duration :" $duration
1873 if [ $(($RES_FAIL+$RES_CONF_FAIL)) -ne $TC_TIMER_CURRENT_FAILS ]; then
1874 res="Failures occured during test - timer not reliabled"
1877 echo -e "$TC_TIMER_TIMER_TEXT \t $duration \t $res" >> $TIMER_MEASUREMENTS
1880 # Print info about a deviations from intended tests
1881 # Each deviation counted is also printed in the testreport
1882 # args <deviation message to print>
1884 echo -e $BOLD"DEVIATION(${BASH_LINENO[0]}): "${FUNCNAME[0]} $EBOLD
1885 if [ $# -lt 1 ]; then
1887 __print_err "need 1 or more args, <deviation message to print>" $@
1891 echo -e $BOLD$YELLOW" Test case deviation: ${@:1}"$EYELLOW$EBOLD
1892 echo "Line: ${BASH_LINENO[0]} - ${@:1}" >> $DEVIATION_FILE
1893 __print_current_stats
1897 # Stop at first FAIL test case and take all logs - only for debugging/trouble shooting
1898 __check_stop_at_error() {
1899 if [ $STOP_AT_ERROR -eq 1 ]; then
1900 echo -e $RED"Test script configured to stop at first FAIL, taking all logs and stops"$ERED
1901 store_logs "STOP_AT_ERROR"
1903 # Update test suite counter
1904 if [ -f .tmp_tcsuite_fail_ctr ]; then
1905 tmpval=$(< .tmp_tcsuite_fail_ctr)
1907 echo $tmpval > .tmp_tcsuite_fail_ctr
1909 if [ -f .tmp_tcsuite_fail ]; then
1910 echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution stopped due to error" >> .tmp_tcsuite_fail
1917 # Stop and remove all containers
1919 # (Not for test scripts)
1920 __clean_containers() {
1922 echo -e $BOLD"Docker clean and stopping and removing all running containers, by container name"$EBOLD
1925 running_contr_file="./tmp/running_contr.txt"
1926 > $running_contr_file
1928 # Get list of all containers started by the test script
1929 for imagename in $APP_SHORT_NAMES; do
1930 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
1932 running_contr_file_empty="No docker containers running, started by previous test execution"
1933 if [ -s $running_contr_file ]; then
1934 running_contr_file_empty=""
1937 # Kill all containers started by the test env - to speed up shut down
1938 docker kill $(docker ps -a --filter "label=nrttest_app" --format '{{.Names}}') &> /dev/null
1940 tab_heading1="App display name"
1941 tab_heading2="App short name"
1942 tab_heading3="Container name"
1944 tab_heading1_len=${#tab_heading1}
1945 tab_heading2_len=${#tab_heading2}
1946 tab_heading3_len=${#tab_heading3}
1948 #Calc field lengths of each item in the list of containers
1950 if (( $cntr % 3 == 0 ));then
1951 if [ ${#p} -gt $tab_heading1_len ]; then
1952 tab_heading1_len=${#p}
1955 if (( $cntr % 3 == 1));then
1956 if [ ${#p} -gt $tab_heading2_len ]; then
1957 tab_heading2_len=${#p}
1960 if (( $cntr % 3 == 2));then
1961 if [ ${#p} -gt $tab_heading3_len ]; then
1962 tab_heading3_len=${#p}
1966 done <$running_contr_file
1968 let tab_heading1_len=tab_heading1_len+2
1969 while (( ${#tab_heading1} < $tab_heading1_len)); do
1970 tab_heading1="$tab_heading1"" "
1973 let tab_heading2_len=tab_heading2_len+2
1974 while (( ${#tab_heading2} < $tab_heading2_len)); do
1975 tab_heading2="$tab_heading2"" "
1978 let tab_heading3_len=tab_heading3_len+2
1979 while (( ${#tab_heading3} < $tab_heading3_len)); do
1980 tab_heading3="$tab_heading3"" "
1983 if [ ! -z "$running_contr_file_empty" ]; then
1984 echo $running_contr_file_empty | indent1
1986 echo " $tab_heading1$tab_heading2$tab_heading3"" Actions"
1989 if (( $cntr % 3 == 0 ));then
1992 heading_len=$tab_heading1_len
1994 if (( $cntr % 3 == 1));then
1996 heading_len=$tab_heading2_len
1998 if (( $cntr % 3 == 2));then
2001 heading_len=$tab_heading3_len
2003 while (( ${#heading} < $heading_len)); do
2004 heading="$heading"" "
2007 if (( $cntr % 3 == 2));then
2008 echo -ne $row$SAMELINE
2009 echo -ne " $row ${GREEN}stopping...${EGREEN}${SAMELINE}"
2010 docker stop $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
2011 echo -ne " $row ${GREEN}stopped removing...${EGREEN}${SAMELINE}"
2012 docker rm --force $(docker ps -qa --filter name=${contr} --filter network=$DOCKER_SIM_NWNAME) &> /dev/null
2013 echo -e " $row ${GREEN}stopped removed ${EGREEN}"
2016 done <$running_contr_file
2021 echo -e $BOLD" Removing docker network"$EBOLD
2022 TMP=$(docker network ls -q --filter name=$DOCKER_SIM_NWNAME)
2023 if [ "$TMP" == $DOCKER_SIM_NWNAME ]; then
2024 docker network rm $DOCKER_SIM_NWNAME | indent2
2025 if [ $? -ne 0 ]; then
2026 echo -e $RED" Cannot remove docker network. Manually remove or disconnect containers from $DOCKER_SIM_NWNAME"$ERED
2030 echo -e "$GREEN Done$EGREEN"
2032 echo -e $BOLD" Removing all unused docker neworks"$EBOLD
2033 docker network prune --force | indent2
2034 echo -e "$GREEN Done$EGREEN"
2036 echo -e $BOLD" Removing all unused docker volumes"$EBOLD
2037 docker volume prune --force | indent2
2038 echo -e "$GREEN Done$EGREEN"
2040 echo -e $BOLD" Removing all dangling/untagged docker images"$EBOLD
2041 docker rmi --force $(docker images -q -f dangling=true) &> /dev/null
2042 echo -e "$GREEN Done$EGREEN"
2045 CONTRS=$(docker ps | awk '$1 != "CONTAINER" { n++ }; END { print n+0 }')
2046 if [ $? -eq 0 ]; then
2047 if [ $CONTRS -ne 0 ]; then
2048 echo -e $RED"Containers running, may cause distubance to the test case"$ERED
2049 docker ps -a | indent1
2055 ###################################
2056 ### Functions for kube management
2057 ###################################
2059 # Get resource type for scaling
2060 # args: <resource-name> <namespace>
2061 __kube_get_resource_type() {
2062 kubectl get deployment $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
2063 if [ $? -eq 0 ]; then
2067 kubectl get sts $1 -n $2 1> /dev/null 2> ./tmp/kubeerr
2068 if [ $? -eq 0 ]; then
2072 echo "unknown-resource-type"
2076 # Scale a kube resource to a specific count
2077 # args: <resource-type> <resource-name> <namespace> <target-count>
2078 # (Not for test scripts)
2080 echo -ne " Setting $1 $2 replicas=$4 in namespace $3"$SAMELINE
2081 kubectl scale $1 $2 -n $3 --replicas=$4 1> /dev/null 2> ./tmp/kubeerr
2082 if [ $? -ne 0 ]; then
2083 echo -e " Setting $1 $2 replicas=$4 in namespace $3 $RED Failed $ERED"
2085 echo " Message: $(<./tmp/kubeerr)"
2088 echo -e " Setting $1 $2 replicas=$4 in namespace $3 $GREEN OK $EGREEN"
2093 for i in {1..500}; do
2094 count=$(kubectl get $1/$2 -n $3 -o jsonpath='{.status.replicas}' 2> /dev/null)
2096 if [ -z "$count" ]; then
2097 #No value is sometimes returned for some reason, in case the resource has replica 0
2100 if [ $retcode -ne 0 ]; then
2101 echo -e "$RED Cannot fetch current replica count for $1 $2 in namespace $3 $ERED"
2106 if [ $count -ne $4 ]; then
2107 echo -ne " Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds $SAMELINE"
2110 echo -e " Waiting for $1 $2 replicas=$4 in namespace $3. Replicas=$count after $(($SECONDS-$TSTART)) seconds"
2111 echo -e " Replicas=$4 after $(($SECONDS-$TSTART)) seconds $GREEN OK $EGREEN"
2117 echo -e "$RED Replica count did not reach target replicas=$4. Failed with replicas=$count $ERED"
2122 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and label-id
2123 # This function does not wait for the resource to reach 0
2124 # args: <namespace> <label-name> <label-id>
2125 # (Not for test scripts)
2126 __kube_scale_all_resources() {
2130 resources="deployment replicaset statefulset"
2131 for restype in $resources; do
2132 result=$(kubectl get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2133 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2134 for resid in $result; do
2135 echo -ne " Ordered caling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"$SAMELINE
2136 kubectl scale $restype $resid -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
2137 echo -e " Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0 $GREEN OK $EGREEN"
2143 # Scale all kube resource sets to 0 in a namespace for resources having a certain lable and an optional label-id
2144 # This function do wait for the resource to reach 0
2145 # args: <namespace> <label-name> [ <label-id> ]
2146 # (Not for test scripts)
2147 __kube_scale_and_wait_all_resources() {
2151 if [ -z "$3" ]; then
2152 echo " Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname"
2154 echo " Attempt to scale - deployment replicaset statefulset - in namespace $namespace with label $labelname=$labelid"
2156 resources="deployment replicaset statefulset"
2158 while [ $scaled_all -ne 0 ]; do
2160 for restype in $resources; do
2161 if [ -z "$3" ]; then
2162 result=$(kubectl get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname')].metadata.name}')
2164 result=$(kubectl get $restype -n $namespace -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2166 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2167 for resid in $result; do
2168 echo -e " Ordered scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0"
2169 kubectl scale $restype $resid -n $namespace --replicas=0 1> /dev/null 2> ./tmp/kubeerr
2172 while [ $count -ne 0 ]; do
2173 count=$(kubectl get $restype $resid -n $namespace -o jsonpath='{.status.replicas}' 2> /dev/null)
2174 echo -ne " Scaling $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count"$SAMELINE
2175 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
2180 duration=$(($SECONDS-$T_START))
2181 if [ $duration -gt 100 ]; then
2182 #Forcring count 0, to avoid hanging for failed scaling
2187 echo -e " Scaled $restype $resid in namespace $namespace with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
2194 # Remove all kube resources in a namespace for resources having a certain label and label-id
2195 # This function wait until the resources are gone. Scaling to 0 must have been ordered previously
2196 # args: <namespace> <label-name> <label-id>
2197 # (Not for test scripts)
2198 __kube_delete_all_resources() {
2202 resources="deployments replicaset statefulset services pods configmaps persistentvolumeclaims persistentvolumes serviceaccounts clusterrolebindings"
2203 deleted_resourcetypes=""
2204 for restype in $resources; do
2205 ns_flag="-n $namespace"
2206 ns_text="in namespace $namespace"
2207 if [ $restype == "persistentvolumes" ]; then
2211 if [ $restype == "clusterrolebindings" ]; then
2215 result=$(kubectl get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2216 if [ $? -eq 0 ] && [ ! -z "$result" ]; then
2217 deleted_resourcetypes=$deleted_resourcetypes" "$restype
2218 for resid in $result; do
2219 if [ $restype == "replicaset" ] || [ $restype == "statefulset" ]; then
2221 while [ $count -ne 0 ]; do
2222 count=$(kubectl get $restype $resid $ns_flag -o jsonpath='{.status.replicas}' 2> /dev/null)
2223 echo -ne " Scaling $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count"$SAMELINE
2224 if [ $? -eq 0 ] && [ ! -z "$count" ]; then
2230 echo -e " Scaled $restype $resid $ns_text with label $labelname=$labelid to 0, current count=$count $GREEN OK $EGREEN"
2232 echo -ne " Deleting $restype $resid $ns_text with label $labelname=$labelid "$SAMELINE
2233 kubectl delete --grace-period=1 $restype $resid $ns_flag 1> /dev/null 2> ./tmp/kubeerr
2234 if [ $? -eq 0 ]; then
2235 echo -e " Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN OK $EGREEN"
2237 echo -e " Deleted $restype $resid $ns_text with label $labelname=$labelid $GREEN Does not exist - OK $EGREEN"
2243 if [ ! -z "$deleted_resourcetypes" ]; then
2244 for restype in $deleted_resources; do
2245 ns_flag="-n $namespace"
2246 ns_text="in namespace $namespace"
2247 if [ $restype == "persistentvolumes" ]; then
2251 echo -ne " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted..."$SAMELINE
2254 while [ ! -z "$result" ]; do
2256 result=$(kubectl get $restype $ns_flag -o jsonpath='{.items[?(@.metadata.labels.'$labelname'=="'$labelid'")].metadata.name}')
2257 echo -ne " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds "$SAMELINE
2258 if [ -z "$result" ]; then
2259 echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $GREEN OK $EGREEN"
2260 elif [ $(($SECONDS-$T_START)) -gt 300 ]; then
2261 echo -e " Waiting for $restype $ns_text with label $labelname=$labelid to be deleted...$(($SECONDS-$T_START)) seconds $RED Failed $ERED"
2269 # Creates a namespace if it does not exists
2271 # (Not for test scripts)
2272 __kube_create_namespace() {
2274 #Check if test namespace exists, if not create it
2275 kubectl get namespace $1 1> /dev/null 2> ./tmp/kubeerr
2276 if [ $? -ne 0 ]; then
2277 echo -ne " Creating namespace "$1 $SAMELINE
2278 kubectl create namespace $1 1> /dev/null 2> ./tmp/kubeerr
2279 if [ $? -ne 0 ]; then
2280 echo -e " Creating namespace $1 $RED$BOLD FAILED $EBOLD$ERED"
2282 echo " Message: $(<./tmp/kubeerr)"
2285 kubectl label ns $1 autotest=engine
2286 echo -e " Creating namespace $1 $GREEN$BOLD OK $EBOLD$EGREEN"
2289 echo -e " Creating namespace $1 $GREEN$BOLD Already exists, OK $EBOLD$EGREEN"
2294 # Removes a namespace if it exists
2296 # (Not for test scripts)
2297 __kube_delete_namespace() {
2299 #Check if test namespace exists, if so remove it
2300 kubectl get namespace $1 1> /dev/null 2> ./tmp/kubeerr
2301 if [ $? -eq 0 ]; then
2302 echo -ne " Removing namespace "$1 $SAMELINE
2303 kubectl delete namespace $1 1> /dev/null 2> ./tmp/kubeerr
2304 if [ $? -ne 0 ]; then
2305 echo -e " Removing namespace $1 $RED$BOLD FAILED $EBOLD$ERED"
2307 echo " Message: $(<./tmp/kubeerr)"
2310 echo -e " Removing namespace $1 $GREEN$BOLD OK $EBOLD$EGREEN"
2313 echo -e " Namespace $1 $GREEN$BOLD does not exist, OK $EBOLD$EGREEN"
2318 # Removes a namespace
2320 # (Not for test scripts)
2321 clean_and_create_namespace() {
2324 if [ $# -ne 1 ]; then
2325 __print_err "<namespace>" $@
2328 __kube_delete_namespace $1
2329 if [ $? -ne 0 ]; then
2332 __kube_create_namespace $1
2333 if [ $? -ne 0 ]; then
2339 # Find the host ip of an app (using the service resource)
2340 # args: <app-name> <namespace>
2341 # (Not for test scripts)
2342 __kube_get_service_host() {
2343 if [ $# -ne 2 ]; then
2345 __print_err "need 2 args, <app-name> <namespace>" $@
2348 for timeout in {1..60}; do
2349 host=$(kubectl get svc $1 -n $2 -o jsonpath='{.spec.clusterIP}')
2350 if [ $? -eq 0 ]; then
2351 if [ ! -z "$host" ]; then
2359 echo "host-not-found-fatal-error"
2363 # Find the named port to an app (using the service resource)
2364 # args: <app-name> <namespace> <port-name>
2365 # (Not for test scripts)
2366 __kube_get_service_port() {
2367 if [ $# -ne 3 ]; then
2369 __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2373 for timeout in {1..60}; do
2374 port=$(kubectl get svc $1 -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].port}')
2375 if [ $? -eq 0 ]; then
2376 if [ ! -z "$port" ]; then
2388 # Find the named node port to an app (using the service resource)
2389 # args: <app-name> <namespace> <port-name>
2390 # (Not for test scripts)
2391 __kube_get_service_nodeport() {
2392 if [ $# -ne 3 ]; then
2394 __print_err "need 3 args, <app-name> <namespace> <port-name>" $@
2398 for timeout in {1..60}; do
2399 port=$(kubectl get svc $1 -n $2 -o jsonpath='{...ports[?(@.name=="'$3'")].nodePort}')
2400 if [ $? -eq 0 ]; then
2401 if [ ! -z "$port" ]; then
2413 # Create a kube resource from a yaml template
2414 # args: <resource-type> <resource-name> <template-yaml> <output-yaml>
2415 # (Not for test scripts)
2416 __kube_create_instance() {
2417 echo -ne " Creating $1 $2"$SAMELINE
2419 kubectl apply -f $4 1> /dev/null 2> ./tmp/kubeerr
2420 if [ $? -ne 0 ]; then
2422 echo -e " Creating $1 $2 $RED Failed $ERED"
2423 echo " Message: $(<./tmp/kubeerr)"
2426 echo -e " Creating $1 $2 $GREEN OK $EGREEN"
2430 # Function to create a configmap in kubernetes
2431 # args: <configmap-name> <namespace> <labelname> <labelid> <path-to-data-file> <path-to-output-yaml>
2432 # (Not for test scripts)
2433 __kube_create_configmap() {
2434 echo -ne " Creating configmap $1 "$SAMELINE
2435 envsubst < $5 > $5"_tmp"
2436 cp $5"_tmp" $5 #Need to copy back to orig file name since create configmap neeed the original file name
2437 kubectl create configmap $1 -n $2 --from-file=$5 --dry-run=client -o yaml > $6
2438 if [ $? -ne 0 ]; then
2439 echo -e " Creating configmap $1 $RED Failed $ERED"
2444 kubectl apply -f $6 1> /dev/null 2> ./tmp/kubeerr
2445 if [ $? -ne 0 ]; then
2446 echo -e " Creating configmap $1 $RED Apply failed $ERED"
2447 echo " Message: $(<./tmp/kubeerr)"
2451 kubectl label configmap $1 -n $2 $3"="$4 --overwrite 1> /dev/null 2> ./tmp/kubeerr
2452 if [ $? -ne 0 ]; then
2453 echo -e " Creating configmap $1 $RED Labeling failed $ERED"
2454 echo " Message: $(<./tmp/kubeerr)"
2458 # Log the resulting map
2459 kubectl get configmap $1 -n $2 -o yaml > $6
2461 echo -e " Creating configmap $1 $GREEN OK $EGREEN"
2465 # This function runs a kubectl cmd where a single output value is expected, for example get ip with jsonpath filter.
2466 # The function retries up to the timeout given in the cmd flag '--cluster-timeout'
2467 # args: <full kubectl cmd with parameters>
2468 # (Not for test scripts)
2469 __kube_cmd_with_timeout() {
2470 TS_TMP=$(($SECONDS+$CLUSTER_TIME_OUT))
2473 kube_cmd_result=$($@)
2474 if [ $? -ne 0 ]; then
2477 if [ $SECONDS -ge $TS_TMP ] || [ ! -z "$kube_cmd_result" ] ; then
2478 echo $kube_cmd_result
2485 # This function starts a pod that cleans a the contents of a path mounted as a pvc
2486 # After this action the pod should terminate
2487 # This should only be executed when the pod owning the pvc is not running
2488 # args: <appname> <namespace> <pvc-name> <path-to remove>
2489 # (Not for test scripts)
2490 __kube_clean_pvc() {
2492 #using env vars setup in pvccleaner_api_functions.sh
2494 export PVC_CLEANER_NAMESPACE=$2
2495 export PVC_CLEANER_CLAIMNAME=$3
2496 export PVC_CLEANER_RM_PATH=$4
2497 export PVC_CLEANER_APP_NAME
2498 input_yaml=$SIM_GROUP"/"$PVC_CLEANER_COMPOSE_DIR"/"pvc-cleaner.yaml
2499 output_yaml=$PWD/tmp/$2-pvc-cleaner.yaml
2501 envsubst < $input_yaml > $output_yaml
2503 kubectl delete -f $output_yaml 1> /dev/null 2> /dev/null # Delete the previous terminated pod - if existing
2505 __kube_create_instance pod $PVC_CLEANER_APP_NAME $input_yaml $output_yaml
2506 if [ $? -ne 0 ]; then
2507 echo $YELLOW" Could not clean pvc for app: $1 - persistent storage not clean - tests may not work"
2511 term_ts=$(($SECONDS+30))
2512 while [ $term_ts -gt $SECONDS ]; do
2513 pod_status=$(kubectl get pod pvc-cleaner -n $PVC_CLEANER_NAMESPACE --no-headers -o custom-columns=":status.phase")
2514 if [ "$pod_status" == "Succeeded" ]; then
2521 # This function scales or deletes all resources for app selected by the testcase.
2523 # (Not for test scripts)
2525 echo -e $BOLD"Initialize kube pods/statefulsets/replicaset to initial state"$EBOLD
2527 # Scale prestarted or managed apps
2528 for imagename in $APP_SHORT_NAMES; do
2529 # A function name is created from the app short name
2530 # for example app short name 'RICMSIM' -> produce the function
2531 # name __RICSIM_kube_scale_zero or __RICSIM_kube_scale_zero_and_wait
2532 # This function is called and is expected to exist in the imported
2533 # file for the ricsim test functions
2534 # The resulting function impl shall scale the resources to 0
2535 # For prestarted apps, the function waits until the resources are 0
2536 # For included (not prestated) apps, the scaling is just ordered
2537 __check_prestarted_image $imagename
2538 if [ $? -eq 0 ]; then
2539 function_pointer="__"$imagename"_kube_scale_zero_and_wait"
2540 echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2543 __check_included_image $imagename
2544 if [ $? -eq 0 ]; then
2545 function_pointer="__"$imagename"_kube_scale_zero"
2546 echo -e " Scaling all kube resources for app $BOLD $imagename $EBOLD to 0"
2552 # Delete managed apps
2553 for imagename in $APP_SHORT_NAMES; do
2554 __check_included_image $imagename
2555 if [ $? -eq 0 ]; then
2556 __check_prestarted_image $imagename
2557 if [ $? -ne 0 ]; then
2558 # A function name is created from the app short name
2559 # for example app short name 'RICMSIM' -> produce the function
2560 # name __RICSIM__kube_delete_all
2561 # This function is called and is expected to exist in the imported
2562 # file for the ricsim test functions
2563 # The resulting function impl shall delete all its resources
2564 function_pointer="__"$imagename"_kube_delete_all"
2565 echo -e " Deleting all kube resources for app $BOLD $imagename $EBOLD"
2574 # Function stop and remove all containers (docker) and services/deployments etc(kube)
2576 # Function for test script
2577 clean_environment() {
2578 if [ $RUNMODE == "KUBE" ]; then
2580 if [ $PRE_CLEAN -eq 1 ]; then
2581 echo " Cleaning docker resouces to free up resources, may take time..."
2582 ../common/clean_docker.sh 2>&1 /dev/null
2587 if [ $PRE_CLEAN -eq 1 ]; then
2588 echo " Cleaning kubernetes resouces to free up resources, may take time..."
2589 ../common/clean_kube.sh 2>&1 /dev/null
2595 # 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
2597 # (Function for test scripts)
2598 auto_clean_environment() {
2600 if [ "$AUTO_CLEAN" == "auto" ]; then
2601 echo -e $BOLD"Initiating automatic cleaning of environment"$EBOLD
2606 # Function to sleep a test case for a numner of seconds. Prints the optional text args as info
2607 # args: <sleep-time-in-sec> [any-text-in-quotes-to-be-printed]
2608 # (Function for test scripts)
2611 echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
2612 if [ $# -lt 1 ]; then
2614 __print_err "need at least one arg, <sleep-time-in-sec> [any-text-to-printed]" $@
2617 #echo "---- Sleep for " $1 " seconds ---- "$2
2619 duration=$((SECONDS-start))
2620 while [ $duration -lt $1 ]; do
2621 echo -ne " Slept for ${duration} seconds${SAMELINE}"
2623 duration=$((SECONDS-start))
2625 echo -ne " Slept for ${duration} seconds${SAMELINE}"
2629 # Print error info for the call in the parent script (test case). Arg: <error-message-to-print>
2630 # Not to be called from the test script itself.
2632 echo -e $RED ${FUNCNAME[1]} " "$1" " ${BASH_SOURCE[2]} " line" ${BASH_LINENO[1]} $ERED
2633 if [ $# -gt 1 ]; then
2634 echo -e $RED" Got: "${FUNCNAME[1]} ${@:2} $ERED
2637 __check_stop_at_error
2640 # Function to create the docker network for the test
2641 # Not to be called from the test script itself.
2642 __create_docker_network() {
2643 tmp=$(docker network ls --format={{.Name}} --filter name=$DOCKER_SIM_NWNAME)
2644 if [ $? -ne 0 ]; then
2645 echo -e $RED" Could not check if docker network $DOCKER_SIM_NWNAME exists"$ERED
2648 if [ "$tmp" != $DOCKER_SIM_NWNAME ]; then
2649 echo -e " Creating docker network:$BOLD $DOCKER_SIM_NWNAME $EBOLD"
2650 docker network create $DOCKER_SIM_NWNAME | indent2
2651 if [ $? -ne 0 ]; then
2652 echo -e $RED" Could not create docker network $DOCKER_SIM_NWNAME"$ERED
2655 echo -e "$GREEN Done$EGREEN"
2658 echo -e " Docker network $DOCKER_SIM_NWNAME already exists$GREEN OK $EGREEN"
2662 # Function to start container with docker-compose and wait until all are in state running.
2663 # If the <docker-compose-file> is empty, the default 'docker-compose.yml' is assumed.
2664 #args: <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+
2665 # (Not for test scripts)
2666 __start_container() {
2668 if [ $# -lt 5 ]; then
2670 __print_err "need 5 or more args, <docker-compose-dir> <docker-compose-file> <docker-compose-arg>|NODOCKERARGS <count> <app-name>+" $@
2674 __create_docker_network
2682 if [ -z "$compose_file" ]; then
2683 compose_file="docker-compose.yml"
2691 envsubst < $compose_file > "gen_"$compose_file
2692 compose_file="gen_"$compose_file
2693 if [ $DOCKER_COMPOSE_VERION == "V1" ]; then
2694 docker_compose_cmd="docker-compose"
2696 docker_compose_cmd="docker compose"
2699 if [ "$compose_args" == "NODOCKERARGS" ]; then
2700 $docker_compose_cmd -f $compose_file up -d &> .dockererr
2701 if [ $? -ne 0 ]; then
2702 echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2704 echo -e $RED"Stopping script...."$ERED
2708 $docker_compose_cmd -f $compose_file up -d $compose_args &> .dockererr
2709 if [ $? -ne 0 ]; then
2710 echo -e $RED"Problem to launch container(s) with docker-compose"$ERED
2712 echo -e $RED"Stopping script...."$ERED
2720 while [ $appindex -lt $appcount ]; do
2724 for i in {1..10}; do
2725 if [ "$(docker inspect --format '{{ .State.Running }}' $appname)" == "true" ]; then
2726 echo -e " Container $BOLD${appname}$EBOLD$GREEN running$EGREEN on$BOLD image $(docker inspect --format '{{ .Config.Image }}' ${appname}) $EBOLD"
2733 if [ $app_started -eq 0 ]; then
2736 echo -e $RED" Container $BOLD${appname}$EBOLD could not be started"$ERED
2737 echo -e $RED" Stopping script..."$ERED
2740 let appindex=appindex+1
2745 # Function to check if container/service is responding to http/https
2746 # args: <container-name>|<service-name> url
2747 # (Not for test scripts)
2748 __check_service_start() {
2750 if [ $# -ne 2 ]; then
2752 __print_err "need 2 args, <container-name>|<service-name> url" $@
2756 if [ $RUNMODE == "KUBE" ]; then
2757 ENTITY="service/set/deployment"
2763 echo -ne " Container $BOLD${appname}$EBOLD starting${SAMELINE}"
2767 echo -ne " Waiting for ${ENTITY} ${appname} service status...${SAMELINE}"
2770 while (( $TSTART+600 > $SECONDS )); do
2771 result="$(__do_curl -m 10 $url)"
2772 if [ $? -eq 0 ]; then
2773 if [ ${#result} -gt 15 ]; then
2774 #If response is too long, truncate
2775 result="...response text too long, omitted"
2777 echo -ne " Waiting for {ENTITY} $BOLD${appname}$EBOLD service status on ${3}, result: $result${SAMELINE}"
2778 echo -ne " The ${ENTITY} $BOLD${appname}$EBOLD$GREEN is alive$EGREEN, responds to service status:$GREEN $result $EGREEN on ${url} after $(($SECONDS-$TSTART)) seconds"
2784 if (( $TS_OFFSET > 5 )); then
2787 while [ $(($TS_TMP+$TS_OFFSET)) -gt $SECONDS ]; do
2788 echo -ne " Waiting for ${ENTITY} ${appname} service status on ${url}...$(($SECONDS-$TSTART)) seconds, retrying in $(($TS_TMP+$TS_OFFSET-$SECONDS)) seconds ${SAMELINE}"
2792 let loop_ctr=loop_ctr+1
2795 if [ "$pa_st" = "false" ]; then
2797 echo -e $RED" The ${ENTITY} ${appname} did not respond to service status on ${url} in $(($SECONDS-$TSTART)) seconds"$ERED
2810 __check_container_logs() {
2818 echo -e $BOLD"Checking $dispname container $appname log ($logpath) for WARNINGs and ERRORs"$EBOLD
2820 if [ $RUNMODE == "KUBE" ]; then
2821 echo -e $YELLOW" Internal log for $dispname not checked in kube"$EYELLOW
2825 #tmp=$(docker ps | grep $appname)
2826 tmp=$(docker ps -q --filter name=$appname) #get the container id
2827 if [ -z "$tmp" ]; then #Only check logs for running Policy Agent apps
2828 echo " "$dispname" is not running, no check made"
2831 foundentries="$(docker exec -t $tmp grep $warning $logpath | wc -l)"
2832 if [ $? -ne 0 ];then
2833 echo " Problem to search $appname log $logpath"
2835 if [ $foundentries -eq 0 ]; then
2836 echo " No WARN entries found in $appname log $logpath"
2838 echo -e " Found \033[1m"$foundentries"\033[0m WARN entries in $appname log $logpath"
2841 foundentries="$(docker exec -t $tmp grep $error $logpath | wc -l)"
2842 if [ $? -ne 0 ];then
2843 echo " Problem to search $appname log $logpath"
2845 if [ $foundentries -eq 0 ]; then
2846 echo " No ERR entries found in $appname log $logpath"
2848 echo -e $RED" Found \033[1m"$foundentries"\033[0m"$RED" ERR entries in $appname log $logpath"$ERED
2854 # Store all container logs and other logs in the log dir for the script
2855 # Logs are stored with a prefix in case logs should be stored several times during a test
2856 # args: <logfile-prefix>
2857 # (Function for test scripts)
2859 if [ $# != 1 ]; then
2861 __print_err "need one arg, <file-prefix>" $@
2864 echo -e $BOLD"Storing all docker/kube container logs and other test logs in $TESTLOGS/$ATC using prefix: "$1$EBOLD
2866 docker stats --no-stream > $TESTLOGS/$ATC/$1_docker_stats.log 2>&1
2868 docker ps -a > $TESTLOGS/$ATC/$1_docker_ps.log 2>&1
2870 cp .httplog_${ATC}.txt $TESTLOGS/$ATC/$1_httplog_${ATC}.txt 2>&1
2872 if [ $RUNMODE == "DOCKER" ]; then
2874 # Store docker logs for all container
2875 for imagename in $APP_SHORT_NAMES; do
2876 __check_included_image $imagename
2877 if [ $? -eq 0 ]; then
2878 # A function name is created from the app short name
2879 # for example app short name 'RICMSIM' -> produce the function
2880 # name __RICSIM__store_docker_logs
2881 # This function is called and is expected to exist in the imported
2882 # file for the ricsim test functions
2883 # The resulting function impl shall store the docker logs for each container
2884 function_pointer="__"$imagename"_store_docker_logs"
2885 $function_pointer "$TESTLOGS/$ATC/" $1
2889 if [ $RUNMODE == "KUBE" ]; then
2890 namespaces=$(kubectl get namespaces -o jsonpath='{.items[?(@.metadata.name)].metadata.name}')
2891 for nsid in $namespaces; do
2892 pods=$(kubectl get pods -n $nsid -o jsonpath='{.items[?(@.metadata.labels.autotest)].metadata.name}')
2893 for podid in $pods; do
2894 kubectl logs -n $nsid $podid > $TESTLOGS/$ATC/$1_${podid}.log
2904 # Generic curl function, assumes all 200-codes are ok
2905 # args: <valid-curl-args-including full url>
2906 # returns: <returned response (without respose code)> or "<no-response-from-server>" or "<not found, <http-code>>""
2907 # returns: The return code is 0 for ok and 1 for not ok
2909 echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
2911 if [ ! -z "$KUBE_PROXY_PATH" ]; then
2912 if [ $KUBE_PROXY_HTTPX == "http" ]; then
2913 proxyflag=" --proxy $KUBE_PROXY_PATH"
2915 proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
2918 curlString="curl -skw %{http_code} $proxyflag $@"
2919 echo " CMD: $curlString" >> $HTTPLOG
2922 echo " RESP: $res" >> $HTTPLOG
2923 echo " RETCODE: $retcode" >> $HTTPLOG
2924 if [ $retcode -ne 0 ]; then
2925 echo "<no-response-from-server>"
2928 http_code="${res:${#res}-3}"
2929 if [ ${#res} -eq 3 ]; then
2930 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
2931 echo "<no-response-from-server>"
2937 if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
2938 echo "<not found, resp:${http_code}>"
2941 if [ $# -eq 2 ]; then
2942 echo "${res:0:${#res}-3}" | xargs
2944 echo "${res:0:${#res}-3}"
2951 #######################################
2952 ### Basic helper function for test cases
2953 #######################################
2955 # Test a simulator container variable value towards target value using an condition operator with an optional timeout.
2956 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> - This test is done
2957 # immediately and sets pass or fail depending on the result of comparing variable and target using the operator.
2958 # Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> <timeout> - This test waits up to the timeout
2959 # before setting pass or fail depending on the result of comparing variable and target using the operator.
2960 # 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.
2961 # Not to be called from test script.
2964 checkjsonarraycount=0
2965 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
2966 if [ $# -eq 6 ]; then
2967 if [[ $3 == "json:"* ]]; then
2968 checkjsonarraycount=1
2971 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds"$EBOLD
2972 echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds" >> $HTTPLOG
2975 ((TEST_SEQUENCE_NR++))
2979 if [ $checkjsonarraycount -eq 0 ]; then
2980 result="$(__do_curl $2$3)"
2982 result=${result//[[:blank:]]/} #Strip blanks
2985 result="$(__do_curl $2$path)"
2987 echo "$result" > ./tmp/.tmp.curl.json
2988 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
2990 duration=$((SECONDS-start))
2991 echo -ne " Result=${result} after ${duration} seconds${SAMELINE}"
2993 if [ $retcode -ne 0 ]; then
2994 if [ $duration -gt $6 ]; then
2996 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
2997 __print_current_stats
2998 __check_stop_at_error
3001 elif [ "$4" == "=" ] && [ "$result" -eq $5 ]; then
3003 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3004 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3005 __print_current_stats
3007 elif [ "$4" == ">" ] && [ "$result" -gt $5 ]; then
3009 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3010 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3011 __print_current_stats
3013 elif [ "$4" == "<" ] && [ "$result" -lt $5 ]; then
3015 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3016 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3017 __print_current_stats
3019 elif [ "$4" == ">=" ] && [ "$result" -ge $5 ]; then
3021 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3022 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3023 __print_current_stats
3025 elif [ "$4" == "contain_str" ] && [[ $result =~ $5 ]]; then
3027 echo -e " Result=${result} after ${duration} seconds${SAMELINE}"
3028 echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
3029 __print_current_stats
3032 if [ $duration -gt $6 ]; then
3034 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
3035 __print_current_stats
3036 __check_stop_at_error
3042 elif [ $# -eq 5 ]; then
3043 if [[ $3 == "json:"* ]]; then
3044 checkjsonarraycount=1
3047 echo -e $BOLD"TEST $TEST_SEQUENCE_NR (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}"$EBOLD
3048 echo "TEST $TEST_SEQUENCE_NR - ${TIMESTAMP}: (${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}" >> $HTTPLOG
3050 ((TEST_SEQUENCE_NR++))
3051 if [ $checkjsonarraycount -eq 0 ]; then
3052 result="$(__do_curl $2$3)"
3054 result=${result//[[:blank:]]/} #Strip blanks
3057 result="$(__do_curl $2$path)"
3059 echo "$result" > ./tmp/.tmp.curl.json
3060 result=$(python3 ../common/count_json_elements.py "./tmp/.tmp.curl.json")
3062 if [ $retcode -ne 0 ]; then
3064 echo -e $RED" FAIL ${ERED}- ${3} ${4} ${5} not reached, result = ${result}"
3065 __print_current_stats
3066 __check_stop_at_error
3067 elif [ "$4" == "=" ] && [ "$result" -eq $5 ]; then
3069 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3070 __print_current_stats
3071 elif [ "$4" == ">" ] && [ "$result" -gt $5 ]; then
3073 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3074 __print_current_stats
3075 elif [ "$4" == "<" ] && [ "$result" -lt $5 ]; then
3077 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3078 __print_current_stats
3079 elif [ "$4" == ">=" ] && [ "$result" -ge $5 ]; then
3081 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3082 __print_current_stats
3083 elif [ "$4" == "contain_str" ] && [[ $result =~ $5 ]]; then
3085 echo -e $GREEN" PASS${EGREEN} - Result=${result}"
3086 __print_current_stats
3089 echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached, result = ${result}"
3090 __print_current_stats
3091 __check_stop_at_error
3094 echo "Wrong args to __var_test, needs five or six args: <simulator-name> <host> <variable-name> <condition-operator> <target-value> [ <timeout> ]"