test/common/controller_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 A1 Controller API
  21
  22 ################ Test engine functions ################
  23
  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
  27 __SDNC_imagesetup() {
  28
  29         sdnc_suffix_tag=$1
  30
  31         for oia_name in $ONAP_IMAGES_APP_NAMES; do
  32                 if [ "$oia_name" == "SDNC" ]; then
  33                         sdnc_suffix_tag="REMOTE_RELEASE_ONAP"
  34                 fi
  35         done
  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"
  38
  39 }
  40
  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'
  46 __SDNC_imagepull() {
  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
  49 }
  50
  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
  54 __SDNC_imagebuild() {
  55         echo -e $RED" Image for app SDNC shall never be built"$ERED
  56 }
  57
  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>
  61 __SDNC_image_data() {
  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
  65         fi
  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
  69         fi
  70 }
  71
  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
  77 }
  78
  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"
  83 }
  84
  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
  89 }
  90
  91 # Store docker logs
  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
  96 }
  97
  98 #######################################################
  99
 100
 101 SDNC_HTTPX="http"
 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
 108     #presume correct
 109         SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
 110         #test
 111         #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
 112 else
 113         SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_INTERNAL_PORT
 114 fi
 115
 116 use_sdnc_http() {
 117         echo -e $BOLD"SDNC NB protocol setting"$EBOLD
 118         echo -e " Using $BOLD http $EBOLD towards SDNC"
 119         SDNC_HTTPX="http"
 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
 123                 #presume correct
 124                 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
 125                 #test
 126                 #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_PORT
 127         else
 128                 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_INTERNAL_PORT
 129         fi
 130         echo ""
 131 }
 132
 133 use_sdnc_https() {
 134         echo -e $BOLD"SDNC NB protocol setting"$EBOLD
 135         echo -e " Using $BOLD https $EBOLD towards SDNC"
 136         SDNC_HTTPX="https"
 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
 140                 #presume correct
 141                 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_SECURE_PORT
 142                 #test
 143                 #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_SECURE_PORT
 144         else
 145                 SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_INTERNAL_SECURE_PORT
 146         fi
 147         echo ""
 148 }
 149
 150 ##################
 151 ### SDNC functions
 152 ##################
 153
 154 # Start the SDNC A1 Controller
 155 # args: -
 156 # (Function for test scripts)
 157 start_sdnc() {
 158
 159         echo -e $BOLD"Starting $SDNC_DISPLAY_NAME"$EBOLD
 160
 161         if [ $RUNMODE == "KUBE" ]; then
 162
 163                 # Check if app shall be fully managed by the test script
 164                 __check_included_image "SDNC"
 165                 retcode_i=$?
 166
 167                 # Check if app shall only be used by the testscipt
 168                 __check_prestarted_image "SDNC"
 169                 retcode_p=$?
 170
 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
 174                         exit
 175                 fi
 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
 179                         exit
 180                 fi
 181
 182
 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
 187                 fi
 188
 189                                 # Check if app shall be fully managed by the test script
 190                 if [ $retcode_i -eq 0 ]; then
 191
 192                         echo -e " Creating $SDNC_APP_NAME app and expose service"
 193
 194                         #Check if nonrtric namespace exists, if not create it
 195                         __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
 196
 197                         export KUBE_NONRTRIC_NAMESPACE
 198                         export SDNC_APP_NAME
 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
 206                         export SDNC_DB_IMAGE
 207                         export SDNC_USER
 208                         export SDNC_PWD
 209
 210                         # Create service
 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
 214
 215                         # Create app
 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
 219
 220                 fi
 221
 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")
 226
 227                 echo " Host IP, http port, https port: $SDNC_HOST_NAME $SDNC_EXTERNAL_PORT $SDNC_EXTERNAL_SECURE_PORT"
 228
 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
 232             #presume correct
 233                         SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_PORT
 234                         #test
 235                         #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_PORT
 236                 else
 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
 239             #presume correct
 240                         SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME"."$KUBE_NONRTRIC_NAMESPACE":"$SDNC_EXTERNAL_SECURE_PORT
 241                         #test
 242                         #SDNC_SERVICE_PATH=$SDNC_HTTPX"://"$SDNC_APP_NAME":"$SDNC_EXTERNAL_SECURE_PORT
 243                 fi
 244
 245                 __check_service_start $SDNC_APP_NAME $SDNC_PATH$SDNC_ALIVE_URL
 246         else
 247
 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
 252                         exit
 253                 fi
 254
 255                 export SDNC_DB_APP_NAME
 256         export SDNC_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
 264                 export SDNC_USER
 265                 export SDNC_PWD
 266
 267                 __start_container $SDNC_COMPOSE_DIR $SDNC_COMPOSE_FILE NODOCKERARGS 1 $SDNC_APP_NAME
 268
 269                 __check_service_start $SDNC_APP_NAME $SDNC_PATH$SDNC_ALIVE_URL
 270         fi
 271     echo ""
 272     return 0
 273 }
 274
 275
 276 # Stop the sndc
 277 # args: -
 278 # args: -
 279 # (Function for test scripts)
 280 stop_sdnc() {
 281         echo -e $BOLD"Stopping $SDNC_DISPLAY_NAME"$EBOLD
 282
 283         if [ $RUNMODE == "KUBE" ]; then
 284                 __log_conf_fail_not_supported " Cannot stop sndc in KUBE mode"
 285                 return 1
 286         else
 287                 docker stop $SDNC_APP_NAME &> ./tmp/.dockererr
 288                 if [ $? -ne 0 ]; then
 289                         __print_err "Could not stop $SDNC_APP_NAME" $@
 290                         cat ./tmp/.dockererr
 291                         ((RES_CONF_FAIL++))
 292                         return 1
 293                 fi
 294         fi
 295         echo -e $BOLD$GREEN"Stopped"$EGREEN$EBOLD
 296         echo ""
 297         return 0
 298 }
 299
 300 # Start a previously stopped sdnc
 301 # args: -
 302 # (Function for test scripts)
 303 start_stopped_sdnc() {
 304         echo -e $BOLD"Starting (the previously stopped) $SDNC_DISPLAY_NAME"$EBOLD
 305
 306         if [ $RUNMODE == "KUBE" ]; then
 307                 __log_conf_fail_not_supported " Cannot restart sndc in KUBE mode"
 308                 return 1
 309         else
 310                 docker start $SDNC_APP_NAME &> ./tmp/.dockererr
 311                 if [ $? -ne 0 ]; then
 312                         __print_err "Could not start (the stopped) $SDNC_APP_NAME" $@
 313                         cat ./tmp/.dockererr
 314                         ((RES_CONF_FAIL++))
 315                         return 1
 316                 fi
 317         fi
 318         __check_service_start $SDNC_APP_NAME $SDNC_PATH$SDNC_ALIVE_URL
 319         if [ $? -ne 0 ]; then
 320                 return 1
 321         fi
 322         echo ""
 323         return 0
 324 }
 325
 326 # Check the agent logs for WARNINGs and ERRORs
 327 # args: -
 328 # (Function for test scripts)
 329 check_sdnc_logs() {
 330         __check_container_logs "SDNC A1 Controller" $SDNC_APP_NAME $SDNC_KARAF_LOG WARN ERROR
 331 }
 332
 333 # Generic function to query the RICs via the A1-controller API.
 334 # args: <operation> <url> [<body>]
 335 # <operation>: getA1Policy,putA1Policy,getA1PolicyType,deleteA1Policy,getA1PolicyStatus
 336 # response: <json-body><3-digit-response-code>
 337 # (Not for test scripts)
 338 __do_curl_to_controller() {
 339     echo " (${BASH_LINENO[0]}): ${FUNCNAME[0]}" $@ >> $HTTPLOG
 340     if [ $# -ne 2 ] && [ $# -ne 3 ]; then
 341                 ((RES_CONF_FAIL++))
 342         echo "-Incorrect number of parameters to __do_curl_to_controller " $@ >> $HTTPLOG
 343         echo "-Expected: <operation> <url> [<body>]" >> $HTTPLOG
 344         echo "-Returning response 000" >> $HTTPLOG
 345         echo "000"
 346         return 1
 347     fi
 348     if [ $# -eq 2 ]; then
 349         json='{"input":{"near-rt-ric-url":"'$2'"}}'
 350     else
 351         # Escape quotes in the body
 352         body=$(echo "$3" | sed 's/"/\\"/g')
 353         json='{"input":{"near-rt-ric-url":"'$2'","body":"'"$body"'"}}'
 354     fi
 355         payload="./tmp/.sdnc.payload.json"
 356     echo "$json" > $payload
 357     echo "  FILE ($payload) : $json"  >> $HTTPLOG
 358         proxyflag=""
 359         if [ $RUNMODE == "KUBE" ]; then
 360                 if [ ! -z "$KUBE_PROXY_PATH" ]; then
 361                         if [ $KUBE_PROXY_HTTPX == "http" ]; then
 362                                 proxyflag=" --proxy $KUBE_PROXY_PATH"
 363                         else
 364                                 proxyflag=" --proxy-insecure --proxy $KUBE_PROXY_PATH"
 365                         fi
 366                 fi
 367         fi
 368     curlString="curl -skw %{http_code} $proxyflag -X POST $SDNC_API_PATH$1 -H accept:application/json -H Content-Type:application/json --data-binary @$payload"
 369     echo "  CMD: "$curlString >> $HTTPLOG
 370     res=$($curlString)
 371     retcode=$?
 372     echo "  RESP: "$res >> $HTTPLOG
 373     if [ $retcode -ne 0 ]; then
 374         echo "  RETCODE: "$retcode >> $HTTPLOG
 375         echo "000"
 376         return 1
 377     fi
 378
 379         status=${res:${#res}-3}
 380
 381     if [ $status -ne 200 ]; then
 382         echo "000"
 383         return 1
 384     fi
 385     body=${res:0:${#res}-3}
 386         echo "  JSON: "$body >> $HTTPLOG
 387         reply="./tmp/.sdnc-reply.json"
 388     echo "$body" > $reply
 389     res=$(python3 ../common/extract_sdnc_reply.py $SDNC_RESPONSE_JSON_KEY $reply)
 390     echo "  EXTRACED BODY+CODE: "$res >> $HTTPLOG
 391     echo "$res"
 392     return 0
 393 }
 394
 395 # Controller API Test function: getA1Policy (return ids only)
 396 # arg: <response-code> (OSC <ric-id> <policy-type-id> [ <policy-id> [<policy-id>]* ]) | ( STD <ric-id> [ <policy-id> [<policy-id>]* ] )
 397 # (Function for test scripts)
 398 controller_api_get_A1_policy_ids() {
 399         __log_test_start $@
 400
 401         ric_id=$3
 402         if [ $RUNMODE == "KUBE" ]; then
 403                 ric_id=$(get_kube_sim_host $3)
 404         fi
 405     paramError=1
 406     if [ $# -gt 3 ] && [ $2 == "OSC" ]; then
 407         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies"
 408                 paramError=0
 409     elif [ $# -gt 2 ] && [ $2 == "STD" ]; then
 410         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies"
 411         paramError=0
 412         fi
 413
 414     if [ $paramError -ne 0 ]; then
 415                 __print_err "<response-code> (OSC <ric-id> <policy-type-id> [ <policy-id> [<policy-id>]* ]) | ( STD <ric-id> [ <policy-id> [<policy-id>]* ] )" $@
 416                 return 1
 417         fi
 418
 419     res=$(__do_curl_to_controller getA1Policy "$url")
 420     retcode=$?
 421     status=${res:${#res}-3}
 422
 423     if [ $retcode -ne 0 ]; then
 424                 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
 425                 return 1
 426         fi
 427
 428         if [ $status -ne $1 ]; then
 429                 __log_test_fail_status_code $1 $status
 430                 return 1
 431         fi
 432     body=${res:0:${#res}-3}
 433
 434         targetJson="["
 435     start=4
 436     if [ $2 == "OSC" ]; then
 437         start=5
 438     fi
 439     for pid in ${@:$start} ; do
 440         if [ "$targetJson" != "[" ]; then
 441             targetJson=$targetJson","
 442         fi
 443         targetJson=$targetJson"\"$UUID$pid\""
 444     done
 445     targetJson=$targetJson"]"
 446
 447         echo " TARGET JSON: $targetJson" >> $HTTPLOG
 448
 449         res=$(python3 ../common/compare_json.py "$targetJson" "$body")
 450
 451         if [ $res -ne 0 ]; then
 452                 __log_test_fail_body
 453                 return 1
 454         fi
 455
 456         __log_test_pass
 457         return 0
 458 }
 459
 460
 461 # Controller API Test function: getA1PolicyType
 462 # arg: <response-code> OSC <ric-id> <policy-type-id> [<policy-type-file>]
 463 # (Function for test scripts)
 464 controller_api_get_A1_policy_type() {
 465         __log_test_start $@
 466
 467         ric_id=$3
 468         if [ $RUNMODE == "KUBE" ]; then
 469                 ric_id=$(get_kube_sim_host $3)
 470         fi
 471     paramError=1
 472     if [ $# -gt 3 ] && [ $2 == "OSC" ]; then
 473         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4"
 474                 paramError=0
 475         fi
 476
 477     if [ $paramError -ne 0 ]; then
 478                 __print_err "<response-code> OSC <ric-id> <policy-type-id> [<policy-type-file>]" $@
 479                 return 1
 480         fi
 481
 482     res=$(__do_curl_to_controller getA1PolicyType "$url")
 483     retcode=$?
 484     status=${res:${#res}-3}
 485
 486     if [ $retcode -ne 0 ]; then
 487                 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
 488                 return 1
 489         fi
 490
 491         if [ $status -ne $1 ]; then
 492                 __log_test_fail_status_code $1 $status
 493                 return 1
 494         fi
 495     body=${res:0:${#res}-3}
 496
 497         if [ $# -eq 5 ]; then
 498
 499                 body=${res:0:${#res}-3}
 500
 501                 targetJson=$(< $5)
 502                 echo " TARGET JSON: $targetJson" >> $HTTPLOG
 503                 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
 504
 505                 if [ $res -ne 0 ]; then
 506                         __log_test_fail_body
 507                         return 1
 508                 fi
 509         fi
 510
 511         __log_test_pass
 512         return 0
 513 }
 514
 515 # Controller API Test function: deleteA1Policy
 516 # arg: <response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)
 517 # (Function for test scripts)
 518 controller_api_delete_A1_policy() {
 519         __log_test_start $@
 520
 521         ric_id=$3
 522         if [ $RUNMODE == "KUBE" ]; then
 523                 ric_id=$(get_kube_sim_host $3)
 524         fi
 525     paramError=1
 526     if [ $# -eq 5 ] && [ $2 == "OSC" ]; then
 527         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5"
 528                 paramError=0
 529     elif [ $# -eq 4 ] && [ $2 == "STD" ]; then
 530         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4"
 531         paramError=0
 532         fi
 533
 534     if [ $paramError -ne 0 ]; then
 535                 __print_err "<response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)" $@
 536                 return 1
 537         fi
 538
 539     res=$(__do_curl_to_controller deleteA1Policy "$url")
 540     retcode=$?
 541     status=${res:${#res}-3}
 542
 543     if [ $retcode -ne 0 ]; then
 544                 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
 545                 return 1
 546         fi
 547
 548         if [ $status -ne $1 ]; then
 549                 __log_test_fail_status_code $1 $status
 550                 return 1
 551         fi
 552
 553         __log_test_pass
 554         return 0
 555 }
 556
 557 # Controller API Test function: putA1Policy
 558 # arg: <response-code> (STD <ric-id> <policy-id> <template-file> ) | (OSC <ric-id> <policy-type-id> <policy-id> <template-file>)
 559 # (Function for test scripts)
 560 controller_api_put_A1_policy() {
 561         __log_test_start $@
 562
 563         ric_id=$3
 564         if [ $RUNMODE == "KUBE" ]; then
 565                 ric_id=$(get_kube_sim_host $3)
 566         fi
 567     paramError=1
 568     if [ $# -eq 6 ] && [ $2 == "OSC" ]; then
 569         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5"
 570         body=$(sed 's/XXX/'${5}'/g' $6)
 571
 572                 paramError=0
 573     elif [ $# -eq 5 ] && [ $2 == "STD" ]; then
 574         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4"
 575         body=$(sed 's/XXX/'${4}'/g' $5)
 576         paramError=0
 577         fi
 578
 579     if [ $paramError -ne 0 ]; then
 580                 __print_err "<response-code> (STD <ric-id> <policy-id>) | (OSC <ric-id> <policy-type-id> <policy-id>)" $@
 581                 return 1
 582         fi
 583
 584     res=$(__do_curl_to_controller putA1Policy "$url" "$body")
 585     retcode=$?
 586     status=${res:${#res}-3}
 587
 588     if [ $retcode -ne 0 ]; then
 589                 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
 590                 return 1
 591         fi
 592
 593         if [ $status -ne $1 ]; then
 594                 __log_test_fail_status_code $1 $status
 595                 return 1
 596         fi
 597
 598         __log_test_pass
 599         return 0
 600 }
 601
 602
 603 # Controller API Test function: getA1PolicyStatus
 604 # arg: <response-code> (STD <ric-id> <policy-id> <enforce-status> [<reason>]) | (OSC <ric-id> <policy-type-id> <policy-id> <instance-status> <has-been-deleted>)
 605 # (Function for test scripts)
 606 controller_api_get_A1_policy_status() {
 607         __log_test_start $@
 608
 609         ric_id=$3
 610         if [ $RUNMODE == "KUBE" ]; then
 611                 ric_id=$(get_kube_sim_host $3)
 612         fi
 613     targetJson=""
 614     paramError=1
 615     if [ $# -ge 5 ] && [ $2 == "OSC" ]; then
 616         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/a1-p/policytypes/$4/policies/$UUID$5/status"
 617         if [ $# -gt 5 ]; then
 618             targetJson="{\"instance_status\":\"$6\""
 619             targetJson=$targetJson",\"has_been_deleted\":\"$7\""
 620             targetJson=$targetJson",\"created_at\":\"????\"}"
 621         fi
 622                 paramError=0
 623     elif [ $# -ge 4 ] && [ $2 == "STD" ]; then
 624         url="$RIC_SIM_HTTPX://$ric_id:$RIC_SIM_PORT/A1-P/v1/policies/$UUID$4/status"
 625         if [ $# -gt 4 ]; then
 626             targetJson="{\"enforceStatus\":\"$5\""
 627             if [ $# -eq 6 ]; then
 628                 targetJson=$targetJson",\"reason\":\"$6\""
 629             fi
 630             targetJson=$targetJson"}"
 631         fi
 632         paramError=0
 633         fi
 634
 635     if [ $paramError -ne 0 ]; then
 636                 __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>)" $@
 637                 return 1
 638         fi
 639
 640     res=$(__do_curl_to_controller getA1PolicyStatus "$url")
 641     retcode=$?
 642     status=${res:${#res}-3}
 643
 644     if [ $retcode -ne 0 ]; then
 645                 __log_test_fail_status_code $1 $retcode "(likely remote server error)"
 646                 return 1
 647         fi
 648
 649         if [ $status -ne $1 ]; then
 650                 __log_test_fail_status_code $1 $status
 651                 return 1
 652         fi
 653
 654         if [ ! -z "$targetJson" ]; then
 655
 656                 body=${res:0:${#res}-3}
 657                 echo " TARGET JSON: $targetJson" >> $HTTPLOG
 658                 res=$(python3 ../common/compare_json.py "$targetJson" "$body")
 659
 660                 if [ $res -ne 0 ]; then
 661                         __log_test_fail_body
 662                         return 1
 663                 fi
 664         fi
 665
 666         __log_test_pass
 667         return 0
 668 }