Change of ECS to ICS in test env
[nonrtric.git] / test / common / ngw_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         if [ $RUNMODE == "KUBE" ]; then
82                 kubectl  logs -l "autotest=NGW" -n $KUBE_NONRTRIC_NAMESPACE --tail=-1 > $1$2_gateway.log 2>&1
83         else
84                 docker logs $NRT_GATEWAY_APP_NAME > $1$2_gateway.log 2>&1
85         fi
86 }
87
88 # Initial setup of protocol, host and ports
89 # This function is called for apps managed by the test script.
90 # args: -
91 __NGW_initial_setup() {
92         use_gateway_http
93 }
94
95 # Set app short-name, app name and namespace for logging runtime statistics of kubernets pods or docker containers
96 # For docker, the namespace shall be excluded
97 # This function is called for apps managed by the test script as well as for prestarted apps.
98 # args: -
99 __NGW_statisics_setup() {
100         if [ $RUNMODE == "KUBE" ]; then
101                 echo "NGW $NRT_GATEWAY_APP_NAME $KUBE_NONRTRIC_NAMESPACE"
102         else
103                 echo "NGW $NRT_GATEWAY_APP_NAME"
104         fi
105 }
106
107 #######################################################
108
109
110
111
112
113 # Set http as the protocol to use for all communication to the nonrtric gateway
114 # args: -
115 # (Function for test scripts)
116 use_gateway_http() {
117         __gateway_set_protocoll "http" $NRT_GATEWAY_INTERNAL_PORT $NRT_GATEWAY_EXTERNAL_PORT
118 }
119
120 # Set https as the protocol to use for all communication to the nonrtric gateway
121 # args: -
122 # (Function for test scripts)
123 use_gateway_https() {
124         __gateway_set_protocoll "https" $NRT_GATEWAY_INTERNAL_SECURE_PORT $NRT_GATEWAY_EXTERNAL_SECURE_PORT
125 }
126
127 # Setup paths to svc/container for internal and external access
128 # args: <protocol> <internal-port> <external-port>
129 __gateway_set_protocoll() {
130         echo -e $BOLD"$NRT_GATEWAY_DISPLAY_NAME protocol setting"$EBOLD
131         echo -e " Using $BOLD $1 $EBOLD towards $NRT_GATEWAY_DISPLAY_NAME"
132
133         ## Access to nonrtric gateway
134
135         NRT_GATEWAY_SERVICE_PATH=$1"://"$NRT_GATEWAY_APP_NAME":"$2  # docker access, container->container and script->container via proxy
136         if [ $RUNMODE == "KUBE" ]; then
137                 NRT_GATEWAY_SERVICE_PATH=$1"://"$NRT_GATEWAY_APP_NAME.$KUBE_NONRTRIC_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
138         fi
139
140         # NRT_GATEWAY_ADAPTER used for switching between REST and DMAAP (only REST supported currently)
141         NRT_GATEWAY_ADAPTER_TYPE="REST"
142         NRT_GATEWAY_ADAPTER=$DMAAP_ADP_SERVICE_PATH
143
144         echo ""
145 }
146
147 # Turn on debug level tracing in the gateway
148 # args: -
149 # (Function for test scripts)
150 set_gateway_debug() {
151         echo -e $BOLD"Setting gateway debug logging"$EBOLD
152         curlString="$NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ACTUATOR -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"debug\"}"
153         result=$(__do_curl "$curlString")
154         if [ $? -ne 0 ]; then
155                 __print_err "could not set debug mode" $@
156                 ((RES_CONF_FAIL++))
157                 return 1
158         fi
159         echo ""
160         return 0
161 }
162
163 # Turn on trace level tracing in the gateway
164 # args: -
165 # (Function for test scripts)
166 set_gateway_trace() {
167         echo -e $BOLD"Setting gateway trace logging"$EBOLD
168         curlString="$NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ACTUATOR -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"trace\"}"
169         result=$(__do_curl "$curlString")
170         if [ $? -ne 0 ]; then
171                 __print_err "could not set trace mode" $@
172                 ((RES_CONF_FAIL++))
173                 return 1
174         fi
175         echo ""
176         return 0
177 }
178
179 # Export env vars for config files, docker compose and kube resources
180 # args: -
181 __gateway_export_vars() {
182
183         export NRT_GATEWAY_APP_NAME
184         export NRT_GATEWAY_DISPLAY_NAME
185
186         export KUBE_NONRTRIC_NAMESPACE
187         export DOCKER_SIM_NWNAME
188
189         export NRT_GATEWAY_IMAGE
190         export NRT_GATEWAY_INTERNAL_PORT
191         export NRT_GATEWAY_INTERNAL_SECURE_PORT
192         export NRT_GATEWAY_EXTERNAL_PORT
193         export NRT_GATEWAY_EXTERNAL_SECURE_PORT
194         export NRT_GATEWAY_CONFIG_MOUNT_PATH
195         export NRT_GATEWAY_CONFIG_FILE
196         export NGW_CONFIG_CONFIGMAP_NAME=$NRT_GATEWAY_APP_NAME"-config"
197         export NRT_GATEWAY_HOST_MNT_DIR
198         export NRT_GATEWAY_COMPOSE_DIR
199
200         if [ $RUNMODE == "KUBE" ]; then
201                 export POLICY_AGENT_EXTERNAL_SECURE_PORT
202                 export ICS_EXTERNAL_SECURE_PORT
203                 export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
204                 export ICS_DOMAIN_NAME=$ICS_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
205         else
206                 export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME
207                 export ICS_DOMAIN_NAME=$ICS_APP_NAME
208         fi
209 }
210
211 # Start the Gateway container
212 # args: -
213 # (Function for test scripts)
214 start_gateway() {
215
216         echo -e $BOLD"Starting $NRT_GATEWAY_DISPLAY_NAME"$EBOLD
217
218         if [ $RUNMODE == "KUBE" ]; then
219
220                 # Check if app shall be fully managed by the test script
221                 __check_included_image "NGW"
222                 retcode_i=$?
223
224                 # Check if app shall only be used by the testscipt
225                 __check_prestarted_image "NGW"
226                 retcode_p=$?
227
228                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
229                         echo -e $RED"The $NRT_GATEWAY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
230                         echo -e $RED"The $NRT_GATEWAY_APP_NAME will not be started"$ERED
231                         exit
232                 fi
233                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
234                         echo -e $RED"The $NRT_GATEWAY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
235                         echo -e $RED"The $NRT_GATEWAY_APP_NAME will not be started"$ERED
236                         exit
237                 fi
238
239                 # Check if app shall be used - not managed - by the test script
240                 __check_prestarted_image "NGW"
241                 if [ $? -eq 0 ]; then
242                         echo -e " Using existing $NRT_GATEWAY_APP_NAME deployment and service"
243                         echo " Setting NGW replicas=1"
244                         __kube_scale deployment $NRT_GATEWAY_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
245                 fi
246
247                 if [ $retcode_i -eq 0 ]; then
248
249                         echo -e " Creating $NRT_GATEWAY_APP_NAME app and expose service"
250
251                         __gateway_export_vars
252
253                         #Check if nonrtric namespace exists, if not create it
254                         __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
255
256                         # Create config map for config
257                         datafile=$PWD/tmp/$NRT_GATEWAY_CONFIG_FILE
258                         #Add config to properties file
259                         envsubst < $1 > $datafile
260                         output_yaml=$PWD/tmp/ngw_cfc.yaml
261                         __kube_create_configmap $NGW_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest NGW $datafile $output_yaml
262
263                         # Create service
264                         input_yaml=$SIM_GROUP"/"$NRT_GATEWAY_COMPOSE_DIR"/"svc.yaml
265                         output_yaml=$PWD/tmp/ngw_svc.yaml
266                         __kube_create_instance service $NRT_GATEWAY_APP_NAME $input_yaml $output_yaml
267
268                         # Create app
269                         input_yaml=$SIM_GROUP"/"$NRT_GATEWAY_COMPOSE_DIR"/"app.yaml
270                         output_yaml=$PWD/tmp/ngw_app.yaml
271                         __kube_create_instance app $NRT_GATEWAY_APP_NAME $input_yaml $output_yaml
272
273                 fi
274
275                 __check_service_start $NRT_GATEWAY_APP_NAME $NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ALIVE_URL
276
277         else
278                 # Check if docker app shall be fully managed by the test script
279                 __check_included_image 'NGW'
280                 if [ $? -eq 1 ]; then
281                         echo -e $RED"The Gateway app is not included in this test script"$ERED
282                         echo -e $RED"The Gateway will not be started"$ERED
283                         exit
284                 fi
285
286                 __gateway_export_vars
287
288                 dest_file=$SIM_GROUP/$NRT_GATEWAY_COMPOSE_DIR/$NRT_GATEWAY_HOST_MNT_DIR/$NRT_GATEWAY_CONFIG_FILE
289
290                 envsubst < $1 > $dest_file
291
292                 __start_container $NRT_GATEWAY_COMPOSE_DIR "" NODOCKERARGS 1 $NRT_GATEWAY_APP_NAME
293
294                 __check_service_start $NRT_GATEWAY_APP_NAME $NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ALIVE_URL
295         fi
296         echo ""
297 }
298
299
300 # API Test function: V2 GET /status towards PMS
301 # args: <response-code>
302 # (Function for test scripts)
303 gateway_pms_get_status() {
304         __log_test_start $@
305     if [ $# -ne 1 ]; then
306                 __print_err "<response-code>" $@
307                 return 1
308         fi
309         query=$PMS_API_PREFIX"/v2/status"
310     res="$(__do_curl_to_api NGW GET $query)"
311     status=${res:${#res}-3}
312
313         if [ $status -ne $1 ]; then
314                 __log_test_fail_status_code $1 $status
315                 return 1
316         fi
317
318         __log_test_pass
319         return 0
320 }
321
322 # API Test function: GET /ei-producer/v1/eitypes towards ICS
323 # Note: This is just to test service response
324 # args: <response-code>
325 # (Function for test scripts)
326 gateway_ics_get_types() {
327         __log_test_start $@
328     if [ $# -ne 1 ]; then
329                 __print_err "<response-code>" $@
330                 return 1
331         fi
332         query="/ei-producer/v1/eitypes"
333     res="$(__do_curl_to_api NGW GET $query)"
334     status=${res:${#res}-3}
335
336         if [ $status -ne $1 ]; then
337                 __log_test_fail_status_code $1 $status
338                 return 1
339         fi
340
341         __log_test_pass
342         return 0
343 }