test/common/control_panel_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 function
  21 # and test functions for Control Panel
  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 __CP_imagesetup() {
  29         __check_and_create_image_var CP "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_IMAGE_BASE" "CONTROL_PANEL_IMAGE_TAG" $1 "$CONTROL_PANEL_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 __CP_imagepull() {
  38         __check_and_pull_image $1 "$CONTROL_PANEL_DISPLAY_NAME" $CONTROL_PANEL_APP_NAME CONTROL_PANEL_IMAGE
  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 __CP_imagebuild() {
  45         echo -e $RED" Image for app CP shall never be built"$ERED
  46 }
  47
  48 # Generate a string for each included image using the app display name and a docker images format string
  49 # If a custom image repo is used then also the source image from the local repo is listed
  50 # arg: <docker-images-format-string> <file-to-append>
  51 __CP_image_data() {
  52         echo -e "$CONTROL_PANEL_DISPLAY_NAME\t$(docker images --format $1 $CONTROL_PANEL_IMAGE)" >>   $2
  53         if [ ! -z "$CONTROL_PANEL_IMAGE_SOURCE" ]; then
  54                 echo -e "-- source image --\t$(docker images --format $1 $CONTROL_PANEL_IMAGE_SOURCE)" >>   $2
  55         fi
  56 }
  57
  58 # Scale kubernetes resources to zero
  59 # All resources shall be ordered to be scaled to 0, if relevant. If not relevant to scale, then do no action.
  60 # This function is called for apps fully managed by the test script
  61 __CP_kube_scale_zero() {
  62         __kube_scale_all_resources $KUBE_NONRTRIC_NAMESPACE autotest CP
  63 }
  64
  65 # Scale kubernetes resources to zero and wait until this has been accomplished, if relevant. If not relevant to scale, then do no action.
  66 # This function is called for prestarted apps not managed by the test script.
  67 __CP_kube_scale_zero_and_wait() {
  68         echo -e " CP replicas kept as is"
  69 }
  70
  71 # Delete all kube resouces for the app
  72 # This function is called for apps managed by the test script.
  73 __CP_kube_delete_all() {
  74         __kube_delete_all_resources $KUBE_NONRTRIC_NAMESPACE autotest CP
  75 }
  76
  77 # Store docker logs
  78 # This function is called for apps managed by the test script.
  79 # args: <log-dir> <file-prexix>
  80 __CP_store_docker_logs() {
  81         docker logs $CONTROL_PANEL_APP_NAME > $1$2_control-panel.log 2>&1
  82 }
  83
  84 #######################################################
  85
  86
  87 ## Access to control panel
  88 # Host name may be changed if app started by kube
  89 # Direct access from script
  90 CP_HTTPX="http"
  91 CP_HOST_NAME=$LOCALHOST_NAME
  92 CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_PORT
  93
  94 ###########################
  95 ### Control Panel functions
  96 ###########################
  97
  98 # Set http as the protocol to use for all communication to the Control Panel
  99 # args: -
 100 # (Function for test scripts)
 101 use_control_panel_http() {
 102         echo -e $BOLD"Control Panel, CP, protocol setting"$EBOLD
 103         echo -e " Using $BOLD http $EBOLD towards CP"
 104         CP_HTTPX="http"
 105         CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_PORT
 106         echo ""
 107 }
 108
 109 # Set https as the protocol to use for all communication to the Control Panel
 110 # args: -
 111 # (Function for test scripts)
 112 use_control_panel_https() {
 113         echo -e $BOLD"Control Panel, CP, protocol setting"$EBOLD
 114         echo -e " Using $BOLD https $EBOLD towards CP"
 115         CP_HTTPX="https"
 116         CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_SECURE_PORT
 117         echo ""
 118 }
 119
 120 # Start the Control Panel container
 121 # args: -
 122 # (Function for test scripts)
 123 start_control_panel() {
 124
 125         echo -e $BOLD"Starting $CONTROL_PANEL_DISPLAY_NAME"$EBOLD
 126
 127         if [ $RUNMODE == "KUBE" ]; then
 128
 129                 # Check if app shall be fully managed by the test script
 130                 __check_included_image "CP"
 131                 retcode_i=$?
 132
 133                 # Check if app shall only be used by the testscipt
 134                 __check_prestarted_image "CP"
 135                 retcode_p=$?
 136
 137                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
 138                         echo -e $RED"The $CONTROL_PANEL_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
 139                         echo -e $RED"The $CONTROL_PANEL_APP_NAME will not be started"$ERED
 140                         exit
 141                 fi
 142                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
 143                         echo -e $RED"The $CONTROL_PANEL_APP_NAME app is included both as managed and prestarted in this test script"$ERED
 144                         echo -e $RED"The $CONTROL_PANEL_APP_NAME will not be started"$ERED
 145                         exit
 146                 fi
 147
 148                 # Check if app shall be used - not managed - by the test script
 149                 __check_prestarted_image "CP"
 150                 if [ $? -eq 0 ]; then
 151                         echo -e " Using existing $CONTROL_PANEL_APP_NAME deployment and service"
 152                         echo " Setting CP replicas=1"
 153                         __kube_scale deployment $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
 154                 fi
 155
 156                 if [ $retcode_i -eq 0 ]; then
 157
 158                         echo -e " Creating $CONTROL_PANEL_APP_NAME app and expose service"
 159
 160                         #Export all vars needed for service and deployment
 161                         export CONTROL_PANEL_APP_NAME
 162                         export KUBE_NONRTRIC_NAMESPACE
 163                         export CONTROL_PANEL_IMAGE
 164                         export CONTROL_PANEL_INTERNAL_PORT
 165                         export CONTROL_PANEL_INTERNAL_SECURE_PORT
 166                         export CONTROL_PANEL_EXTERNAL_PORT
 167                         export CONTROL_PANEL_EXTERNAL_SECURE_PORT
 168                         export CONTROL_PANEL_CONFIG_MOUNT_PATH
 169                         export CONTROL_PANEL_CONFIG_FILE
 170                         export CP_CONFIG_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-config"
 171                         export CP_PROXY_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-proxy"
 172
 173                         export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME.$KUBE_NONRTRIC_NAMESPACE.svc.cluster.local  # suffix needed for nginx name resolution
 174                         export NRT_GATEWAY_EXTERNAL_PORT
 175                         export CONTROL_PANEL_PATH_POLICY_PREFIX
 176                         export CONTROL_PANEL_PATH_ECS_PREFIX
 177                         export CONTROL_PANEL_PATH_ECS_PREFIX2
 178
 179                         export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_KUBE_RESOLVER
 180
 181                         #Check if nonrtric namespace exists, if not create it
 182                         __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
 183
 184                         # Create config map for config
 185                         datafile=$PWD/tmp/$CONTROL_PANEL_CONFIG_FILE
 186                         #Add config to properties file
 187
 188                         #Trick to prevent these two vars to be replace with space in the config file by cmd envsubst
 189                         export upstream='$upstream'
 190                         export uri='$uri'
 191
 192                         envsubst < $1 > $datafile
 193
 194                         output_yaml=$PWD/tmp/cp_cfc.yaml
 195                         __kube_create_configmap $CP_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest CP $datafile $output_yaml
 196
 197                         # Create service
 198                         input_yaml=$SIM_GROUP"/"$CONTROL_PANEL_COMPOSE_DIR"/"svc.yaml
 199                         output_yaml=$PWD/tmp/cp_svc.yaml
 200                         __kube_create_instance service $CONTROL_PANEL_APP_NAME $input_yaml $output_yaml
 201
 202                         # Create app
 203                         input_yaml=$SIM_GROUP"/"$CONTROL_PANEL_COMPOSE_DIR"/"app.yaml
 204                         output_yaml=$PWD/tmp/cp_app.yaml
 205                         __kube_create_instance app $CONTROL_PANEL_APP_NAME $input_yaml $output_yaml
 206
 207                 fi
 208
 209                 echo " Retrieving host and ports for service..."
 210                 CP_HOST_NAME=$(__kube_get_service_host $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE)
 211
 212                 CONTROL_PANEL_EXTERNAL_PORT=$(__kube_get_service_port $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "http")
 213                 CONTROL_PANEL_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "https")
 214
 215                 echo " Host IP, http port, https port: $CP_HOST_NAME $CONTROL_PANEL_EXTERNAL_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT"
 216                 if [ $CP_HTTPX == "http" ]; then
 217                         CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_PORT
 218                 else
 219                         CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_SECURE_PORT
 220                 fi
 221
 222                 __check_service_start $CONTROL_PANEL_APP_NAME $CP_PATH$CONTROL_PANEL_ALIVE_URL
 223         else
 224                 # Check if docker app shall be fully managed by the test script
 225                 __check_included_image 'CP'
 226                 if [ $? -eq 1 ]; then
 227                         echo -e $RED"The Control Panel app is not included in this test script"$ERED
 228                         echo -e $RED"The Control Panel will not be started"$ERED
 229                         exit
 230                 fi
 231
 232                 # Export needed vars for docker compose
 233         export CONTROL_PANEL_APP_NAME
 234         export CONTROL_PANEL_INTERNAL_PORT
 235         export CONTROL_PANEL_EXTERNAL_PORT
 236         export CONTROL_PANEL_INTERNAL_SECURE_PORT
 237         export CONTROL_PANEL_EXTERNAL_SECURE_PORT
 238         export DOCKER_SIM_NWNAME
 239
 240         export CONTROL_PANEL_HOST_MNT_DIR
 241                 export CONTROL_PANEL_CONFIG_FILE
 242                 export CONTROL_PANEL_CONFIG_MOUNT_PATH
 243
 244                 export NRT_GATEWAY_APP_NAME
 245                 export NRT_GATEWAY_EXTERNAL_PORT
 246
 247                 export POLICY_AGENT_EXTERNAL_SECURE_PORT
 248                 export ECS_EXTERNAL_SECURE_PORT
 249                 export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME
 250                 export ECS_DOMAIN_NAME=$ECS_APP_NAME
 251
 252                 export CONTROL_PANEL_HOST_MNT_DIR
 253                 export CONTROL_PANEL_CONFIG_MOUNT_PATH
 254                 export CONTROL_PANEL_CONFIG_FILE
 255                 export CONTROL_PANEL_DISPLAY_NAME
 256                 export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME
 257                 export CONTROL_PANEL_PATH_POLICY_PREFIX
 258                 export CONTROL_PANEL_PATH_ECS_PREFIX
 259                 export CONTROL_PANEL_PATH_ECS_PREFIX2
 260
 261                 export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_DOCKER_RESOLVER
 262
 263                 dest_file=$SIM_GROUP/$CONTROL_PANEL_COMPOSE_DIR/$CONTROL_PANEL_HOST_MNT_DIR/$CONTROL_PANEL_CONFIG_FILE
 264
 265                 envsubst '${NGW_DOMAIN_NAME},${CP_NGINX_RESOLVER},${NRT_GATEWAY_EXTERNAL_PORT},${POLICY_AGENT_EXTERNAL_SECURE_PORT},${ECS_EXTERNAL_SECURE_PORT},${POLICY_AGENT_DOMAIN_NAME},${ECS_DOMAIN_NAME},${CONTROL_PANEL_PATH_POLICY_PREFIX},${CONTROL_PANEL_PATH_ECS_PREFIX},${CONTROL_PANEL_PATH_ECS_PREFIX2}' < $1 > $dest_file
 266
 267                 __start_container $CONTROL_PANEL_COMPOSE_DIR "" NODOCKERARGS 1 $CONTROL_PANEL_APP_NAME
 268
 269                 __check_service_start $CONTROL_PANEL_APP_NAME $CP_PATH$CONTROL_PANEL_ALIVE_URL
 270         fi
 271         echo ""
 272 }