3 # ============LICENSE_START===============================================
4 # Copyright (C) 2020 Nordix Foundation. All rights reserved.
5 # ========================================================================
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ============LICENSE_END=================================================
21 ### Admin API functions for the RIC simulator
24 # Excute a curl cmd towards a ricsimulator and check the response code.
25 # args: <expected-response-code> <curl-cmd-string>
26 __execute_curl_to_sim() {
27 echo ${FUNCNAME[1]} "line: "${BASH_LINENO[1]} >> $HTTPLOG
28 echo " CMD: $2" >> $HTTPLOG
30 echo " RESP: $res" >> $HTTPLOG
32 if [ $retcode -ne 0 ]; then
34 echo " RETCODE: "$retcode
35 echo -e $RED" FAIL - fatal error when executing curl."$ERED
38 status=${res:${#res}-3}
39 if [ $status -eq $1 ]; then
40 echo -e $GREEN" OK"$EGREEN
43 echo -e $RED" FAIL - expected http response: "$1" but got http response: "$status $ERED
48 # Tests if a variable value in the ricsimulator is equal to a target value and and optional timeout.
49 # Arg: <ric-id> <variable-name> <target-value> - This test set pass or fail depending on if the variable is
50 # equal to the target or not.
51 # Arg: <ric-id> <variable-name> <target-value> <timeout-in-sec> - This test waits up to the timeout seconds
52 # before setting pass or fail depending on if the variable value becomes equal to the target
54 # (Function for test scripts)
57 if [ $# -eq 3 ] || [ $# -eq 4 ]; then
58 port=$(__find_sim_port $1)
59 __var_test $1 "$RIC_SIM_LOCALHOST$port/counter/" $2 "=" $3 $4
62 __print_err "needs three or four args: <ric-id> <sim-param> <target-value> [ timeout ]"
67 # Print a variable value from the RIC sim.
68 # args: <ric-id> <variable-name>
69 # (Function for test scripts)
73 __print_err "need two args, <ric-id> <sim-param>" $@
76 port=$(__find_sim_port $1)
77 echo -e $BOLD"INFO(${BASH_LINENO[0]}): $1, $2 = $(__do_curl $RIC_SIM_LOCALHOST$port/counter/$2)"$EBOLD
80 # Tests if a variable value in the RIC simulator contains the target string and and optional timeout
81 # Arg: <ric-id> <variable-name> <target-value> - This test set pass or fail depending on if the variable contains
83 # Arg: <ric-id> <variable-name> <target-value> <timeout-in-sec> - This test waits up to the timeout seconds
84 # before setting pass or fail depending on if the variable value contains the target
86 # (Function for test scripts)
89 if [ $# -eq 3 ] || [ $# -eq 4 ]; then
90 port=$(__find_sim_port $1)
91 __var_test $1 "$RIC_SIM_LOCALHOST$port/counter/" $2 "contain_str" $3 $4
94 __print_err "needs three or four args: <ric-id> <sim-param> <target-value> [ timeout ]"
99 # Simulator API: Put a policy type in a ric
100 # args: <response-code> <ric-id> <policy-type-id> <policy-type-file>
101 # (Function for test scripts)
102 sim_put_policy_type() {
104 if [ $# -ne 4 ]; then
105 __print_err "<response-code> <ric-id> <policy-type-id> <policy-type-file>" $@
108 res=$(__find_sim_port $2)
109 curlString="curl -X PUT -skw %{http_code} $RIC_SIM_LOCALHOST"$res"/policytype?id="$3" -H Content-Type:application/json --data-binary @"$4
110 __execute_curl_to_sim $1 "$curlString"
114 # Simulator API: Delete a policy type in a ric
115 # <response-code> <ric-id> <policy-type-id>
116 # (Function for test scripts)
117 sim_delete_policy_type() {
119 if [ $# -ne 3 ]; then
120 __print_err "<response-code> <ric-id> <policy_type_id>" $@
123 res=$(__find_sim_port $2)
124 curlString="curl -X DELETE -skw %{http_code} $RIC_SIM_LOCALHOST"$res"/policytype?id="$3
125 __execute_curl_to_sim $1 "$curlString"
129 # Simulator API: Delete instances (and status), for one ric
130 # <response-code> <ric-id>
131 # (Function for test scripts)
132 sim_post_delete_instances() {
134 if [ $# -ne 2 ]; then
135 __print_err "<response-code> <ric-id>" $@
138 res=$(__find_sim_port $2)
139 curlString="curl -X POST -skw %{http_code} $RIC_SIM_LOCALHOST"$res"/deleteinstances"
140 __execute_curl_to_sim $1 "$curlString"
144 # Simulator API: Delete all (instances/types/statuses/settings), for one ric
145 # <response-code> <ric-id>
146 # (Function for test scripts)
147 sim_post_delete_all() {
149 if [ $# -ne 3 ]; then
150 __print_err "<response-code> <numericic-id>" $@
153 res=$(__find_sim_port $2)
154 curlString="curl -X POST -skw %{http_code} $RIC_SIM_LOCALHOST"$res"/deleteall"
155 __execute_curl_to_sim $1 "$curlString"
159 # Simulator API: Set (or reset) response code for next A1 message, for one ric
160 # <response-code> <ric-id> [<forced_response_code>]
161 # (Function for test scripts)
162 sim_post_forcedresponse() {
164 if [ $# -ne 3 ]; then
165 __print_err "<response-code> <ric-id> <forced_response_code>" $@
168 res=$(__find_sim_port $2)
169 curlString="curl -X POST -skw %{http_code} $RIC_SIM_LOCALHOST"$res"/forceresponse"
170 if [ $# -eq 3 ]; then
171 curlString=$curlString"?code="$3
173 __execute_curl_to_sim $1 "$curlString"
177 # Simulator API: Set (or reset) A1 response delay, for one ric
178 # <response-code> <ric-id> [<delay-in-seconds>]
179 # (Function for test scripts)
180 sim_post_forcedelay() {
182 if [ $# -ne 3 ]; then
183 __print_err "<response-code> <ric-id> [<delay-in-seconds>]" $@
186 res=$(__find_sim_port $2)
187 curlString="curl -X POST -skw %{http_code} $RIC_SIM_LOCALHOST$res/forcedelay"
188 if [ $# -eq 3 ]; then
189 curlString=$curlString"?delay="$3
191 __execute_curl_to_sim $1 "$curlString"