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 management functions and test functions for Producer stub
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
28 __PRODSTUB_imagesetup() {
29 __check_and_create_image_var PRODSTUB "PROD_STUB_IMAGE" "PROD_STUB_IMAGE_BASE" "PROD_STUB_IMAGE_TAG" LOCAL "$PROD_STUB_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'
37 __PRODSTUB_imagepull() {
38 echo -e $RED"Image for app PRODSTUB 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
44 __PRODSTUB_imagebuild() {
46 echo " Building PRODSTUB - $PROD_STUB_DISPLAY_NAME - image: $PROD_STUB_IMAGE"
47 docker build --build-arg NEXUS_PROXY_REPO=$NEXUS_PROXY_REPO -t $PROD_STUB_IMAGE . &> .dockererr
49 echo -e $GREEN" Build Ok"$EGREEN
50 __retag_and_push_image PROD_STUB_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>
66 __PRODSTUB_image_data() {
67 echo -e "$PROD_STUB_DISPLAY_NAME\t$(docker images --format $1 $PROD_STUB_IMAGE)" >> $2
68 if [ ! -z "$PROD_STUB_IMAGE_SOURCE" ]; then
69 echo -e "-- source image --\t$(docker images --format $1 $PROD_STUB_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 __PRODSTUB_kube_scale_zero() {
77 __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest PRODSTUB
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 __PRODSTUB_kube_scale_zero_and_wait() {
83 echo -e $RED" PRODSTUB 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 __PRODSTUB_kube_delete_all() {
89 __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest PRODSTUB
93 # This function is called for apps managed by the test script.
94 # args: <log-dir> <file-prexix>
95 __PRODSTUB_store_docker_logs() {
96 docker logs $PROD_STUB_APP_NAME > $1$2_prodstub.log 2>&1
98 #######################################################
101 ## Access to Prod stub sim
103 PROD_STUB_HTTPX="http"
104 PROD_STUB_HOST_NAME=$LOCALHOST_NAME
105 PROD_STUB_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_HOST_NAME":"$PROD_STUB_EXTERNAL_PORT
107 #Docker/Kube internal path
108 if [ $RUNMODE == "KUBE" ]; then
109 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME"."$KUBE_SIM_NAMESPACE":"$PROD_STUB_EXTERNAL_PORT
111 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME":"$PROD_STUB_INTERNAL_PORT
114 # Set http as the protocol to use for all communication to the Producer stub
116 # (Function for test scripts)
117 use_prod_stub_http() {
118 echo -e $BOLD"Producer stub protocol setting"$EBOLD
119 echo -e " Using $BOLD http $EBOLD towards Producer stub"
121 PROD_STUB_HTTPX="http"
122 PROD_STUB_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_HOST_NAME":"$PROD_STUB_EXTERNAL_PORT
124 if [ $RUNMODE == "KUBE" ]; then
125 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME"."$KUBE_SIM_NAMESPACE":"$PROD_STUB_EXTERNAL_PORT
127 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME":"$PROD_STUB_INTERNAL_PORT
133 # Set https as the protocol to use for all communication to the Producer stub
135 # (Function for test scripts)
136 use_prod_stub_https() {
137 echo -e $BOLD"Producer stub protocol setting"$EBOLD
138 echo -e " Using $BOLD https $EBOLD towards Producer stub"
140 PROD_STUB_HTTPX="https"
141 PROD_STUB_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_HOST_NAME":"$PROD_STUB_EXTERNAL_SECURE_PORT
143 if [ $RUNMODE == "KUBE" ]; then
144 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME"."$KUBE_SIM_NAMESPACE":"$PROD_STUB_EXTERNAL_SECURE_PORT
146 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME":"$PROD_STUB_INTERNAL_SECURE_PORT
151 ### Admin API functions producer stub
153 ###########################
154 ### Producer stub functions
155 ###########################
157 # Start the Producer stub in the simulator group
159 # (Function for test scripts)
162 echo -e $BOLD"Starting $PROD_STUB_DISPLAY_NAME"$EBOLD
164 if [ $RUNMODE == "KUBE" ]; then
166 # Check if app shall be fully managed by the test script
167 __check_included_image "PRODSTUB"
170 # Check if app shall only be used by the testscipt
171 __check_prestarted_image "PRODSTUB"
174 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
175 echo -e $RED"The $ECS_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
176 echo -e $RED"The $ECS_APP_NAME will not be started"$ERED
179 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
180 echo -e $RED"The $ECS_APP_NAME app is included both as managed and prestarted in this test script"$ERED
181 echo -e $RED"The $ECS_APP_NAME will not be started"$ERED
185 if [ $retcode_p -eq 0 ]; then
186 echo -e " Using existing $PROD_STUB_APP_NAME deployment and service"
187 echo " Setting RC replicas=1"
188 __kube_scale deployment $PROD_STUB_APP_NAME $KUBE_SIM_NAMESPACE 1
191 if [ $retcode_i -eq 0 ]; then
192 echo -e " Creating $PROD_STUB_APP_NAME deployment and service"
193 export PROD_STUB_APP_NAME
194 export KUBE_SIM_NAMESPACE
195 export PROD_STUB_IMAGE
196 export PROD_STUB_INTERNAL_PORT
197 export PROD_STUB_INTERNAL_SECURE_PORT
198 export PROD_STUB_EXTERNAL_PORT
199 export PROD_STUB_EXTERNAL_SECURE_PORT
201 __kube_create_namespace $KUBE_SIM_NAMESPACE
204 input_yaml=$SIM_GROUP"/"$PROD_STUB_COMPOSE_DIR"/"svc.yaml
205 output_yaml=$PWD/tmp/prodstub_svc.yaml
206 __kube_create_instance service $PROD_STUB_APP_NAME $input_yaml $output_yaml
209 input_yaml=$SIM_GROUP"/"$PROD_STUB_COMPOSE_DIR"/"app.yaml
210 output_yaml=$PWD/tmp/prodstub_app.yaml
211 __kube_create_instance app $PROD_STUB_APP_NAME $input_yaml $output_yaml
214 PROD_STUB_HOST_NAME=$(__kube_get_service_host $PROD_STUB_APP_NAME $KUBE_SIM_NAMESPACE)
216 PROD_STUB_EXTERNAL_PORT=$(__kube_get_service_port $PROD_STUB_APP_NAME $KUBE_SIM_NAMESPACE "http")
217 PROD_STUB_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $PROD_STUB_APP_NAME $KUBE_SIM_NAMESPACE "https")
219 echo " Host IP, http port, https port: $PROD_STUB_HOST_NAME $PROD_STUB_EXTERNAL_PORT $PROD_STUB_EXTERNAL_SECURE_PORT"
220 if [ $PROD_STUB_HTTPX == "http" ]; then
221 PROD_STUB_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_HOST_NAME":"$PROD_STUB_EXTERNAL_PORT
222 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME"."$KUBE_SIM_NAMESPACE":"$PROD_STUB_EXTERNAL_PORT
224 PROD_STUB_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_HOST_NAME":"$PROD_STUB_EXTERNAL_SECURE_PORT
225 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME"."$KUBE_SIM_NAMESPACE":"$PROD_STUB_EXTERNAL_SECURE_PORT
228 __check_service_start $PROD_STUB_APP_NAME $PROD_STUB_PATH$PROD_STUB_ALIVE_URL
230 echo -ne " Service $PROD_STUB_APP_NAME - reset "$SAMELINE
231 result=$(__do_curl $PROD_STUB_PATH/reset)
232 if [ $? -ne 0 ]; then
233 echo -e " Service $PROD_STUB_APP_NAME - reset $RED Failed $ERED - will continue"
235 echo -e " Service $PROD_STUB_APP_NAME - reset $GREEN OK $EGREEN"
239 # Check if docker app shall be fully managed by the test script
240 __check_included_image 'PRODSTUB'
241 if [ $? -eq 1 ]; then
242 echo -e $RED"The Producer stub app is not included as managed in this test script"$ERED
243 echo -e $RED"The Producer stub will not be started"$ERED
247 export PROD_STUB_APP_NAME
248 export PROD_STUB_APP_NAME_ALIAS
249 export PROD_STUB_INTERNAL_PORT
250 export PROD_STUB_EXTERNAL_PORT
251 export PROD_STUB_INTERNAL_SECURE_PORT
252 export PROD_STUB_EXTERNAL_SECURE_PORT
253 export DOCKER_SIM_NWNAME
255 export PROD_STUB_DISPLAY_NAME
257 __start_container $PROD_STUB_COMPOSE_DIR "" NODOCKERARGS 1 $PROD_STUB_APP_NAME
259 __check_service_start $PROD_STUB_APP_NAME $PROD_STUB_PATH$PROD_STUB_ALIVE_URL
265 # Excute a curl cmd towards the prodstub simulator and check the response code.
266 # args: TEST|CONF <expected-response-code> <curl-cmd-string> [<json-file-to-compare-output>]
267 __execute_curl_to_prodstub() {
268 TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
269 echo "(${BASH_LINENO[0]}) - ${TIMESTAMP}: ${FUNCNAME[0]}" $@ >> $HTTPLOG
271 if [ $RUNMODE == "KUBE" ]; then
272 if [ ! -z "$KUBE_PROXY_PATH" ]; then
273 if [ $KUBE_PROXY_HTTPX == "http" ]; then
274 proxyflag=" --proxy $KUBE_PROXY_PATH"
276 proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
280 echo " CMD: $3 $proxyflag" >> $HTTPLOG
281 res="$($3 $proxyflag)"
282 echo " RESP: $res" >> $HTTPLOG
284 if [ $retcode -ne 0 ]; then
285 __log_conf_fail_general " Fatal error when executing curl, response: "$retcode
288 status=${res:${#res}-3}
289 if [ $status -eq $2 ]; then
290 if [ $# -eq 4 ]; then
291 body=${res:0:${#res}-3}
293 echo " TARGET JSON: $jobfile" >> $HTTPLOG
294 res=$(python3 ../common/compare_json.py "$jobfile" "$body")
295 if [ $res -ne 0 ]; then
296 if [ $1 == "TEST" ]; then
304 if [ $1 == "TEST" ]; then
311 if [ $1 == "TEST" ]; then
312 __log_test_fail_status_code $2 $status
314 __log_conf_fail_status_code $2 $status
319 # Prodstub API: Set (or reset) response code for producer supervision
320 # <response-code> <producer-id> [<forced_response_code>]
321 # (Function for test scripts)
322 prodstub_arm_producer() {
324 if [ $# -ne 2 ] && [ $# -ne 3 ]; then
325 __print_err "<response-code> <producer-id> [<forced_response_code>]" $@
329 curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/supervision/"$2
330 if [ $# -eq 3 ]; then
331 curlString=$curlString"?response="$3
334 __execute_curl_to_prodstub CONF $1 "$curlString"
338 # Prodstub API: Set (or reset) response code job create
339 # <response-code> <producer-id> <job-id> [<forced_response_code>]
340 # (Function for test scripts)
341 prodstub_arm_job_create() {
343 if [ $# -ne 3 ] && [ $# -ne 4 ]; then
344 __print_err "<response-code> <producer-id> <job-id> [<forced_response_code>]" $@
348 curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/create/$2/$3"
349 if [ $# -eq 4 ]; then
350 curlString=$curlString"?response="$4
353 __execute_curl_to_prodstub CONF $1 "$curlString"
357 # Prodstub API: Set (or reset) response code job delete
358 # <response-code> <producer-id> <job-id> [<forced_response_code>]
359 # (Function for test scripts)
360 prodstub_arm_job_delete() {
362 if [ $# -ne 3 ] && [ $# -ne 4 ]; then
363 __print_err "<response-code> <producer-id> <job-id> [<forced_response_code>]" $@
367 curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/delete/$2/$3"
368 if [ $# -eq 4 ]; then
369 curlString=$curlString"?response="$4
372 __execute_curl_to_prodstub CONF $1 "$curlString"
376 # Prodstub API: Arm a type of a producer
377 # <response-code> <producer-id> <type-id>
378 # (Function for test scripts)
379 prodstub_arm_type() {
381 if [ $# -ne 3 ]; then
382 __print_err "<response-code> <producer-id> <type-id>" $@
386 curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/type/$2/$3"
388 __execute_curl_to_prodstub CONF $1 "$curlString"
392 # Prodstub API: Disarm a type in a producer
393 # <response-code> <producer-id> <type-id>
394 # (Function for test scripts)
395 prodstub_disarm_type() {
397 if [ $# -ne 3 ]; then
398 __print_err "<response-code> <producer-id> <type-id>" $@
402 curlString="curl -X DELETE -skw %{http_code} $PROD_STUB_PATH/arm/type/$2/$3"
404 __execute_curl_to_prodstub CONF $1 "$curlString"
408 # Prodstub API: Get job data for a job and compare with a target job json
409 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
410 # (Function for test scripts)
411 prodstub_check_jobdata() {
413 if [ $# -ne 7 ]; then
414 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
419 jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
421 __log_test_fail_general "Template file "$7" for jobdata, does not exist"
424 targetJson="{\"ei_job_identity\":\"$3\",\"ei_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"ei_job_data\":$jobfile}"
426 echo "$targetJson" > $file
428 curlString="curl -X GET -skw %{http_code} $PROD_STUB_PATH/jobdata/$2/$3"
430 __execute_curl_to_prodstub TEST $1 "$curlString" $file
434 # Prodstub API: Get job data for a job and compare with a target job json
435 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
436 # (Function for test scripts)
437 prodstub_check_jobdata_2() {
439 if [ $# -ne 7 ]; then
440 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
445 jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
447 __log_test_fail_general "Template file "$7" for jobdata, does not exist"
450 if [[ "$ECS_FEATURE_LEVEL" == *"INFO-TYPES"* ]]; then
451 targetJson="{\"info_job_identity\":\"$3\",\"info_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"info_job_data\":$jobfile,\"last_updated\":\"????\"}"
453 targetJson="{\"ei_job_identity\":\"$3\",\"ei_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"ei_job_data\":$jobfile,\"last_updated\":\"????\"}"
456 echo "$targetJson" > $file
458 curlString="curl -X GET -skw %{http_code} $PROD_STUB_PATH/jobdata/$2/$3"
460 __execute_curl_to_prodstub TEST $1 "$curlString" $file
464 # Prodstub API: Get job data for a job and compare with a target job json (info-jobs)
465 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
466 # (Function for test scripts)
467 prodstub_check_jobdata_3() {
469 if [ $# -ne 7 ]; then
470 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
475 jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
477 __log_test_fail_general "Template file "$7" for jobdata, does not exist"
480 targetJson="{\"info_job_identity\":\"$3\",\"info_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"info_job_data\":$jobfile,\"last_updated\":\"????\"}"
482 echo "$targetJson" > $file
484 curlString="curl -X GET -skw %{http_code} $PROD_STUB_PATH/jobdata/$2/$3"
486 __execute_curl_to_prodstub TEST $1 "$curlString" $file
490 # Prodstub API: Delete the job data
491 # <response-code> <producer-id> <job-id>
492 # (Function for test scripts)
493 prodstub_delete_jobdata() {
495 if [ $# -ne 3 ]; then
496 __print_err "<response-code> <producer-id> <job-id> " $@
499 curlString="curl -X DELETE -skw %{http_code} $PROD_STUB_PATH/jobdata/$2/$3"
501 __execute_curl_to_prodstub CONF $1 "$curlString"
505 # Tests if a variable value in the prod stub is equal to a target value and and optional timeout.
506 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
507 # equal to the target or not.
508 # Arg: <variable-name> <target-value> <timeout-in-sec> - This test waits up to the timeout seconds
509 # before setting pass or fail depending on if the variable value becomes equal to the target
511 # (Function for test scripts)
513 if [ $# -eq 2 ] || [ $# -eq 3 ]; then
514 __var_test "PRODSTUB" "$PROD_STUB_PATH/counter/" $1 "=" $2 $3
516 __print_err "Wrong args to prodstub_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@