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" LOCAL "$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         echo -e $RED"Image for app KUBEPROXY shall never be pulled from remote repo"$ERED
  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         cd ../http-https-proxy
  46         echo " Building KUBEPROXY - $KUBE_PROXY_DISPLAY_NAME - image: $KUBE_PROXY_IMAGE"
  47         docker build  --build-arg NEXUS_PROXY_REPO=$NEXUS_PROXY_REPO -t $KUBE_PROXY_IMAGE . &> .dockererr
  48         if [ $? -eq 0 ]; then
  49                 echo -e  $GREEN"  Build Ok"$EGREEN
  50                 __retag_and_push_image KUBE_PROXY_IMAGE
  51                 if [ $? -ne 0 ]; then
  52                         exit 1
  53                 fi
  54         else
  55                 echo -e $RED"  Build Failed"$ERED
  56                 ((RES_CONF_FAIL++))
  57                 cat .dockererr
  58                 echo -e $RED"Exiting...."$ERED
  59                 exit 1
  60         fi
  61 }
  62
  63 # Generate a string for each included image using the app display name and a docker images format string
  64 # If a custom image repo is used then also the source image from the local repo is listed
  65 # arg: <docker-images-format-string> <file-to-append>
  66 __KUBEPROXY_image_data() {
  67         echo -e "$KUBE_PROXY_DISPLAY_NAME\t$(docker images --format $1 $KUBE_PROXY_IMAGE)" >>   $2
  68         if [ ! -z "$KUBE_PROXY_IMAGE_SOURCE" ]; then
  69                 echo -e "-- source image --\t$(docker images --format $1 $KUBE_PROXY_IMAGE_SOURCE)" >>   $2
  70         fi
  71 }
  72
  73 # Scale kubernetes resources to zero
  74 # All resources shall be ordered to be scaled to 0, if relevant. If not relevant to scale, then do no action.
  75 # This function is called for apps fully managed by the test script
  76 __KUBEPROXY_kube_scale_zero() {
  77         __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest KUBEPROXY
  78 }
  79
  80 # Scale kubernetes resources to zero and wait until this has been accomplished, if relevant. If not relevant to scale, then do no action.
  81 # This function is called for prestarted apps not managed by the test script.
  82 __KUBEPROXY_kube_scale_zero_and_wait() {
  83         echo -e $RED" KUBEPROXY app is not scaled in this state"$ERED
  84 }
  85
  86 # Delete all kube resouces for the app
  87 # This function is called for apps managed by the test script.
  88 __KUBEPROXY_kube_delete_all() {
  89         __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest KUBEPROXY
  90 }
  91
  92 # Store docker logs
  93 # This function is called for apps managed by the test script.
  94 # args: <log-dir> <file-prexix>
  95 __KUBEPROXY_store_docker_logs() {
  96         docker logs $KUBE_PROXY_APP_NAME > $1$2_kubeproxy.log 2>&1
  97 }
  98
  99 #######################################################
 100
 101 #########################
 102 ### Http Proxy functions
 103 #########################
 104
 105 # Start the Kube Http Proxy in the simulator group
 106 # args: -
 107 # (Function for test scripts)
 108 start_kube_proxy() {
 109
 110         echo -e $BOLD"Starting $KUBE_PROXY_DISPLAY_NAME"$EBOLD
 111
 112         if [ $RUNMODE == "KUBE" ]; then
 113
 114                 # Check if app shall be fully managed by the test script
 115                 __check_included_image "KUBEPROXY"
 116                 retcode_i=$?
 117
 118                 # Check if app shall only be used by the testscipt
 119                 __check_prestarted_image "KUBEPROXY"
 120                 retcode_p=$?
 121
 122                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
 123                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
 124                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 125                         exit
 126                 fi
 127                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
 128                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
 129                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
 130                         exit
 131                 fi
 132
 133                 # Check if app shall be used - not managed - by the test script
 134                 if [ $retcode_p -eq 0 ]; then
 135                         echo -e " Using existing $KUBE_PROXY_APP_NAME deployment and service"
 136                         echo " Setting KUBEPROXY replicas=1"
 137                         __kube_scale deployment $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE 1
 138                 fi
 139
 140                 if [ $retcode_i -eq 0 ]; then
 141                         echo -e " Creating $KUBE_PROXY_APP_NAME deployment and service"
 142                         export KUBE_PROXY_APP_NAME
 143                         export KUBE_PROXY_WEB_EXTERNAL_PORT
 144                         export KUBE_PROXY_WEB_INTERNAL_PORT
 145                         export KUBE_PROXY_EXTERNAL_PORT
 146                         export KUBE_PROXY_INTERNAL_PORT
 147                         export KUBE_SIM_NAMESPACE
 148                         export KUBE_PROXY_IMAGE
 149
 150                         __kube_create_namespace $KUBE_SIM_NAMESPACE
 151
 152                         # Create service
 153                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"svc.yaml
 154                         output_yaml=$PWD/tmp/proxy_svc.yaml
 155                         __kube_create_instance service $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 156
 157                         # Create app
 158                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"app.yaml
 159                         output_yaml=$PWD/tmp/proxy_app.yaml
 160                         __kube_create_instance app $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
 161
 162                 fi
 163
 164                 echo " Retrieving host and ports for service..."
 165
 166                 CLUSTER_KUBE_PROXY="http"
 167
 168                 #Finding host of the proxy
 169                 echo "  Trying to find svc hostname..."
 170                 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}")
 171
 172
 173                 if [ "$CLUSTER_KUBE_PROXY_HOST" == "localhost" ]; then
 174                         #Local host found
 175                         echo -e $YELLOW" The test environment svc $KUBE_PROXY_APP_NAME host is: $CLUSTER_KUBE_PROXY_HOST"$EYELLOW
 176                         CLUSTER_KUBE_PROXY_HOST="127.0.0.1"
 177                 else
 178                         if [ -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
 179                                 #Host of proxy not found, trying to find the ip....
 180                                 echo "  Trying to find svc ip..."
 181                                 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}")
 182                                 if [ ! -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
 183                                         #Host ip found
 184                                         echo -e $YELLOW" The test environment svc $KUBE_PROXY_APP_NAME ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
 185                                 fi
 186                         else
 187                                 #Host or ip of proxy found
 188                                 echo -e $YELLOW" The test environment host/ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
 189                         fi
 190                 fi
 191                 if [ -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
 192                         #Host/ip of proxy not found, try to use the cluster and the nodeports of the proxy
 193                         CLUSTER_KUBE_PROXY_HOST=$(kubectl config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
 194                         echo -e $YELLOW" The test environment cluster ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
 195                         CLUSTER_KUBE_PROXY_PORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")  # port for proxy access
 196                         KUBE_PROXY_WEB_NODEPORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web")  # web port, only for alive test
 197                         echo " Cluster ip/host, cluster http nodeport, cluster web nodeport: $CLUSTER_KUBE_PROXY_HOST $CLUSTER_KUBE_PROXY_PORT $KUBE_PROXY_WEB_NODEPORT"
 198                 else
 199                         #Find the service ports of the proxy
 200                         CLUSTER_KUBE_PROXY_PORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")  # port for proxy access
 201                         KUBE_PROXY_WEB_NODEPORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web")  # web port, only for alive test
 202                         echo " Proxy ip/host, proxy http port, proxy web port: $CLUSTER_KUBE_PROXY_HOST $CLUSTER_KUBE_PROXY_PORT $KUBE_PROXY_WEB_NODEPORT"
 203                 fi
 204
 205                 KUBE_PROXY_WEB_PATH=$CLUSTER_KUBE_PROXY"://"$CLUSTER_KUBE_PROXY_HOST":"$KUBE_PROXY_WEB_NODEPORT
 206
 207                 export KUBE_PROXY_PATH=  # Make sure proxy is empty when checking the proxy itself
 208                 __check_service_start $KUBE_PROXY_APP_NAME $KUBE_PROXY_WEB_PATH$KUBE_PROXY_ALIVE_URL
 209
 210                 # Set proxy for all subsequent calls for all services etc
 211                 export KUBE_PROXY_PATH=$CLUSTER_KUBE_PROXY"://"$CLUSTER_KUBE_PROXY_HOST":"$CLUSTER_KUBE_PROXY_PORT
 212
 213         else
 214                 echo $YELLOW" Kube http proxy not needed in docker test. App not started"
 215         fi
 216         echo ""
 217
 218 }
 219