X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcommon%2Fcr_api_functions.sh;h=ba4651018172892ff8a3a8e0853d800de1e1a04e;hb=663566c28930429775ea9921f0e32ddf5253da28;hp=fe4b1fd699413358248bfe06234990f5b8edecd8;hpb=803d48989d7824309602393763142320cdbbc0d2;p=nonrtric.git diff --git a/test/common/cr_api_functions.sh b/test/common/cr_api_functions.sh index fe4b1fd6..ba465101 100644 --- a/test/common/cr_api_functions.sh +++ b/test/common/cr_api_functions.sh @@ -17,35 +17,239 @@ # ============LICENSE_END================================================= # -. ../common/api_curl.sh +# This is a script that contains container/service managemnt functions test functions for the Callback Reciver -### Admin API functions for the Callback Reciver +################ Test engine functions ################ -# Excute a curl cmd towards a Callback Reciver admin interface and check the response code. -# args: -__execute_curl_to_cr() { - echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG - echo " CMD: $2" >> $HTTPLOG - res="$($2)" - echo " RESP: $res" >> $HTTPLOG - retcode=$? - if [ $retcode -ne 0 ]; then +# Create the image var used during the test +# arg: (selects staging, snapshot, release etc) +# is present only for images with staging, snapshot,release tags +__CR_imagesetup() { + __check_and_create_image_var CR "CR_IMAGE" "CR_IMAGE_BASE" "CR_IMAGE_TAG" LOCAL "$CR_DISPLAY_NAME" +} + +# Pull image from remote repo or use locally built image +# arg: +# Shall be used for images allowing overriding. For example use a local image when test is started to use released images +# 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 remote repo"$ERED +} + +# Build image (only for simulator or interfaces stubs owned by the test environment) +# arg: (selects staging, snapshot, release etc) +# is present only for images with staging, snapshot,release tags +__CR_imagebuild() { + cd ../cr + 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 + __retag_and_push_image CR_IMAGE + if [ $? -ne 0 ]; then + exit 1 + fi + else + echo -e $RED" Build Failed"$ERED ((RES_CONF_FAIL++)) - echo " RETCODE: "$retcode - echo -e $RED" FAIL - fatal error when executing curl."$ERED - return 1 - fi - status=${res:${#res}-3} - if [ $status -eq $1 ]; then - echo -e $GREEN" OK"$EGREEN - return 0 - fi - echo -e $RED" FAIL - expected http response: "$1" but got http response: "$status $ERED - ((RES_CONF_FAIL++)) - return 1 + cat .dockererr + echo -e $RED"Exiting...."$ERED + exit 1 + fi +} + +# 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: +__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 +# 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 +__CR_kube_scale_zero() { + __kube_scale_all_resources $KUBE_SIM_NAMESPACE autotest CR +} + +# 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. +__CR_kube_scale_zero_and_wait() { + echo -e $RED" CR app is not scaled in this state"$ERED +} + +# Delete all kube resouces for the app +# This function is called for apps managed by the test script. +__CR_kube_delete_all() { + __kube_delete_all_resources $KUBE_SIM_NAMESPACE autotest CR +} + +# Store docker logs +# This function is called for apps managed by the test script. +# args: +__CR_store_docker_logs() { + 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 +} + +####################################################### + +################ +### CR functions +################ + +# Set http as the protocol to use for all communication to the Dmaap adapter +# args: - +# (Function for test scripts) +use_cr_http() { + __cr_set_protocoll "http" $CR_INTERNAL_PORT $CR_EXTERNAL_PORT } +# Set https as the protocol to use for all communication to the Dmaap adapter +# args: - +# (Function for test scripts) +use_cr_https() { + __cr_set_protocoll "https" $CR_INTERNAL_SECURE_PORT $CR_EXTERNAL_SECURE_PORT +} + +# Setup paths to svc/container for internal and external access +# args: +__cr_set_protocoll() { + echo -e $BOLD"$CR_DISPLAY_NAME protocol setting"$EBOLD + echo -e " Using $BOLD http $EBOLD towards $CR_DISPLAY_NAME" + + ## 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=$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_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_SERVICE_PATH + + echo "" +} + +# Export env vars for config files, docker compose and kube resources +# args: +__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) +start_cr() { + + echo -e $BOLD"Starting $CR_DISPLAY_NAME"$EBOLD + + if [ $RUNMODE == "KUBE" ]; then + + # Check if app shall be fully managed by the test script + __check_included_image "CR" + retcode_i=$? + + # Check if app shall only be used by the testscipt + __check_prestarted_image "CR" + retcode_p=$? + + if [ $retcode_i -ne 0 ] && [ $retcode_p -ne 0 ]; then + echo -e $RED"The $CR_APP_NAME app is not included as managed nor prestarted in this test script"$ERED + echo -e $RED"The $CR_APP_NAME will not be started"$ERED + exit + fi + if [ $retcode_i -eq 0 ] && [ $retcode_p -eq 0 ]; then + echo -e $RED"The $CR_APP_NAME app is included both as managed and prestarted in this test script"$ERED + echo -e $RED"The $CR_APP_NAME will not be started"$ERED + exit + fi + + # Check if app shall be used - not managed - by the test script + if [ $retcode_p -eq 0 ]; then + echo -e " Using existing $CR_APP_NAME deployment and service" + echo " Setting CR replicas=1" + __kube_scale deployment $CR_APP_NAME $KUBE_SIM_NAMESPACE 1 + fi + + if [ $retcode_i -eq 0 ]; then + echo -e " Creating $CR_APP_NAME deployment and service" + + __cr_export_vars + + __kube_create_namespace $KUBE_SIM_NAMESPACE + + # Create service + input_yaml=$SIM_GROUP"/"$CR_COMPOSE_DIR"/"svc.yaml + output_yaml=$PWD/tmp/cr_svc.yaml + __kube_create_instance service $CR_APP_NAME $input_yaml $output_yaml + + # Create app + input_yaml=$SIM_GROUP"/"$CR_COMPOSE_DIR"/"app.yaml + output_yaml=$PWD/tmp/cr_app.yaml + __kube_create_instance app $CR_APP_NAME $input_yaml $output_yaml + + fi + + __check_service_start $CR_APP_NAME $CR_SERVICE_PATH$CR_ALIVE_URL + + echo -ne " Service $CR_APP_NAME - reset "$SAMELINE + 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 + echo -e " Service $CR_APP_NAME - reset $GREEN OK $EGREEN" + fi + else + # Check if docker app shall be fully managed by the test script + __check_included_image 'CR' + if [ $? -eq 1 ]; then + echo -e $RED"The Callback Receiver app is not included in this test script"$ERED + echo -e $RED"The Callback Receiver will not be started"$ERED + exit + fi + + __cr_export_vars + + __start_container $CR_COMPOSE_DIR "" NODOCKERARGS 1 $CR_APP_NAME + + __check_service_start $CR_APP_NAME $CR_SERVICE_PATH$CR_ALIVE_URL + fi + echo "" +} + + # Tests if a variable value in the CR is equal to a target value and and optional timeout. # Arg: - This test set pass or fail depending on if the variable is # equal to the target or not. @@ -55,25 +259,67 @@ __execute_curl_to_cr() { # (Function for test scripts) cr_equal() { if [ $# -eq 2 ] || [ $# -eq 3 ]; then - __var_test "CR" "$LOCALHOST$CR_EXTERNAL_PORT/counter/" $1 "=" $2 $3 + __var_test "CR" "$CR_SERVICE_PATH/counter/" $1 "=" $2 $3 else - ((RES_CONF_FAIL++)) __print_err "Wrong args to cr_equal, needs two or three args: [ timeout ]" $@ fi } -# CR API: Check the contents of all current ric sync events from PMS +# Tests if a variable value in the CR contains the target string and and optional timeout +# Arg: - This test set pass or fail depending on if the variable contains +# the target or not. +# Arg: - 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: [ timeout ]" + return 1 + fi +} + +# Read a variable value from CR sim and send to stdout. Arg: +cr_read() { + echo "$(__do_curl $CR_SERVICE_PATH/counter/$1)" +} + +# Function to configure write delay on callbacks +# Delay given in seconds. +# arg +# (Function for test scripts) +cr_delay_callback() { + __log_conf_start $@ + + if [ $# -ne 2 ]; then + __print_err " ]" $@ + 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 # [ EMPTY | ( )+ ] # (Function for test scripts) cr_api_check_all_sync_events() { - echo -e $BOLD"TEST(${BASH_LINENO[0]}): ${FUNCNAME[0]}" $@ $EBOLD - echo "TEST(${BASH_LINENO[0]}): ${FUNCNAME[0]}" $@ >> $HTTPLOG - ((RES_TEST++)) + __log_test_start $@ if [ "$PMS_VERSION" != "V2" ]; then - echo -e $RED" FAIL, function not supported"$ERED - ((RES_FAIL++)) - __check_stop_at_error + __log_test_fail_not_supported return 1 fi @@ -87,9 +333,7 @@ cr_api_check_all_sync_events() { status=${res:${#res}-3} if [ $status -ne $1 ]; then - echo -e $RED" FAIL. Exepected status "$1", got "$status $ERED - ((RES_FAIL++)) - __check_stop_at_error + __log_test_fail_status_code $1 $status return 1 fi @@ -115,13 +359,228 @@ cr_api_check_all_sync_events() { res=$(python3 ../common/compare_json.py "$targetJson" "$body") if [ $res -ne 0 ]; then - echo -e $RED" FAIL, returned body not correct"$ERED - ((RES_FAIL++)) - __check_stop_at_error + __log_test_fail_body + return 1 + fi + fi + __log_test_pass + return 0 +} + +# CR API: Check the contents of all current status events for one id from ECS +# [ EMPTY | ( )+ ] +# (Function for test scripts) +cr_api_check_all_ecs_events() { + __log_test_start $@ + + if [ $# -lt 2 ]; then + __print_err " [ EMPTY | ( )+ ]" $@ + 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} + if [ $# -eq 3 ] && [ $3 == "EMPTY" ]; then + targetJson="[" + else + targetJson="[" + arr=(${@:3}) + + for ((i=0; i<$(($#-2)); i=i+1)); do + + if [ "$targetJson" != "[" ]; then + targetJson=$targetJson"," + fi + targetJson=$targetJson"{\"eiJobStatus\":\"${arr[$i]}\"}" + 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 - ((RES_PASS++)) - echo -e $GREEN" PASS"$EGREEN + __log_test_pass + return 0 +} + +# CR API: Check the contents of all current type subscription events for one id from ECS +# [ EMPTY | ( )+ ] +# (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 " [ EMPTY | ( )+ ]" $@ + 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 +# (EMPTY | + ) +# (Function for test scripts) +cr_api_check_all_genric_json_events() { + __log_test_start $@ + + if [ $# -lt 3 ]; then + __print_err " (EMPTY | + )" $@ + 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 +# (EMPTY | ) +# (Function for test scripts) +cr_api_check_single_genric_json_event() { + __log_test_start $@ + + if [ $# -ne 3 ]; then + __print_err " (EMPTY | )" $@ + 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 + + 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 } \ No newline at end of file