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
10 # http://www.apache.org/licenses/LICENSE-2.0
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=================================================
20 # This is a script that contains container/service management function
21 # and test functions for Control Panel
23 ################ Test engine functions ################
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
29 __check_and_create_image_var CP "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_IMAGE_BASE" "CONTROL_PANEL_IMAGE_TAG" $1 "$CONTROL_PANEL_DISPLAY_NAME"
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'
38 __check_and_pull_image $1 "$CONTROL_PANEL_DISPLAY_NAME" $CONTROL_PANEL_APP_NAME CONTROL_PANEL_IMAGE
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
45 echo -e $RED" Image for app CP shall never be built"$ERED
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>
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
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
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"
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
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 logs -l "autotest=CP" -n $KUBE_NONRTRIC_NAMESPACE --tail=-1 > $1$2_control-panel.log 2>&1
84 docker logs $CONTROL_PANEL_APP_NAME > $1$2_control-panel.log 2>&1
88 # Initial setup of protocol, host and ports
89 # This function is called for apps managed by the test script.
91 __CP_initial_setup() {
92 use_control_panel_http
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.
99 __CP_statisics_setup() {
100 if [ $RUNMODE == "KUBE" ]; then
101 echo "CP $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE"
103 echo "CP $CONTROL_PANEL_APP_NAME"
107 #######################################################
110 ###########################
111 ### Control Panel functions
112 ###########################
114 # Set http as the protocol to use for all communication to the Control Panel
116 # (Function for test scripts)
117 use_control_panel_http() {
118 __control_panel_set_protocoll "http" $CONTROL_PANEL_INTERNAL_PORT $CONTROL_PANEL_EXTERNAL_PORT
121 # Set https as the protocol to use for all communication to the Control Panel
123 # (Function for test scripts)
124 use_control_panel_https() {
125 __control_panel_set_protocoll "https" $CONTROL_PANEL_INTERNAL_SECURE_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT
128 # Setup paths to svc/container for internal and external access
129 # args: <protocol> <internal-port> <external-port>
130 __control_panel_set_protocoll() {
131 echo -e $BOLD"$CONTROL_PANEL_DISPLAY_NAME protocol setting"$EBOLD
132 echo -e " Using $BOLD $1 $EBOLD towards $CONTROL_PANEL_DISPLAY_NAME"
134 CP_SERVICE_PATH=$1"://"$CONTROL_PANEL_APP_NAME":"$2
135 if [ $RUNMODE == "KUBE" ]; then
136 CP_SERVICE_PATH=$1"://"$CONTROL_PANEL_APP_NAME.$KUBE_NONRTRIC_NAMESPACE":"$3
141 # Export env vars for config files, docker compose and kube resources
143 __control_panel_export_vars() {
144 #Export all vars needed for service and deployment
145 export CONTROL_PANEL_APP_NAME
146 export CONTROL_PANEL_DISPLAY_NAME
147 export KUBE_NONRTRIC_NAMESPACE
148 export DOCKER_SIM_NWNAME
150 export CONTROL_PANEL_IMAGE
151 export CONTROL_PANEL_INTERNAL_PORT
152 export CONTROL_PANEL_INTERNAL_SECURE_PORT
153 export CONTROL_PANEL_EXTERNAL_PORT
154 export CONTROL_PANEL_EXTERNAL_SECURE_PORT
155 export CONTROL_PANEL_CONFIG_MOUNT_PATH
156 export CONTROL_PANEL_CONFIG_FILE
157 export CONTROL_PANEL_HOST_MNT_DIR
159 export CP_CONFIG_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-config"
160 export CP_PROXY_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-proxy"
162 export CONTROL_PANEL_PATH_POLICY_PREFIX
163 export CONTROL_PANEL_PATH_ICS_PREFIX
164 export CONTROL_PANEL_PATH_ICS_PREFIX2
166 export NRT_GATEWAY_APP_NAME
167 export NRT_GATEWAY_EXTERNAL_PORT
169 export POLICY_AGENT_EXTERNAL_SECURE_PORT
170 export ICS_EXTERNAL_SECURE_PORT
172 if [ $RUNMODE == "KUBE" ]; then
173 export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME.$KUBE_NONRTRIC_NAMESPACE.svc.cluster.local # suffix needed for nginx name resolution
174 export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_KUBE_RESOLVER
176 export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME
177 export ICS_DOMAIN_NAME=$ICS_APP_NAME
179 export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME
180 export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_DOCKER_RESOLVER
184 # Start the Control Panel container
186 # (Function for test scripts)
187 start_control_panel() {
189 echo -e $BOLD"Starting $CONTROL_PANEL_DISPLAY_NAME"$EBOLD
191 if [ $RUNMODE == "KUBE" ]; then
193 # Check if app shall be fully managed by the test script
194 __check_included_image "CP"
197 # Check if app shall only be used by the testscipt
198 __check_prestarted_image "CP"
201 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
202 echo -e $RED"The $CONTROL_PANEL_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
203 echo -e $RED"The $CONTROL_PANEL_APP_NAME will not be started"$ERED
206 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
207 echo -e $RED"The $CONTROL_PANEL_APP_NAME app is included both as managed and prestarted in this test script"$ERED
208 echo -e $RED"The $CONTROL_PANEL_APP_NAME will not be started"$ERED
212 # Check if app shall be used - not managed - by the test script
213 __check_prestarted_image "CP"
214 if [ $? -eq 0 ]; then
215 echo -e " Using existing $CONTROL_PANEL_APP_NAME deployment and service"
216 echo " Setting CP replicas=1"
217 __kube_scale deployment $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
220 if [ $retcode_i -eq 0 ]; then
222 echo -e " Creating $CONTROL_PANEL_APP_NAME app and expose service"
224 __control_panel_export_vars
226 #Check if nonrtric namespace exists, if not create it
227 __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
229 # Create config map for config
230 datafile=$PWD/tmp/$CONTROL_PANEL_CONFIG_FILE
231 #Add config to properties file
233 #Trick to prevent these two vars to be replace with space in the config file by cmd envsubst
234 export upstream='$upstream'
237 envsubst < $1 > $datafile
239 output_yaml=$PWD/tmp/cp_cfc.yaml
240 __kube_create_configmap $CP_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest CP $datafile $output_yaml
243 input_yaml=$SIM_GROUP"/"$CONTROL_PANEL_COMPOSE_DIR"/"svc.yaml
244 output_yaml=$PWD/tmp/cp_svc.yaml
245 __kube_create_instance service $CONTROL_PANEL_APP_NAME $input_yaml $output_yaml
248 input_yaml=$SIM_GROUP"/"$CONTROL_PANEL_COMPOSE_DIR"/"app.yaml
249 output_yaml=$PWD/tmp/cp_app.yaml
250 __kube_create_instance app $CONTROL_PANEL_APP_NAME $input_yaml $output_yaml
254 __check_service_start $CONTROL_PANEL_APP_NAME $CP_SERVICE_PATH$CONTROL_PANEL_ALIVE_URL
256 CP_PORT1=$(__kube_get_service_nodeport $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "http")
257 CP_PORT2=$(__kube_get_service_nodeport $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "https")
259 echo " $CONTROL_PANEL_DISPLAY_NAME node ports (http/https): $CP_PORT1 $CP_PORT2"
261 # Check if docker app shall be fully managed by the test script
262 __check_included_image 'CP'
263 if [ $? -eq 1 ]; then
264 echo -e $RED"The Control Panel app is not included in this test script"$ERED
265 echo -e $RED"The Control Panel will not be started"$ERED
269 __control_panel_export_vars
271 dest_file=$SIM_GROUP/$CONTROL_PANEL_COMPOSE_DIR/$CONTROL_PANEL_HOST_MNT_DIR/$CONTROL_PANEL_CONFIG_FILE
273 envsubst '${NGW_DOMAIN_NAME},${CP_NGINX_RESOLVER},${NRT_GATEWAY_EXTERNAL_PORT},${POLICY_AGENT_EXTERNAL_SECURE_PORT},${ICS_EXTERNAL_SECURE_PORT},${POLICY_AGENT_DOMAIN_NAME},${ICS_DOMAIN_NAME},${CONTROL_PANEL_PATH_POLICY_PREFIX},${CONTROL_PANEL_PATH_ICS_PREFIX} ,${CONTROL_PANEL_PATH_ICS_PREFIX2}' < $1 > $dest_file
275 __start_container $CONTROL_PANEL_COMPOSE_DIR "" NODOCKERARGS 1 $CONTROL_PANEL_APP_NAME
277 __check_service_start $CONTROL_PANEL_APP_NAME $CP_SERVICE_PATH$CONTROL_PANEL_ALIVE_URL
279 echo " $CONTROL_PANEL_DISPLAY_NAME locahost ports (http/https): $CONTROL_PANEL_EXTERNAL_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT"