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_max_wait_time} 2min
26 ${vnf_scale_pol_time} 15sec
27 ${vim_timeout_multiplier} %{OSM_VIM_MULTIPLIER_TIMEOUT=1.0}
31 Create Network Service
32 [Arguments] ${nsd} ${vim_name} ${ns_name} ${ns_config} ${publickey} ${ns_launch_max_wait_time}=5min ${config_file}=${EMPTY}
34 ${ns_launch_max_wait_time}= Convert Time ${ns_launch_max_wait_time} result_format=number
35 ${ns_launch_max_wait_time}= Evaluate ${ns_launch_max_wait_time} * ${vim_timeout_multiplier}
36 Log ${ns_launch_max_wait_time}
37 ${config_attr} Set Variable If '${ns_config}'!='${EMPTY}' --config '${ns_config}' \
38 ${sshkeys_attr} Set Variable If '${publickey}'!='${EMPTY}' --ssh_keys ${publickey} \
39 ${config_file_attr} Set Variable If '${config_file}'!='${EMPTY}' --config_file '${config_file}' \
41 ${ns_id}= Instantiate Network Service ${ns_name} ${nsd} ${vim_name} ${config_attr} ${sshkeys_attr} ${config_file_attr}
44 WAIT UNTIL KEYWORD SUCCEEDS ${ns_launch_max_wait_time} ${ns_launch_pol_time} Check For NS Instance To Configured ${ns_name}
45 Check For NS Instance For Failure ${ns_name}
49 Instantiate Network Service
50 [Arguments] ${ns_name} ${nsd} ${vim_name} ${ns_extra_args}
52 ${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}
54 Should Be Equal As Integers ${rc} ${success_return_code}
58 Get Vnf Management Ip Address
59 [Arguments] ${ns_id} ${vnf_member_index}
61 Should Not Be Empty ${ns_id}
62 Should Not Be Empty ${vnf_member_index}
63 ${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
65 Should Be Equal As Integers ${rc} ${success_return_code}
70 [Arguments] ${ns_id} ${vnf_member_index}
72 Should Not Be Empty ${ns_id}
73 Should Not Be Empty ${vnf_member_index}
74 ${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
76 Should Be Equal As Integers ${rc} ${success_return_code}
83 Should Not Be Empty ${ns_id}
84 @{vnf_list_string}= Run and Return RC and Output osm vnf-list | grep ${ns_id} | awk '{print $2}' 2>&1
85 # Returns a String of vnf_id and needs to be converted into a list
86 @{vnf_list} = Split String ${vnf_list_string}[1]
92 [Arguments] @{vnf_list}
94 should not be empty @{vnf_list}
95 @{temp_list}= Create List
96 FOR ${vnf_id} IN @{vnf_list}
98 @{vnf_ip_list} Get Vnf Ip List ${vnf_id}
99 @{temp_list}= Combine Lists ${temp_list} ${vnf_ip_list}
101 should not be empty ${temp_list}
102 [return] @{temp_list}
106 [arguments] ${vnf_id}
108 should not be empty ${vnf_id}
109 @{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
110 # returns a string of ip addresses and needs to be converted into a list
111 should not be empty ${vnf_ip_list_string}[1]
112 @{vnf_ip_list} = split string ${vnf_ip_list_string}[1]
113 log list ${vnf_ip_list}
114 should not be empty ${vnf_ip_list}
115 [return] @{vnf_ip_list}
118 Check For Ns Instance To Configured
119 [arguments] ${ns_name}
121 ${rc} ${stdout}= Run and Return RC and Output openstack server list
123 ${rc} ${stdout}= run and return rc and output osm ns-list --filter name="${ns_name}"
125 Should Be Equal As Integers ${rc} ${success_return_code}
126 Should Contain Any ${stdout} READY BROKEN
128 Check For NS Instance For Failure
129 [Arguments] ${ns_name}
131 ${rc} ${stdout}= Run and Return RC and Output openstack server list
133 ${rc} ${stdout}= Run and Return RC and Output osm ns-list --filter name="${ns_name}"
135 Should Be Equal As Integers ${rc} ${success_return_code}
136 Should Not Contain ${stdout} BROKEN
138 Check For NS Instance To Be Deleted
141 ${rc} ${stdout}= Run and Return RC and Output openstack server list
143 ${rc} ${stdout}= Run and Return RC and Output osm ns-list | awk '{print $2}' | grep ${ns}
144 Should Not Be Equal As Strings ${stdout} ${ns}
147 [Documentation] Delete ns
148 [Arguments] ${ns} ${ns_delete_max_wait_time}=4min
150 ${ns_delete_max_wait_time}= Convert Time ${ns_delete_max_wait_time} result_format=number
151 ${ns_delete_max_wait_time}= Evaluate ${ns_delete_max_wait_time} * ${vim_timeout_multiplier}
152 Log ${ns_delete_max_wait_time}
153 ${rc} ${stdout}= Run and Return RC and Output osm ns-delete ${ns}
155 Should Be Equal As Integers ${rc} ${success_return_code}
157 WAIT UNTIL KEYWORD SUCCEEDS ${ns_delete_max_wait_time} ${ns_delete_pol_time} Check For NS Instance To Be Deleted ${ns}
160 [Documentation] Execute an action over the desired NS.
161 ... Parameters are given to this function in key=value format (one argument per key/value pair).
162 ... Return the ID of the operation associated to the executed action.
163 ... Examples of execution:
164 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index}
165 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index} \${param1}=\${value1} \${param2}=\${value2}
167 [Arguments] ${ns_name} ${ns_action} ${vnf_member_index} @{action_params}
169 ${params}= Set Variable ${EMPTY}
170 FOR ${param} IN @{action_params}
171 ${match} ${param_name} ${param_value} = Should Match Regexp ${param} (.+)=(.+) msg=Syntax error in parameters
172 ${params}= Catenate SEPARATOR= ${params} "${param_name}":"${param_value}",
174 ${osm_ns_action_command}= Set Variable osm ns-action --action_name ${ns_action} --vnf_name ${vnf_member_index}
175 ${osm_ns_action_command}= Run Keyword If '${params}'!='${EMPTY}' Catenate ${osm_ns_action_command} --params '{${params}}'
176 ... ELSE Set Variable ${osm_ns_action_command}
177 ${osm_ns_action_command}= Catenate ${osm_ns_action_command} ${ns_name}
178 ${rc} ${stdout}= Run and Return RC and Output ${osm_ns_action_command}
179 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
180 Wait Until Keyword Succeeds ${ns_action_max_wait_time} ${ns_action_pol_time} Check For NS Operation Completed ${stdout}
184 Execute NS K8s Action
185 [Documentation] Execute an action over the desired K8s NS.
186 ... Parameters are given to this function in key=value format (one argument per key/value pair).
187 ... Return the ID of the operation associated to the executed action.
188 ... Examples of execution:
189 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index}
190 ... \${ns_op_id}= Execute NS Action \${ns_name} \${ns_action} \${vnf_member_index} \${param1}=\${value1} \${param2}=\${value2}
192 [Arguments] ${ns_name} ${ns_action} ${vnf_member_index} ${kdu_name} @{action_params}
194 ${params}= Set Variable ${EMPTY}
195 FOR ${param} IN @{action_params}
196 ${match} ${param_name} ${param_value} = Should Match Regexp ${param} (.+)=(.+) msg=Syntax error in parameters
197 ${params}= Catenate SEPARATOR= ${params} "${param_name}":"${param_value}",
199 ${osm_ns_action_command}= Set Variable osm ns-action --action_name ${ns_action} --vnf_name ${vnf_member_index} --kdu_name ${kdu_name}
200 ${osm_ns_action_command}= Run Keyword If '${params}'!='${EMPTY}' Catenate ${osm_ns_action_command} --params '{${params}}'
201 ... ELSE Set Variable ${osm_ns_action_command}
202 ${osm_ns_action_command}= Catenate ${osm_ns_action_command} ${ns_name}
203 ${rc} ${stdout}= Run and Return RC and Output ${osm_ns_action_command}
204 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
205 Wait Until Keyword Succeeds ${ns_action_max_wait_time} ${ns_action_pol_time} Check For NS Operation Completed ${stdout}
209 Execute Manual VNF Scale
210 [Documentation] Execute a manual VNF Scale action.
211 ... The parameter 'scale_type' must be SCALE_IN or SCALE_OUT.
212 ... Return the ID of the operation associated to the executed scale action.
214 [Arguments] ${ns_name} ${vnf_member_index} ${scaling_group} ${scale_type}
216 Should Contain Any ${scale_type} SCALE_IN SCALE_OUT msg=Unknown scale type: ${scale_type} values=False
217 ${osm_vnf_scale_command}= Set Variable osm vnf-scale --scaling-group ${scaling_group}
218 ${osm_vnf_scale_command}= Run Keyword If '${scale_type}'=='SCALE_IN' Catenate ${osm_vnf_scale_command} --scale-in
219 ... ELSE Catenate ${osm_vnf_scale_command} --scale-out
220 ${osm_vnf_scale_command}= Catenate ${osm_vnf_scale_command} ${ns_name} ${vnf_member_index}
221 ${rc} ${stdout}= Run and Return RC and Output ${osm_vnf_scale_command}
222 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
223 Wait Until Keyword Succeeds ${vnf_scale_max_wait_time} ${vnf_scale_pol_time} Check For NS Operation Completed ${stdout}
228 [Arguments] ${ns_name}
230 ${rc} ${stdout}= Run and Return RC and Output osm ns-op-list ${ns_name}
233 Should Be Equal As Integers ${rc} ${success_return_code}
236 Check For NS Operation Completed
237 [Documentation] Check wheter the status of the desired operation is "COMPLETED" or not.
239 [Arguments] ${ns_operation_id}
241 ${rc} ${stdout}= Run and Return RC and Output osm ns-op-show ${ns_operation_id} --literal | yq .operationState | tr -d \\"
243 Should Be Equal As Integers ${rc} ${success_return_code}
244 Should Contain ${stdout} COMPLETED msg=Timeout waiting for ns-action with id ${ns_operation_id} values=False
248 [Documentation] Return a list with the IDs of the VNF records of a NS instance.
252 ${rc} ${stdout}= Run and Return RC and Output osm vnf-list | grep ${ns_id} | awk '{print $2}' 2>&1
253 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
254 @{vdur} = Split String ${stdout}
259 [Documentation] Return a list with the names of the VDU records of a VNF instance.
261 [Arguments] ${vnf_id}
263 ${rc} ${stdout}= Run and Return RC and Output osm vnf-show ${vnf_id} --literal | yq .vdur[].name | tr -d \\"
264 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
265 @{vdur} = Split String ${stdout}
269 Get Vnf Kdu Replica Count
270 [Documentation] Return the number of KDU replicas (empty if none) of a VNF instance.
272 [Arguments] ${vnf_id} ${kdu_name}
274 ${rc} ${stdout}= Run and Return RC and Output osm vnf-show ${vnf_id} --kdu ${kdu_name} | yq .config.replicaCount | tr -d \\"
275 Should Be Equal As Integers ${rc} ${success_return_code} msg=${stdout} values=False
276 ${return} = Set Variable If '${stdout}' == 'null' ${EMPTY} ${stdout}