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