-#!/usr/bin/env bash
+#!/bin/bash
+
+# ============LICENSE_START===============================================
+# Copyright (C) 2020 Nordix Foundation. All rights reserved.
+# ========================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============LICENSE_END=================================================
+#
+# This is a script that contains all the functions needed for auto test
+# Arg: local|remote|remote-remove [auto-clean]
+
+#Formatting for 'echo' cmd
+BOLD="\033[1m"
+EBOLD="\033[0m"
+RED="\033[31m\033[1m"
+ERED="\033[0m"
+GREEN="\033[32m\033[1m"
+EGREEN="\033[0m"
+YELLOW="\033[33m\033[1m"
+EYELLOW="\033[0m"
+
+# Just resetting any previous echo formatting...
+echo -ne $EBOLD$ERED$EGREEN
+
+# source test environment variables
. ../common/test_env.sh
-echo "Test case started as: ${BASH_SOURCE[$i+1]} "$1 $2 $3
-echo "Numbers of ric simulator started" $2
+echo "Test case started as: ${BASH_SOURCE[$i+1]} "$@
-# This is a script that contains all the functions needed for auto test
-# Arg: local | remote (1, 2, 3, 4....)
+#Vars for A1 interface version and container count
+G1_A1_VERSION=""
+G2_A1_VERSION=""
+G3_A1_VERSION=""
+G1_COUNT=0
+G2_COUNT=0
+G3_COUNT=0
-STARTED_POLICY_AGENT="" #Policy Agent app names added to this var to keep track of started container in the script
-START_ARG=$1
-IMAGE_TAG="1.0.0-SNAPSHOT"
-IMAGE_TAG_REMOTE="latest"
-RIC_NUMBER=$2
-SDNC=$3
+#Localhost constant
+LOCALHOST="http://localhost:"
-if [ $# -lt 1 ] || [ $# -gt 4 ]; then
- echo "Expected arg: local | remote and numbers of the rics and SDNC "
- exit 1
-elif [ $1 == "local" ]; then
- if [ -z $POLICY_AGENT_LOCAL_IMAGE ]; then
- echo "POLICY_AGENT_LOCAL_IMAGE not set in test_env"
- exit 1
- fi
- POLICY_AGENT_IMAGE=$POLICY_AGENT_LOCAL_IMAGE":"$IMAGE_TAG
-elif [ $1 == "remote" ]; then
- if [ -z $POLICY_AGENT_REMOTE_IMAGE ]; then
- echo "POLICY_AGENT_REMOTE_IMAGE not set in test_env"
- exit 1
- fi
- POLICY_AGENT_IMAGE=$POLICY_AGENT_REMOTE_IMAGE":"$IMAGE_TAG_REMOTE
-fi
+# Make curl retries for http response codes set in this env var, space separated list of codes
+AGENT_RETRY_CODES=""
+
+# Var to hold 'auto' in case containers shall be stopped when test case ends
+AUTO_CLEAN=""
# Set a description string for the test case
if [ -z "$TC_ONELINE_DESCR" ]; then
echo "No test case description found, TC_ONELINE_DESCR should be set on in the test script , using "$TC_ONELINE_DESCR
fi
-ATC=$(basename "${BASH_SOURCE[$i+1]}" .sh)
+# Counter for test suites
+if [ -f .tmp_tcsuite_ctr ]; then
+ tmpval=$(< .tmp_tcsuite_ctr)
+ ((tmpval++))
+ echo $tmpval > .tmp_tcsuite_ctr
+fi
+# Create a test case id, ATC (Auto Test Case), from the name of the test case script.
+# FTC1.sh -> ATC == FTC1
+ATC=$(basename "${BASH_SOURCE[$i+1]}" .sh)
# Create the logs dir if not already created in the current dir
if [ ! -d "logs" ]; then
mkdir logs
fi
-
TESTLOGS=$PWD/logs
+# Create a http message log for this testcase
+HTTPLOG=$PWD"/.httplog_"$ATC".txt"
+echo "" > $HTTPLOG
+
+# Create a log dir for the test case
mkdir -p $TESTLOGS/$ATC
+# Clear the log dir for the test case
+rm $TESTLOGS/$ATC/*.log &> /dev/null
+rm $TESTLOGS/$ATC/*.txt &> /dev/null
+rm $TESTLOGS/$ATC/*.json &> /dev/null
+
+# Log all output from the test case to a TC log
TCLOG=$TESTLOGS/$ATC/TC.log
exec &> >(tee ${TCLOG})
RES_TEST=0
RES_PASS=0
RES_FAIL=0
+RES_CONF_FAIL=0
+
+#Var for measuring execution time
TCTEST_START=$SECONDS
echo "-------------------------------------------------------------------------------------------------"
echo "-------------------------------------------------------------------------------------------------"
echo "----------------------------------- Test case setup -----------------------------------"
+echo -e $BOLD"Checking configured image setting for this test case"$EBOLD
+
+#Temp var to check for image variable name errors
+IMAGE_ERR=0
+#Create a file with image info for later printing as a table
+image_list_file=".image-list"
+echo -e " Container\tImage\ttag" > $image_list_file
+
+# Check if image env var is set and if so export the env var with image to use (used by docker compose files)
+# arg: <image name> <script start-arg> <target-variable-name> <image-variable-name> <image-tag-variable-name>
+__check_image_var() {
+ if [ $# -ne 5 ]; then
+ echo "Expected arg: <image name> <script start-arg> <target-variable-name> <image-variable-name> <image-tag-variable-name>"
+ ((IMAGE_ERR++))
+ return
+ fi
+ tmp=${1}"\t"
+ #Create var from the input var names
+ image="${!4}"
+ tag="${!5}"
+
+ if [ -z $image ]; then
+ echo -e $RED"\$"$4" not set in test_env"$ERED
+ ((IMAGE_ERR++))
+ echo ""
+ tmp=$tmp"<no-image>\t"
+ else
+ tmp=$tmp$image"\t"
+ fi
+ if [ -z $tag ]; then
+ echo -e $RED"\$"$5" not set in test_env"$ERED
+ ((IMAGE_ERR++))
+ echo ""
+ tmp=$tmp"<no-tag>\t"
+ else
+ tmp=$tmp$tag
+ fi
+ echo -e "$tmp" >> $image_list_file
+ #Export the env var
+ export "${3}"=$image":"$tag
+
+ #echo " Configured image for ${1} (script start arg=${2}): "$image":"$tag
+}
+
+# Check that image env setting are available
+echo ""
+if [ $# -lt 1 ] || [ $# -gt 2 ]; then
+ echo "Expected arg: local|remote|remote-remove [auto-clean]"
+ exit 1
+elif [ $1 == "local" ]; then
+
+ #Local agent image
+ __check_image_var " Policy Agent" $1 "POLICY_AGENT_IMAGE" "POLICY_AGENT_LOCAL_IMAGE" "POLICY_AGENT_LOCAL_IMAGE_TAG"
+
+ #Local Control Panel image
+ __check_image_var " Control Panel" $1 "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_LOCAL_IMAGE" "CONTROL_PANEL_LOCAL_IMAGE_TAG"
+
+ #Local SNDC image
+ __check_image_var " SDNC A1 Controller" $1 "SDNC_A1_CONTROLLER_IMAGE" "SDNC_A1_CONTROLLER_LOCAL_IMAGE" "SDNC_A1_CONTROLLER_LOCAL_IMAGE_TAG"
+
+ #Local ric sim image
+ __check_image_var " RIC Simulator" $1 "RIC_SIM_IMAGE" "RIC_SIM_LOCAL_IMAGE" "RIC_SIM_LOCAL_IMAGE_TAG"
+
+elif [ $1 == "remote" ] || [ $1 == "remote-remove" ]; then
+
+ #Remote agent image
+ __check_image_var " Policy Agent" $1 "POLICY_AGENT_IMAGE" "POLICY_AGENT_REMOTE_IMAGE" "POLICY_AGENT_REMOTE_IMAGE_TAG"
+
+ #Remote Control Panel image
+ __check_image_var " Control Panel" $1 "CONTROL_PANEL_IMAGE" "CONTROL_PANEL_REMOTE_IMAGE" "CONTROL_PANEL_REMOTE_IMAGE_TAG"
+
+ #Remote SDNC image
+ __check_image_var " SDNC A1 Controller" $1 "SDNC_A1_CONTROLLER_IMAGE" "SDNC_A1_CONTROLLER_REMOTE_IMAGE" "SDNC_A1_CONTROLLER_REMOTE_IMAGE_TAG"
+
+ #Remote ric sim image
+ __check_image_var " RIC Simulator" $1 "RIC_SIM_IMAGE" "RIC_SIM_REMOTE_IMAGE" "RIC_SIM_REMOTE_IMAGE_TAG"
+
+else
+ echo "Expected arg: local|remote|remote-remove [auto-clean]"
+ exit 1
+fi
+
+if [ $# -eq 2 ]; then
+ if [ $2 == "auto-clean" ]; then
+ echo "Stting automatic cleaning of container when test case ends"
+ AUTO_CLEAN="auto"
+ else
+ echo "Expected arg: local|remote|remote-remove [auto-clean]"
+ exit 1
+ fi
+fi
+
+# These images are not built as part of this project official images, just check that env vars are set correctly
+__check_image_var " Message Router" $1 "MRSTUB_IMAGE" "MRSTUB_LOCAL_IMAGE" "MRSTUB_LOCAL_IMAGE_TAG"
+__check_image_var " Callback Receiver" $1 "CR_IMAGE" "CR_LOCAL_IMAGE" "CR_LOCAL_IMAGE_TAG"
+__check_image_var " Consul" $1 "CONSUL_IMAGE" "CONSUL_REMOTE_IMAGE" "CONSUL_REMOTE_IMAGE_TAG"
+__check_image_var " CBS" $1 "CBS_IMAGE" "CBS_REMOTE_IMAGE" "CBS_REMOTE_IMAGE_TAG"
+__check_image_var " SDNC DB" $1 "SDNC_DB_IMAGE" "SDNC_DB_REMOTE_IMAGE" "SDNC_DB_REMOTE_IMAGE_TAG"
+
+#Errors in image setting - exit
+if [ $IMAGE_ERR -ne 0 ]; then
+ exit 1
+fi
+
+#Print a tables of the image settings
+echo -e $BOLD"Images configured for start arg: "$1 $EBOLD
+column -t -s $'\t' $image_list_file
+
+echo ""
+
+#Set the SIM_GROUP var
+echo -e $BOLD"Setting var to main dir of all container/simulator scripts"$EBOLD
if [ -z "$SIM_GROUP" ]; then
- SIM_GROUP=$PWD/../simulator-group
- if [ ! -d $SIM_GROUP ]; then
- echo "Trying to set env var SIM_GROUP to dir 'simulator-group' in the integration repo, but failed."
- echo "Please set the SIM_GROUP manually in the test_env.sh"
- exit 1
- else
- echo "SIM_GROUP auto set to: " $SIM_GROUP
- fi
+ SIM_GROUP=$PWD/../simulator-group
+ if [ ! -d $SIM_GROUP ]; then
+ echo "Trying to set env var SIM_GROUP to dir 'simulator-group' in the nontrtric repo, but failed."
+ echo -e $RED"Please set the SIM_GROUP manually in the test_env.sh"$ERED
+ exit 1
+ else
+ echo " SIM_GROUP auto set to: " $SIM_GROUP
+ fi
elif [ $SIM_GROUP = *simulator_group ]; then
- echo "Env var SIM_GROUP does not seem to point to dir 'simulator-group' in the integration repo, check test_env.sh"
- exit 1
+ echo -e $RED"Env var SIM_GROUP does not seem to point to dir 'simulator-group' in the repo, check common/test_env.sh"$ERED
+ exit 1
+else
+ echo " SIM_GROUP env var already set to: " $SIM_GROUP
fi
echo ""
-if [ $1 != "manual-container" ] && [ $1 != "manual-app" ]; then
- #echo -e "Policy Agent image tag set to: \033[1m" $IMAGE_TAG"\033[0m"
- echo "Configured image for Policy Agent app(s) (${1}): "$POLICY_AGENT_IMAGE
- tmp_im=$(docker images ${POLICY_AGENT_IMAGE} | grep -v REPOSITORY)
+#Temp var to check for image pull errors
+IMAGE_ERR=0
+
+#Function to check if image exist and stop+remove the container+pull new images as needed
+#args <script-start-arg> <descriptive-image-name> <container-base-name> <image-with-tag>
+__check_and_pull_image() {
+
+ echo -e " Checking $BOLD$2$EBOLD container(s) with basename: $BOLD$3$EBOLD using image: $BOLD$4$EBOLD"
+ format_string="\"{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}\""
+ tmp_im=$(docker images --format $format_string ${4})
if [ $1 == "local" ]; then
if [ -z "$tmp_im" ]; then
- echo "Local image (non nexus) "$POLICY_AGENT_IMAGE" does not exist in local registry, need to be built"
- exit 1
+ echo -e " "$2" (local image): \033[1m"$4"\033[0m $RED does not exist in local registry, need to be built (or manually pulled)"$ERED
+ ((IMAGE_ERR++))
+ return 1
else
- echo -e "Policy Agent local image: \033[1m"$tmp_im"\033[0m"
- echo "If the Policy Agent image seem outdated, rebuild the image and run the test again."
+ echo -e " "$2" (local image): \033[1m"$4"\033[0m "$GREEN"OK"$EGREEN
fi
- elif [ $1 == "remote" ]; then
- if [ -z "$tmp_im" ]; then
- echo "Pulling Policy Agent image from nexus: "$POLICY_AGENT_IMAGE
- docker pull $POLICY_AGENT_IMAGE > /dev/null
- tmp_im=$(docker images ${POLICY_AGENT_IMAGE} | grep -v REPOSITORY)
+ elif [ $1 == "remote" ] || [ $1 == "remote-remove" ]; then
+ if [ $1 == "remote-remove" ]; then
+ echo -ne " Attempt to stop and remove container(s), if running - \033[0K\r"
+ tmp="$(docker ps -aq --filter name=${3})"
+ if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
+ docker stop $tmp &> /dev/null
+ if [ $? -ne 0 ]; then
+ ((IMAGE_ERR++))
+ echo ""
+ echo -e $RED" Container(s) could not be stopped - try manual stopping the container(s)"$ERED
+ return 1
+ fi
+ fi
+ echo -ne " Attempt to stop and remove container(s), if running - "$GREEN"stopped"$EGREEN"\033[0K\r"
+ tmp="$(docker ps -aq --filter name=${3})" &> /dev/null
+ if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
+ docker rm $tmp &> /dev/null
+ if [ $? -ne 0 ]; then
+ ((IMAGE_ERR++))
+ echo ""
+ echo -e $RED" Container(s) could not be removed - try manual removal of the container(s)"$ERED
+ return 1
+ fi
+ fi
+ echo -e " Attempt to stop and remove container(s), if running - "$GREEN"stopped removed"$EGREEN
+ echo -ne " Removing image - \033[0K\r"
+ tmp="$(docker images -q ${4})" &> /dev/null
+ if [ $? -eq 0 ] && [ ! -z "$tmp" ]; then
+ docker rmi $4 &> /dev/null
+ if [ $? -ne 0 ]; then
+ ((IMAGE_ERR++))
+ echo ""
+ echo -e $RED" Image could not be removed - try manual removal of the image"$ERED
+ return 1
+ fi
+ echo -e " Removing image - "$GREEN"removed"$EGREEN
+ else
+ echo -e " Removing image - "$GREEN"image not in repository"$EGREEN
+ fi
+ tmp_im=""
+ fi
+ if [ -z "$tmp_im" ]; then
+ echo -ne " Pulling image\033[0K\r"
+ docker pull $4 > /dev/null
+ tmp_im=$(docker images ${4} | grep -v REPOSITORY)
if [ -z "$tmp_im" ]; then
- echo "Image could not be pulled"
- exit 1
+ echo ""
+ echo -e " Pulling image -$RED could not be pulled"$ERED
+ ((IMAGE_ERR++))
+ return 1
fi
- echo -e "Policy Agent image: \033[1m"$tmp_im"\033[0m"
+ echo -e " Pulling image -$GREEN Pulled $EGREEN"
else
- echo -e "Policy Agent image: \033[1m"$tmp_im"\033[0m"
- echo "!! If the Policy Agent image seem outdated, consider removing it from your docker registry and run the test again."
+ echo -e " Pulling image -$GREEN OK $EGREEN(exists in local repository)"
fi
fi
+ return 0
+}
+
+
+echo -e $BOLD"Pulling configured images, if needed"$EBOLD
+
+app="Policy Agent"; __check_and_pull_image $1 "$app" $POLICY_AGENT_APP_NAME $POLICY_AGENT_IMAGE
+app="Non-RT RIC Control Panel"; __check_and_pull_image $1 "$app" $CONTROL_PANEL_APP_NAME $CONTROL_PANEL_IMAGE
+app="SDNC A1 Controller"; __check_and_pull_image $1 "$app" $SDNC_APP_NAME $SDNC_A1_CONTROLLER_IMAGE
+app="Near-RT RIC Simulator"; __check_and_pull_image $1 "$app" $RIC_SIM_PREFIX"_"$RIC_SIM_BASE $RIC_SIM_IMAGE
+
+app="Consul"; __check_and_pull_image $1 "$app" $CONSUL_APP_NAME $CONSUL_IMAGE
+app="CBS"; __check_and_pull_image $1 "$app" $CBS_APP_NAME $CBS_IMAGE
+app="SDNC DB"; __check_and_pull_image $1 "$app" $SDNC_APP_NAME $SDNC_DB_IMAGE
+
+# MR stub image not checked, will be built by this script - only local image
+# CR stub image not checked, will be built by this script - only local image
+
+
+#Errors in image setting - exit
+if [ $IMAGE_ERR -ne 0 ]; then
+ echo ""
+ echo "#################################################################################################"
+ echo -e $RED"One or more images could not be pulled or containers using the images could not be stopped/removed"$ERED
+ echo "#################################################################################################"
+ echo ""
+ exit 1
fi
echo ""
-echo "Building images for the simulators"
-if [ -z "$SIM_DIR" ]; then
- SIM_DIR=$(find . -type d -path "*a1-interface/near-rt-ric-simulator/scripts*" 2>/dev/null -print -quit)
- if [ ! -d $SIM_DIR ]; then
- echo "Trying to set env var SIM_DIR to dir 'a1-interface/near-rt-ric-simulator/scripts' in the sim repo, but failed."
- echo "It might be that you did not download the repository of the Near-rt-ric simulator.In that case, run the command:"
- echo "git clone 'https://gerrit.o-ran-sc.org/oransc/sim/a1-interface'"
- echo "Otherwise, please set the SIM_DIR manually in the test_env.sh"
- exit 1
- else
- echo "SIM_DIR auto set to: " $SIM_DIR
- fi
+echo -e $BOLD"Building images needed for test"$EBOLD
+
+curdir=$PWD
+cd $curdir
+cd ../mrstub
+echo " Building mrstub image: mrstub:latest"
+docker build -t mrstub . &> /dev/null
+if [ $? -eq 0 ]; then
+ echo -e $GREEN" Build Ok"$EGREEN
+else
+ echo -e $RED" Build Failed"$ERED
+ ((RES_CONF_FAIL++))
fi
-cd $SIM_DIR
-docker build -t ric-simulator:latest . &> /dev/null
cd $curdir
-echo ""
+cd ../cr
+echo " Building Callback Receiver image: callback-receiver:latest"
+docker build -t callback-receiver . &> /dev/null
+if [ $? -eq 0 ]; then
+ echo -e $GREEN" Build Ok"$EGREEN
+else
+ echo -e $RED" Build Failed"$ERED
+ ((RES_CONF_FAIL++))
+fi
+cd $curdir
-echo "Local registry images for simulators:"
-echo "Consul: " $(docker images | grep consul)
-echo "CBS: " $(docker images | grep platform.configbinding.app)
-echo "RIC: " $(docker images | grep ric-simulator)
echo ""
+# Create a table of the images used in the script
+echo -e $BOLD"Local docker registry images used in the this test script"$EBOLD
-__consul_config() {
+docker_tmp_file=.docker-images-table
+format_string="{{.Repository}}\\t{{.Tag}}\\t{{.CreatedSince}}\\t{{.Size}}"
+echo -e " Application\tRepository\tTag\tCreated Since\tSize" > $docker_tmp_file
+echo -e " Policy Agent\t$(docker images --format $format_string $POLICY_AGENT_IMAGE)" >> $docker_tmp_file
+echo -e " Control Panel\t$(docker images --format $format_string $CONTROL_PANEL_IMAGE)" >> $docker_tmp_file
+echo -e " SDNC A1 Controller\t$(docker images --format $format_string $SDNC_A1_CONTROLLER_IMAGE)" >> $docker_tmp_file
+echo -e " RIC Simulator\t$(docker images --format $format_string $RIC_SIM_IMAGE)" >> $docker_tmp_file
+echo -e " Message Router\t$(docker images --format $format_string $MRSTUB_IMAGE)" >> $docker_tmp_file
+echo -e " Callback Receiver\t$(docker images --format $format_string $CR_IMAGE)" >> $docker_tmp_file
+echo -e " Consul\t$(docker images --format $format_string $CONSUL_IMAGE)" >> $docker_tmp_file
+echo -e " CBS\t$(docker images --format $format_string $CBS_IMAGE)" >> $docker_tmp_file
+echo -e " SDNC DB\t$(docker images --format $format_string $SDNC_DB_IMAGE)" >> $docker_tmp_file
- appname=$PA_APP_BASE
+column -t -s $'\t' $docker_tmp_file
- echo "Configuring consul for " $appname " from " $1
- curl -s http://127.0.0.1:${CONSUL_PORT}/v1/kv/${appname}?dc=dc1 -X PUT -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' --data-binary "@"$1 >/dev/null
-}
+echo ""
+echo -e $BOLD"======================================================="$EBOLD
+echo -e $BOLD"== Common test setup completed - test script begins =="$EBOLD
+echo -e $BOLD"======================================================="$EBOLD
+echo ""
-consul_config_app() {
+# Function to print the test result, shall be the last cmd in a test script
+# args: -
+# (Function for test scripts)
+print_result() {
+
+ TCTEST_END=$SECONDS
+ duration=$((TCTEST_END-TCTEST_START))
+
+ echo "-------------------------------------------------------------------------------------------------"
+ echo "------------------------------------- Test case: "$ATC
+ echo "------------------------------------- Ended: "$(date)
+ echo "-------------------------------------------------------------------------------------------------"
+ echo "-- Description: "$TC_ONELINE_DESCR
+ echo "-- Execution time: " $duration " seconds"
+ echo "-------------------------------------------------------------------------------------------------"
+ echo "------------------------------------- RESULTS"
+ echo ""
- __consul_config $1
-}
+ total=$((RES_PASS+RES_FAIL))
+ if [ $RES_TEST -eq 0 ]; then
+ echo -e "\033[1mNo tests seem to have been executed. Check the script....\033[0m"
+ echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
+ echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
+ echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
+ echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
+ elif [ $total != $RES_TEST ]; then
+ echo -e "\033[1mTotal number of tests does not match the sum of passed and failed tests. Check the script....\033[0m"
+ echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
+ echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
+ echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
+ echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
+ elif [ $RES_CONF_FAIL -ne 0 ]; then
+ echo -e "\033[1mOne or more configure regest has failed. Check the script log....\033[0m"
+ echo -e "\033[31m\033[1m ___ ___ ___ ___ ___ _____ ___ _ ___ _ _ _ ___ ___ \033[0m"
+ echo -e "\033[31m\033[1m/ __|/ __| _ \_ _| _ \_ _| | __/_\ |_ _| | | | | | _ \ __|\033[0m"
+ echo -e "\033[31m\033[1m\__ \ (__| /| || _/ | | | _/ _ \ | || |_| |_| | / _| \033[0m"
+ echo -e "\033[31m\033[1m|___/\___|_|_\___|_| |_| |_/_/ \_\___|____\___/|_|_\___|\033[0m"
+ elif [ $RES_PASS = $RES_TEST ]; then
+ echo -e "All tests \033[32m\033[1mPASS\033[0m"
+ echo -e "\033[32m\033[1m ___ _ ___ ___ \033[0m"
+ echo -e "\033[32m\033[1m | _ \/_\ / __/ __| \033[0m"
+ echo -e "\033[32m\033[1m | _/ _ \\__ \__ \\ \033[0m"
+ echo -e "\033[32m\033[1m |_|/_/ \_\___/___/ \033[0m"
+ echo ""
+
+ # Update test suite counter
+ if [ -f .tmp_tcsuite_pass_ctr ]; then
+ tmpval=$(< .tmp_tcsuite_pass_ctr)
+ ((tmpval++))
+ echo $tmpval > .tmp_tcsuite_pass_ctr
+ fi
+ if [ -f .tmp_tcsuite_pass ]; then
+ echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_pass
+ fi
+ else
+ echo -e "One or more tests with status \033[31m\033[1mFAIL\033[0m "
+ echo -e "\033[31m\033[1m ___ _ ___ _ \033[0m"
+ echo -e "\033[31m\033[1m | __/_\ |_ _| | \033[0m"
+ echo -e "\033[31m\033[1m | _/ _ \ | || |__ \033[0m"
+ echo -e "\033[31m\033[1m |_/_/ \_\___|____|\033[0m"
+ echo ""
+ # Update test suite counter
+ if [ -f .tmp_tcsuite_fail_ctr ]; then
+ tmpval=$(< .tmp_tcsuite_fail_ctr)
+ ((tmpval++))
+ echo $tmpval > .tmp_tcsuite_fail_ctr
+ fi
+ if [ -f .tmp_tcsuite_fail ]; then
+ echo " - "$ATC " -- "$TC_ONELINE_DESCR" Execution time: "$duration" seconds" >> .tmp_tcsuite_fail
+ fi
+ fi
+ echo "++++ Number of tests: "$RES_TEST
+ echo "++++ Number of passed tests: "$RES_PASS
+ echo "++++ Number of failed tests: "$RES_FAIL
+ echo ""
+ echo "++++ Number of failed configs: "$RES_CONF_FAIL
+ echo "------------------------------------- Test case complete ---------------------------------"
+ echo "-------------------------------------------------------------------------------------------------"
+ echo ""
+}
+#####################################################################
+###### Functions for start, configuring, stoping, cleaning etc ######
+#####################################################################
-start_ric_simulator() {
- DOCKER_SIM_NWNAME="nonrtric-docker-net"
- echo "Creating docker network $DOCKER_SIM_NWNAME, if needed"
- docker network ls| grep $DOCKER_SIM_NWNAME > /dev/null || docker network create $DOCKER_SIM_NWNAME
+# Stop and remove all containers
+# args: -
+# (Function for test scripts)
+clean_containers() {
- echo "start ric simulator"
- curdir=$PWD
- cd $SIM_GROUP
- cd ric/
+ echo -e $BOLD"Stopping and removing all running containers, by container name"$EBOLD
+
+ CONTAINTER_NAMES=("Policy Agent " $POLICY_AGENT_APP_NAME\
+ "Non-RT RIC Simulator(s)" $RIC_SIM_PREFIX\
+ "Message Router " $MR_APP_NAME\
+ "Callback Receiver " $CR_APP_NAME\
+ "Control Panel " $CONTROL_PANEL_APP_NAME\
+ "SDNC A1 Controller " $SDNC_APP_NAME\
+ "SDNC DB " $SDNC_DB_APP_NAME\
+ "CBS " $CBS_APP_NAME\
+ "Consul " $CONSUL_APP_NAME)
+
+ nw=0 # Calc max width of container name, to make a nice table
+ for (( i=1; i<${#CONTAINTER_NAMES[@]} ; i+=2 )) ; do
+ if [ ${#CONTAINTER_NAMES[i]} -gt $nw ]; then
+ nw=${#CONTAINTER_NAMES[i]}
+ fi
+ done
- docker-compose up --scale ric-simulator=$RIC_NUMBER -d
+ for (( i=0; i<${#CONTAINTER_NAMES[@]} ; i+=2 )) ; do
+ APP="${CONTAINTER_NAMES[i]}"
+ CONTR="${CONTAINTER_NAMES[i+1]}"
+ for((w=${#CONTR}; w<$nw; w=w+1)); do
+ CONTR="$CONTR "
+ done
+ echo -ne " $APP: $CONTR - ${GREEN}stopping${EGREEN}\033[0K\r"
+ docker stop $(docker ps -qa --filter name=${CONTR}) &> /dev/null
+ echo -ne " $APP: $CONTR - ${GREEN}stopped${EGREEN}\033[0K\r"
+ docker rm $(docker ps -qa --filter name=${CONTR}) &> /dev/null
+ echo -e " $APP: $CONTR - ${GREEN}stopped removed${EGREEN}"
+ done
- cd $curdir
echo ""
}
-start_dashboard() {
-
- DOCKER_SIM_NWNAME="nonrtric-docker-net"
- echo "Creating docker network $DOCKER_SIM_NWNAME, if needed"
- docker network ls| grep $DOCKER_SIM_NWNAME > /dev/null || docker network create $DOCKER_SIM_NWNAME
-
- echo "start Control Panel"
- curdir=$PWD
- cd $SIM_GROUP
- cd dashboard/
+# Function stop and remove all container in the end of the test script, if the arg 'auto-clean' is given at test script start
+# args: -
+# (Function for test scripts)
+auto_clean_containers() {
+ echo
+ if [ "$AUTO_CLEAN" == "auto" ]; then
+ echo -e $BOLD"Initiating automatic cleaning of started containers"$EBOLD
+ clean_containers
+ fi
+}
- docker-compose up -d
+# Function to sleep a test case for a numner of seconds. Prints the optional text args as info
+# args: <sleep-time-in-sec> [any-text-in-quoteds-to-printed]
+# (Function for test scripts)
+sleep_wait() {
- cd $curdir
+ echo -e $BOLD"INFO(${BASH_LINENO[0]}): "${FUNCNAME[0]}"," $@ $EBOLD
+ if [ $# -lt 1 ]; then
+ ((RES_CONF_FAIL++))
+ __print_err "need at least one arg, <sleep-time-in-sec> [any-text-to-printed]" $@
+ exit 1
+ fi
+ #echo "---- Sleep for " $1 " seconds ---- "$2
+ start=$SECONDS
+ duration=$((SECONDS-start))
+ while [ $duration -lt $1 ]; do
+ echo -ne " Slept for ${duration} seconds\033[0K\r"
+ sleep 1
+ duration=$((SECONDS-start))
+ done
+ echo -ne " Slept for ${duration} seconds\033[0K\r"
echo ""
}
-start_sdnc() {
-
- if [ $SDNC == "sdnc" ]; then
- DOCKER_SIM_NWNAME="nonrtric-docker-net"
- echo "Creating docker network $DOCKER_SIM_NWNAME, if needed"
- docker network ls| grep $DOCKER_SIM_NWNAME > /dev/null || docker network create $DOCKER_SIM_NWNAME
+# Print error info for the call in the parent script (test case). Arg: <error-message-to-print>
+# Not to be called from the test script itself.
+__print_err() {
+ echo -e $RED ${FUNCNAME[1]} " "$1" " ${BASH_SOURCE[2]} " line" ${BASH_LINENO[1]} $ERED
+ if [ $# -gt 1 ]; then
+ echo -e $RED" Got: "${FUNCNAME[1]} ${@:2} $ERED
+ fi
+}
- echo "start sdnc"
- curdir=$PWD
- cd $SIM_GROUP
- cd sdnc/
- docker-compose up -d a1-controller
+# Helper function to get a the port of a specific ric simulatpor
+# args: <ric-id>
+# (Not for test scripts)
+__find_sim_port() {
+ name=$1" " #Space appended to prevent matching 10 if 1 is desired....
+ cmdstr="docker ps --filter name=${name} --format \"{{.Names}} {{.Ports}}\" | grep '${name}' | sed s/0.0.0.0:// | cut -f 2 -d ' ' | cut -f 1 -d '-'"
+ res=$(eval $cmdstr)
+ if [[ "$res" =~ ^[0-9]+$ ]]; then
+ echo $res
+ else
+ echo "0"
+ fi
+}
- cd $curdir
- echo ""
+# Function to create the docker network for the test
+# Not to be called from the test script itself.
+__create_docker_network() {
+ tmp=$(docker network ls -q --filter name=$DOCKER_SIM_NWNAME)
+ if [ $? -ne 0 ]; then
+ echo -e $RED" Could not check if docker network $DOCKER_SIM_NWNAME exists"$ERED
+ return 1
+ fi
+ if [ -z tmp ]; then
+ echo -e "Creating docker network:$BOLD $DOCKER_SIM_NWNAME $EBOLD"
+ docker network create $DOCKER_SIM_NWNAME
+ if [ $? -ne 0 ]; then
+ echo -e $RED" Could not create docker network $DOCKER_SIM_NWNAME"$ERED
+ return 1
+ fi
+ else
+ echo -e " Docker network $DOCKER_SIM_NWNAME already exists$GREEN OK $EGREEN"
fi
}
-prepare_consul_config() {
- echo "prepare consul config"
- curdir=$PWD
- cd $SIM_GROUP
- cd ric/
+# Check if container is started by calling url on localhost using a port, expects response code 2XX
+# args: <container-name> <port> <url>
+# Not to be called from the test script itself.
+__check_container_start() {
+ if [ $# -ne 3 ]; then
+ ((RES_CONF_FAIL++))
+ __print_err "need 3 args, <container-name> <port> <url>" $@
+ return 1
+ fi
+ echo -ne " Container $BOLD$1$EBOLD starting\033[0K\r"
+ appname=$1
+ localport=$2
+ url=$3
+ pa_started=false
+ for i in {1..10}; do
+ if [ $(docker inspect --format '{{ .State.Running }}' $appname) ]; then
+ echo -e " Container $BOLD$1$EBOLD$GREEN running$EGREEN on$BOLD image $(docker inspect --format '{{ .Config.Image }}' ${appname}) $EBOLD"
+ pa_started=true
+ break
+ else
+ sleep $i
+ fi
+ done
+ if ! [ $pa_started ]; then
+ ((RES_CONF_FAIL++))
+ echo ""
+ echo -e $RED" Container $BOLD${appname}$EBOLD could not be started"$ERED
+ return 1
+ fi
+ if [ $localport -eq 0 ]; then
+ while [ $localport -eq 0 ]; do
+ echo -ne " Waiting for container ${appname} to publish its ports...\033[0K\r"
+ localport=$(__find_sim_port $appname)
+ sleep 1
+ echo -ne " Waiting for container ${appname} to publish its ports...retrying....\033[0K\r"
+ done
+ echo -ne " Waiting for container ${appname} to publish its ports...retrying....$GREEN OK $EGREEN"
+ echo ""
+ fi
+
+ pa_st=false
+ echo -ne " Waiting for container ${appname} service status...\033[0K\r"
+ for i in {1..20}; do
+ result="$(__do_curl $LOCALHOST${localport}${url})"
+ if [ $? -eq 0 ]; then
+ if [ ${#result} -gt 15 ]; then
+ #If response is too long, truncate
+ result="...response text too long, omitted"
+ fi
+ echo -ne " Waiting for container $BOLD${appname}$EBOLD service status, result: $result\033[0K\r"
+ echo -ne " Container $BOLD${appname}$EBOLD$GREEN is alive$EGREEN, responds to service status:$GREEN $result $EGREEN"
+ pa_st=true
+ break
+ else
+ #echo " Retrying in $i seconds"
+ echo -ne " Waiting for container ${appname} service status...retrying in $i seconds\033[0K\r"
+ sleep $i
+ fi
+ done
- python3 cleanConsul.py
- python3 prepareConsul.py
+ if [ "$pa_st" = "false" ]; then
+ ((RES_CONF_FAIL++))
+ echo -e $RED" Container ${appname} did not respond to service status"$ERED
+ return 0
+ fi
- cd $curdir
echo ""
+ return 0
+}
-}
+# Function to start a container and wait until it responds on the given port and url.
+#args: <docker-compose-dir> NODOCKERARGS|<docker-compose-arg> <app-name> <port-number> <alive-url> [<app-name> <port-number> <alive-url>]*
+__start_container() {
+ variableArgCount=$(($#-2))
+ if [ $# -lt 5 ] && [ [ $(($variableArgCount%3)) -ne 0 ]; then
+ ((RES_CONF_FAIL++))
+ __print_err "need 5 or more args, <docker-compose-dir> NODOCKERARGS|<docker-compose-arg> <app-name> <port-number> <alive-url> [<app-name> <port-number> <alive-url>]*" $@
+ exit 1
+ fi
-# Start all simulators in the simulator group
-start_simulators() {
+ __create_docker_network
- echo "Starting all simulators"
curdir=$PWD
cd $SIM_GROUP
+ cd $1
+
+ if [ "$2" == "NODOCKERARGS" ]; then
+ docker-compose up -d &> /dev/null
+ else
+ docker-compose up -d $2 &> /dev/null
+ fi
+
+ shift; shift;
+ cntr=0
+ while [ $cntr -lt $variableArgCount ]; do
+ app=$1; shift;
+ port=$1; shift;
+ url=$1; shift;
+ let cntr=cntr+3
+
+ __check_container_start "$app" "$port" "$url"
+ done
- $SIM_GROUP/simulators-start.sh
cd $curdir
echo ""
+ return 0
}
+####################
+### Consul functions
+####################
+# Function to load config from a file into consul for the Policy Agent
+# arg: <json-config-file>
+# (Function for test scripts)
+consul_config_app() {
+
+ echo -e $BOLD"Configuring Consul"$EBOLD
+
+ if [ $# -ne 1 ]; then
+ ((RES_CONF_FAIL++))
+ __print_err "need one arg, <json-config-file>" $@
+ exit 1
+ fi
+
+ echo " Loading config for "$POLICY_AGENT_APP_NAME" from "$1
+
+ curl -s $LOCALHOST${CONSUL_EXTERNAL_PORT}/v1/kv/${POLICY_AGENT_APP_NAME}?dc=dc1 -X PUT -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' --data-binary "@"$1 >/dev/null
+ if [ $? -ne 0 ]; then
+ echo -e $RED" FAIL - json config could not be loaded to consul" $ERED
+ ((RES_CONF_FAIL++))
+ return 1
+ fi
+ body="$(__do_curl $LOCALHOST$CBS_EXTERNAL_PORT/service_component_all/$POLICY_AGENT_APP_NAME)"
+
+ if [ $? -ne 0 ]; then
+ echo -e $RED" FAIL - json config could not be loaded from consul/cbs, contents cannot be checked." $ERED
+ ((RES_CONF_FAIL++))
+ return 1
+ else
+ targetJson=$(< $1)
+ targetJson="{\"config\":"$targetJson"}"
+ echo "TARGET JSON: $targetJson" >> $HTTPLOG
+ res=$(python ../common/compare_json.py "$targetJson" "$body")
+ if [ $res -ne 0 ]; then
+ echo -e $RED" FAIL - policy json config read from consul/cbs is not equal to the intended json config...." $ERED
+ ((RES_CONF_FAIL++))
+ return 1
+ else
+ echo -e $GREEN" Config loaded ok to consul"$EGREEN
+ fi
+ fi
-clean_containers() {
- echo "Stopping all containers, Policy Agent app(s) and simulators with name prefix 'policy-agent'"
- docker stop $(docker ps -q --filter name=/policy-agent) &> /dev/null
- echo "Removing all containers, Policy Agent app and simulators with name prefix 'policy-agent'"
- docker rm $(docker ps -a -q --filter name=/policy-agent) &> /dev/null
- echo "Stopping all containers, Policy Agent app(s) and simulators with name prefix 'ric-simulator'"
- docker stop $(docker ps -q --filter name=ric-simulator) &> /dev/null
- echo "Removing all containers, Policy Agent app and simulators with name prefix 'ric-simulator'"
- docker rm $(docker ps -a -q --filter name=ric-simulator) &> /dev/null
- echo "Removing all containers, Policy Agent app and simulators with name prefix 'dashboard'"
- docker rm $(docker ps -a -q --filter name=dashboard) &> /dev/null
- echo "Removing all containers, Policy Agent app and simulators with name prefix 'a1-controller'"
- docker rm $(docker ps -a -q --filter name=a1-controller) &> /dev/null
- echo "Removing all containers, Policy Agent app and simulators with name prefix 'sdnc_db_container'"
- docker rm $(docker ps -a -q --filter name=sdnc_db_container) &> /dev/null
- echo "Removing all containers, Policy Agent app and simulators with name prefix 'cbs'"
- docker rm $(docker ps -a -q --filter name=polman_cbs) &> /dev/null
- echo "Removing all containers, Policy Agent app and simulators with name prefix 'consul'"
- docker rm $(docker ps -a -q --filter name=polman_consul) &> /dev/null
- echo "Removing unused docker networks with substring 'nonrtric' in network name"
- docker network rm $(docker network ls -q --filter name=nonrtric)
echo ""
+
}
-start_policy_agent() {
+# Function to perpare the consul configuration according to the current simulator configuration
+# args: SDNC|NOSDNC <output-file>
+# (Function for test scripts)
+prepare_consul_config() {
+ echo -e $BOLD"Prepare Consul config"$EBOLD
- appname=$PA_APP_BASE
+ echo " Writing consul config for "$POLICY_AGENT_APP_NAME" to file: "$2
- if [ $START_ARG == "local" ] || [ $START_ARG == "remote" ]; then
- __start_policy_agent_image $appname
+ if [ $# != 2 ]; then
+ ((RES_CONF_FAIL++))
+ __print_err "need two args, SDNC|NOSDNC <output-file>" $@
+ exit 1
fi
-}
-__start_policy_agent_image() {
+ if [ $1 == "SDNC" ]; then
+ echo -e " Config$BOLD including SDNC$EBOLD configuration"
+ elif [ $1 == "NOSDNC" ]; then
+ echo -e " Config$BOLD excluding SDNC$EBOLD configuration"
+ else
+ ((RES_CONF_FAIL++))
+ __print_err "need two args, SDNC|NOSDNC <output-file>" $@
+ exit 1
+ fi
- appname=$1
- localport=$POLICY_AGENT_PORT
+ config_json="\n {"
+ if [ $1 == "SDNC" ]; then
+ config_json=$config_json"\n \"controller\": ["
+ config_json=$config_json"\n {"
+ config_json=$config_json"\n \"name\": \"$SDNC_APP_NAME\","
+ config_json=$config_json"\n \"baseUrl\": \"http://$SDNC_APP_NAME:$SDNC_INTERNAL_PORT\","
+ config_json=$config_json"\n \"userName\": \"$SDNC_USER\","
+ config_json=$config_json"\n \"password\": \"$SDNC_PWD\""
+ config_json=$config_json"\n }"
+ config_json=$config_json"\n ],"
+ fi
- echo "Creating docker network $DOCKER_SIM_NWNAME, if needed"
- docker network ls| grep $DOCKER_SIM_NWNAME > /dev/null || docker network create $DOCKER_SIM_NWNAME
+ config_json=$config_json"\n \"streams_publishes\": {"
+ config_json=$config_json"\n \"dmaap_publisher\": {"
+ config_json=$config_json"\n \"type\": \"$MR_APP_NAME\","
+ config_json=$config_json"\n \"dmaap_info\": {"
+ config_json=$config_json"\n \"topic_url\": \"http://$MR_APP_NAME:$MR_INTERNAL_PORT/events/A1-POLICY-AGENT-WRITE\""
+ config_json=$config_json"\n }"
+ config_json=$config_json"\n }"
+ config_json=$config_json"\n },"
+ config_json=$config_json"\n \"streams_subscribes\": {"
+ config_json=$config_json"\n \"dmaap_subscriber\": {"
+ config_json=$config_json"\n \"type\": \"$MR_APP_NAME\","
+ config_json=$config_json"\n \"dmaap_info\": {"
+ config_json=$config_json"\n \"topic_url\": \"http://$MR_APP_NAME:$MR_INTERNAL_PORT/events/A1-POLICY-AGENT-READ/users/policy-agent\""
+ config_json=$config_json"\n }"
+ config_json=$config_json"\n }"
+ config_json=$config_json"\n },"
+
+ config_json=$config_json"\n \"ric\": ["
+
+ rics=$(docker ps | grep ricsim | awk '{print $NF}')
+
+ if [ $? -ne 0 ] || [ -z "$rics" ]; then
+ echo -e $RED" FAIL - the names of the running RIC Simulator cannot be retrieved." $ERED
+ ((RES_CONF_FAIL++))
+ return 1
+ fi
- echo "Starting Policy Agent: " $appname " with ports mapped to " $localport " in docker network "$DOCKER_SIM_NWNAME
- docker run -d -p $localport":8081" --network=$DOCKER_SIM_NWNAME -e CONSUL_HOST=$CONSUL_HOST -e CONSUL_PORT=$CONSUL_PORT -e CONFIG_BINDING_SERVICE=$CONFIG_BINDING_SERVICE -e HOSTNAME=$appname --name $appname $POLICY_AGENT_IMAGE
- #docker run -d -p 8081:8081 --network=nonrtric-docker-net -e CONSUL_HOST=CONSUL_HOST=$CONSUL_HOST -e CONSUL_PORT=$CONSUL_PORT -e CONFIG_BINDING_SERVICE=$CONFIG_BINDING_SERVICE -e HOSTNAME=policy-agent
- sleep 3
- set +x
- pa_started=false
- for i in {1..10}; do
- if [ $(docker inspect --format '{{ .State.Running }}' $appname) ]
- then
- echo " Image: $(docker inspect --format '{{ .Config.Image }}' ${appname})"
- echo "Policy Agent container ${appname} running"
- pa_started=true
- break
- else
- sleep $i
- fi
+ cntr=0
+ for ric in $rics; do
+ if [ $cntr -gt 0 ]; then
+ config_json=$config_json"\n ,"
+ fi
+ config_json=$config_json"\n {"
+ config_json=$config_json"\n \"name\": \"$ric\","
+ config_json=$config_json"\n \"baseUrl\": \"http://$ric:$RIC_SIM_INTERNAL_PORT\","
+ if [ $1 == "SDNC" ]; then
+ config_json=$config_json"\n \"controller\": \"$SDNC_APP_NAME\","
+ fi
+ config_json=$config_json"\n \"managedElementIds\": ["
+ config_json=$config_json"\n \"me1_$ric\","
+ config_json=$config_json"\n \"me2_$ric\""
+ config_json=$config_json"\n ]"
+ config_json=$config_json"\n }"
+ let cntr=cntr+1
done
- if ! [ $pa_started ]; then
- echo "Policy Agent container ${appname} could not be started"
+
+ config_json=$config_json"\n ]"
+ config_json=$config_json"\n}"
+
+
+ printf "$config_json">$2
+
+ echo ""
+}
+
+
+# Start Consul and CBS
+# args: -
+# (Function for test scripts)
+start_consul_cbs() {
+
+ echo -e $BOLD"Starting Consul and CBS"$EBOLD
+
+ __start_container consul_cbs NODOCKERARGS "$CONSUL_APP_NAME" "$CONSUL_EXTERNAL_PORT" "/ui/dc1/kv" \
+ "$CBS_APP_NAME" "$CBS_EXTERNAL_PORT" "/healthcheck"
+}
+
+###########################
+### RIC Simulator functions
+###########################
+
+# Start one group (ricsim_g1, ricsim_g2 or ricsim_g3) with a number of RIC Simulators using a given A interface
+# args: ricsim_g1|ricsim_g2|ricsim_g3 <count> <interface-id>
+# (Function for test scripts)
+start_ric_simulators() {
+
+ echo -e $BOLD"Starting RIC Simulators"$EBOLD
+
+ if [ $# != 3 ]; then
+ ((RES_CONF_FAIL++))
+ __print_err "need three args, ricsim_g1|ricsim_g2|ricsim_g3 <count> <interface-id>" $@
+ exit 1
+ fi
+ echo " $2 simulators using basename: $1 on interface: $3"
+ #Set env var for simulator count and A1 interface vesion for the given group
+ if [ $1 == "ricsim_g1" ]; then
+ G1_COUNT=$2
+ G1_A1_VERSION=$3
+ elif [ $1 == "ricsim_g2" ]; then
+ G2_COUNT=$2
+ G2_A1_VERSION=$3
+ elif [ $1 == "ricsim_g3" ]; then
+ G3_COUNT=$2
+ G3_A1_VERSION=$3
+ else
+ ((RES_CONF_FAIL++))
+ __print_err "need three args, gricsim_g1|ricsim_g2|ricsim_g3 <count> <interface-id>" $@
exit 1
fi
- pa_st=false
- echo "Waiting for Policy Agent ${appname} service status..."
- for i in {1..10}; do
- result="$(__do_curl http://127.0.0.1:${localport}/status)"
- if [ $? -eq 0 ]; then
- echo "Policy Agent ${appname} responds to service status: " $result
- echo "Policy Agent is alive."
- pa_st=true
- break
- else
- sleep $i
- fi
+ # Create .env file to compose project, all ric container will get this prefix
+ echo "COMPOSE_PROJECT_NAME="$RIC_SIM_PREFIX > $SIM_GROUP/ric/.env
+
+ export G1_A1_VERSION
+ export G2_A1_VERSION
+ export G3_A1_VERSION
+
+ docker_args="--scale g1=$G1_COUNT --scale g2=$G2_COUNT --scale g3=$G3_COUNT"
+ app_data=""
+ cntr=1
+ while [ $cntr -le $2 ]; do
+ app=$1"_"$cntr
+ port=0
+ app_data="$app_data $app $port /"
+ let cntr=cntr+1
done
- if [ "$pa_st" = "false" ]; then
- echo "Policy Agent ${appname} did not respond to service status"
- exit 1
+ __start_container ric "$docker_args" $app_data
+
+}
+
+###########################
+### Control Panel functions
+###########################
+
+# Start the Control Panel container
+# args: -
+# (Function for test scripts)
+start_control_panel() {
+
+ echo -e $BOLD"Starting Control Panel"$EBOLD
+
+ __start_container control_panel NODOCKERARGS $CONTROL_PANEL_APP_NAME $CONTROL_PANEL_EXTERNAL_PORT "/"
+
+}
+
+##################
+### SDNC functions
+##################
+
+# Start the SDNC A1 Controller
+# args: -
+# (Function for test scripts)
+start_sdnc() {
+
+ echo -e $BOLD"Starting SDNC A1 Controller"$EBOLD
+
+ __start_container sdnc NODOCKERARGS $SDNC_APP_NAME $SDNC_EXTERNAL_PORT "/apidoc/explorer"
+
+}
+
+#####################
+### MR stub functions
+#####################
+
+# Start the Message Router stub interface in the simulator group
+# args: -
+# (Function for test scripts)
+start_mr() {
+
+ echo -e $BOLD"Starting Message Router 'mrstub'"$EBOLD
+
+ __start_container mr NODOCKERARGS $MR_APP_NAME $MR_EXTERNAL_PORT "/"
+
+}
+
+################
+### CR functions
+################
+
+# Start the Callback reciver in the simulator group
+# args: -
+# (Function for test scripts)
+start_cr() {
+
+ echo -e $BOLD"Starting Callback Receiver"$EBOLD
+
+ __start_container cr NODOCKERARGS $CR_APP_NAME $CR_EXTERNAL_PORT "/"
+
+}
+
+###########################
+### Policy Agents functions
+###########################
+
+# Start the policy agwent
+# args: -
+# (Function for test scripts)
+start_policy_agent() {
+
+ echo -e $BOLD"Starting Policy Agent"$EBOLD
+
+ __start_container policy_agent NODOCKERARGS $POLICY_AGENT_APP_NAME $POLICY_AGENT_EXTERNAL_PORT "/status"
+
+}
+
+# All calls to the agent will be directed to the agent REST interface from now on
+# args: -
+# (Function for test scripts)
+use_agent_rest() {
+ echo -e $BOLD"Using agent REST interface"$EBOLD
+ export ADAPTER=$RESTBASE
+ echo ""
+}
+
+# All calls to the agent will be directed to the agent dmaap interface from now on
+# args: -
+# (Function for test scripts)
+use_agent_dmaap() {
+ echo -e $BOLD"Using agent DMAAP interface"$EBOLD
+ export ADAPTER=$DMAAPBASE
+ echo ""
+
+}
+
+# Turn on debug level tracing in the agent
+# args: -
+# (Function for test scripts)
+set_agent_debug() {
+ echo -e $BOLD"Setting agent debug"$EBOLD
+ curl $LOCALHOST$POLICY_AGENT_EXTERNAL_PORT/actuator/loggers/org.oransc.policyagent -X POST -H 'Content-Type: application/json' -d '{"configuredLevel":"debug"}' &> /dev/null
+ if [ $? -ne 0 ]; then
+ __print_err "could not set debug mode" $@
+ return 1
fi
+ return 0
+ echo ""
}
-check_policy_agent_logs() {
+# Perform curl retries when making direct call to the agent for the specified http response codes
+# Speace separated list of http response codes
+# args: [<response-code>]*
+use_agent_retries() {
+ echo -e $BOLD"Do curl retries to the agent REST inteface for these response codes:$@"$EBOLD
+ AGENT_RETRY_CODES=$@
+ echo ""
+}
- appname=$PA_APP_BASE
- tmp=$(docker ps | grep $appname)
- if ! [ -z "$tmp" ]; then #Only check logs for running Policy Agent apps
- __check_policy_agent_log $appname
- fi
+#################
+### Log functions
+#################
+# Check the agent logs for WARNINGs and ERRORs
+# args: -
+# (Function for test scripts)
+
+check_policy_agent_logs() {
+ __check_container_logs "Policy Agent" $POLICY_AGENT_APP_NAME $POLICY_AGENT_LOGPATH
}
-__check_policy_agent_log() {
- echo "Checking $1 log $POLICY_AGENT_LOGPATH for WARNINGs and ERRORs"
- foundentries=$(docker exec -it $1 grep WARN /var/log/policy-agent/application.log | wc -l)
+check_control_panel_logs() {
+ __check_container_logs "Control Panel" $CONTROL_PANEL_APP_NAME $CONTROL_PANEL_LOGPATH
+}
+
+__check_container_logs() {
+ dispname=$1
+ appname=$2
+ logpath=$3
+ echo -e $BOLD"Checking $dispname container $appname log ($logpath) for WARNINGs and ERRORs"$EBOLD
+
+ #tmp=$(docker ps | grep $appname)
+ tmp=$(docker ps -q --filter name=$appname) #get the container id
+ if [ -z "$tmp" ]; then #Only check logs for running Policy Agent apps
+ echo $dispname" is not running, no check made"
+ return
+ fi
+ foundentries="$(docker exec -it $tmp grep WARN $logpath | wc -l)"
if [ $? -ne 0 ];then
- echo " Problem to search $1 log $POLICY_AGENT_LOGPATH"
+ echo " Problem to search $appname log $logpath"
else
if [ $foundentries -eq 0 ]; then
- echo " No WARN entries found in $1 log $POLICY_AGENT_LOGPATH"
+ echo " No WARN entries found in $appname log $logpath"
else
- echo -e " Found \033[1m"$foundentries"\033[0m WARN entries in $1 log $POLICY_AGENT_LOGPATH"
+ echo -e " Found \033[1m"$foundentries"\033[0m WARN entries in $appname log $logpath"
fi
fi
- foundentries=$(docker exec -it $1 grep ERR $POLICY_AGENT_LOGPATH | wc -l)
+ foundentries="$(docker exec -it $tmp grep ERR $logpath | wc -l)"
if [ $? -ne 0 ];then
- echo " Problem to search $1 log $POLICY_AGENT_LOGPATH"
+ echo " Problem to search $appname log $logpath"
else
if [ $foundentries -eq 0 ]; then
- echo " No ERR entries found in $1 log $POLICY_AGENT_LOGPATH"
+ echo " No ERR entries found in $appname log $logpath"
else
- echo -e " Found \033[1m"$foundentries"\033[0m ERR entries in $1 log $POLICY_AGENT_LOGPATH"
+ echo -e $RED" Found \033[1m"$foundentries"\033[0m"$RED" ERR entries in $appname log $logpath"$ERED
fi
fi
+ echo ""
}
+# Store all container logs and other logs in the log dir for the script
+# Logs are stored with a prefix in case logs should be stored several times during a test
+# args: <logfile-prefix>
+# (Function for test scripts)
store_logs() {
if [ $# != 1 ]; then
- __print_err "need one arg, <file-prefix>"
+ ((RES_CONF_FAIL++))
+ __print_err "need one arg, <file-prefix>" $@
exit 1
fi
- echo "Storing all container logs and Policy Agent app log using prefix: "$1
+ echo -e $BOLD"Storing all container logs, Policy Agent app log and consul config using prefix: "$1
+
+ docker logs $CONSUL_APP_NAME > $TESTLOGS/$ATC/$1_consul.log 2>&1
+ docker logs $CBS_APP_NAME > $TESTLOGS/$ATC/$1_cbs.log 2>&1
+ docker logs $POLICY_AGENT_APP_NAME > $TESTLOGS/$ATC/$1_policy-agent.log 2>&1
+ docker logs $CONSUL_APP_NAME > $TESTLOGS/$ATC/$1_control-panel.log 2>&1
+ docker logs $MR_APP_NAME > $TESTLOGS/$ATC/$1_mr.log 2>&1
+ docker logs $CR_APP_NAME > $TESTLOGS/$ATC/$1_cr.log 2>&1
+ cp .httplog_${ATC}.txt $TESTLOGS/$ATC/$1_httplog_${ATC}.txt 2>&1
+
+ docker exec -it $SDNC_APP_NAME cat /opt/opendaylight/data/log/karaf.log > $TESTLOGS/$ATC/$1_karaf.log 2>&1
- docker logs polman_consul > $TESTLOGS/$ATC/$1_consul.log 2>&1
- docker logs polman_cbs > $TESTLOGS/$ATC/$1_cbs.log 2>&1
+ rics=$(docker ps -f "name=$RIC_SIM_PREFIX" --format "{{.Names}}")
+ for ric in $rics; do
+ docker logs $ric > $TESTLOGS/$ATC/$1_$ric.log 2>&1
+ done
+ body="$(__do_curl $LOCALHOST$CBS_EXTERNAL_PORT/service_component_all/$POLICY_AGENT_APP_NAME)"
+ echo "$body" > $TESTLOGS/$ATC/$1_consul_config.json 2>&1
+ echo ""
}
+###############
+## Generic curl
+###############
+# Generic curl function, assumed all 200-codes are ok
+# args: <url>
+# returns: <returned response (without respose code)> or "<no-response-from-server>" or "<not found, <http-code>>""
+# returns: The return code is 0 for ok and 1 for not ok
__do_curl() {
- res=$(curl -skw "%{http_code}" $1)
+ echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
+ curlString="curl -skw %{http_code} $1"
+ echo " CMD: $curlString" >> $HTTPLOG
+ res=$($curlString)
+ echo " RESP: $res" >> $HTTPLOG
http_code="${res:${#res}-3}"
if [ ${#res} -eq 3 ]; then
echo "<no-response-from-server>"
return 1
else
- if [ $http_code -lt 200 ] && [ $http_code -gt 299]; then
+ if [ $http_code -lt 200 ] || [ $http_code -gt 299 ]; then
echo "<not found, resp:${http_code}>"
return 1
fi
fi
}
+#######################################
+### Basic helper function for test cases
+#######################################
+
+# Test a simulator container variable value towards target value using an condition operator with an optional timeout.
+# Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> - This test is done
+# immediately and sets pass or fail depending on the result of comparing variable and target using the operator.
+# Arg: <simulator-name> <host> <variable-name> <condition-operator> <target-value> <timeout> - This test waits up to the timeout
+# before setting pass or fail depending on the result of comparing variable and target using the operator.
+# If the <variable-name> has the 'json:' prefix, the the variable will be used as url and the <target-value> will be compared towards the length of the json array in the response.
+# Not to be called from test script.
+
+__var_test() {
+ checkjsonarraycount=0
+
+ if [ $# -eq 6 ]; then
+ if [[ $3 == "json:"* ]]; then
+ checkjsonarraycount=1
+ fi
+
+ #echo -e "---- ${1} sim test criteria: \033[1m ${3} \033[0m ${4} ${5} within ${6} seconds ----"
+ echo -e $BOLD"TEST(${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5} within ${6} seconds"
+ ((RES_TEST++))
+ start=$SECONDS
+ ctr=0
+ for (( ; ; )); do
+ if [ $checkjsonarraycount -eq 0 ]; then
+ result="$(__do_curl $2$3)"
+ retcode=$?
+ result=${result//[[:blank:]]/} #Strip blanks
+ else
+ path=${3:5}
+ result="$(__do_curl $2$path)"
+ retcode=$?
+ echo "$result" > .tmp.curl.json
+ result=$(python ../common/count_json_elements.py ".tmp.curl.json")
+ fi
+ duration=$((SECONDS-start))
+ echo -ne " Result=${result} after ${duration} seconds\033[0K\r"
+ let ctr=ctr+1
+ if [ $retcode -ne 0 ]; then
+ if [ $duration -gt $6 ]; then
+ ((RES_FAIL++))
+ #echo -e "---- \033[31m\033[1mFAIL\033[0m - Target ${3} ${4} ${5} not reached in ${6} seconds, result = ${result} ----"
+ echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
+ return
+ fi
+ elif [ $4 = "=" ] && [ "$result" -eq $5 ]; then
+ ((RES_PASS++))
+ echo -e " Result=${result} after ${duration} seconds\033[0K\r"
+ echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met in ${duration} seconds ----"
+ return
+ elif [ $4 = ">" ] && [ "$result" -gt $5 ]; then
+ ((RES_PASS++))
+ echo -e " Result=${result} after ${duration} seconds\033[0K\r"
+ echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met in ${duration} seconds, result = ${result} ----"
+ return
+ elif [ $4 = "<" ] && [ "$result" -lt $5 ]; then
+ ((RES_PASS++))
+ echo -e " Result=${result} after ${duration} seconds\033[0K\r"
+ echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met in ${duration} seconds, result = ${result} ----"
+ return
+ elif [ $4 = "contain_str" ] && [[ $result =~ $5 ]]; then
+ ((RES_PASS++))
+ echo -e " Result=${result} after ${duration} seconds\033[0K\r"
+ echo -e $GREEN" PASS${EGREEN} - Result=${result} after ${duration} seconds"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met in ${duration} seconds, result = ${result} ----"
+ return
+ else
+ if [ $duration -gt $6 ]; then
+ ((RES_FAIL++))
+ echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached in ${6} seconds, result = ${result}"
+ #echo -e "---- \033[31m\033[1mFAIL\033[0m - Target ${3} ${4} ${5} not reached in ${6} seconds, result = ${result} ----"
+ return
+ fi
+ fi
+ sleep 1
+ done
+ elif [ $# -eq 5 ]; then
+ if [[ $3 == "json:"* ]]; then
+ checkjsonarraycount=1
+ fi
+
+ #echo -e "---- ${1} sim test criteria: \033[1m ${3} \033[0m ${4} ${5} ----"
+ echo -e $BOLD"TEST(${BASH_LINENO[1]}): ${1}, ${3} ${4} ${5}"$EBOLD
+ ((RES_TEST++))
+ if [ $checkjsonarraycount -eq 0 ]; then
+ result="$(__do_curl $2$3)"
+ retcode=$?
+ result=${result//[[:blank:]]/} #Strip blanks
+ else
+ path=${3:5}
+ result="$(__do_curl $2$path)"
+ retcode=$?
+ echo "$result" > .tmp.curl.json
+ result=$(python ../common/count_json_elements.py ".tmp.curl.json")
+ fi
+ if [ $retcode -ne 0 ]; then
+ ((RES_FAIL++))
+ #echo -e "---- \033[31m\033[1mFAIL\033[0m - Target ${3} ${4} ${5} not reached, result = ${result} ----"
+ echo -e $RED" FAIL ${ERED}- ${3} ${4} ${5} not reached, result = ${result}"
+ elif [ $4 = "=" ] && [ "$result" -eq $5 ]; then
+ ((RES_PASS++))
+ echo -e $GREEN" PASS${EGREEN} - Result=${result}"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met"
+ elif [ $4 = ">" ] && [ "$result" -gt $5 ]; then
+ ((RES_PASS++))
+ echo -e $GREEN" PASS${EGREEN} - Result=${result}"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met, result = ${result} ----"
+ elif [ $4 = "<" ] && [ "$result" -lt $5 ]; then
+ ((RES_PASS++))
+ echo -e $GREEN" PASS${EGREEN} - Result=${result}"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met, result = ${result} ----"
+ elif [ $4 = "contain_str" ] && [[ $result =~ $5 ]]; then
+ ((RES_PASS++))
+ echo -e $GREEN" PASS${EGREEN} - Result=${result}"
+ #echo -e "---- \033[32m\033[1mPASS\033[0m - Test criteria met, result = ${result} ----"
+ else
+ ((RES_FAIL++))
+ echo -e $RED" FAIL${ERED} - ${3} ${4} ${5} not reached, result = ${result}"
+ #echo -e "---- \033[31m\033[1mFAIL\033[0m - Target ${3} ${4} ${5} not reached, result = ${result} ----"
+ fi
+ else
+ echo "Wrong args to __var_test, needs five or six args: <simulator-name> <host> <variable-name> <condition-operator> <target-value> [ <timeout> ]"
+ echo "Got:" $@
+ exit 1
+ fi
+}
+
+
+### Generic test cases for varaible checking
+
+# Tests if a variable value in the CR is equal to a target value and and optional timeout.
+# Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
+# equal to 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 becomes equal to the target
+# value or not.
+# (Function for test scripts)
+cr_equal() {
+ if [ $# -eq 2 ] || [ $# -eq 3 ]; then
+ __var_test "CR" "$LOCALHOST$CR_EXTERNAL_PORT/counter/" $1 "=" $2 $3
+ else
+ ((RES_CONF_FAIL++))
+ __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 MR stub is equal to a target value and and optional timeout.
+# Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
+# equal to 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 becomes equal to the target
+# value or not.
+# (Function for test scripts)
+mr_equal() {
+ if [ $# -eq 2 ] || [ $# -eq 3 ]; then
+ __var_test "MR" "$LOCALHOST$MR_EXTERNAL_PORT/counter/" $1 "=" $2 $3
+ else
+ ((RES_CONF_FAIL++))
+ __print_err "Wrong args to mr_equal, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
+ fi
+}
+
+# Tests if a variable value in the MR stub is greater than a target value and and optional timeout.
+# Arg: <variable-name> <target-value> - This test set pass or fail depending on if the variable is
+# greater than 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 becomes greater than the target
+# value or not.
+# (Function for test scripts)
+mr_greater() {
+ if [ $# -eq 2 ] || [ $# -eq 3 ]; then
+ __var_test "MR" "$LOCALHOST$MR_EXTERNAL_PORT/counter/" $1 "=" $2 $3
+ else
+ ((RES_CONF_FAIL++))
+ __print_err "Wrong args to mr_greater, needs two or three args: <sim-param> <target-value> [ timeout ]" $@
+ fi
+}
+
+# Read a variable value from MR sim and send to stdout. Arg: <variable-name>
+mr_read() {
+ echo "$(__do_curl $LOCALHOST$MR_EXTERNAL_PORT/counter/$1)"
+}
+
+# Print a variable value from the MR stub.
+# arg: <variable-name>
+# (Function for test scripts)
+mr_print() {
+ if [ $# != 1 ]; then
+ ((RES_CONF_FAIL++))
+ __print_err "need one arg, <mr-param>" $@
+ exit 1
+ fi
+ echo -e $BOLD"INFO(${BASH_LINENO[0]}): mrstub, $1 = $(__do_curl $LOCALHOST$MR_EXTERNAL_PORT/counter/$1)"$EBOLD
+}
+
+
Code Review / nonrtric.git / blobdiff