eb4600cc6a81cf88d5e7456193daa3e517d34d27
[nonrtric.git] / test / common / kubeproxy_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         if [ $RUNMODE == "KUBE" ]; then
97                 kubectl  logs -l "autotest=KUBEPROXY" -n $KUBE_SIM_NAMESPACE --tail=-1 > $1$2_kubeproxy.log 2>&1
98         else
99                 docker logs $KUBE_PROXY_APP_NAME > $1$2_kubeproxy.log 2>&1
100         fi
101 }
102
103 # Initial setup of protocol, host and ports
104 # This function is called for apps managed by the test script.
105 # args: -
106 __KUBEPROXY_initial_setup() {
107         use_kube_proxy_http
108 }
109
110 # Set app short-name, app name and namespace for logging runtime statistics of kubernets pods or docker containers
111 # For docker, the namespace shall be excluded
112 # This function is called for apps managed by the test script as well as for prestarted apps.
113 # args: -
114 __KUBEPROXY_statisics_setup() {
115         if [ $RUNMODE == "KUBE" ]; then
116                 echo "KUBEPROXXY $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE"
117         else
118                 echo "KUBEPROXXY $KUBE_PROXY_APP_NAME"
119         fi
120 }
121
122 #######################################################
123
124 ## Access to Kube http proxy
125 # Direct access
126 KUBE_PROXY_HTTPX="http"
127
128
129 # Set http as the protocol to use for all communication to the Kube http proxy
130 # args: -
131 # (Function for test scripts)
132 use_kube_proxy_http() {
133         echo -e $BOLD"$KUBE_PROXY_DISPLAY_NAME protocol setting"$EBOLD
134         echo -e " Using $BOLD http $EBOLD towards Kube http proxy"
135
136         KUBE_PROXY_HTTPX="http"
137
138         echo -e $YELLOW" This setting cannot be changed once the kube proxy is started"$EYELLOW
139         echo ""
140 }
141
142 # Set https as the protocol to use for all communication to the Kube http proxy
143 # args: -
144 # (Function for test scripts)
145 use_kube_proxy_https() {
146         echo -e $BOLD"$KUBE_PROXY_DISPLAY_NAME protocol setting"$EBOLD
147         echo -e " Using $BOLD https $EBOLD towards Kube http proxy"
148
149         KUBE_PROXY_HTTPX="https"
150
151         echo -e $YELLOW" This setting cannot be changed once the kube proxy is started"$EYELLOW
152         echo ""
153 }
154
155 #########################
156 ### Kube Http Proxy functions
157 #########################
158
159 # Export env vars for config files, docker compose and kube resources
160 # args: -
161 __kube_proxy_vars() {
162
163         export KUBE_PROXY_WEB_EXTERNAL_PORT
164         export KUBE_PROXY_WEB_INTERNAL_PORT
165         export KUBE_PROXY_EXTERNAL_PORT
166         export KUBE_PROXY_INTERNAL_PORT
167
168         export KUBE_PROXY_WEB_EXTERNAL_SECURE_PORT
169         export KUBE_PROXY_WEB_INTERNAL_SECURE_PORT
170         export KUBE_PROXY_EXTERNAL_SECURE_PORT
171         export KUBE_PROXY_INTERNAL_SECURE_PORT
172
173         export KUBE_SIM_NAMESPACE
174         export KUBE_PROXY_IMAGE
175
176         export KUBE_PROXY_APP_NAME
177         export KUBE_PROXY_DOCKER_EXTERNAL_PORT
178         export KUBE_PROXY_DOCKER_EXTERNAL_SECURE_PORT
179         export KUBE_PROXY_WEB_DOCKER_EXTERNAL_PORT
180         export KUBE_PROXY_WEB_DOCKER_EXTERNAL_SECURE_PORT
181         export DOCKER_SIM_NWNAME
182
183         export KUBE_PROXY_DISPLAY_NAME
184 }
185
186 # Start the Kube Http Proxy in the simulator group
187 # args: -
188 # (Function for test scripts)
189 start_kube_proxy() {
190
191         echo -e $BOLD"Starting $KUBE_PROXY_DISPLAY_NAME"$EBOLD
192
193         if [ $RUNMODE == "KUBE" ]; then
194
195                 # Check if app shall be fully managed by the test script
196                 __check_included_image "KUBEPROXY"
197                 retcode_i=$?
198
199                 # Check if app shall only be used by the testscipt
200                 __check_prestarted_image "KUBEPROXY"
201                 retcode_p=$?
202
203                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
204                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
205                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
206                         exit
207                 fi
208                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
209                         echo -e $RED"The $KUBE_PROXY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
210                         echo -e $RED"The $KUBE_PROXY_APP_NAME will not be started"$ERED
211                         exit
212                 fi
213
214                 # Check if app shall be used - not managed - by the test script
215                 if [ $retcode_p -eq 0 ]; then
216                         echo -e " Using existing $KUBE_PROXY_APP_NAME deployment and service"
217                         echo " Setting KUBEPROXY replicas=1"
218                         __kube_scale deployment $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE 1
219                 fi
220
221                 if [ $retcode_i -eq 0 ]; then
222                         echo -e " Creating $KUBE_PROXY_APP_NAME deployment and service"
223
224                         __kube_proxy_vars
225
226                         export KUBE_PROXY_APP_NAME
227
228                         __kube_create_namespace $KUBE_SIM_NAMESPACE
229
230                         # Create service
231                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"svc.yaml
232                         output_yaml=$PWD/tmp/proxy_svc.yaml
233                         __kube_create_instance service $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
234
235                         # Create app
236                         input_yaml=$SIM_GROUP"/"$KUBE_PROXY_COMPOSE_DIR"/"app.yaml
237                         output_yaml=$PWD/tmp/proxy_app.yaml
238                         __kube_create_instance app $KUBE_PROXY_APP_NAME $input_yaml $output_yaml
239
240                 fi
241
242                 echo " Retrieving host and ports for service..."
243
244                 #Finding host of the proxy
245                 echo "  Trying to find svc hostname..."
246                 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}")
247
248
249                 if [ "$CLUSTER_KUBE_PROXY_HOST" == "localhost" ]; then
250                         #Local host found
251                         echo -e $YELLOW" The test environment svc $KUBE_PROXY_APP_NAME host is: $CLUSTER_KUBE_PROXY_HOST"$EYELLOW
252                         CLUSTER_KUBE_PROXY_HOST="127.0.0.1"
253                 else
254                         if [ -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
255                                 #Host of proxy not found, trying to find the ip....
256                                 echo "  Trying to find svc ip..."
257                                 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}")
258                                 if [ ! -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
259                                         #Host ip found
260                                         echo -e $YELLOW" The test environment svc $KUBE_PROXY_APP_NAME ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
261                                 fi
262                         else
263                                 #Host or ip of proxy found
264                                 echo -e $YELLOW" The test environment host/ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
265                         fi
266                 fi
267
268                 PORT_KEY_PREFIX=""
269                 if [ $KUBE_PROXY_HTTPX == "https" ]; then
270                         PORT_KEY_PREFIX="s"  #add suffix to port key name to get https ports
271                 fi
272                 if [ -z "$CLUSTER_KUBE_PROXY_HOST" ]; then
273                         #Host/ip of proxy not found, try to use the cluster and the nodeports of the proxy
274                         CLUSTER_KUBE_PROXY_HOST=$(kubectl config view -o jsonpath={.clusters[0].cluster.server} | awk -F[/:] '{print $4}')
275                         echo -e $YELLOW" The test environment cluster ip is: $CLUSTER_KUBE_PROXY_HOST."$EYELLOW
276                         CLUSTER_KUBE_PROXY_PORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http$PORT_KEY_PREFIX")  # port for proxy access
277                         KUBE_PROXY_WEB_NODEPORT=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web$PORT_KEY_PREFIX")  # web port, only for alive test
278                         echo " Cluster ip/host, cluster http$PORT_KEY_PREFIX nodeport, cluster web$PORT_KEY_PREFIX nodeport: $CLUSTER_KUBE_PROXY_HOST $CLUSTER_KUBE_PROXY_PORT $KUBE_PROXY_WEB_NODEPORT"
279                 else
280                         #Find the service ports of the proxy
281                         CLUSTER_KUBE_PROXY_PORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http$PORT_KEY_PREFIX")  # port for proxy access
282                         KUBE_PROXY_WEB_NODEPORT=$(__kube_get_service_port $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "web$PORT_KEY_PREFIX")  # web port, only for alive test
283                         echo " Proxy ip/host, proxy http$PORT_KEY_PREFIX port, proxy web$PORT_KEY_PREFIX port: $CLUSTER_KUBE_PROXY_HOST $CLUSTER_KUBE_PROXY_PORT $KUBE_PROXY_WEB_NODEPORT"
284                 fi
285
286                 KUBE_PROXY_WEB_PATH=$KUBE_PROXY_HTTPX"://"$CLUSTER_KUBE_PROXY_HOST":"$KUBE_PROXY_WEB_NODEPORT
287
288                 export KUBE_PROXY_PATH=  # Make sure proxy is empty when checking the proxy itself
289                 __check_service_start $KUBE_PROXY_APP_NAME $KUBE_PROXY_WEB_PATH$KUBE_PROXY_ALIVE_URL
290
291                 # Set proxy for all subsequent calls for all services etc
292                 export KUBE_PROXY_PATH=$KUBE_PROXY_HTTPX"://"$CLUSTER_KUBE_PROXY_HOST":"$CLUSTER_KUBE_PROXY_PORT
293                 export KUBE_PROXY_HTTPX
294
295                 KP_PORT1=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "http")
296                 KP_PORT2=$(__kube_get_service_nodeport $KUBE_PROXY_APP_NAME $KUBE_SIM_NAMESPACE "https")
297
298                 echo " $KUBE_PROXY_DISPLAY_NAME node ports (http/https): $KP_PORT1 $KP_PORT2"
299
300         else
301                 # Check if docker app shall be fully managed by the test script
302                 __check_included_image 'KUBEPROXY'
303                 if [ $? -eq 1 ]; then
304                         echo -e $RED"The Kube Proxy app is not included in this test script"$ERED
305                         echo -e $RED"The Kube Proxy will not be started"$ERED
306                         exit
307                 fi
308
309                 __kube_proxy_vars
310
311                 __start_container $KUBE_PROXY_COMPOSE_DIR "" NODOCKERARGS 1 $KUBE_PROXY_APP_NAME
312
313                 if [ $KUBE_PROXY_HTTPX == "http" ]; then
314                         export KUBE_PROXY_WEB_PATH=$KUBE_PROXY_HTTPX"://"$LOCALHOST_NAME":"$KUBE_PROXY_WEB_DOCKER_EXTERNAL_PORT
315                 else
316                         export KUBE_PROXY_WEB_PATH=$KUBE_PROXY_HTTPX"://"$LOCALHOST_NAME":"$KUBE_PROXY_WEB_DOCKER_EXTERNAL_SECURE_PORT
317                 fi
318
319                 export KUBE_PROXY_PATH=  # Make sure proxy is empty when checking the proxy itself
320         __check_service_start $KUBE_PROXY_APP_NAME $KUBE_PROXY_WEB_PATH$KUBE_PROXY_ALIVE_URL
321
322                 if [ $KUBE_PROXY_HTTPX == "http" ]; then
323                         export KUBE_PROXY_PATH=$KUBE_PROXY_HTTPX"://"$LOCALHOST_NAME":"$KUBE_PROXY_DOCKER_EXTERNAL_PORT
324                 else
325                         export KUBE_PROXY_PATH=$KUBE_PROXY_HTTPX"://"$LOCALHOST_NAME":"$KUBE_PROXY_DOCKER_EXTERNAL_SECURE_PORT
326                 fi
327
328                 echo " $KUBE_PROXY_DISPLAY_NAME localhost ports (http/https): $KUBE_PROXY_DOCKER_EXTERNAL_PORT $KUBE_PROXY_DOCKER_EXTERNAL_SECURE_PORT"
329
330
331         fi
332         echo ""
333
334 }
335