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 ### Http Proxy functions
  88 #########################
  89
  90 # Start the Kube Http Proxy in the simulator group
  91 # args: -
  92 # (Function for test scripts)
  93 start_kube_proxy() {
  94
  95         echo -e $BOLD"Starting $KUBE_PROXY_DISPLAY_NAME"$EBOLD
  96
  97         if [ $RUNMODE == "KUBE" ]; then
  98
  99                 # Check if app shall be fully managed by the test script
 100                 __check_included_image "KUBEPROXY"
 101                 retcode_i=$?
 102
 103                 # Check if app shall only be used by the testscipt
 104                 __check_prestarted_image "KUBEPROXY"
 105                 retcode_p=$?
 106
 107                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
 108                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
 109                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 110                         exit
 111                 fi
 112                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
 113                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
 114                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 115                         exit
 116                 fi
 117
 118                 # Check if app shall be used - not managed - by the test script
 119                 if [ $retcode_p -eq 0 ]; then
 120                         echo -e " Using existing $KUBE_PROXY_APP_NAME deployment and service"
 121                         echo " Setting KUBEPROXY replicas=1"
 122                         __kube_scale deployment $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE 1
 123                 fi
 124
 125                 if [ $retcode_i -eq 0 ]; then
 126                         echo -e " Creating $KUBE_PROXY_APP_NAME deployment and service"
 127                         export KUBE_PROXY_APP_NAME
 128                         export KUBE_PROXY_WEB_EXTERNAL_PORT
 129                         export KUBE_PROXY_WEB_INTERNAL_PORT
 130                         export KUBE_PROXY_EXTERNAL_PORT
 131                         export KUBE_PROXY_INTERNAL_PORT
 132                         export KUBE_SIM_NAMESPACE
 133                         export KUBE_PROXY_IMAGE
 134
 135                         __kube_create_namespace $KUBE_SIM_NAMESPACE
 136
 137                         # Create service
 138                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"svc.yaml
 139                         output_yaml=$PWD/tmp/proxy_svc.yaml
 140                         __kube_create_instance service $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 141
 142                         # Create app
 143                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"app.yaml
 144                         output_yaml=$PWD/tmp/proxy_app.yaml
 145                         __kube_create_instance app $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 146
 147                 fi
 148
 149                 echo " Retrieving host and ports for service..."
 150
 151                 CLUSTER_KUBE_PROXY="http"
 152
 153                 #Finding host of the proxy
 154                 echo "  Trying to find svc hostname..."
 155                 CLUSTER_KUBE_PROXY_HOST=$(__kube_cmd_with_timeout "kubectl get svc $KUBE_PROXY_APP_NAME -n $KUBE_SIM_NAMESPACE  -o jsonpath={.status.loadBalancer.ingress[0].hostname}")
 156
 157
 158                 if [ "$CLUSTER_KUBE_PROXY_HOST" == "localhost" ]; then
 159                         #Local host found
 160                         echo -e $YELLOW" The test environment svc $KUBE_PROXY_APP_NAME 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"$EYELLOW
 161                         CLUSTER_KUBE_PROXY_HOST="127.0.0.1"
 162                 else
 163                         if [ -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
 164                                 #Host of proxy not found, trying to find the ip....
 165                                 echo "  Trying to find svc ip..."
 166                                 CLUSTER_KUBE_PROXY_HOST=$(__kube_cmd_with_timeout "kubectl get svc $KUBE_PROXY_APP_NAME -n $KUBE_SIM_NAMESPACE  -o jsonpath={.status.loadBalancer.ingress[0].ip}")
 167                                 if [ ! -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
 168                                         #Host ip found
 169                                         echo -e $YELLOW" The test environment svc $KUBE_PROXY_APP_NAME ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
 170                                 fi
 171                         else
 172                                 #Host or ip of proxy found
 173                                 echo -e $YELLOW" The test environment host/ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
 174                         fi
 175                 fi
 176                 if [ -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
 177                         #Host/ip of proxy not found, try to use the cluster and the nodeports of the proxy
 178                         CLUSTER_KUBE_PROXY_HOST=$(kubectl config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
 179                         echo -e $YELLOW" The test environment cluster ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
 180                         CLUSTER_KUBE_PROXY_PORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")  # port for proxy access
 181                         KUBE_PROXY_WEB_NODEPORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web")  # web port, only for alive test
 182                         echo " Cluster ip/host, cluster http nodeport, cluster web nodeport: $CLUSTER_KUBE_PROXY_HOST $CLUSTER_KUBE_PROXY_PORT $KUBE_PROXY_WEB_NODEPORT"
 183                 else
 184                         #Find the service ports of the proxy
 185                         CLUSTER_KUBE_PROXY_PORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")  # port for proxy access
 186                         KUBE_PROXY_WEB_NODEPORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web")  # web port, only for alive test
 187                         echo " Proxy ip/host, proxy http port, proxy web port: $CLUSTER_KUBE_PROXY_HOST $CLUSTER_KUBE_PROXY_PORT $KUBE_PROXY_WEB_NODEPORT"
 188                 fi
 189
 190                 KUBE_PROXY_WEB_PATH=$CLUSTER_KUBE_PROXY"://"$CLUSTER_KUBE_PROXY_HOST":"$KUBE_PROXY_WEB_NODEPORT
 191
 192                 export KUBE_PROXY_PATH=  # Make sure proxy is empty when checking the proxy itself
 193                 __check_service_start $KUBE_PROXY_APP_NAME $KUBE_PROXY_WEB_PATH$KUBE_PROXY_ALIVE_URL
 194
 195                 # Set proxy for all subsequent calls for all services etc
 196                 export KUBE_PROXY_PATH=$CLUSTER_KUBE_PROXY"://"$CLUSTER_KUBE_PROXY_HOST":"$CLUSTER_KUBE_PROXY_PORT
 197
 198         else
 199                 echo $YELLOW" Kube http proxy not needed in docker test. App not started"
 200         fi
 201         echo ""
 202
 203 }
 204