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 Get Tenant ID From Security Group
25 [Documentation] Returns tenant ID by reading it from existing default security-group.
26 ${output} = OpenStack CLI openstack security group show default | grep "| tenant_id" | awk '{print $4}'
29 Get Tenant ID From Network
30 [Arguments] ${network_uuid}
31 [Documentation] Returns tenant ID by reading it from existing network.
32 ${resp} = TemplatedRequests.Get_From_Uri uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/ accept=${ACCEPT_EMPTY} session=session
33 ${tenant_id} = Utils.Extract Value From Content ${resp} /network/0/tenant-id strip
37 [Arguments] ${network_name} ${additional_args}=${EMPTY} ${verbose}=TRUE
38 [Documentation] Create Network with openstack request.
39 ${output} = OpenStack CLI openstack network create ${network_name} ${additional_args}
43 [Arguments] ${network_name} ${additional_args}=${EMPTY}
44 [Documentation] Update Network with neutron request.
45 ${output} = OpenStack CLI openstack network set ${network_name} ${additional_args}
49 [Arguments] ${network_name}
50 [Documentation] Show Network with neutron request.
51 ${output} = OpenStack CLI openstack network show ${network_name}
55 [Documentation] List networks and return output with neutron client.
56 ${output} = OpenStack CLI openstack network list
60 [Documentation] List subnets and return output with neutron client.
61 ${output} = OpenStack CLI openstack subnet list
65 [Arguments] ${network_name}
66 [Documentation] Delete Network with neutron request.
67 ${output} = OpenStack CLI openstack network delete ${network_name}
70 [Arguments] ${network_name} ${subnet_name} ${range_ip} ${additional_args}=${EMPTY}
71 [Documentation] Create SubNet for the Network with neutron request.
72 ${output} = OpenStack CLI openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet_name} ${additional_args}
75 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
76 [Documentation] Update subnet with openstack subnet set request.
77 ${output} = OpenStack CLI openstack subnet set ${subnet_name} ${additional_args}
81 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
82 [Documentation] Update subnet with openstack subnet unset request
83 ${output} = OpenStack CLI openstack subnet unset ${subnet_name} ${additional_args}
87 [Arguments] ${subnet_name}
88 [Documentation] Show subnet with neutron request.
89 ${output} = OpenStack CLI openstack subnet show ${subnet_name}
93 [Arguments] ${network_name} ${port_name} ${sg}=default ${additional_args}=${EMPTY} ${allowed_address_pairs}=${EMPTY}
94 [Documentation] Create Port with neutron request.
95 # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
96 # in a different format with the neutron vs openstack cli.
97 ${address_pair_length} = BuiltIn.Get Length ${allowed_address_pairs}
98 ${allowed_pairs_argv} = BuiltIn.Set Variable ${EMPTY}
99 ${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}
100 ${output} = OpenStack CLI openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
103 [Arguments] ${port_name} ${additional_args}=${EMPTY}
104 [Documentation] Update port with neutron request.
105 ${output} = OpenStack CLI openstack port set ${port_name} ${additional_args}
109 [Arguments] ${port_name}
110 [Documentation] Show port with neutron request.
111 ${output} = OpenStack CLI openstack port show ${port_name}
115 [Arguments] ${port_name}
116 [Documentation] Delete Port with neutron request.
117 ${output} = OpenStack CLI openstack port delete ${port_name}
120 [Documentation] List ports and return output with neutron client.
121 ${output} = OpenStack CLI openstack port list
125 [Documentation] List VMs and return output with nova client.
126 ${output} = OpenStack CLI openstack server list --all-projects
129 Create And Associate Floating IPs
130 [Arguments] ${external_net} @{vm_list}
131 [Documentation] Create and associate floating IPs to VMs with nova request
132 ${ip_list} = BuiltIn.Create List @{EMPTY}
133 : FOR ${vm} IN @{vm_list}
134 \ ${output} = OpenStack CLI openstack floating ip create ${external_net}
135 \ @{ip} = String.Get Regexp Matches ${output} [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
136 \ ${ip_length} = BuiltIn.Get Length ${ip}
137 \ BuiltIn.Run Keyword If ${ip_length}>0 Collections.Append To List ${ip_list} @{ip}[0]
138 \ ... ELSE Collections.Append To List ${ip_list} None
139 \ ${output} = OpenStack CLI openstack server add floating ip ${vm} @{ip}[0]
142 Remove Floating Ip From Vm
143 [Arguments] ${vm_name} ${fip}
144 [Documentation] Remove the Floating IP From VM Instance
145 ${output} = OpenStack CLI openstack server remove floating ip ${vm_name} ${fip}
149 [Documentation] Delete floating ip with neutron request.
150 ${output} = OpenStack CLI openstack floating ip delete ${fip}
153 [Arguments] ${subnet}
154 [Documentation] Delete SubNet for the Network with neutron request.
155 ${output} = OpenStack CLI openstack subnet delete ${subnet}
158 [Arguments] ${vm_name}
159 [Documentation] Delete Vm instances using instance names.
160 ${output} = OpenStack CLI openstack server delete ${vm_name}
163 [Arguments] ${network_name}
164 [Documentation] Retrieve the net id for the given network name to create specific vm instance
165 ${output} = OpenStack CLI openstack network list | grep "${network_name}" | awk '{print $2}'
166 ${splitted_output} = String.Split String ${output} ${EMPTY}
167 ${net_id} = Collections.Get from List ${splitted_output} 0
171 [Arguments] ${subnet_name}
172 [Documentation] Retrieve the subnet id for the given subnet name
173 ${output} = OpenStack CLI openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
174 ${splitted_output} = String.Split String ${output} ${EMPTY}
175 ${subnet_id} = Collections.Get from List ${splitted_output} 0
176 [Return] ${subnet_id}
179 [Arguments] ${port_name}
180 [Documentation] Retrieve the port id for the given port name to attach specific vm instance to a particular port
181 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk '{print $2}'
182 ${splitted_output} = String.Split String ${output} ${EMPTY}
183 ${port_id} = Collections.Get from List ${splitted_output} 0
187 [Arguments] ${portname}
188 [Documentation] Retrieve the first 10 chars of the UUID for the given port name
189 ${port_id} = OpenStackOperations.Get Port Id ${portname}
190 ${output} = String.Get Regexp Matches ${port_id} \\w{8}-\\w{2}
191 ${subport_id} = Collections.Get from List ${output} 0
192 [Return] ${subport_id}
195 [Arguments] ${router1}
196 [Documentation] Retrieve the router id for the given router name
197 ${output} = OpenStack CLI openstack router show "${router1}" |awk '/ id / {print $4}'
198 ${splitted_output} = String.Split String ${output} ${EMPTY}
199 ${router_id} = Collections.Get from List ${splitted_output} 0
200 [Return] ${router_id}
203 [Arguments] ${net_name} ${vm_instance_names} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default ${min}=1
205 [Documentation] Create X Vm Instance with the net id of the Netowrk.
206 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
207 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
208 : FOR ${vm} IN @{vm_instance_names}
209 \ ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
211 Create Vm Instance On Compute Node
212 [Arguments] ${net_name} ${vm_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
213 [Documentation] Create a VM instance on a specific compute node.
214 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
215 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
216 ${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}
218 Create Vm Instance With Port
219 [Arguments] ${port_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
220 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
221 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
222 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
223 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-group ${sg}
225 Create Vm Instance With Ports
226 [Arguments] ${port_name} ${port2_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
227 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
228 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
229 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
230 ${port2_id} = OpenStackOperations.Get Port Id ${port2_name}
231 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --nic port-id=${port2_id} ${vm_instance_name} --security-group ${sg}
233 Create Vm Instance With Port On Compute Node
234 [Arguments] ${port_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
235 [Documentation] Create One VM instance using given ${port_name} and for given ${node_hostname}
236 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
237 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
238 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
240 Create Vm Instance With Ports On Compute Node
241 [Arguments] ${port1_name} ${port2_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano
243 [Documentation] Create One VM instance using given ${port1_name}, ${port2_name} and for given ${node_hostname}
244 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
245 ${port1_id} = OpenStackOperations.Get Port Id ${port1_name}
246 ${port2_id} = OpenStackOperations.Get Port Id ${port2_name}
247 ${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}
249 Get Hypervisor Hostname From IP
250 [Arguments] ${hypervisor_ip}
251 [Documentation] Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
252 ... the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
253 ${output} = OpenStack CLI openstack hypervisor list
254 ${hostname} = OpenStack CLI openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
258 [Documentation] Create a nano flavor
259 ${output} = OpenStack CLI openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
262 [Arguments] ${vm_name}
263 [Documentation] Run these commands to check whether the created vm instance is active or not.
264 ${output} = OpenStack CLI openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
265 BuiltIn.Should Contain ${output} active
268 [Arguments] ${vm_name} ${retry}=600s ${retry_interval}=30s
269 [Documentation] Run these commands to check whether the created vm instance is active or not.
270 BuiltIn.Wait Until Keyword Succeeds ${retry} ${retry_interval} OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
273 [Arguments] ${text} ${regexp} ${index}=0
274 [Documentation] Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
275 @{matches} = String.Get Regexp Matches ${text} ${regexp}
276 ${matches_length} = BuiltIn.Get Length ${matches}
277 BuiltIn.Set Suite Variable ${OS_MATCH} None
278 BuiltIn.Run Keyword If ${matches_length} > ${index} BuiltIn.Set Suite Variable ${OS_MATCH} @{matches}[${index}]
282 [Arguments] ${fail_on_none} ${vm}
283 [Documentation] Get the vm ip address and nameserver by scraping the vm's console log.
284 ... Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
285 ${vm_console_output} = OpenStack CLI With No Log openstack console log show ${vm}
286 ${vm_ip} = BuiltIn.Set Variable None
287 ${dhcp_ip} = BuiltIn.Set Variable None
288 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_OBTAINED}
289 ${vm_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 0
290 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_IPROUTE}
291 ${dhcp_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 1
292 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${vm_ip} None
293 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${dhcp_ip} None
294 [Return] ${vm_ip} ${dhcp_ip} ${vm_console_output}
298 [Documentation] Get the instance IP addresses and nameserver address for the list of given vms.
299 ... First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
300 ... Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
301 ... of None) and [1] the dhcp ip address found in the last vm checked.
302 ... TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
303 ... may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
304 @{vm_ips} BuiltIn.Create List @{EMPTY}
305 : FOR ${vm} IN @{vms}
306 \ OpenStackOperations.Poll VM Is ACTIVE ${vm}
307 \ ${status} ${ips_and_console_log} BuiltIn.Run Keyword And Ignore Error BuiltIn.Wait Until Keyword Succeeds 180s 15s
308 \ ... OpenStackOperations.Get VM IP true ${vm}
309 \ # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
310 \ # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
311 \ # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
312 \ # the vm ip list if status is FAIL.
313 \ BuiltIn.Run Keyword If "${status}" == "PASS" BuiltIn.Log ${ips_and_console_log[2]}
314 \ BuiltIn.Run Keyword If "${status}" == "PASS" Collections.Append To List ${vm_ips} ${ips_and_console_log[0]}
315 \ BuiltIn.Run Keyword If "${status}" == "FAIL" Collections.Append To List ${vm_ips} None
316 \ ${vm_console_output} = BuiltIn.Run Keyword If "${status}" == "FAIL" OpenStack CLI openstack console log show ${vm}
317 \ BuiltIn.Run Keyword If "${status}" == "FAIL" BuiltIn.Log ${vm_console_output}
318 OpenStackOperations.Copy DHCP Files From Control Node
319 [Return] @{vm_ips} ${ips_and_console_log[1]}
321 Get Two Port VM IP Addresses
322 [Arguments] ${conn_id} ${vm_name}
323 [Documentation] Show information of a given two port VM and grep for two ip address. VM name should be sent as arguments.
324 SSHLibrary.Switch Connection ${conn_id}
325 ${cmd} = BuiltIn.Set Variable openstack server show ${vm_name}
326 ${output} = OpenStackOperations.OpenStack CLI ${cmd}
327 BuiltIn.Log ${output}
328 ${address_output} = OpenStackOperations.OpenStack CLI ${cmd} | grep "addresses" | awk '{print $4$5}'
329 @{vm_ips} = String.Get Regexp Matches ${address_output} ${REGEX_IPV4}
332 Get Subnet Gateway Ip
333 [Arguments] ${subnet_name}
334 [Documentation] Show information of a subnet and grep for subnet gateway ip address
335 ${output} = OpenStackOperations.OpenStack CLI openstack subnet show ${subnet_name} | grep gateway_ip | awk '{print $4}'
336 ${splitted_output} = String.Split String ${output} ${EMPTY}
337 ${matches} = Collections.Get Matches ${splitted_output} regexp=(\\d\.)+
338 ${subnet_gateway_ip} = String.Strip String ${matches[0]} characters=','
339 [Return] ${subnet_gateway_ip}
341 Collect VM IPv6 SLAAC Addresses
342 [Arguments] ${fail_on_none} ${vm_list} ${network} ${subnet}
343 [Documentation] For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
344 ... Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
345 ... obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
346 ... Returns an empty list if no IPv6 addresses found or if SSH connection fails.
347 ... Otherwise, returns a list of IPv6 addresses.
348 ${ipv6_list} = BuiltIn.Create List @{EMPTY}
349 : FOR ${vm} IN @{vm_list}
350 \ ${output} = OpenStack CLI openstack server show ${vm} -f shell
351 \ ${pattern} = String.Replace String ${subnet} ::/64 (:[a-f0-9]{,4}){,4}
352 \ @{vm_ipv6} = String.Get Regexp Matches ${output} ${pattern}
353 \ ${vm_ip_length} = BuiltIn.Get Length ${vm_ipv6}[0]
354 \ ${ipv6_data_from_vm} = BuiltIn.Run Keyword If ${vm_ip_length}>0 OpenStackOperations.Execute Command on VM Instance ${network} ${vm_ipv6[0]}
356 \ @{ipv6} = String.Get Regexp Matches ${ipv6_data_from_vm} ${pattern}
357 \ ${ipv6_addr_list_length} BuiltIn.Get Length @{ipv6}
358 \ BuiltIn.Run Keyword If ${ipv6_addr_list_length}>0 Collections.Append To List ${ipv6_list} ${ipv6[0]}
359 \ ... ELSE Collections.Append To List ${ipv6_list} None
360 [Return] ${ipv6_list}
363 [Arguments] ${vm_instance_names}
364 [Documentation] View Console log of the created vm instances using nova show.
365 : FOR ${vm} IN @{vm_instance_names}
366 \ ${output} = OpenStack CLI openstack server show ${vm}
367 \ ${output} = OpenStack CLI openstack console log show ${vm}
369 Ping Vm From DHCP Namespace
370 [Arguments] ${net_name} ${vm_ip}
371 [Documentation] Reach all Vm Instance with the net id of the Netowrk.
372 OpenStackOperations.Get ControlNode Connection
373 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
374 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
375 BuiltIn.Should Contain ${output} 64 bytes
377 Ping From DHCP Should Not Succeed
378 [Arguments] ${net_name} ${vm_ip}
379 [Documentation] Should Not Reach Vm Instance with the net id of the Netowrk.
380 Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
381 OpenStackOperations.Get ControlNode Connection
382 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
383 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
384 BuiltIn.Should Not Contain ${output} 64 bytes
386 Ping Vm From Control Node
387 [Arguments] ${vm_floating_ip} ${additional_args}=${EMPTY}
388 [Documentation] Ping VM floating IP from control node
389 OpenStackOperations.Get ControlNode Connection
390 ${output} = DevstackUtils.Write Commands Until Prompt And Log ping ${additional_args} -c 3 ${vm_floating_ip} 20s
391 BuiltIn.Should Contain ${output} 64 bytes
394 [Documentation] Ping to the expected destination ip.
395 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
396 DevstackUtils.Write Commands Until Prompt exit
397 BuiltIn.Should Contain ${output} 200
400 [Documentation] Exit the vm instance.
401 ${output} = DevstackUtils.Write Commands Until Prompt And Log exit
403 Check If Console Is VmInstance
404 [Arguments] ${console}=cirros
405 [Documentation] Check if the session has been able to login to the VM instance
406 ${output} = Utils.Write Commands Until Expected Prompt id ${OS_SYSTEM_PROMPT}
407 BuiltIn.Should Contain ${output} ${console}
410 [Documentation] Check if the session has been able to login to the VM instance and exit the instance
411 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance cirros
412 BuiltIn.Run Keyword If ${rcode} DevstackUtils.Write Commands Until Prompt exit
415 [Arguments] ${ip_address} ${ttl}=64
416 [Documentation] Run Ping command on the IP available as argument
417 ${ethertype} = String.Get Regexp Matches ${ip_address} ${IP_REGEX}
418 ${output} = BuiltIn.Run Keyword If ${ethertype} Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
419 ... ELSE Utils.Write Commands Until Expected Prompt ping6 -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
420 BuiltIn.Should Contain ${output} 64 bytes
423 [Arguments] ${ip_address} ${ttl}=64
424 [Documentation] Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
425 ${output} = Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
426 BuiltIn.Should Not Contain ${output} 64 bytes
428 Check Metadata Access
429 [Documentation] Try curl on the Metadataurl and check if it is okay
430 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
431 BuiltIn.Should Contain ${output} 200
433 Execute Command on VM Instance
434 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=cirros ${password}=cubswin:)
435 [Documentation] Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
436 OpenStackOperations.Get ControlNode Connection
437 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
438 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ssh ${user}@${vm_ip} -o ConnectTimeout=10 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null password: timeout=60s
439 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT} timeout=60s
440 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
441 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT} timeout=60s
442 [Teardown] Exit From Vm Console
445 Test Operations From Vm Instance
446 [Arguments] ${net_name} ${src_ip} ${dest_ips} ${user}=cirros ${password}=cubswin:) ${ttl}=64
447 ... ${ping_should_succeed}=True ${check_metadata}=True
448 [Documentation] Login to the vm instance using ssh in the network.
449 OpenStackOperations.Get ControlNode Connection
450 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
451 ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ssh -o ConnectTimeout=10 -o StrictHostKeyChecking=no ${user}@${src_ip} -o UserKnownHostsFile=/dev/null password:
452 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
453 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
454 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ifconfig ${OS_SYSTEM_PROMPT}
455 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -n ${OS_SYSTEM_PROMPT}
456 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -A inet6 ${OS_SYSTEM_PROMPT}
457 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt arp -an ${OS_SYSTEM_PROMPT}
458 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ip -f inet6 neigh show ${OS_SYSTEM_PROMPT}
459 : FOR ${dest_ip} IN @{dest_ips}
460 \ ${string_empty} = BuiltIn.Run Keyword And Return Status Should Be Empty ${dest_ip}
461 \ BuiltIn.Run Keyword If ${string_empty} Continue For Loop
462 \ BuiltIn.Run Keyword If ${rcode} and "${ping_should_succeed}" == "True" OpenStackOperations.Check Ping ${dest_ip} ttl=${ttl}
463 \ ... ELSE OpenStackOperations.Check No Ping ${dest_ip} ttl=${ttl}
464 ${ethertype} = String.Get Regexp Matches ${src_ip} ${IP_REGEX}
465 BuiltIn.Run Keyword If ${rcode} and "${check_metadata}" and ${ethertype} == "True" OpenStackOperations.Check Metadata Access
466 [Teardown] Exit From Vm Console
468 Test Netcat Operations From Vm Instance
469 [Arguments] ${net_name} ${vm_ip} ${dest_ip} ${additional_args}=${EMPTY} ${port}=12345 ${user}=cirros
470 ... ${password}=cubswin:)
471 [Documentation] Use Netcat to test TCP/UDP connections to the controller
472 ${client_data} BuiltIn.Set Variable Test Client Data
473 ${server_data} BuiltIn.Set Variable Test Server Data
474 OpenStackOperations.Get ControlNode Connection
475 ${output} = DevstackUtils.Write Commands Until Prompt And Log ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
476 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo netstat -nlap | grep ${port}
477 ${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}
478 BuiltIn.Log ${output}
479 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo route -n
480 BuiltIn.Log ${output}
481 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo arp -an
482 BuiltIn.Log ${output}
483 BuiltIn.Should Match Regexp ${nc_output} ${server_data}
486 [Arguments] ${list_of_external_dst_ips}
487 [Documentation] Check reachability with other network's instances.
488 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
489 : FOR ${dest_ip} IN @{list_of_external_dst_ips}
490 \ OpenStackOperations.Check Ping ${dest_ip}
493 [Arguments] ${router_name}
494 [Documentation] Create Router and Add Interface to the subnets.
495 ${output} = OpenStack CLI openstack router create ${router_name}
498 [Documentation] List Routers and return output with neutron client.
499 ${output} = OpenStack CLI openstack router list -f value
503 [Arguments] ${router_name} ${interface_name}
504 ${output} = OpenStack CLI openstack router add subnet ${router_name} ${interface_name}
506 Show Router Interface
507 [Arguments] ${router_name}
508 [Documentation] List Routers interface associated with given Router and return output with neutron client.
509 ${output} = OpenStack CLI openstack port list --router ${router_name} -f value
513 [Arguments] ${router_name} ${external_network_name} ${additional_args}=${EMPTY}
514 ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name} ${additional_args}
517 [Arguments] ${router_name} ${interface_name}
518 [Documentation] Remove Interface to the subnets.
519 ${output} = OpenStack CLI openstack router remove subnet ${router_name} ${interface_name}
522 [Arguments] ${router_name}
523 [Documentation] Remove external gateway from the router.
524 ${output} = OpenStack CLI openstack router unset ${router_name} --external-gateway
527 [Arguments] ${router_name} ${cmd}
528 [Documentation] Update the router with the command. Router name and command should be passed as argument.
529 ${output} = OpenStack CLI openstack router set ${router_name} ${cmd}
532 [Arguments] ${router_name} ${additional_args}=${EMPTY}
533 [Documentation] Show information of a given router. Router name and optional fields should be sent as arguments.
534 ${output} = OpenStack CLI openstack router show ${router_name} ${additional_args}
538 [Arguments] ${router_name}
539 [Documentation] Delete Router and Interface to the subnets.
540 ${output} = OpenStack CLI openstack router delete ${router_name}
542 Get DumpFlows And Ovsconfig
543 [Arguments] ${conn_id}
544 [Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
545 SSHLibrary.Switch Connection ${conn_id}
546 Utils.Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
547 Utils.Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
548 Utils.Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
549 Utils.Write Commands Until Expected Prompt arp -an ${DEFAULT_LINUX_PROMPT_STRICT}
550 ${nslist} = Utils.Write Commands Until Expected Prompt ip netns list | awk '{print $1}' ${DEFAULT_LINUX_PROMPT_STRICT}
551 @{lines} Split To Lines ${nslist} end=-1
552 : FOR ${line} IN @{lines}
553 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
554 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
555 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
556 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
557 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
558 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
559 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
560 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
561 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
563 Get ControlNode Connection
564 SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
565 [Return] ${OS_CNTL_CONN_ID}
568 [Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
569 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
570 \ OpenStackOperations.Get DumpFlows And Ovsconfig ${conn_id}
572 Get Test Teardown Debugs
573 [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME} ${fail}=${FAIL_ON_EXCEPTIONS}
574 ODLTools.Get All node_ip=${HA_PROXY_IP} test_name=${test_name}
575 OpenStackOperations.Get OvsDebugInfo
576 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_data_models}
577 KarafKeywords.Fail If Exceptions Found During Test ${test_name} fail=${fail}
580 Get Test Teardown Debugs test_name=${SUITE_NAME} fail=False
582 Get Test Teardown Debugs For SFC
583 [Arguments] ${test_name}=${TEST_NAME}
584 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_sfc_data_models}
587 [Arguments] @{vm_indices}
588 [Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
589 OpenStackOperations.Get ControlNode Connection
590 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns list
591 : FOR ${index} IN @{vm_indices}
592 \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
593 \ BuiltIn.Log ${output}
594 OpenStackOperations.List Nova VMs
595 OpenStackOperations.List Routers
596 OpenStackOperations.List Networks
597 OpenStackOperations.List Subnets
598 OpenStackOperations.List Ports
599 OpenStackOperations.List Security Groups
602 [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
603 ... credentials are already sourced
604 ${output} = OpenStack CLI openstack security group list
607 Neutron Security Group Show
608 [Arguments] ${SecurityGroupRuleName}
609 [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
610 ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
614 [Arguments] ${PortName}
615 [Documentation] Display the port configuration that belong to a given neutron port
616 ${output} = OpenStack CLI openstack port show ${PortName}
619 Neutron Security Group Create
620 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
621 [Documentation] Create a security group with specified name ,description & protocol value according to security group template
622 OpenStackOperations.Get ControlNode Connection
623 ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
624 ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
625 [Return] ${output} ${sgp_id}
627 Neutron Security Group Update
628 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
629 [Documentation] Updating security groups
630 ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
634 [Arguments] ${sg_name}
635 [Documentation] Delete Security group
636 ${output} = OpenStack CLI openstack security group delete ${sg_name}
638 Neutron Security Group Rule Create
639 [Arguments] ${Security_group_name} &{Kwargs}
640 [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]} ..."
641 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
642 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
643 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
644 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
645 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
646 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
647 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
648 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
649 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote-ip default=${None}
650 ${cmd} = BuiltIn.Set Variable openstack security group rule create
651 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
652 ... ELSE BuiltIn.Catenate ${cmd}
653 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --${direction}
654 ... ELSE BuiltIn.Catenate ${cmd}
655 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
656 ... ELSE BuiltIn.Catenate ${cmd}
657 ${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}
658 ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
659 ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}
660 ... ELSE BuiltIn.Catenate ${cmd}
661 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
662 ... ELSE BuiltIn.Catenate ${cmd}
663 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote-group ${remote_group_id}
664 ... ELSE BuiltIn.Catenate ${cmd}
665 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --remote-ip ${remote_ip_prefix} ${Security_group_name}
666 ... ELSE BuiltIn.Catenate ${cmd}
667 ${output} = OpenStack CLI ${cmd}
668 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
669 [Return] ${output} ${rule_id}
671 Security Group Create Without Default Security Rules
672 [Arguments] ${sg_name} ${additional_args}=${EMPTY}
673 [Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
674 OpenStackOperations.Neutron Security Group Create ${sg_name} ${additional_args}
675 Delete All Security Group Rules ${sg_name}
677 Delete All Security Group Rules
678 [Arguments] ${sg_name}
679 [Documentation] Delete all security rules from a specified security group
680 ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
681 @{sg_rules} = String.Split String ${sg_rules_output} \n
682 : FOR ${rule} IN @{sg_rules}
683 \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
685 Create Allow All SecurityGroup
686 [Arguments] ${sg_name} ${ether_type}=IPv4
687 [Documentation] Allow all TCP/UDP/ICMP packets for this suite
688 OpenStackOperations.Neutron Security Group Create ${sg_name}
689 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
690 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
691 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
692 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
693 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
694 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
696 Create Neutron Port With Additional Params
697 [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
698 [Documentation] Create Port With given additional parameters
699 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
700 BuiltIn.Log ${output}
701 BuiltIn.Should Be True '${rc}' == '0'
702 ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
703 [Return] ${OUTPUT} ${port_id}
707 [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
708 ${macs} BuiltIn.Create List
709 : FOR ${port} IN @{ports}
710 \ ${mac} = OpenStackOperations.Get Port Mac ${port}
711 \ Collections.Append To List ${macs} ${mac}
715 [Arguments] ${port_name}
716 [Documentation] Keyword would return the IP of the ${port_name} received.
717 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
718 ${splitted_output} = String.Split String ${output} ${EMPTY}
719 ${port_ip} = Collections.Get from List ${splitted_output} 0
723 [Arguments] ${port_name}
724 [Documentation] Keyword would return the MAC ID of the ${port_name} received.
725 ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
726 ${splitted_output} = String.Split String ${output} ${EMPTY}
727 ${port_mac} = Collections.Get from List ${splitted_output} 0
730 Get Port Mac Address From Ip
732 [Documentation] Retrieve the mac address for a port that matches any given ip.
733 ${output} = OpenStack CLI openstack port list | grep -w ${ip} | awk '{print $5}'
734 ${splitted_output} = String.Split String ${output} ${EMPTY}
735 ${mac_addr} = Collections.Get from List ${splitted_output} 0
739 [Arguments] ${bridge_name} ${intf_name} ${gw_name}
740 [Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
741 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
742 BuiltIn.Log ${l2gw_output}
743 [Return] ${l2gw_output}
746 [Arguments] ${bridge_name} ${gw_name} ${intf_name_1} ${intf_name_2}
747 [Documentation] Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
748 ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
750 [Return] ${l2gw_output}
752 Create L2Gateway Connection
753 [Arguments] ${gw_name} ${net_name}
754 [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
755 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
756 BuiltIn.Log ${l2gw_output}
757 BuiltIn.Should Be True '${rc}' == '0'
758 [Return] ${l2gw_output}
761 [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
762 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
763 BuiltIn.Should Be True '${rc}' == '0'
766 Get All L2Gateway Connection
767 [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
768 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
769 BuiltIn.Should Be True '${rc}' == '0'
774 [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
775 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
776 BuiltIn.Log ${output}
777 BuiltIn.Should Be True '${rc}' == '0'
781 [Arguments] ${l2gw_name}
782 [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
783 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
784 BuiltIn.Log ${output}
785 BuiltIn.Should Be True '${rc}' == '0'
786 ${splitted_output} = String.Split String ${output} ${EMPTY}
787 ${l2gw_id} = Collections.Get from List ${splitted_output} 0
790 Get L2gw Connection Id
791 [Arguments] ${l2gw_name}
792 [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
793 ${l2gw_id} = OpenStackOperations.Get L2gw Id ${l2gw_name}
794 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
795 BuiltIn.Should Be True '${rc}' == '0'
796 ${splitted_output} = String.Split String ${output} ${EMPTY}
797 ${splitted_output} = String.Split String ${output} ${EMPTY}
798 ${l2gw_conn_id} = Collections.Get from List ${splitted_output} 0
799 [Return] ${l2gw_conn_id}
801 Neutron Port List Rest
802 [Documentation] Keyword to get all ports details in Neutron (Using REST).
803 ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
804 BuiltIn.Log ${resp.content}
805 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
806 [Return] ${resp.content}
808 Get Neutron Port Rest
809 [Arguments] ${port_id}
810 [Documentation] Keyword to get the specific port details in Neutron (Using REST).
811 ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
812 BuiltIn.Log ${resp.content}
813 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
814 [Return] ${resp.content}
817 [Arguments] ${port_id} ${json_data}
818 [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
819 BuiltIn.Log ${json_data}
820 ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
821 BuiltIn.Log ${resp.content}
822 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
823 [Return] ${resp.content}
825 Get Neutron Network Rest
826 [Arguments] ${net_id}
827 [Documentation] Keyword to get the specific network details in Neutron (Using REST).
828 ${resp} = RequestsLibrary.Get Request session ${NETWORK_URL}/network/${net_id}
829 BuiltIn.Log ${resp.content}
830 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
831 [Return] ${resp.content}
833 Create And Configure Security Group
834 [Arguments] ${sg-name}
835 [Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
836 OpenStackOperations.Neutron Security Group Create ${sg-name}
837 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
838 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
839 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
840 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
841 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
842 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
844 Add Security Group To VM
845 [Arguments] ${vm} ${sg}
846 [Documentation] Add the security group provided to the given VM.
847 ${output} = OpenStack CLI openstack server add security group ${vm} ${sg}
849 Remove Security Group From VM
850 [Arguments] ${vm} ${sg}
851 [Documentation] Remove the security group provided to the given VM.
852 OpenStackOperations.Get ControlNode Connection
853 ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
855 Create SFC Flow Classifier
856 [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${dest_port} ${neutron_src_port}
857 [Documentation] Create a flow classifier for SFC
858 ${output} = OpenStack CLI openstack sfc flow classifier create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --destination-port ${dest_port}:${dest_port} --logical-source-port ${neutron_src_port} ${name}
859 BuiltIn.Should Contain ${output} ${name}
862 Delete SFC Flow Classifier
864 [Documentation] Delete a SFC flow classifier
865 OpenStackOperations.Get ControlNode Connection
866 ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
870 [Arguments] ${name} ${port_in} ${port_out}
871 [Documentation] Creates a neutron port pair for SFC
872 OpenStackOperations.Get ControlNode Connection
873 ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
874 BuiltIn.Should Contain ${output} ${name}
879 [Documentation] Delete a SFC port pair
880 ${output} = OpenStack CLI openstack sfc port pair delete ${name}
883 Create SFC Port Pair Group
884 [Arguments] ${name} ${port_pair}
885 [Documentation] Creates a port pair group with a single port pair for SFC
886 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
887 BuiltIn.Should Contain ${output} ${name}
890 Create SFC Port Pair Group With Two Pairs
891 [Arguments] ${name} ${port_pair1} ${port_pair2}
892 [Documentation] Creates a port pair group with two port pairs for SFC
893 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
894 BuiltIn.Should Contain ${output} ${name}
897 Delete SFC Port Pair Group
899 [Documentation] Delete a SFC port pair group
900 OpenStackOperations.Get ControlNode Connection
901 ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
904 Create SFC Port Chain
905 [Arguments] ${name} ${pg1} ${pg2} ${fc}
906 [Documentation] Creates a port pair chain with two port groups and a singel classifier.
907 ${output} = OpenStack CLI openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
908 BuiltIn.Should Contain ${output} ${name}
911 Delete SFC Port Chain
913 [Documentation] Delete a SFC port chain
914 ${output} = OpenStack CLI openstack sfc port chain delete ${name}
918 [Arguments] ${vm_name}
919 [Documentation] Reboot NOVA VM
920 ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
921 BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
923 Remove RSA Key From KnownHosts
925 [Documentation] Remove RSA
926 OpenStackOperations.Get ControlNode Connection
927 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
928 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
929 ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
931 Wait For Routes To Propogate
932 [Arguments] ${networks} ${subnets}
933 [Documentation] Check propagated routes
934 OpenStackOperations.Get ControlNode Connection
935 : FOR ${INDEX} IN RANGE 0 1
936 \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
937 \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
938 \ ${length} = BuiltIn.Get Length ${is_ipv6}
939 \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
940 \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ${DEFAULT_LINUX_PROMPT_STRICT}
941 \ BuiltIn.Should Contain ${output} @{subnets}[${INDEX}]
944 [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
945 : FOR ${vm} IN @{vms}
946 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
947 : FOR ${port} IN @{ports}
948 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
949 : FOR ${subnet} IN @{subnets}
950 \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
951 : FOR ${network} IN @{networks}
952 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
953 : FOR ${sg} IN @{sgs}
954 \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
957 [Documentation] Get a list of different OpenStack resources that might be in use.
958 @{modules} = BuiltIn.Create List server port network subnet security group
959 ... security group rule floating ip router
960 : FOR ${module} IN @{modules}
961 \ ${output} = OpenStack CLI openstack ${module} list
963 OpenStack CLI Get List
965 [Documentation] Return a json list from the output of an OpenStack command.
966 @{list} = BuiltIn.Create List
967 ${json} = OpenStack CLI ${cmd}
968 @{list} = RequestsLibrary.To Json ${json}
974 [Documentation] Run the given OpenStack ${cmd} and log the output.
975 ${result} = Process.Run Process ${cmd} shell=True
976 BuiltIn.Log ${result.stdout}
977 BuiltIn.Log ${result.stderr}
978 BuiltIn.Should Be True '${result.rc}' == '0'
979 [Return] ${result.stdout}
981 OpenStack CLI With No Log
983 [Documentation] Run the given OpenStack ${cmd} and do not log the output.
984 ${result} = Process.Run Process ${cmd} shell=True
985 BuiltIn.Should Be True '${result.rc}' == '0'
986 [Return] ${result.stdout}
988 OpenStack Cleanup All
989 [Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
990 ... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
991 @{fips} = OpenStack CLI Get List openstack floating ip list -f json
992 : FOR ${fip} IN @{fips}
993 \ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
994 @{vms} = OpenStack CLI Get List openstack server list -f json
995 : FOR ${vm} IN @{vms}
996 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
997 @{routers} = OpenStack CLI Get List openstack router list -f json
998 : FOR ${router} IN @{routers}
999 \ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
1000 @{ports} = OpenStack CLI Get List openstack port list -f json
1001 : FOR ${port} IN @{ports}
1002 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
1003 @{networks} = OpenStack CLI Get List openstack network list -f json
1004 : FOR ${network} IN @{networks}
1005 \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
1006 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
1007 @{security_groups} = OpenStack CLI Get List openstack security group list -f json
1008 : FOR ${security_group} IN @{security_groups}
1009 \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
1014 [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
1015 @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
1016 : FOR ${port} IN @{ports}
1017 \ ${subnet_id} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 0
1018 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
1019 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
1020 BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
1022 OpenStack Suite Setup
1023 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1024 SetupUtils.Setup_Utils_For_Setup_And_Teardown
1025 @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil org.apache.sshd.server.session.ServerSessionImpl
1026 Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All OFF ${loggers}
1027 DevstackUtils.Devstack Suite Setup
1028 @{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
1029 BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
1030 BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
1031 OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1032 Run_Keyword_If_At_Least_Oxygen Wait Until Keyword Succeeds 60 2 ClusterManagement.Check Status Of Services Is OPERATIONAL @{NETVIRT_DIAG_SERVICES}
1033 Verify Expected Default Tables On Nodes
1035 OpenStack Suite Teardown
1036 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1037 ... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1038 ... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1039 ... benefit automatically.
1040 # TODO: followup patch will add the list of vms to pass to Show Debugs
1041 # OpenStackOperations.Show Debugs @{NET_1_VMS} @{NET_2_VMS}
1042 OpenStackOperations.Get Suite Debugs
1043 OpenStack Cleanup All
1044 OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
1045 SSHLibrary.Close All Connections
1046 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
1047 \ KarafKeywords.Issue Command On Karaf Console threads --list | wc -l ${ODL_SYSTEM_${i+1}_IP}
1049 Copy DHCP Files From Control Node
1050 [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
1051 ... after the subnet(s) are created and before the subnet(s) are deleted.
1052 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1053 ${dstdir} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
1054 OperatingSystem.Create Directory ${dstdir}
1055 OpenStackOperations.Get ControlNode Connection
1056 BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
1058 Is Feature Installed
1059 [Arguments] ${features}=none
1060 : FOR ${feature} IN @{features}
1061 \ ${status} ${output} BuiltIn.Run Keyword And Ignore Error BuiltIn.Should Contain ${CONTROLLERFEATURES} ${feature}
1062 \ Return From Keyword If "${status}" == "PASS" True
1065 Add OVS Logging On All OpenStack Nodes
1066 [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
1067 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1068 \ OVSDB.Add OVS Logging ${conn_id}
1070 Reset OVS Logging On All OpenStack Nodes
1071 [Documentation] Reset the OVS logging to all the OpenStack nodes
1072 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1073 \ OVSDB.Reset OVS Logging ${conn_id}
1075 Start Packet Capture On Nodes
1076 [Arguments] ${tag} ${filter} @{ips}
1077 [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1078 ... The caller must pass the three arguments with a variable number of ips at the end,
1079 ... but ${EMPTY} can be used for the tag and filter.
1080 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1081 ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
1082 @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
1083 [Return] @{conn_ids}
1085 Stop Packet Capture On Nodes
1086 [Arguments] ${conn_ids}=@{EMPTY}
1087 Tcpdump.Stop Packet Capture on Nodes ${conn_ids}
1090 [Arguments] ${vm_instance_name}
1091 [Documentation] Keyword for live migration of VM instance
1092 ... additional_agrs is to select particular migration(live/shared-migration/block-migration)
1093 ... if the additional_agrs is not given default migration(shared-migration) will happen
1094 ${output} = OpenStackOperations.OpenStack CLI nova live-migration ${vm_instance_name}
1096 Get Hypervisor Host Of Vm
1097 [Arguments] ${vm_name}
1098 [Documentation] Show server with neutron request.
1099 ${output} = OpenStackOperations.OpenStack CLI openstack server show -f value -c OS-EXT-SRV-ATTR:host ${vm_name}
1102 Check If Migration Is Complete
1103 [Arguments] ${vm_name}
1104 [Documentation] Show server and verify if task_state is not migrating
1105 ${output} = OpenStackOperations.OpenStack CLI openstack server show ${vm_name} | grep "OS-EXT-STS:task_state"
1106 BuiltIn.Should Not Contain ${output} migrating
1108 Modify OpenStack Configuration File
1109 [Arguments] ${conn_id} ${file_name} ${section} ${key} ${value}
1110 [Documentation] Use crudini to modify any parameter in any Openstack configuration File
1111 SSHLibrary.Switch Connection ${conn_id}
1112 ${output} ${rc} = SSHLibrary.Execute Command sudo crudini --verbose --set --inplace ${file_name} ${section} ${key} ${value} return_rc=True return_stdout=True
1113 BuiltIn.Log ${output}
1114 BuiltIn.Should Be True '${rc}' == '0'
1116 Restart DevStack Service
1117 [Arguments] ${conn_id} ${service_name}
1118 [Documentation] Restart the Openstack Service
1119 SSHLibrary.Switch Connection ${conn_id}
1120 ${output} ${rc} = SSHLibrary.Execute Command sudo systemctl restart devstack@${service_name}.service return_rc=True return_stdout=True
1121 BuiltIn.Log ${output}
1122 BuiltIn.Should Be True '${rc}' == '0'
1124 Get Network Segmentation Id
1125 [Arguments] ${network_name}
1126 [Documentation] Returns network segmentation id for the given network name.
1127 ${output} = OpenStack CLI openstack network show ${network_name} | grep segmentation_id | awk '{print $4}'
1128 @{list} = String.Split String ${output}
1131 Verify Expected Default Tables On Nodes
1132 [Arguments] ${node_ips}=@{OS_ALL_IPS}
1133 [Documentation] Verify if Default Table Entries are programmed on all Nodes
1134 ${resp} = RequestsLibrary.Get Request session ${CONFIG_NODES_API}
1135 Utils.Log Content ${resp.content}
1136 ${failed_node_list} = BuiltIn.Create List
1137 : FOR ${node_ip} IN @{node_ips}
1138 \ ${failed_table_list} = Verify Expected Default Tables ${node_ip}
1139 \ ${failed_table_list_size} = BuiltIn.Get Length ${failed_table_list}
1140 \ BuiltIn.Run Keyword If ${failed_table_list_size} > 0 Collections.Append To List ${failed_node_list} ${node_ip}
1141 Builtin.Should Be Empty ${failed_node_list}
1143 Verify Expected Default Tables
1144 [Arguments] ${ovs_ip}
1145 [Documentation] Verify if Default Table Entries are programmed on specific Node
1146 ${flow_dump} = Utils.Run Command On Remote System ${ovs_ip} sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13
1147 BuiltIn.Log ${flow_dump}
1148 ${failed_table_list} = BuiltIn.Create List
1149 : FOR ${table} IN @{DEFAULT_FLOW_TABLES}
1150 \ ${rc} = Builtin.Run Keyword And Return Status Builtin.Should Not Match Regexp ${flow_dump} .*table=${table}.*priority=0
1151 \ BuiltIn.Run Keyword If ${rc} Collections.Append To List ${failed_table_list} ${table}
1152 [Return] ${failed_table_list}
1155 [Arguments] ${project_name}
1156 [Documentation] Returns project ID for the given project name.
1157 ${project_id} = OpenStack CLI openstack project show ${project_name} -f value -c id
1158 [Return] ${project_id}
1160 Set Instance Quota For Project
1161 [Arguments] ${num_instances} ${project_id}
1162 [Documentation] Set quota for the created instances using the specific project id.
1163 ${output} = OpenStack CLI openstack quota set --instances ${num_instances} ${project_id}