First version of service exposure
[nonrtric.git] / test / common / cp_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 function
21 # and test functions for Control Panel
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 __CP_imagesetup() {
29         __check_and_create_image_var CP "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_IMAGE_BASE" "CONTROL_PANEL_IMAGE_TAG" $1 "$CONTROL_PANEL_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 __CP_imagepull() {
38         __check_and_pull_image $1 "$CONTROL_PANEL_DISPLAY_NAME" $CONTROL_PANEL_APP_NAME CONTROL_PANEL_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 __CP_imagebuild() {
45         echo -e $RED" Image for app CP 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 __CP_image_data() {
52         echo -e "$CONTROL_PANEL_DISPLAY_NAME\t$(docker images --format $1 $CONTROL_PANEL_IMAGE)" >>   $2
53         if [ ! -z "$CONTROL_PANEL_IMAGE_SOURCE" ]; then
54                 echo -e "-- source image --\t$(docker images --format $1 $CONTROL_PANEL_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 __CP_kube_scale_zero() {
62         __kube_scale_all_resources $KUBE_NONRTRIC_NAMESPACE autotest CP
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 __CP_kube_scale_zero_and_wait() {
68         echo -e " CP 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 __CP_kube_delete_all() {
74         __kube_delete_all_resources $KUBE_NONRTRIC_NAMESPACE autotest CP
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 __CP_store_docker_logs() {
81         if [ $RUNMODE == "KUBE" ]; then
82                 kubectl $KUBECONF  logs -l "autotest=CP" -n $KUBE_NONRTRIC_NAMESPACE --tail=-1 > $1$2_control-panel.log 2>&1
83         else
84                 docker logs $CONTROL_PANEL_APP_NAME > $1$2_control-panel.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 __CP_initial_setup() {
92         use_control_panel_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 __CP_statisics_setup() {
100         if [ $RUNMODE == "KUBE" ]; then
101                 echo "CP $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE"
102         else
103                 echo "CP $CONTROL_PANEL_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 __CP_test_requirements() {
110         :
111 }
112
113 #######################################################
114
115
116 ###########################
117 ### Control Panel functions
118 ###########################
119
120 # Set http as the protocol to use for all communication to the Control Panel
121 # args: -
122 # (Function for test scripts)
123 use_control_panel_http() {
124         __control_panel_set_protocoll "http" $CONTROL_PANEL_INTERNAL_PORT $CONTROL_PANEL_EXTERNAL_PORT
125 }
126
127 # Set https as the protocol to use for all communication to the Control Panel
128 # args: -
129 # (Function for test scripts)
130 use_control_panel_https() {
131         __control_panel_set_protocoll "https" $CONTROL_PANEL_INTERNAL_SECURE_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT
132 }
133
134 # Setup paths to svc/container for internal and external access
135 # args: <protocol> <internal-port> <external-port>
136 __control_panel_set_protocoll() {
137         echo -e $BOLD"$CONTROL_PANEL_DISPLAY_NAME protocol setting"$EBOLD
138         echo -e " Using $BOLD $1 $EBOLD towards $CONTROL_PANEL_DISPLAY_NAME"
139
140         CP_SERVICE_PATH=$1"://"$CONTROL_PANEL_APP_NAME":"$2
141         if [ $RUNMODE == "KUBE" ]; then
142                 CP_SERVICE_PATH=$1"://"$CONTROL_PANEL_APP_NAME.$KUBE_NONRTRIC_NAMESPACE":"$3
143         fi
144         echo ""
145 }
146
147 # Export env vars for config files, docker compose and kube resources
148 # args: -
149 __control_panel_export_vars() {
150         #Export all vars needed for service and deployment
151         export CONTROL_PANEL_APP_NAME
152         export CONTROL_PANEL_DISPLAY_NAME
153         export KUBE_NONRTRIC_NAMESPACE
154         export DOCKER_SIM_NWNAME
155
156         export CONTROL_PANEL_IMAGE
157         export CONTROL_PANEL_INTERNAL_PORT
158         export CONTROL_PANEL_INTERNAL_SECURE_PORT
159         export CONTROL_PANEL_EXTERNAL_PORT
160         export CONTROL_PANEL_EXTERNAL_SECURE_PORT
161         export CONTROL_PANEL_CONFIG_MOUNT_PATH
162         export CONTROL_PANEL_CONFIG_FILE
163         export CONTROL_PANEL_HOST_MNT_DIR
164
165         export CP_CONFIG_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-config"
166         export CP_PROXY_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-proxy"
167
168         export CONTROL_PANEL_PATH_POLICY_PREFIX
169         export CONTROL_PANEL_PATH_ICS_PREFIX
170         export CONTROL_PANEL_PATH_ICS_PREFIX2
171
172         export NRT_GATEWAY_APP_NAME
173         export NRT_GATEWAY_EXTERNAL_PORT
174
175         export A1PMS_EXTERNAL_SECURE_PORT
176         export ICS_EXTERNAL_SECURE_PORT
177
178         if [ $RUNMODE == "KUBE" ]; then
179                 export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME.$KUBE_NONRTRIC_NAMESPACE.svc.cluster.local  # suffix needed for nginx name resolution
180                 export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_KUBE_RESOLVER
181         else
182                 export A1PMS_DOMAIN_NAME=$A1PMS_APP_NAME
183                 export ICS_DOMAIN_NAME=$ICS_APP_NAME
184
185                 export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME
186                 export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_DOCKER_RESOLVER
187         fi
188 }
189
190 # Start the Control Panel container
191 # args: -
192 # (Function for test scripts)
193 start_control_panel() {
194
195         echo -e $BOLD"Starting $CONTROL_PANEL_DISPLAY_NAME"$EBOLD
196
197         if [ $RUNMODE == "KUBE" ]; then
198
199                 # Check if app shall be fully managed by the test script
200                 __check_included_image "CP"
201                 retcode_i=$?
202
203                 # Check if app shall only be used by the testscipt
204                 __check_prestarted_image "CP"
205                 retcode_p=$?
206
207                 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
208                         echo -e $RED"The $CONTROL_PANEL_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
209                         echo -e $RED"The $CONTROL_PANEL_APP_NAME will not be started"$ERED
210                         exit
211                 fi
212                 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
213                         echo -e $RED"The $CONTROL_PANEL_APP_NAME app is included both as managed and prestarted in this test script"$ERED
214                         echo -e $RED"The $CONTROL_PANEL_APP_NAME will not be started"$ERED
215                         exit
216                 fi
217
218                 # Check if app shall be used - not managed - by the test script
219                 __check_prestarted_image "CP"
220                 if [ $? -eq 0 ]; then
221                         echo -e " Using existing $CONTROL_PANEL_APP_NAME deployment and service"
222                         echo " Setting CP replicas=1"
223                         __kube_scale deployment $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
224                 fi
225
226                 if [ $retcode_i -eq 0 ]; then
227
228                         echo -e " Creating $CONTROL_PANEL_APP_NAME app and expose service"
229
230                         __control_panel_export_vars
231
232                         #Check if nonrtric namespace exists, if not create it
233                         __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
234
235                         # Create config map for config
236                         datafile=$PWD/tmp/$CONTROL_PANEL_CONFIG_FILE
237                         #Add config to properties file
238
239                         #Trick to prevent these two vars to be replace with space in the config file by cmd envsubst
240                         export upstream='$upstream'
241                         export uri='$uri'
242
243                         envsubst < $1 > $datafile
244
245                         output_yaml=$PWD/tmp/cp_cfc.yaml
246                         __kube_create_configmap $CP_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest CP $datafile $output_yaml
247
248                         # Create service
249                         input_yaml=$SIM_GROUP"/"$CONTROL_PANEL_COMPOSE_DIR"/"svc.yaml
250                         output_yaml=$PWD/tmp/cp_svc.yaml
251                         __kube_create_instance service $CONTROL_PANEL_APP_NAME $input_yaml $output_yaml
252
253                         # Create app
254                         input_yaml=$SIM_GROUP"/"$CONTROL_PANEL_COMPOSE_DIR"/"app.yaml
255                         output_yaml=$PWD/tmp/cp_app.yaml
256                         __kube_create_instance app $CONTROL_PANEL_APP_NAME $input_yaml $output_yaml
257
258                 fi
259
260                 __check_service_start $CONTROL_PANEL_APP_NAME $CP_SERVICE_PATH$CONTROL_PANEL_ALIVE_URL
261
262                 CP_PORT1=$(__kube_get_service_nodeport $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "http")
263                 CP_PORT2=$(__kube_get_service_nodeport $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "https")
264
265                 echo " $CONTROL_PANEL_DISPLAY_NAME node ports (http/https): $CP_PORT1 $CP_PORT2"
266         else
267                 # Check if docker app shall be fully managed by the test script
268                 __check_included_image 'CP'
269                 if [ $? -eq 1 ]; then
270                         echo -e $RED"The Control Panel app is not included in this test script"$ERED
271                         echo -e $RED"The Control Panel will not be started"$ERED
272                         exit
273                 fi
274
275                 __control_panel_export_vars
276
277                 dest_file=$SIM_GROUP/$CONTROL_PANEL_COMPOSE_DIR/$CONTROL_PANEL_HOST_MNT_DIR/$CONTROL_PANEL_CONFIG_FILE
278
279                 envsubst '${NGW_DOMAIN_NAME},${CP_NGINX_RESOLVER},${NRT_GATEWAY_EXTERNAL_PORT},${A1PMS_EXTERNAL_SECURE_PORT},${ICS_EXTERNAL_SECURE_PORT},${A1PMS_DOMAIN_NAME},${ICS_DOMAIN_NAME},${CONTROL_PANEL_PATH_POLICY_PREFIX},${CONTROL_PANEL_PATH_ICS_PREFIX} ,${CONTROL_PANEL_PATH_ICS_PREFIX2}' < $1 > $dest_file
280
281                 __start_container $CONTROL_PANEL_COMPOSE_DIR "" NODOCKERARGS 1 $CONTROL_PANEL_APP_NAME
282
283                 __check_service_start $CONTROL_PANEL_APP_NAME $CP_SERVICE_PATH$CONTROL_PANEL_ALIVE_URL
284
285                 echo " $CONTROL_PANEL_DISPLAY_NAME locahost ports (http/https): $CONTROL_PANEL_EXTERNAL_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT"
286         fi
287         echo ""
288 }