2 Documentation Openstack library. This library is useful for tests to create network, subnet, router and vm instances
4 Library OperatingSystem
5 Library RequestsLibrary
8 Resource DataModels.robot
9 Resource DevstackUtils.robot
10 Resource L2GatewayOperations.robot
12 Resource SetupUtils.robot
13 Resource SSHKeywords.robot
14 Resource Tcpdump.robot
16 Resource ../variables/Variables.robot
17 Resource ../variables/netvirt/Variables.robot
18 Variables ../variables/netvirt/Modules.py
21 Get Tenant ID From Security Group
22 [Documentation] Returns tenant ID by reading it from existing default security-group.
23 ${output} = OpenStack CLI openstack security group show default | grep "| tenant_id" | awk '{print $4}'
26 Get Tenant ID From Network
27 [Arguments] ${network_uuid}
28 [Documentation] Returns tenant ID by reading it from existing network.
29 ${resp} = TemplatedRequests.Get_From_Uri uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/ accept=${ACCEPT_EMPTY} session=session
30 ${tenant_id} = Utils.Extract Value From Content ${resp} /network/0/tenant-id strip
34 [Arguments] ${network_name} ${additional_args}=${EMPTY} ${verbose}=TRUE
35 [Documentation] Create Network with neutron request.
36 ${output} = OpenStack CLI openstack network create ${network_name} ${additional_args}
40 [Arguments] ${network_name} ${additional_args}=${EMPTY}
41 [Documentation] Update Network with neutron request.
42 ${cmd} = BuiltIn.Set Variable If '${OPENSTACK_BRANCH}'=='stable/newton' neutron -v net-update ${network_name} ${additional_args} openstack network set ${network_name} ${additional_args}
43 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
45 BuiltIn.Should Be True '${rc}' == '0'
49 [Arguments] ${network_name}
50 [Documentation] Show Network with neutron request.
51 ${output} = OpenStack CLI openstack network show ${network_name}
55 [Documentation] List networks and return output with neutron client.
56 ${output} = OpenStack CLI openstack network list
60 [Documentation] List subnets and return output with neutron client.
61 ${output} = OpenStack CLI openstack subnet list
65 [Arguments] ${network_name}
66 [Documentation] Delete Network with neutron request.
67 ${output} = OpenStack CLI openstack network delete ${network_name}
70 [Arguments] ${network_name} ${subnet_name} ${range_ip} ${additional_args}=${EMPTY}
71 [Documentation] Create SubNet for the Network with neutron request.
72 ${output} = OpenStack CLI openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet_name} ${additional_args}
75 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
76 [Documentation] Update subnet with neutron request.
77 ${cmd} = BuiltIn.Set Variable If '${OPENSTACK_BRANCH}'=='stable/newton' neutron -v subnet-update ${subnet_name} ${additional_args} openstack subnet set ${subnet_name} ${additional_args}
78 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
80 BuiltIn.Should Be True '${rc}' == '0'
84 [Arguments] ${subnet_name}
85 [Documentation] Show subnet with neutron request.
86 ${output} = OpenStack CLI openstack subnet show ${subnet_name}
90 [Arguments] ${network_name} ${port_name} ${sg}=default ${additional_args}=${EMPTY} ${allowed_address_pairs}=${EMPTY}
91 [Documentation] Create Port with neutron request.
92 # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
93 # in a different format with the neutron vs openstack cli.
94 ${address_pair_length} = BuiltIn.Get Length ${allowed_address_pairs}
95 ${allowed_pairs_argv} = BuiltIn.Set Variable If '${OPENSTACK_BRANCH}'=='stable/newton' and '${address_pair_length}'=='2' --allowed-address-pairs type=dict list=true ip_address=@{allowed_address_pairs}[0] ip_address=@{allowed_address_pairs}[1]
96 ${allowed_pairs_argv} = BuiltIn.Set Variable If '${OPENSTACK_BRANCH}'!='stable/newton' and '${address_pair_length}'=='2' --allowed-address ip-address=@{allowed_address_pairs}[0] --allowed-address ip-address=@{allowed_address_pairs}[1] ${allowed_pairs_argv}
97 ${allowed_pairs_argv} = BuiltIn.Set Variable If '${address_pair_length}'=='0' ${EMPTY} ${allowed_pairs_argv}
98 ${cmd} = BuiltIn.Set Variable If '${OPENSTACK_BRANCH}'=='stable/newton' neutron -v port-create ${network_name} --name ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv} openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
99 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
100 BuiltIn.Log ${output}
101 BuiltIn.Should Be True '${rc}' == '0'
104 [Arguments] ${port_name} ${additional_args}=${EMPTY}
105 [Documentation] Update port with neutron request.
106 ${output} = OpenStack CLI openstack port set ${port_name} ${additional_args}
110 [Arguments] ${port_name}
111 [Documentation] Show port with neutron request.
112 ${output} = OpenStack CLI openstack port show ${port_name}
116 [Arguments] ${port_name}
117 [Documentation] Delete Port with neutron request.
118 ${output} = OpenStack CLI openstack port delete ${port_name}
121 [Documentation] List ports and return output with neutron client.
122 ${output} = OpenStack CLI openstack port list
126 [Documentation] List VMs and return output with nova client.
127 ${output} = OpenStack CLI openstack server list --all-projects
130 Create And Associate Floating IPs
131 [Arguments] ${external_net} @{vm_list}
132 [Documentation] Create and associate floating IPs to VMs with nova request
133 ${ip_list} = BuiltIn.Create List @{EMPTY}
134 : FOR ${vm} IN @{vm_list}
135 \ ${output} = OpenStack CLI openstack floating ip create ${external_net}
136 \ @{ip} = String.Get Regexp Matches ${output} [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
137 \ ${ip_length} = BuiltIn.Get Length ${ip}
138 \ BuiltIn.Run Keyword If ${ip_length}>0 Collections.Append To List ${ip_list} @{ip}[0]
139 \ ... ELSE Collections.Append To List ${ip_list} None
140 \ ${output} = OpenStack CLI openstack server add floating ip ${vm} @{ip}[0]
145 [Documentation] Delete floating ip with neutron request.
146 ${output} = OpenStack CLI openstack floating ip delete ${fip}
149 [Arguments] ${subnet}
150 [Documentation] Delete SubNet for the Network with neutron request.
151 ${output} = OpenStack CLI openstack subnet delete ${subnet}
154 [Arguments] ${vm_name}
155 [Documentation] Delete Vm instances using instance names.
156 ${output} = OpenStack CLI openstack server delete ${vm_name}
159 [Arguments] ${network_name}
160 [Documentation] Retrieve the net id for the given network name to create specific vm instance
161 ${output} = OpenStack CLI openstack network list | grep "${network_name}" | awk '{print $2}'
162 ${splitted_output} = String.Split String ${output} ${EMPTY}
163 ${net_id} = Collections.Get from List ${splitted_output} 0
167 [Arguments] ${subnet_name}
168 [Documentation] Retrieve the subnet id for the given subnet name
169 ${output} = OpenStack CLI openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
170 ${splitted_output} = String.Split String ${output} ${EMPTY}
171 ${subnet_id} = Collections.Get from List ${splitted_output} 0
172 [Return] ${subnet_id}
175 [Arguments] ${port_name}
176 [Documentation] Retrieve the port id for the given port name to attach specific vm instance to a particular port
177 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk '{print $2}'
178 ${splitted_output} = String.Split String ${output} ${EMPTY}
179 ${port_id} = Collections.Get from List ${splitted_output} 0
183 [Arguments] ${router1}
184 [Documentation] Retrieve the router id for the given router name
185 ${output} = OpenStack CLI openstack router show "${router1}" |awk '/ id / {print $4}'
186 ${splitted_output} = String.Split String ${output} ${EMPTY}
187 ${router_id} = Collections.Get from List ${splitted_output} 0
188 [Return] ${router_id}
191 [Arguments] ${net_name} ${vm_instance_names} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default ${min}=1
193 [Documentation] Create X Vm Instance with the net id of the Netowrk.
194 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
195 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
196 : FOR ${vm} IN @{vm_instance_names}
197 \ ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
199 Create Vm Instance On Compute Node
200 [Arguments] ${net_name} ${vm_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
201 [Documentation] Create a VM instance on a specific compute node.
202 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
203 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
204 ${output} = OpenStack CLI openstack server create ${vm_name} --image ${image} --flavor ${flavor} --nic net-id=${net_id} --security-group ${sg} --availability-zone nova:${node_hostname}
206 Create Vm Instance With Port
207 [Arguments] ${port_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
208 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
209 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
210 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
211 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-group ${sg}
213 Create Vm Instance With Ports
214 [Arguments] ${port_name} ${port2_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
215 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
216 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
217 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
218 ${port2_id} = OpenStackOperations.Get Port Id ${port2_name}
219 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --nic port-id=${port2_id} ${vm_instance_name} --security-group ${sg}
221 Create Vm Instance With Port On Compute Node
222 [Arguments] ${port_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
223 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
224 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
225 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
226 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
228 Get Hypervisor Hostname From IP
229 [Arguments] ${hypervisor_ip}
230 [Documentation] Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
231 ... the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
232 ${output} = OpenStack CLI openstack hypervisor list
233 ${hostname} = OpenStack CLI openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
237 [Documentation] Create a nano flavor
238 ${output} = OpenStack CLI openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
241 [Arguments] ${vm_name}
242 [Documentation] Run these commands to check whether the created vm instance is active or not.
243 ${output} = OpenStack CLI openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
244 BuiltIn.Should Contain ${output} active
247 [Arguments] ${vm_name} ${retry}=600s ${retry_interval}=30s
248 [Documentation] Run these commands to check whether the created vm instance is active or not.
249 BuiltIn.Wait Until Keyword Succeeds ${retry} ${retry_interval} OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
252 [Arguments] ${text} ${regexp} ${index}=0
253 [Documentation] Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
254 @{matches} = String.Get Regexp Matches ${text} ${regexp}
255 ${matches_length} = BuiltIn.Get Length ${matches}
256 BuiltIn.Set Suite Variable ${OS_MATCH} None
257 BuiltIn.Run Keyword If ${matches_length} > ${index} BuiltIn.Set Suite Variable ${OS_MATCH} @{matches}[${index}]
261 [Arguments] ${fail_on_none} ${vm}
262 [Documentation] Get the vm ip address and nameserver by scraping the vm's console log.
263 ... Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
264 ${vm_console_output} = OpenStack CLI With No Log openstack console log show ${vm}
265 ${vm_ip} = BuiltIn.Set Variable None
266 ${dhcp_ip} = BuiltIn.Set Variable None
267 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_OBTAINED}
268 ${vm_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 0
269 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_IPROUTE}
270 ${dhcp_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 1
271 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${vm_ip} None
272 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${dhcp_ip} None
273 [Return] ${vm_ip} ${dhcp_ip} ${vm_console_output}
277 [Documentation] Get the instance IP addresses and nameserver address for the list of given vms.
278 ... First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
279 ... Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
280 ... of None) and [1] the dhcp ip address found in the last vm checked.
281 ... TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
282 ... may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
283 @{vm_ips} BuiltIn.Create List @{EMPTY}
284 : FOR ${vm} IN @{vms}
285 \ OpenStackOperations.Poll VM Is ACTIVE ${vm}
286 \ ${status} ${ips_and_console_log} BuiltIn.Run Keyword And Ignore Error BuiltIn.Wait Until Keyword Succeeds 180s 15s
287 \ ... OpenStackOperations.Get VM IP true ${vm}
288 \ # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
289 \ # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
290 \ # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
291 \ # the vm ip list if status is FAIL.
292 \ BuiltIn.Run Keyword If "${status}" == "PASS" BuiltIn.Log ${ips_and_console_log[2]}
293 \ BuiltIn.Run Keyword If "${status}" == "PASS" Collections.Append To List ${vm_ips} ${ips_and_console_log[0]}
294 \ BuiltIn.Run Keyword If "${status}" == "FAIL" Collections.Append To List ${vm_ips} None
295 \ ${vm_console_output} = BuiltIn.Run Keyword If "${status}" == "FAIL" OpenStack CLI openstack console log show ${vm}
296 \ BuiltIn.Run Keyword If "${status}" == "FAIL" BuiltIn.Log ${vm_console_output}
297 OpenStackOperations.Copy DHCP Files From Control Node
298 [Return] @{vm_ips} ${ips_and_console_log[1]}
300 Collect VM IPv6 SLAAC Addresses
301 [Arguments] ${fail_on_none} ${vm_list} ${network} ${subnet}
302 [Documentation] For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
303 ... Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
304 ... obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
305 ... Returns an empty list if no IPv6 addresses found or if SSH connection fails.
306 ... Otherwise, returns a list of IPv6 addresses.
307 ${ipv6_list} = BuiltIn.Create List @{EMPTY}
308 : FOR ${vm} IN @{vm_list}
309 \ ${output} = OpenStack CLI openstack server show ${vm} -f shell
310 \ ${pattern} = String.Replace String ${subnet} ::/64 (:[a-f0-9]{,4}){,4}
311 \ @{vm_ipv6} = String.Get Regexp Matches ${output} ${pattern}
312 \ ${vm_ip_length} = BuiltIn.Get Length ${vm_ipv6}[0]
313 \ ${ipv6_data_from_vm} = BuiltIn.Run Keyword If ${vm_ip_length}>0 OpenStackOperations.Execute Command on VM Instance ${network} ${vm_ipv6[0]}
315 \ @{ipv6} = String.Get Regexp Matches ${ipv6_data_from_vm} ${pattern}
316 \ ${ipv6_addr_list_length} BuiltIn.Get Length @{ipv6}
317 \ BuiltIn.Run Keyword If ${ipv6_addr_list_length}>0 Collections.Append To List ${ipv6_list} ${ipv6[0]}
318 \ ... ELSE Collections.Append To List ${ipv6_list} None
319 [Return] ${ipv6_list}
322 [Arguments] ${vm_instance_names}
323 [Documentation] View Console log of the created vm instances using nova show.
324 : FOR ${vm} IN @{vm_instance_names}
325 \ ${output} = OpenStack CLI openstack server show ${vm}
326 \ ${output} = OpenStack CLI openstack console log show ${vm}
328 Ping Vm From DHCP Namespace
329 [Arguments] ${net_name} ${vm_ip}
330 [Documentation] Reach all Vm Instance with the net id of the Netowrk.
331 OpenStackOperations.Get ControlNode Connection
332 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
333 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
334 BuiltIn.Should Contain ${output} 64 bytes
336 Ping From DHCP Should Not Succeed
337 [Arguments] ${net_name} ${vm_ip}
338 [Documentation] Should Not Reach Vm Instance with the net id of the Netowrk.
339 Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
340 OpenStackOperations.Get ControlNode Connection
341 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
342 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
343 BuiltIn.Should Not Contain ${output} 64 bytes
345 Ping Vm From Control Node
346 [Arguments] ${vm_floating_ip} ${additional_args}=${EMPTY}
347 [Documentation] Ping VM floating IP from control node
348 OpenStackOperations.Get ControlNode Connection
349 ${output} = DevstackUtils.Write Commands Until Prompt And Log ping ${additional_args} -c 3 ${vm_floating_ip} 20s
350 BuiltIn.Should Contain ${output} 64 bytes
353 [Documentation] Ping to the expected destination ip.
354 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
355 DevstackUtils.Write Commands Until Prompt exit
356 BuiltIn.Should Contain ${output} 200
359 [Documentation] Exit the vm instance.
360 ${output} = DevstackUtils.Write Commands Until Prompt And Log exit
362 Check If Console Is VmInstance
363 [Arguments] ${console}=cirros
364 [Documentation] Check if the session has been able to login to the VM instance
365 ${output} = Utils.Write Commands Until Expected Prompt id ${OS_SYSTEM_PROMPT}
366 BuiltIn.Should Contain ${output} ${console}
369 [Documentation] Check if the session has been able to login to the VM instance and exit the instance
370 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance cirros
371 BuiltIn.Run Keyword If ${rcode} DevstackUtils.Write Commands Until Prompt exit
374 [Arguments] ${ip_address} ${ttl}=64
375 [Documentation] Run Ping command on the IP available as argument
376 ${ethertype} = String.Get Regexp Matches ${ip_address} ${IP_REGEX}
377 ${output} = BuiltIn.Run Keyword If ${ethertype} Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
378 ... ELSE Utils.Write Commands Until Expected Prompt ping6 -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
379 BuiltIn.Should Contain ${output} 64 bytes
382 [Arguments] ${ip_address} ${ttl}=64
383 [Documentation] Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
384 ${output} = Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
385 BuiltIn.Should Not Contain ${output} 64 bytes
387 Check Metadata Access
388 [Documentation] Try curl on the Metadataurl and check if it is okay
389 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
390 BuiltIn.Should Contain ${output} 200
392 Execute Command on VM Instance
393 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=cirros ${password}=cubswin:)
394 [Documentation] Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
395 OpenStackOperations.Get ControlNode Connection
396 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
397 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ssh ${user}@${vm_ip} -o ConnectTimeout=10 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null password:
398 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
399 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
400 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT}
401 [Teardown] Exit From Vm Console
404 Test Operations From Vm Instance
405 [Arguments] ${net_name} ${src_ip} ${dest_ips} ${user}=cirros ${password}=cubswin:) ${ttl}=64
406 ... ${ping_should_succeed}=True ${check_metadata}=True
407 [Documentation] Login to the vm instance using ssh in the network.
408 OpenStackOperations.Get ControlNode Connection
409 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
410 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ssh -o ConnectTimeout=10 -o StrictHostKeyChecking=no ${user}@${src_ip} -o UserKnownHostsFile=/dev/null password:
411 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
412 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
413 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ifconfig ${OS_SYSTEM_PROMPT}
414 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -n ${OS_SYSTEM_PROMPT}
415 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -A inet6 ${OS_SYSTEM_PROMPT}
416 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt arp -an ${OS_SYSTEM_PROMPT}
417 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ip -f inet6 neigh show ${OS_SYSTEM_PROMPT}
418 : FOR ${dest_ip} IN @{dest_ips}
419 \ ${string_empty} = BuiltIn.Run Keyword And Return Status Should Be Empty ${dest_ip}
420 \ BuiltIn.Run Keyword If ${string_empty} Continue For Loop
421 \ BuiltIn.Run Keyword If ${rcode} and "${ping_should_succeed}" == "True" OpenStackOperations.Check Ping ${dest_ip} ttl=${ttl}
422 \ ... ELSE OpenStackOperations.Check No Ping ${dest_ip} ttl=${ttl}
423 ${ethertype} = String.Get Regexp Matches ${src_ip} ${IP_REGEX}
424 BuiltIn.Run Keyword If ${rcode} and "${check_metadata}" and ${ethertype} == "True" OpenStackOperations.Check Metadata Access
425 [Teardown] Exit From Vm Console
427 Test Netcat Operations From Vm Instance
428 [Arguments] ${net_name} ${vm_ip} ${dest_ip} ${additional_args}=${EMPTY} ${port}=12345 ${user}=cirros
429 ... ${password}=cubswin:)
430 [Documentation] Use Netcat to test TCP/UDP connections to the controller
431 ${client_data} BuiltIn.Set Variable Test Client Data
432 ${server_data} BuiltIn.Set Variable Test Server Data
433 OpenStackOperations.Get ControlNode Connection
434 ${output} = DevstackUtils.Write Commands Until Prompt And Log ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
435 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo netstat -nlap | grep ${port}
436 ${nc_output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo echo "${client_data}" | nc -v -w 5 ${additional_args} ${dest_ip} ${port}
437 BuiltIn.Log ${output}
438 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo route -n
439 BuiltIn.Log ${output}
440 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo arp -an
441 BuiltIn.Log ${output}
442 BuiltIn.Should Match Regexp ${nc_output} ${server_data}
445 [Arguments] ${list_of_external_dst_ips}
446 [Documentation] Check reachability with other network's instances.
447 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
448 : FOR ${dest_ip} IN @{list_of_external_dst_ips}
449 \ OpenStackOperations.Check Ping ${dest_ip}
452 [Arguments] ${router_name}
453 [Documentation] Create Router and Add Interface to the subnets.
454 ${output} = OpenStack CLI openstack router create ${router_name}
457 [Documentation] List Routers and return output with neutron client.
458 ${output} = OpenStack CLI openstack router list -f value
462 [Arguments] ${router_name} ${interface_name}
463 ${output} = OpenStack CLI openstack router add subnet ${router_name} ${interface_name}
465 Show Router Interface
466 [Arguments] ${router_name}
467 [Documentation] List Routers interface associated with given Router and return output with neutron client.
468 ${output} = OpenStack CLI openstack port list --router ${router_name} -f value
472 [Arguments] ${router_name} ${external_network_name}
473 ${cmd} = BuiltIn.Set Variable If '${OPENSTACK_BRANCH}'=='stable/newton' neutron -v router-gateway-set ${router_name} ${external_network_name} openstack router set ${router_name} --external-gateway ${external_network_name}
474 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
475 BuiltIn.Should Be True '${rc}' == '0'
478 [Arguments] ${router_name} ${interface_name}
479 [Documentation] Remove Interface to the subnets.
480 ${output} = OpenStack CLI openstack router remove subnet ${router_name} ${interface_name}
483 [Arguments] ${router_name}
484 [Documentation] Remove external gateway from the router.
485 BuiltIn.Log openstack router unset ${router_name} --external-gateway
488 [Arguments] ${router_name} ${cmd}
489 [Documentation] Update the router with the command. Router name and command should be passed as argument.
490 ${output} = OpenStack CLI openstack router set ${router_name} ${cmd}
493 [Arguments] ${router_name} ${options}
494 [Documentation] Show information of a given router. Router name and optional fields should be sent as arguments.
495 ${output} = OpenStack CLI openstack router show ${router_name}
498 [Arguments] ${router_name}
499 [Documentation] Delete Router and Interface to the subnets.
500 ${output} = OpenStack CLI openstack router delete ${router_name}
502 Get DumpFlows And Ovsconfig
503 [Arguments] ${conn_id}
504 [Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
505 SSHLibrary.Switch Connection ${conn_id}
506 Utils.Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
507 Utils.Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
508 Utils.Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
509 Utils.Write Commands Until Expected Prompt arp -an ${DEFAULT_LINUX_PROMPT_STRICT}
510 ${nslist} = Utils.Write Commands Until Expected Prompt ip netns list | awk '{print $1}' ${DEFAULT_LINUX_PROMPT_STRICT}
511 @{lines} Split To Lines ${nslist} end=-1
512 : FOR ${line} IN @{lines}
513 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
514 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
515 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
516 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
517 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
518 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
519 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
520 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
521 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
523 Get Karaf Log Type From Test Start
524 [Arguments] ${ip} ${test_name} ${type} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
525 ... ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
526 ${cmd} = BuiltIn.Set Variable sed '1,/ROBOT MESSAGE: Starting test ${test_name}/d' ${log_file} | grep '${type}'
527 ${output} = Utils.Run Command On Controller ${ip} ${cmd} ${user} ${password} ${prompt}
530 Get Karaf Log Types From Test Start
531 [Arguments] ${ip} ${test_name} ${types} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
532 ... ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
533 : FOR ${type} IN @{types}
534 \ OpenStackOperations.Get Karaf Log Type From Test Start ${ip} ${test_name} ${type} ${user} ${password}
535 \ ... ${prompt} ${log_file}
537 Get Karaf Log Events From Test Start
538 [Arguments] ${test_name} ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${prompt}=${ODL_SYSTEM_PROMPT}
539 ${log_types} = BuiltIn.Create List ERROR WARN Exception
540 BuiltIn.Run Keyword If 0 < ${NUM_ODL_SYSTEM} OpenStackOperations.Get Karaf Log Types From Test Start ${ODL_SYSTEM_IP} ${test_name} ${log_types}
541 BuiltIn.Run Keyword If 1 < ${NUM_ODL_SYSTEM} OpenStackOperations.Get Karaf Log Types From Test Start ${ODL_SYSTEM_2_IP} ${test_name} ${log_types}
542 BuiltIn.Run Keyword If 2 < ${NUM_ODL_SYSTEM} OpenStackOperations.Get Karaf Log Types From Test Start ${ODL_SYSTEM_3_IP} ${test_name} ${log_types}
544 Get ControlNode Connection
545 SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
546 [Return] ${OS_CNTL_CONN_ID}
549 [Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
550 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CNTL_CONN_ID}
551 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP1_CONN_ID}
552 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP2_CONN_ID}
554 Get Test Teardown Debugs
555 [Arguments] ${test_name}=${TEST_NAME}
556 OpenStackOperations.Get OvsDebugInfo
557 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_data_models}
558 OpenStackOperations.Get Karaf Log Events From Test Start ${test_name}
560 Get Test Teardown Debugs For SFC
561 [Arguments] ${test_name}=${TEST_NAME}
562 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_sfc_data_models}
565 [Arguments] @{vm_indices}
566 [Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
567 OpenStackOperations.Get ControlNode Connection
568 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns list
569 : FOR ${index} IN @{vm_indices}
570 \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
571 \ BuiltIn.Log ${output}
572 OpenStackOperations.List Nova VMs
573 OpenStackOperations.List Routers
574 OpenStackOperations.List Networks
575 OpenStackOperations.List Subnets
576 OpenStackOperations.List Ports
577 OpenStackOperations.List Security Groups
580 [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
581 ... credentials are already sourced
582 ${output} = OpenStack CLI openstack security group list
585 Neutron Security Group Show
586 [Arguments] ${SecurityGroupRuleName}
587 [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
588 ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
592 [Arguments] ${PortName}
593 [Documentation] Display the port configuration that belong to a given neutron port
594 ${output} = OpenStack CLI openstack port show ${PortName}
597 Neutron Security Group Create
598 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
599 [Documentation] Create a security group with specified name ,description & protocol value according to security group template
600 OpenStackOperations.Get ControlNode Connection
601 ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
602 ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
603 [Return] ${output} ${sgp_id}
605 Neutron Security Group Update
606 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
607 [Documentation] Updating security groups
608 ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
612 [Arguments] ${sg_name}
613 [Documentation] Delete Security group
614 ${output} = OpenStack CLI openstack security group delete ${sg_name}
616 Neutron Security Group Rule Create
617 [Arguments] ${Security_group_name} &{Kwargs}
618 [Documentation] Creates neutron security rule with Openstack CLI with or without optional params, here security group name is mandatory args, rule with optional params can be created by passing the optional args values ex: direction=${INGRESS_EGRESS}, Then these optional params are BuiltIn.Catenated with mandatory args, example of usage: "OpenStack Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
619 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
620 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
621 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
622 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
623 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
624 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
625 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
626 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
627 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
628 ${cmd} = BuiltIn.Set Variable openstack security group rule create ${Security_group_name}
629 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
630 ... ELSE BuiltIn.Catenate ${cmd}
631 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --${direction}
632 ... ELSE BuiltIn.Catenate ${cmd}
633 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
634 ... ELSE BuiltIn.Catenate ${cmd}
635 ${cmd} = BuiltIn.Run Keyword If '${port_range_min}'!='None' and '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}:${port_range_max}
636 ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
637 ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}
638 ... ELSE BuiltIn.Catenate ${cmd}
639 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
640 ... ELSE BuiltIn.Catenate ${cmd}
641 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote-group ${remote_group_id}
642 ... ELSE BuiltIn.Catenate ${cmd}
643 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --src-ip ${remote_ip_prefix}
644 ... ELSE BuiltIn.Catenate ${cmd}
645 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
646 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
647 BuiltIn.Log ${rule_id}
648 BuiltIn.Should Be True '${rc}' == '0'
649 [Return] ${output} ${rule_id}
651 Neutron Security Group Rule Create Legacy Cli
652 [Arguments] ${Security_group_name} &{Kwargs}
653 [Documentation] Creates neutron security rule with neutron request with or without optional params, here security group name is mandatory args, rule with optional params can be created by passing the optional args values ex: direction=${INGRESS_EGRESS}, Then these optional params are BuiltIn.Catenated with mandatory args, example of usage: "OpenStack Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
654 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
655 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
656 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
657 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
658 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
659 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
660 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
661 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
662 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
663 ${cmd} = BuiltIn.Set Variable neutron security-group-rule-create ${Security_group_name}
664 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
665 ... ELSE BuiltIn.Catenate ${cmd}
666 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --direction ${direction}
667 ... ELSE BuiltIn.Catenate ${cmd}
668 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
669 ... ELSE BuiltIn.Catenate ${cmd}
670 ${cmd} = BuiltIn.Run Keyword If '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --port_range_max ${port_range_max}
671 ... ELSE BuiltIn.Catenate ${cmd}
672 ${cmd} = BuiltIn.Run Keyword If '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --port_range_min ${port_range_min}
673 ... ELSE BuiltIn.Catenate ${cmd}
674 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
675 ... ELSE BuiltIn.Catenate ${cmd}
676 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote_group_id ${remote_group_id}
677 ... ELSE BuiltIn.Catenate ${cmd}
678 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --remote_ip_prefix ${remote_ip_prefix}
679 ... ELSE BuiltIn.Catenate ${cmd}
680 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
681 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
682 BuiltIn.Log ${rule_id}
683 BuiltIn.Should Be True '${rc}' == '0'
684 [Return] ${output} ${rule_id}
686 Security Group Create Without Default Security Rules
687 [Arguments] ${sg_name} ${additional_args}=${EMPTY}
688 [Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
689 OpenStackOperations.Neutron Security Group Create ${sg_name} ${additional_args}
690 Delete All Security Group Rules ${sg_name}
692 Delete All Security Group Rules
693 [Arguments] ${sg_name}
694 [Documentation] Delete all security rules from a specified security group
695 ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
696 @{sg_rules} = String.Split String ${sg_rules_output} \n
697 : FOR ${rule} IN @{sg_rules}
698 \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
700 Create Allow All SecurityGroup
701 [Arguments] ${sg_name} ${ether_type}=IPv4
702 [Documentation] Allow all TCP/UDP/ICMP packets for this suite
703 OpenStackOperations.Neutron Security Group Create ${sg_name}
704 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
705 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
706 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
707 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
708 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
709 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
711 Create Neutron Port With Additional Params
712 [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
713 [Documentation] Create Port With given additional parameters
714 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
715 BuiltIn.Log ${output}
716 BuiltIn.Should Be True '${rc}' == '0'
717 ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
718 [Return] ${OUTPUT} ${port_id}
722 [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
723 ${macs} BuiltIn.Create List
724 : FOR ${port} IN @{ports}
725 \ ${mac} = OpenStackOperations.Get Port Mac ${port}
726 \ Collections.Append To List ${macs} ${mac}
730 [Arguments] ${port_name}
731 [Documentation] Keyword would return the IP of the ${port_name} received.
732 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
733 ${splitted_output} = String.Split String ${output} ${EMPTY}
734 ${port_ip} = Collections.Get from List ${splitted_output} 0
738 [Arguments] ${port_name}
739 [Documentation] Keyword would return the MAC ID of the ${port_name} received.
740 ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
741 ${splitted_output} = String.Split String ${output} ${EMPTY}
742 ${port_mac} = Collections.Get from List ${splitted_output} 0
746 [Arguments] ${bridge_name} ${intf_name} ${gw_name}
747 [Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
748 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
749 BuiltIn.Log ${l2gw_output}
750 [Return] ${l2gw_output}
752 Create L2Gateway Connection
753 [Arguments] ${gw_name} ${net_name}
754 [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
755 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
756 BuiltIn.Log ${l2gw_output}
757 BuiltIn.Should Be True '${rc}' == '0'
758 [Return] ${l2gw_output}
761 [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
762 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
763 BuiltIn.Should Be True '${rc}' == '0'
766 Get All L2Gateway Connection
767 [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
768 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
769 BuiltIn.Should Be True '${rc}' == '0'
774 [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
775 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
776 BuiltIn.Log ${output}
777 BuiltIn.Should Be True '${rc}' == '0'
781 [Arguments] ${l2gw_name}
782 [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
783 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
784 BuiltIn.Log ${output}
785 BuiltIn.Should Be True '${rc}' == '0'
786 ${splitted_output} = String.Split String ${output} ${EMPTY}
787 ${l2gw_id} = Collections.Get from List ${splitted_output} 0
790 Get L2gw Connection Id
791 [Arguments] ${l2gw_name}
792 [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
793 ${l2gw_id} = OpenStackOperations.Get L2gw Id ${l2gw_name}
794 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
795 BuiltIn.Should Be True '${rc}' == '0'
796 ${splitted_output} = String.Split String ${output} ${EMPTY}
797 ${splitted_output} = String.Split String ${output} ${EMPTY}
798 ${l2gw_conn_id} = Collections.Get from List ${splitted_output} 0
799 [Return] ${l2gw_conn_id}
801 Neutron Port List Rest
802 [Documentation] Keyword to get all ports details in Neutron (Using REST).
803 ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
804 BuiltIn.Log ${resp.content}
805 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
806 [Return] ${resp.content}
808 Get Neutron Port Rest
809 [Arguments] ${port_id}
810 [Documentation] Keyword to get the specific port details in Neutron (Using REST).
811 ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
812 BuiltIn.Log ${resp.content}
813 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
814 [Return] ${resp.content}
817 [Arguments] ${port_id} ${json_data}
818 [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
819 BuiltIn.Log ${json_data}
820 ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
821 BuiltIn.Log ${resp.content}
822 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
823 [Return] ${resp.content}
825 Create And Configure Security Group
826 [Arguments] ${sg-name}
827 [Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
828 OpenStackOperations.Neutron Security Group Create ${sg-name}
829 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress port_range_max=65535 port_range_min=1 protocol=tcp remote_ip_prefix=0.0.0.0/0
830 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress port_range_max=65535 port_range_min=1 protocol=tcp remote_ip_prefix=0.0.0.0/0
831 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
832 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
833 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress port_range_max=65535 port_range_min=1 protocol=udp remote_ip_prefix=0.0.0.0/0
834 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress port_range_max=65535 port_range_min=1 protocol=udp remote_ip_prefix=0.0.0.0/0
836 Add Security Group To VM
837 [Arguments] ${vm} ${sg}
838 [Documentation] Add the security group provided to the given VM.
839 ${output} = OpenStack CLI openstack server add security group ${vm} ${sg}
841 Remove Security Group From VM
842 [Arguments] ${vm} ${sg}
843 [Documentation] Remove the security group provided to the given VM.
844 OpenStackOperations.Get ControlNode Connection
845 ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
847 Create SFC Flow Classifier
848 [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${dest_port} ${neutron_src_port}
849 [Documentation] Create a flow classifier for SFC
850 ${output} = OpenStack CLI openstack sfc flow classifier create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --destination-port ${dest_port}:${dest_port} --logical-source-port ${neutron_src_port} ${name}
851 BuiltIn.Should Contain ${output} ${name}
854 Delete SFC Flow Classifier
856 [Documentation] Delete a SFC flow classifier
857 OpenStackOperations.Get ControlNode Connection
858 ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
862 [Arguments] ${name} ${port_in} ${port_out}
863 [Documentation] Creates a neutron port pair for SFC
864 OpenStackOperations.Get ControlNode Connection
865 ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
866 BuiltIn.Should Contain ${output} ${name}
871 [Documentation] Delete a SFC port pair
872 ${output} = OpenStack CLI openstack sfc port pair delete ${name}
875 Create SFC Port Pair Group
876 [Arguments] ${name} ${port_pair}
877 [Documentation] Creates a port pair group with a single port pair for SFC
878 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
879 BuiltIn.Should Contain ${output} ${name}
882 Create SFC Port Pair Group With Two Pairs
883 [Arguments] ${name} ${port_pair1} ${port_pair2}
884 [Documentation] Creates a port pair group with two port pairs for SFC
885 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
886 BuiltIn.Should Contain ${output} ${name}
889 Delete SFC Port Pair Group
891 [Documentation] Delete a SFC port pair group
892 OpenStackOperations.Get ControlNode Connection
893 ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
896 Create SFC Port Chain
897 [Arguments] ${name} ${pg1} ${pg2} ${fc}
898 [Documentation] Creates a port pair chain with two port groups and a singel classifier.
899 ${output} = OpenStack CLI openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
900 BuiltIn.Should Contain ${output} ${name}
903 Delete SFC Port Chain
905 [Documentation] Delete a SFC port chain
906 ${output} = OpenStack CLI openstack sfc port chain delete ${name}
910 [Arguments] ${vm_name}
911 [Documentation] Reboot NOVA VM
912 ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
913 BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
915 Remove RSA Key From KnownHosts
917 [Documentation] Remove RSA
918 OpenStackOperations.Get ControlNode Connection
919 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
920 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
921 ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
923 Wait For Routes To Propogate
924 [Arguments] ${networks} ${subnets}
925 [Documentation] Check propagated routes
926 OpenStackOperations.Get ControlNode Connection
927 : FOR ${INDEX} IN RANGE 0 1
928 \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
929 \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
930 \ ${length} = BuiltIn.Get Length ${is_ipv6}
931 \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
932 \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ]>
933 \ BuiltIn.Should Contain ${output} @{subnets}[${INDEX}]
936 [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
937 : FOR ${vm} IN @{vms}
938 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
939 : FOR ${port} IN @{ports}
940 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
941 : FOR ${subnet} IN @{subnets}
942 \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
943 : FOR ${network} IN @{networks}
944 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
945 : FOR ${sg} IN @{sgs}
946 \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
949 [Documentation] Get a list of different OpenStack resources that might be in use.
950 @{modules} = BuiltIn.Create List server port network subnet security group
951 ... security group rule
952 BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" Collections.Append To List ${modules} floating ip router
953 : FOR ${module} IN @{modules}
954 \ ${output} = OpenStack CLI openstack ${module} list
956 OpenStack CLI Get List
958 [Documentation] Return a json list from the output of an OpenStack command.
959 @{list} = BuiltIn.Create List
960 ${json} = OpenStack CLI ${cmd}
961 @{list} = RequestsLibrary.To Json ${json}
967 [Documentation] Run the given OpenStack ${cmd} and log the output.
968 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
969 BuiltIn.Log ${output}
970 BuiltIn.Should Be True '${rc}' == '0'
973 OpenStack CLI With No Log
975 [Documentation] Run the given OpenStack ${cmd} and do not log the output.
976 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
977 BuiltIn.Should Be True '${rc}' == '0'
980 OpenStack Cleanup All
981 [Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
982 ... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
983 @{fips} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack floating ip list -f json
984 ... ELSE BuiltIn.Create List @{EMPTY}
985 : FOR ${fip} IN @{fips}
986 \ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
987 @{vms} = OpenStack CLI Get List openstack server list -f json
988 : FOR ${vm} IN @{vms}
989 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
990 @{routers} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack router list -f json
991 ... ELSE BuiltIn.Create List @{EMPTY}
992 : FOR ${router} IN @{routers}
993 \ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
994 @{ports} = OpenStack CLI Get List openstack port list -f json
995 : FOR ${port} IN @{ports}
996 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
997 @{networks} = OpenStack CLI Get List openstack network list -f json
998 : FOR ${network} IN @{networks}
999 \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
1000 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
1001 @{security_groups} = OpenStack CLI Get List openstack security group list -f json
1002 : FOR ${security_group} IN @{security_groups}
1003 \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
1008 [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
1009 @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
1010 : FOR ${port} IN @{ports}
1011 \ ${subnet_id} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 0
1012 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
1013 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
1014 BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
1016 OpenStack Suite Setup
1017 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1018 SetupUtils.Setup_Utils_For_Setup_And_Teardown
1019 DevstackUtils.Devstack Suite Setup
1020 @{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
1021 BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
1022 BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
1023 OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1025 OpenStack Suite Teardown
1026 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1027 ... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1028 ... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1029 ... benefit automatically.
1030 OpenStack Cleanup All
1031 OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
1032 SSHLibrary.Close All Connections
1034 Copy DHCP Files From Control Node
1035 [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
1036 ... after the subnet(s) are created and before the subnet(s) are deleted.
1037 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1038 ${dstdir} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
1039 OperatingSystem.Create Directory ${dstdir}
1040 OpenStackOperations.Get ControlNode Connection
1041 BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
1043 Is Feature Installed
1044 [Arguments] ${features}=none
1045 : FOR ${feature} IN @{features}
1046 \ ${status} ${output} BuiltIn.Run Keyword And Ignore Error BuiltIn.Should Contain ${CONTROLLERFEATURES} ${feature}
1047 \ Return From Keyword If "${status}" == "PASS" True
1050 Add OVS Logging On All OpenStack Nodes
1051 [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
1052 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CNTL_CONN_ID}
1053 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP1_CONN_ID}
1054 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP2_CONN_ID}
1056 Reset OVS Logging On All OpenStack Nodes
1057 [Documentation] Reset the OVS logging to all the OpenStack nodes
1058 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CNTL_CONN_ID}
1059 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP1_CONN_ID}
1060 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP2_CONN_ID}
1062 Start Packet Capture On Nodes
1063 [Arguments] ${tag} ${filter} @{ips}
1064 [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1065 ... The caller must pass the three arguments with a variable number of ips at the end,
1066 ... but ${EMPTY} can be used for the tag and filter.
1067 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1068 ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
1069 @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
1070 [Return] @{conn_ids}
1072 Stop Packet Capture On Nodes
1073 [Arguments] ${conn_ids}=@{EMPTY}
1074 Tcpdump.Stop Packet Capture on Nodes ${conn_ids}