Merge "Adapted function test for E release"
[nonrtric.git] / test / common / gateway_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 management functions
21 # for NonRTRIC Gateway
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 __NGW_imagesetup() {
29         __check_and_create_image_var NGW "NRT_GATEWAY_IMAGE" "NRT_GATEWAY_IMAGE_BASE" "NRT_GATEWAY_IMAGE_TAG" $1 "$NRT_GATEWAY_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 __NGW_imagepull() {
38         __check_and_pull_image $1 "$NRT_GATEWAY_DISPLAY_NAME" $NRT_GATEWAY_APP_NAME NRT_GATEWAY_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 __NGW_imagebuild() {
45         echo -e $RED"Image for app NGW 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 __NGW_image_data() {
52         echo -e "$NRT_GATEWAY_DISPLAY_NAME\t$(docker images --format $1 $NRT_GATEWAY_IMAGE)" >>   $2
53         if [ ! -z "$NRT_GATEWAY_IMAGE_SOURCE" ]; then
54                 echo -e "-- source image --\t$(docker images --format $1 $NRT_GATEWAY_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 __NGW_kube_scale_zero() {
62         __kube_scale_all_resources $KUBE_NONRTRIC_NAMESPACE autotest NGW
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 __NGW_kube_scale_zero_and_wait() {
68         echo -e " NGW replicas kept as is"
69 }
70
71 # Delete all kube resouces for the app
72 # This function is called for apps managed by the test script.
73 __NGW_kube_delete_all() {
74         __kube_delete_all_resources $KUBE_NONRTRIC_NAMESPACE autotest NGW
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 __NGW_store_docker_logs() {
81         docker logs $NRT_GATEWAY_APP_NAME > $1$2_gateway.log 2>&1
82 }
83
84 #######################################################
85
86 ## Access to Gateway
87 # Host name may be changed if app started by kube
88 # Direct access from script
89 NGW_HTTPX="http"
90 NGW_HOST_NAME=$LOCALHOST_NAME
91 NGW_PATH=$NGW_HTTPX"://"$NGW_HOST_NAME":"$NRT_GATEWAY_EXTERNAL_PORT
92 # NGW_ADAPTER used for switch between REST and DMAAP (only REST supported currently)
93 NGW_ADAPTER_TYPE="REST"
94 NGW_ADAPTER=$NGW_PATH
95 ###########################
96 ### Gateway functions
97 ###########################
98
99 # Set http as the protocol to use for all communication to the Gateway
100 # args: -
101 # (Function for test scripts)
102 use_gateway_http() {
103         echo -e $BOLD"Gateway, NGW, protocol setting"$EBOLD
104         echo -e " Using $BOLD http $EBOLD towards NGW"
105         NGW_HTTPX="http"
106         NGW_PATH=$NGW_HTTPX"://"$NGW_HOST_NAME":"$NRT_GATEWAY_EXTERNAL_PORT
107         NGW_ADAPTER_TYPE="REST"
108         NGW_ADAPTER=$NGW_PATH
109         echo ""
110 }
111
112 # Set https as the protocol to use for all communication to the Gateway
113 # args: -
114 # (Function for test scripts)
115 use_gateway_https() {
116         echo -e $BOLD"Gateway, NGW, protocol setting"$EBOLD
117         echo -e " Using $BOLD https $EBOLD towards NGW"
118         NGW_HTTPX="https"
119         NGW_PATH=$NGW_HTTPX"://"$NGW_HOST_NAME":"$NRT_GATEWAY_EXTERNAL_SECURE_PORT
120         NGW_ADAPTER_TYPE="REST"
121         NGW_ADAPTER=$NGW_PATH
122         echo ""
123 }
124
125 # Turn on debug level tracing in the gateway
126 # args: -
127 # (Function for test scripts)
128 set_gateway_debug() {
129         echo -e $BOLD"Setting gateway debug logging"$EBOLD
130         curlString="$NGW_PATH$NRT_GATEWAY_ACTUATOR -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"debug\"}"
131         result=$(__do_curl "$curlString")
132         if [ $? -ne 0 ]; then
133                 __print_err "could not set debug mode" $@
134                 ((RES_CONF_FAIL++))
135                 return 1
136         fi
137         echo ""
138         return 0
139 }
140
141 # Turn on trace level tracing in the gateway
142 # args: -
143 # (Function for test scripts)
144 set_gateway_trace() {
145         echo -e $BOLD"Setting gateway trace logging"$EBOLD
146         curlString="$NGW_PATH$NRT_GATEWAY_ACTUATOR -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"trace\"}"
147         result=$(__do_curl "$curlString")
148         if [ $? -ne 0 ]; then
149                 __print_err "could not set trace mode" $@
150                 ((RES_CONF_FAIL++))
151                 return 1
152         fi
153         echo ""
154         return 0
155 }
156
157 # Start the Gateway container
158 # args: -
159 # (Function for test scripts)
160 start_gateway() {
161
162         echo -e $BOLD"Starting $NRT_GATEWAY_DISPLAY_NAME"$EBOLD
163
164         if [ $RUNMODE == "KUBE" ]; then
165
166                 # Check if app shall be fully managed by the test script
167                 __check_included_image "NGW"
168                 retcode_i=$?
169
170                 # Check if app shall only be used by the testscipt
171                 __check_prestarted_image "NGW"
172                 retcode_p=$?
173
174                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
175                         echo -e $RED"The $NRT_GATEWAY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
176                         echo -e $RED"The $NRT_GATEWAY_APP_NAME will not be started"$ERED
177                         exit
178                 fi
179                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
180                         echo -e $RED"The $NRT_GATEWAY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
181                         echo -e $RED"The $NRT_GATEWAY_APP_NAME will not be started"$ERED
182                         exit
183                 fi
184
185                 # Check if app shall be used - not managed - by the test script
186                 __check_prestarted_image "NGW"
187                 if [ $? -eq 0 ]; then
188                         echo -e " Using existing $NRT_GATEWAY_APP_NAME deployment and service"
189                         echo " Setting NGW replicas=1"
190                         __kube_scale deployment $NRT_GATEWAY_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
191                 fi
192
193                 if [ $retcode_i -eq 0 ]; then
194
195                         echo -e " Creating $NRT_GATEWAY_APP_NAME app and expose service"
196
197                         #Export all vars needed for service and deployment
198                         export NRT_GATEWAY_APP_NAME
199                         export KUBE_NONRTRIC_NAMESPACE
200                         export NRT_GATEWAY_IMAGE
201                         export NRT_GATEWAY_INTERNAL_PORT
202                         export NRT_GATEWAY_INTERNAL_SECURE_PORT
203                         export NRT_GATEWAY_EXTERNAL_PORT
204                         export NRT_GATEWAY_EXTERNAL_SECURE_PORT
205                         export NRT_GATEWAY_CONFIG_MOUNT_PATH
206                         export NRT_GATEWAY_CONFIG_FILE
207                         export NGW_CONFIG_CONFIGMAP_NAME=$NRT_GATEWAY_APP_NAME"-config"
208
209                         export POLICY_AGENT_EXTERNAL_SECURE_PORT
210                         export ECS_EXTERNAL_SECURE_PORT
211                         export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
212                         export ECS_DOMAIN_NAME=$ECS_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
213
214                         #Check if nonrtric namespace exists, if not create it
215                         __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
216
217                         # Create config map for config
218                         datafile=$PWD/tmp/$NRT_GATEWAY_CONFIG_FILE
219                         #Add config to properties file
220                         envsubst < $1 > $datafile
221                         output_yaml=$PWD/tmp/ngw_cfc.yaml
222                         __kube_create_configmap $NGW_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest NGW $datafile $output_yaml
223
224                         # Create service
225                         input_yaml=$SIM_GROUP"/"$NRT_GATEWAY_COMPOSE_DIR"/"svc.yaml
226                         output_yaml=$PWD/tmp/ngw_svc.yaml
227                         __kube_create_instance service $NRT_GATEWAY_APP_NAME $input_yaml $output_yaml
228
229                         # Create app
230                         input_yaml=$SIM_GROUP"/"$NRT_GATEWAY_COMPOSE_DIR"/"app.yaml
231                         output_yaml=$PWD/tmp/ngw_app.yaml
232                         __kube_create_instance app $NRT_GATEWAY_APP_NAME $input_yaml $output_yaml
233
234                 fi
235
236                 echo " Retrieving host and ports for service..."
237                 NGW_HOST_NAME=$(__kube_get_service_host $NRT_GATEWAY_APP_NAME $KUBE_NONRTRIC_NAMESPACE)
238
239                 NRT_GATEWAY_EXTERNAL_PORT=$(__kube_get_service_port $NRT_GATEWAY_APP_NAME $KUBE_NONRTRIC_NAMESPACE "http")
240                 NRT_GATEWAY_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $NRT_GATEWAY_APP_NAME $KUBE_NONRTRIC_NAMESPACE "https")
241
242                 echo " Host IP, http port, https port: $NGW_HOST_NAME $NRT_GATEWAY_EXTERNAL_PORT $NRT_GATEWAY_EXTERNAL_SECURE_PORT"
243                 if [ $NGW_HTTPX == "http" ]; then
244                         NGW_PATH=$NGW_HTTPX"://"$NGW_HOST_NAME":"$NRT_GATEWAY_EXTERNAL_PORT
245                 else
246                         NGW_PATH=$NGW_HTTPX"://"$NGW_HOST_NAME":"$NRT_GATEWAY_EXTERNAL_SECURE_PORT
247                 fi
248
249                 __check_service_start $NRT_GATEWAY_APP_NAME $NGW_PATH$NRT_GATEWAY_ALIVE_URL
250
251                 # Update the curl adapter if set to rest, no change if type dmaap
252                 if [ $NGW_ADAPTER_TYPE == "REST" ]; then
253                         NGW_ADAPTER=$NGW_PATH
254                 fi
255         else
256                 # Check if docker app shall be fully managed by the test script
257                 __check_included_image 'NGW'
258                 if [ $? -eq 1 ]; then
259                         echo -e $RED"The Gateway app is not included in this test script"$ERED
260                         echo -e $RED"The Gateway will not be started"$ERED
261                         exit
262                 fi
263
264                 # Export needed vars for docker compose
265         export NRT_GATEWAY_APP_NAME
266         export NRT_GATEWAY_INTERNAL_PORT
267         export NRT_GATEWAY_EXTERNAL_PORT
268         #export NRT_GATEWAY_INTERNAL_SECURE_PORT
269         #export NRT_GATEWAY_EXTERNAL_SECURE_PORT
270
271         export DOCKER_SIM_NWNAME
272                 export NRT_GATEWAY_HOST_MNT_DIR
273                 export NRT_GATEWAY_CONFIG_FILE
274                 export NRT_GATEWAY_CONFIG_MOUNT_PATH
275                 export NRT_GATEWAY_COMPOSE_DIR
276
277                 export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME
278                 export POLICY_AGENT_EXTERNAL_SECURE_PORT
279                 export ECS_DOMAIN_NAME=$ECS_APP_NAME
280                 export ECS_EXTERNAL_SECURE_PORT
281
282                 export NRT_GATEWAY_DISPLAY_NAME
283
284                 dest_file=$SIM_GROUP/$NRT_GATEWAY_COMPOSE_DIR/$NRT_GATEWAY_HOST_MNT_DIR/$NRT_GATEWAY_CONFIG_FILE
285
286                 envsubst < $1 > $dest_file
287
288                 __start_container $NRT_GATEWAY_COMPOSE_DIR "" NODOCKERARGS 1 $NRT_GATEWAY_APP_NAME
289
290                 __check_service_start $NRT_GATEWAY_APP_NAME $NGW_PATH$NRT_GATEWAY_ALIVE_URL
291         fi
292         echo ""
293 }
294
295
296 # API Test function: V2 GET /status towards PMS
297 # args: <response-code>
298 # (Function for test scripts)
299 gateway_pms_get_status() {
300         __log_test_start $@
301     if [ $# -ne 1 ]; then
302                 __print_err "<response-code>" $@
303                 return 1
304         fi
305         query=$PMS_API_PREFIX"/v2/status"
306     res="$(__do_curl_to_api NGW GET $query)"
307     status=${res:${#res}-3}
308
309         if [ $status -ne $1 ]; then
310                 __log_test_fail_status_code $1 $status
311                 return 1
312         fi
313
314         __log_test_pass
315         return 0
316 }
317
318 # API Test function: GET /ei-producer/v1/eitypes towards ECS
319 # Note: This is just to test service response
320 # args: <response-code>
321 # (Function for test scripts)
322 gateway_ecs_get_types() {
323         __log_test_start $@
324     if [ $# -ne 1 ]; then
325                 __print_err "<response-code>" $@
326                 return 1
327         fi
328         query="/ei-producer/v1/eitypes"
329     res="$(__do_curl_to_api NGW GET $query)"
330     status=${res:${#res}-3}
331
332         if [ $status -ne $1 ]; then
333                 __log_test_fail_status_code $1 $status
334                 return 1
335         fi
336
337         __log_test_pass
338         return 0
339 }