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 managemnt functions for Http Proxy
22 ################ Test engine functions ################
24 # Create the image var used during the test
25 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
26 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
27 __HTTPPROXY_imagesetup() {
28 __check_and_create_image_var HTTPPROXY "HTTP_PROXY_IMAGE" "HTTP_PROXY_IMAGE_BASE" "HTTP_PROXY_IMAGE_TAG" LOCAL "$HTTP_PROXY_DISPLAY_NAME"
31 # Pull image from remote repo or use locally built image
32 # arg: <pull-policy-override> <pull-policy-original>
33 # <pull-policy-override> Shall be used for images allowing overriding. For example use a local image when test is started to use released images
34 # <pull-policy-original> Shall be used for images that does not allow overriding
35 # Both var may contain: 'remote', 'remote-remove' or 'local'
36 __HTTPPROXY_imagepull() {
37 __check_and_pull_image $2 "$HTTP_PROXY_DISPLAY_NAME" $HTTP_PROXY_APP_NAME HTTP_PROXY_IMAGE
40 # Build image (only for simulator or interfaces stubs owned by the test environment)
41 # arg: <image-tag-suffix> (selects staging, snapshot, release etc)
42 # <image-tag-suffix> is present only for images with staging, snapshot,release tags
43 __HTTPPROXY_imagebuild() {
44 cd ../$HTTP_PROXY_BUILD_DIR # Note: Reusing same impl as for kube proxy
45 echo " Building HTTPPROXY - $HTTP_PROXY_DISPLAY_NAME - image: $HTTP_PROXY_IMAGE"
46 docker build --build-arg NEXUS_PROXY_REPO=$NEXUS_PROXY_REPO -t $HTTP_PROXY_IMAGE . &> .dockererr
48 echo -e $GREEN" Build Ok"$EGREEN
49 __retag_and_push_image HTTP_PROXY_IMAGE
54 echo -e $RED" Build Failed"$ERED
57 echo -e $RED"Exiting...."$ERED
62 # Generate a string for each included image using the app display name and a docker images format string
63 # If a custom image repo is used then also the source image from the local repo is listed
64 # arg: <docker-images-format-string> <file-to-append>
65 __HTTPPROXY_image_data() {
66 echo -e "$HTTP_PROXY_DISPLAY_NAME\t$(docker images --format $1 $HTTP_PROXY_IMAGE)" >> $2
67 if [ ! -z "$HTTP_PROXY_IMAGE_SOURCE" ]; then
68 echo -e "-- source image --\t$(docker images --format $1 $HTTP_PROXY_IMAGE_SOURCE)" >> $2
72 # Scale kubernetes resources to zero
73 # All resources shall be ordered to be scaled to 0, if relevant. If not relevant to scale, then do no action.
74 # This function is called for apps fully managed by the test script
75 __HTTPPROXY_kube_scale_zero() {
76 __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest HTTPPROXY
79 # Scale kubernetes resources to zero and wait until this has been accomplished, if relevant. If not relevant to scale, then do no action.
80 # This function is called for prestarted apps not managed by the test script.
81 __HTTPPROXY_kube_scale_zero_and_wait() {
82 echo -e $RED" HTTPPROXY app is not scaled in this state"$ERED
85 # Delete all kube resouces for the app
86 # This function is called for apps managed by the test script.
87 __HTTPPROXY_kube_delete_all() {
88 __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest HTTPPROXY
92 # This function is called for apps managed by the test script.
93 # args: <log-dir> <file-prexix>
94 __HTTPPROXY_store_docker_logs() {
95 if [ $RUNMODE == "KUBE" ]; then
96 kubectl logs -l "autotest=HTTPPROXY" -n $KUBE_SIM_NAMESPACE --tail=-1 > $1$2_httpproxy.log 2>&1
98 docker logs $HTTP_PROXY_APP_NAME > $1$2_httpproxy.log 2>&1
102 # Initial setup of protocol, host and ports
103 # This function is called for apps managed by the test script.
105 __HTTPPROXY_initial_setup() {
109 # Set app short-name, app name and namespace for logging runtime statistics of kubernets pods or docker containers
110 # For docker, the namespace shall be excluded
111 # This function is called for apps managed by the test script as well as for prestarted apps.
113 __HTTPPROXY_statisics_setup() {
114 if [ $RUNMODE == "KUBE" ]; then
115 echo "HTTPPROXY $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE"
117 echo "HTTPPROXY $HTTP_PROXY_APP_NAME"
121 #######################################################
123 # Set http as the protocol to use for all communication to the http proxy
125 # (Function for test scripts)
126 use_http_proxy_http() {
127 __http_proxy_set_protocoll "http" $HTTP_PROXY_INTERNAL_PORT $HTTP_PROXY_EXTERNAL_PORT
130 # Set https as the protocol to use for all communication to the http proxy
132 # (Function for test scripts)
133 use_http_proxy_https() {
134 __http_proxy_set_protocoll "https" $HTTP_PROXY_INTERNAL_SECURE_PORT $HTTP_PROXY_EXTERNAL_SECURE_PORT
137 # Setup paths to svc/container for internal and external access
138 # args: <protocol> <internal-port> <external-port>
139 __http_proxy_set_protocoll() {
140 echo -e $BOLD"$HTTP_PROXY_DISPLAY_NAME protocol setting"$EBOLD
141 echo -e " Using $BOLD $1 $EBOLD towards $HTTP_PROXY_DISPLAY_NAME"
143 ## Access to http proxy
144 ## HTTP_PROXY_CONFIG_HOST_NAME and HTTP_PROXY_CONFIG_PORT used by apps as config for proxy host and port
146 HTTP_PROXY_SERVICE_PATH=$1"://"$HTTP_PROXY_APP_NAME":"$2 # docker access, container->container and script->container via proxy
147 HTTP_PROXY_CONFIG_HOST_NAME=$HTTP_PROXY_APP_NAME
148 HTTP_PROXY_CONFIG_PORT=$2
149 if [ $RUNMODE == "KUBE" ]; then
150 HTTP_PROXY_CONFIG_HOST_NAME=$HTTP_PROXY_APP_NAME"."$KUBE_SIM_NAMESPACE
151 HTTP_PROXY_CONFIG_PORT=$3
152 HTTP_PROXY_SERVICE_PATH=$1"://"$HTTP_PROXY_APP_NAME.$KUBE_SIM_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
158 # Export env vars for config files, docker compose and kube resources
160 __http_proxy_export_vars() {
162 export HTTP_PROXY_APP_NAME
163 export HTTP_PROXY_DISPLAY_NAME
165 export HTTP_PROXY_WEB_EXTERNAL_PORT
166 export HTTP_PROXY_WEB_INTERNAL_PORT
167 export HTTP_PROXY_EXTERNAL_PORT
168 export HTTP_PROXY_INTERNAL_PORT
170 export HTTP_PROXY_WEB_EXTERNAL_SECURE_PORT
171 export HTTP_PROXY_WEB_INTERNAL_SECURE_PORT
172 export HTTP_PROXY_EXTERNAL_SECURE_PORT
173 export HTTP_PROXY_INTERNAL_SECURE_PORT
175 export KUBE_SIM_NAMESPACE
176 export DOCKER_SIM_NWNAME
177 export HTTP_PROXY_IMAGE
180 # Start the Http Proxy in the simulator group
182 # (Function for test scripts)
185 echo -e $BOLD"Starting $HTTP_PROXY_DISPLAY_NAME"$EBOLD
187 if [ $RUNMODE == "KUBE" ]; then
189 # Check if app shall be fully managed by the test script
190 __check_included_image "HTTPPROXY"
193 # Check if app shall only be used by the testscipt
194 __check_prestarted_image "HTTPPROXY"
197 if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then
198 echo -e $RED"The $HTTP_PROXY_APP_NAME app is not included as managed nor prestarted in this test script"$ERED
199 echo -e $RED"The $HTTP_PROXY_APP_NAME will not be started"$ERED
202 if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then
203 echo -e $RED"The $HTTP_PROXY_APP_NAME app is included both as managed and prestarted in this test script"$ERED
204 echo -e $RED"The $HTTP_PROXY_APP_NAME will not be started"$ERED
208 # Check if app shall be used - not managed - by the test script
209 if [ $retcode_p -eq 0 ]; then
210 echo -e " Using existing $HTTP_PROXY_APP_NAME deployment and service"
211 echo " Setting HTTPPROXY replicas=1"
212 __kube_scale deployment $HTTP_PROXY_APP_NAME $KUBE_SIM_NAMESPACE 1
215 if [ $retcode_i -eq 0 ]; then
216 echo -e " Creating $HTTP_PROXY_APP_NAME deployment and service"
218 __kube_create_namespace $KUBE_SIM_NAMESPACE
220 __http_proxy_export_vars
223 input_yaml=$SIM_GROUP"/"$HTTP_PROXY_COMPOSE_DIR"/"svc.yaml
224 output_yaml=$PWD/tmp/proxy_svc.yaml
225 __kube_create_instance service $HTTP_PROXY_APP_NAME $input_yaml $output_yaml
228 input_yaml=$SIM_GROUP"/"$HTTP_PROXY_COMPOSE_DIR"/"app.yaml
229 output_yaml=$PWD/tmp/proxy_app.yaml
230 __kube_create_instance app $HTTP_PROXY_APP_NAME $input_yaml $output_yaml
234 __check_service_start $HTTP_PROXY_APP_NAME $HTTP_PROXY_SERVICE_PATH$HTTP_PROXY_ALIVE_URL
237 # Check if docker app shall be fully managed by the test script
238 __check_included_image 'HTTPPROXY'
239 if [ $? -eq 1 ]; then
240 echo -e $RED"The Http Proxy app is not included in this test script"$ERED
241 echo -e $RED"The Http Proxy will not be started"$ERED
245 __http_proxy_export_vars
247 __start_container $HTTP_PROXY_COMPOSE_DIR "" NODOCKERARGS 1 $HTTP_PROXY_APP_NAME
249 __check_service_start $HTTP_PROXY_APP_NAME $HTTP_PROXY_SERVICE_PATH$HTTP_PROXY_ALIVE_URL