test/common/http_proxy_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 managemnt functions for Http Proxy
  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 __HTTPPROXY_imagesetup() {
  28         __check_and_create_image_var HTTPPROXY "HTTP_PROXY_IMAGE" "HTTP_PROXY_IMAGE_BASE" "HTTP_PROXY_IMAGE_TAG" LOCAL "$HTTP_PROXY_DISPLAY_NAME"
  29 }
  30
  31 # Pull image from remote repo or use locally built image
  32 # arg: <pull-policy-override> <pull-policy-original>
  33 # <pull-policy-override> Shall be used for images allowing overriding. For example use a local image when test is started to use released images
  34 # <pull-policy-original> Shall be used for images that does not allow overriding
  35 # Both var may contain: 'remote', 'remote-remove' or 'local'
  36 __HTTPPROXY_imagepull() {
  37         __check_and_pull_image $2 "$HTTP_PROXY_DISPLAY_NAME" $HTTP_PROXY_APP_NAME HTTP_PROXY_IMAGE
  38 }
  39
  40 # Build image (only for simulator or interfaces stubs owned by the test environment)
  41 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
  42 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
  43 __HTTPPROXY_imagebuild() {
  44         cd ../$HTTP_PROXY_BUILD_DIR       # Note: Reusing same impl as for kube proxy
  45         echo " Building HTTPPROXY - $HTTP_PROXY_DISPLAY_NAME - image: $HTTP_PROXY_IMAGE"
  46         docker build  --build-arg NEXUS_PROXY_REPO=$NEXUS_PROXY_REPO -t $HTTP_PROXY_IMAGE . &> .dockererr
  47         if [ $? -eq 0 ]; then
  48                 echo -e  $GREEN"  Build Ok"$EGREEN
  49                 __retag_and_push_image HTTP_PROXY_IMAGE
  50                 if [ $? -ne 0 ]; then
  51                         exit 1
  52                 fi
  53         else
  54                 echo -e $RED"  Build Failed"$ERED
  55                 ((RES_CONF_FAIL++))
  56                 cat .dockererr
  57                 echo -e $RED"Exiting...."$ERED
  58                 exit 1
  59         fi
  60 }
  61
  62 # Generate a string for each included image using the app display name and a docker images format string
  63 # If a custom image repo is used then also the source image from the local repo is listed
  64 # arg: <docker-images-format-string> <file-to-append>
  65 __HTTPPROXY_image_data() {
  66         echo -e "$HTTP_PROXY_DISPLAY_NAME\t$(docker images --format $1 $HTTP_PROXY_IMAGE)" >>   $2
  67         if [ ! -z "$HTTP_PROXY_IMAGE_SOURCE" ]; then
  68                 echo -e "-- source image --\t$(docker images --format $1 $HTTP_PROXY_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 __HTTPPROXY_kube_scale_zero() {
  76         __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest HTTPPROXY
  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 __HTTPPROXY_kube_scale_zero_and_wait() {
  82         echo -e $RED" HTTPPROXY replicas kept as is"$ERED
  83 }
  84
  85 # Delete all kube resouces for the app
  86 # This function is called for apps managed by the test script.
  87 __HTTPPROXY_kube_delete_all() {
  88         __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest HTTPPROXY
  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 __HTTPPROXY_store_docker_logs() {
  95         docker logs $HTTP_PROXY_APP_NAME > $1$2_httpproxy.log 2>&1
  96 }
  97
  98 #######################################################
  99
 100
 101 ## Access to Http Proxy Receiver
 102 # Host name may be changed if app started by kube
 103 # Direct access from script
 104 HTTP_PROXY_HTTPX="http"
 105 HTTP_PROXY_HOST_NAME=$LOCALHOST_NAME
 106 HTTP_PROXY_PATH=$HTTP_PROXY_HTTPX"://"$HTTP_PROXY_HOST_NAME":"$HTTP_PROXY_WEB_EXTERNAL_PORT
 107
 108 #########################
 109 ### Http Proxy functions
 110 #########################
 111
 112 # All calls to httpproxy will be directed to the http interface
 113 # args: -
 114 # (Function for test scripts)
 115 use_http_proxy_http() {
 116         echo -e $BOLD"$HTTP_PROXY_DISPLAY_NAME protocol setting"$EBOLD
 117         echo -e " Using $BOLD http $EBOLD"
 118         HTTP_PROXY_HTTPX="http"
 119         HTTP_PROXY_PATH=$HTTP_PROXY_HTTPX"://"$HTTP_PROXY_HOST_NAME":"$HTTP_PROXY_EXTERNAL_PORT
 120
 121         echo ""
 122 }
 123
 124 # All calls to httpproxy will be directed to the https interface
 125 # args: -
 126 # (Function for test scripts)
 127 use_http_proxy_https() {
 128         echo -e $BOLD"$HTTP_PROXY_DISPLAY_NAME protocol setting"$EBOLD
 129         echo -e " Using $BOLD https $EBOLD"
 130         HTTP_PROXY_HTTPX="https"
 131         HTTP_PROXY_PATH=$HTTP_PROXY_HTTPX"://"$HTTP_PROXY_HOST_NAME":"$HTTP_PROXY_EXTERNAL_SECURE_PORT
 132
 133         echo ""
 134 }
 135
 136 # Start the Http Proxy in the simulator group
 137 # args: -
 138 # (Function for test scripts)
 139 start_http_proxy() {
 140
 141         echo -e $BOLD"Starting $HTTP_PROXY_DISPLAY_NAME"$EBOLD
 142
 143         if [ $RUNMODE == "KUBE" ]; then
 144
 145                 # Check if app shall be fully managed by the test script
 146                 __check_included_image "HTTPPROXY"
 147                 retcode_i=$?
 148
 149                 # Check if app shall only be used by the testscipt
 150                 __check_prestarted_image "HTTPPROXY"
 151                 retcode_p=$?
 152
 153                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
 154                         echo -e $RED"The $HTTP_PROXY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
 155                         echo -e $RED"The $HTTP_PROXY_APP_NAME will not be started"$ERED
 156                         exit
 157                 fi
 158                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
 159                         echo -e $RED"The $HTTP_PROXY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
 160                         echo -e $RED"The $HTTP_PROXY_APP_NAME will not be started"$ERED
 161                         exit
 162                 fi
 163
 164                 # Check if app shall be used - not managed - by the test script
 165                 if [ $retcode_p -eq 0 ]; then
 166                         echo -e " Using existing $HTTP_PROXY_APP_NAME deployment and service"
 167                         echo " Setting HTTPPROXY replicas=1"
 168                         __kube_scale deployment $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE 1
 169                 fi
 170
 171                 if [ $retcode_i -eq 0 ]; then
 172                         echo -e " Creating $HTTP_PROXY_APP_NAME deployment and service"
 173                         export HTTP_PROXY_APP_NAME
 174
 175                         export HTTP_PROXY_WEB_EXTERNAL_PORT
 176                         export HTTP_PROXY_WEB_INTERNAL_PORT
 177                         export HTTP_PROXY_EXTERNAL_PORT
 178                         export HTTP_PROXY_INTERNAL_PORT
 179
 180                         export HTTP_PROXY_WEB_EXTERNAL_SECURE_PORT
 181                         export HTTP_PROXY_WEB_INTERNAL_SECURE_PORT
 182                         export HTTP_PROXY_EXTERNAL_SECURE_PORT
 183                         export HTTP_PROXY_INTERNAL_SECURE_PORT
 184
 185                         export KUBE_SIM_NAMESPACE
 186                         export HTTP_PROXY_IMAGE
 187
 188                         __kube_create_namespace $KUBE_SIM_NAMESPACE
 189
 190                         # Create service
 191                         input_yaml=$SIM_GROUP"/"$HTTP_PROXY_COMPOSE_DIR"/"svc.yaml
 192                         output_yaml=$PWD/tmp/proxy_svc.yaml
 193                         __kube_create_instance service $HTTP_PROXY_APP_NAME $input_yaml $output_yaml
 194
 195                         # Create app
 196                         input_yaml=$SIM_GROUP"/"$HTTP_PROXY_COMPOSE_DIR"/"app.yaml
 197                         output_yaml=$PWD/tmp/proxy_app.yaml
 198                         __kube_create_instance app $HTTP_PROXY_APP_NAME $input_yaml $output_yaml
 199
 200                 fi
 201
 202                 echo " Retrieving host and ports for service..."
 203                 HTTP_PROXY_HOST_NAME=$(__kube_get_service_host $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE)
 204                 HTTP_PROXY_WEB_EXTERNAL_PORT=$(__kube_get_service_port $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web")
 205                 HTTP_PROXY_WEB_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "webs")
 206
 207                 HTTP_PROXY_EXTERNAL_PORT=$(__kube_get_service_port $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")
 208                 HTTP_PROXY_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "https")
 209
 210                 if [ $HTTP_PROXY_HTTPX == "http" ]; then
 211                         HTTP_PROXY_PATH=$HTTP_PROXY_HTTPX"://"$HTTP_PROXY_HOST_NAME":"$HTTP_PROXY_WEB_EXTERNAL_PORT
 212                         HTTP_PROXY_CONFIG_PORT=$HTTP_PROXY_EXTERNAL_PORT
 213                         HTTP_PROXY_CONFIG_HOST_NAME=$HTTP_PROXY_APP_NAME"."$KUBE_SIM_NAMESPACE
 214
 215                         echo " Host IP, http port: $HTTP_PROXY_HOST_NAME $HTTP_PROXY_WEB_EXTERNAL_PORT"
 216                 else
 217                         HTTP_PROXY_PATH=$HTTP_PROXY_HTTPX"://"$HTTP_PROXY_HOST_NAME":"$HTTP_PROXY_WEB_EXTERNAL_SECURE_PORT
 218                         HTTP_PROXY_CONFIG_PORT=$HTTP_PROXY_EXTERNAL_SECURE_PORT
 219                         HTTP_PROXY_CONFIG_HOST_NAME=$HTTP_PROXY_APP_NAME"."$KUBE_SIM_NAMESPACE
 220
 221                         echo " Host IP, https port: $HTTP_PROXY_HOST_NAME $HTTP_PROXY_WEB_EXTERNAL_SECURE_PORT"
 222                 fi
 223
 224                 __check_service_start $HTTP_PROXY_APP_NAME $HTTP_PROXY_PATH$HTTP_PROXY_ALIVE_URL
 225
 226         else
 227                 # Check if docker app shall be fully managed by the test script
 228                 __check_included_image 'HTTPPROXY'
 229                 if [ $? -eq 1 ]; then
 230                         echo -e $RED"The Http Proxy app is not included in this test script"$ERED
 231                         echo -e $RED"The Http Proxy will not be started"$ERED
 232                         exit
 233                 fi
 234
 235                 export HTTP_PROXY_APP_NAME
 236                 export HTTP_PROXY_EXTERNAL_PORT
 237                 export HTTP_PROXY_INTERNAL_PORT
 238                 export HTTP_PROXY_EXTERNAL_SECURE_PORT
 239                 export HTTP_PROXY_INTERNAL_SECURE_PORT
 240                 export HTTP_PROXY_WEB_EXTERNAL_PORT
 241                 export HTTP_PROXY_WEB_INTERNAL_PORT
 242                 export HTTP_PROXY_WEB_EXTERNAL_SECURE_PORT
 243                 export HTTP_PROXY_WEB_INTERNAL_SECURE_PORT
 244                 export DOCKER_SIM_NWNAME
 245
 246                 export HTTP_PROXY_DISPLAY_NAME
 247
 248                 __start_container $HTTP_PROXY_COMPOSE_DIR "" NODOCKERARGS 1 $HTTP_PROXY_APP_NAME
 249
 250                 if [ $HTTP_PROXY_HTTPX == "http" ]; then
 251                         HTTP_PROXY_PATH=$HTTP_PROXY_HTTPX"://"$HTTP_PROXY_HOST_NAME":"$HTTP_PROXY_EXTERNAL_PORT
 252                 else
 253                         HTTP_PROXY_PATH=$HTTP_PROXY_HTTPX"://"$HTTP_PROXY_HOST_NAME":"$HTTP_PROXY_EXTERNAL_SECURE_PORT
 254                 fi
 255         __check_service_start $HTTP_PROXY_APP_NAME $HTTP_PROXY_PATH$HTTP_PROXY_ALIVE_URL
 256
 257                 if [ $HTTP_PROXY_HTTPX == "http" ]; then
 258                         HTTP_PROXY_CONFIG_PORT=$HTTP_PROXY_INTERNAL_PORT
 259                 else
 260                         HTTP_PROXY_CONFIG_PORT=$HTTP_PROXY_INTERNAL_SECURE_PORT
 261                 fi
 262                 HTTP_PROXY_CONFIG_HOST_NAME=$HTTP_PROXY_APP_NAME
 263
 264         fi
 265         echo ""
 266 }
 267