X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcommon%2Fcontrol_panel_api_functions.sh;h=eda6fe3aec631b3a88999ebca26f351da6f84aec;hb=663566c28930429775ea9921f0e32ddf5253da28;hp=9f179a1f209c008b1e98bda22c3bed997cb4b21c;hpb=f0019c8168b9d59f132ba47e939e8aa3ef324b7d;p=nonrtric.git

diff --git a/test/common/control_panel_api_functions.sh b/test/common/control_panel_api_functions.sh
index 9f179a1f..eda6fe3a 100644
--- a/test/common/control_panel_api_functions.sh
+++ b/test/common/control_panel_api_functions.sh
@@ -20,12 +20,79 @@
 # This is a script that contains container/service management function
 # and test functions for Control Panel
 
-## Access to control panel
-# Host name may be changed if app started by kube
-# Direct access from script
-CP_HTTPX="http"
-CP_HOST_NAME=$LOCALHOST_NAME
-CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_PORT
+################ Test engine functions ################
+
+# Create the image var used during the test
+# arg: <image-tag-suffix> (selects staging, snapshot, release etc)
+# <image-tag-suffix> is present only for images with staging, snapshot,release tags
+__CP_imagesetup() {
+	__check_and_create_image_var CP "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_IMAGE_BASE" "CONTROL_PANEL_IMAGE_TAG" $1 "$CONTROL_PANEL_DISPLAY_NAME"
+}
+
+# Pull image from remote repo or use locally built image
+# arg: <pull-policy-override> <pull-policy-original>
+# <pull-policy-override> Shall be used for images allowing overriding. For example use a local image when test is started to use released images
+# <pull-policy-original> Shall be used for images that does not allow overriding
+# Both var may contain: 'remote', 'remote-remove' or 'local'
+__CP_imagepull() {
+	__check_and_pull_image $1 "$CONTROL_PANEL_DISPLAY_NAME" $CONTROL_PANEL_APP_NAME CONTROL_PANEL_IMAGE
+}
+
+# Build image (only for simulator or interfaces stubs owned by the test environment)
+# arg: <image-tag-suffix> (selects staging, snapshot, release etc)
+# <image-tag-suffix> is present only for images with staging, snapshot,release tags
+__CP_imagebuild() {
+	echo -e $RED" Image for app CP shall never be built"$ERED
+}
+
+# Generate a string for each included image using the app display name and a docker images format string
+# If a custom image repo is used then also the source image from the local repo is listed
+# arg: <docker-images-format-string> <file-to-append>
+__CP_image_data() {
+	echo -e "$CONTROL_PANEL_DISPLAY_NAME\t$(docker images --format $1 $CONTROL_PANEL_IMAGE)" >>   $2
+	if [ ! -z "$CONTROL_PANEL_IMAGE_SOURCE" ]; then
+		echo -e "-- source image --\t$(docker images --format $1 $CONTROL_PANEL_IMAGE_SOURCE)" >>   $2
+	fi
+}
+
+# Scale kubernetes resources to zero
+# All resources shall be ordered to be scaled to 0, if relevant. If not relevant to scale, then do no action.
+# This function is called for apps fully managed by the test script
+__CP_kube_scale_zero() {
+	__kube_scale_all_resources $KUBE_NONRTRIC_NAMESPACE autotest CP
+}
+
+# Scale kubernetes resources to zero and wait until this has been accomplished, if relevant. If not relevant to scale, then do no action.
+# This function is called for prestarted apps not managed by the test script.
+__CP_kube_scale_zero_and_wait() {
+	echo -e " CP replicas kept as is"
+}
+
+# Delete all kube resouces for the app
+# This function is called for apps managed by the test script.
+__CP_kube_delete_all() {
+	__kube_delete_all_resources $KUBE_NONRTRIC_NAMESPACE autotest CP
+}
+
+# Store docker logs
+# This function is called for apps managed by the test script.
+# args: <log-dir> <file-prexix>
+__CP_store_docker_logs() {
+	if [ $RUNMODE == "KUBE" ]; then
+		kubectl  logs -l "autotest=CP" -n $KUBE_NONRTRIC_NAMESPACE --tail=-1 > $1$2_control-panel.log 2>&1
+	else
+		docker logs $CONTROL_PANEL_APP_NAME > $1$2_control-panel.log 2>&1
+	fi
+}
+
+# Initial setup of protocol, host and ports
+# This function is called for apps managed by the test script.
+# args: -
+__CP_initial_setup() {
+	use_control_panel_http
+}
+#######################################################
+
 
 ###########################
 ### Control Panel functions
@@ -35,24 +102,72 @@ CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_PORT
 # args: -
 # (Function for test scripts)
 use_control_panel_http() {
-	echo -e $BOLD"Control Panel, CP, protocol setting"$EBOLD
-	echo -e " Using $BOLD http $EBOLD towards CP"
-	CP_HTTPX="http"
-	CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_PORT
-	echo ""
+	__control_panel_set_protocoll "http" $CONTROL_PANEL_INTERNAL_PORT $CONTROL_PANEL_EXTERNAL_PORT
 }
 
 # Set https as the protocol to use for all communication to the Control Panel
 # args: -
 # (Function for test scripts)
 use_control_panel_https() {
-	echo -e $BOLD"Control Panel, CP, protocol setting"$EBOLD
-	echo -e " Using $BOLD https $EBOLD towards CP"
-	CP_HTTPX="https"
-	CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_SECURE_PORT
+	__control_panel_set_protocoll "https" $CONTROL_PANEL_INTERNAL_SECURE_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT
+}
+
+# Setup paths to svc/container for internal and external access
+# args: <protocol> <internal-port> <external-port>
+__control_panel_set_protocoll() {
+	echo -e $BOLD"$CONTROL_PANEL_DISPLAY_NAME protocol setting"$EBOLD
+	echo -e " Using $BOLD http $EBOLD towards $CONTROL_PANEL_DISPLAY_NAME"
+
+	CP_SERVICE_PATH=$1"://"$CONTROL_PANEL_APP_NAME":"$2
+	if [ $RUNMODE == "KUBE" ]; then
+		CP_SERVICE_PATH=$1"://"$CONTROL_PANEL_APP_NAME.$KUBE_NONRTRIC_NAMESPACE":"$3
+	fi
 	echo ""
 }
 
+# Export env vars for config files, docker compose and kube resources
+# args: -
+__control_panel_export_vars() {
+	#Export all vars needed for service and deployment
+	export CONTROL_PANEL_APP_NAME
+	export CONTROL_PANEL_DISPLAY_NAME
+	export KUBE_NONRTRIC_NAMESPACE
+	export DOCKER_SIM_NWNAME
+
+	export CONTROL_PANEL_IMAGE
+	export CONTROL_PANEL_INTERNAL_PORT
+	export CONTROL_PANEL_INTERNAL_SECURE_PORT
+	export CONTROL_PANEL_EXTERNAL_PORT
+	export CONTROL_PANEL_EXTERNAL_SECURE_PORT
+	export CONTROL_PANEL_CONFIG_MOUNT_PATH
+	export CONTROL_PANEL_CONFIG_FILE
+	export CONTROL_PANEL_HOST_MNT_DIR
+
+	export CP_CONFIG_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-config"
+	export CP_PROXY_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-proxy"
+
+	export CONTROL_PANEL_PATH_POLICY_PREFIX
+	export CONTROL_PANEL_PATH_ECS_PREFIX
+	export CONTROL_PANEL_PATH_ECS_PREFIX2
+
+	export NRT_GATEWAY_APP_NAME
+	export NRT_GATEWAY_EXTERNAL_PORT
+
+	export POLICY_AGENT_EXTERNAL_SECURE_PORT
+	export ECS_EXTERNAL_SECURE_PORT
+
+	if [ $RUNMODE == "KUBE" ]; then
+		export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME.$KUBE_NONRTRIC_NAMESPACE.svc.cluster.local  # suffix needed for nginx name resolution
+		export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_KUBE_RESOLVER
+	else
+		export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME
+		export ECS_DOMAIN_NAME=$ECS_APP_NAME
+
+		export NGW_DOMAIN_NAME=$NRT_GATEWAY_APP_NAME
+		export CP_NGINX_RESOLVER=$CONTROL_PANEL_NGINX_DOCKER_RESOLVER
+	fi
+}
+
 # Start the Control Panel container
 # args: -
 # (Function for test scripts)
@@ -91,24 +206,9 @@ start_control_panel() {
 
 		if [ $retcode_i -eq 0 ]; then
 
-			echo -e " Creating $CP_APP_NAME app and expose service"
-
-			#Export all vars needed for service and deployment
-			export CONTROL_PANEL_APP_NAME
-			export KUBE_NONRTRIC_NAMESPACE
-			export CONTROL_PANEL_IMAGE
-			export CONTROL_PANEL_INTERNAL_PORT
-			export CONTROL_PANEL_INTERNAL_SECURE_PORT
-			export CONTROL_PANEL_EXTERNAL_PORT
-			export CONTROL_PANEL_EXTERNAL_SECURE_PORT
-			export CONTROL_PANEL_CONFIG_MOUNT_PATH
-			export CONTROL_PANEL_CONFIG_FILE
-			export CP_CONFIG_CONFIGMAP_NAME=$CONTROL_PANEL_APP_NAME"-config"
-
-			export POLICY_AGENT_EXTERNAL_SECURE_PORT
-			export ECS_EXTERNAL_SECURE_PORT
-			export POLICY_AGENT_DOMAIN_NAME=$POLICY_AGENT_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
-			export ECS_DOMAIN_NAME=$ECS_APP_NAME.$KUBE_NONRTRIC_NAMESPACE
+			echo -e " Creating $CONTROL_PANEL_APP_NAME app and expose service"
+
+			__control_panel_export_vars
 
 			#Check if nonrtric namespace exists, if not create it
 			__kube_create_namespace $KUBE_NONRTRIC_NAMESPACE
@@ -116,7 +216,13 @@ start_control_panel() {
 			# Create config map for config
 			datafile=$PWD/tmp/$CONTROL_PANEL_CONFIG_FILE
 			#Add config to properties file
+
+			#Trick to prevent these two vars to be replace with space in the config file by cmd envsubst
+			export upstream='$upstream'
+			export uri='$uri'
+
 			envsubst < $1 > $datafile
+
 			output_yaml=$PWD/tmp/cp_cfc.yaml
 			__kube_create_configmap $CP_CONFIG_CONFIGMAP_NAME $KUBE_NONRTRIC_NAMESPACE autotest CP $datafile $output_yaml
 
@@ -132,20 +238,12 @@ start_control_panel() {
 
 		fi
 
-		echo " Retrieving host and ports for service..."
-		CP_HOST_NAME=$(__kube_get_service_host $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE)
+		__check_service_start $CONTROL_PANEL_APP_NAME $CP_SERVICE_PATH$CONTROL_PANEL_ALIVE_URL
 
-		CONTROL_PANEL_EXTERNAL_PORT=$(__kube_get_service_port $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "http")
-		CONTROL_PANEL_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "https")
+		CP_PORT1=$(__kube_get_service_nodeport $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "http")
+		CP_PORT2=$(__kube_get_service_nodeport $CONTROL_PANEL_APP_NAME $KUBE_NONRTRIC_NAMESPACE "https")
 
-		echo " Host IP, http port, https port: $CP_HOST_NAME $CONTROL_PANEL_EXTERNAL_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT"
-		if [ $CP_HTTPX == "http" ]; then
-			CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_PORT
-		else
-			CP_PATH=$CP_HTTPX"://"$CP_HOST_NAME":"$CONTROL_PANEL_EXTERNAL_SECURE_PORT
-		fi
-
-		__check_service_start $CONTROL_PANEL_APP_NAME $CP_PATH$CONTROL_PANEL_ALIVE_URL
+		echo " $CONTROL_PANEL_DISPLAY_NAME node ports (http/https): $CP_PORT1 $CP_PORT2"
 	else
 		# Check if docker app shall be fully managed by the test script
 		__check_included_image 'CP'
@@ -155,18 +253,17 @@ start_control_panel() {
 			exit
 		fi
 
-		# Export needed vars for docker compose
-        export CONTROL_PANEL_APP_NAME
-        export CONTROL_PANEL_INTERNAL_PORT
-        export CONTROL_PANEL_EXTERNAL_PORT
-        export CONTROL_PANEL_INTERNAL_SECURE_PORT
-        export CONTROL_PANEL_EXTERNAL_SECURE_PORT
-        export DOCKER_SIM_NWNAME
+		__control_panel_export_vars
+
+		dest_file=$SIM_GROUP/$CONTROL_PANEL_COMPOSE_DIR/$CONTROL_PANEL_HOST_MNT_DIR/$CONTROL_PANEL_CONFIG_FILE
 
-		__start_container $CONTROL_PANEL_COMPOSE_DIR NODOCKERARGS 1 $CONTROL_PANEL_APP_NAME
+		envsubst '${NGW_DOMAIN_NAME},${CP_NGINX_RESOLVER},${NRT_GATEWAY_EXTERNAL_PORT},${POLICY_AGENT_EXTERNAL_SECURE_PORT},${ECS_EXTERNAL_SECURE_PORT},${POLICY_AGENT_DOMAIN_NAME},${ECS_DOMAIN_NAME},${CONTROL_PANEL_PATH_POLICY_PREFIX},${CONTROL_PANEL_PATH_ECS_PREFIX} ,${CONTROL_PANEL_PATH_ECS_PREFIX2}' < $1 > $dest_file
 
-		__check_service_start $CONTROL_PANEL_APP_NAME $CP_PATH$CONTROL_PANEL_ALIVE_URL
+		__start_container $CONTROL_PANEL_COMPOSE_DIR "" NODOCKERARGS 1 $CONTROL_PANEL_APP_NAME
+
+		__check_service_start $CONTROL_PANEL_APP_NAME $CP_SERVICE_PATH$CONTROL_PANEL_ALIVE_URL
+
+		echo " $CONTROL_PANEL_DISPLAY_NAME locahost ports (http/https): $CONTROL_PANEL_EXTERNAL_PORT $CONTROL_PANEL_EXTERNAL_SECURE_PORT"
 	fi
 	echo ""
 }
-