Fix distribution of Kafka messages
[nonrtric.git] / test / common / dmaapmed_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 __DMAAPMED_imagesetup() {
29         __check_and_create_image_var DMAAPMED "DMAAP_MED_IMAGE" "DMAAP_MED_IMAGE_BASE" "DMAAP_MED_IMAGE_TAG" $1 "$DMAAP_MED_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 __DMAAPMED_imagepull() {
38         __check_and_pull_image $1 "$DMAAP_MED_DISPLAY_NAME" $DMAAP_MED_APP_NAME DMAAP_MED_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 __DMAAPMED_imagebuild() {
45         echo -e $RED" Image for app DMAAPMED 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 __DMAAPMED_image_data() {
52         echo -e "$DMAAP_MED_DISPLAY_NAME\t$(docker images --format $1 $DMAAP_MED_IMAGE)" >>   $2
53         if [ ! -z "$DMAAP_MED_IMAGE_SOURCE" ]; then
54                 echo -e "-- source image --\t$(docker images --format $1 $DMAAP_MED_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 __DMAAPMED_kube_scale_zero() {
62         __kube_scale_all_resources $KUBE_NONRTRIC_NAMESPACE autotest DMAAPMED
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 __DMAAPMED_kube_scale_zero_and_wait() {
68         __kube_scale_and_wait_all_resources $KUBE_NONRTRIC_NAMESPACE app "$KUBE_NONRTRIC_NAMESPACE"-dmaapmediatorservice
69 }
70
71 # Delete all kube resouces for the app
72 # This function is called for apps managed by the test script.
73 __DMAAPMED_kube_delete_all() {
74         __kube_delete_all_resources $KUBE_NONRTRIC_NAMESPACE autotest DMAAPMED
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 __DMAAPMED_store_docker_logs() {
81         if [ $RUNMODE == "KUBE" ]; then
82                 kubectl  logs -l "autotest=DMAAPMED" -n $KUBE_NONRTRIC_NAMESPACE --tail=-1 > $1$2_dmaapmediator.log 2>&1
83         else
84                 docker logs $DMAAP_MED_APP_NAME > $1$2_dmaapmediator.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 __DMAAPMED_initial_setup() {
92         use_dmaapmed_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 __DMAAPMED_statisics_setup() {
100         if [ $RUNMODE == "KUBE" ]; then
101                 echo "DMAAPMED $DMAAP_MED_APP_NAME $KUBE_NONRTRIC_NAMESPACE"
102         else
103                 echo "DMAAPMED $DMAAP_MED_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 __DMAAPMED_test_requirements() {
110         :
111 }
112
113 #######################################################
114
115 # Set http as the protocol to use for all communication to the Dmaap mediator
116 # args: -
117 # (Function for test scripts)
118 use_dmaapmed_http() {
119         __dmaapmed_set_protocoll "http" $DMAAP_MED_INTERNAL_PORT $DMAAP_MED_EXTERNAL_PORT
120 }
121
122 # Set https as the protocol to use for all communication to the Dmaap mediator
123 # args: -
124 # (Function for test scripts)
125 use_dmaapmed_https() {
126         __dmaapmed_set_protocoll "https" $DMAAP_MED_INTERNAL_SECURE_PORT $DMAAP_MED_EXTERNAL_SECURE_PORT
127 }
128
129 # Setup paths to svc/container for internal and external access
130 # args: <protocol> <internal-port> <external-port>
131 __dmaapmed_set_protocoll() {
132         echo -e $BOLD"$DMAAP_MED_DISPLAY_NAME protocol setting"$EBOLD
133         echo -e " Using $BOLD $1 $EBOLD towards $DMAAP_MED_DISPLAY_NAME"
134
135         ## Access to Dmaap mediator
136
137         DMAAP_MED_SERVICE_PATH=$1"://"$DMAAP_MED_APP_NAME":"$2  # docker access, container->container and script->container via proxy
138         if [ $RUNMODE == "KUBE" ]; then
139                 DMAAP_MED_SERVICE_PATH=$1"://"$DMAAP_MED_APP_NAME.$KUBE_NONRTRIC_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
140         fi
141
142         # DMAAP_MED_ADAPTER used for switching between REST and DMAAP (only REST supported currently)
143         DMAAP_MED_ADAPTER_TYPE="REST"
144         DMAAP_MED_ADAPTER=$DMAAP_MED_SERVICE_PATH
145
146         echo ""
147 }
148
149 # Export env vars for config files, docker compose and kube resources
150 # args: PROXY|NOPROXY
151 __dmaapmed_export_vars() {
152
153         export DMAAP_MED_APP_NAME
154         export DMAAP_MED_DISPLAY_NAME
155
156         export KUBE_NONRTRIC_NAMESPACE
157         export DOCKER_SIM_NWNAME
158
159         export DMAAP_MED_IMAGE
160
161         export DMAAP_MED_INTERNAL_PORT
162         export DMAAP_MED_INTERNAL_SECURE_PORT
163         export DMAAP_MED_EXTERNAL_PORT
164         export DMAAP_MED_EXTERNAL_SECURE_PORT
165
166         export DMAAP_MED_DATA_MOUNT_PATH
167         export DMAAP_MED_HOST_MNT_DIR
168         export DMAAP_MED_DATA_FILE
169         export DMAAP_MED_DATA_CONFIGMAP_NAME=$DMAAP_MED_APP_NAME"-data"
170
171         if [ $1 == "PROXY" ]; then
172                 export DMAAP_MED_HTTP_PROXY_CONFIG_PORT=$HTTP_PROXY_CONFIG_PORT  #Set if proxy is started
173                 export DMAAP_MED_HTTP_PROXY_CONFIG_HOST_NAME=$HTTP_PROXY_CONFIG_HOST_NAME #Set if proxy is started
174                 if [ $DMAAP_MED_HTTP_PROXY_CONFIG_PORT -eq 0 ] || [ -z "$DMAAP_MED_HTTP_PROXY_CONFIG_HOST_NAME" ]; then
175                         echo -e $YELLOW" Warning: HTTP PROXY will not be configured, proxy app not started"$EYELLOW
176                 else
177                         echo " Configured with http proxy"
178                 fi
179         else
180                 export DMAAP_MED_HTTP_PROXY_CONFIG_PORT=0
181                 export DMAAP_MED_HTTP_PROXY_CONFIG_HOST_NAME=""
182                 echo " Configured without http proxy"
183         fi
184
185         # paths to other components
186         export ICS_SERVICE_PATH
187
188         export DMAAP_MED_CONF_SELF_HOST=$(echo $DMAAP_MED_SERVICE_PATH | cut -d: -f1-2)
189         export DMAAP_MED_CONF_SELF_PORT=$(echo $DMAAP_MED_SERVICE_PATH | cut -d: -f3)
190         export MR_SERVICE_PATH
191 }
192
193 # Start the Dmaap mediator
194 # args: -
195 # (Function for test scripts)
196 start_dmaapmed() {
197
198         echo -e $BOLD"Starting $DMAAP_MED_DISPLAY_NAME"$EBOLD
199
200         if [ $RUNMODE == "KUBE" ]; then
201
202                 # Check if app shall be fully managed by the test script
203                 __check_included_image "DMAAPMED"
204                 retcode_i=$?
205
206                 # Check if app shall only be used by the testscipt
207                 __check_prestarted_image "DMAAPMED"
208                 retcode_p=$?
209
210                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
211                         echo -e $RED"The $DMAAP_MED_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
212                         echo -e $RED"The $DMAAP_MED_APP_NAME will not be started"$ERED
213                         exit
214                 fi
215                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
216                         echo -e $RED"The $DMAAP_MED_APP_NAME app is included both as managed and prestarted in this test script"$ERED
217                         echo -e $RED"The $DMAAP_MED_APP_NAME will not be started"$ERED
218                         exit
219                 fi
220
221                 # Check if app shall be used - not managed - by the test script
222                 if [ $retcode_p -eq 0 ]; then
223                         echo -e " Using existing $DMAAP_MED_APP_NAME deployment and service"
224                         echo " Setting DMAAPMED replicas=1"
225                         __kube_scale statefulset $DMAAP_MED_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
226                 fi
227
228                 if [ $retcode_i -eq 0 ]; then
229                         echo -e " Creating $DMAAP_MED_APP_NAME deployment and service"
230
231                         __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
232
233                         __dmaapmed_export_vars $1
234
235                         # Create config map for data
236                         data_json=$PWD/tmp/$DMAAP_MED_DATA_FILE
237                         if [ $# -lt 2 ]; then
238                                 #create empty dummy file
239                                 echo "{}" > $data_json
240                         else
241                                 cp $2 $data_json
242                         fi
243                         output_yaml=$PWD/tmp/dmaapmed_cfd.yaml
244                         __kube_create_configmap $DMAAP_MED_DATA_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest DMAAPMED $data_json $output_yaml
245
246                         # Create service
247                         input_yaml=$SIM_GROUP"/"$DMAAP_MED_COMPOSE_DIR"/"svc.yaml
248                         output_yaml=$PWD/tmp/dmaapmed_svc.yaml
249                         __kube_create_instance service $DMAAP_MED_APP_NAME $input_yaml $output_yaml
250
251                         # Create app
252                         input_yaml=$SIM_GROUP"/"$DMAAP_MED_COMPOSE_DIR"/"app.yaml
253                         output_yaml=$PWD/tmp/dmaapmed_app.yaml
254                         __kube_create_instance app $DMAAP_MED_APP_NAME $input_yaml $output_yaml
255
256                 fi
257
258                 __check_service_start $DMAAP_MED_APP_NAME $DMAAP_MED_SERVICE_PATH$DMAAP_MED_ALIVE_URL
259
260         else
261                 # Check if docker app shall be fully managed by the test script
262                 __check_included_image 'DMAAPMED'
263                 if [ $? -eq 1 ]; then
264                         echo -e $RED"The $DMAAP_MED_DISPLAY_NAME app is not included in this test script"$ERED
265                         echo -e $RED"The $DMAAP_MED_DISPLAY_NAME will not be started"$ERED
266                         exit
267                 fi
268
269                 __dmaapmed_export_vars $1
270
271                 dest_file=$SIM_GROUP/$DMAAP_MED_COMPOSE_DIR/$DMAAP_MED_HOST_MNT_DIR/$DMAAP_MED_DATA_FILE
272
273                 envsubst < $2 > $dest_file
274
275                 __start_container $DMAAP_MED_COMPOSE_DIR "" NODOCKERARGS 1 $DMAAP_MED_APP_NAME
276
277                 __check_service_start $DMAAP_MED_APP_NAME $DMAAP_MED_SERVICE_PATH$DMAAP_MED_ALIVE_URL
278         fi
279         echo ""
280 }