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 remove 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         docker logs $PROD_STUB_APP_NAME > $1$2_prodstub.log 2>&1
  97 }
  98 #######################################################
  99
 100
 101 ## Access to Prod stub sim
 102 # Direct access
 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
 106
 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
 110 else
 111         PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME":"$PROD_STUB_INTERNAL_PORT
 112 fi
 113
 114 # Set http as the protocol to use for all communication to the Producer stub
 115 # args: -
 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"
 120
 121         PROD_STUB_HTTPX="http"
 122     PROD_STUB_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_HOST_NAME":"$PROD_STUB_EXTERNAL_PORT
 123
 124         if [ $RUNMODE == "KUBE" ]; then
 125                 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME"."$KUBE_SIM_NAMESPACE":"$PROD_STUB_EXTERNAL_PORT
 126         else
 127                 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME":"$PROD_STUB_INTERNAL_PORT
 128         fi
 129
 130         echo ""
 131 }
 132
 133 # Set https as the protocol to use for all communication to the Producer stub
 134 # args: -
 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"
 139
 140         PROD_STUB_HTTPX="https"
 141     PROD_STUB_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_HOST_NAME":"$PROD_STUB_EXTERNAL_SECURE_PORT
 142
 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
 145         else
 146                 PROD_STUB_SERVICE_PATH=$PROD_STUB_HTTPX"://"$PROD_STUB_APP_NAME":"$PROD_STUB_INTERNAL_SECURE_PORT
 147         fi
 148         echo ""
 149 }
 150
 151 ### Admin API functions producer stub
 152
 153 ###########################
 154 ### Producer stub functions
 155 ###########################
 156
 157 # Start the Producer stub in the simulator group
 158 # args: -
 159 # (Function for test scripts)
 160 start_prod_stub() {
 161
 162         echo -e $BOLD"Starting $PROD_STUB_DISPLAY_NAME"$EBOLD
 163
 164         if [ $RUNMODE == "KUBE" ]; then
 165
 166                 # Check if app shall be fully managed by the test script
 167                 __check_included_image "PRODSTUB"
 168                 retcode_i=$?
 169
 170                 # Check if app shall only be used by the testscipt
 171                 __check_prestarted_image "PRODSTUB"
 172                 retcode_p=$?
 173
 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
 177                         exit
 178                 fi
 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
 182                         exit
 183                 fi
 184
 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
 189                 fi
 190
 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
 200
 201             __kube_create_namespace $KUBE_SIM_NAMESPACE
 202
 203                         # Create service
 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
 207
 208                         # Create app
 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
 212                 fi
 213
 214                 PROD_STUB_HOST_NAME=$(__kube_get_service_host $PROD_STUB_APP_NAME $KUBE_SIM_NAMESPACE)
 215
 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")
 218
 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
 223                 else
 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
 226                 fi
 227
 228                 __check_service_start $PROD_STUB_APP_NAME $PROD_STUB_PATH$PROD_STUB_ALIVE_URL
 229
 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"
 234                 else
 235                         echo -e " Service $PROD_STUB_APP_NAME - reset  $GREEN OK $EGREEN"
 236                 fi
 237         else
 238
 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
 244                         exit
 245                 fi
 246
 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
 254
 255                 export PROD_STUB_DISPLAY_NAME
 256
 257                 __start_container $PROD_STUB_COMPOSE_DIR "" NODOCKERARGS 1 $PROD_STUB_APP_NAME
 258
 259         __check_service_start $PROD_STUB_APP_NAME $PROD_STUB_PATH$PROD_STUB_ALIVE_URL
 260         fi
 261     echo ""
 262     return 0
 263 }
 264
 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
 270         proxyflag=""
 271         if [ $RUNMODE == "KUBE" ]; then
 272                 if [ ! -z "$KUBE_PROXY_PATH" ]; then
 273                         proxyflag=" --proxy $KUBE_PROXY_PATH"
 274                 fi
 275         fi
 276         echo " CMD: $3 $proxyflag" >> $HTTPLOG
 277         res="$($3 $proxyflag)"
 278         echo " RESP: $res" >> $HTTPLOG
 279         retcode=$?
 280     if [ $retcode -ne 0 ]; then
 281         __log_conf_fail_general " Fatal error when executing curl, response: "$retcode
 282         return 1
 283     fi
 284     status=${res:${#res}-3}
 285     if [ $status -eq $2 ]; then
 286         if [ $# -eq 4 ]; then
 287             body=${res:0:${#res}-3}
 288             jobfile=$(cat $4)
 289             echo " TARGET JSON: $jobfile" >> $HTTPLOG
 290                     res=$(python3 ../common/compare_json.py "$jobfile" "$body")
 291             if [ $res -ne 0 ]; then
 292                 if [ $1 == "TEST" ]; then
 293                     __log_test_fail_body
 294                  else
 295                     __log_conf_fail_body
 296                 fi
 297                 return 1
 298             fi
 299         fi
 300         if [ $1 == "TEST" ]; then
 301             __log_test_pass
 302         else
 303             __log_conf_ok
 304         fi
 305         return 0
 306     fi
 307     if [ $1 == "TEST" ]; then
 308         __log_test_fail_status_code $2 $status
 309         else
 310         __log_conf_fail_status_code $2 $status
 311     fi
 312     return 1
 313 }
 314
 315 # Prodstub API: Set (or reset) response code for producer supervision
 316 # <response-code> <producer-id> [<forced_response_code>]
 317 # (Function for test scripts)
 318 prodstub_arm_producer() {
 319         __log_conf_start $@
 320         if [ $# -ne 2 ] && [ $# -ne 3 ]; then
 321                 __print_err "<response-code> <producer-id> [<forced_response_code>]" $@
 322                 return 1
 323         fi
 324
 325     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/supervision/"$2
 326         if [ $# -eq 3 ]; then
 327                 curlString=$curlString"?response="$3
 328         fi
 329
 330     __execute_curl_to_prodstub CONF $1 "$curlString"
 331     return $?
 332 }
 333
 334 # Prodstub API: Set (or reset) response code job create
 335 # <response-code> <producer-id> <job-id> [<forced_response_code>]
 336 # (Function for test scripts)
 337 prodstub_arm_job_create() {
 338         __log_conf_start $@
 339         if [ $# -ne 3 ] && [ $# -ne 4 ]; then
 340                 __print_err "<response-code> <producer-id> <job-id> [<forced_response_code>]" $@
 341                 return 1
 342         fi
 343
 344     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/create/$2/$3"
 345         if [ $# -eq 4 ]; then
 346                 curlString=$curlString"?response="$4
 347         fi
 348
 349     __execute_curl_to_prodstub CONF $1 "$curlString"
 350     return $?
 351 }
 352
 353 # Prodstub API: Set (or reset) response code job delete
 354 # <response-code> <producer-id> <job-id> [<forced_response_code>]
 355 # (Function for test scripts)
 356 prodstub_arm_job_delete() {
 357         __log_conf_start $@
 358         if [ $# -ne 3 ] && [ $# -ne 4 ]; then
 359                 __print_err "<response-code> <producer-id> <job-id> [<forced_response_code>]" $@
 360                 return 1
 361         fi
 362
 363     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/delete/$2/$3"
 364         if [ $# -eq 4 ]; then
 365                 curlString=$curlString"?response="$4
 366         fi
 367
 368     __execute_curl_to_prodstub CONF $1 "$curlString"
 369     return $?
 370 }
 371
 372 # Prodstub API: Arm a type of a producer
 373 # <response-code> <producer-id> <type-id>
 374 # (Function for test scripts)
 375 prodstub_arm_type() {
 376         __log_conf_start $@
 377         if [ $# -ne 3 ]; then
 378                 __print_err "<response-code> <producer-id> <type-id>" $@
 379                 return 1
 380         fi
 381
 382     curlString="curl -X PUT -skw %{http_code} $PROD_STUB_PATH/arm/type/$2/$3"
 383
 384     __execute_curl_to_prodstub CONF $1 "$curlString"
 385     return $?
 386 }
 387
 388 # Prodstub API: Disarm a type in a producer
 389 # <response-code> <producer-id> <type-id>
 390 # (Function for test scripts)
 391 prodstub_disarm_type() {
 392         __log_conf_start $@
 393         if [ $# -ne 3 ]; then
 394                 __print_err "<response-code> <producer-id> <type-id>" $@
 395                 return 1
 396         fi
 397
 398     curlString="curl -X DELETE -skw %{http_code} $PROD_STUB_PATH/arm/type/$2/$3"
 399
 400     __execute_curl_to_prodstub CONF $1 "$curlString"
 401     return $?
 402 }
 403
 404 # Prodstub API: Get job data for a job and compare with a target job json
 405 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
 406 # (Function for test scripts)
 407 prodstub_check_jobdata() {
 408         __log_test_start $@
 409         if [ $# -ne 7 ]; then
 410                 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
 411                 return 1
 412         fi
 413     if [ -f $7 ]; then
 414         jobfile=$(cat $7)
 415         jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
 416     else
 417         _log_test_fail_general "Template file "$7" for jobdata, does not exist"
 418         return 1
 419     fi
 420     targetJson="{\"ei_job_identity\":\"$3\",\"ei_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"ei_job_data\":$jobfile}"
 421     file="./tmp/.p.json"
 422         echo "$targetJson" > $file
 423
 424     curlString="curl -X GET -skw %{http_code} $PROD_STUB_PATH/jobdata/$2/$3"
 425
 426     __execute_curl_to_prodstub TEST $1 "$curlString" $file
 427     return $?
 428 }
 429
 430 # Prodstub API: Get job data for a job and compare with a target job json
 431 # <response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>
 432 # (Function for test scripts)
 433 prodstub_check_jobdata_2() {
 434         __log_test_start $@
 435         if [ $# -ne 7 ]; then
 436                 __print_err "<response-code> <producer-id> <job-id> <type-id> <target-url> <job-owner> <template-job-file>" $@
 437                 return 1
 438         fi
 439     if [ -f $7 ]; then
 440         jobfile=$(cat $7)
 441         jobfile=$(echo "$jobfile" | sed "s/XXXX/$3/g")
 442     else
 443         _log_test_fail_general "Template file "$7" for jobdata, does not exist"
 444         return 1
 445     fi
 446     targetJson="{\"ei_job_identity\":\"$3\",\"ei_type_identity\":\"$4\",\"target_uri\":\"$5\",\"owner\":\"$6\", \"ei_job_data\":$jobfile,\"last_updated\":\"????\"}"
 447     file="./tmp/.p.json"
 448         echo "$targetJson" > $file
 449
 450     curlString="curl -X GET -skw %{http_code} $PROD_STUB_PATH/jobdata/$2/$3"
 451
 452     __execute_curl_to_prodstub TEST $1 "$curlString" $file
 453     return $?
 454 }
 455
 456 # Prodstub API: Delete the job data
 457 # <response-code> <producer-id> <job-id>
 458 # (Function for test scripts)
 459 prodstub_delete_jobdata() {
 460         __log_conf_start
 461         if [ $# -ne 3 ]; then
 462                 __print_err "<response-code> <producer-id> <job-id> " $@
 463                 return 1
 464         fi
 465     curlString="curl -X DELETE -skw %{http_code} $PROD_STUB_PATH/jobdata/$2/$3"
 466
 467     __execute_curl_to_prodstub CONF $1 "$curlString"
 468     return $?
 469 }
 470
 471 # Tests if a variable value in the prod stub is equal to a target value and and optional timeout.
 472 # Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
 473 # equal to the target or not.
 474 # Arg: <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
 475 # before setting pass or fail depending on if the variable value becomes equal to the target
 476 # value or not.
 477 # (Function for test scripts)
 478 prodstub_equal() {
 479         if [ $# -eq 2 ] || [ $# -eq 3 ]; then
 480                 __var_test "PRODSTUB" "$PROD_STUB_PATH/counter/" $1 "=" $2 $3
 481         else
 482                 __print_err "Wrong args to prodstub_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
 483         fi
 484 }