9af00d8d65a512404a00fa6fef0613795341a00a
[nonrtric.git] / test / common / prodstub_api_functions.sh
1 #!/bin/bash
2
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
9 #
10 #       http://www.apache.org/licenses/LICENSE-2.0
11 #
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=================================================
18 #
19
20 # This is a script that contains container/service management functions and test functions for Producer stub
21
22
23 ################ Test engine functions ################
24
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"
30 }
31
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
39 }
40
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() {
45         cd ../prodstub
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
48         if [ $? -eq 0 ]; then
49                 echo -e  $GREEN"  Build Ok"$EGREEN
50                 __retag_and_push_image PROD_STUB_IMAGE
51                 if [ $? -ne 0 ]; then
52                         exit 1
53                 fi
54         else
55                 echo -e $RED"  Build Failed"$ERED
56                 ((RES_CONF_FAIL++))
57                 cat .dockererr
58                 echo -e $RED"Exiting...."$ERED
59                 exit 1
60         fi
61 }
62
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
70         fi
71 }
72
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
78 }
79
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
84 }
85
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
90 }
91
92 # Store docker logs
93 # This function is called for apps managed by the test script.
94 # args: <log-dir> <file-prexix>
95 __PRODSTUB_store_docker_logs() {
96         if [ $RUNMODE == "KUBE" ]; then
97                 kubectl $KUBECONF  logs -l "autotest=PRODSTUB" -n $KUBE_SIM_NAMESPACE --tail=-1 > $1$2_prodstub.log 2>&1
98         else
99                 docker logs $PROD_STUB_APP_NAME > $1$2_prodstub.log 2>&1
100         fi
101 }
102
103 # Initial setup of protocol, host and ports
104 # This function is called for apps managed by the test script.
105 # args: -
106 __PRODSTUB_initial_setup() {
107         use_prod_stub_http
108 }
109
110 # Set app short-name, app name and namespace for logging runtime statistics of kubernets pods or docker containers
111 # For docker, the namespace shall be excluded
112 # This function is called for apps managed by the test script as well as for prestarted apps.
113 # args: -
114 __PRODSTUB_statisics_setup() {
115         if [ $RUNMODE == "KUBE" ]; then
116                 echo "PRODSTUB $PROD_STUB_APP_NAME $KUBE_SIM_NAMESPACE"
117         else
118                 echo "PRODSTUB $PROD_STUB_APP_NAME"
119         fi
120 }
121
122 # Check application requirements, e.g. helm, the the test needs. Exit 1 if req not satisfied
123 # args: -
124 __PRODSTUB_test_requirements() {
125         :
126 }
127
128 #######################################################
129
130 # Set http as the protocol to use for all communication to the Prod stub sim
131 # args: -
132 # (Function for test scripts)
133 use_prod_stub_http() {
134         __prod_stub_set_protocoll "http" $PROD_STUB_INTERNAL_PORT $PROD_STUB_EXTERNAL_PORT
135 }
136
137 # Set https as the protocol to use for all communication to the Prod stub sim
138 # args: -
139 # (Function for test scripts)
140 use_prod_stub_https() {
141         __prod_stub_set_protocoll "https" $PROD_STUB_INTERNAL_SECURE_PORT $PROD_STUB_EXTERNAL_SECURE_PORT
142 }
143
144 # Setup paths to svc/container for internal and external access
145 # args: <protocol> <internal-port> <external-port>
146 __prod_stub_set_protocoll() {
147         echo -e $BOLD"$PROD_STUB_DISPLAY_NAME protocol setting"$EBOLD
148         echo -e " Using $BOLD $1 $EBOLD towards $PROD_STUB_DISPLAY_NAME"
149
150         ## Access to Prod stub sim
151
152         PROD_STUB_SERVICE_PATH=$1"://"$PROD_STUB_APP_NAME":"$2  # docker access, container->container and script->container via proxy
153         if [ $RUNMODE == "KUBE" ]; then
154                 PROD_STUB_SERVICE_PATH=$1"://"$PROD_STUB_APP_NAME.$KUBE_SIM_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
155         fi
156
157         echo ""
158 }
159
160 ### Admin API functions producer stub
161
162 ###########################
163 ### Producer stub functions
164 ###########################
165
166 # Export env vars for config files, docker compose and kube resources
167 # args:
168 __prodstub_export_vars() {
169         export PROD_STUB_APP_NAME
170         export PROD_STUB_DISPLAY_NAME
171
172         export DOCKER_SIM_NWNAME
173         export KUBE_SIM_NAMESPACE
174
175         export PROD_STUB_IMAGE
176         export PROD_STUB_INTERNAL_PORT
177         export PROD_STUB_INTERNAL_SECURE_PORT
178         export PROD_STUB_EXTERNAL_PORT
179         export PROD_STUB_EXTERNAL_SECURE_PORT
180 }
181
182
183 # Start the Producer stub in the simulator group
184 # args: -
185 # (Function for test scripts)
186 start_prod_stub() {
187
188         echo -e $BOLD"Starting $PROD_STUB_DISPLAY_NAME"$EBOLD
189
190         if [ $RUNMODE == "KUBE" ]; then
191
192                 # Check if app shall be fully managed by the test script
193                 __check_included_image "PRODSTUB"
194                 retcode_i=$?
195
196                 # Check if app shall only be used by the testscipt
197                 __check_prestarted_image "PRODSTUB"
198                 retcode_p=$?
199
200                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
201                         echo -e $RED"The $PROD_STUB_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
202                         echo -e $RED"The $PROD_STUB_APP_NAME will not be started"$ERED
203                         exit
204                 fi
205                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
206                         echo -e $RED"The $PROD_STUB_APP_NAME app is included both as managed and prestarted in this test script"$ERED
207                         echo -e $RED"The $PROD_STUB_APP_NAME will not be started"$ERED
208                         exit
209                 fi
210
211                 if [ $retcode_p -eq 0 ]; then
212                         echo -e " Using existing $PROD_STUB_APP_NAME deployment and service"
213                         echo " Setting RC replicas=1"
214                         __kube_scale deployment $PROD_STUB_APP_NAME $KUBE_SIM_NAMESPACE 1
215                 fi
216
217                 if [ $retcode_i -eq 0 ]; then
218                         echo -e " Creating $PROD_STUB_APP_NAME deployment and service"
219
220             __kube_create_namespace $KUBE_SIM_NAMESPACE
221
222                         __prodstub_export_vars
223
224                         # Create service
225                         input_yaml=$SIM_GROUP"/"$PROD_STUB_COMPOSE_DIR"/"svc.yaml
226                         output_yaml=$PWD/tmp/prodstub_svc.yaml
227                         __kube_create_instance service $PROD_STUB_APP_NAME $input_yaml $output_yaml
228
229                         # Create app
230                         input_yaml=$SIM_GROUP"/"$PROD_STUB_COMPOSE_DIR"/"app.yaml
231                         output_yaml=$PWD/tmp/prodstub_app.yaml
232                         __kube_create_instance app $PROD_STUB_APP_NAME $input_yaml $output_yaml
233                 fi
234
235                 __check_service_start $PROD_STUB_APP_NAME $PROD_STUB_SERVICE_PATH$PROD_STUB_ALIVE_URL
236
237                 echo -ne " Service $PROD_STUB_APP_NAME - reset  "$SAMELINE
238                 result=$(__do_curl $PROD_STUB_SERVICE_PATH/reset)
239                 if [ $? -ne 0 ]; then
240                         echo -e " Service $PROD_STUB_APP_NAME - reset  $RED Failed $ERED - will continue"
241                 else
242                         echo -e " Service $PROD_STUB_APP_NAME - reset  $GREEN OK $EGREEN"
243                 fi
244         else
245
246                 # Check if docker app shall be fully managed by the test script
247                 __check_included_image 'PRODSTUB'
248                 if [ $? -eq 1 ]; then
249                         echo -e $RED"The Producer stub app is not included as managed in this test script"$ERED
250                         echo -e $RED"The Producer stub will not be started"$ERED
251                         exit
252                 fi
253
254                 __prodstub_export_vars
255
256                 __start_container $PROD_STUB_COMPOSE_DIR "" NODOCKERARGS 1 $PROD_STUB_APP_NAME
257
258         __check_service_start $PROD_STUB_APP_NAME $PROD_STUB_SERVICE_PATH$PROD_STUB_ALIVE_URL
259         fi
260     echo ""
261     return 0
262 }
263
264 # Excute a curl cmd towards the prodstub simulator and check the response code.
265 # args: TEST|CONF <expected-response-code> <curl-cmd-string> [<json-file-to-compare-output>]
266 __execute_curl_to_prodstub() {
267     TIMESTAMP=$(date "+%Y-%m-%d %H:%M:%S")
268     echo "(${BASH_LINENO[0]}) - ${TIMESTAMP}: ${FUNCNAME[0]}" $@ >> $HTTPLOG
269         proxyflag=""
270         if [ ! -z "$KUBE_PROXY_PATH" ]; then
271                 if [ $KUBE_PROXY_HTTPX == "http" ]; then
272                         proxyflag=" --proxy $KUBE_PROXY_PATH"
273                 else
274                         proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
275                 fi
276         fi
277         echo " CMD: $3 $proxyflag" >> $HTTPLOG
278         res="$($3 $proxyflag)"
279         echo " RESP: $res" >> $HTTPLOG
280         retcode=$?
281     if [ $retcode -ne 0 ]; then
282         __log_conf_fail_general " Fatal error when executing curl, response: "$retcode
283         return 1
284     fi
285     status=${res:${#res}-3}
286     if [ $status -eq $2 ]; then
287         if [ $# -eq 4 ]; then
288             body=${res:0:${#res}-3}
289             jobfile=$(cat $4)
290             echo " TARGET JSON: $jobfile" >> $HTTPLOG
291                     res=$(python3 ../common/compare_json.py "$jobfile" "$body")
292             if [ $res -ne 0 ]; then
293                 if [ $1 == "TEST" ]; then
294                     __log_test_fail_body
295                  else
296                     __log_conf_fail_body
297                 fi
298                 return 1
299             fi
300         fi
301         if [ $1 == "TEST" ]; then
302             __log_test_pass
303         else
304             __log_conf_ok
305         fi
306         return 0
307     fi
308     if [ $1 == "TEST" ]; then
309         __log_test_fail_status_code $2 $status
310         else
311         __log_conf_fail_status_code $2 $status
312     fi
313     return 1
314 }
315
316 # Prodstub API: Set (or reset) response code for producer supervision
317 # <response-code> <producer-id> [<forced_response_code>]
318 # (Function for test scripts)
319 prodstub_arm_producer() {
320         __log_conf_start $@
321         if [ $# -ne 2 ] && [ $# -ne 3 ]; then
322                 __print_err "<response-code> <producer-id> [<forced_response_code>]" $@
323                 return 1
324         fi
325
326     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_SERVICE_PATH/arm/supervision/"$2
327         if [ $# -eq 3 ]; then
328                 curlString=$curlString"?response="$3
329         fi
330
331     __execute_curl_to_prodstub CONF $1 "$curlString"
332     return $?
333 }
334
335 # Prodstub API: Set (or reset) response code job create
336 # <response-code> <producer-id> <job-id> [<forced_response_code>]
337 # (Function for test scripts)
338 prodstub_arm_job_create() {
339         __log_conf_start $@
340         if [ $# -ne 3 ] && [ $# -ne 4 ]; then
341                 __print_err "<response-code> <producer-id> <job-id> [<forced_response_code>]" $@
342                 return 1
343         fi
344
345     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_SERVICE_PATH/arm/create/$2/$3"
346         if [ $# -eq 4 ]; then
347                 curlString=$curlString"?response="$4
348         fi
349
350     __execute_curl_to_prodstub CONF $1 "$curlString"
351     return $?
352 }
353
354 # Prodstub API: Set (or reset) response code job delete
355 # <response-code> <producer-id> <job-id> [<forced_response_code>]
356 # (Function for test scripts)
357 prodstub_arm_job_delete() {
358         __log_conf_start $@
359         if [ $# -ne 3 ] && [ $# -ne 4 ]; then
360                 __print_err "<response-code> <producer-id> <job-id> [<forced_response_code>]" $@
361                 return 1
362         fi
363
364     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_SERVICE_PATH/arm/delete/$2/$3"
365         if [ $# -eq 4 ]; then
366                 curlString=$curlString"?response="$4
367         fi
368
369     __execute_curl_to_prodstub CONF $1 "$curlString"
370     return $?
371 }
372
373 # Prodstub API: Arm a type of a producer
374 # <response-code> <producer-id> <type-id>
375 # (Function for test scripts)
376 prodstub_arm_type() {
377         __log_conf_start $@
378         if [ $# -ne 3 ]; then
379                 __print_err "<response-code> <producer-id> <type-id>" $@
380                 return 1
381         fi
382
383     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_SERVICE_PATH/arm/type/$2/$3"
384
385     __execute_curl_to_prodstub CONF $1 "$curlString"
386     return $?
387 }
388
389 # Prodstub API: Disarm a type in a producer
390 # <response-code> <producer-id> <type-id>
391 # (Function for test scripts)
392 prodstub_disarm_type() {
393         __log_conf_start $@
394         if [ $# -ne 3 ]; then
395                 __print_err "<response-code> <producer-id> <type-id>" $@
396                 return 1
397         fi
398
399     curlString="curl -X DELETE -skw %{http_code} $PROD_STUB_SERVICE_PATH/arm/type/$2/$3"
400
401     __execute_curl_to_prodstub CONF $1 "$curlString"
402     return $?
403 }
404
405 # Prodstub API: Get job data for a job and compare with a target job json
406 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
407 # (Function for test scripts)
408 prodstub_check_jobdata() {
409         __log_test_start $@
410         if [ $# -ne 7 ]; then
411                 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
412                 return 1
413         fi
414     if [ -f $7 ]; then
415         jobfile=$(cat $7)
416         jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
417     else
418         __log_test_fail_general "Template file "$7" for jobdata, does not exist"
419         return 1
420     fi
421     targetJson="{\"ei_job_identity\":\"$3\",\"ei_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"ei_job_data\":$jobfile}"
422     file="./tmp/.p.json"
423         echo "$targetJson" > $file
424
425     curlString="curl -X GET -skw %{http_code} $PROD_STUB_SERVICE_PATH/jobdata/$2/$3"
426
427     __execute_curl_to_prodstub TEST $1 "$curlString" $file
428     return $?
429 }
430
431 # Prodstub API: Get job data for a job and compare with a target job json
432 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
433 # (Function for test scripts)
434 prodstub_check_jobdata_2() {
435         __log_test_start $@
436         if [ $# -ne 7 ]; then
437                 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
438                 return 1
439         fi
440     if [ -f $7 ]; then
441         jobfile=$(cat $7)
442         jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
443     else
444         __log_test_fail_general "Template file "$7" for jobdata, does not exist"
445         return 1
446     fi
447         if [[ "$ICS_FEATURE_LEVEL" == *"INFO-TYPES"* ]]; then
448                 targetJson="{\"info_job_identity\":\"$3\",\"info_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"info_job_data\":$jobfile,\"last_updated\":\"????\"}"
449         else
450                 targetJson="{\"ei_job_identity\":\"$3\",\"ei_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"ei_job_data\":$jobfile,\"last_updated\":\"????\"}"
451     fi
452         file="./tmp/.p.json"
453         echo "$targetJson" > $file
454
455     curlString="curl -X GET -skw %{http_code} $PROD_STUB_SERVICE_PATH/jobdata/$2/$3"
456
457     __execute_curl_to_prodstub TEST $1 "$curlString" $file
458     return $?
459 }
460
461 # Prodstub API: Get job data for a job and compare with a target job json (info-jobs)
462 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
463 # (Function for test scripts)
464 prodstub_check_jobdata_3() {
465         __log_test_start $@
466         if [ $# -ne 7 ]; then
467                 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
468                 return 1
469         fi
470     if [ -f $7 ]; then
471         jobfile=$(cat $7)
472         jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
473     else
474         __log_test_fail_general "Template file "$7" for jobdata, does not exist"
475         return 1
476     fi
477     targetJson="{\"info_job_identity\":\"$3\",\"info_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"info_job_data\":$jobfile,\"last_updated\":\"????\"}"
478     file="./tmp/.p.json"
479         echo "$targetJson" > $file
480
481     curlString="curl -X GET -skw %{http_code} $PROD_STUB_SERVICE_PATH/jobdata/$2/$3"
482
483     __execute_curl_to_prodstub TEST $1 "$curlString" $file
484     return $?
485 }
486
487 # Prodstub API: Delete the job data
488 # <response-code> <producer-id> <job-id>
489 # (Function for test scripts)
490 prodstub_delete_jobdata() {
491         __log_conf_start
492         if [ $# -ne 3 ]; then
493                 __print_err "<response-code> <producer-id> <job-id> " $@
494                 return 1
495         fi
496     curlString="curl -X DELETE -skw %{http_code} $PROD_STUB_SERVICE_PATH/jobdata/$2/$3"
497
498     __execute_curl_to_prodstub CONF $1 "$curlString"
499     return $?
500 }
501
502 # Tests if a variable value in the prod stub is equal to a target value and and optional timeout.
503 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
504 # equal to the target or not.
505 # Arg: <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
506 # before setting pass or fail depending on if the variable value becomes equal to the target
507 # value or not.
508 # (Function for test scripts)
509 prodstub_equal() {
510         if [ $# -eq 2 ] || [ $# -eq 3 ]; then
511                 __var_test "PRODSTUB" "$PROD_STUB_SERVICE_PATH/counter/" $1 "=" $2 $3
512         else
513                 __print_err "Wrong args to prodstub_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
514         fi
515 }