X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcommon%2Fcr_api_functions.sh;h=bf490fc0212ea7791df0bebe413fe194bd511ebe;hb=4f7f0cda2f07f62dcbb2e371fc09764b2337a8e9;hp=fe4b1fd699413358248bfe06234990f5b8edecd8;hpb=6a39814272307d0207222c9229b0d765ac062bf0;p=nonrtric.git diff --git a/test/common/cr_api_functions.sh b/test/common/cr_api_functions.sh index fe4b1fd6..bf490fc0 100644 --- a/test/common/cr_api_functions.sh +++ b/test/common/cr_api_functions.sh @@ -17,35 +17,180 @@ # ============LICENSE_END================================================= # -. ../common/api_curl.sh - -### Admin API functions for the Callback Reciver - - -# 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 - ((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 +# This is a script that contains container/service managemnt functions test functions for the Callback Reciver + +## 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 +# 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 "" +} + +# Set https as the protocol to use for all communication to the Callback Receiver +# args: - +# (Function for test scripts) +use_cr_https() { + echo -e $BOLD"CR protocol setting"$EBOLD + echo -e " Using $BOLD https $EBOLD towards CR" + + CR_HTTPX="https" + CR_PATH=$CR_HTTPX"://"$CR_HOST_NAME":"$CR_EXTERNAL_SECURE_PORT + + 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 + fi + + CR_ADAPTER_TYPE="REST" + CR_ADAPTER=$CR_PATH + echo "" } +# 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" + 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 + + __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 + + 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 + + echo -ne " Service $CR_APP_NAME - reset "$SAMELINE + result=$(__do_curl $CR_APP_NAME $CR_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 + + 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 + + __start_container $CR_COMPOSE_DIR NODOCKERARGS 1 $CR_APP_NAME + + __check_service_start $CR_APP_NAME $CR_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 +200,20 @@ __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_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 +# 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 +227,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 +253,60 @@ 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 } \ No newline at end of file