First version of service exposure
[nonrtric.git] / test / common / dmaapadp_api_functions.sh
1 #!/bin/bash
2
3 #  ============LICENSE_START===============================================
4 #  Copyright (C) 2021 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 test functions for the Dmaap Adatper
21
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 __DMAAPADP_imagesetup() {
29         __check_and_create_image_var DMAAPADP "DMAAP_ADP_IMAGE" "DMAAP_ADP_IMAGE_BASE" "DMAAP_ADP_IMAGE_TAG" $1 "$DMAAP_ADP_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 __DMAAPADP_imagepull() {
38         __check_and_pull_image $1 "$DMAAP_ADP_DISPLAY_NAME" $DMAAP_ADP_APP_NAME DMAAP_ADP_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 __DMAAPADP_imagebuild() {
45         echo -e $RED" Image for app DMAAPADP 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 __DMAAPADP_image_data() {
52         echo -e "$DMAAP_ADP_DISPLAY_NAME\t$(docker images --format $1 $DMAAP_ADP_IMAGE)" >>   $2
53         if [ ! -z "$DMAAP_ADP_IMAGE_SOURCE" ]; then
54                 echo -e "-- source image --\t$(docker images --format $1 $DMAAP_ADP_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 __DMAAPADP_kube_scale_zero() {
62         __kube_scale_all_resources $KUBE_NONRTRIC_NAMESPACE autotest DMAAPADP
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 __DMAAPADP_kube_scale_zero_and_wait() {
68         __kube_scale_and_wait_all_resources $KUBE_NONRTRIC_NAMESPACE app "$KUBE_NONRTRIC_NAMESPACE"-dmaapadapterservice
69 }
70
71 # Delete all kube resouces for the app
72 # This function is called for apps managed by the test script.
73 __DMAAPADP_kube_delete_all() {
74         __kube_delete_all_resources $KUBE_NONRTRIC_NAMESPACE autotest DMAAPADP
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 __DMAAPADP_store_docker_logs() {
81         if [ $RUNMODE == "KUBE" ]; then
82                 kubectl $KUBECONF  logs -l "autotest=DMAAPADP" -n $KUBE_NONRTRIC_NAMESPACE --tail=-1 > $1$2_dmaapadapter.log 2>&1
83         else
84                 docker logs $DMAAP_ADP_APP_NAME > $1$2_dmaapadapter.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 __DMAAPADP_initial_setup() {
92         use_dmaapadp_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 __DMAAPADP_statisics_setup() {
100         if [ $RUNMODE == "KUBE" ]; then
101                 echo "DMAAPADP $DMAAP_ADP_APP_NAME $KUBE_NONRTRIC_NAMESPACE"
102         else
103                 echo "DMAAPADP $DMAAP_ADP_APP_NAME"
104         fi
105 }
106
107 # Check application requirements, e.g. helm, the the test needs. Exit 1 if req not satisfied
108 # args: -
109 __DMAAPADP_test_requirements() {
110         :
111 }
112
113 #######################################################
114
115 # Set http as the protocol to use for all communication to the Dmaap adapter
116 # args: -
117 # (Function for test scripts)
118 use_dmaapadp_http() {
119         __dmaapadp_set_protocoll "http" $DMAAP_ADP_INTERNAL_PORT $DMAAP_ADP_EXTERNAL_PORT
120 }
121
122 # Set https as the protocol to use for all communication to the Dmaap adapter
123 # args: -
124 # (Function for test scripts)
125 use_dmaapadp_https() {
126         __dmaapadp_set_protocoll "https" $DMAAP_ADP_INTERNAL_SECURE_PORT $DMAAP_ADP_EXTERNAL_SECURE_PORT
127 }
128
129 # Setup paths to svc/container for internal and external access
130 # args: <protocol> <internal-port> <external-port>
131 __dmaapadp_set_protocoll() {
132         echo -e $BOLD"$DMAAP_ADP_DISPLAY_NAME protocol setting"$EBOLD
133         echo -e " Using $BOLD $1 $EBOLD towards $DMAAP_ADP_DISPLAY_NAME"
134
135         ## Access to Dmaap adapter
136
137         DMAAP_ADP_SERVICE_PATH=$1"://"$DMAAP_ADP_APP_NAME":"$2  # docker access, container->container and script->container via proxy
138         if [ $RUNMODE == "KUBE" ]; then
139                 DMAAP_ADP_SERVICE_PATH=$1"://"$DMAAP_ADP_APP_NAME.$KUBE_NONRTRIC_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
140         fi
141
142         # DMAAP_ADP_ADAPTER used for switching between REST and DMAAP (only REST supported currently)
143         DMAAP_ADP_ADAPTER_TYPE="REST"
144         DMAAP_ADP_ADAPTER=$DMAAP_ADP_SERVICE_PATH
145
146         echo ""
147 }
148
149 # Export env vars for config files, docker compose and kube resources
150 # args: PROXY|NOPROXY
151 __dmaapadp_export_vars() {
152
153         export DMAAP_ADP_APP_NAME
154         export DMAAP_ADP_DISPLAY_NAME
155
156         export KUBE_NONRTRIC_NAMESPACE
157         export DOCKER_SIM_NWNAME
158
159         export DMAAP_ADP_IMAGE
160
161         export DMAAP_ADP_INTERNAL_PORT
162         export DMAAP_ADP_INTERNAL_SECURE_PORT
163         export DMAAP_ADP_EXTERNAL_PORT
164         export DMAAP_ADP_EXTERNAL_SECURE_PORT
165
166         export DMAAP_ADP_CONFIG_MOUNT_PATH
167         export DMAAP_ADP_DATA_MOUNT_PATH
168         export DMAAP_ADP_HOST_MNT_DIR
169         export DMAAP_ADP_CONFIG_FILE
170         export DMAAP_ADP_DATA_FILE
171
172         export DMAAP_ADP_CONFIG_CONFIGMAP_NAME=$DMAAP_ADP_APP_NAME"-config"
173         export DMAAP_ADP_DATA_CONFIGMAP_NAME=$DMAAP_ADP_APP_NAME"-data"
174
175         export DMMAAP_ADP_PROXY_FLAG="false"
176
177         if [ $1 == "PROXY" ]; then
178                 export DMAAP_ADP_HTTP_PROXY_CONFIG_PORT=$HTTP_PROXY_CONFIG_PORT  #Set if proxy is started
179                 export DMAAP_ADP_HTTP_PROXY_CONFIG_HOST_NAME=$HTTP_PROXY_CONFIG_HOST_NAME #Set if proxy is started
180                 if [ $DMAAP_ADP_HTTP_PROXY_CONFIG_PORT -eq 0 ] || [ -z "$DMAAP_ADP_HTTP_PROXY_CONFIG_HOST_NAME" ]; then
181                         echo -e $YELLOW" Warning: HTTP PROXY will not be configured, proxy app not started"$EYELLOW
182                 else
183                         echo " Configured with http proxy"
184                 fi
185                 export DMMAAP_ADP_PROXY_FLAG="true"
186         else
187                 export DMAAP_ADP_HTTP_PROXY_CONFIG_PORT=0
188                 export DMAAP_ADP_HTTP_PROXY_CONFIG_HOST_NAME=""
189                 echo " Configured without http proxy"
190         fi
191
192
193         # paths to other components
194         export ICS_SERVICE_PATH
195         export DMAAP_ADP_SERVICE_PATH
196         export MR_SERVICE_PATH
197
198 }
199
200 # Start the Dmaap Adapter
201 # args: -
202 # (Function for test scripts)
203 start_dmaapadp() {
204
205         echo -e $BOLD"Starting $DMAAP_ADP_DISPLAY_NAME"$EBOLD
206
207         if [ $RUNMODE == "KUBE" ]; then
208
209                 # Check if app shall be fully managed by the test script
210                 __check_included_image "DMAAPADP"
211                 retcode_i=$?
212
213                 # Check if app shall only be used by the testscipt
214                 __check_prestarted_image "DMAAPADP"
215                 retcode_p=$?
216
217                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
218                         echo -e $RED"The $DMAAP_ADP_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
219                         echo -e $RED"The $DMAAP_ADP_APP_NAME will not be started"$ERED
220                         exit
221                 fi
222                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
223                         echo -e $RED"The $DMAAP_ADP_APP_NAME app is included both as managed and prestarted in this test script"$ERED
224                         echo -e $RED"The $DMAAP_ADP_APP_NAME will not be started"$ERED
225                         exit
226                 fi
227
228                 # Check if app shall be used - not managed - by the test script
229                 if [ $retcode_p -eq 0 ]; then
230                         echo -e " Using existing $DMAAP_ADP_APP_NAME deployment and service"
231                         echo " Setting DMAAPADP replicas=1"
232                         __kube_scale statefulset $DMAAP_ADP_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
233                 fi
234
235                 if [ $retcode_i -eq 0 ]; then
236                         echo -e " Creating $DMAAP_ADP_APP_NAME deployment and service"
237
238                         __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
239
240                         __dmaapadp_export_vars $1
241
242                         # Create config map for config
243                         configfile=$PWD/tmp/$DMAAP_ADP_CONFIG_FILE
244                         #cp $2 $configfile
245                         envsubst < $2 > $configfile
246                         output_yaml=$PWD/tmp/dmaapadp_cfc.yaml
247                         __kube_create_configmap $DMAAP_ADP_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest DMAAPADP $configfile $output_yaml
248
249                         # Create config map for data
250                         data_json=$PWD/tmp/$DMAAP_ADP_DATA_FILE
251                         if [ $# -lt 3 ]; then
252                                 #create empty dummy file
253                                 echo "{}" > $data_json
254                         else
255                                 cp $3 $data_json
256                         fi
257                         output_yaml=$PWD/tmp/dmaapadp_cfd.yaml
258                         __kube_create_configmap $DMAAP_ADP_DATA_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest DMAAPADP $data_json $output_yaml
259
260
261                         # Create service
262                         input_yaml=$SIM_GROUP"/"$DMAAP_ADP_COMPOSE_DIR"/"svc.yaml
263                         output_yaml=$PWD/tmp/dmaapadp_svc.yaml
264                         __kube_create_instance service $DMAAP_ADP_APP_NAME $input_yaml $output_yaml
265
266                         # Create app
267                         input_yaml=$SIM_GROUP"/"$DMAAP_ADP_COMPOSE_DIR"/"app.yaml
268                         output_yaml=$PWD/tmp/dmaapadp_app.yaml
269                         __kube_create_instance app $DMAAP_ADP_APP_NAME $input_yaml $output_yaml
270
271                 fi
272
273                 __check_service_start $DMAAP_ADP_APP_NAME $DMAAP_ADP_SERVICE_PATH$DMAAP_ADP_ALIVE_URL
274
275         else
276                 # Check if docker app shall be fully managed by the test script
277                 __check_included_image 'DMAAPADP'
278                 if [ $? -eq 1 ]; then
279                         echo -e $RED"The $DMAAP_ADP_DISPLAY_NAME app is not included in this test script"$ERED
280                         echo -e $RED"The $DMAAP_ADP_DISPLAY_NAME will not be started"$ERED
281                         exit
282                 fi
283
284                 __dmaapadp_export_vars $1
285
286                 dest_file=$SIM_GROUP/$DMAAP_ADP_COMPOSE_DIR/$DMAAP_ADP_HOST_MNT_DIR/$DMAAP_ADP_CONFIG_FILE
287
288                 envsubst < $2 > $dest_file
289
290                 dest_file=$SIM_GROUP/$DMAAP_ADP_COMPOSE_DIR/$DMAAP_ADP_HOST_MNT_DIR/$DMAAP_ADP_DATA_FILE
291
292                 if [ $# -lt 3 ]; then
293                         #create empty dummy file
294                         echo "{}" > $dest_file
295                 else
296                         envsubst < $3 > $dest_file
297                 fi
298
299                 __start_container $DMAAP_ADP_COMPOSE_DIR "" NODOCKERARGS 1 $DMAAP_ADP_APP_NAME
300
301                 __check_service_start $DMAAP_ADP_APP_NAME $DMAAP_ADP_SERVICE_PATH$DMAAP_ADP_ALIVE_URL
302         fi
303         echo ""
304 }
305
306 # Turn on trace level tracing
307 # args: -
308 # (Function for test scripts)
309 set_dmaapadp_trace() {
310         echo -e $BOLD"$DMAAP_ADP_DISPLAY_NAME trace logging"$EBOLD
311         curlString="$DMAAP_ADP_SERVICE_PATH$DMAAP_ADP_ACTUATOR -X POST  -H Content-Type:application/json -d {\"configuredLevel\":\"trace\"}"
312         result=$(__do_curl "$curlString")
313         if [ $? -ne 0 ]; then
314                 __print_err "could not set trace mode" $@
315                 ((RES_CONF_FAIL++))
316                 return 1
317         fi
318         echo ""
319         return 0
320 }