1 # Licensed under the Apache License, Version 2.0 (the "License");
2 # you may not use this file except in compliance with the License.
3 # You may obtain a copy of the License at
5 # http://www.apache.org/licenses/LICENSE-2.0
7 # Unless required by applicable law or agreed to in writing, software
8 # distributed under the License is distributed on an "AS IS" BASIS,
9 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 # See the License for the specific language governing permissions and
11 # limitations under the License.
14 Documentation Library to deploy and delete NS, and run operations on them.
20 ${success_return_code} 0
21 ${ns_launch_pol_time} 30sec
22 ${ns_delete_pol_time} 15sec
23 ${ns_action_max_wait_time} 1min
24 ${ns_action_pol_time} 15sec
25 ${vnf_scale_pol_time} 15sec
26 ${vim_timeout_multiplier} %{OSM_VIM_MULTIPLIER_TIMEOUT=1.0}
30 Create Network Service
31 [Arguments] ${nsd} ${vim_name} ${ns_name} ${ns_config} ${publickey} ${ns_launch_max_wait_time}=5min ${config_file}=${EMPTY}
33 ${ns_launch_max_wait_time}= Convert Time ${ns_launch_max_wait_time} result_format=number
34 ${ns_launch_max_wait_time}= Evaluate ${ns_launch_max_wait_time} * ${vim_timeout_multiplier}
35 Log ${ns_launch_max_wait_time}
36 ${config_attr} Set Variable If '${ns_config}'!='${EMPTY}' --config '${ns_config}' \
37 ${sshkeys_attr} Set Variable If '${publickey}'!='${EMPTY}' --ssh_keys ${publickey} \
38 ${config_file_attr} Set Variable If '${config_file}'!='${EMPTY}' --config_file '${config_file}' \
40 ${ns_id}= Instantiate Network Service ${ns_name} ${nsd} ${vim_name} ${config_attr} ${sshkeys_attr} ${config_file_attr}
43 WAIT UNTIL KEYWORD SUCCEEDS ${ns_launch_max_wait_time} ${ns_launch_pol_time} Check For NS Instance To Configured ${ns_name}
44 Check For NS Instance For Failure ${ns_name}
48 Instantiate Network Service
49 [Arguments] ${ns_name} ${nsd} ${vim_name} ${ns_extra_args}
51 ${rc} ${stdout}= Run and Return RC and Output osm ns-create --ns_name ${ns_name} --nsd_name ${nsd} --vim_account ${vim_name} ${ns_extra_args}
53 Should Be Equal As Integers ${rc} ${success_return_code}
57 Update Network Service
58 [Arguments] ${ns_id} ${update_type} ${ns_update_config} ${ns_update_timeout}
60 ${rc} ${stdout}= Run and Return RC and Output osm ns-update ${ns_id} --updatetype ${update_type} --config ${ns_update_config} --timeout ${ns_update_timeout} --wait
62 Should Be Equal As Integers ${rc} ${success_return_code}
66 Get Vnf Management Ip Address
67 [Arguments] ${ns_id} ${vnf_member_index}
69 Should Not Be Empty ${ns_id}
70 Should Not Be Empty ${vnf_member_index}
71 ${rc} ${stdout}= Run and Return RC and Output osm vnf-list --filter member-vnf-index-ref=${vnf_member_index} | grep ${ns_id} | awk '{print $14}' 2>&1
73 Should Be Equal As Integers ${rc} ${success_return_code}
78 [Arguments] ${ns_id} ${vnf_member_index}
80 Should Not Be Empty ${ns_id}
81 Should Not Be Empty ${vnf_member_index}
82 ${rc} ${stdout}= Run and Return RC and Output osm vnf-list --filter member-vnf-index-ref=${vnf_member_index} | grep ${ns_id} | awk '{print $2}' 2>&1
84 Should Be Equal As Integers ${rc} ${success_return_code}
89 [Arguments] ${ns_name}
91 Should Not Be Empty ${ns_name}
92 ${rc} ${stdout}= Run and Return RC and Output osm ns-list | grep ${ns_name} | awk '{print $4}' 2>&1
94 Should Be Equal As Integers ${rc} ${success_return_code}
95 Should Not Be Empty ${stdout}
102 Should Not Be Empty ${ns_id}
103 @{vnf_list_string}= Run and Return RC and Output osm vnf-list | grep ${ns_id} | awk '{print $2}' 2>&1
104 # Returns a String of vnf_id and needs to be converted into a list
105 @{vnf_list} = Split String ${vnf_list_string}[1]
111 [Arguments] @{vnf_list}
113 should not be empty @{vnf_list}
114 @{temp_list}= Create List
115 FOR ${vnf_id} IN @{vnf_list}
117 @{vnf_ip_list} Get Vnf Ip List ${vnf_id}
118 @{temp_list}= Combine Lists ${temp_list} ${vnf_ip_list}
120 should not be empty ${temp_list}
121 [return] @{temp_list}
125 [arguments] ${vnf_id}
127 should not be empty ${vnf_id}
128 @{vnf_ip_list_string}= run and return rc and output osm vnf-list --filter id=${vnf_id} | grep -o '[0-9]\\{1,3\\}\\.[0-9]\\{1,3\\}\\.[0-9]\\{1,3\\}\\.[0-9]\\{1,3\\}' | sort -t: -u -k1,1 2>&1
129 # returns a string of ip addresses and needs to be converted into a list
130 should not be empty ${vnf_ip_list_string}[1]
131 @{vnf_ip_list} = split string ${vnf_ip_list_string}[1]
132 log list ${vnf_ip_list}
133 should not be empty ${vnf_ip_list}
134 [return] @{vnf_ip_list}
137 Check For Ns Instance To Configured
138 [arguments] ${ns_name}
140 ${rc} ${stdout}= Run and Return RC and Output openstack server list
142 ${rc} ${stdout}= run and return rc and output osm ns-list --filter name="${ns_name}"
144 Should Be Equal As Integers ${rc} ${success_return_code}
145 Should Contain Any ${stdout} READY BROKEN
147 Check For NS Instance For Failure
148 [Arguments] ${ns_name}
150 ${rc} ${stdout}= Run and Return RC and Output openstack server list
152 ${rc} ${stdout}= Run and Return RC and Output osm ns-list --filter name="${ns_name}"
154 Should Be Equal As Integers ${rc} ${success_return_code}
155 Should Not Contain ${stdout} BROKEN
157 Check For NS Instance To Be Deleted
160 ${rc} ${stdout}= Run and Return RC and Output openstack server list
162 ${rc} ${stdout}= Run and Return RC and Output osm ns-list | awk '{print $2}' | grep ${ns}
163 Should Not Be Equal As Strings ${stdout} ${ns}
166 [Documentation] Delete ns
167 [Arguments] ${ns} ${ns_delete_max_wait_time}=4min
169 ${ns_delete_max_wait_time}= Convert Time ${ns_delete_max_wait_time} result_format=number
170 ${ns_delete_max_wait_time}= Evaluate ${ns_delete_max_wait_time} * ${vim_timeout_multiplier}
171 Log ${ns_delete_max_wait_time}
172 ${rc} ${stdout}= Run and Return RC and Output osm ns-delete ${ns}
174 Should Be Equal As Integers ${rc} ${success_return_code}
176 WAIT UNTIL KEYWORD SUCCEEDS ${ns_delete_max_wait_time} ${ns_delete_pol_time} Check For NS Instance To Be Deleted ${ns}
179 [Documentation] Execute an action over the desired NS.
180 ... Parameters are given to this function in key=value format (one argument per key/value pair).
181 ... Return the ID of the operation associated to the executed action.
182 ... Examples of execution:
183 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index}
184 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index} \${param1}=\${value1} \${param2}=\${value2}
186 [Arguments] ${ns_name} ${ns_action} ${vnf_member_index} @{action_params}
188 ${params}= Set Variable ${EMPTY}
189 FOR ${param} IN @{action_params}
190 ${match} ${param_name} ${param_value} = Should Match Regexp ${param} (.+)=(.+) msg=Syntax error in parameters
191 ${params}= Catenate SEPARATOR= ${params} "${param_name}":"${param_value}",
193 ${osm_ns_action_command}= Set Variable osm ns-action --action_name ${ns_action} --vnf_name ${vnf_member_index}
194 ${osm_ns_action_command}= Run Keyword If '${params}'!='${EMPTY}' Catenate ${osm_ns_action_command} --params '{${params}}'
195 ... ELSE Set Variable ${osm_ns_action_command}
196 ${osm_ns_action_command}= Catenate ${osm_ns_action_command} ${ns_name}
197 ${rc} ${stdout}= Run and Return RC and Output ${osm_ns_action_command}
198 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
199 Wait Until Keyword Succeeds ${ns_action_max_wait_time} ${ns_action_pol_time} Check For NS Operation Completed ${stdout}
203 Execute NS K8s Action
204 [Documentation] Execute an action over the desired K8s NS.
205 ... Parameters are given to this function in key=value format (one argument per key/value pair).
206 ... Return the ID of the operation associated to the executed action.
207 ... Examples of execution:
208 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index}
209 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index} \${param1}=\${value1} \${param2}=\${value2}
211 [Arguments] ${ns_name} ${ns_action} ${vnf_member_index} ${kdu_name} @{action_params}
213 ${params}= Set Variable ${EMPTY}
214 FOR ${param} IN @{action_params}
215 ${match} ${param_name} ${param_value} = Should Match Regexp ${param} (.+)=(.+) msg=Syntax error in parameters
216 ${params}= Catenate SEPARATOR= ${params} "${param_name}":"${param_value}",
218 ${osm_ns_action_command}= Set Variable osm ns-action --action_name ${ns_action} --vnf_name ${vnf_member_index} --kdu_name ${kdu_name}
219 ${osm_ns_action_command}= Run Keyword If '${params}'!='${EMPTY}' Catenate ${osm_ns_action_command} --params '{${params}}'
220 ... ELSE Set Variable ${osm_ns_action_command}
221 ${osm_ns_action_command}= Catenate ${osm_ns_action_command} ${ns_name}
222 ${rc} ${stdout}= Run and Return RC and Output ${osm_ns_action_command}
223 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
224 Wait Until Keyword Succeeds ${ns_action_max_wait_time} ${ns_action_pol_time} Check For NS Operation Completed ${stdout}
228 Execute Manual VNF Scale
229 [Documentation] Execute a manual VNF Scale action.
230 ... The parameter 'scale_type' must be SCALE_IN or SCALE_OUT.
231 ... Return the ID of the operation associated to the executed scale action.
233 [Arguments] ${ns_name} ${vnf_member_index} ${scaling_group} ${scale_type} ${vnf_scale_max_wait_time}=2min
235 ${vnf_scale_max_wait_time}= Convert Time ${vnf_scale_max_wait_time} result_format=number
236 ${vnf_scale_max_wait_time}= Evaluate ${vnf_scale_max_wait_time} * ${vim_timeout_multiplier}
237 Should Contain Any ${scale_type} SCALE_IN SCALE_OUT msg=Unknown scale type: ${scale_type} values=False
238 ${osm_vnf_scale_command}= Set Variable osm vnf-scale --scaling-group ${scaling_group}
239 ${osm_vnf_scale_command}= Run Keyword If '${scale_type}'=='SCALE_IN' Catenate ${osm_vnf_scale_command} --scale-in
240 ... ELSE Catenate ${osm_vnf_scale_command} --scale-out
241 ${osm_vnf_scale_command}= Catenate ${osm_vnf_scale_command} ${ns_name} ${vnf_member_index}
242 ${rc} ${stdout}= Run and Return RC and Output ${osm_vnf_scale_command}
243 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
244 Wait Until Keyword Succeeds ${vnf_scale_max_wait_time} ${vnf_scale_pol_time} Check For NS Operation Completed ${stdout}
249 [Arguments] ${ns_name}
251 ${rc} ${stdout}= Run and Return RC and Output osm ns-op-list ${ns_name}
254 Should Be Equal As Integers ${rc} ${success_return_code}
257 Check For NS Operation Completed
258 [Documentation] Check wheter the status of the desired operation is "COMPLETED" or not.
260 [Arguments] ${ns_operation_id}
262 ${rc} ${stdout}= Run and Return RC and Output osm ns-op-show ${ns_operation_id} --literal | yq .operationState | tr -d \\"
264 Should Be Equal As Integers ${rc} ${success_return_code}
265 Should Contain ${stdout} COMPLETED msg=Timeout waiting for ns-action with id ${ns_operation_id} values=False
269 [Documentation] Return a list with the IDs of the VNF records of a NS instance.
273 ${rc} ${stdout}= Run and Return RC and Output osm vnf-list | grep ${ns_id} | awk '{print $2}' 2>&1
274 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
275 @{vdur} = Split String ${stdout}
280 [Documentation] Return a list with the names of the VDU records of a VNF instance.
282 [Arguments] ${vnf_id}
284 ${rc} ${stdout}= Run and Return RC and Output osm vnf-show ${vnf_id} --literal | yq .vdur[].name | tr -d \\"
285 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
286 @{vdur} = Split String ${stdout}
290 Get Vnf Kdu Replica Count
291 [Documentation] Return the number of KDU replicas (empty if none) of a VNF instance.
293 [Arguments] ${vnf_id} ${kdu_name}
295 ${rc} ${stdout}= Run and Return RC and Output osm vnf-show ${vnf_id} --kdu ${kdu_name} | yq .config.replicaCount | tr -d \\"
296 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
297 ${return} = Set Variable If '${stdout}' == 'null' ${EMPTY} ${stdout}
301 Get Application Names
302 [Documentation] Return the list of the application of a VNF instance.
304 [Arguments] ${ns_name}
306 ${rc} ${stdout}= Run and Return RC and Output osm ns-show ${ns_name} --literal | yq ._admin.deployed.VCA[].application | tr -d \\"
307 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
308 @{app_names} = Split String ${stdout}
309 [Return] ${app_names}
312 Get VDU Affinity Group Name
313 [Documentation] Return the affinity group name for a NF
315 [Arguments] ${ns_name} ${vnf_id} ${vdur_id}
317 ${rc} ${affinity_group_id}= Run and Return RC and Output osm vnf-show ${vnf_id} --literal | yq '.vdur[] | select(.id == "'${vdur_id}'")' | yq '."affinity-or-anti-affinity-group-id"[0]' | tr -d \\" 2>&1
318 log ${affinity_group_id}
319 Should Be Equal As Integers ${rc} ${success_return_code} msg=${affinity_group_id} values=False
320 ${rc} ${affinity_group_name}= Run and Return RC and Output osm ns-show ${ns_name} --literal | yq '."affinity-or-anti-affinity-group"[] | select(.id == "'${affinity_group_id}'")' | yq '.name' | tr -d \\" 2>&1
321 log ${affinity_group_name}
322 Should Be Equal As Integers ${rc} ${success_return_code} msg=${affinity_group_name} values=False
323 [Return] ${affinity_group_name}