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 A1 Controller API
22 ################ Test engine functions ################
24 # Create the image var used during the test
25 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
26 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
31 for oia_name in $ONAP_IMAGES_APP_NAMES; do
32 if [ "$oia_name" == "SDNC" ]; then
33 sdnc_suffix_tag="REMOTE_RELEASE_ONAP"
36 __check_and_create_image_var SDNC "SDNC_A1_CONTROLLER_IMAGE" "SDNC_A1_CONTROLLER_IMAGE_BASE" "SDNC_A1_CONTROLLER_IMAGE_TAG" $sdnc_suffix_tag "$SDNC_DISPLAY_NAME"
37 __check_and_create_image_var SDNC "SDNC_DB_IMAGE" "SDNC_DB_IMAGE_BASE" "SDNC_DB_IMAGE_TAG" REMOTE_PROXY "SDNC DB"
41 # Pull image from remote repo or use locally built image
42 # arg: <pull-policy-override> <pull-policy-original>
43 # <pull-policy-override> Shall be used for images allowing overriding. For example use a local image when test is started to use released images
44 # <pull-policy-original> Shall be used for images that does not allow overriding
45 # Both var may contain: 'remote', 'remote-remove' or 'local'
47 __check_and_pull_image $1 "$SDNC_DISPLAY_NAME" $SDNC_APP_NAME SDNC_A1_CONTROLLER_IMAGE
48 __check_and_pull_image $2 "SDNC DB" $SDNC_APP_NAME SDNC_DB_IMAGE
51 # Build image (only for simulator or interfaces stubs owned by the test environment)
52 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
53 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
55 echo -e $RED" Image for app SDNC shall never be built"$ERED
58 # Generate a string for each included image using the app display name and a docker images format string
59 # If a custom image repo is used then also the source image from the local repo is listed
60 # arg: <docker-images-format-string> <file-to-append>
62 echo -e "$SDNC_DISPLAY_NAME\t$(docker images --format $1 $SDNC_A1_CONTROLLER_IMAGE)" >> $2
63 if [ ! -z "$SDNC_A1_CONTROLLER_IMAGE_SOURCE" ]; then
64 echo -e "-- source image --\t$(docker images --format $1 $SDNC_A1_CONTROLLER_IMAGE_SOURCE)" >> $2
66 echo -e "SDNC DB\t$(docker images --format $1 $SDNC_DB_IMAGE)" >> $2
67 if [ ! -z "$SDNC_DB_IMAGE_SOURCE" ]; then
68 echo -e "-- source image --\t$(docker images --format $1 $SDNC_DB_IMAGE_SOURCE)" >> $2
72 # Scale kubernetes resources to zero
73 # All resources shall be ordered to be scaled to 0, if relevant. If not relevant to scale, then do no action.
74 # This function is called for apps fully managed by the test script
75 __SDNC_kube_scale_zero() {
76 __kube_scale_all_resources $KUBE_NONRTRIC_NAMESPACE autotest SDNC
79 # Scale kubernetes resources to zero and wait until this has been accomplished, if relevant. If not relevant to scale, then do no action.
80 # This function is called for prestarted apps not managed by the test script.
81 __SDNC_kube_scale_zero_and_wait() {
82 echo -e " SDNC replicas kept as is"
85 # Delete all kube resouces for the app
86 # This function is called for apps managed by the test script.
87 __SDNC_kube_delete_all() {
88 __kube_delete_all_resources $KUBE_NONRTRIC_NAMESPACE autotest SDNC
92 # This function is called for apps managed by the test script.
93 # args: <log-dir> <file-prexix>
94 __SDNC_store_docker_logs() {
95 docker exec -t $SDNC_APP_NAME cat $SDNC_KARAF_LOG> $1$2_SDNC_karaf.log 2>&1
98 #######################################################
102 SDNC_HOST_NAME=$LOCALHOST_NAME
103 SDNC_PATH=$SDNC_HTTPX"://"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_PORT
104 SDNC_API_PATH=$SDNC_HTTPX"://"$SDNC_USER":"$SDNC_PWD"@"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_PORT$SDNC_API_URL
105 #Docker/Kube internal path
106 if [ $RUNMODE == "KUBE" ]; then
107 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_PORT
109 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
111 #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
113 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_INTERNAL_PORT
117 echo -e $BOLD"SDNC NB protocol setting"$EBOLD
118 echo -e " Using $BOLD http $EBOLD towards SDNC"
120 SDNC_PATH=$SDNC_HTTPX"://"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_PORT
121 SDNC_API_PATH=$SDNC_HTTPX"://"$SDNC_USER":"$SDNC_PWD"@"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_PORT$SDNC_API_URL
122 if [ $RUNMODE == "KUBE" ]; then
124 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
126 #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_PORT
128 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_INTERNAL_PORT
134 echo -e $BOLD"SDNC NB protocol setting"$EBOLD
135 echo -e " Using $BOLD https $EBOLD towards SDNC"
137 SDNC_PATH=$SDNC_HTTPX"://"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_SECURE_PORT
138 SDNC_API_PATH=$SDNC_HTTPX"://"$SDNC_USER":"$SDNC_PWD"@"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_SECURE_PORT$SDNC_API_URL
139 if [ $RUNMODE == "KUBE" ]; then
141 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_SECURE_PORT
143 #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_SECURE_PORT
145 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_INTERNAL_SECURE_PORT
154 # Start the SDNC A1 Controller
156 # (Function for test scripts)
159 echo -e $BOLD"Starting $SDNC_DISPLAY_NAME"$EBOLD
161 if [ $RUNMODE == "KUBE" ]; then
163 # Check if app shall be fully managed by the test script
164 __check_included_image "SDNC"
167 # Check if app shall only be used by the testscipt
168 __check_prestarted_image "SDNC"
171 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
172 echo -e $RED"The $SDNC_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
173 echo -e $RED"The $SDNC_APP_NAME will not be started"$ERED
176 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
177 echo -e $RED"The $SDNC_APP_NAME app is included both as managed and prestarted in this test script"$ERED
178 echo -e $RED"The $SDNC_APP_NAME will not be started"$ERED
183 if [ $retcode_p -eq 0 ]; then
184 echo -e " Using existing $SDNC_APP_NAME deployment and service"
185 echo " Setting SDNC replicas=1"
186 __kube_scale deployment $SDNC_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
189 # Check if app shall be fully managed by the test script
190 if [ $retcode_i -eq 0 ]; then
192 echo -e " Creating $SDNC_APP_NAME app and expose service"
194 #Check if nonrtric namespace exists, if not create it
195 __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
197 export KUBE_NONRTRIC_NAMESPACE
199 export SDNC_A1_CONTROLLER_IMAGE
200 export SDNC_INTERNAL_PORT
201 export SDNC_EXTERNAL_PORT
202 export SDNC_INTERNAL_SECURE_PORT
203 export SDNC_EXTERNAL_SECURE_PORT
204 export SDNC_A1_TRUSTSTORE_PASSWORD
205 export SDNC_DB_APP_NAME
211 input_yaml=$SIM_GROUP"/"$SDNC_COMPOSE_DIR"/"svc.yaml
212 output_yaml=$PWD/tmp/sdnc_svc.yaml
213 __kube_create_instance service $SDNC_APP_NAME $input_yaml $output_yaml
216 input_yaml=$SIM_GROUP"/"$SDNC_COMPOSE_DIR"/"$SDNC_KUBE_APP_FILE
217 output_yaml=$PWD/tmp/sdnc_app.yaml
218 __kube_create_instance app $SDNC_APP_NAME $input_yaml $output_yaml
222 echo " Retrieving host and ports for service..."
223 SDNC_HOST_NAME=$(__kube_get_service_host $SDNC_APP_NAME $KUBE_NONRTRIC_NAMESPACE)
224 SDNC_EXTERNAL_PORT=$(__kube_get_service_port $SDNC_APP_NAME $KUBE_NONRTRIC_NAMESPACE "http")
225 SDNC_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $SDNC_APP_NAME $KUBE_NONRTRIC_NAMESPACE "https")
227 echo " Host IP, http port, https port: $SDNC_HOST_NAME $SDNC_EXTERNAL_PORT $SDNC_EXTERNAL_SECURE_PORT"
229 if [ $SDNC_HTTPX == "http" ]; then
230 SDNC_PATH=$SDNC_HTTPX"://"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_PORT
231 SDNC_API_PATH=$SDNC_HTTPX"://"$SDNC_USER":"$SDNC_PWD"@"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_PORT$SDNC_API_URL
233 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
235 #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_PORT
237 SDNC_PATH=$SDNC_HTTPX"://"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_SECURE_PORT
238 SDNC_API_PATH=$SDNC_HTTPX"://"$SDNC_USER":"$SDNC_PWD"@"$SDNC_HOST_NAME":"$SDNC_EXTERNAL_SECURE_PORT$SDNC_API_URL
240 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_SECURE_PORT
242 #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_SECURE_PORT
245 __check_service_start $SDNC_APP_NAME $SDNC_PATH$SDNC_ALIVE_URL
248 __check_included_image 'SDNC'
249 if [ $? -eq 1 ]; then
250 echo -e $RED"The SDNC A1 Controller app is not included in this test script"$ERED
251 echo -e $RED"The Policy Agent will not be started"$ERED
255 export SDNC_DB_APP_NAME
257 export SDNC_INTERNAL_PORT
258 export SDNC_EXTERNAL_PORT
259 export SDNC_INTERNAL_SECURE_PORT
260 export SDNC_EXTERNAL_SECURE_PORT
261 export SDNC_A1_TRUSTSTORE_PASSWORD
262 export DOCKER_SIM_NWNAME
263 export SDNC_DISPLAY_NAME
267 __start_container $SDNC_COMPOSE_DIR $SDNC_COMPOSE_FILE NODOCKERARGS 1 $SDNC_APP_NAME
269 __check_service_start $SDNC_APP_NAME $SDNC_PATH$SDNC_ALIVE_URL
275 # Check the agent logs for WARNINGs and ERRORs
277 # (Function for test scripts)
279 __check_container_logs "SDNC A1 Controller" $SDNC_APP_NAME $SDNC_KARAF_LOG WARN ERROR
282 # Generic function to query the RICs via the A1-controller API.
283 # args: <operation> <url> [<body>]
284 # <operation>: getA1Policy,putA1Policy,getA1PolicyType,deleteA1Policy,getA1PolicyStatus
285 # response: <json-body><3-digit-response-code>
286 # (Not for test scripts)
287 __do_curl_to_controller() {
288 echo " (${BASH_LINENO[0]}): ${FUNCNAME[0]}" $@ >> $HTTPLOG
289 if [ $# -ne 2 ] && [ $# -ne 3 ]; then
291 echo "-Incorrect number of parameters to __do_curl_to_controller " $@ >> $HTTPLOG
292 echo "-Expected: <operation> <url> [<body>]" >> $HTTPLOG
293 echo "-Returning response 000" >> $HTTPLOG
297 if [ $# -eq 2 ]; then
298 json='{"input":{"near-rt-ric-url":"'$2'"}}'
300 # Escape quotes in the body
301 body=$(echo "$3" | sed 's/"/\\"/g')
302 json='{"input":{"near-rt-ric-url":"'$2'","body":"'"$body"'"}}'
304 payload="./tmp/.sdnc.payload.json"
305 echo "$json" > $payload
306 echo " FILE ($payload) : $json" >> $HTTPLOG
308 if [ $RUNMODE == "KUBE" ]; then
309 if [ ! -z "$KUBE_PROXY_PATH" ]; then
310 proxyflag=" --proxy KUBE_PROXY_PATH"
313 curlString="curl -skw %{http_code} $proxyflag -X POST $SDNC_API_PATH$1 -H accept:application/json -H Content-Type:application/json --data-binary @$payload"
314 echo " CMD: "$curlString >> $HTTPLOG
317 echo " RESP: "$res >> $HTTPLOG
318 if [ $retcode -ne 0 ]; then
319 echo " RETCODE: "$retcode >> $HTTPLOG
324 status=${res:${#res}-3}
326 if [ $status -ne 200 ]; then
330 body=${res:0:${#res}-3}
331 echo " JSON: "$body >> $HTTPLOG
332 reply="./tmp/.sdnc-reply.json"
333 echo "$body" > $reply
334 res=$(python3 ../common/extract_sdnc_reply.py $SDNC_RESPONSE_JSON_KEY $reply)
335 echo " EXTRACED BODY+CODE: "$res >> $HTTPLOG
340 # Controller API Test function: getA1Policy (return ids only)
341 # arg: <response-code> (OSC <ric-id> <policy-type-id> [ <policy-id> [<policy-id>]* ]) | ( STD <ric-id> [ <policy-id> [<policy-id>]* ] )
342 # (Function for test scripts)
343 controller_api_get_A1_policy_ids() {
347 if [ $RUNMODE == "KUBE" ]; then
348 ric_id=$(get_kube_sim_host $3)
351 if [ $# -gt 3 ] && [ $2 == "OSC" ]; then
352 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies"
354 elif [ $# -gt 2 ] && [ $2 == "STD" ]; then
355 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies"
359 if [ $paramError -ne 0 ]; then
360 __print_err "<response-code> (OSC <ric-id> <policy-type-id> [ <policy-id> [<policy-id>]* ]) | ( STD <ric-id> [ <policy-id> [<policy-id>]* ] )" $@
364 res=$(__do_curl_to_controller getA1Policy "$url")
366 status=${res:${#res}-3}
368 if [ $retcode -ne 0 ]; then
369 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
373 if [ $status -ne $1 ]; then
374 __log_test_fail_status_code $1 $status
377 body=${res:0:${#res}-3}
381 if [ $2 == "OSC" ]; then
384 for pid in ${@:$start} ; do
385 if [ "$targetJson" != "[" ]; then
386 targetJson=$targetJson","
388 targetJson=$targetJson"\"$UUID$pid\""
390 targetJson=$targetJson"]"
392 echo " TARGET JSON: $targetJson" >> $HTTPLOG
394 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
396 if [ $res -ne 0 ]; then
406 # Controller API Test function: getA1PolicyType
407 # arg: <response-code> OSC <ric-id> <policy-type-id> [<policy-type-file>]
408 # (Function for test scripts)
409 controller_api_get_A1_policy_type() {
413 if [ $RUNMODE == "KUBE" ]; then
414 ric_id=$(get_kube_sim_host $3)
417 if [ $# -gt 3 ] && [ $2 == "OSC" ]; then
418 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4"
422 if [ $paramError -ne 0 ]; then
423 __print_err "<response-code> OSC <ric-id> <policy-type-id> [<policy-type-file>]" $@
427 res=$(__do_curl_to_controller getA1PolicyType "$url")
429 status=${res:${#res}-3}
431 if [ $retcode -ne 0 ]; then
432 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
436 if [ $status -ne $1 ]; then
437 __log_test_fail_status_code $1 $status
440 body=${res:0:${#res}-3}
442 if [ $# -eq 5 ]; then
444 body=${res:0:${#res}-3}
447 echo " TARGET JSON: $targetJson" >> $HTTPLOG
448 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
450 if [ $res -ne 0 ]; then
460 # Controller API Test function: deleteA1Policy
461 # arg: <response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)
462 # (Function for test scripts)
463 controller_api_delete_A1_policy() {
467 if [ $RUNMODE == "KUBE" ]; then
468 ric_id=$(get_kube_sim_host $3)
471 if [ $# -eq 5 ] && [ $2 == "OSC" ]; then
472 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5"
474 elif [ $# -eq 4 ] && [ $2 == "STD" ]; then
475 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4"
479 if [ $paramError -ne 0 ]; then
480 __print_err "<response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)" $@
484 res=$(__do_curl_to_controller deleteA1Policy "$url")
486 status=${res:${#res}-3}
488 if [ $retcode -ne 0 ]; then
489 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
493 if [ $status -ne $1 ]; then
494 __log_test_fail_status_code $1 $status
502 # Controller API Test function: putA1Policy
503 # arg: <response-code> (STD <ric-id> <policy-id> <template-file> ) | (OSC <ric-id> <policy-type-id> <policy-id> <template-file>)
504 # (Function for test scripts)
505 controller_api_put_A1_policy() {
509 if [ $RUNMODE == "KUBE" ]; then
510 ric_id=$(get_kube_sim_host $3)
513 if [ $# -eq 6 ] && [ $2 == "OSC" ]; then
514 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5"
515 body=$(sed 's/XXX/'${5}'/g' $6)
518 elif [ $# -eq 5 ] && [ $2 == "STD" ]; then
519 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4"
520 body=$(sed 's/XXX/'${4}'/g' $5)
524 if [ $paramError -ne 0 ]; then
525 __print_err "<response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)" $@
529 res=$(__do_curl_to_controller putA1Policy "$url" "$body")
531 status=${res:${#res}-3}
533 if [ $retcode -ne 0 ]; then
534 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
538 if [ $status -ne $1 ]; then
539 __log_test_fail_status_code $1 $status
548 # Controller API Test function: getA1PolicyStatus
549 # arg: <response-code> (STD <ric-id> <policy-id> <enforce-status> [<reason>]) | (OSC <ric-id> <policy-type-id> <policy-id> <instance-status> <has-been-deleted>)
550 # (Function for test scripts)
551 controller_api_get_A1_policy_status() {
555 if [ $RUNMODE == "KUBE" ]; then
556 ric_id=$(get_kube_sim_host $3)
560 if [ $# -ge 5 ] && [ $2 == "OSC" ]; then
561 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5/status"
562 if [ $# -gt 5 ]; then
563 targetJson="{\"instance_status\":\"$6\""
564 targetJson=$targetJson",\"has_been_deleted\":\"$7\""
565 targetJson=$targetJson",\"created_at\":\"????\"}"
568 elif [ $# -ge 4 ] && [ $2 == "STD" ]; then
569 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4/status"
570 if [ $# -gt 4 ]; then
571 targetJson="{\"enforceStatus\":\"$5\""
572 if [ $# -eq 6 ]; then
573 targetJson=$targetJson",\"reason\":\"$6\""
575 targetJson=$targetJson"}"
580 if [ $paramError -ne 0 ]; then
581 __print_err "<response-code> (STD <ric-id> <policy-id> <enforce-status> [<reason>]) | (OSC <ric-id> <policy-type-id> <policy-id> <instance-status> <has-been-deleted>)" $@
585 res=$(__do_curl_to_controller getA1PolicyStatus "$url")
587 status=${res:${#res}-3}
589 if [ $retcode -ne 0 ]; then
590 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
594 if [ $status -ne $1 ]; then
595 __log_test_fail_status_code $1 $status
599 if [ ! -z "$targetJson" ]; then
601 body=${res:0:${#res}-3}
602 echo " TARGET JSON: $targetJson" >> $HTTPLOG
603 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
605 if [ $res -ne 0 ]; then