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 # 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 __KUBEPROXY_image_data() {
  52         echo -e "$KUBE_PROXY_DISPLAY_NAME\t$(docker images --format $1 $KUBE_PROXY_IMAGE)" >>   $2
  53         if [ ! -z "$KUBE_PROXY_IMAGE_SOURCE" ]; then
  54                 echo -e "-- source image --\t$(docker images --format $1 $KUBE_PROXY_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 __KUBEPROXY_kube_scale_zero() {
  62         __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest KUBEPROXY
  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 __KUBEPROXY_kube_scale_zero_and_wait() {
  68         echo -e $RED" Http proxy replicas kept as is"$ERED
  69 }
  70
  71 # Delete all kube resouces for the app
  72 # This function is called for apps managed by the test script.
  73 __KUBEPROXY_kube_delete_all() {
  74         __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest KUBEPROXY
  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 __KUBEPROXY_store_docker_logs() {
  81         docker logs $KUBE_PROXY_APP_NAME > $1$2_kubeproxy.log 2>&1
  82 }
  83
  84 #######################################################
  85
  86
  87 ## Access to Kube Http Proxy
  88 # Host name may be changed if app started by kube
  89 # Direct access from script
  90 #BMXX  KUBE_PROXY_HTTPX="http"
  91 #BMXX KUBE_PROXY_HOST_NAME=$LOCALHOST_NAME
  92 #BMXX KUBE_PROXY_PATH=$KUBE_PROXY_HTTPX"://"$KUBE_PROXY_HOST_NAME":"$KUBE_PROXY_WEB_EXTERNAL_PORT
  93
  94 #########################
  95 ### Http Proxy functions
  96 #########################
  97
  98 # Start the Kube Http Proxy in the simulator group
  99 # args: -
 100 # (Function for test scripts)
 101 start_kube_proxy() {
 102
 103         echo -e $BOLD"Starting $KUBE_PROXY_DISPLAY_NAME"$EBOLD
 104
 105         if [ $RUNMODE == "KUBE" ]; then
 106
 107                 # Check if app shall be fully managed by the test script
 108                 __check_included_image "KUBEPROXY"
 109                 retcode_i=$?
 110
 111                 # Check if app shall only be used by the testscipt
 112                 __check_prestarted_image "KUBEPROXY"
 113                 retcode_p=$?
 114
 115                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
 116                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
 117                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 118                         exit
 119                 fi
 120                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
 121                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
 122                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 123                         exit
 124                 fi
 125
 126                 # Check if app shall be used - not managed - by the test script
 127                 if [ $retcode_p -eq 0 ]; then
 128                         echo -e " Using existing $KUBE_PROXY_APP_NAME deployment and service"
 129                         echo " Setting KUBEPROXY replicas=1"
 130                         __kube_scale deployment $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE 1
 131                 fi
 132
 133                 if [ $retcode_i -eq 0 ]; then
 134                         echo -e " Creating $KUBE_PROXY_APP_NAME deployment and service"
 135                         export KUBE_PROXY_APP_NAME
 136                         export KUBE_PROXY_WEB_EXTERNAL_PORT
 137                         export KUBE_PROXY_WEB_INTERNAL_PORT
 138                         export KUBE_PROXY_EXTERNAL_PORT
 139                         export KUBE_PROXY_INTERNAL_PORT
 140                         export KUBE_SIM_NAMESPACE
 141                         export KUBE_PROXY_IMAGE
 142
 143                         __kube_create_namespace $KUBE_SIM_NAMESPACE
 144
 145                         # Create service
 146                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"svc.yaml
 147                         output_yaml=$PWD/tmp/proxy_svc.yaml
 148                         __kube_create_instance service $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 149
 150                         # Create app
 151                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"app.yaml
 152                         output_yaml=$PWD/tmp/proxy_app.yaml
 153                         __kube_create_instance app $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 154
 155                 fi
 156
 157                 echo " Retrieving host and ports for service..."
 158
 159                 CLUSTER_KUBE_PROXY="http"
 160                 CLUSTER_KUBE_PROXY_HOST=$(kubectl config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
 161                 if [[ $CLUSTER_KUBE_PROXY_HOST == *"kubernetes"* ]]; then
 162                         echo -e $YELLOW" The cluster host is: $CLUSTER_KUBE_PROXY_HOST. The proxy (mitmproxy) used by test script requires an ip so the ip is assumed and set to 127.0.0.1"
 163                         CLUSTER_KUBE_PROXY_HOST="127.0.0.1"
 164                 fi
 165                 CLUSTER_KUBE_PROXY_NODEPORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")  # port for proxy access
 166                 KUBE_PROXY_WEB_NODEPORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web")  # web port, only for alive test
 167
 168                 KUBE_PROXY_WEB_PATH=$CLUSTER_KUBE_PROXY"://"$CLUSTER_KUBE_PROXY_HOST":"$KUBE_PROXY_WEB_NODEPORT
 169
 170                 echo " Cluster ip/host, cluster http nodeport cluster web nodeport: $CLUSTER_KUBE_PROXY_HOST $CLUSTER_KUBE_PROXY_NODEPORT $KUBE_PROXY_WEB_NODEPORT"
 171
 172                 export KUBE_PROXY_PATH=  # Make sure proxy is empty when checking the proxy itself
 173                 __check_service_start $KUBE_PROXY_APP_NAME $KUBE_PROXY_WEB_PATH$KUBE_PROXY_ALIVE_URL
 174
 175                 # Set proxy for all subsequent calls for all services etc
 176                 export KUBE_PROXY_PATH=$CLUSTER_KUBE_PROXY"://"$CLUSTER_KUBE_PROXY_HOST":"$CLUSTER_KUBE_PROXY_NODEPORT
 177
 178         else
 179                 echo $YELLOW" Kube http proxy not needed in docker test. App not started"
 180         fi
 181         echo ""
 182 }
 183