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 functions
21 # for NonRTRIC Gateway
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 NGW "NRT_GATEWAY_IMAGE" "NRT_GATEWAY_IMAGE_BASE" "NRT_GATEWAY_IMAGE_TAG" $1 "$NRT_GATEWAY_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 "$NRT_GATEWAY_DISPLAY_NAME" $NRT_GATEWAY_APP_NAME NRT_GATEWAY_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 NGW 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 "$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
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
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"
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
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
84 docker logs $NRT_GATEWAY_APP_NAME > $1$2_gateway.log 2>&1
88 # Initial setup of protocol, host and ports
89 # This function is called for apps managed by the test script.
91 __NGW_initial_setup() {
95 #######################################################
101 # Set http as the protocol to use for all communication to the nonrtric gateway
103 # (Function for test scripts)
105 __gateway_set_protocoll "http" $NRT_GATEWAY_INTERNAL_PORT $NRT_GATEWAY_EXTERNAL_PORT
108 # Set https as the protocol to use for all communication to the nonrtric gateway
110 # (Function for test scripts)
111 use_gateway_https() {
112 __gateway_set_protocoll "https" $NRT_GATEWAY_INTERNAL_SECURE_PORT $NRT_GATEWAY_EXTERNAL_SECURE_PORT
115 # Setup paths to svc/container for internal and external access
116 # args: <protocol> <internal-port> <external-port>
117 __gateway_set_protocoll() {
118 echo -e $BOLD"$NRT_GATEWAY_DISPLAY_NAME protocol setting"$EBOLD
119 echo -e " Using $BOLD http $EBOLD towards $NRT_GATEWAY_DISPLAY_NAME"
121 ## Access to nonrtric gateway
123 NRT_GATEWAY_SERVICE_PATH=$1"://"$NRT_GATEWAY_APP_NAME":"$2 # docker access, container->container and script->container via proxy
124 if [ $RUNMODE == "KUBE" ]; then
125 NRT_GATEWAY_SERVICE_PATH=$1"://"$NRT_GATEWAY_APP_NAME.$KUBE_NONRTRIC_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
128 # NRT_GATEWAY_ADAPTER used for switching between REST and DMAAP (only REST supported currently)
129 NRT_GATEWAY_ADAPTER_TYPE="REST"
130 NRT_GATEWAY_ADAPTER=$DMAAP_ADP_SERVICE_PATH
135 # Turn on debug level tracing in the gateway
137 # (Function for test scripts)
138 set_gateway_debug() {
139 echo -e $BOLD"Setting gateway debug logging"$EBOLD
140 curlString="$NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ACTUATOR -X POST -H Content-Type:application/json -d {\"configuredLevel\":\"debug\"}"
141 result=$(__do_curl "$curlString")
142 if [ $? -ne 0 ]; then
143 __print_err "could not set debug mode" $@
151 # Turn on trace level tracing in the gateway
153 # (Function for test scripts)
154 set_gateway_trace() {
155 echo -e $BOLD"Setting gateway trace logging"$EBOLD
156 curlString="$NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ACTUATOR -X POST -H Content-Type:application/json -d {\"configuredLevel\":\"trace\"}"
157 result=$(__do_curl "$curlString")
158 if [ $? -ne 0 ]; then
159 __print_err "could not set trace mode" $@
167 # Export env vars for config files, docker compose and kube resources
169 __gateway_export_vars() {
171 export NRT_GATEWAY_APP_NAME
172 export NRT_GATEWAY_DISPLAY_NAME
174 export KUBE_NONRTRIC_NAMESPACE
175 export DOCKER_SIM_NWNAME
177 export NRT_GATEWAY_IMAGE
178 export NRT_GATEWAY_INTERNAL_PORT
179 export NRT_GATEWAY_INTERNAL_SECURE_PORT
180 export NRT_GATEWAY_EXTERNAL_PORT
181 export NRT_GATEWAY_EXTERNAL_SECURE_PORT
182 export NRT_GATEWAY_CONFIG_MOUNT_PATH
183 export NRT_GATEWAY_CONFIG_FILE
184 export NGW_CONFIG_CONFIGMAP_NAME=$NRT_GATEWAY_APP_NAME"-config"
185 export NRT_GATEWAY_HOST_MNT_DIR
186 export NRT_GATEWAY_COMPOSE_DIR
188 if [ $RUNMODE == "KUBE" ]; then
189 export POLICY_AGENT_EXTERNAL_SECURE_PORT
190 export ECS_EXTERNAL_SECURE_PORT
191 export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
192 export ECS_DOMAIN_NAME=$ECS_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
194 export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME
195 export ECS_DOMAIN_NAME=$ECS_APP_NAME
199 # Start the Gateway container
201 # (Function for test scripts)
204 echo -e $BOLD"Starting $NRT_GATEWAY_DISPLAY_NAME"$EBOLD
206 if [ $RUNMODE == "KUBE" ]; then
208 # Check if app shall be fully managed by the test script
209 __check_included_image "NGW"
212 # Check if app shall only be used by the testscipt
213 __check_prestarted_image "NGW"
216 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
217 echo -e $RED"The $NRT_GATEWAY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
218 echo -e $RED"The $NRT_GATEWAY_APP_NAME will not be started"$ERED
221 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
222 echo -e $RED"The $NRT_GATEWAY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
223 echo -e $RED"The $NRT_GATEWAY_APP_NAME will not be started"$ERED
227 # Check if app shall be used - not managed - by the test script
228 __check_prestarted_image "NGW"
229 if [ $? -eq 0 ]; then
230 echo -e " Using existing $NRT_GATEWAY_APP_NAME deployment and service"
231 echo " Setting NGW replicas=1"
232 __kube_scale deployment $NRT_GATEWAY_APP_NAME $KUBE_NONRTRIC_NAMESPACE 1
235 if [ $retcode_i -eq 0 ]; then
237 echo -e " Creating $NRT_GATEWAY_APP_NAME app and expose service"
239 __gateway_export_vars
241 #Check if nonrtric namespace exists, if not create it
242 __kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
244 # Create config map for config
245 datafile=$PWD/tmp/$NRT_GATEWAY_CONFIG_FILE
246 #Add config to properties file
247 envsubst < $1 > $datafile
248 output_yaml=$PWD/tmp/ngw_cfc.yaml
249 __kube_create_configmap $NGW_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest NGW $datafile $output_yaml
252 input_yaml=$SIM_GROUP"/"$NRT_GATEWAY_COMPOSE_DIR"/"svc.yaml
253 output_yaml=$PWD/tmp/ngw_svc.yaml
254 __kube_create_instance service $NRT_GATEWAY_APP_NAME $input_yaml $output_yaml
257 input_yaml=$SIM_GROUP"/"$NRT_GATEWAY_COMPOSE_DIR"/"app.yaml
258 output_yaml=$PWD/tmp/ngw_app.yaml
259 __kube_create_instance app $NRT_GATEWAY_APP_NAME $input_yaml $output_yaml
263 __check_service_start $NRT_GATEWAY_APP_NAME $NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ALIVE_URL
266 # Check if docker app shall be fully managed by the test script
267 __check_included_image 'NGW'
268 if [ $? -eq 1 ]; then
269 echo -e $RED"The Gateway app is not included in this test script"$ERED
270 echo -e $RED"The Gateway will not be started"$ERED
274 __gateway_export_vars
276 dest_file=$SIM_GROUP/$NRT_GATEWAY_COMPOSE_DIR/$NRT_GATEWAY_HOST_MNT_DIR/$NRT_GATEWAY_CONFIG_FILE
278 envsubst < $1 > $dest_file
280 __start_container $NRT_GATEWAY_COMPOSE_DIR "" NODOCKERARGS 1 $NRT_GATEWAY_APP_NAME
282 __check_service_start $NRT_GATEWAY_APP_NAME $NRT_GATEWAY_SERVICE_PATH$NRT_GATEWAY_ALIVE_URL
288 # API Test function: V2 GET /status towards PMS
289 # args: <response-code>
290 # (Function for test scripts)
291 gateway_pms_get_status() {
293 if [ $# -ne 1 ]; then
294 __print_err "<response-code>" $@
297 query=$PMS_API_PREFIX"/v2/status"
298 res="$(__do_curl_to_api NGW GET $query)"
299 status=${res:${#res}-3}
301 if [ $status -ne $1 ]; then
302 __log_test_fail_status_code $1 $status
310 # API Test function: GET /ei-producer/v1/eitypes towards ECS
311 # Note: This is just to test service response
312 # args: <response-code>
313 # (Function for test scripts)
314 gateway_ecs_get_types() {
316 if [ $# -ne 1 ]; then
317 __print_err "<response-code>" $@
320 query="/ei-producer/v1/eitypes"
321 res="$(__do_curl_to_api NGW GET $query)"
322 status=${res:${#res}-3}
324 if [ $status -ne $1 ]; then
325 __log_test_fail_status_code $1 $status