X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcommon%2Fcr_api_functions.sh;h=a537bc85bac40ec83ddc8ee24a4ee1d5537bb2ae;hb=6fc58fd020514c2afce1fc240828bf23f53d8fb6;hp=d587c0c74922b641a40b8771cb40fecb8961e6ba;hpb=be9a07faf8fbc1030404bbc71f409eb5e19736ba;p=nonrtric.git

diff --git a/test/common/cr_api_functions.sh b/test/common/cr_api_functions.sh
index d587c0c7..a537bc85 100644
--- a/test/common/cr_api_functions.sh
+++ b/test/common/cr_api_functions.sh
@@ -35,7 +35,7 @@ __CR_imagesetup() {
 # <pull-policy-original> Shall be used for images that does not allow overriding
 # Both var may contain: 'remote', 'remote-remove' or 'local'
 __CR_imagepull() {
-	echo -e $RED" Image for app CR shall never be pulled from remove repo"$ERED
+	echo -e $RED" Image for app CR shall never be pulled from remote repo"$ERED
 }
 
 # Build image (only for simulator or interfaces stubs owned by the test environment)
@@ -46,9 +46,13 @@ __CR_imagebuild() {
 	echo " Building CR - $CR_DISPLAY_NAME - image: $CR_IMAGE"
 	docker build  --build-arg NEXUS_PROXY_REPO=$NEXUS_PROXY_REPO -t $CR_IMAGE . &> .dockererr
 	if [ $? -eq 0 ]; then
-		echo -e  $GREEN" Build Ok"$EGREEN
+		echo -e  $GREEN"  Build Ok"$EGREEN
+		__retag_and_push_image CR_IMAGE
+		if [ $? -ne 0 ]; then
+			exit 1
+		fi
 	else
-		echo -e $RED" Build Failed"$ERED
+		echo -e $RED"  Build Failed"$ERED
 		((RES_CONF_FAIL++))
 		cat .dockererr
 		echo -e $RED"Exiting...."$ERED
@@ -57,9 +61,13 @@ __CR_imagebuild() {
 }
 
 # 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>
 __CR_image_data() {
 	echo -e "$CR_DISPLAY_NAME\t$(docker images --format $1 $CR_IMAGE)" >>   $2
+	if [ ! -z "$CR_IMAGE_SOURCE" ]; then
+		echo -e "-- source image --\t$(docker images --format $1 $CR_IMAGE_SOURCE)" >>   $2
+	fi
 }
 
 # Scale kubernetes resources to zero
@@ -85,74 +93,94 @@ __CR_kube_delete_all() {
 # This function is called for apps managed by the test script.
 # args: <log-dir> <file-prexix>
 __CR_store_docker_logs() {
-	docker logs $CR_APP_NAME > $1$2_cr.log 2>&1
+	if [ $RUNMODE == "KUBE" ]; then
+		kubectl  logs -l "autotest=CR" -n $KUBE_SIM_NAMESPACE --tail=-1 > $1$2_cr.log 2>&1
+	else
+		docker logs $CR_APP_NAME > $1$2_cr.log 2>&1
+	fi
 }
 
-#######################################################
+# Initial setup of protocol, host and ports
+# This function is called for apps managed by the test script.
+# args: -
+__CR_initial_setup() {
+	use_cr_http
+}
 
+# Set app short-name, app name and namespace for logging runtime statistics of kubernets pods or docker containers
+# For docker, the namespace shall be excluded
+# This function is called for apps managed by the test script as well as for prestarted apps.
+# args: -
+__CR_statisics_setup() {
+	if [ $RUNMODE == "KUBE" ]; then
+		echo "CR $CR_APP_NAME $KUBE_SIM_NAMESPACE"
+	else
+		echo "CR $CR_APP_NAME"
+	fi
+}
 
-## Access to Callback Receiver
-# Host name may be changed if app started by kube
-# Direct access from script
-CR_HTTPX="http"
-CR_HOST_NAME=$LOCALHOST_NAME
-CR_PATH=$CR_HTTPX"://"$CR_HOST_NAME":"$CR_EXTERNAL_PORT
-#Docker/Kube internal path
-if [ $RUNMODE == "KUBE" ]; then
-	CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME"."$KUBE_SIM_NAMESPACE":"$CR_EXTERNAL_PORT$CR_APP_CALLBACK
-else
-	CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME":"$CR_INTERNAL_PORT$CR_APP_CALLBACK
-fi
-# CR_ADAPTER used for switching between REST and DMAAP (only REST supported currently)
-CR_ADAPTER_TYPE="REST"
-CR_ADAPTER=$CR_PATH
+#######################################################
 
 ################
 ### CR functions
 ################
 
-# Set http as the protocol to use for all communication to the Callback Receiver
+# Set http as the protocol to use for all communication to the Dmaap adapter
 # args: -
 # (Function for test scripts)
 use_cr_http() {
-	echo -e $BOLD"CR protocol setting"$EBOLD
-	echo -e " Using $BOLD http $EBOLD towards CR"
-
-	CR_HTTPX="http"
-	CR_PATH=$CR_HTTPX"://"$CR_HOST_NAME":"$CR_EXTERNAL_PORT
-
-	#Docker/Kube internal path
-	if [ $RUNMODE == "KUBE" ]; then
-		CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME"."$KUBE_SIM_NAMESPACE":"$CR_EXTERNAL_PORT$CR_APP_CALLBACK
-	else
-		CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME":"$CR_INTERNAL_PORT$CR_APP_CALLBACK
-	fi
-	CR_ADAPTER_TYPE="REST"
-	CR_ADAPTER=$CR_PATH
-	echo ""
+	__cr_set_protocoll "http" $CR_INTERNAL_PORT $CR_EXTERNAL_PORT
 }
 
-# Set https as the protocol to use for all communication to the Callback Receiver
+# Set https as the protocol to use for all communication to the Dmaap adapter
 # args: -
 # (Function for test scripts)
 use_cr_https() {
-	echo -e $BOLD"CR protocol setting"$EBOLD
-	echo -e " Using $BOLD https $EBOLD towards CR"
+	__cr_set_protocoll "https" $CR_INTERNAL_SECURE_PORT $CR_EXTERNAL_SECURE_PORT
+}
+
+# Setup paths to svc/container for internal and external access
+# args: <protocol> <internal-port> <external-port>
+__cr_set_protocoll() {
+	echo -e $BOLD"$CR_DISPLAY_NAME protocol setting"$EBOLD
+	echo -e " Using $BOLD http $EBOLD towards $CR_DISPLAY_NAME"
 
-	CR_HTTPX="https"
-	CR_PATH=$CR_HTTPX"://"$CR_HOST_NAME":"$CR_EXTERNAL_SECURE_PORT
+	## Access to Dmaap adapter
 
+	# CR_SERVICE_PATH is the base path to cr
+	CR_SERVICE_PATH=$1"://"$CR_APP_NAME":"$2  # docker access, container->container and script->container via proxy
 	if [ $RUNMODE == "KUBE" ]; then
-		CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME"."$KUBE_SIM_NAMESPACE":"$CR_EXTERNAL_SECURE_PORT$CR_APP_CALLBACK
-	else
-		CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME":"$CR_INTERNAL_SECURE_PORT$CR_APP_CALLBACK
+		CR_SERVICE_PATH=$1"://"$CR_APP_NAME.$KUBE_SIM_NAMESPACE":"$3 # kube access, pod->svc and script->svc via proxy
 	fi
+	# Service paths are used in test script to provide callbacck urls to app
+	CR_SERVICE_MR_PATH=$CR_SERVICE_PATH$CR_APP_CALLBACK_MR  #Only for messages from dmaap adapter/mediator
+	CR_SERVICE_TEXT_PATH=$CR_SERVICE_PATH$CR_APP_CALLBACK_TEXT  #Callbacks for text payload
+	CR_SERVICE_APP_PATH=$CR_SERVICE_PATH$CR_APP_CALLBACK    #For general callbacks from apps
 
+	# CR_ADAPTER used for switching between REST and DMAAP (only REST supported currently)
 	CR_ADAPTER_TYPE="REST"
-	CR_ADAPTER=$CR_PATH
+	CR_ADAPTER=$CR_SERVICE_PATH
+
 	echo ""
 }
 
+# Export env vars for config files, docker compose and kube resources
+# args: <proxy-flag>
+__cr_export_vars() {
+	export CR_APP_NAME
+	export CR_DISPLAY_NAME
+
+	export KUBE_SIM_NAMESPACE
+	export DOCKER_SIM_NWNAME
+
+	export CR_IMAGE
+
+	export CR_INTERNAL_PORT
+	export CR_INTERNAL_SECURE_PORT
+	export CR_EXTERNAL_PORT
+	export CR_EXTERNAL_SECURE_PORT
+}
+
 # Start the Callback reciver in the simulator group
 # args: -
 # (Function for test scripts)
@@ -190,13 +218,8 @@ start_cr() {
 
 		if [ $retcode_i -eq 0 ]; then
 			echo -e " Creating $CR_APP_NAME deployment and service"
-			export CR_APP_NAME
-			export KUBE_SIM_NAMESPACE
-			export CR_IMAGE
-			export CR_INTERNAL_PORT
-			export CR_INTERNAL_SECURE_PORT
-			export CR_EXTERNAL_PORT
-			export CR_EXTERNAL_SECURE_PORT
+
+			__cr_export_vars
 
 			__kube_create_namespace $KUBE_SIM_NAMESPACE
 
@@ -212,28 +235,10 @@ start_cr() {
 
 		fi
 
-		echo " Retrieving host and ports for service..."
-		CR_HOST_NAME=$(__kube_get_service_host $CR_APP_NAME $KUBE_SIM_NAMESPACE)
-
-		CR_EXTERNAL_PORT=$(__kube_get_service_port $CR_APP_NAME $KUBE_SIM_NAMESPACE "http")
-		CR_EXTERNAL_SECURE_PORT=$(__kube_get_service_port $CR_APP_NAME $KUBE_SIM_NAMESPACE "https")
-
-		echo " Host IP, http port, https port: $CR_HOST_NAME $CR_EXTERNAL_PORT $CR_EXTERNAL_SECURE_PORT"
-		if [ $CR_HTTPX == "http" ]; then
-			CR_PATH=$CR_HTTPX"://"$CR_HOST_NAME":"$CR_EXTERNAL_PORT
-			CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME"."$KUBE_SIM_NAMESPACE":"$CR_EXTERNAL_PORT$CR_APP_CALLBACK
-		else
-			CR_PATH=$CR_HTTPX"://"$CR_HOST_NAME":"$CR_EXTERNAL_SECURE_PORT
-			CR_SERVICE_PATH=$CR_HTTPX"://"$CR_APP_NAME"."$KUBE_SIM_NAMESPACE":"$CR_EXTERNAL_SECURE_PORT$CR_APP_CALLBACK
-		fi
-		if [ $CR_ADAPTER_TYPE == "REST" ]; then
-			CR_ADAPTER=$CR_PATH
-		fi
-
-		__check_service_start $CR_APP_NAME $CR_PATH$CR_ALIVE_URL
+		__check_service_start $CR_APP_NAME $CR_SERVICE_PATH$CR_ALIVE_URL
 
 		echo -ne " Service $CR_APP_NAME - reset  "$SAMELINE
-		result=$(__do_curl $CR_APP_NAME $CR_PATH/reset)
+		result=$(__do_curl CR $CR_SERVICE_PATH/reset)
 		if [ $? -ne 0 ]; then
 			echo -e " Service $CR_APP_NAME - reset  $RED Failed $ERED - will continue"
 		else
@@ -248,17 +253,11 @@ start_cr() {
 			exit
 		fi
 
-		export CR_APP_NAME
-		export CR_INTERNAL_PORT
-		export CR_EXTERNAL_PORT
-		export CR_INTERNAL_SECURE_PORT
-		export CR_EXTERNAL_SECURE_PORT
-		export DOCKER_SIM_NWNAME
-		export CR_DISPLAY_NAME
+		__cr_export_vars
 
 		__start_container $CR_COMPOSE_DIR "" NODOCKERARGS 1 $CR_APP_NAME
 
-        __check_service_start $CR_APP_NAME $CR_PATH$CR_ALIVE_URL
+        __check_service_start $CR_APP_NAME $CR_SERVICE_PATH$CR_ALIVE_URL
 	fi
 	echo ""
 }
@@ -273,12 +272,59 @@ start_cr() {
 # (Function for test scripts)
 cr_equal() {
 	if [ $# -eq 2 ] || [ $# -eq 3 ]; then
-		__var_test "CR" "$CR_PATH/counter/" $1 "=" $2 $3
+		__var_test "CR" "$CR_SERVICE_PATH/counter/" $1 "=" $2 $3
 	else
 		__print_err "Wrong args to cr_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
 	fi
 }
 
+# Tests if a variable value in the CR contains the target string and and optional timeout
+# Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable contains
+# the target or not.
+# Arg: <variable-name> <target-value> <timeout-in-sec>  - This test waits up to the timeout seconds
+# before setting pass or fail depending on if the variable value contains the target
+# value or not.
+# (Function for test scripts)
+cr_contains_str() {
+
+	if [ $# -eq 2 ] || [ $# -eq 3 ]; then
+		__var_test "CR" "$CR_SERVICE_PATH/counter/" $1 "contain_str" $2 $3
+		return 0
+	else
+		__print_err "needs two or three args: <sim-param> <target-value> [ timeout ]"
+		return 1
+	fi
+}
+
+# Read a variable value from CR sim and send to stdout. Arg: <variable-name>
+cr_read() {
+	echo "$(__do_curl $CR_SERVICE_PATH/counter/$1)"
+}
+
+# Function to configure write delay on callbacks
+# Delay given in seconds.
+# arg <response-code> <delay-in-sec>
+# (Function for test scripts)
+cr_delay_callback() {
+	__log_conf_start $@
+
+	if [ $# -ne 2 ]; then
+        __print_err "<response-code> <delay-in-sec>]" $@
+        return 1
+	fi
+
+	res="$(__do_curl_to_api CR POST /forcedelay?delay=$2)"
+	status=${res:${#res}-3}
+
+	if [ $status -ne 200 ]; then
+		__log_conf_fail_status_code $1 $status
+		return 1
+	fi
+
+	__log_conf_ok
+	return 0
+}
+
 # CR API: Check the contents of all current ric sync events for one id from PMS
 # <response-code> <id> [ EMPTY | ( <ric-id> )+ ]
 # (Function for test scripts)
@@ -380,6 +426,298 @@ cr_api_check_all_ecs_events() {
 			return 1
 		fi
 	fi
+	__log_test_pass
+	return 0
+}
+
+# CR API: Check the contents of all current type subscription events for one id from ECS
+# <response-code> <id> [ EMPTY | ( <type-id> <schema> <registration-status> )+ ]
+# (Function for test scripts)
+cr_api_check_all_ecs_subscription_events() {
+	__log_test_start $@
+
+	#Valid number of parameter 2,3,7,11
+	paramError=1
+	if [ $# -eq 2 ]; then
+		paramError=0
+	fi
+	if [ $# -eq 3 ] && [ "$3" == "EMPTY" ]; then
+		paramError=0
+	fi
+	variablecount=$(($#-2))
+	if [ $# -gt 3 ] && [ $(($variablecount%3)) -eq 0 ]; then
+		paramError=0
+	fi
+	if [ $paramError -eq 1 ]; then
+		__print_err "<response-code> <id> [ EMPTY | ( <type-id> <schema> <registration-status> )+ ]" $@
+		return 1
+	fi
+
+	query="/get-all-events/"$2
+	res="$(__do_curl_to_api CR GET $query)"
+	status=${res:${#res}-3}
+
+	if [ $status -ne $1 ]; then
+		__log_test_fail_status_code $1 $status
+		return 1
+	fi
+
+	if [ $# -gt 2 ]; then
+		body=${res:0:${#res}-3}
+		targetJson="["
+		if [ $# -gt 3 ]; then
+			arr=(${@:3})
+			for ((i=0; i<$(($#-3)); i=i+3)); do
+				if [ "$targetJson" != "[" ]; then
+					targetJson=$targetJson","
+				fi
+				if [ -f ${arr[$i+1]} ]; then
+					jobfile=$(cat ${arr[$i+1]})
+				else
+					__log_test_fail_general "Job schema file "${arr[$i+1]}", does not exist"
+					return 1
+				fi
+				targetJson=$targetJson"{\"info_type_id\":\"${arr[$i]}\",\"job_data_schema\":$jobfile,\"status\":\"${arr[$i+2]}\"}"
+			done
+		fi
+		targetJson=$targetJson"]"
+
+		echo " TARGET JSON: $targetJson" >> $HTTPLOG
+		res=$(python3 ../common/compare_json.py "$targetJson" "$body")
+
+		if [ $res -ne 0 ]; then
+			__log_test_fail_body
+			return 1
+		fi
+	fi
+
+	__log_test_pass
+	return 0
+}
+
+
+# CR API: Reset all events and counters
+# Arg: -
+# (Function for test scripts)
+cr_api_reset() {
+	__log_conf_start $@
+
+	res="$(__do_curl_to_api CR GET /reset)"
+	status=${res:${#res}-3}
+
+	if [ $status -ne 200 ]; then
+		__log_conf_fail_status_code $1 $status
+		return 1
+	fi
+
+	__log_conf_ok
+	return 0
+}
+
+
+# CR API: Check the contents of all json events for path
+# <response-code> <topic-url> (EMPTY | <json-msg>+ )
+# (Function for test scripts)
+cr_api_check_all_genric_json_events() {
+	__log_test_start $@
+
+	if [ $# -lt 3 ]; then
+		__print_err "<response-code> <topic-url> (EMPTY | <json-msg>+ )" $@
+		return 1
+	fi
+
+	query="/get-all-events/"$2
+	res="$(__do_curl_to_api CR GET $query)"
+	status=${res:${#res}-3}
+
+	if [ $status -ne $1 ]; then
+		__log_test_fail_status_code $1 $status
+		return 1
+	fi
+	body=${res:0:${#res}-3}
+	targetJson="["
+
+	if [ $3 != "EMPTY" ]; then
+		shift
+		shift
+		while [ $# -gt 0 ]; do
+			if [ "$targetJson" != "[" ]; then
+				targetJson=$targetJson","
+			fi
+			targetJson=$targetJson$1
+			shift
+		done
+	fi
+	targetJson=$targetJson"]"
+
+	echo " TARGET JSON: $targetJson" >> $HTTPLOG
+	res=$(python3 ../common/compare_json.py "$targetJson" "$body")
+
+	if [ $res -ne 0 ]; then
+		__log_test_fail_body
+		return 1
+	fi
+
+	__log_test_pass
+	return 0
+}
+
+
+
+# CR API: Check a single (oldest) json event (or none if empty) for path
+# <response-code> <topic-url> (EMPTY | <json-msg> )
+# (Function for test scripts)
+cr_api_check_single_genric_json_event() {
+	__log_test_start $@
+
+	if [ $# -ne 3 ]; then
+		__print_err "<response-code> <topic-url> (EMPTY | <json-msg> )" $@
+		return 1
+	fi
+
+	query="/get-event/"$2
+	res="$(__do_curl_to_api CR GET $query)"
+	status=${res:${#res}-3}
+
+	if [ $status -ne $1 ]; then
+		__log_test_fail_status_code $1 $status
+		return 1
+	fi
+	body=${res:0:${#res}-3}
+	targetJson=$3
+
+	if [ $targetJson == "EMPTY" ] && [ ${#body} -ne 0 ]; then
+		__log_test_fail_body
+		return 1
+	fi
+	echo " TARGET JSON: $targetJson" >> $HTTPLOG
+	res=$(python3 ../common/compare_json.py "$targetJson" "$body")
+
+	if [ $res -ne 0 ]; then
+		__log_test_fail_body
+		return 1
+	fi
+
+	__log_test_pass
+	return 0
+}
+
+# CR API: Check a single (oldest) json in md5 format (or none if empty) for path.
+# Note that if a json message is given, it shall be compact, no ws except inside string.
+# The MD5 will generate different hash if ws is present or not in otherwise equivalent json
+# arg: <response-code> <topic-url> (EMPTY | <data-msg> )
+# (Function for test scripts)
+cr_api_check_single_genric_event_md5() {
+	__log_test_start $@
+
+	if [ $# -ne 3 ]; then
+		__print_err "<response-code> <topic-url> (EMPTY | <data-msg> )" $@
+		return 1
+	fi
+
+	query="/get-event/"$2
+	res="$(__do_curl_to_api CR GET $query)"
+	status=${res:${#res}-3}
+
+	if [ $status -ne $1 ]; then
+		__log_test_fail_status_code $1 $status
+		return 1
+	fi
+	body=${res:0:${#res}-3}
+	if [ $3 == "EMPTY" ]; then
+		if [ ${#body} -ne 0 ]; then
+			__log_test_fail_body
+			return 1
+		else
+			__log_test_pass
+			return 0
+		fi
+	fi
+	command -v md5 > /dev/null # Mac
+	if [ $? -eq 0 ]; then
+		targetMd5=$(echo -n "$3" | md5)
+	else
+		command -v md5sum > /dev/null # Linux
+		if [ $? -eq 0 ]; then
+			targetMd5=$(echo -n "$3" | md5sum | cut -d' ' -f 1)  # Need to cut additional info printed by cmd
+		else
+			__log_test_fail_general "Command md5 nor md5sum is available"
+			return 1
+		fi
+	fi
+	targetMd5="\""$targetMd5"\"" #Quotes needed
+
+	echo " TARGET MD5 hash: $targetMd5" >> $HTTPLOG
+
+	if [ "$body" != "$targetMd5" ]; then
+		__log_test_fail_body
+		return 1
+	fi
+
+	__log_test_pass
+	return 0
+}
+
+# CR API: Check a single (oldest) event in md5 format (or none if empty) for path.
+# Note that if a file with json message is given, the json shall be compact, no ws except inside string and not newlines.
+# The MD5 will generate different hash if ws/newlines is present or not in otherwise equivalent json
+# arg: <response-code> <topic-url> (EMPTY | <data-file> )
+# (Function for test scripts)
+cr_api_check_single_genric_event_md5_file() {
+	__log_test_start $@
+
+	if [ $# -ne 3 ]; then
+		__print_err "<response-code> <topic-url> (EMPTY | <data-file> )" $@
+		return 1
+	fi
+
+	query="/get-event/"$2
+	res="$(__do_curl_to_api CR GET $query)"
+	status=${res:${#res}-3}
+
+	if [ $status -ne $1 ]; then
+		__log_test_fail_status_code $1 $status
+		return 1
+	fi
+	body=${res:0:${#res}-3}
+	if [ $3 == "EMPTY" ]; then
+		if [ ${#body} -ne 0 ]; then
+			__log_test_fail_body
+			return 1
+		else
+			__log_test_pass
+			return 0
+		fi
+	fi
+
+	if [ ! -f $3 ]; then
+		__log_test_fail_general "File $3 does not exist"
+		return 1
+	fi
+
+	filedata=$(cat $3)
+
+	command -v md5 > /dev/null # Mac
+	if [ $? -eq 0 ]; then
+		targetMd5=$(echo -n "$filedata" | md5)
+	else
+		command -v md5sum > /dev/null # Linux
+		if [ $? -eq 0 ]; then
+			targetMd5=$(echo -n "$filedata" | md5sum | cut -d' ' -f 1)  # Need to cut additional info printed by cmd
+		else
+			__log_test_fail_general "Command md5 nor md5sum is available"
+			return 1
+		fi
+	fi
+	targetMd5="\""$targetMd5"\""   #Quotes needed
+
+	echo " TARGET MD5 hash: $targetMd5" >> $HTTPLOG
+
+	if [ "$body" != "$targetMd5" ]; then
+		__log_test_fail_body
+		return 1
+	fi
+
 	__log_test_pass
 	return 0
 }
\ No newline at end of file