2 Documentation Openstack library. This library is useful for tests to create network, subnet, router and vm instances
4 Library OperatingSystem
5 Library RequestsLibrary
8 Resource DataModels.robot
9 Resource DevstackUtils.robot
10 Resource KarafKeywords.robot
11 Resource L2GatewayOperations.robot
13 Resource SetupUtils.robot
14 Resource SSHKeywords.robot
15 Resource Tcpdump.robot
17 Resource ../variables/Variables.robot
18 Resource ../variables/netvirt/Variables.robot
19 Variables ../variables/netvirt/Modules.py
20 Variables ../variables/netvirt/Exceptions_Whitelist.py
23 Get Tenant ID From Security Group
24 [Documentation] Returns tenant ID by reading it from existing default security-group.
25 ${output} = OpenStack CLI openstack security group show default | grep "| tenant_id" | awk '{print $4}'
28 Get Tenant ID From Network
29 [Arguments] ${network_uuid}
30 [Documentation] Returns tenant ID by reading it from existing network.
31 ${resp} = TemplatedRequests.Get_From_Uri uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/ accept=${ACCEPT_EMPTY} session=session
32 ${tenant_id} = Utils.Extract Value From Content ${resp} /network/0/tenant-id strip
36 [Arguments] ${network_name} ${additional_args}=${EMPTY} ${verbose}=TRUE
37 [Documentation] Create Network with openstack request.
38 ${output} = OpenStack CLI openstack network create ${network_name} ${additional_args}
42 [Arguments] ${network_name} ${additional_args}=${EMPTY}
43 [Documentation] Update Network with neutron request.
44 ${output} = OpenStack CLI openstack network set ${network_name} ${additional_args}
48 [Arguments] ${network_name}
49 [Documentation] Show Network with neutron request.
50 ${output} = OpenStack CLI openstack network show ${network_name}
54 [Documentation] List networks and return output with neutron client.
55 ${output} = OpenStack CLI openstack network list
59 [Documentation] List subnets and return output with neutron client.
60 ${output} = OpenStack CLI openstack subnet list
64 [Arguments] ${network_name}
65 [Documentation] Delete Network with neutron request.
66 ${output} = OpenStack CLI openstack network delete ${network_name}
69 [Arguments] ${network_name} ${subnet_name} ${range_ip} ${additional_args}=${EMPTY}
70 [Documentation] Create SubNet for the Network with neutron request.
71 ${output} = OpenStack CLI openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet_name} ${additional_args}
74 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
75 [Documentation] Update subnet with openstack subnet set request.
76 ${output} = OpenStack CLI openstack subnet set ${subnet_name} ${additional_args}
80 [Arguments] ${subnet_name} ${additional_args}=${EMPTY}
81 [Documentation] Update subnet with openstack subnet unset request
82 ${output} = OpenStack CLI openstack subnet unset ${subnet_name} ${additional_args}
86 [Arguments] ${subnet_name}
87 [Documentation] Show subnet with neutron request.
88 ${output} = OpenStack CLI openstack subnet show ${subnet_name}
92 [Arguments] ${network_name} ${port_name} ${sg}=default ${additional_args}=${EMPTY} ${allowed_address_pairs}=${EMPTY}
93 [Documentation] Create Port with neutron request.
94 # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
95 # in a different format with the neutron vs openstack cli.
96 ${address_pair_length} = BuiltIn.Get Length ${allowed_address_pairs}
97 ${allowed_pairs_argv} = BuiltIn.Set Variable ${EMPTY}
98 ${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}
99 ${output} = OpenStack CLI openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
102 [Arguments] ${port_name} ${additional_args}=${EMPTY}
103 [Documentation] Update port with neutron request.
104 ${output} = OpenStack CLI openstack port set ${port_name} ${additional_args}
108 [Arguments] ${port_name}
109 [Documentation] Show port with neutron request.
110 ${output} = OpenStack CLI openstack port show ${port_name}
114 [Arguments] ${port_name}
115 [Documentation] Delete Port with neutron request.
116 ${output} = OpenStack CLI openstack port delete ${port_name}
119 [Documentation] List ports and return output with neutron client.
120 ${output} = OpenStack CLI openstack port list
124 [Documentation] List VMs and return output with nova client.
125 ${output} = OpenStack CLI openstack server list --all-projects
128 Create And Associate Floating IPs
129 [Arguments] ${external_net} @{vm_list}
130 [Documentation] Create and associate floating IPs to VMs with nova request
131 ${ip_list} = BuiltIn.Create List @{EMPTY}
132 : FOR ${vm} IN @{vm_list}
133 \ ${output} = OpenStack CLI openstack floating ip create ${external_net}
134 \ @{ip} = String.Get Regexp Matches ${output} [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
135 \ ${ip_length} = BuiltIn.Get Length ${ip}
136 \ BuiltIn.Run Keyword If ${ip_length}>0 Collections.Append To List ${ip_list} @{ip}[0]
137 \ ... ELSE Collections.Append To List ${ip_list} None
138 \ ${output} = OpenStack CLI openstack server add floating ip ${vm} @{ip}[0]
141 Remove Floating Ip From Vm
142 [Arguments] ${vm_name} ${fip}
143 [Documentation] Remove the Floating IP From VM Instance
144 ${output} = OpenStack CLI openstack server remove floating ip ${vm_name} ${fip}
148 [Documentation] Delete floating ip with neutron request.
149 ${output} = OpenStack CLI openstack floating ip delete ${fip}
152 [Arguments] ${subnet}
153 [Documentation] Delete SubNet for the Network with neutron request.
154 ${output} = OpenStack CLI openstack subnet delete ${subnet}
157 [Arguments] ${vm_name}
158 [Documentation] Delete Vm instances using instance names.
159 ${output} = OpenStack CLI openstack server delete ${vm_name}
162 [Arguments] ${network_name}
163 [Documentation] Retrieve the net id for the given network name to create specific vm instance
164 ${output} = OpenStack CLI openstack network list | grep "${network_name}" | awk '{print $2}'
165 ${splitted_output} = String.Split String ${output} ${EMPTY}
166 ${net_id} = Collections.Get from List ${splitted_output} 0
170 [Arguments] ${subnet_name}
171 [Documentation] Retrieve the subnet id for the given subnet name
172 ${output} = OpenStack CLI openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
173 ${splitted_output} = String.Split String ${output} ${EMPTY}
174 ${subnet_id} = Collections.Get from List ${splitted_output} 0
175 [Return] ${subnet_id}
178 [Arguments] ${port_name}
179 [Documentation] Retrieve the port id for the given port name to attach specific vm instance to a particular port
180 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk '{print $2}'
181 ${splitted_output} = String.Split String ${output} ${EMPTY}
182 ${port_id} = Collections.Get from List ${splitted_output} 0
186 [Arguments] ${router1}
187 [Documentation] Retrieve the router id for the given router name
188 ${output} = OpenStack CLI openstack router show "${router1}" |awk '/ id / {print $4}'
189 ${splitted_output} = String.Split String ${output} ${EMPTY}
190 ${router_id} = Collections.Get from List ${splitted_output} 0
191 [Return] ${router_id}
194 [Arguments] ${net_name} ${vm_instance_names} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default ${min}=1
196 [Documentation] Create X Vm Instance with the net id of the Netowrk.
197 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
198 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
199 : FOR ${vm} IN @{vm_instance_names}
200 \ ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
202 Create Vm Instance On Compute Node
203 [Arguments] ${net_name} ${vm_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
204 [Documentation] Create a VM instance on a specific compute node.
205 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
206 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
207 ${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}
209 Create Vm Instance With Port
210 [Arguments] ${port_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
211 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
212 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
213 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
214 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-group ${sg}
216 Create Vm Instance With Ports
217 [Arguments] ${port_name} ${port2_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
218 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
219 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
220 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
221 ${port2_id} = OpenStackOperations.Get Port Id ${port2_name}
222 ${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}
224 Create Vm Instance With Port On Compute Node
225 [Arguments] ${port_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
226 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
227 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
228 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
229 ${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}
231 Get Hypervisor Hostname From IP
232 [Arguments] ${hypervisor_ip}
233 [Documentation] Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
234 ... the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
235 ${output} = OpenStack CLI openstack hypervisor list
236 ${hostname} = OpenStack CLI openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
240 [Documentation] Create a nano flavor
241 ${output} = OpenStack CLI openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
244 [Arguments] ${vm_name}
245 [Documentation] Run these commands to check whether the created vm instance is active or not.
246 ${output} = OpenStack CLI openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
247 BuiltIn.Should Contain ${output} active
250 [Arguments] ${vm_name} ${retry}=600s ${retry_interval}=30s
251 [Documentation] Run these commands to check whether the created vm instance is active or not.
252 BuiltIn.Wait Until Keyword Succeeds ${retry} ${retry_interval} OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
255 [Arguments] ${text} ${regexp} ${index}=0
256 [Documentation] Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
257 @{matches} = String.Get Regexp Matches ${text} ${regexp}
258 ${matches_length} = BuiltIn.Get Length ${matches}
259 BuiltIn.Set Suite Variable ${OS_MATCH} None
260 BuiltIn.Run Keyword If ${matches_length} > ${index} BuiltIn.Set Suite Variable ${OS_MATCH} @{matches}[${index}]
264 [Arguments] ${fail_on_none} ${vm}
265 [Documentation] Get the vm ip address and nameserver by scraping the vm's console log.
266 ... Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
267 ${vm_console_output} = OpenStack CLI With No Log openstack console log show ${vm}
268 ${vm_ip} = BuiltIn.Set Variable None
269 ${dhcp_ip} = BuiltIn.Set Variable None
270 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_OBTAINED}
271 ${vm_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 0
272 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_IPROUTE}
273 ${dhcp_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 1
274 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${vm_ip} None
275 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${dhcp_ip} None
276 [Return] ${vm_ip} ${dhcp_ip} ${vm_console_output}
280 [Documentation] Get the instance IP addresses and nameserver address for the list of given vms.
281 ... First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
282 ... Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
283 ... of None) and [1] the dhcp ip address found in the last vm checked.
284 ... TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
285 ... may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
286 @{vm_ips} BuiltIn.Create List @{EMPTY}
287 : FOR ${vm} IN @{vms}
288 \ OpenStackOperations.Poll VM Is ACTIVE ${vm}
289 \ ${status} ${ips_and_console_log} BuiltIn.Run Keyword And Ignore Error BuiltIn.Wait Until Keyword Succeeds 180s 15s
290 \ ... OpenStackOperations.Get VM IP true ${vm}
291 \ # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
292 \ # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
293 \ # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
294 \ # the vm ip list if status is FAIL.
295 \ BuiltIn.Run Keyword If "${status}" == "PASS" BuiltIn.Log ${ips_and_console_log[2]}
296 \ BuiltIn.Run Keyword If "${status}" == "PASS" Collections.Append To List ${vm_ips} ${ips_and_console_log[0]}
297 \ BuiltIn.Run Keyword If "${status}" == "FAIL" Collections.Append To List ${vm_ips} None
298 \ ${vm_console_output} = BuiltIn.Run Keyword If "${status}" == "FAIL" OpenStack CLI openstack console log show ${vm}
299 \ BuiltIn.Run Keyword If "${status}" == "FAIL" BuiltIn.Log ${vm_console_output}
300 OpenStackOperations.Copy DHCP Files From Control Node
301 [Return] @{vm_ips} ${ips_and_console_log[1]}
303 Get Subnet Gateway Ip
304 [Arguments] ${subnet_name}
305 [Documentation] Show information of a subnet and grep for subnet gateway ip address
306 ${output} = OpenStackOperations.OpenStack CLI openstack subnet show ${subnet_name} | grep gateway_ip | awk '{print $4}'
307 ${splitted_output} = String.Split String ${output} ${EMPTY}
308 ${matches} = Collections.Get Matches ${splitted_output} regexp=(\\d\.)+
309 ${subnet_gateway_ip} = String.Strip String ${matches[0]} characters=','
310 [Return] ${subnet_gateway_ip}
312 Collect VM IPv6 SLAAC Addresses
313 [Arguments] ${fail_on_none} ${vm_list} ${network} ${subnet}
314 [Documentation] For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
315 ... Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
316 ... obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
317 ... Returns an empty list if no IPv6 addresses found or if SSH connection fails.
318 ... Otherwise, returns a list of IPv6 addresses.
319 ${ipv6_list} = BuiltIn.Create List @{EMPTY}
320 : FOR ${vm} IN @{vm_list}
321 \ ${output} = OpenStack CLI openstack server show ${vm} -f shell
322 \ ${pattern} = String.Replace String ${subnet} ::/64 (:[a-f0-9]{,4}){,4}
323 \ @{vm_ipv6} = String.Get Regexp Matches ${output} ${pattern}
324 \ ${vm_ip_length} = BuiltIn.Get Length ${vm_ipv6}[0]
325 \ ${ipv6_data_from_vm} = BuiltIn.Run Keyword If ${vm_ip_length}>0 OpenStackOperations.Execute Command on VM Instance ${network} ${vm_ipv6[0]}
327 \ @{ipv6} = String.Get Regexp Matches ${ipv6_data_from_vm} ${pattern}
328 \ ${ipv6_addr_list_length} BuiltIn.Get Length @{ipv6}
329 \ BuiltIn.Run Keyword If ${ipv6_addr_list_length}>0 Collections.Append To List ${ipv6_list} ${ipv6[0]}
330 \ ... ELSE Collections.Append To List ${ipv6_list} None
331 [Return] ${ipv6_list}
334 [Arguments] ${vm_instance_names}
335 [Documentation] View Console log of the created vm instances using nova show.
336 : FOR ${vm} IN @{vm_instance_names}
337 \ ${output} = OpenStack CLI openstack server show ${vm}
338 \ ${output} = OpenStack CLI openstack console log show ${vm}
340 Ping Vm From DHCP Namespace
341 [Arguments] ${net_name} ${vm_ip}
342 [Documentation] Reach all Vm Instance with the net id of the Netowrk.
343 OpenStackOperations.Get ControlNode Connection
344 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
345 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
346 BuiltIn.Should Contain ${output} 64 bytes
348 Ping From DHCP Should Not Succeed
349 [Arguments] ${net_name} ${vm_ip}
350 [Documentation] Should Not Reach Vm Instance with the net id of the Netowrk.
351 Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
352 OpenStackOperations.Get ControlNode Connection
353 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
354 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
355 BuiltIn.Should Not Contain ${output} 64 bytes
357 Ping Vm From Control Node
358 [Arguments] ${vm_floating_ip} ${additional_args}=${EMPTY}
359 [Documentation] Ping VM floating IP from control node
360 OpenStackOperations.Get ControlNode Connection
361 ${output} = DevstackUtils.Write Commands Until Prompt And Log ping ${additional_args} -c 3 ${vm_floating_ip} 20s
362 BuiltIn.Should Contain ${output} 64 bytes
365 [Documentation] Ping to the expected destination ip.
366 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
367 DevstackUtils.Write Commands Until Prompt exit
368 BuiltIn.Should Contain ${output} 200
371 [Documentation] Exit the vm instance.
372 ${output} = DevstackUtils.Write Commands Until Prompt And Log exit
374 Check If Console Is VmInstance
375 [Arguments] ${console}=cirros
376 [Documentation] Check if the session has been able to login to the VM instance
377 ${output} = Utils.Write Commands Until Expected Prompt id ${OS_SYSTEM_PROMPT}
378 BuiltIn.Should Contain ${output} ${console}
381 [Documentation] Check if the session has been able to login to the VM instance and exit the instance
382 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance cirros
383 BuiltIn.Run Keyword If ${rcode} DevstackUtils.Write Commands Until Prompt exit
386 [Arguments] ${ip_address} ${ttl}=64
387 [Documentation] Run Ping command on the IP available as argument
388 ${ethertype} = String.Get Regexp Matches ${ip_address} ${IP_REGEX}
389 ${output} = BuiltIn.Run Keyword If ${ethertype} Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
390 ... ELSE Utils.Write Commands Until Expected Prompt ping6 -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
391 BuiltIn.Should Contain ${output} 64 bytes
394 [Arguments] ${ip_address} ${ttl}=64
395 [Documentation] Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
396 ${output} = Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
397 BuiltIn.Should Not Contain ${output} 64 bytes
399 Check Metadata Access
400 [Documentation] Try curl on the Metadataurl and check if it is okay
401 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
402 BuiltIn.Should Contain ${output} 200
404 Execute Command on VM Instance
405 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=cirros ${password}=cubswin:)
406 [Documentation] Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
407 OpenStackOperations.Get ControlNode Connection
408 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
409 ${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:
410 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
411 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
412 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT}
413 [Teardown] Exit From Vm Console
416 Test Operations From Vm Instance
417 [Arguments] ${net_name} ${src_ip} ${dest_ips} ${user}=cirros ${password}=cubswin:) ${ttl}=64
418 ... ${ping_should_succeed}=True ${check_metadata}=True
419 [Documentation] Login to the vm instance using ssh in the network.
420 OpenStackOperations.Get ControlNode Connection
421 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
422 ${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:
423 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
424 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
425 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ifconfig ${OS_SYSTEM_PROMPT}
426 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -n ${OS_SYSTEM_PROMPT}
427 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -A inet6 ${OS_SYSTEM_PROMPT}
428 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt arp -an ${OS_SYSTEM_PROMPT}
429 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ip -f inet6 neigh show ${OS_SYSTEM_PROMPT}
430 : FOR ${dest_ip} IN @{dest_ips}
431 \ ${string_empty} = BuiltIn.Run Keyword And Return Status Should Be Empty ${dest_ip}
432 \ BuiltIn.Run Keyword If ${string_empty} Continue For Loop
433 \ BuiltIn.Run Keyword If ${rcode} and "${ping_should_succeed}" == "True" OpenStackOperations.Check Ping ${dest_ip} ttl=${ttl}
434 \ ... ELSE OpenStackOperations.Check No Ping ${dest_ip} ttl=${ttl}
435 ${ethertype} = String.Get Regexp Matches ${src_ip} ${IP_REGEX}
436 BuiltIn.Run Keyword If ${rcode} and "${check_metadata}" and ${ethertype} == "True" OpenStackOperations.Check Metadata Access
437 [Teardown] Exit From Vm Console
439 Test Netcat Operations From Vm Instance
440 [Arguments] ${net_name} ${vm_ip} ${dest_ip} ${additional_args}=${EMPTY} ${port}=12345 ${user}=cirros
441 ... ${password}=cubswin:)
442 [Documentation] Use Netcat to test TCP/UDP connections to the controller
443 ${client_data} BuiltIn.Set Variable Test Client Data
444 ${server_data} BuiltIn.Set Variable Test Server Data
445 OpenStackOperations.Get ControlNode Connection
446 ${output} = DevstackUtils.Write Commands Until Prompt And Log ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
447 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo netstat -nlap | grep ${port}
448 ${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}
449 BuiltIn.Log ${output}
450 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo route -n
451 BuiltIn.Log ${output}
452 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo arp -an
453 BuiltIn.Log ${output}
454 BuiltIn.Should Match Regexp ${nc_output} ${server_data}
457 [Arguments] ${list_of_external_dst_ips}
458 [Documentation] Check reachability with other network's instances.
459 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
460 : FOR ${dest_ip} IN @{list_of_external_dst_ips}
461 \ OpenStackOperations.Check Ping ${dest_ip}
464 [Arguments] ${router_name}
465 [Documentation] Create Router and Add Interface to the subnets.
466 ${output} = OpenStack CLI openstack router create ${router_name}
469 [Documentation] List Routers and return output with neutron client.
470 ${output} = OpenStack CLI openstack router list -f value
474 [Arguments] ${router_name} ${interface_name}
475 ${output} = OpenStack CLI openstack router add subnet ${router_name} ${interface_name}
477 Show Router Interface
478 [Arguments] ${router_name}
479 [Documentation] List Routers interface associated with given Router and return output with neutron client.
480 ${output} = OpenStack CLI openstack port list --router ${router_name} -f value
484 [Arguments] ${router_name} ${external_network_name}
485 ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name}
488 [Arguments] ${router_name} ${interface_name}
489 [Documentation] Remove Interface to the subnets.
490 ${output} = OpenStack CLI openstack router remove subnet ${router_name} ${interface_name}
493 [Arguments] ${router_name}
494 [Documentation] Remove external gateway from the router.
495 BuiltIn.Log openstack router unset ${router_name} --external-gateway
498 [Arguments] ${router_name} ${cmd}
499 [Documentation] Update the router with the command. Router name and command should be passed as argument.
500 ${output} = OpenStack CLI openstack router set ${router_name} ${cmd}
503 [Arguments] ${router_name} ${options}
504 [Documentation] Show information of a given router. Router name and optional fields should be sent as arguments.
505 ${output} = OpenStack CLI openstack router show ${router_name}
508 [Arguments] ${router_name}
509 [Documentation] Delete Router and Interface to the subnets.
510 ${output} = OpenStack CLI openstack router delete ${router_name}
512 Get DumpFlows And Ovsconfig
513 [Arguments] ${conn_id}
514 [Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
515 SSHLibrary.Switch Connection ${conn_id}
516 Utils.Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
517 Utils.Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
518 Utils.Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
519 Utils.Write Commands Until Expected Prompt arp -an ${DEFAULT_LINUX_PROMPT_STRICT}
520 ${nslist} = Utils.Write Commands Until Expected Prompt ip netns list | awk '{print $1}' ${DEFAULT_LINUX_PROMPT_STRICT}
521 @{lines} Split To Lines ${nslist} end=-1
522 : FOR ${line} IN @{lines}
523 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
524 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
525 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
526 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
527 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
528 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
529 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
530 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
531 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
533 Get ControlNode Connection
534 SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
535 [Return] ${OS_CNTL_CONN_ID}
538 [Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
539 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CNTL_CONN_ID}
540 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP1_CONN_ID}
541 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP2_CONN_ID}
543 Get Test Teardown Debugs
544 [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME}
545 OpenStackOperations.Get OvsDebugInfo
546 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_data_models}
547 Run Keyword If "${FAIL_ON_EXCEPTIONS}"=="True" KarafKeywords.Fail If Exceptions Found During Test ${test_name}
549 Get Test Teardown Debugs For SFC
550 [Arguments] ${test_name}=${TEST_NAME}
551 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_sfc_data_models}
554 [Arguments] @{vm_indices}
555 [Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
556 OpenStackOperations.Get ControlNode Connection
557 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns list
558 : FOR ${index} IN @{vm_indices}
559 \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
560 \ BuiltIn.Log ${output}
561 OpenStackOperations.List Nova VMs
562 OpenStackOperations.List Routers
563 OpenStackOperations.List Networks
564 OpenStackOperations.List Subnets
565 OpenStackOperations.List Ports
566 OpenStackOperations.List Security Groups
569 [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
570 ... credentials are already sourced
571 ${output} = OpenStack CLI openstack security group list
574 Neutron Security Group Show
575 [Arguments] ${SecurityGroupRuleName}
576 [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
577 ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
581 [Arguments] ${PortName}
582 [Documentation] Display the port configuration that belong to a given neutron port
583 ${output} = OpenStack CLI openstack port show ${PortName}
586 Neutron Security Group Create
587 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
588 [Documentation] Create a security group with specified name ,description & protocol value according to security group template
589 OpenStackOperations.Get ControlNode Connection
590 ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
591 ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
592 [Return] ${output} ${sgp_id}
594 Neutron Security Group Update
595 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
596 [Documentation] Updating security groups
597 ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
601 [Arguments] ${sg_name}
602 [Documentation] Delete Security group
603 ${output} = OpenStack CLI openstack security group delete ${sg_name}
605 Neutron Security Group Rule Create
606 [Arguments] ${Security_group_name} &{Kwargs}
607 [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]} ..."
608 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
609 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
610 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
611 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
612 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
613 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
614 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
615 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
616 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
617 ${cmd} = BuiltIn.Set Variable openstack security group rule create ${Security_group_name}
618 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
619 ... ELSE BuiltIn.Catenate ${cmd}
620 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --${direction}
621 ... ELSE BuiltIn.Catenate ${cmd}
622 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
623 ... ELSE BuiltIn.Catenate ${cmd}
624 ${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}
625 ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
626 ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}
627 ... ELSE BuiltIn.Catenate ${cmd}
628 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
629 ... ELSE BuiltIn.Catenate ${cmd}
630 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote-group ${remote_group_id}
631 ... ELSE BuiltIn.Catenate ${cmd}
632 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --src-ip ${remote_ip_prefix}
633 ... ELSE BuiltIn.Catenate ${cmd}
634 ${output} = OpenStack CLI ${cmd}
635 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
636 [Return] ${output} ${rule_id}
638 Neutron Security Group Rule Create Legacy Cli
639 [Arguments] ${Security_group_name} &{Kwargs}
640 [Documentation] Creates neutron security rule with neutron request with or without optional params, here security group name is mandatory args, rule with optional params can be created by passing the optional args values ex: direction=${INGRESS_EGRESS}, Then these optional params are BuiltIn.Catenated with mandatory args, example of usage: "OpenStack Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
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_prefix default=${None}
650 ${cmd} = BuiltIn.Set Variable neutron security-group-rule-create ${Security_group_name}
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 ${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_max}'!='None' BuiltIn.Catenate ${cmd} --port_range_max ${port_range_max}
658 ... ELSE BuiltIn.Catenate ${cmd}
659 ${cmd} = BuiltIn.Run Keyword If '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --port_range_min ${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_id ${remote_group_id}
664 ... ELSE BuiltIn.Catenate ${cmd}
665 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --remote_ip_prefix ${remote_ip_prefix}
666 ... ELSE BuiltIn.Catenate ${cmd}
667 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
668 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
669 BuiltIn.Log ${rule_id}
670 BuiltIn.Should Be True '${rc}' == '0'
671 [Return] ${output} ${rule_id}
673 Security Group Create Without Default Security Rules
674 [Arguments] ${sg_name} ${additional_args}=${EMPTY}
675 [Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
676 OpenStackOperations.Neutron Security Group Create ${sg_name} ${additional_args}
677 Delete All Security Group Rules ${sg_name}
679 Delete All Security Group Rules
680 [Arguments] ${sg_name}
681 [Documentation] Delete all security rules from a specified security group
682 ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
683 @{sg_rules} = String.Split String ${sg_rules_output} \n
684 : FOR ${rule} IN @{sg_rules}
685 \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
687 Create Allow All SecurityGroup
688 [Arguments] ${sg_name} ${ether_type}=IPv4
689 [Documentation] Allow all TCP/UDP/ICMP packets for this suite
690 OpenStackOperations.Neutron Security Group Create ${sg_name}
691 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
692 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
693 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
694 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
695 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
696 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
698 Create Neutron Port With Additional Params
699 [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
700 [Documentation] Create Port With given additional parameters
701 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
702 BuiltIn.Log ${output}
703 BuiltIn.Should Be True '${rc}' == '0'
704 ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
705 [Return] ${OUTPUT} ${port_id}
709 [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
710 ${macs} BuiltIn.Create List
711 : FOR ${port} IN @{ports}
712 \ ${mac} = OpenStackOperations.Get Port Mac ${port}
713 \ Collections.Append To List ${macs} ${mac}
717 [Arguments] ${port_name}
718 [Documentation] Keyword would return the IP of the ${port_name} received.
719 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
720 ${splitted_output} = String.Split String ${output} ${EMPTY}
721 ${port_ip} = Collections.Get from List ${splitted_output} 0
725 [Arguments] ${port_name}
726 [Documentation] Keyword would return the MAC ID of the ${port_name} received.
727 ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
728 ${splitted_output} = String.Split String ${output} ${EMPTY}
729 ${port_mac} = Collections.Get from List ${splitted_output} 0
733 [Arguments] ${bridge_name} ${intf_name} ${gw_name}
734 [Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
735 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
736 BuiltIn.Log ${l2gw_output}
737 [Return] ${l2gw_output}
740 [Arguments] ${bridge_name} ${gw_name} ${intf_name_1} ${intf_name_2}
741 [Documentation] Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
742 ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
744 [Return] ${l2gw_output}
746 Create L2Gateway Connection
747 [Arguments] ${gw_name} ${net_name}
748 [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
749 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
750 BuiltIn.Log ${l2gw_output}
751 BuiltIn.Should Be True '${rc}' == '0'
752 [Return] ${l2gw_output}
755 [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
756 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
757 BuiltIn.Should Be True '${rc}' == '0'
760 Get All L2Gateway Connection
761 [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
762 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
763 BuiltIn.Should Be True '${rc}' == '0'
768 [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
769 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
770 BuiltIn.Log ${output}
771 BuiltIn.Should Be True '${rc}' == '0'
775 [Arguments] ${l2gw_name}
776 [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
777 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
778 BuiltIn.Log ${output}
779 BuiltIn.Should Be True '${rc}' == '0'
780 ${splitted_output} = String.Split String ${output} ${EMPTY}
781 ${l2gw_id} = Collections.Get from List ${splitted_output} 0
784 Get L2gw Connection Id
785 [Arguments] ${l2gw_name}
786 [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
787 ${l2gw_id} = OpenStackOperations.Get L2gw Id ${l2gw_name}
788 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
789 BuiltIn.Should Be True '${rc}' == '0'
790 ${splitted_output} = String.Split String ${output} ${EMPTY}
791 ${splitted_output} = String.Split String ${output} ${EMPTY}
792 ${l2gw_conn_id} = Collections.Get from List ${splitted_output} 0
793 [Return] ${l2gw_conn_id}
795 Neutron Port List Rest
796 [Documentation] Keyword to get all ports details in Neutron (Using REST).
797 ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
798 BuiltIn.Log ${resp.content}
799 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
800 [Return] ${resp.content}
802 Get Neutron Port Rest
803 [Arguments] ${port_id}
804 [Documentation] Keyword to get the specific port details in Neutron (Using REST).
805 ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
806 BuiltIn.Log ${resp.content}
807 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
808 [Return] ${resp.content}
811 [Arguments] ${port_id} ${json_data}
812 [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
813 BuiltIn.Log ${json_data}
814 ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
815 BuiltIn.Log ${resp.content}
816 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
817 [Return] ${resp.content}
819 Create And Configure Security Group
820 [Arguments] ${sg-name}
821 [Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
822 OpenStackOperations.Neutron Security Group Create ${sg-name}
823 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
824 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
825 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
826 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
827 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
828 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
830 Add Security Group To VM
831 [Arguments] ${vm} ${sg}
832 [Documentation] Add the security group provided to the given VM.
833 ${output} = OpenStack CLI openstack server add security group ${vm} ${sg}
835 Remove Security Group From VM
836 [Arguments] ${vm} ${sg}
837 [Documentation] Remove the security group provided to the given VM.
838 OpenStackOperations.Get ControlNode Connection
839 ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
841 Create SFC Flow Classifier
842 [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${dest_port} ${neutron_src_port}
843 [Documentation] Create a flow classifier for SFC
844 ${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}
845 BuiltIn.Should Contain ${output} ${name}
848 Delete SFC Flow Classifier
850 [Documentation] Delete a SFC flow classifier
851 OpenStackOperations.Get ControlNode Connection
852 ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
856 [Arguments] ${name} ${port_in} ${port_out}
857 [Documentation] Creates a neutron port pair for SFC
858 OpenStackOperations.Get ControlNode Connection
859 ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
860 BuiltIn.Should Contain ${output} ${name}
865 [Documentation] Delete a SFC port pair
866 ${output} = OpenStack CLI openstack sfc port pair delete ${name}
869 Create SFC Port Pair Group
870 [Arguments] ${name} ${port_pair}
871 [Documentation] Creates a port pair group with a single port pair for SFC
872 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
873 BuiltIn.Should Contain ${output} ${name}
876 Create SFC Port Pair Group With Two Pairs
877 [Arguments] ${name} ${port_pair1} ${port_pair2}
878 [Documentation] Creates a port pair group with two port pairs for SFC
879 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
880 BuiltIn.Should Contain ${output} ${name}
883 Delete SFC Port Pair Group
885 [Documentation] Delete a SFC port pair group
886 OpenStackOperations.Get ControlNode Connection
887 ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
890 Create SFC Port Chain
891 [Arguments] ${name} ${pg1} ${pg2} ${fc}
892 [Documentation] Creates a port pair chain with two port groups and a singel classifier.
893 ${output} = OpenStack CLI openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
894 BuiltIn.Should Contain ${output} ${name}
897 Delete SFC Port Chain
899 [Documentation] Delete a SFC port chain
900 ${output} = OpenStack CLI openstack sfc port chain delete ${name}
904 [Arguments] ${vm_name}
905 [Documentation] Reboot NOVA VM
906 ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
907 BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
909 Remove RSA Key From KnownHosts
911 [Documentation] Remove RSA
912 OpenStackOperations.Get ControlNode Connection
913 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
914 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
915 ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
917 Wait For Routes To Propogate
918 [Arguments] ${networks} ${subnets}
919 [Documentation] Check propagated routes
920 OpenStackOperations.Get ControlNode Connection
921 : FOR ${INDEX} IN RANGE 0 1
922 \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
923 \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
924 \ ${length} = BuiltIn.Get Length ${is_ipv6}
925 \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
926 \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ${DEFAULT_LINUX_PROMPT_STRICT}
927 \ BuiltIn.Should Contain ${output} @{subnets}[${INDEX}]
930 [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
931 : FOR ${vm} IN @{vms}
932 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
933 : FOR ${port} IN @{ports}
934 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
935 : FOR ${subnet} IN @{subnets}
936 \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
937 : FOR ${network} IN @{networks}
938 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
939 : FOR ${sg} IN @{sgs}
940 \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
943 [Documentation] Get a list of different OpenStack resources that might be in use.
944 @{modules} = BuiltIn.Create List server port network subnet security group
945 ... security group rule
946 BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" Collections.Append To List ${modules} floating ip router
947 : FOR ${module} IN @{modules}
948 \ ${output} = OpenStack CLI openstack ${module} list
950 OpenStack CLI Get List
952 [Documentation] Return a json list from the output of an OpenStack command.
953 @{list} = BuiltIn.Create List
954 ${json} = OpenStack CLI ${cmd}
955 @{list} = RequestsLibrary.To Json ${json}
961 [Documentation] Run the given OpenStack ${cmd} and log the output.
962 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
963 BuiltIn.Log ${output}
964 BuiltIn.Should Be True '${rc}' == '0'
967 OpenStack CLI With No Log
969 [Documentation] Run the given OpenStack ${cmd} and do not log the output.
970 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
971 BuiltIn.Should Be True '${rc}' == '0'
974 OpenStack Cleanup All
975 [Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
976 ... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
977 @{fips} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack floating ip list -f json
978 ... ELSE BuiltIn.Create List @{EMPTY}
979 : FOR ${fip} IN @{fips}
980 \ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
981 @{vms} = OpenStack CLI Get List openstack server list -f json
982 : FOR ${vm} IN @{vms}
983 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
984 @{routers} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack router list -f json
985 ... ELSE BuiltIn.Create List @{EMPTY}
986 : FOR ${router} IN @{routers}
987 \ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
988 @{ports} = OpenStack CLI Get List openstack port list -f json
989 : FOR ${port} IN @{ports}
990 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
991 @{networks} = OpenStack CLI Get List openstack network list -f json
992 : FOR ${network} IN @{networks}
993 \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
994 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
995 @{security_groups} = OpenStack CLI Get List openstack security group list -f json
996 : FOR ${security_group} IN @{security_groups}
997 \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
1002 [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
1003 @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
1004 : FOR ${port} IN @{ports}
1005 \ ${subnet_id} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 0
1006 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
1007 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
1008 BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
1010 OpenStack Suite Setup
1011 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1012 SetupUtils.Setup_Utils_For_Setup_And_Teardown
1013 @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil
1014 Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All OFF ${loggers}
1015 DevstackUtils.Devstack Suite Setup
1016 @{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
1017 BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
1018 BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
1019 OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1021 OpenStack Suite Teardown
1022 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1023 ... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1024 ... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1025 ... benefit automatically.
1026 OpenStack Cleanup All
1027 OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
1028 SSHLibrary.Close All Connections
1029 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
1030 \ KarafKeywords.Issue Command On Karaf Console threads --list | wc -l ${ODL_SYSTEM_${i+1}_IP}
1032 Copy DHCP Files From Control Node
1033 [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
1034 ... after the subnet(s) are created and before the subnet(s) are deleted.
1035 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1036 ${dstdir} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
1037 OperatingSystem.Create Directory ${dstdir}
1038 OpenStackOperations.Get ControlNode Connection
1039 BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
1041 Is Feature Installed
1042 [Arguments] ${features}=none
1043 : FOR ${feature} IN @{features}
1044 \ ${status} ${output} BuiltIn.Run Keyword And Ignore Error BuiltIn.Should Contain ${CONTROLLERFEATURES} ${feature}
1045 \ Return From Keyword If "${status}" == "PASS" True
1048 Add OVS Logging On All OpenStack Nodes
1049 [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
1050 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CNTL_CONN_ID}
1051 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP1_CONN_ID}
1052 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP2_CONN_ID}
1054 Reset OVS Logging On All OpenStack Nodes
1055 [Documentation] Reset the OVS logging to all the OpenStack nodes
1056 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CNTL_CONN_ID}
1057 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP1_CONN_ID}
1058 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP2_CONN_ID}
1060 Start Packet Capture On Nodes
1061 [Arguments] ${tag} ${filter} @{ips}
1062 [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1063 ... The caller must pass the three arguments with a variable number of ips at the end,
1064 ... but ${EMPTY} can be used for the tag and filter.
1065 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1066 ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
1067 @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
1068 [Return] @{conn_ids}
1070 Stop Packet Capture On Nodes
1071 [Arguments] ${conn_ids}=@{EMPTY}
1072 Tcpdump.Stop Packet Capture on Nodes ${conn_ids}