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 container/service managemnt functions test functions for the Callback Reciver
23 ################ Test engine functions ################
25 # Create the image var used during the test
26 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
27 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
29 __check_and_create_image_var CR "CR_IMAGE" "CR_IMAGE_BASE" "CR_IMAGE_TAG" LOCAL "$CR_DISPLAY_NAME"
32 # Pull image from remote repo or use locally built image
33 # arg: <pull-policy-override> <pull-policy-original>
34 # <pull-policy-override> Shall be used for images allowing overriding. For example use a local image when test is started to use released images
35 # <pull-policy-original> Shall be used for images that does not allow overriding
36 # Both var may contain: 'remote', 'remote-remove' or 'local'
38 echo -e $RED" Image for app CR shall never be pulled from remote repo"$ERED
41 # Build image (only for simulator or interfaces stubs owned by the test environment)
42 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
43 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
46 echo " Building CR - $CR_DISPLAY_NAME - image: $CR_IMAGE"
47 docker build --build-arg NEXUS_PROXY_REPO=$NEXUS_PROXY_REPO -t $CR_IMAGE . &> .dockererr
49 echo -e $GREEN" Build Ok"$EGREEN
50 __retag_and_push_image CR_IMAGE
55 echo -e $RED" Build Failed"$ERED
58 echo -e $RED"Exiting...."$ERED
63 # Generate a string for each included image using the app display name and a docker images format string
64 # If a custom image repo is used then also the source image from the local repo is listed
65 # arg: <docker-images-format-string> <file-to-append>
67 echo -e "$CR_DISPLAY_NAME\t$(docker images --format $1 $CR_IMAGE)" >> $2
68 if [ ! -z "$CR_IMAGE_SOURCE" ]; then
69 echo -e "-- source image --\t$(docker images --format $1 $CR_IMAGE_SOURCE)" >> $2
73 # Scale kubernetes resources to zero
74 # All resources shall be ordered to be scaled to 0, if relevant. If not relevant to scale, then do no action.
75 # This function is called for apps fully managed by the test script
76 __CR_kube_scale_zero() {
77 __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest CR
80 # Scale kubernetes resources to zero and wait until this has been accomplished, if relevant. If not relevant to scale, then do no action.
81 # This function is called for prestarted apps not managed by the test script.
82 __CR_kube_scale_zero_and_wait() {
83 echo -e $RED" CR app is not scaled in this state"$ERED
86 # Delete all kube resouces for the app
87 # This function is called for apps managed by the test script.
88 __CR_kube_delete_all() {
89 __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest CR
93 # This function is called for apps managed by the test script.
94 # args: <log-dir> <file-prexix>
95 __CR_store_docker_logs() {
96 if [ $RUNMODE == "KUBE" ]; then
97 kubectl logs -l "autotest=CR" -n $KUBE_SIM_NAMESPACE --tail=-1 > $1$2_cr.log 2>&1
99 docker logs $CR_APP_NAME > $1$2_cr.log 2>&1
103 # Initial setup of protocol, host and ports
104 # This function is called for apps managed by the test script.
106 __CR_initial_setup() {
110 #######################################################
116 # Set http as the protocol to use for all communication to the Dmaap adapter
118 # (Function for test scripts)
120 __cr_set_protocoll "http" $CR_INTERNAL_PORT $CR_EXTERNAL_PORT
123 # Set https as the protocol to use for all communication to the Dmaap adapter
125 # (Function for test scripts)
127 __cr_set_protocoll "https" $CR_INTERNAL_SECURE_PORT $CR_EXTERNAL_SECURE_PORT
130 # Setup paths to svc/container for internal and external access
131 # args: <protocol> <internal-port> <external-port>
132 __cr_set_protocoll() {
133 echo -e $BOLD"$CR_DISPLAY_NAME protocol setting"$EBOLD
134 echo -e " Using $BOLD http $EBOLD towards $CR_DISPLAY_NAME"
136 ## Access to Dmaap adapter
138 # CR_SERVICE_PATH is the base path to cr
139 CR_SERVICE_PATH=$1"://"$CR_APP_NAME":"$2 # docker access, container->container and script->container via proxy
140 if [ $RUNMODE == "KUBE" ]; then
141 CR_SERVICE_PATH=$1"://"$CR_APP_NAME.$KUBE_SIM_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
143 # Service paths are used in test script to provide callbacck urls to app
144 CR_SERVICE_MR_PATH=$CR_SERVICE_PATH$CR_APP_CALLBACK_MR #Only for messages from dmaap adapter/mediator
145 CR_SERVICE_APP_PATH=$CR_SERVICE_PATH$CR_APP_CALLBACK #For general callbacks from apps
147 # CR_ADAPTER used for switching between REST and DMAAP (only REST supported currently)
148 CR_ADAPTER_TYPE="REST"
149 CR_ADAPTER=$CR_SERVICE_PATH
154 # Export env vars for config files, docker compose and kube resources
158 export CR_DISPLAY_NAME
160 export KUBE_SIM_NAMESPACE
161 export DOCKER_SIM_NWNAME
165 export CR_INTERNAL_PORT
166 export CR_INTERNAL_SECURE_PORT
167 export CR_EXTERNAL_PORT
168 export CR_EXTERNAL_SECURE_PORT
171 # Start the Callback reciver in the simulator group
173 # (Function for test scripts)
176 echo -e $BOLD"Starting $CR_DISPLAY_NAME"$EBOLD
178 if [ $RUNMODE == "KUBE" ]; then
180 # Check if app shall be fully managed by the test script
181 __check_included_image "CR"
184 # Check if app shall only be used by the testscipt
185 __check_prestarted_image "CR"
188 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
189 echo -e $RED"The $CR_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
190 echo -e $RED"The $CR_APP_NAME will not be started"$ERED
193 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
194 echo -e $RED"The $CR_APP_NAME app is included both as managed and prestarted in this test script"$ERED
195 echo -e $RED"The $CR_APP_NAME will not be started"$ERED
199 # Check if app shall be used - not managed - by the test script
200 if [ $retcode_p -eq 0 ]; then
201 echo -e " Using existing $CR_APP_NAME deployment and service"
202 echo " Setting CR replicas=1"
203 __kube_scale deployment $CR_APP_NAME $KUBE_SIM_NAMESPACE 1
206 if [ $retcode_i -eq 0 ]; then
207 echo -e " Creating $CR_APP_NAME deployment and service"
211 __kube_create_namespace $KUBE_SIM_NAMESPACE
214 input_yaml=$SIM_GROUP"/"$CR_COMPOSE_DIR"/"svc.yaml
215 output_yaml=$PWD/tmp/cr_svc.yaml
216 __kube_create_instance service $CR_APP_NAME $input_yaml $output_yaml
219 input_yaml=$SIM_GROUP"/"$CR_COMPOSE_DIR"/"app.yaml
220 output_yaml=$PWD/tmp/cr_app.yaml
221 __kube_create_instance app $CR_APP_NAME $input_yaml $output_yaml
225 __check_service_start $CR_APP_NAME $CR_SERVICE_PATH$CR_ALIVE_URL
227 echo -ne " Service $CR_APP_NAME - reset "$SAMELINE
228 result=$(__do_curl CR $CR_SERVICE_PATH/reset)
229 if [ $? -ne 0 ]; then
230 echo -e " Service $CR_APP_NAME - reset $RED Failed $ERED - will continue"
232 echo -e " Service $CR_APP_NAME - reset $GREEN OK $EGREEN"
235 # Check if docker app shall be fully managed by the test script
236 __check_included_image 'CR'
237 if [ $? -eq 1 ]; then
238 echo -e $RED"The Callback Receiver app is not included in this test script"$ERED
239 echo -e $RED"The Callback Receiver will not be started"$ERED
245 __start_container $CR_COMPOSE_DIR "" NODOCKERARGS 1 $CR_APP_NAME
247 __check_service_start $CR_APP_NAME $CR_SERVICE_PATH$CR_ALIVE_URL
253 # Tests if a variable value in the CR is equal to a target value and and optional timeout.
254 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
255 # equal to the target or not.
256 # Arg: <variable-name> <target-value> <timeout-in-sec> - This test waits up to the timeout seconds
257 # before setting pass or fail depending on if the variable value becomes equal to the target
259 # (Function for test scripts)
261 if [ $# -eq 2 ] || [ $# -eq 3 ]; then
262 __var_test "CR" "$CR_SERVICE_PATH/counter/" $1 "=" $2 $3
264 __print_err "Wrong args to cr_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
268 # Tests if a variable value in the CR contains the target string and and optional timeout
269 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable contains
271 # Arg: <variable-name> <target-value> <timeout-in-sec> - This test waits up to the timeout seconds
272 # before setting pass or fail depending on if the variable value contains the target
274 # (Function for test scripts)
277 if [ $# -eq 2 ] || [ $# -eq 3 ]; then
278 __var_test "CR" "$CR_SERVICE_PATH/counter/" $1 "contain_str" $2 $3
281 __print_err "needs two or three args: <sim-param> <target-value> [ timeout ]"
286 # Read a variable value from CR sim and send to stdout. Arg: <variable-name>
288 echo "$(__do_curl $CR_SERVICE_PATH/counter/$1)"
291 # Function to configure write delay on callbacks
292 # Delay given in seconds.
293 # arg <response-code> <delay-in-sec>
294 # (Function for test scripts)
295 cr_delay_callback() {
298 if [ $# -ne 2 ]; then
299 __print_err "<response-code> <delay-in-sec>]" $@
303 res="$(__do_curl_to_api CR POST /forcedelay?delay=$2)"
304 status=${res:${#res}-3}
306 if [ $status -ne 200 ]; then
307 __log_conf_fail_status_code $1 $status
315 # CR API: Check the contents of all current ric sync events for one id from PMS
316 # <response-code> <id> [ EMPTY | ( <ric-id> )+ ]
317 # (Function for test scripts)
318 cr_api_check_all_sync_events() {
321 if [ "$PMS_VERSION" != "V2" ]; then
322 __log_test_fail_not_supported
326 if [ $# -lt 2 ]; then
327 __print_err "<response-code> <id> [ EMPTY | ( <ric-id> )+ ]" $@
331 query="/get-all-events/"$2
332 res="$(__do_curl_to_api CR GET $query)"
333 status=${res:${#res}-3}
335 if [ $status -ne $1 ]; then
336 __log_test_fail_status_code $1 $status
340 if [ $# -gt 2 ]; then
341 body=${res:0:${#res}-3}
342 if [ $# -eq 3 ] && [ $3 == "EMPTY" ]; then
348 for ((i=0; i<$(($#-2)); i=i+1)); do
350 if [ "$targetJson" != "[" ]; then
351 targetJson=$targetJson","
353 targetJson=$targetJson"{\"ric_id\":\"${arr[$i]}\",\"event_type\":\"AVAILABLE\"}"
357 targetJson=$targetJson"]"
358 echo "TARGET JSON: $targetJson" >> $HTTPLOG
359 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
361 if [ $res -ne 0 ]; then
370 # CR API: Check the contents of all current status events for one id from ECS
371 # <response-code> <id> [ EMPTY | ( <status> )+ ]
372 # (Function for test scripts)
373 cr_api_check_all_ecs_events() {
376 if [ $# -lt 2 ]; then
377 __print_err "<response-code> <id> [ EMPTY | ( <status> )+ ]" $@
381 query="/get-all-events/"$2
382 res="$(__do_curl_to_api CR GET $query)"
383 status=${res:${#res}-3}
385 if [ $status -ne $1 ]; then
386 __log_test_fail_status_code $1 $status
390 if [ $# -gt 2 ]; then
391 body=${res:0:${#res}-3}
392 if [ $# -eq 3 ] && [ $3 == "EMPTY" ]; then
398 for ((i=0; i<$(($#-2)); i=i+1)); do
400 if [ "$targetJson" != "[" ]; then
401 targetJson=$targetJson","
403 targetJson=$targetJson"{\"eiJobStatus\":\"${arr[$i]}\"}"
407 targetJson=$targetJson"]"
408 echo "TARGET JSON: $targetJson" >> $HTTPLOG
409 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
411 if [ $res -ne 0 ]; then
420 # CR API: Check the contents of all current type subscription events for one id from ECS
421 # <response-code> <id> [ EMPTY | ( <type-id> <schema> <registration-status> )+ ]
422 # (Function for test scripts)
423 cr_api_check_all_ecs_subscription_events() {
426 #Valid number of parameter 2,3,7,11
428 if [ $# -eq 2 ]; then
431 if [ $# -eq 3 ] && [ "$3" == "EMPTY" ]; then
434 variablecount=$(($#-2))
435 if [ $# -gt 3 ] && [ $(($variablecount%3)) -eq 0 ]; then
438 if [ $paramError -eq 1 ]; then
439 __print_err "<response-code> <id> [ EMPTY | ( <type-id> <schema> <registration-status> )+ ]" $@
443 query="/get-all-events/"$2
444 res="$(__do_curl_to_api CR GET $query)"
445 status=${res:${#res}-3}
447 if [ $status -ne $1 ]; then
448 __log_test_fail_status_code $1 $status
452 if [ $# -gt 2 ]; then
453 body=${res:0:${#res}-3}
455 if [ $# -gt 3 ]; then
457 for ((i=0; i<$(($#-3)); i=i+3)); do
458 if [ "$targetJson" != "[" ]; then
459 targetJson=$targetJson","
461 if [ -f ${arr[$i+1]} ]; then
462 jobfile=$(cat ${arr[$i+1]})
464 __log_test_fail_general "Job schema file "${arr[$i+1]}", does not exist"
467 targetJson=$targetJson"{\"info_type_id\":\"${arr[$i]}\",\"job_data_schema\":$jobfile,\"status\":\"${arr[$i+2]}\"}"
470 targetJson=$targetJson"]"
472 echo " TARGET JSON: $targetJson" >> $HTTPLOG
473 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
475 if [ $res -ne 0 ]; then
486 # CR API: Reset all events and counters
488 # (Function for test scripts)
492 res="$(__do_curl_to_api CR GET /reset)"
493 status=${res:${#res}-3}
495 if [ $status -ne 200 ]; then
496 __log_conf_fail_status_code $1 $status
505 # CR API: Check the contents of all json events for path
506 # <response-code> <topic-url> (EMPTY | <json-msg>+ )
507 # (Function for test scripts)
508 cr_api_check_all_genric_json_events() {
511 if [ $# -lt 3 ]; then
512 __print_err "<response-code> <topic-url> (EMPTY | <json-msg>+ )" $@
516 query="/get-all-events/"$2
517 res="$(__do_curl_to_api CR GET $query)"
518 status=${res:${#res}-3}
520 if [ $status -ne $1 ]; then
521 __log_test_fail_status_code $1 $status
524 body=${res:0:${#res}-3}
527 if [ $3 != "EMPTY" ]; then
530 while [ $# -gt 0 ]; do
531 if [ "$targetJson" != "[" ]; then
532 targetJson=$targetJson","
534 targetJson=$targetJson$1
538 targetJson=$targetJson"]"
540 echo " TARGET JSON: $targetJson" >> $HTTPLOG
541 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
543 if [ $res -ne 0 ]; then
554 # CR API: Check a single (oldest) json event (or none if empty) for path
555 # <response-code> <topic-url> (EMPTY | <json-msg> )
556 # (Function for test scripts)
557 cr_api_check_single_genric_json_event() {
560 if [ $# -ne 3 ]; then
561 __print_err "<response-code> <topic-url> (EMPTY | <json-msg> )" $@
565 query="/get-event/"$2
566 res="$(__do_curl_to_api CR GET $query)"
567 status=${res:${#res}-3}
569 if [ $status -ne $1 ]; then
570 __log_test_fail_status_code $1 $status
573 body=${res:0:${#res}-3}
576 echo " TARGET JSON: $targetJson" >> $HTTPLOG
577 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
579 if [ $res -ne 0 ]; then