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}
47 [Arguments] ${network_name} ${additional_args}=${EMPTY}
48 [Documentation] Update Network with neutron request.
49 ${output} = OpenStack CLI openstack network set ${network_name} ${additional_args}
53 [Arguments] ${network_name}
54 [Documentation] Show Network with neutron request.
55 ${output} = OpenStack CLI openstack network show ${network_name}
59 [Documentation] List networks and return output with neutron client.
60 ${output} = OpenStack CLI openstack network list
64 [Documentation] List subnets and return output with neutron client.
65 ${output} = OpenStack CLI openstack subnet list
69 [Arguments] ${network_name}
70 [Documentation] Delete Network with neutron request.
71 ${output} = OpenStack CLI openstack network delete ${network_name}
74 [Arguments] ${network_name} ${subnet_name} ${range_ip} ${additional_args}=${EMPTY}
75 [Documentation] Create SubNet for the Network with neutron request.
76 ${output} = OpenStack CLI openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet_name} ${additional_args}
79 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
80 [Documentation] Update subnet with openstack subnet set request.
81 ${output} = OpenStack CLI openstack subnet set ${subnet_name} ${additional_args}
85 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
86 [Documentation] Update subnet with openstack subnet unset request
87 ${output} = OpenStack CLI openstack subnet unset ${subnet_name} ${additional_args}
91 [Arguments] ${subnet_name}
92 [Documentation] Show subnet with neutron request.
93 ${output} = OpenStack CLI openstack subnet show ${subnet_name}
97 [Arguments] ${network_name} ${port_name} ${sg}=default ${additional_args}=${EMPTY} ${allowed_address_pairs}=${EMPTY}
98 [Documentation] Create Port with neutron request.
99 # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
100 # in a different format with the neutron vs openstack cli.
101 ${address_pair_length} = BuiltIn.Get Length ${allowed_address_pairs}
102 ${allowed_pairs_argv} = BuiltIn.Set Variable ${EMPTY}
103 ${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}
104 ${output} = OpenStack CLI openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
107 [Arguments] ${port_name} ${additional_args}=${EMPTY}
108 [Documentation] Update port with neutron request.
109 ${output} = OpenStack CLI openstack port set ${port_name} ${additional_args}
113 [Arguments] ${port_name}
114 [Documentation] Show port with neutron request.
115 ${output} = OpenStack CLI openstack port show ${port_name}
119 [Arguments] ${port_name}
120 [Documentation] Delete Port with neutron request.
121 ${output} = OpenStack CLI openstack port delete ${port_name}
124 [Documentation] List ports and return output with neutron client.
125 ${output} = OpenStack CLI openstack port list
129 [Documentation] List VMs and return output with nova client.
130 ${output} = OpenStack CLI openstack server list --all-projects
133 Create And Associate Floating IPs
134 [Arguments] ${external_net} @{vm_list}
135 [Documentation] Create and associate floating IPs to VMs with nova request
136 ${ip_list} = BuiltIn.Create List @{EMPTY}
137 : FOR ${vm} IN @{vm_list}
138 \ ${output} = OpenStack CLI openstack floating ip create ${external_net}
139 \ @{ip} = String.Get Regexp Matches ${output} [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
140 \ ${ip_length} = BuiltIn.Get Length ${ip}
141 \ BuiltIn.Run Keyword If ${ip_length}>0 Collections.Append To List ${ip_list} @{ip}[0]
142 \ ... ELSE Collections.Append To List ${ip_list} None
143 \ ${output} = OpenStack CLI openstack server add floating ip ${vm} @{ip}[0]
146 Remove Floating Ip From Vm
147 [Arguments] ${vm_name} ${fip}
148 [Documentation] Remove the Floating IP From VM Instance
149 ${output} = OpenStack CLI openstack server remove floating ip ${vm_name} ${fip}
153 [Documentation] Delete floating ip with neutron request.
154 ${output} = OpenStack CLI openstack floating ip delete ${fip}
157 [Arguments] ${subnet}
158 [Documentation] Delete SubNet for the Network with neutron request.
159 ${output} = OpenStack CLI openstack subnet delete ${subnet}
162 [Arguments] ${vm_name}
163 [Documentation] Delete Vm instances using instance names.
164 ${output} = OpenStack CLI openstack server delete ${vm_name}
167 [Arguments] ${network_name}
168 [Documentation] Retrieve the net id for the given network name to create specific vm instance
169 ${output} = OpenStack CLI openstack network list | grep "${network_name}" | awk '{print $2}'
170 ${splitted_output} = String.Split String ${output} ${EMPTY}
171 ${net_id} = Collections.Get from List ${splitted_output} 0
175 [Arguments] ${subnet_name}
176 [Documentation] Retrieve the subnet id for the given subnet name
177 ${output} = OpenStack CLI openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
178 ${splitted_output} = String.Split String ${output} ${EMPTY}
179 ${subnet_id} = Collections.Get from List ${splitted_output} 0
180 [Return] ${subnet_id}
183 [Arguments] ${port_name}
184 [Documentation] Retrieve the port id for the given port name to attach specific vm instance to a particular port
185 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk '{print $2}'
186 ${splitted_output} = String.Split String ${output} ${EMPTY}
187 ${port_id} = Collections.Get from List ${splitted_output} 0
191 [Arguments] ${portname}
192 [Documentation] Retrieve the first 10 chars of the UUID for the given port name
193 ${port_id} = OpenStackOperations.Get Port Id ${portname}
194 ${output} = String.Get Regexp Matches ${port_id} \\w{8}-\\w{2}
195 ${subport_id} = Collections.Get from List ${output} 0
196 [Return] ${subport_id}
199 [Arguments] ${router1}
200 [Documentation] Retrieve the router id for the given router name
201 ${output} = OpenStack CLI openstack router show "${router1}" |awk '/ id / {print $4}'
202 ${splitted_output} = String.Split String ${output} ${EMPTY}
203 ${router_id} = Collections.Get from List ${splitted_output} 0
204 [Return] ${router_id}
206 Add New Image From Url
207 [Arguments] ${image_url} ${image_name}
208 [Documentation] To add new qcow2 images for testing.
209 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output wget ${image_url} -O /tmp/new_image.qcow2
210 BuiltIn.Log ${output}
211 BuiltIn.Should Be True '${rc}' == '0'
212 ${output} = OpenStack CLI openstack image create ${image_name} --file /tmp/new_image.qcow2 --disk-format qcow2 --container-format bare --public
215 [Arguments] ${flavor_name} ${ram_in_mb} ${disk_in_gb} ${ncpu}=1
216 [Documentation] To create new flavors for instance deployment and testing
217 ${output} = OpenStack CLI openstack flavor create ${flavor_name} --ram ${ram_in_mb} --disk ${disk_in_gb} --vcpus ${ncpu}
220 [Arguments] ${keyname} ${public_key_file}
221 [Documentation] To add keypairs to Openstack that can be used when ssh to instances using publickey authentication
222 ${output} = OpenStack CLI openstack keypair create ${keyname} --public-key ${public_key_file}
224 Generate And Add Keypair
225 [Arguments] ${keyname} ${keyfilename}
226 [Documentation] To generate keypair using ssh-keygen and add them to Openstack
227 ${result} = Process.Run Process ssh-keygen -b 2048 -t rsa -f ${JENKINS_WORKSPACE}/${keyfilename} -q -N "" shell=True
228 BuiltIn.Log ${result.stdout}
229 BuiltIn.Log ${result.stderr}
230 BuiltIn.Should Be True '${result.rc}' == '0'
231 OpenStackOperations.Create Keypair ${keyname} ${JENKINS_WORKSPACE}/${keyfilename}.pub
232 OpenStackOperations.Get ControlNode Connection
233 SSHLibrary.Put_File ${JENKINS_WORKSPACE}/${keyfilename} /tmp
236 [Arguments] ${net_name} ${vm_instance_names} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default ${min}=1
237 [Documentation] Create X Vm Instance with the net id of the Netowrk.
239 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
240 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
241 : FOR ${vm} IN @{vm_instance_names}
242 \ ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
244 Create Vm Instance On Compute Node
245 [Arguments] ${net_name} ${vm_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
246 [Documentation] Create a VM instance on a specific compute node.
247 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
248 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
249 ${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}
251 Create Vm Instance With Port
252 [Arguments] ${port_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
253 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
254 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
255 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --port ${port_name} --security-group ${sg} ${vm_instance_name}
257 Create Vm Instance With Ports And Key On Compute Node
258 [Arguments] ${port1_name} ${port2_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano
259 ... ${sg}=default ${keyname}=${EMPTY}
260 [Documentation] Create One VM instance using given ${port1_name} and ${port2_name} with keyname for ssh and also on a specific compute node
261 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
262 ${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}
264 Create Vm Instance With Port On Compute Node
265 [Arguments] ${port_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
266 [Documentation] Create One VM instance using given ${port_name} and for given ${node_hostname}
267 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
268 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --port ${port_name} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
270 Remove Security Group From Vm Instance
271 [Arguments] ${vm_instance_name} ${security_group}
272 [Documentation] Delete the Security Group from the VM Instance.
273 ${output} = OpenStack CLI openstack server remove security group ${vm_instance_name} ${security_group}
275 Create Vm Instance With Ports On Compute Node
276 [Arguments] ${port1_name} ${port2_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano
278 [Documentation] Create One VM instance using given ${port1_name}, ${port2_name} and for given ${node_hostname} with no keys (cirros like)
279 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
280 ${port1_id} = OpenStackOperations.Get Port Id ${port1_name}
281 ${port2_id} = OpenStackOperations.Get Port Id ${port2_name}
282 ${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}
284 Get Hypervisor Hostname From IP
285 [Arguments] ${hypervisor_ip}
286 [Documentation] Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
287 ... the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
288 ${output} = OpenStack CLI openstack hypervisor list
289 ${hostname} = OpenStack CLI openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
293 [Documentation] Create a nano flavor
294 ${output} = OpenStack CLI openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
297 [Arguments] ${vm_name}
298 [Documentation] Run these commands to check whether the created vm instance is active or not.
299 ${output} = OpenStack CLI openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
300 BuiltIn.Should Contain ${output} active
303 [Arguments] ${vm_name} ${retry}=600s ${retry_interval}=30s
304 [Documentation] Run these commands to check whether the created vm instance is active or not.
305 BuiltIn.Wait Until Keyword Succeeds ${retry} ${retry_interval} OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
308 [Arguments] ${text} ${regexp} ${index}=0
309 [Documentation] Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
310 @{matches} = String.Get Regexp Matches ${text} ${regexp}
311 ${matches_length} = BuiltIn.Get Length ${matches}
312 BuiltIn.Set Suite Variable ${OS_MATCH} None
313 BuiltIn.Run Keyword If ${matches_length} > ${index} BuiltIn.Set Suite Variable ${OS_MATCH} @{matches}[${index}]
317 [Arguments] ${fail_on_none} ${vm}
318 [Documentation] Get the vm ip address and nameserver by scraping the vm's console log.
319 ... Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
320 ${vm_console_output} = OpenStack CLI With No Log openstack console log show ${vm}
321 ${vm_ip} = BuiltIn.Set Variable None
322 ${dhcp_ip} = BuiltIn.Set Variable None
323 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_OBTAINED}
324 ${vm_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 0
325 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_IPROUTE}
326 ${dhcp_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 1
327 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${vm_ip} None
328 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${dhcp_ip} None
329 [Return] ${vm_ip} ${dhcp_ip} ${vm_console_output}
331 Verify If Instance Is Arpingable From DHCP Namespace
332 [Arguments] ${net_name} ${mac} ${ip}
333 [Documentation] Get the Port IP and check the arp -a from DHCP NS to ensure that the VM's have been assigned IP's
334 OpenStackOperations.Get ControlNode Connection
335 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
336 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} arping ${ip} -c3 ${DEFAULT_LINUX_PROMPT_STRICT} timeout=60s
337 ${mac_uppercase} = String.Convert To Upper Case ${mac}
338 BuiltIn.Should Contain ${output} [${mac_uppercase}]
340 Check If Instance Is Ready For Ssh Login Using PublicKey
341 [Arguments] ${net_name} ${vm_ip} ${user}=centos ${idfile}=/tmp/odlkey ${console}=cirros
342 [Documentation] Ensure the VM is reachable from ssh as tests would require. This keyword will use publickey authentication
343 ${output} = Execute Command on VM Instance with PublicKey Auth ${net_name} ${vm_ip} ifconfig user=${user} idfile=${idfile}
344 ... console=${console}
345 BuiltIn.Should Contain ${output} ${vm_ip}
347 Check If Instance Is Ready For Ssh Login Using Password
348 [Arguments] ${net_name} ${vm_ip} ${user}=cirros ${console}=cirros
349 [Documentation] Ensure the VM is reachable from ssh as tests would require. This keyword will use password authentication
350 ${output} = Execute Command on VM Instance ${net_name} ${vm_ip} ifconfig console=${console}
351 BuiltIn.Should Contain ${output} ${vm_ip}
355 [Documentation] Get the instance IP addresses and nameserver address for the list of given vms.
356 ... First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
357 ... Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
358 ... of None) and [1] the dhcp ip address found in the last vm checked.
359 ... TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
360 ... may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
361 @{vm_ips} BuiltIn.Create List @{EMPTY}
362 : FOR ${vm} IN @{vms}
363 \ OpenStackOperations.Poll VM Is ACTIVE ${vm}
364 \ ${status} ${ips_and_console_log} BuiltIn.Run Keyword And Ignore Error BuiltIn.Wait Until Keyword Succeeds 180s 15s
365 \ ... OpenStackOperations.Get VM IP true ${vm}
366 \ # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
367 \ # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
368 \ # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
369 \ # the vm ip list if status is FAIL.
370 \ BuiltIn.Run Keyword If "${status}" == "PASS" BuiltIn.Log ${ips_and_console_log[2]}
371 \ BuiltIn.Run Keyword If "${status}" == "PASS" Collections.Append To List ${vm_ips} ${ips_and_console_log[0]}
372 \ BuiltIn.Run Keyword If "${status}" == "FAIL" Collections.Append To List ${vm_ips} None
373 \ ${vm_console_output} = BuiltIn.Run Keyword If "${status}" == "FAIL" OpenStack CLI openstack console log show ${vm}
374 \ BuiltIn.Run Keyword If "${status}" == "FAIL" BuiltIn.Log ${vm_console_output}
375 OpenStackOperations.Copy DHCP Files From Control Node
376 [Return] @{vm_ips} ${ips_and_console_log[1]}
378 Get Subnet Gateway Ip
379 [Arguments] ${subnet_name}
380 [Documentation] Show information of a subnet and grep for subnet gateway ip address
381 ${output} = OpenStackOperations.OpenStack CLI openstack subnet show ${subnet_name} | grep gateway_ip | awk '{print $4}'
382 ${splitted_output} = String.Split String ${output} ${EMPTY}
383 ${matches} = Collections.Get Matches ${splitted_output} regexp=(\\d\.)+
384 ${subnet_gateway_ip} = String.Strip String ${matches[0]} characters=','
385 [Return] ${subnet_gateway_ip}
387 Collect VM IPv6 SLAAC Addresses
388 [Arguments] ${fail_on_none} ${vm_list} ${network} ${subnet}
389 [Documentation] For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
390 ... Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
391 ... obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
392 ... Returns an empty list if no IPv6 addresses found or if SSH connection fails.
393 ... Otherwise, returns a list of IPv6 addresses.
394 ${ipv6_list} = BuiltIn.Create List @{EMPTY}
395 : FOR ${vm} IN @{vm_list}
396 \ ${output} = OpenStack CLI openstack server show ${vm} -f shell
397 \ ${pattern} = String.Replace String ${subnet} ::/64 (:[a-f0-9]{,4}){,4}
398 \ @{vm_ipv6} = String.Get Regexp Matches ${output} ${pattern}
399 \ ${vm_ip_length} = BuiltIn.Get Length ${vm_ipv6}[0]
400 \ ${ipv6_data_from_vm} = BuiltIn.Run Keyword If ${vm_ip_length}>0 OpenStackOperations.Execute Command on VM Instance ${network} ${vm_ipv6[0]}
402 \ @{ipv6} = String.Get Regexp Matches ${ipv6_data_from_vm} ${pattern}
403 \ ${ipv6_addr_list_length} BuiltIn.Get Length @{ipv6}
404 \ BuiltIn.Run Keyword If ${ipv6_addr_list_length}>0 Collections.Append To List ${ipv6_list} ${ipv6[0]}
405 \ ... ELSE Collections.Append To List ${ipv6_list} None
406 [Return] ${ipv6_list}
409 [Arguments] ${vm_instance_names}
410 [Documentation] View Console log of the created vm instances using nova show.
411 : FOR ${vm} IN @{vm_instance_names}
412 \ ${output} = OpenStack CLI openstack server show ${vm}
413 \ ${output} = OpenStack CLI openstack console log show ${vm}
415 Ping Vm From DHCP Namespace
416 [Arguments] ${net_name} ${vm_ip}
417 [Documentation] Reach all Vm Instance with the net id of the Netowrk.
418 OpenStackOperations.Get ControlNode Connection
419 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
420 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
421 BuiltIn.Should Contain ${output} 64 bytes
423 Ping From DHCP Should Not Succeed
424 [Arguments] ${net_name} ${vm_ip}
425 [Documentation] Should Not Reach Vm Instance with the net id of the Netowrk.
426 Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
427 OpenStackOperations.Get ControlNode Connection
428 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
429 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
430 BuiltIn.Should Not Contain ${output} 64 bytes
432 Ping Vm From Control Node
433 [Arguments] ${vm_floating_ip} ${additional_args}=${EMPTY}
434 [Documentation] Ping VM floating IP from control node
435 OpenStackOperations.Get ControlNode Connection
436 ${output} = DevstackUtils.Write Commands Until Prompt And Log ping ${additional_args} -c 3 ${vm_floating_ip} 20s
437 BuiltIn.Should Contain ${output} 64 bytes
440 [Documentation] Ping to the expected destination ip.
441 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
442 DevstackUtils.Write Commands Until Prompt exit
443 BuiltIn.Should Contain ${output} 200
446 [Documentation] Exit the vm instance.
447 ${output} = DevstackUtils.Write Commands Until Prompt And Log exit
449 Check If Console Is VmInstance
450 [Arguments] ${console}=cirros
451 [Documentation] Check if the session has been able to login to the VM instance
452 ${output} = Utils.Write Commands Until Expected Prompt id ${OS_SYSTEM_PROMPT}
453 BuiltIn.Should Contain ${output} ${console}
456 [Arguments] ${console}=cirros
457 [Documentation] Check if the session has been able to login to the VM instance and exit the instance
458 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
459 BuiltIn.Run Keyword If ${rcode} DevstackUtils.Write Commands Until Prompt exit
462 [Arguments] ${ip_address} ${ttl}=64 ${ping_tries}=3
463 [Documentation] Run Ping command on the IP available as argument
464 ${ethertype} = String.Get Regexp Matches ${ip_address} ${IP_REGEX}
465 ${ping} = BuiltIn.Set Variable If ${ethertype} ping ping6
466 ${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
467 ${output} = Utils.Write Commands Until Expected Regexp ${cmd} ping_rc=\\d+ 120
468 BuiltIn.Log output: ${output}
469 BuiltIn.Should Contain ${output} 64 bytes
472 [Arguments] ${ip_address} ${ttl}=64
473 [Documentation] Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
474 ${output} = Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
475 BuiltIn.Should Not Contain ${output} 64 bytes
477 Check Metadata Access
478 [Documentation] Try curl on the Metadataurl and check if it is okay
479 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
480 BuiltIn.Should Contain ${output} 200
482 Execute Command on VM Instance
483 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=cirros ${password}=cubswin:) ${cmd_timeout}=30s
484 ... ${console}=cirros
485 [Documentation] Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
486 OpenStackOperations.Get ControlNode Connection
487 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
488 ${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:
489 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
490 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
491 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT} timeout=${cmd_timeout}
492 [Teardown] Exit From Vm Console ${console}
495 Execute Command on VM Instance With PublicKey Auth
496 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=centos ${idfile}=/tmp/odlkey ${console}=cirros
497 [Documentation] Login to the vm instance using ssh publickey in the network, executes a command inside the VM and returns the ouput.
498 OpenStackOperations.Get ControlNode Connection
499 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
500 ${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
501 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
502 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT}
503 [Teardown] Exit From Vm Console ${console}
506 Copy File To VM Instance With PublicKey Auth
507 [Arguments] ${net_name} ${vm_ip} ${file_to_copy} ${user}=centos ${idfile}=/tmp/odlkey
508 [Documentation] Login to the vm instance using ssh publickey in the network, executes a command inside the VM and returns the ouput.
509 OpenStackOperations.Get ControlNode Connection
510 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
511 ${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
512 BuiltIn.Should Be True '${rc}' == '0'
514 Test Operations From Vm Instance
515 [Arguments] ${net_name} ${src_ip} ${dest_ips} ${user}=cirros ${password}=cubswin:) ${ttl}=64
516 ... ${ping_should_succeed}=True ${check_metadata}=True ${console}=cirros ${ping_tries}=3
517 [Documentation] Login to the vm instance using ssh in the network.
518 OpenStackOperations.Get ControlNode Connection
519 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
520 ${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
521 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
522 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
523 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ifconfig ${OS_SYSTEM_PROMPT}
524 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -n ${OS_SYSTEM_PROMPT}
525 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -A inet6 ${OS_SYSTEM_PROMPT}
526 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt arp -an ${OS_SYSTEM_PROMPT}
527 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ip -f inet6 neigh show ${OS_SYSTEM_PROMPT}
528 : FOR ${dest_ip} IN @{dest_ips}
529 \ ${string_empty} = BuiltIn.Run Keyword And Return Status Should Be Empty ${dest_ip}
530 \ BuiltIn.Run Keyword If ${string_empty} Continue For Loop
531 \ BuiltIn.Run Keyword If ${rcode} and "${ping_should_succeed}" == "True" OpenStackOperations.Check Ping ${dest_ip} ttl=${ttl} ping_tries=${ping_tries}
532 \ ... ELSE OpenStackOperations.Check No Ping ${dest_ip} ttl=${ttl}
533 ${ethertype} = String.Get Regexp Matches ${src_ip} ${IP_REGEX}
534 BuiltIn.Run Keyword If ${rcode} and "${check_metadata}" and ${ethertype} == "True" OpenStackOperations.Check Metadata Access
535 [Teardown] Exit From Vm Console ${console}
537 Test Netcat Operations From Vm Instance
538 [Arguments] ${net_name} ${vm_ip} ${dest_ip} ${additional_args}=${EMPTY} ${port}=12345 ${user}=cirros
539 ... ${password}=cubswin:)
540 [Documentation] Use Netcat to test TCP/UDP connections to the controller
541 ${client_data} BuiltIn.Set Variable Test Client Data
542 ${server_data} BuiltIn.Set Variable Test Server Data
543 OpenStackOperations.Get ControlNode Connection
544 ${output} = DevstackUtils.Write Commands Until Prompt And Log ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
545 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo netstat -nlap | grep ${port}
546 ${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}
547 BuiltIn.Log ${output}
548 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo route -n
549 BuiltIn.Log ${output}
550 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo arp -an
551 BuiltIn.Log ${output}
552 BuiltIn.Should Match Regexp ${nc_output} ${server_data}
555 [Arguments] ${list_of_external_dst_ips} ${console}=cirros
556 [Documentation] Check reachability with other network's instances.
557 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance ${console}
558 : FOR ${dest_ip} IN @{list_of_external_dst_ips}
559 \ OpenStackOperations.Check Ping ${dest_ip}
562 [Arguments] ${router_name}
563 [Documentation] Create Router and Add Interface to the subnets.
564 ${output} = OpenStack CLI openstack router create ${router_name}
567 [Documentation] List Routers and return output with neutron client.
568 ${output} = OpenStack CLI openstack router list -f value
572 [Arguments] ${router_name} ${interface_name}
573 ${output} = OpenStack CLI openstack router add subnet ${router_name} ${interface_name}
575 Show Router Interface
576 [Arguments] ${router_name}
577 [Documentation] List Routers interface associated with given Router and return output with neutron client.
578 ${output} = OpenStack CLI openstack port list --router ${router_name} -f value
582 [Arguments] ${router_name} ${external_network_name} ${additional_args}=${EMPTY}
583 ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name} ${additional_args}
586 [Arguments] ${router_name} ${interface_name}
587 [Documentation] Remove Interface to the subnets.
588 ${output} = OpenStack CLI openstack router remove subnet ${router_name} ${interface_name}
591 [Arguments] ${router_name}
592 [Documentation] Remove external gateway from the router.
593 ${output} = OpenStack CLI openstack router unset ${router_name} --external-gateway
596 [Arguments] ${router_name} ${cmd}
597 [Documentation] Update the router with the command. Router name and command should be passed as argument.
598 ${output} = OpenStack CLI openstack router set ${router_name} ${cmd}
601 [Arguments] ${router_name} ${additional_args}=${EMPTY}
602 [Documentation] Show information of a given router. Router name and optional fields should be sent as arguments.
603 ${output} = OpenStack CLI openstack router show ${router_name} ${additional_args}
607 [Arguments] ${router_name}
608 [Documentation] Delete Router and Interface to the subnets.
609 ${output} = OpenStack CLI openstack router delete ${router_name}
611 Get DumpFlows And Ovsconfig
612 [Arguments] ${conn_id}
613 [Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
614 SSHLibrary.Switch Connection ${conn_id}
615 Utils.Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
616 Utils.Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
617 Utils.Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
618 Utils.Write Commands Until Expected Prompt arp -an ${DEFAULT_LINUX_PROMPT_STRICT}
619 ${nslist} = Utils.Write Commands Until Expected Prompt ip netns list | awk '{print $1}' ${DEFAULT_LINUX_PROMPT_STRICT}
620 @{lines} Split To Lines ${nslist} end=-1
621 : FOR ${line} IN @{lines}
622 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
623 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
624 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
625 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
626 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
627 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
628 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
629 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
630 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
632 Get ControlNode Connection
633 SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
634 [Return] ${OS_CNTL_CONN_ID}
637 [Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
638 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
639 \ OpenStackOperations.Get DumpFlows And Ovsconfig ${conn_id}
641 Get Test Teardown Debugs
642 [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME} ${fail}=${FAIL_ON_EXCEPTIONS}
643 ODLTools.Get All node_ip=${HA_PROXY_IP} test_name=${test_name}
644 OpenStackOperations.Get OvsDebugInfo
645 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_data_models}
646 KarafKeywords.Fail If Exceptions Found During Test ${test_name} fail=${fail}
647 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
648 \ BuiltIn.Run Keyword And Ignore Error Issue_Command_On_Karaf_Console trace:transactions ${ODL_SYSTEM_${i+1}_IP}
651 Get Test Teardown Debugs test_name=${SUITE_NAME} fail=False
653 Get Test Teardown Debugs For SFC
654 [Arguments] ${test_name}=${TEST_NAME}
655 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_sfc_data_models}
658 [Arguments] @{vm_indices}
659 [Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
660 OpenStackOperations.Get ControlNode Connection
661 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns list
662 : FOR ${index} IN @{vm_indices}
663 \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
664 \ BuiltIn.Log ${output}
665 OpenStackOperations.List Nova VMs
666 OpenStackOperations.List Routers
667 OpenStackOperations.List Networks
668 OpenStackOperations.List Subnets
669 OpenStackOperations.List Ports
670 OpenStackOperations.List Security Groups
673 [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
674 ... credentials are already sourced
675 ${output} = OpenStack CLI openstack security group list
678 Neutron Security Group Show
679 [Arguments] ${SecurityGroupRuleName}
680 [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
681 ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
685 [Arguments] ${PortName}
686 [Documentation] Display the port configuration that belong to a given neutron port
687 ${output} = OpenStack CLI openstack port show ${PortName}
690 Neutron Security Group Create
691 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
692 [Documentation] Create a security group with specified name ,description & protocol value according to security group template
693 OpenStackOperations.Get ControlNode Connection
694 ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
695 ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
696 [Return] ${output} ${sgp_id}
698 Neutron Security Group Update
699 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
700 [Documentation] Updating security groups
701 ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
705 [Arguments] ${sg_name}
706 [Documentation] Delete Security group
707 ${output} = OpenStack CLI openstack security group delete ${sg_name}
709 Neutron Security Group Rule Create
710 [Arguments] ${Security_group_name} &{Kwargs}
711 [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]} ..."
712 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
713 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
714 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
715 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
716 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
717 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
718 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
719 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
720 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
721 ${cmd} = BuiltIn.Set Variable openstack security group rule create ${Security_group_name}
722 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
723 ... ELSE BuiltIn.Catenate ${cmd}
724 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --${direction}
725 ... ELSE BuiltIn.Catenate ${cmd}
726 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
727 ... ELSE BuiltIn.Catenate ${cmd}
728 ${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}
729 ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
730 ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}
731 ... ELSE BuiltIn.Catenate ${cmd}
732 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
733 ... ELSE BuiltIn.Catenate ${cmd}
734 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote-group ${remote_group_id}
735 ... ELSE BuiltIn.Catenate ${cmd}
736 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --src-ip ${remote_ip_prefix}
737 ... ELSE BuiltIn.Catenate ${cmd}
738 ${output} = OpenStack CLI ${cmd}
739 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
740 [Return] ${output} ${rule_id}
742 Security Group Create Without Default Security Rules
743 [Arguments] ${sg_name} ${additional_args}=${EMPTY}
744 [Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
745 OpenStackOperations.Neutron Security Group Create ${sg_name} ${additional_args}
746 Delete All Security Group Rules ${sg_name}
748 Delete All Security Group Rules
749 [Arguments] ${sg_name}
750 [Documentation] Delete all security rules from a specified security group
751 ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
752 @{sg_rules} = String.Split String ${sg_rules_output} \n
753 : FOR ${rule} IN @{sg_rules}
754 \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
756 Create Allow All SecurityGroup
757 [Arguments] ${sg_name} ${ether_type}=IPv4 ${dual}=False
758 [Documentation] Allow all TCP/UDP/ICMP packets for this suite
759 OpenStackOperations.Neutron Security Group Create ${sg_name}
760 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
761 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
762 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
763 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
764 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
765 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
766 BuiltIn.Run Keyword If "${dual}"=="True" Run Keywords OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6
767 ... port_range_max=65535 port_range_min=1 protocol=tcp
768 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 port_range_max=65535
769 ... port_range_min=1 protocol=tcp
770 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6 protocol=icmp
771 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 protocol=icmp
772 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6 port_range_max=65535
773 ... port_range_min=1 protocol=udp
774 ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 port_range_max=65535
775 ... port_range_min=1 protocol=udp
777 Create Neutron Port With Additional Params
778 [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
779 [Documentation] Create Port With given additional parameters
780 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
781 BuiltIn.Log ${output}
782 BuiltIn.Should Be True '${rc}' == '0'
783 ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
784 [Return] ${OUTPUT} ${port_id}
788 [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
789 ${macs} BuiltIn.Create List
790 : FOR ${port} IN @{ports}
791 \ ${mac} = OpenStackOperations.Get Port Mac ${port}
792 \ Collections.Append To List ${macs} ${mac}
796 [Arguments] ${port_name}
797 [Documentation] Keyword would return the IP of the ${port_name} received.
798 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
799 ${splitted_output} = String.Split String ${output} ${EMPTY}
800 ${port_ip} = Collections.Get from List ${splitted_output} 0
804 [Arguments] ${port_name}
805 [Documentation] Keyword would return the MAC ID of the ${port_name} received.
806 ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
807 ${splitted_output} = String.Split String ${output} ${EMPTY}
808 ${port_mac} = Collections.Get from List ${splitted_output} 0
811 Get Port Mac Address From Ip
813 [Documentation] Retrieve the mac address for a port that matches any given ip.
814 ${output} = OpenStack CLI openstack port list | grep -w ${ip} | awk '{print $5}'
815 ${splitted_output} = String.Split String ${output} ${EMPTY}
816 ${mac_addr} = Collections.Get from List ${splitted_output} 0
820 [Arguments] ${bridge_name} ${intf_name} ${gw_name}
821 [Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
822 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
823 BuiltIn.Log ${l2gw_output}
824 [Return] ${l2gw_output}
827 [Arguments] ${bridge_name} ${gw_name} ${intf_name_1} ${intf_name_2}
828 [Documentation] Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
829 ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
831 [Return] ${l2gw_output}
833 Create L2Gateway Connection
834 [Arguments] ${gw_name} ${net_name}
835 [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
836 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
837 BuiltIn.Log ${l2gw_output}
838 BuiltIn.Should Be True '${rc}' == '0'
839 [Return] ${l2gw_output}
842 [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
843 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
844 BuiltIn.Should Be True '${rc}' == '0'
847 Get All L2Gateway Connection
848 [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
849 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
850 BuiltIn.Should Be True '${rc}' == '0'
855 [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
856 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
857 BuiltIn.Log ${output}
858 BuiltIn.Should Be True '${rc}' == '0'
862 [Arguments] ${l2gw_name}
863 [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
864 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
865 BuiltIn.Log ${output}
866 BuiltIn.Should Be True '${rc}' == '0'
867 ${splitted_output} = String.Split String ${output} ${EMPTY}
868 ${l2gw_id} = Collections.Get from List ${splitted_output} 0
871 Get L2gw Connection Id
872 [Arguments] ${l2gw_name}
873 [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
874 ${l2gw_id} = OpenStackOperations.Get L2gw Id ${l2gw_name}
875 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
876 BuiltIn.Should Be True '${rc}' == '0'
877 ${splitted_output} = String.Split String ${output} ${EMPTY}
878 ${splitted_output} = String.Split String ${output} ${EMPTY}
879 ${l2gw_conn_id} = Collections.Get from List ${splitted_output} 0
880 [Return] ${l2gw_conn_id}
882 Neutron Port List Rest
883 [Documentation] Keyword to get all ports details in Neutron (Using REST).
884 ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
885 BuiltIn.Log ${resp.content}
886 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
887 [Return] ${resp.content}
889 Get Neutron Port Rest
890 [Arguments] ${port_id}
891 [Documentation] Keyword to get the specific port details in Neutron (Using REST).
892 ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
893 BuiltIn.Log ${resp.content}
894 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
895 [Return] ${resp.content}
898 [Arguments] ${port_id} ${json_data}
899 [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
900 BuiltIn.Log ${json_data}
901 ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
902 BuiltIn.Log ${resp.content}
903 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
904 [Return] ${resp.content}
906 Get Neutron Network Rest
907 [Arguments] ${net_id}
908 [Documentation] Keyword to get the specific network details in Neutron (Using REST).
909 ${resp} = RequestsLibrary.Get Request session ${NETWORK_URL}/network/${net_id}
910 BuiltIn.Log ${resp.content}
911 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
912 [Return] ${resp.content}
914 Create And Configure Security Group
915 [Arguments] ${sg-name}
916 [Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
917 OpenStackOperations.Neutron Security Group Create ${sg-name}
918 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
919 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
920 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
921 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
922 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
923 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
925 Add Security Group To VM
926 [Arguments] ${vm} ${sg}
927 [Documentation] Add the security group provided to the given VM.
928 ${output} = OpenStack CLI openstack server add security group ${vm} ${sg}
930 Remove Security Group From VM
931 [Arguments] ${vm} ${sg}
932 [Documentation] Remove the security group provided to the given VM.
933 OpenStackOperations.Get ControlNode Connection
934 ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
936 Create SFC Flow Classifier
937 [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${neutron_src_port} ${args}=${EMPTY}
938 [Documentation] Create a flow classifier for SFC
939 ${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}
940 BuiltIn.Should Contain ${output} ${name}
943 Delete SFC Flow Classifier
945 [Documentation] Delete a SFC flow classifier
946 ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
950 [Arguments] ${name} ${port_in} ${port_out}
951 [Documentation] Creates a neutron port pair for SFC
952 ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
953 BuiltIn.Should Contain ${output} ${name}
958 [Documentation] Delete a SFC port pair
959 ${output} = OpenStack CLI openstack sfc port pair delete ${name}
962 Create SFC Port Pair Group
963 [Arguments] ${name} ${port_pair}
964 [Documentation] Creates a port pair group with a single port pair for SFC
965 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
966 BuiltIn.Should Contain ${output} ${name}
969 Create SFC Port Pair Group With Two Pairs
970 [Arguments] ${name} ${port_pair1} ${port_pair2}
971 [Documentation] Creates a port pair group with two port pairs for SFC
972 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
973 BuiltIn.Should Contain ${output} ${name}
976 Delete SFC Port Pair Group
978 [Documentation] Delete a SFC port pair group
979 OpenStackOperations.Get ControlNode Connection
980 ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
983 Create SFC Port Chain
984 [Arguments] ${name} ${args}=${EMPTY}
985 [Documentation] Creates a port pair chain with two port groups and a singel classifier.
986 ${output} = OpenStack CLI openstack sfc port chain create ${name} ${args}
987 BuiltIn.Should Contain ${output} ${name}
990 Update SFC Port Chain With A New Flow Classifier
991 [Arguments] ${name} ${fc}
992 [Documentation] Adds a Flow Classifier to a Port Chain
993 ${output} = OpenStack CLI openstack sfc port chain set ${name} --flow-classifier ${fc}
996 Update SFC Port Chain Removing A Flow Classifier
997 [Arguments] ${name} ${fc}
998 [Documentation] Adds a Flow Classifier to a Port Chain
999 ${output} = OpenStack CLI openstack sfc port chain unset ${name} --flow-classifier ${fc}
1002 Delete SFC Port Chain
1004 [Documentation] Delete a SFC port chain
1005 ${output} = OpenStack CLI openstack sfc port chain delete ${name}
1009 [Arguments] ${vm_name}
1010 [Documentation] Reboot NOVA VM
1011 ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
1012 BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
1014 Remove RSA Key From KnownHosts
1015 [Arguments] ${vm_ip}
1016 [Documentation] Remove RSA
1017 OpenStackOperations.Get ControlNode Connection
1018 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
1019 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
1020 ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
1022 Wait For Routes To Propogate
1023 [Arguments] ${networks} ${subnets}
1024 [Documentation] Check propagated routes
1025 OpenStackOperations.Get ControlNode Connection
1026 : FOR ${INDEX} IN RANGE 0 1
1027 \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
1028 \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
1029 \ ${length} = BuiltIn.Get Length ${is_ipv6}
1030 \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
1031 \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ${DEFAULT_LINUX_PROMPT_STRICT}
1032 \ BuiltIn.Should Contain ${output} @{subnets}[${INDEX}]
1035 [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
1036 : FOR ${vm} IN @{vms}
1037 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
1038 : FOR ${port} IN @{ports}
1039 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
1040 : FOR ${subnet} IN @{subnets}
1041 \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
1042 : FOR ${network} IN @{networks}
1043 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
1044 : FOR ${sg} IN @{sgs}
1045 \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
1048 [Documentation] Get a list of different OpenStack resources that might be in use.
1049 @{modules} = BuiltIn.Create List server port network subnet security group
1050 ... security group rule floating ip router
1051 : FOR ${module} IN @{modules}
1052 \ ${output} = OpenStack CLI openstack ${module} list
1054 OpenStack CLI Get List
1056 [Documentation] Return a json list from the output of an OpenStack command.
1057 @{list} = BuiltIn.Create List
1058 ${json} = OpenStack CLI ${cmd}
1059 @{list} = RequestsLibrary.To Json ${json}
1065 [Documentation] Run the given OpenStack ${cmd} and log the output.
1066 ${result} = Process.Run Process ${cmd} shell=True
1067 BuiltIn.Log ${result.stdout}
1068 BuiltIn.Log ${result.stderr}
1069 BuiltIn.Should Be True '${result.rc}' == '0'
1070 [Return] ${result.stdout}
1072 OpenStack CLI With No Log
1074 [Documentation] Run the given OpenStack ${cmd} and do not log the output.
1075 ${result} = Process.Run Process ${cmd} shell=True
1076 BuiltIn.Should Be True '${result.rc}' == '0'
1077 [Return] ${result.stdout}
1079 OpenStack Cleanup All
1080 [Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
1081 ... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
1082 @{fips} = OpenStack CLI Get List openstack floating ip list -f json
1083 : FOR ${fip} IN @{fips}
1084 \ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
1085 @{vms} = OpenStack CLI Get List openstack server list -f json
1086 : FOR ${vm} IN @{vms}
1087 \ OpenStack CLI openstack server show ${vm['ID']}
1088 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
1089 @{routers} = OpenStack CLI Get List openstack router list -f json
1090 : FOR ${router} IN @{routers}
1091 \ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
1092 @{ports} = OpenStack CLI Get List openstack port list -f json
1093 : FOR ${port} IN @{ports}
1094 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
1095 @{networks} = OpenStack CLI Get List openstack network list -f json
1096 : FOR ${network} IN @{networks}
1097 \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
1098 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
1099 @{security_groups} = OpenStack CLI Get List openstack security group list -f json
1100 : FOR ${security_group} IN @{security_groups}
1101 \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
1106 [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
1107 @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
1108 : FOR ${port} IN @{ports}
1109 \ ${subnet_id} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 0
1110 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
1111 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
1112 BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
1114 OpenStack Suite Setup
1115 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1116 SetupUtils.Setup_Utils_For_Setup_And_Teardown
1117 @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil org.apache.sshd.server.session.ServerSessionImpl
1118 Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All OFF ${loggers}
1119 DevstackUtils.Devstack Suite Setup
1120 @{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
1121 BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
1122 BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
1123 OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1126 OpenStack Suite Teardown
1127 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1128 ... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1129 ... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1130 ... benefit automatically.
1131 # TODO: followup patch will add the list of vms to pass to Show Debugs
1132 # OpenStackOperations.Show Debugs @{NET_1_VMS} @{NET_2_VMS}
1133 OpenStackOperations.Get Suite Debugs
1134 OpenStack Cleanup All
1135 OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
1136 SSHLibrary.Close All Connections
1137 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
1138 \ KarafKeywords.Issue Command On Karaf Console threads --list | wc -l ${ODL_SYSTEM_${i+1}_IP}
1141 [Documentation] Validate the deployment. Examples to validate are verifying default table
1142 ... flows are installed and that the tunnel mesh has been built correctly.
1143 Write To Validate File ----------------------------------------\n${SUITE_NAME}\n
1144 : FOR ${keyword} IN @{VALIDATION_KEYWORDS}
1145 \ ${status} = Builtin.Run Keyword And Return Status ${keyword}
1146 \ BuiltIn.Run Keyword If "${status}" == "FAIL" or "${status}" == "False" BuiltIn.Run Keywords Write To Validate File Failed: ${keyword}
1147 \ ... AND BuiltIn.Fail
1148 \ ... ELSE Write To Validate File Passed: ${keyword}
1150 Write To Validate File
1152 [Documentation] Write the given ${msg} to ${VALIDATION_FILE}. Create the file if not present.
1153 ${status} = BuiltIn.Run Keyword And Return Status OperatingSystem.File Should Exist ${VALIDATION_FILE}
1154 BuiltIn.Run Keyword If "${status}" == "False" OperatingSystem.Create File ${VALIDATION_FILE}
1155 OperatingSystem.Append To File ${VALIDATION_FILE} ${msg}\n
1157 Copy DHCP Files From Control Node
1158 [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
1159 ... after the subnet(s) are created and before the subnet(s) are deleted.
1160 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1161 ${dstdir} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
1162 OperatingSystem.Create Directory ${dstdir}
1163 OpenStackOperations.Get ControlNode Connection
1164 BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
1166 Is Feature Installed
1167 [Arguments] ${features}=none
1168 : FOR ${feature} IN @{features}
1169 \ ${status} ${output} BuiltIn.Run Keyword And Ignore Error BuiltIn.Should Contain ${CONTROLLERFEATURES} ${feature}
1170 \ Return From Keyword If "${status}" == "PASS" True
1173 Add OVS Logging On All OpenStack Nodes
1174 [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
1175 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1176 \ OVSDB.Add OVS Logging ${conn_id}
1178 Reset OVS Logging On All OpenStack Nodes
1179 [Documentation] Reset the OVS logging to all the OpenStack nodes
1180 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1181 \ OVSDB.Reset OVS Logging ${conn_id}
1183 Start Packet Capture On Nodes
1184 [Arguments] ${tag} ${filter} @{ips}
1185 [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1186 ... The caller must pass the three arguments with a variable number of ips at the end,
1187 ... but ${EMPTY} can be used for the tag and filter.
1188 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1189 ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
1190 @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
1191 [Return] @{conn_ids}
1193 Stop Packet Capture On Nodes
1194 [Arguments] ${conn_ids}=@{EMPTY}
1195 Tcpdump.Stop Packet Capture on Nodes ${conn_ids}
1198 [Arguments] ${vm_instance_name}
1199 [Documentation] Keyword for live migration of VM instance
1200 ... additional_agrs is to select particular migration(live/shared-migration/block-migration)
1201 ... if the additional_agrs is not given default migration(shared-migration) will happen
1202 ${output} = OpenStackOperations.OpenStack CLI nova live-migration ${vm_instance_name}
1204 Get Hypervisor Host Of Vm
1205 [Arguments] ${vm_name}
1206 [Documentation] Show server with neutron request.
1207 ${output} = OpenStackOperations.OpenStack CLI openstack server show -f value -c OS-EXT-SRV-ATTR:host ${vm_name}
1210 Check If Migration Is Complete
1211 [Arguments] ${vm_name}
1212 [Documentation] Show server and verify if task_state is not migrating
1213 ${output} = OpenStackOperations.OpenStack CLI openstack server show ${vm_name} | grep "OS-EXT-STS:task_state"
1214 BuiltIn.Should Not Contain ${output} migrating
1216 Modify OpenStack Configuration File
1217 [Arguments] ${conn_id} ${file_name} ${section} ${key} ${value}
1218 [Documentation] Use crudini to modify any parameter in any Openstack configuration File
1219 SSHLibrary.Switch Connection ${conn_id}
1220 ${output} ${rc} = SSHLibrary.Execute Command sudo crudini --verbose --set --inplace ${file_name} ${section} ${key} ${value} return_rc=True return_stdout=True
1221 BuiltIn.Log ${output}
1222 BuiltIn.Should Be True '${rc}' == '0'
1224 Restart DevStack Service
1225 [Arguments] ${conn_id} ${service_name}
1226 [Documentation] Restart the Openstack Service
1227 SSHLibrary.Switch Connection ${conn_id}
1228 ${output} ${rc} = SSHLibrary.Execute Command sudo systemctl restart devstack@${service_name}.service return_rc=True return_stdout=True
1229 BuiltIn.Log ${output}
1230 BuiltIn.Should Be True '${rc}' == '0'
1232 Get Network Segmentation Id
1233 [Arguments] ${network_name}
1234 [Documentation] Returns network segmentation id for the given network name.
1235 ${output} = OpenStack CLI openstack network show ${network_name} | grep segmentation_id | awk '{print $4}'
1236 @{list} = String.Split String ${output}
1240 [Documentation] Verify if the services are operational
1241 Wait Until Keyword Succeeds 60 2 ClusterManagement.Check Status Of Services Is OPERATIONAL @{NETVIRT_DIAG_SERVICES}
1243 Verify Expected Default Tunnels
1244 [Documentation] Verify if the default tunnels are created.
1245 ... SFC jobs currently fail this validation because it uses of-tunnels.
1246 ... This validation will be blocked for NEtvirt SFC jobs until support for of-tunnels
1247 ... added to odltools.
1248 ${check_feature_list} = BuiltIn.Create List odl-netvirt-sfc
1249 ${is_sfc_enabled} = OpenStackOperations.Is Feature Installed features=${check_feature_list}
1250 BuiltIn.Return From Keyword If ${is_sfc_enabled} == ${True} ${True}
1251 BuiltIn.Return From Keyword If ${OS_NODE_CNT} == ${1} ${True}
1252 ${output} = ODLTools.Analyze Tunnels test_name=${SUITE_NAME}.Suite Setup
1253 BuiltIn.Should Contain ${output} All tunnels are up
1255 Verify Expected Default Tables On Nodes
1256 [Arguments] ${node_ips}=@{OS_ALL_IPS}
1257 [Documentation] Verify if Default Table Entries are programmed on all Nodes
1258 ${resp} = RequestsLibrary.Get Request session ${CONFIG_NODES_API}
1259 Utils.Log Content ${resp.content}
1260 ${failed_node_list} = BuiltIn.Create List
1261 : FOR ${node_ip} IN @{node_ips}
1262 \ ${failed_table_list} = Verify Expected Default Tables ${node_ip}
1263 \ ${failed_table_list_size} = BuiltIn.Get Length ${failed_table_list}
1264 \ BuiltIn.Run Keyword If ${failed_table_list_size} > 0 Collections.Append To List ${failed_node_list} ${node_ip}
1265 Builtin.Should Be Empty ${failed_node_list}
1267 Verify Expected Default Tables
1268 [Arguments] ${ovs_ip}
1269 [Documentation] Verify if Default Table Entries are programmed on specific Node
1270 ${flow_dump} = Utils.Run Command On Remote System ${ovs_ip} sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13
1271 BuiltIn.Log ${flow_dump}
1272 ${failed_table_list} = BuiltIn.Create List
1273 : FOR ${table} IN @{DEFAULT_FLOW_TABLES}
1274 \ ${rc} = Builtin.Run Keyword And Return Status Builtin.Should Not Match Regexp ${flow_dump} .*table=${table}.*priority=0
1275 \ BuiltIn.Run Keyword If ${rc} Collections.Append To List ${failed_table_list} ${table}
1276 [Return] ${failed_table_list}
1279 [Arguments] ${project_name}
1280 [Documentation] Returns project ID for the given project name.
1281 ${project_id} = OpenStack CLI openstack project show ${project_name} -f value -c id
1282 [Return] ${project_id}
1284 Set Instance Quota For Project
1285 [Arguments] ${num_instances} ${project_id}
1286 [Documentation] Set quota for the created instances using the specific project id.
1287 ${output} = OpenStack CLI openstack quota set --instances ${num_instances} ${project_id}