test/common/kube_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 Kube Http Proxy
  21 # This http proxy is to provide full access for the test script to all adressable kube object in a clister
  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 __KUBEPROXY_imagesetup() {
  29         __check_and_create_image_var KUBEPROXY "KUBE_PROXY_IMAGE" "KUBE_PROXY_IMAGE_BASE" "KUBE_PROXY_IMAGE_TAG" REMOTE_PROXY "$KUBE_PROXY_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 __KUBEPROXY_imagepull() {
  38         __check_and_pull_image $2 "$KUBE_PROXY_DISPLAY_NAME" $KUBE_PROXY_APP_NAME $KUBE_PROXY_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 __KUBEPROXY_imagebuild() {
  45         echo -e $RED"Image for app KUBEPROXY 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 __KUBEPROXY_image_data() {
  51         echo -e "$KUBE_PROXY_DISPLAY_NAME\t$(docker images --format $1 $KUBE_PROXY_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 __KUBEPROXY_kube_scale_zero() {
  58         __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest KUBEPROXY
  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 __KUBEPROXY_kube_scale_zero_and_wait() {
  64         echo -e $RED" Http proxy replicas kept as is"$ERED
  65 }
  66
  67 # Delete all kube resouces for the app
  68 # This function is called for apps managed by the test script.
  69 __KUBEPROXY_kube_delete_all() {
  70         __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest KUBEPROXY
  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 __KUBEPROXY_store_docker_logs() {
  77         docker logs $KUBE_PROXY_APP_NAME > $1$2_kubeproxy.log 2>&1
  78 }
  79
  80 #######################################################
  81
  82
  83 ## Access to Kube Http Proxy
  84 # Host name may be changed if app started by kube
  85 # Direct access from script
  86 KUBE_PROXY_HTTPX="http"
  87 KUBE_PROXY_HOST_NAME=$LOCALHOST_NAME
  88 KUBE_PROXY_PATH=$KUBE_PROXY_HTTPX"://"$KUBE_PROXY_HOST_NAME":"$KUBE_PROXY_WEB_EXTERNAL_PORT
  89
  90 #########################
  91 ### Http Proxy functions
  92 #########################
  93
  94 # Start the Kube Http Proxy in the simulator group
  95 # args: -
  96 # (Function for test scripts)
  97 start_kube_proxy() {
  98
  99         echo -e $BOLD"Starting $KUBE_PROXY_DISPLAY_NAME"$EBOLD
 100
 101         if [ $RUNMODE == "KUBE" ]; then
 102
 103                 # Check if app shall be fully managed by the test script
 104                 __check_included_image "KUBEPROXY"
 105                 retcode_i=$?
 106
 107                 # Check if app shall only be used by the testscipt
 108                 __check_prestarted_image "KUBEPROXY"
 109                 retcode_p=$?
 110
 111                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
 112                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
 113                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 114                         exit
 115                 fi
 116                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
 117                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
 118                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 119                         exit
 120                 fi
 121
 122                 # Check if app shall be used - not managed - by the test script
 123                 if [ $retcode_p -eq 0 ]; then
 124                         echo -e " Using existing $KUBE_PROXY_APP_NAME deployment and service"
 125                         echo " Setting KUBEPROXY replicas=1"
 126                         __kube_scale deployment $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE 1
 127                 fi
 128
 129                 if [ $retcode_i -eq 0 ]; then
 130                         echo -e " Creating $KUBE_PROXY_APP_NAME deployment and service"
 131                         export KUBE_PROXY_APP_NAME
 132                         export KUBE_PROXY_WEB_EXTERNAL_PORT
 133                         export KUBE_PROXY_WEB_INTERNAL_PORT
 134                         export KUBE_PROXY_EXTERNAL_PORT
 135                         export KUBE_PROXY_INTERNAL_PORT
 136                         export KUBE_SIM_NAMESPACE
 137                         export KUBE_PROXY_IMAGE
 138
 139                         __kube_create_namespace $KUBE_SIM_NAMESPACE
 140
 141                         # Create service
 142                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"svc.yaml
 143                         output_yaml=$PWD/tmp/proxy_svc.yaml
 144                         __kube_create_instance service $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 145
 146                         # Create app
 147                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"app.yaml
 148                         output_yaml=$PWD/tmp/proxy_app.yaml
 149                         __kube_create_instance app $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 150
 151                 fi
 152
 153                 echo " Retrieving host and ports for service..."
 154                 KUBE_PROXY_HOST_NAME=$(__kube_get_service_host $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE)
 155                 KUBE_PROXY_WEB_EXTERNAL_PORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web")
 156                 KUBE_PROXY_EXTERNAL_PORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")
 157
 158
 159                 minikube status > /dev/null
 160                 if [ $? -eq 0 ]; then
 161                         echo -e $GREEN" Running minikube inside a kubernetes cluster. No proxy needed for the test script to access services"$EGREEN
 162                         export CLUSTER_KUBE_PROXY_NODEPORT=""
 163                 else
 164                         echo -e $YELLOW" Running outside the kubernetes cluster. Proxy is setup to access services from the test script"$EYELLOW
 165                         export CLUSTER_KUBE_PROXY_NODEPORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")
 166                 fi
 167
 168                 KUBE_PROXY_PATH=$KUBE_PROXY_HTTPX"://"$KUBE_PROXY_HOST_NAME":"$KUBE_PROXY_WEB_EXTERNAL_PORT
 169                 KUBE_PROXY_CONFIG_PORT=$KUBE_PROXY_EXTERNAL_PORT
 170                 KUBE_PROXY_CONFIG_HOST_NAME=$KUBE_PROXY_APP_NAME"."$KUBE_SIM_NAMESPACE
 171
 172                 echo " Host IP, http port, cluster http nodeport (may be empty): $KUBE_PROXY_HOST_NAME $KUBE_PROXY_WEB_EXTERNAL_PORT $CLUSTER_KUBE_PROXY_NODEPORT"
 173
 174                 __check_service_start $KUBE_PROXY_APP_NAME $KUBE_PROXY_PATH$KUBE_PROXY_ALIVE_URL
 175
 176         else
 177                 echo $YELLOW" Kube http proxy not needed in docker test. App not started"
 178         fi
 179         echo ""
 180 }
 181