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_SNDC_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_SNDC_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 if [ $RUNMODE == "KUBE" ]; then
96 kubectl logs -l "autotest=SDNC" -n $KUBE_SNDC_NAMESPACE --tail=-1 > $1$2_SDNC.log 2>&1
97 podname=$(kubectl get pods -n $KUBE_SNDC_NAMESPACE -l "autotest=SDNC" -o custom-columns=":metadata.name")
98 kubectl exec -t -n $KUBE_SNDC_NAMESPACE $podname -- cat $SDNC_KARAF_LOG> $1$2_SDNC_karaf.log 2>&1
100 docker exec -t $SDNC_APP_NAME cat $SDNC_KARAF_LOG> $1$2_SDNC_karaf.log 2>&1
104 # Initial setup of protocol, host and ports
105 # This function is called for apps managed by the test script.
107 __SDNC_initial_setup() {
111 #######################################################
113 # Set http as the protocol to use for all communication to SDNC
115 # (Function for test scripts)
117 __sdnc_set_protocoll "http" $SDNC_INTERNAL_PORT $SDNC_EXTERNAL_PORT
120 # Set https as the protocol to use for all communication to SDNC
122 # (Function for test scripts)
124 __sdnc_set_protocoll "https" $SDNC_INTERNAL_SECURE_PORT $SDNC_EXTERNAL_SECURE_PORT
127 # Setup paths to svc/container for internal and external access
128 # args: <protocol> <internal-port> <external-port>
129 __sdnc_set_protocoll() {
130 echo -e $BOLD"$SDNC_DISPLAY_NAME protocol setting"$EBOLD
131 echo -e " Using $BOLD http $EBOLD towards $SDNC_DISPLAY_NAME"
135 SDNC_SERVICE_PATH=$1"://"$SDNC_APP_NAME":"$2 # docker access, container->container and script->container via proxy
136 SDNC_SERVICE_API_PATH=$1"://"$SDNC_USER":"$SDNC_PWD"@"$SDNC_APP_NAME":"$1$SDNC_API_URL
137 if [ $RUNMODE == "KUBE" ]; then
138 SDNC_SERVICE_PATH=$1"://"$SDNC_APP_NAME.$KUBE_SNDC_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
139 SDNC_SERVICE_API_PATH=$1"://"$SDNC_USER":"$SDNC_PWD"@"$SDNC_APP_NAME.KUBE_SNDC_NAMESPACE":"$1$SDNC_API_URL
145 # Export env vars for config files, docker compose and kube resources
147 __sdnc_export_vars() {
148 export KUBE_SNDC_NAMESPACE
149 export DOCKER_SIM_NWNAME
152 export SDNC_DISPLAY_NAME
154 export SDNC_A1_CONTROLLER_IMAGE
155 export SDNC_INTERNAL_PORT
156 export SDNC_EXTERNAL_PORT
157 export SDNC_INTERNAL_SECURE_PORT
158 export SDNC_EXTERNAL_SECURE_PORT
159 export SDNC_A1_TRUSTSTORE_PASSWORD
160 export SDNC_DB_APP_NAME
170 # Start the SDNC A1 Controller
172 # (Function for test scripts)
175 echo -e $BOLD"Starting $SDNC_DISPLAY_NAME"$EBOLD
177 if [ $RUNMODE == "KUBE" ]; then
179 # Check if app shall be fully managed by the test script
180 __check_included_image "SDNC"
183 # Check if app shall only be used by the testscipt
184 __check_prestarted_image "SDNC"
187 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
188 echo -e $RED"The $SDNC_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
189 echo -e $RED"The $SDNC_APP_NAME will not be started"$ERED
192 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
193 echo -e $RED"The $SDNC_APP_NAME app is included both as managed and prestarted in this test script"$ERED
194 echo -e $RED"The $SDNC_APP_NAME will not be started"$ERED
199 if [ $retcode_p -eq 0 ]; then
200 echo -e " Using existing $SDNC_APP_NAME deployment and service"
201 echo " Setting SDNC replicas=1"
202 __kube_scale deployment $SDNC_APP_NAME $KUBE_SNDC_NAMESPACE 1
205 # Check if app shall be fully managed by the test script
206 if [ $retcode_i -eq 0 ]; then
208 echo -e " Creating $SDNC_APP_NAME app and expose service"
210 #Check if namespace exists, if not create it
211 __kube_create_namespace $KUBE_SNDC_NAMESPACE
216 input_yaml=$SIM_GROUP"/"$SDNC_COMPOSE_DIR"/"svc.yaml
217 output_yaml=$PWD/tmp/sdnc_svc.yaml
218 __kube_create_instance service $SDNC_APP_NAME $input_yaml $output_yaml
221 input_yaml=$SIM_GROUP"/"$SDNC_COMPOSE_DIR"/"$SDNC_KUBE_APP_FILE
222 output_yaml=$PWD/tmp/sdnc_app.yaml
223 __kube_create_instance app $SDNC_APP_NAME $input_yaml $output_yaml
227 __check_service_start $SDNC_APP_NAME $SDNC_SERVICE_PATH$SDNC_ALIVE_URL
230 __check_included_image 'SDNC'
231 if [ $? -eq 1 ]; then
232 echo -e $RED"The SDNC A1 Controller app is not included in this test script"$ERED
233 echo -e $RED"The Policy Agent will not be started"$ERED
239 __start_container $SDNC_COMPOSE_DIR $SDNC_COMPOSE_FILE NODOCKERARGS 1 $SDNC_APP_NAME
241 __check_service_start $SDNC_APP_NAME $SDNC_SERVICE_PATH$SDNC_ALIVE_URL
251 # (Function for test scripts)
253 echo -e $BOLD"Stopping $SDNC_DISPLAY_NAME"$EBOLD
255 if [ $RUNMODE == "KUBE" ]; then
256 __log_conf_fail_not_supported " Cannot stop sndc in KUBE mode"
259 docker stop $SDNC_APP_NAME &> ./tmp/.dockererr
260 if [ $? -ne 0 ]; then
261 __print_err "Could not stop $SDNC_APP_NAME" $@
267 echo -e $BOLD$GREEN"Stopped"$EGREEN$EBOLD
272 # Start a previously stopped sdnc
274 # (Function for test scripts)
275 start_stopped_sdnc() {
276 echo -e $BOLD"Starting (the previously stopped) $SDNC_DISPLAY_NAME"$EBOLD
278 if [ $RUNMODE == "KUBE" ]; then
279 __log_conf_fail_not_supported " Cannot restart sndc in KUBE mode"
282 docker start $SDNC_APP_NAME &> ./tmp/.dockererr
283 if [ $? -ne 0 ]; then
284 __print_err "Could not start (the stopped) $SDNC_APP_NAME" $@
290 __check_service_start $SDNC_APP_NAME $SDNC_SERVICE_PATH$SDNC_ALIVE_URL
291 if [ $? -ne 0 ]; then
298 # Check the agent logs for WARNINGs and ERRORs
300 # (Function for test scripts)
302 __check_container_logs "SDNC A1 Controller" $SDNC_APP_NAME $SDNC_KARAF_LOG WARN ERROR
305 # Generic function to query the RICs via the A1-controller API.
306 # args: <operation> <url> [<body>]
307 # <operation>: getA1Policy,putA1Policy,getA1PolicyType,deleteA1Policy,getA1PolicyStatus
308 # response: <json-body><3-digit-response-code>
309 # (Not for test scripts)
310 __do_curl_to_controller() {
311 echo " (${BASH_LINENO[0]}): ${FUNCNAME[0]}" $@ >> $HTTPLOG
312 if [ $# -ne 2 ] && [ $# -ne 3 ]; then
314 echo "-Incorrect number of parameters to __do_curl_to_controller " $@ >> $HTTPLOG
315 echo "-Expected: <operation> <url> [<body>]" >> $HTTPLOG
316 echo "-Returning response 000" >> $HTTPLOG
320 if [ $# -eq 2 ]; then
321 json='{"input":{"near-rt-ric-url":"'$2'"}}'
323 # Escape quotes in the body
324 body=$(echo "$3" | sed 's/"/\\"/g')
325 json='{"input":{"near-rt-ric-url":"'$2'","body":"'"$body"'"}}'
327 payload="./tmp/.sdnc.payload.json"
328 echo "$json" > $payload
329 echo " FILE ($payload) : $json" >> $HTTPLOG
331 if [ ! -z "$KUBE_PROXY_PATH" ]; then
332 if [ $KUBE_PROXY_HTTPX == "http" ]; then
333 proxyflag=" --proxy $KUBE_PROXY_PATH"
335 proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
338 curlString="curl -skw %{http_code} $proxyflag -X POST $SDNC_SERVICE_API_PATH$1 -H accept:application/json -H Content-Type:application/json --data-binary @$payload"
339 echo " CMD: "$curlString >> $HTTPLOG
342 echo " RESP: "$res >> $HTTPLOG
343 if [ $retcode -ne 0 ]; then
344 echo " RETCODE: "$retcode >> $HTTPLOG
349 status=${res:${#res}-3}
351 if [ $status -ne 200 ]; then
355 body=${res:0:${#res}-3}
356 echo " JSON: "$body >> $HTTPLOG
357 reply="./tmp/.sdnc-reply.json"
358 echo "$body" > $reply
359 res=$(python3 ../common/extract_sdnc_reply.py $SDNC_RESPONSE_JSON_KEY $reply)
360 echo " EXTRACED BODY+CODE: "$res >> $HTTPLOG
365 # Controller API Test function: getA1Policy (return ids only)
366 # arg: <response-code> (OSC <ric-id> <policy-type-id> [ <policy-id> [<policy-id>]* ]) | ( STD <ric-id> [ <policy-id> [<policy-id>]* ] )
367 # (Function for test scripts)
368 controller_api_get_A1_policy_ids() {
372 if [ $RUNMODE == "KUBE" ]; then
373 ric_id=$(get_kube_sim_host $3)
376 if [ $# -gt 3 ] && [ $2 == "OSC" ]; then
377 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies"
379 elif [ $# -gt 2 ] && [ $2 == "STD" ]; then
380 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies"
384 if [ $paramError -ne 0 ]; then
385 __print_err "<response-code> (OSC <ric-id> <policy-type-id> [ <policy-id> [<policy-id>]* ]) | ( STD <ric-id> [ <policy-id> [<policy-id>]* ] )" $@
389 res=$(__do_curl_to_controller getA1Policy "$url")
391 status=${res:${#res}-3}
393 if [ $retcode -ne 0 ]; then
394 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
398 if [ $status -ne $1 ]; then
399 __log_test_fail_status_code $1 $status
402 body=${res:0:${#res}-3}
406 if [ $2 == "OSC" ]; then
409 for pid in ${@:$start} ; do
410 if [ "$targetJson" != "[" ]; then
411 targetJson=$targetJson","
413 targetJson=$targetJson"\"$UUID$pid\""
415 targetJson=$targetJson"]"
417 echo " TARGET JSON: $targetJson" >> $HTTPLOG
419 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
421 if [ $res -ne 0 ]; then
431 # Controller API Test function: getA1PolicyType
432 # arg: <response-code> OSC <ric-id> <policy-type-id> [<policy-type-file>]
433 # (Function for test scripts)
434 controller_api_get_A1_policy_type() {
438 if [ $RUNMODE == "KUBE" ]; then
439 ric_id=$(get_kube_sim_host $3)
442 if [ $# -gt 3 ] && [ $2 == "OSC" ]; then
443 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4"
447 if [ $paramError -ne 0 ]; then
448 __print_err "<response-code> OSC <ric-id> <policy-type-id> [<policy-type-file>]" $@
452 res=$(__do_curl_to_controller getA1PolicyType "$url")
454 status=${res:${#res}-3}
456 if [ $retcode -ne 0 ]; then
457 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
461 if [ $status -ne $1 ]; then
462 __log_test_fail_status_code $1 $status
465 body=${res:0:${#res}-3}
467 if [ $# -eq 5 ]; then
469 body=${res:0:${#res}-3}
472 echo " TARGET JSON: $targetJson" >> $HTTPLOG
473 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
475 if [ $res -ne 0 ]; then
485 # Controller API Test function: deleteA1Policy
486 # arg: <response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)
487 # (Function for test scripts)
488 controller_api_delete_A1_policy() {
492 if [ $RUNMODE == "KUBE" ]; then
493 ric_id=$(get_kube_sim_host $3)
496 if [ $# -eq 5 ] && [ $2 == "OSC" ]; then
497 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5"
499 elif [ $# -eq 4 ] && [ $2 == "STD" ]; then
500 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4"
504 if [ $paramError -ne 0 ]; then
505 __print_err "<response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)" $@
509 res=$(__do_curl_to_controller deleteA1Policy "$url")
511 status=${res:${#res}-3}
513 if [ $retcode -ne 0 ]; then
514 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
518 if [ $status -ne $1 ]; then
519 __log_test_fail_status_code $1 $status
527 # Controller API Test function: putA1Policy
528 # arg: <response-code> (STD <ric-id> <policy-id> <template-file> ) | (OSC <ric-id> <policy-type-id> <policy-id> <template-file>)
529 # (Function for test scripts)
530 controller_api_put_A1_policy() {
534 if [ $RUNMODE == "KUBE" ]; then
535 ric_id=$(get_kube_sim_host $3)
538 if [ $# -eq 6 ] && [ $2 == "OSC" ]; then
539 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5"
540 body=$(sed 's/XXX/'${5}'/g' $6)
543 elif [ $# -eq 5 ] && [ $2 == "STD" ]; then
544 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4"
545 body=$(sed 's/XXX/'${4}'/g' $5)
549 if [ $paramError -ne 0 ]; then
550 __print_err "<response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)" $@
554 res=$(__do_curl_to_controller putA1Policy "$url" "$body")
556 status=${res:${#res}-3}
558 if [ $retcode -ne 0 ]; then
559 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
563 if [ $status -ne $1 ]; then
564 __log_test_fail_status_code $1 $status
573 # Controller API Test function: getA1PolicyStatus
574 # arg: <response-code> (STD <ric-id> <policy-id> <enforce-status> [<reason>]) | (OSC <ric-id> <policy-type-id> <policy-id> <instance-status> <has-been-deleted>)
575 # (Function for test scripts)
576 controller_api_get_A1_policy_status() {
580 if [ $RUNMODE == "KUBE" ]; then
581 ric_id=$(get_kube_sim_host $3)
585 if [ $# -ge 5 ] && [ $2 == "OSC" ]; then
586 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5/status"
587 if [ $# -gt 5 ]; then
588 targetJson="{\"instance_status\":\"$6\""
589 targetJson=$targetJson",\"has_been_deleted\":\"$7\""
590 targetJson=$targetJson",\"created_at\":\"????\"}"
593 elif [ $# -ge 4 ] && [ $2 == "STD" ]; then
594 url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4/status"
595 if [ $# -gt 4 ]; then
596 targetJson="{\"enforceStatus\":\"$5\""
597 if [ $# -eq 6 ]; then
598 targetJson=$targetJson",\"reason\":\"$6\""
600 targetJson=$targetJson"}"
605 if [ $paramError -ne 0 ]; then
606 __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>)" $@
610 res=$(__do_curl_to_controller getA1PolicyStatus "$url")
612 status=${res:${#res}-3}
614 if [ $retcode -ne 0 ]; then
615 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
619 if [ $status -ne $1 ]; then
620 __log_test_fail_status_code $1 $status
624 if [ ! -z "$targetJson" ]; then
626 body=${res:0:${#res}-3}
627 echo " TARGET JSON: $targetJson" >> $HTTPLOG
628 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
630 if [ $res -ne 0 ]; then