2 Documentation Openstack library. This library is useful for tests to create network, subnet, router and vm instances
5 Library OperatingSystem
6 Library RequestsLibrary
9 Resource DataModels.robot
10 Resource DevstackUtils.robot
11 Resource KarafKeywords.robot
12 Resource L2GatewayOperations.robot
13 Resource ODLTools.robot
15 Resource SetupUtils.robot
16 Resource SSHKeywords.robot
17 Resource Tcpdump.robot
19 Resource ../variables/Variables.robot
20 Resource ../variables/netvirt/Variables.robot
21 Variables ../variables/netvirt/Modules.py
24 @{VALIDATION_KEYWORDS} Verify Services Verify Expected Default Tunnels Verify Expected Default Tables On Nodes
25 ${VALIDATION_FILE} /tmp/validations.txt
28 Get Tenant ID From Security Group
29 [Documentation] Returns tenant ID by reading it from existing default security-group.
30 ${output} = OpenStack CLI openstack security group show default | grep "| tenant_id" | awk '{print $4}'
33 Get Tenant ID From Network
34 [Arguments] ${network_uuid}
35 [Documentation] Returns tenant ID by reading it from existing network.
36 ${resp} = TemplatedRequests.Get_From_Uri uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/ accept=${ACCEPT_EMPTY} session=session
37 ${tenant_id} = Utils.Extract Value From Content ${resp} /network/0/tenant-id strip
41 [Arguments] ${network_name} ${additional_args}=${EMPTY} ${verbose}=TRUE
42 [Documentation] Create Network with openstack request.
43 ${output} = OpenStack CLI openstack network create ${network_name} ${additional_args}
46 Create Multiple Networks
47 [Arguments] @{name_of_networks}
48 [Documentation] Create required number of networks and return a list of the resulting network ids
49 ${net_list_ids} = BuiltIn.Create List @{EMPTY}
50 : FOR ${net} IN @{name_of_networks}
51 \ ${output} = OpenStackOperations.Create Network ${net}
52 \ ${net_id} = Get Regexp Matches ${output} ${REGEX_UUID}
53 \ Collections.Append To List ${net_list_ids} ${net_id}
54 [Return] @{net_list_ids}
57 [Arguments] ${network_name} ${additional_args}=${EMPTY}
58 [Documentation] Update Network with neutron request.
59 ${output} = OpenStack CLI openstack network set ${network_name} ${additional_args}
63 [Arguments] ${network_name}
64 [Documentation] Show Network with neutron request.
65 ${output} = OpenStack CLI openstack network show ${network_name}
69 [Documentation] List networks and return output with neutron client.
70 ${output} = OpenStack CLI openstack network list
74 [Documentation] List subnets and return output with neutron client.
75 ${output} = OpenStack CLI openstack subnet list
79 [Arguments] ${network_name}
80 [Documentation] Delete Network with neutron request.
81 ${output} = OpenStack CLI openstack network delete ${network_name}
84 [Arguments] ${network_name} ${subnet_name} ${range_ip} ${additional_args}=${EMPTY}
85 [Documentation] Create SubNet for the Network with neutron request.
86 ${output} = OpenStack CLI openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet_name} ${additional_args}
88 Create Multiple Subnets
89 [Arguments] ${network_names} ${subnet_names} ${subnet_cidr}
90 [Documentation] Create required number of subnets for previously created networks and return subnet id
91 ${number_of_networks} = BuiltIn.Get Length ${network_names}
92 @{subnet_id_list} = BuiltIn.Create List @{EMPTY}
93 : FOR ${index} IN RANGE ${number_of_networks}
94 \ OpenStackOperations.Create SubNet ${network_names[${index}]} ${subnet_names[${index}]} ${subnet_cidr[${index}]}
95 ${sub_list} = OpenStackOperations.List Subnets
96 : FOR ${index} IN RANGE ${number_of_networks}
97 \ BuiltIn.Should Contain ${sub_list} ${subnet_names[${index}]}
98 \ ${subnet_id} = OpenStackOperations.Get Subnet Id ${subnet_names[${index}]}
99 \ Collections.Append To List ${subnet_id_list} ${subnet_id}
100 [Return] @{subnet_id_list}
103 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
104 [Documentation] Update subnet with openstack subnet set request.
105 ${output} = OpenStack CLI openstack subnet set ${subnet_name} ${additional_args}
109 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
110 [Documentation] Update subnet with openstack subnet unset request
111 ${output} = OpenStack CLI openstack subnet unset ${subnet_name} ${additional_args}
115 [Arguments] ${subnet_name}
116 [Documentation] Show subnet with neutron request.
117 ${output} = OpenStack CLI openstack subnet show ${subnet_name}
121 [Arguments] ${network_name} ${port_name} ${sg}=default ${additional_args}=${EMPTY} ${allowed_address_pairs}=${EMPTY}
122 [Documentation] Create Port with neutron request.
123 # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
124 # in a different format with the neutron vs openstack cli.
125 ${address_pair_length} = BuiltIn.Get Length ${allowed_address_pairs}
126 ${allowed_pairs_argv} = BuiltIn.Set Variable ${EMPTY}
127 ${allowed_pairs_argv} = BuiltIn.Set Variable If '${address_pair_length}'=='2' --allowed-address ip-address=@{allowed_address_pairs}[0] --allowed-address ip-address=@{allowed_address_pairs}[1] ${allowed_pairs_argv}
128 ${output} = OpenStack CLI openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
131 [Arguments] ${port_name} ${additional_args}=${EMPTY}
132 [Documentation] Update port with neutron request.
133 ${output} = OpenStack CLI openstack port set ${port_name} ${additional_args}
137 [Arguments] ${port_name}
138 [Documentation] Show port with neutron request.
139 ${output} = OpenStack CLI openstack port show ${port_name}
143 [Arguments] ${port_name}
144 [Documentation] Delete Port with neutron request.
145 ${output} = OpenStack CLI openstack port delete ${port_name}
148 [Documentation] List ports and return output with neutron client.
149 ${output} = OpenStack CLI openstack port list
153 [Documentation] List VMs and return output with nova client.
154 ${output} = OpenStack CLI openstack server list --all-projects
157 Create And Associate Floating IPs
158 [Arguments] ${external_net} @{vm_list}
159 [Documentation] Create and associate floating IPs to VMs with nova request
160 ${ip_list} = BuiltIn.Create List @{EMPTY}
161 : FOR ${vm} IN @{vm_list}
162 \ ${output} = OpenStack CLI openstack floating ip create ${external_net}
163 \ @{ip} = String.Get Regexp Matches ${output} [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
164 \ ${ip_length} = BuiltIn.Get Length ${ip}
165 \ BuiltIn.Run Keyword If ${ip_length}>0 Collections.Append To List ${ip_list} @{ip}[0]
166 \ ... ELSE Collections.Append To List ${ip_list} None
167 \ ${output} = OpenStack CLI openstack server add floating ip ${vm} @{ip}[0]
170 Remove Floating Ip From Vm
171 [Arguments] ${vm_name} ${fip}
172 [Documentation] Remove the Floating IP From VM Instance
173 ${output} = OpenStack CLI openstack server remove floating ip ${vm_name} ${fip}
177 [Documentation] Delete floating ip with neutron request.
178 ${output} = OpenStack CLI openstack floating ip delete ${fip}
181 [Arguments] ${subnet}
182 [Documentation] Delete SubNet for the Network with neutron request.
183 ${output} = OpenStack CLI openstack subnet delete ${subnet}
186 [Arguments] ${vm_name}
187 [Documentation] Delete Vm instances using instance names.
188 ${output} = OpenStack CLI openstack server delete ${vm_name}
191 [Arguments] ${network_name}
192 [Documentation] Retrieve the net id for the given network name to create specific vm instance
193 ${output} = OpenStack CLI openstack network list | grep "${network_name}" | awk '{print $2}'
194 ${splitted_output} = String.Split String ${output} ${EMPTY}
195 ${net_id} = Collections.Get from List ${splitted_output} 0
199 [Arguments] ${subnet_name}
200 [Documentation] Retrieve the subnet id for the given subnet name
201 ${output} = OpenStack CLI openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
202 ${splitted_output} = String.Split String ${output} ${EMPTY}
203 ${subnet_id} = Collections.Get from List ${splitted_output} 0
204 [Return] ${subnet_id}
207 [Arguments] ${port_name}
208 [Documentation] Retrieve the port id for the given port name to attach specific vm instance to a particular port
209 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk '{print $2}'
210 ${splitted_output} = String.Split String ${output} ${EMPTY}
211 ${port_id} = Collections.Get from List ${splitted_output} 0
215 [Arguments] ${portname}
216 [Documentation] Retrieve the first 10 chars of the UUID for the given port name
217 ${port_id} = OpenStackOperations.Get Port Id ${portname}
218 ${output} = String.Get Regexp Matches ${port_id} \\w{8}-\\w{2}
219 ${subport_id} = Collections.Get from List ${output} 0
220 [Return] ${subport_id}
223 [Arguments] ${router1}
224 [Documentation] Retrieve the router id for the given router name
225 ${output} = OpenStack CLI openstack router show "${router1}" |awk '/ id / {print $4}'
226 ${splitted_output} = String.Split String ${output} ${EMPTY}
227 ${router_id} = Collections.Get from List ${splitted_output} 0
228 [Return] ${router_id}
230 Get VMs OVS Port Number
231 [Arguments] ${ip_address} ${portname}
232 [Documentation] Get the port number for given portname
233 ${subportid} = OpenStackOperations.Get Sub Port Id ${portname}
234 ${vm_port_number} = OVSDB.Get Port Number ${subportid} ${ip_address}
235 [Return] ${vm_port_number}
237 Add New Image From Url
238 [Arguments] ${image_url} ${image_name}
239 [Documentation] To add new qcow2 images for testing.
240 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output wget ${image_url} -O /tmp/new_image.qcow2
241 BuiltIn.Log ${output}
242 BuiltIn.Should Be True '${rc}' == '0'
243 ${output} = OpenStack CLI openstack image create ${image_name} --file /tmp/new_image.qcow2 --disk-format qcow2 --container-format bare --public
246 [Arguments] ${flavor_name} ${ram_in_mb} ${disk_in_gb} ${ncpu}=1
247 [Documentation] To create new flavors for instance deployment and testing
248 ${output} = OpenStack CLI openstack flavor create ${flavor_name} --ram ${ram_in_mb} --disk ${disk_in_gb} --vcpus ${ncpu}
251 [Arguments] ${keyname} ${public_key_file}
252 [Documentation] To add keypairs to Openstack that can be used when ssh to instances using publickey authentication
253 ${output} = OpenStack CLI openstack keypair create ${keyname} --public-key ${public_key_file}
255 Generate And Add Keypair
256 [Arguments] ${keyname} ${keyfilename}
257 [Documentation] To generate keypair using ssh-keygen and add them to Openstack
258 ${result} = Process.Run Process ssh-keygen -b 2048 -t rsa -f ${JENKINS_WORKSPACE}/${keyfilename} -q -N "" shell=True
259 BuiltIn.Log ${result.stdout}
260 BuiltIn.Log ${result.stderr}
261 BuiltIn.Should Be True '${result.rc}' == '0'
262 OpenStackOperations.Create Keypair ${keyname} ${JENKINS_WORKSPACE}/${keyfilename}.pub
263 OpenStackOperations.Get ControlNode Connection
264 SSHLibrary.Put_File ${JENKINS_WORKSPACE}/${keyfilename} /tmp
267 [Arguments] ${net_name} ${vm_instance_names} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default ${min}=1
268 [Documentation] Create X Vm Instance with the net id of the Netowrk.
270 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
271 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
272 : FOR ${vm} IN @{vm_instance_names}
273 \ ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
275 Create Vm Instance On Compute Node
276 [Arguments] ${net_name} ${vm_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
277 [Documentation] Create a VM instance on a specific compute node.
278 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
279 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
280 ${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}
282 Create Vm Instance With Port
283 [Arguments] ${port_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
284 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
285 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
286 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --port ${port_name} --security-group ${sg} ${vm_instance_name}
288 Create Vm Instance With Ports And Key On Compute Node
289 [Arguments] ${port1_name} ${port2_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano
290 ... ${sg}=default ${keyname}=${EMPTY}
291 [Documentation] Create One VM instance using given ${port1_name} and ${port2_name} with keyname for ssh and also on a specific compute node
292 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
293 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --port ${port1_name} --port ${port2_name} ${vm_instance_name} --security-group ${sg} --availability-zone nova:${node_hostname} --key-name ${keyname}
295 Create Vm Instance With Port On Compute Node
296 [Arguments] ${port_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
297 [Documentation] Create One VM instance using given ${port_name} and for given ${node_hostname}
298 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
299 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --port ${port_name} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
301 Remove Security Group From Vm Instance
302 [Arguments] ${vm_instance_name} ${security_group}
303 [Documentation] Delete the Security Group from the VM Instance.
304 ${output} = OpenStack CLI openstack server remove security group ${vm_instance_name} ${security_group}
306 Create Vm Instance With Ports On Compute Node
307 [Arguments] ${port1_name} ${port2_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano
309 [Documentation] Create One VM instance using given ${port1_name}, ${port2_name} and for given ${node_hostname} with no keys (cirros like)
310 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
311 ${port1_id} = OpenStackOperations.Get Port Id ${port1_name}
312 ${port2_id} = OpenStackOperations.Get Port Id ${port2_name}
313 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port1_id} --nic port-id=${port2_id} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
315 Get Hypervisor Hostname From IP
316 [Arguments] ${hypervisor_ip}
317 [Documentation] Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
318 ... the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
319 ${output} = OpenStack CLI openstack hypervisor list
320 ${hostname} = OpenStack CLI openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
324 [Documentation] Create a nano flavor
325 ${output} = OpenStack CLI openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
328 [Arguments] ${vm_name}
329 [Documentation] Run these commands to check whether the created vm instance is active or not.
330 ${output} = OpenStack CLI openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
331 BuiltIn.Should Contain ${output} active
334 [Arguments] ${vm_name} ${retry}=600s ${retry_interval}=30s
335 [Documentation] Run these commands to check whether the created vm instance is active or not.
336 BuiltIn.Wait Until Keyword Succeeds ${retry} ${retry_interval} OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
339 [Arguments] ${text} ${regexp} ${index}=0
340 [Documentation] Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
341 @{matches} = String.Get Regexp Matches ${text} ${regexp}
342 ${matches_length} = BuiltIn.Get Length ${matches}
343 BuiltIn.Set Suite Variable ${OS_MATCH} None
344 BuiltIn.Run Keyword If ${matches_length} > ${index} BuiltIn.Set Suite Variable ${OS_MATCH} @{matches}[${index}]
348 [Arguments] ${fail_on_none} ${vm}
349 [Documentation] Get the vm ip address and nameserver by scraping the vm's console log.
350 ... Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
351 ${vm_console_output} = OpenStack CLI With No Log openstack console log show ${vm}
352 ${vm_ip} = BuiltIn.Set Variable None
353 ${dhcp_ip} = BuiltIn.Set Variable None
354 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_OBTAINED}
355 ${vm_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 0
356 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_IPROUTE}
357 ${dhcp_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 1
358 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${vm_ip} None
359 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${dhcp_ip} None
360 [Return] ${vm_ip} ${dhcp_ip} ${vm_console_output}
362 Verify If Instance Is Arpingable From DHCP Namespace
363 [Arguments] ${net_name} ${mac} ${ip}
364 [Documentation] Get the Port IP and check the arp -a from DHCP NS to ensure that the VM's have been assigned IP's
365 OpenStackOperations.Get ControlNode Connection
366 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
367 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} arping ${ip} -c3 ${DEFAULT_LINUX_PROMPT_STRICT} timeout=60s
368 ${mac_uppercase} = String.Convert To Upper Case ${mac}
369 BuiltIn.Should Contain ${output} [${mac_uppercase}]
371 Check If Instance Is Ready For Ssh Login Using PublicKey
372 [Arguments] ${net_name} ${vm_ip} ${user}=centos ${idfile}=/tmp/odlkey ${console}=cirros
373 [Documentation] Ensure the VM is reachable from ssh as tests would require. This keyword will use publickey authentication
374 ${output} = Execute Command on VM Instance with PublicKey Auth ${net_name} ${vm_ip} ifconfig user=${user} idfile=${idfile}
375 ... console=${console}
376 BuiltIn.Should Contain ${output} ${vm_ip}
378 Check If Instance Is Ready For Ssh Login Using Password
379 [Arguments] ${net_name} ${vm_ip} ${user}=cirros ${password}=cubswin:) ${console}=cirros
380 [Documentation] Ensure the VM is reachable from ssh as tests would require. This keyword will use password authentication
381 ${output} = Execute Command on VM Instance ${net_name} ${vm_ip} ifconfig ${user} ${password}
382 ... console=${console}
383 BuiltIn.Should Contain ${output} ${vm_ip}
387 [Documentation] Get the instance IP addresses and nameserver address for the list of given vms.
388 ... First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
389 ... Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
390 ... of None) and [1] the dhcp ip address found in the last vm checked.
391 ... TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
392 ... may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
393 @{vm_ips} BuiltIn.Create List @{EMPTY}
394 : FOR ${vm} IN @{vms}
395 \ OpenStackOperations.Poll VM Is ACTIVE ${vm}
396 \ ${status} ${ips_and_console_log} BuiltIn.Run Keyword And Ignore Error BuiltIn.Wait Until Keyword Succeeds 180s 15s
397 \ ... OpenStackOperations.Get VM IP true ${vm}
398 \ # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
399 \ # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
400 \ # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
401 \ # the vm ip list if status is FAIL.
402 \ BuiltIn.Run Keyword If "${status}" == "PASS" BuiltIn.Log ${ips_and_console_log[2]}
403 \ BuiltIn.Run Keyword If "${status}" == "PASS" Collections.Append To List ${vm_ips} ${ips_and_console_log[0]}
404 \ BuiltIn.Run Keyword If "${status}" == "FAIL" Collections.Append To List ${vm_ips} None
405 \ ${vm_console_output} = BuiltIn.Run Keyword If "${status}" == "FAIL" OpenStack CLI openstack console log show ${vm}
406 \ BuiltIn.Run Keyword If "${status}" == "FAIL" BuiltIn.Log ${vm_console_output}
407 OpenStackOperations.Copy DHCP Files From Control Node
408 [Return] @{vm_ips} ${ips_and_console_log[1]}
410 Get All VM IP Addresses
411 [Arguments] ${conn_id} ${vm_name}
412 [Documentation] Show information of a given two port VM and grep for two ip address. VM name should be sent as arguments.
413 SSHLibrary.Switch Connection ${conn_id}
414 ${cmd} = BuiltIn.Set Variable openstack server show ${vm_name}
415 ${output} = OpenStackOperations.OpenStack CLI ${cmd}
416 BuiltIn.Log ${output}
417 ${address_output} = OpenStackOperations.OpenStack CLI ${cmd} | grep "addresses" | awk '{print $4$5}'
418 @{vm_ips} = String.Get Regexp Matches ${address_output} ${REGEX_IPV4}
421 Get Subnet Gateway Ip
422 [Arguments] ${subnet_name}
423 [Documentation] Show information of a subnet and grep for subnet gateway ip address
424 ${output} = OpenStackOperations.OpenStack CLI openstack subnet show ${subnet_name} | grep gateway_ip | awk '{print $4}'
425 ${splitted_output} = String.Split String ${output} ${EMPTY}
426 ${matches} = Collections.Get Matches ${splitted_output} regexp=(\\d\.)+
427 ${subnet_gateway_ip} = String.Strip String ${matches[0]} characters=','
428 [Return] ${subnet_gateway_ip}
430 Collect VM IPv6 SLAAC Addresses
431 [Arguments] ${fail_on_none} ${vm_list} ${network} ${subnet}
432 [Documentation] For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
433 ... Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
434 ... obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
435 ... Returns an empty list if no IPv6 addresses found or if SSH connection fails.
436 ... Otherwise, returns a list of IPv6 addresses.
437 ${ipv6_list} = BuiltIn.Create List @{EMPTY}
438 : FOR ${vm} IN @{vm_list}
439 \ ${output} = OpenStack CLI openstack server show ${vm} -f shell
440 \ ${pattern} = String.Replace String ${subnet} ::/64 (:[a-f0-9]{,4}){,4}
441 \ @{vm_ipv6} = String.Get Regexp Matches ${output} ${pattern}
442 \ ${vm_ip_length} = BuiltIn.Get Length ${vm_ipv6}[0]
443 \ ${ipv6_data_from_vm} = BuiltIn.Run Keyword If ${vm_ip_length}>0 OpenStackOperations.Execute Command on VM Instance ${network} ${vm_ipv6[0]}
445 \ @{ipv6} = String.Get Regexp Matches ${ipv6_data_from_vm} ${pattern}
446 \ ${ipv6_addr_list_length} BuiltIn.Get Length @{ipv6}
447 \ BuiltIn.Run Keyword If ${ipv6_addr_list_length}>0 Collections.Append To List ${ipv6_list} ${ipv6[0]}
448 \ ... ELSE Collections.Append To List ${ipv6_list} None
449 [Return] ${ipv6_list}
452 [Arguments] ${vm_instance_names}
453 [Documentation] View Console log of the created vm instances using nova show.
454 : FOR ${vm} IN @{vm_instance_names}
455 \ ${output} = OpenStack CLI openstack server show ${vm}
456 \ ${output} = OpenStack CLI openstack console log show ${vm}
458 Ping Vm From DHCP Namespace
459 [Arguments] ${net_name} ${vm_ip}
460 [Documentation] Reach all Vm Instance with the net id of the Netowrk.
461 OpenStackOperations.Get ControlNode Connection
462 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
463 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
464 BuiltIn.Should Contain ${output} 64 bytes
466 Ping From DHCP Should Not Succeed
467 [Arguments] ${net_name} ${vm_ip}
468 [Documentation] Should Not Reach Vm Instance with the net id of the Netowrk.
469 Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
470 OpenStackOperations.Get ControlNode Connection
471 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
472 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
473 BuiltIn.Should Not Contain ${output} 64 bytes
475 Ping Vm From Control Node
476 [Arguments] ${vm_floating_ip} ${additional_args}=${EMPTY}
477 [Documentation] Ping VM floating IP from control node
478 OpenStackOperations.Get ControlNode Connection
479 ${output} = DevstackUtils.Write Commands Until Prompt And Log ping ${additional_args} -c 3 ${vm_floating_ip} 20s
480 BuiltIn.Should Contain ${output} 64 bytes
483 [Documentation] Ping to the expected destination ip.
484 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
485 DevstackUtils.Write Commands Until Prompt exit
486 BuiltIn.Should Contain ${output} 200
489 [Documentation] Exit the vm instance.
490 ${output} = DevstackUtils.Write Commands Until Prompt And Log exit
492 Check If Console Is VmInstance
493 [Arguments] ${console}=cirros
494 [Documentation] Check if the session has been able to login to the VM instance
495 ${output} = Utils.Write Commands Until Expected Prompt id ${OS_SYSTEM_PROMPT}
496 BuiltIn.Should Contain ${output} ${console}
499 [Arguments] ${console}=cirros
500 [Documentation] Check if the session has been able to login to the VM instance and exit the instance
501 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
502 BuiltIn.Run Keyword If ${rcode} DevstackUtils.Write Commands Until Prompt exit
505 [Arguments] ${ip_address} ${ttl}=64 ${ping_tries}=3
506 [Documentation] Run Ping command on the IP available as argument
507 ${ethertype} = String.Get Regexp Matches ${ip_address} ${IP_REGEX}
508 ${ping} = BuiltIn.Set Variable If ${ethertype} ping ping6
509 ${cmd} = BuiltIn.Set Variable rc=0; for count in `seq 1 ${ping_tries}`; do ${ping} -W1 -t${ttl} -c1 ${ip_address}; rc=$?; if [ $rc -eq 0 ]; then break; fi; done; echo ping_rc=$rc
510 ${output} = Utils.Write Commands Until Expected Regexp ${cmd} ping_rc=\\d+ 120
511 BuiltIn.Log output: ${output}
512 BuiltIn.Should Contain ${output} 64 bytes
515 [Arguments] ${ip_address} ${ttl}=64
516 [Documentation] Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
517 ${output} = Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
518 BuiltIn.Should Not Contain ${output} 64 bytes
520 Check Metadata Access
521 [Documentation] Try curl on the Metadataurl and check if it is okay
522 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
523 BuiltIn.Should Contain ${output} 200
525 Execute Command on VM Instance
526 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=cirros ${password}=cubswin:) ${cmd_timeout}=30s
527 ... ${console}=cirros
528 [Documentation] Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
529 OpenStackOperations.Get ControlNode Connection
530 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
531 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ssh ${user}@${vm_ip} -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PreferredAuthentications=password password:
532 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
533 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
534 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT} timeout=${cmd_timeout}
535 [Teardown] Exit From Vm Console ${console}
538 Execute Command on VM Instance With PublicKey Auth
539 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=centos ${idfile}=/tmp/odlkey ${console}=cirros
540 [Documentation] Login to the vm instance using ssh publickey in the network, executes a command inside the VM and returns the ouput.
541 OpenStackOperations.Get ControlNode Connection
542 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
543 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ssh -i ${idfile} ${user}@${vm_ip} -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PreferredAuthentications=publickey prompt=${OS_SYSTEM_PROMPT} timeout=60s
544 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
545 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT}
546 [Teardown] Exit From Vm Console ${console}
549 Copy File To VM Instance With PublicKey Auth
550 [Arguments] ${net_name} ${vm_ip} ${file_to_copy} ${user}=centos ${idfile}=/tmp/odlkey
551 [Documentation] Login to the vm instance using ssh publickey in the network, executes a command inside the VM and returns the ouput.
552 OpenStackOperations.Get ControlNode Connection
553 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
554 ${rc} = SSHLibrary.Execute Command sudo ip netns exec qdhcp-${net_id} scp -i ${idfile} -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o PreferredAuthentications=publickey ${file_to_copy} ${user}@${vm_ip}:/tmp/ return_stdout=False return_rc=True
555 BuiltIn.Should Be True '${rc}' == '0'
557 Test Operations From Vm Instance
558 [Arguments] ${net_name} ${src_ip} ${dest_ips} ${user}=cirros ${password}=cubswin:) ${ttl}=64
559 ... ${ping_should_succeed}=True ${check_metadata}=True ${console}=cirros ${ping_tries}=3
560 [Documentation] Login to the vm instance using ssh in the network.
561 OpenStackOperations.Get ControlNode Connection
562 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
563 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ssh -o MACs=hmac-sha1 -o ConnectTimeout=5 -o StrictHostKeyChecking=no ${user}@${src_ip} -o UserKnownHostsFile=/dev/null password: 10s
564 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
565 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
566 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ifconfig ${OS_SYSTEM_PROMPT}
567 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -n ${OS_SYSTEM_PROMPT}
568 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -A inet6 ${OS_SYSTEM_PROMPT}
569 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt arp -an ${OS_SYSTEM_PROMPT}
570 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ip -f inet6 neigh show ${OS_SYSTEM_PROMPT}
571 : FOR ${dest_ip} IN @{dest_ips}
572 \ ${string_empty} = BuiltIn.Run Keyword And Return Status Should Be Empty ${dest_ip}
573 \ BuiltIn.Run Keyword If ${string_empty} Continue For Loop
574 \ BuiltIn.Run Keyword If ${rcode} and "${ping_should_succeed}" == "True" OpenStackOperations.Check Ping ${dest_ip} ttl=${ttl} ping_tries=${ping_tries}
575 \ ... ELSE OpenStackOperations.Check No Ping ${dest_ip} ttl=${ttl}
576 ${ethertype} = String.Get Regexp Matches ${src_ip} ${IP_REGEX}
577 BuiltIn.Run Keyword If ${rcode} and "${check_metadata}" and ${ethertype} == "True" OpenStackOperations.Check Metadata Access
578 [Teardown] Exit From Vm Console ${console}
580 Test Netcat Operations From Vm Instance
581 [Arguments] ${net_name} ${vm_ip} ${dest_ip} ${additional_args}=${EMPTY} ${port}=12345 ${user}=cirros
582 ... ${password}=cubswin:)
583 [Documentation] Use Netcat to test TCP/UDP connections to the controller
584 ${client_data} BuiltIn.Set Variable Test Client Data
585 ${server_data} BuiltIn.Set Variable Test Server Data
586 OpenStackOperations.Get ControlNode Connection
587 ${output} = DevstackUtils.Write Commands Until Prompt And Log ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
588 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo netstat -nlap | grep ${port}
589 ${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}
590 BuiltIn.Log ${output}
591 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo route -n
592 BuiltIn.Log ${output}
593 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo arp -an
594 BuiltIn.Log ${output}
595 BuiltIn.Should Match Regexp ${nc_output} ${server_data}
598 [Arguments] ${list_of_external_dst_ips} ${console}=cirros
599 [Documentation] Check reachability with other network's instances.
600 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
601 : FOR ${dest_ip} IN @{list_of_external_dst_ips}
602 \ OpenStackOperations.Check Ping ${dest_ip}
605 [Arguments] ${router_name}
606 [Documentation] Create Router and Add Interface to the subnets.
607 ${output} = OpenStack CLI openstack router create ${router_name}
610 [Documentation] List Routers and return output with neutron client.
611 ${output} = OpenStack CLI openstack router list -f value
615 [Arguments] ${router_name} ${interface_name}
616 ${output} = OpenStack CLI openstack router add subnet ${router_name} ${interface_name}
618 Show Router Interface
619 [Arguments] ${router_name}
620 [Documentation] List Routers interface associated with given Router and return output with neutron client.
621 ${output} = OpenStack CLI openstack port list --router ${router_name} -f value
625 [Arguments] ${router_name} ${external_network_name} ${additional_args}=${EMPTY}
626 ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name} ${additional_args}
629 [Arguments] ${router_name} ${interface_name}
630 [Documentation] Remove Interface to the subnets.
631 ${output} = OpenStack CLI openstack router remove subnet ${router_name} ${interface_name}
634 [Arguments] ${router_name}
635 [Documentation] Remove external gateway from the router.
636 ${output} = OpenStack CLI openstack router unset ${router_name} --external-gateway
639 [Arguments] ${router_name} ${cmd}
640 [Documentation] Update the router with the command. Router name and command should be passed as argument.
641 ${output} = OpenStack CLI openstack router set ${router_name} ${cmd}
644 [Arguments] ${router_name} ${additional_args}=${EMPTY}
645 [Documentation] Show information of a given router. Router name and optional fields should be sent as arguments.
646 ${output} = OpenStack CLI openstack router show ${router_name} ${additional_args}
650 [Arguments] ${router_name}
651 [Documentation] Delete Router and Interface to the subnets.
652 ${output} = OpenStack CLI openstack router delete ${router_name}
654 Get DumpFlows And Ovsconfig
655 [Arguments] ${conn_id}
656 [Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
657 SSHLibrary.Switch Connection ${conn_id}
658 Utils.Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
659 Utils.Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
660 Utils.Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
661 Utils.Write Commands Until Expected Prompt arp -an ${DEFAULT_LINUX_PROMPT_STRICT}
662 ${nslist} = Utils.Write Commands Until Expected Prompt ip netns list | awk '{print $1}' ${DEFAULT_LINUX_PROMPT_STRICT}
663 @{lines} Split To Lines ${nslist} end=-1
664 : FOR ${line} IN @{lines}
665 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
666 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
667 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
668 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
669 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
670 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
671 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
672 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
673 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
675 Get ControlNode Connection
676 SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
677 [Return] ${OS_CNTL_CONN_ID}
680 [Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
681 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
682 \ OpenStackOperations.Get DumpFlows And Ovsconfig ${conn_id}
684 Get Test Teardown Debugs
685 [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME} ${fail}=${FAIL_ON_EXCEPTIONS}
686 ODLTools.Get All node_ip=${HA_PROXY_IP} test_name=${test_name}
687 OpenStackOperations.Get OvsDebugInfo
688 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_data_models}
689 KarafKeywords.Fail If Exceptions Found During Test ${test_name} fail=${fail}
690 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
691 \ BuiltIn.Run Keyword And Ignore Error Issue_Command_On_Karaf_Console trace:transactions ${ODL_SYSTEM_${i+1}_IP}
694 Get Test Teardown Debugs test_name=${SUITE_NAME} fail=False
696 Get Test Teardown Debugs For SFC
697 [Arguments] ${test_name}=${TEST_NAME}
698 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_sfc_data_models}
701 [Arguments] @{vm_indices}
702 [Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
703 OpenStackOperations.Get ControlNode Connection
704 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns list
705 : FOR ${index} IN @{vm_indices}
706 \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
707 \ BuiltIn.Log ${output}
708 OpenStackOperations.List Nova VMs
709 OpenStackOperations.List Routers
710 OpenStackOperations.List Networks
711 OpenStackOperations.List Subnets
712 OpenStackOperations.List Ports
713 OpenStackOperations.List Security Groups
716 [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
717 ... credentials are already sourced
718 ${output} = OpenStack CLI openstack security group list
721 Neutron Security Group Show
722 [Arguments] ${SecurityGroupRuleName}
723 [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
724 ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
728 [Arguments] ${PortName}
729 [Documentation] Display the port configuration that belong to a given neutron port
730 ${output} = OpenStack CLI openstack port show ${PortName}
733 Neutron Security Group Create
734 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
735 [Documentation] Create a security group with specified name ,description & protocol value according to security group template
736 OpenStackOperations.Get ControlNode Connection
737 ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
738 ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
739 [Return] ${output} ${sgp_id}
741 Neutron Security Group Update
742 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
743 [Documentation] Updating security groups
744 ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
748 [Arguments] ${sg_name}
749 [Documentation] Delete Security group
750 ${output} = OpenStack CLI openstack security group delete ${sg_name}
752 Neutron Security Group Rule Create
753 [Arguments] ${Security_group_name} &{Kwargs}
754 [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]} ..."
755 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
756 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
757 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
758 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
759 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
760 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
761 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
762 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
763 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
764 ${remote_ip} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip default=${None}
765 ${cmd} = BuiltIn.Set Variable openstack security group rule create ${Security_group_name}
766 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
767 ... ELSE BuiltIn.Catenate ${cmd}
768 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --${direction}
769 ... ELSE BuiltIn.Catenate ${cmd}
770 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
771 ... ELSE BuiltIn.Catenate ${cmd}
772 ${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}
773 ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
774 ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}
775 ... ELSE BuiltIn.Catenate ${cmd}
776 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
777 ... ELSE BuiltIn.Catenate ${cmd}
778 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote-group ${remote_group_id}
779 ... ELSE BuiltIn.Catenate ${cmd}
780 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --src-ip ${remote_ip_prefix}
781 ... ELSE BuiltIn.Catenate ${cmd}
782 ${cmd} = BuiltIn.Run Keyword If '${remote_ip}'!='None' BuiltIn.Catenate ${cmd} --remote-ip ${remote_ip}
783 ... ELSE BuiltIn.Catenate ${cmd}
784 ${output} = OpenStack CLI ${cmd}
785 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
786 [Return] ${output} ${rule_id}
788 Security Group Create Without Default Security Rules
789 [Arguments] ${sg_name} ${additional_args}=${EMPTY}
790 [Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
791 OpenStackOperations.Neutron Security Group Create ${sg_name} ${additional_args}
792 Delete All Security Group Rules ${sg_name}
794 Delete All Security Group Rules
795 [Arguments] ${sg_name}
796 [Documentation] Delete all security rules from a specified security group
797 ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
798 @{sg_rules} = String.Split String ${sg_rules_output} \n
799 : FOR ${rule} IN @{sg_rules}
800 \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
802 Create Allow All SecurityGroup
803 [Arguments] ${sg_name} ${ether_type}=IPv4 ${dual}=False
804 [Documentation] Allow all TCP/UDP/ICMP packets for this suite
805 OpenStackOperations.Neutron Security Group Create ${sg_name}
806 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
807 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
808 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
809 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
810 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
811 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
812 BuiltIn.Run Keyword If "${dual}"=="True" Run Keywords OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6
813 ... port_range_max=65535 port_range_min=1 protocol=tcp
814 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 port_range_max=65535
815 ... port_range_min=1 protocol=tcp
816 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6 protocol=icmp
817 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 protocol=icmp
818 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6 port_range_max=65535
819 ... port_range_min=1 protocol=udp
820 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 port_range_max=65535
821 ... port_range_min=1 protocol=udp
823 Create Neutron Port With Additional Params
824 [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
825 [Documentation] Create Port With given additional parameters
826 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
827 BuiltIn.Log ${output}
828 BuiltIn.Should Be True '${rc}' == '0'
829 ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
830 [Return] ${OUTPUT} ${port_id}
834 [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
835 ${macs} BuiltIn.Create List
836 : FOR ${port} IN @{ports}
837 \ ${mac} = OpenStackOperations.Get Port Mac ${port}
838 \ Collections.Append To List ${macs} ${mac}
842 [Arguments] ${port_name}
843 [Documentation] Keyword would return the IP of the ${port_name} received.
844 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
845 ${splitted_output} = String.Split String ${output} ${EMPTY}
846 ${port_ip} = Collections.Get from List ${splitted_output} 0
850 [Arguments] ${port_name}
851 [Documentation] Keyword would return the MAC ID of the ${port_name} received.
852 ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
853 ${splitted_output} = String.Split String ${output} ${EMPTY}
854 ${port_mac} = Collections.Get from List ${splitted_output} 0
857 Get Port Mac Address From Ip
859 [Documentation] Retrieve the mac address for a port that matches any given ip.
860 ${output} = OpenStack CLI openstack port list | grep -w ${ip} | awk '{print $5}'
861 ${splitted_output} = String.Split String ${output} ${EMPTY}
862 ${mac_addr} = Collections.Get from List ${splitted_output} 0
866 [Arguments] ${bridge_name} ${intf_name} ${gw_name}
867 [Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
868 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
869 BuiltIn.Log ${l2gw_output}
870 [Return] ${l2gw_output}
873 [Arguments] ${bridge_name} ${gw_name} ${intf_name_1} ${intf_name_2}
874 [Documentation] Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
875 ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
877 [Return] ${l2gw_output}
879 Create L2Gateway Connection
880 [Arguments] ${gw_name} ${net_name}
881 [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
882 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
883 BuiltIn.Log ${l2gw_output}
884 BuiltIn.Should Be True '${rc}' == '0'
885 [Return] ${l2gw_output}
888 [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
889 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
890 BuiltIn.Should Be True '${rc}' == '0'
893 Get All L2Gateway Connection
894 [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
895 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
896 BuiltIn.Should Be True '${rc}' == '0'
901 [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
902 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
903 BuiltIn.Log ${output}
904 BuiltIn.Should Be True '${rc}' == '0'
908 [Arguments] ${l2gw_name}
909 [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
910 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
911 BuiltIn.Log ${output}
912 BuiltIn.Should Be True '${rc}' == '0'
913 ${splitted_output} = String.Split String ${output} ${EMPTY}
914 ${l2gw_id} = Collections.Get from List ${splitted_output} 0
917 Get L2gw Connection Id
918 [Arguments] ${l2gw_name}
919 [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
920 ${l2gw_id} = OpenStackOperations.Get L2gw Id ${l2gw_name}
921 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
922 BuiltIn.Should Be True '${rc}' == '0'
923 ${splitted_output} = String.Split String ${output} ${EMPTY}
924 ${splitted_output} = String.Split String ${output} ${EMPTY}
925 ${l2gw_conn_id} = Collections.Get from List ${splitted_output} 0
926 [Return] ${l2gw_conn_id}
928 Neutron Port List Rest
929 [Documentation] Keyword to get all ports details in Neutron (Using REST).
930 ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
931 BuiltIn.Log ${resp.content}
932 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
933 [Return] ${resp.content}
935 Get Neutron Port Rest
936 [Arguments] ${port_id}
937 [Documentation] Keyword to get the specific port details in Neutron (Using REST).
938 ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
939 BuiltIn.Log ${resp.content}
940 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
941 [Return] ${resp.content}
944 [Arguments] ${port_id} ${json_data}
945 [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
946 BuiltIn.Log ${json_data}
947 ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
948 BuiltIn.Log ${resp.content}
949 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
950 [Return] ${resp.content}
952 Get Neutron Network Rest
953 [Arguments] ${net_id}
954 [Documentation] Keyword to get the specific network details in Neutron (Using REST).
955 ${resp} = RequestsLibrary.Get Request session ${NETWORK_URL}/network/${net_id}
956 BuiltIn.Log ${resp.content}
957 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
958 [Return] ${resp.content}
960 Create And Configure Security Group
961 [Arguments] ${sg-name}
962 [Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
963 OpenStackOperations.Neutron Security Group Create ${sg-name}
964 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
965 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
966 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
967 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
968 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
969 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
971 Add Security Group To VM
972 [Arguments] ${vm} ${sg}
973 [Documentation] Add the security group provided to the given VM.
974 ${output} = OpenStack CLI openstack server add security group ${vm} ${sg}
976 Remove Security Group From VM
977 [Arguments] ${vm} ${sg}
978 [Documentation] Remove the security group provided to the given VM.
979 OpenStackOperations.Get ControlNode Connection
980 ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
982 Create SFC Flow Classifier
983 [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${neutron_src_port} ${args}=${EMPTY}
984 [Documentation] Create a flow classifier for SFC
985 ${output} = OpenStack CLI openstack sfc flow classifier create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --logical-source-port ${neutron_src_port} ${args} ${name}
986 BuiltIn.Should Contain ${output} ${name}
989 Delete SFC Flow Classifier
991 [Documentation] Delete a SFC flow classifier
992 ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
996 [Arguments] ${name} ${port_in} ${port_out}
997 [Documentation] Creates a neutron port pair for SFC
998 ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
999 BuiltIn.Should Contain ${output} ${name}
1002 Delete SFC Port Pair
1004 [Documentation] Delete a SFC port pair
1005 ${output} = OpenStack CLI openstack sfc port pair delete ${name}
1008 Create SFC Port Pair Group
1009 [Arguments] ${name} ${port_pair}
1010 [Documentation] Creates a port pair group with a single port pair for SFC
1011 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
1012 BuiltIn.Should Contain ${output} ${name}
1015 Create SFC Port Pair Group With Two Pairs
1016 [Arguments] ${name} ${port_pair1} ${port_pair2}
1017 [Documentation] Creates a port pair group with two port pairs for SFC
1018 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
1019 BuiltIn.Should Contain ${output} ${name}
1022 Delete SFC Port Pair Group
1024 [Documentation] Delete a SFC port pair group
1025 OpenStackOperations.Get ControlNode Connection
1026 ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
1029 Create SFC Port Chain
1030 [Arguments] ${name} ${args}=${EMPTY}
1031 [Documentation] Creates a port pair chain with two port groups and a singel classifier.
1032 ${output} = OpenStack CLI openstack sfc port chain create ${name} ${args}
1033 BuiltIn.Should Contain ${output} ${name}
1036 Update SFC Port Chain With A New Flow Classifier
1037 [Arguments] ${name} ${fc}
1038 [Documentation] Adds a Flow Classifier to a Port Chain
1039 ${output} = OpenStack CLI openstack sfc port chain set ${name} --flow-classifier ${fc}
1042 Update SFC Port Chain Removing A Flow Classifier
1043 [Arguments] ${name} ${fc}
1044 [Documentation] Adds a Flow Classifier to a Port Chain
1045 ${output} = OpenStack CLI openstack sfc port chain unset ${name} --flow-classifier ${fc}
1048 Delete SFC Port Chain
1050 [Documentation] Delete a SFC port chain
1051 ${output} = OpenStack CLI openstack sfc port chain delete ${name}
1055 [Arguments] ${vm_name}
1056 [Documentation] Reboot NOVA VM
1057 ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
1058 BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
1060 Remove RSA Key From KnownHosts
1061 [Arguments] ${vm_ip}
1062 [Documentation] Remove RSA
1063 OpenStackOperations.Get ControlNode Connection
1064 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
1065 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
1066 ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
1068 Wait For Routes To Propogate
1069 [Arguments] ${networks} ${subnets}
1070 [Documentation] Check propagated routes
1071 OpenStackOperations.Get ControlNode Connection
1072 : FOR ${INDEX} IN RANGE 0 1
1073 \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
1074 \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
1075 \ ${length} = BuiltIn.Get Length ${is_ipv6}
1076 \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
1077 \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ${DEFAULT_LINUX_PROMPT_STRICT}
1078 \ BuiltIn.Should Contain ${output} @{subnets}[${INDEX}]
1081 [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
1082 : FOR ${vm} IN @{vms}
1083 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
1084 : FOR ${port} IN @{ports}
1085 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
1086 : FOR ${subnet} IN @{subnets}
1087 \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
1088 : FOR ${network} IN @{networks}
1089 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
1090 : FOR ${sg} IN @{sgs}
1091 \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
1094 [Documentation] Get a list of different OpenStack resources that might be in use.
1095 @{modules} = BuiltIn.Create List server port network subnet security group
1096 ... security group rule floating ip router
1097 : FOR ${module} IN @{modules}
1098 \ ${output} = OpenStack CLI openstack ${module} list
1100 OpenStack CLI Get List
1102 [Documentation] Return a json list from the output of an OpenStack command.
1103 @{list} = BuiltIn.Create List
1104 ${json} = OpenStack CLI ${cmd}
1105 @{list} = RequestsLibrary.To Json ${json}
1111 [Documentation] Run the given OpenStack ${cmd} and log the output.
1112 ${result} = Process.Run Process ${cmd} shell=True
1113 BuiltIn.Log ${result.stdout}
1114 BuiltIn.Log ${result.stderr}
1115 BuiltIn.Should Be True '${result.rc}' == '0'
1116 [Return] ${result.stdout}
1118 OpenStack CLI With No Log
1120 [Documentation] Run the given OpenStack ${cmd} and do not log the output.
1121 ${result} = Process.Run Process ${cmd} shell=True
1122 BuiltIn.Should Be True '${result.rc}' == '0'
1123 [Return] ${result.stdout}
1125 OpenStack Cleanup All
1126 [Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
1127 ... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
1128 @{fips} = OpenStack CLI Get List openstack floating ip list -f json
1129 : FOR ${fip} IN @{fips}
1130 \ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
1131 @{vms} = OpenStack CLI Get List openstack server list -f json
1132 : FOR ${vm} IN @{vms}
1133 \ OpenStack CLI openstack server show ${vm['ID']}
1134 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
1135 @{routers} = OpenStack CLI Get List openstack router list -f json
1136 : FOR ${router} IN @{routers}
1137 \ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
1138 @{ports} = OpenStack CLI Get List openstack port list -f json
1139 : FOR ${port} IN @{ports}
1140 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
1141 @{networks} = OpenStack CLI Get List openstack network list -f json
1142 : FOR ${network} IN @{networks}
1143 \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
1144 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
1145 @{security_groups} = OpenStack CLI Get List openstack security group list -f json
1146 : FOR ${security_group} IN @{security_groups}
1147 \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
1152 [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
1153 @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
1154 : FOR ${port} IN @{ports}
1155 \ ${subnet_id} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 0
1156 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
1157 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
1158 BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
1160 OpenStack Suite Setup
1161 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1162 SetupUtils.Setup_Utils_For_Setup_And_Teardown
1163 @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil org.apache.sshd.server.session.ServerSessionImpl
1164 Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All OFF ${loggers}
1165 DevstackUtils.Devstack Suite Setup
1166 @{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
1167 BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
1168 BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
1169 OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1172 OpenStack Suite Teardown
1173 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1174 ... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1175 ... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1176 ... benefit automatically.
1177 # TODO: followup patch will add the list of vms to pass to Show Debugs
1178 # OpenStackOperations.Show Debugs @{NET_1_VMS} @{NET_2_VMS}
1179 OpenStackOperations.Get Suite Debugs
1180 OpenStack Cleanup All
1181 OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
1182 SSHLibrary.Close All Connections
1183 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
1184 \ KarafKeywords.Issue Command On Karaf Console threads --list | wc -l ${ODL_SYSTEM_${i+1}_IP}
1187 [Documentation] Validate the deployment. Examples to validate are verifying default table
1188 ... flows are installed and that the tunnel mesh has been built correctly.
1189 Write To Validate File ----------------------------------------\n${SUITE_NAME}\n
1190 : FOR ${keyword} IN @{VALIDATION_KEYWORDS}
1191 \ ${status} = Builtin.Run Keyword And Return Status ${keyword}
1192 \ BuiltIn.Run Keyword If "${status}" == "FAIL" or "${status}" == "False" BuiltIn.Run Keywords Write To Validate File Failed: ${keyword}
1193 \ ... AND BuiltIn.Fail
1194 \ ... ELSE Write To Validate File Passed: ${keyword}
1196 Write To Validate File
1198 [Documentation] Write the given ${msg} to ${VALIDATION_FILE}. Create the file if not present.
1199 ${status} = BuiltIn.Run Keyword And Return Status OperatingSystem.File Should Exist ${VALIDATION_FILE}
1200 BuiltIn.Run Keyword If "${status}" == "False" OperatingSystem.Create File ${VALIDATION_FILE}
1201 OperatingSystem.Append To File ${VALIDATION_FILE} ${msg}\n
1203 Copy DHCP Files From Control Node
1204 [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
1205 ... after the subnet(s) are created and before the subnet(s) are deleted.
1206 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1207 ${dstdir} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
1208 OperatingSystem.Create Directory ${dstdir}
1209 OpenStackOperations.Get ControlNode Connection
1210 BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
1212 Is Feature Installed
1213 [Arguments] ${features}=none
1214 : FOR ${feature} IN @{features}
1215 \ ${status} ${output} BuiltIn.Run Keyword And Ignore Error BuiltIn.Should Contain ${CONTROLLERFEATURES} ${feature}
1216 \ Return From Keyword If "${status}" == "PASS" True
1219 Add OVS Logging On All OpenStack Nodes
1220 [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
1221 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1222 \ OVSDB.Add OVS Logging ${conn_id}
1224 Reset OVS Logging On All OpenStack Nodes
1225 [Documentation] Reset the OVS logging to all the OpenStack nodes
1226 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1227 \ OVSDB.Reset OVS Logging ${conn_id}
1229 Start Packet Capture On Nodes
1230 [Arguments] ${tag} ${filter} @{ips}
1231 [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1232 ... The caller must pass the three arguments with a variable number of ips at the end,
1233 ... but ${EMPTY} can be used for the tag and filter.
1234 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1235 ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
1236 @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
1237 [Return] @{conn_ids}
1239 Stop Packet Capture On Nodes
1240 [Arguments] ${conn_ids}=@{EMPTY}
1241 Tcpdump.Stop Packet Capture on Nodes ${conn_ids}
1244 [Arguments] ${vm_instance_name}
1245 [Documentation] Keyword for live migration of VM instance
1246 ... additional_agrs is to select particular migration(live/shared-migration/block-migration)
1247 ... if the additional_agrs is not given default migration(shared-migration) will happen
1248 ${output} = OpenStackOperations.OpenStack CLI nova live-migration ${vm_instance_name}
1250 Get Hypervisor Host Of Vm
1251 [Arguments] ${vm_name}
1252 [Documentation] Show server with neutron request.
1253 ${output} = OpenStackOperations.OpenStack CLI openstack server show -f value -c OS-EXT-SRV-ATTR:host ${vm_name}
1256 Check If Migration Is Complete
1257 [Arguments] ${vm_name}
1258 [Documentation] Show server and verify if task_state is not migrating
1259 ${output} = OpenStackOperations.OpenStack CLI openstack server show ${vm_name} | grep "OS-EXT-STS:task_state"
1260 BuiltIn.Should Not Contain ${output} migrating
1262 Modify OpenStack Configuration File
1263 [Arguments] ${conn_id} ${file_name} ${section} ${key} ${value}
1264 [Documentation] Use crudini to modify any parameter in any Openstack configuration File
1265 SSHLibrary.Switch Connection ${conn_id}
1266 ${output} ${rc} = SSHLibrary.Execute Command sudo crudini --verbose --set --inplace ${file_name} ${section} ${key} ${value} return_rc=True return_stdout=True
1267 BuiltIn.Log ${output}
1268 BuiltIn.Should Be True '${rc}' == '0'
1270 Restart DevStack Service
1271 [Arguments] ${conn_id} ${service_name}
1272 [Documentation] Restart the Openstack Service
1273 SSHLibrary.Switch Connection ${conn_id}
1274 ${output} ${rc} = SSHLibrary.Execute Command sudo systemctl restart devstack@${service_name}.service return_rc=True return_stdout=True
1275 BuiltIn.Log ${output}
1276 BuiltIn.Should Be True '${rc}' == '0'
1278 Get Network Segmentation Id
1279 [Arguments] ${network_name}
1280 [Documentation] Returns network segmentation id for the given network name.
1281 ${output} = OpenStack CLI openstack network show ${network_name} | grep segmentation_id | awk '{print $4}'
1282 @{list} = String.Split String ${output}
1286 [Documentation] Verify if the services are operational
1287 Wait Until Keyword Succeeds 60 2 ClusterManagement.Check Status Of Services Is OPERATIONAL @{NETVIRT_DIAG_SERVICES}
1289 Verify Expected Default Tunnels
1290 [Documentation] Verify if the default tunnels are created.
1291 ... SFC jobs currently fail this validation because it uses of-tunnels.
1292 ... This validation will be blocked for NEtvirt SFC jobs until support for of-tunnels
1293 ... added to odltools.
1294 ${check_feature_list} = BuiltIn.Create List odl-netvirt-sfc
1295 ${is_sfc_enabled} = OpenStackOperations.Is Feature Installed features=${check_feature_list}
1296 BuiltIn.Return From Keyword If ${is_sfc_enabled} == ${True} ${True}
1297 BuiltIn.Return From Keyword If ${OS_NODE_CNT} == ${1} ${True}
1298 ${output} = ODLTools.Analyze Tunnels test_name=${SUITE_NAME}.Suite Setup
1299 BuiltIn.Should Contain ${output} All tunnels are up
1301 Verify Expected Default Tables On Nodes
1302 [Arguments] ${node_ips}=@{OS_ALL_IPS}
1303 [Documentation] Verify if Default Table Entries are programmed on all Nodes
1304 ${resp} = RequestsLibrary.Get Request session ${CONFIG_NODES_API}
1305 Utils.Log Content ${resp.content}
1306 ${failed_node_list} = BuiltIn.Create List
1307 : FOR ${node_ip} IN @{node_ips}
1308 \ ${failed_table_list} = Verify Expected Default Tables ${node_ip}
1309 \ ${failed_table_list_size} = BuiltIn.Get Length ${failed_table_list}
1310 \ BuiltIn.Run Keyword If ${failed_table_list_size} > 0 Collections.Append To List ${failed_node_list} ${node_ip}
1311 Builtin.Should Be Empty ${failed_node_list}
1313 Verify Expected Default Tables
1314 [Arguments] ${ovs_ip}
1315 [Documentation] Verify if Default Table Entries are programmed on specific Node
1316 ${flow_dump} = Utils.Run Command On Remote System ${ovs_ip} sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13
1317 BuiltIn.Log ${flow_dump}
1318 ${failed_table_list} = BuiltIn.Create List
1319 : FOR ${table} IN @{DEFAULT_FLOW_TABLES}
1320 \ ${rc} = Builtin.Run Keyword And Return Status Builtin.Should Not Match Regexp ${flow_dump} .*table=${table}.*priority=0
1321 \ BuiltIn.Run Keyword If ${rc} Collections.Append To List ${failed_table_list} ${table}
1322 [Return] ${failed_table_list}
1325 [Arguments] ${project_name}
1326 [Documentation] Returns project ID for the given project name.
1327 ${project_id} = OpenStack CLI openstack project show ${project_name} -f value -c id
1328 [Return] ${project_id}
1330 Set Instance Quota For Project
1331 [Arguments] ${num_instances} ${project_id}
1332 [Documentation] Set quota for the created instances using the specific project id.
1333 ${output} = OpenStack CLI openstack quota set --instances ${num_instances} ${project_id}
1337 [Arguments] ${vpnname} ${additional_args}=${EMPTY}
1338 [Documentation] Create Bgpvpn with neutron request.
1339 ${output} = OpenStack CLI openstack bgpvpn create --name ${vpnname} ${additional_args}
1342 [Arguments] ${vpnName}
1343 [Documentation] Retrieve the bgpvpn id for the given bgpvpn name
1344 ${output} = OpenStack CLI OperatingSystem.Run And Return Rc And Output openstack bgpvpn show ${vpnName} | grep " ID" | awk '{print $4}'
1345 ${splitted_output}= String.Split String ${output} ${EMPTY}
1346 ${vpn_id}= Collections.Get from List ${splitted_output} 0
1349 Configure_IP_On_Sub_Interface
1350 [Arguments] ${network_name} ${ip} ${vm_ip} ${mask} ${sub_interface_state}=${EMPTY} ${interface}=eth0
1351 ... ${sub_interface_number}=1
1352 [Documentation] Keyword for configuring specified IP on specified interface and the corresponding specified sub interface
1353 OpenStackOperations.Execute Command on VM Instance ${network_name} ${vm_ip} sudo ifconfig ${interface}:${sub_interface_number} ${ip} netmask ${mask} ${sub_interface_state}
1355 Verify_IP_Configured_On_Sub_Interface
1356 [Arguments] ${network_name} ${ip} ${vm_ip} ${interface}=eth0 ${sub_interface_number}=1
1357 [Documentation] Keyword for verifying specified IP on specified interface and the corresponding specified sub interface
1358 ${resp} = OpenStackOperations.Execute Command on VM Instance ${network_name} ${vm_ip} sudo ifconfig ${interface}:${sub_interface_number}
1359 BuiltIn.Should Contain ${resp} ${ip}