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
12 Resource ODLTools.robot
14 Resource SetupUtils.robot
15 Resource SSHKeywords.robot
16 Resource Tcpdump.robot
18 Resource ../variables/Variables.robot
19 Resource ../variables/netvirt/Variables.robot
20 Variables ../variables/netvirt/Modules.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] ${portname}
187 [Documentation] Retrieve the first 10 chars of the UUID for the given port name
188 ${port_id} = OpenStackOperations.Get Port Id ${portname}
189 ${output} = String.Get Regexp Matches ${port_id} \\w{8}-\\w{2}
190 ${subport_id} = Collections.Get from List ${output} 0
191 [Return] ${subport_id}
194 [Arguments] ${router1}
195 [Documentation] Retrieve the router id for the given router name
196 ${output} = OpenStack CLI openstack router show "${router1}" |awk '/ id / {print $4}'
197 ${splitted_output} = String.Split String ${output} ${EMPTY}
198 ${router_id} = Collections.Get from List ${splitted_output} 0
199 [Return] ${router_id}
202 [Arguments] ${net_name} ${vm_instance_names} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default ${min}=1
204 [Documentation] Create X Vm Instance with the net id of the Netowrk.
205 ${image} BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
206 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
207 : FOR ${vm} IN @{vm_instance_names}
208 \ ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
210 Create Vm Instance On Compute Node
211 [Arguments] ${net_name} ${vm_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
212 [Documentation] Create a VM instance on a specific compute node.
213 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
214 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
215 ${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}
217 Create Vm Instance With Port
218 [Arguments] ${port_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
219 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
220 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
221 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
222 ${output} = OpenStack CLI openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-group ${sg}
224 Create Vm Instance With Ports
225 [Arguments] ${port_name} ${port2_name} ${vm_instance_name} ${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 ${port2_id} = OpenStackOperations.Get Port Id ${port2_name}
230 ${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}
232 Create Vm Instance With Port On Compute Node
233 [Arguments] ${port_name} ${vm_instance_name} ${node_hostname} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
234 [Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
235 ${image} = BuiltIn.Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
236 ${port_id} = OpenStackOperations.Get Port Id ${port_name}
237 ${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}
239 Get Hypervisor Hostname From IP
240 [Arguments] ${hypervisor_ip}
241 [Documentation] Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
242 ... the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
243 ${output} = OpenStack CLI openstack hypervisor list
244 ${hostname} = OpenStack CLI openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
248 [Documentation] Create a nano flavor
249 ${output} = OpenStack CLI openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
252 [Arguments] ${vm_name}
253 [Documentation] Run these commands to check whether the created vm instance is active or not.
254 ${output} = OpenStack CLI openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
255 BuiltIn.Should Contain ${output} active
258 [Arguments] ${vm_name} ${retry}=600s ${retry_interval}=30s
259 [Documentation] Run these commands to check whether the created vm instance is active or not.
260 BuiltIn.Wait Until Keyword Succeeds ${retry} ${retry_interval} OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
263 [Arguments] ${text} ${regexp} ${index}=0
264 [Documentation] Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
265 @{matches} = String.Get Regexp Matches ${text} ${regexp}
266 ${matches_length} = BuiltIn.Get Length ${matches}
267 BuiltIn.Set Suite Variable ${OS_MATCH} None
268 BuiltIn.Run Keyword If ${matches_length} > ${index} BuiltIn.Set Suite Variable ${OS_MATCH} @{matches}[${index}]
272 [Arguments] ${fail_on_none} ${vm}
273 [Documentation] Get the vm ip address and nameserver by scraping the vm's console log.
274 ... Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
275 ${vm_console_output} = OpenStack CLI With No Log openstack console log show ${vm}
276 ${vm_ip} = BuiltIn.Set Variable None
277 ${dhcp_ip} = BuiltIn.Set Variable None
278 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_OBTAINED}
279 ${vm_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 0
280 ${match} = OpenStackOperations.Get Match ${vm_console_output} ${REGEX_IPROUTE}
281 ${dhcp_ip} = OpenStackOperations.Get Match ${match} ${REGEX_IPV4} 1
282 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${vm_ip} None
283 BuiltIn.Run Keyword If '${fail_on_none}' == 'true' BuiltIn.Should Not Contain ${dhcp_ip} None
284 [Return] ${vm_ip} ${dhcp_ip} ${vm_console_output}
288 [Documentation] Get the instance IP addresses and nameserver address for the list of given vms.
289 ... First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
290 ... Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
291 ... of None) and [1] the dhcp ip address found in the last vm checked.
292 ... TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
293 ... may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
294 @{vm_ips} BuiltIn.Create List @{EMPTY}
295 : FOR ${vm} IN @{vms}
296 \ OpenStackOperations.Poll VM Is ACTIVE ${vm}
297 \ ${status} ${ips_and_console_log} BuiltIn.Run Keyword And Ignore Error BuiltIn.Wait Until Keyword Succeeds 180s 15s
298 \ ... OpenStackOperations.Get VM IP true ${vm}
299 \ # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
300 \ # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
301 \ # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
302 \ # the vm ip list if status is FAIL.
303 \ BuiltIn.Run Keyword If "${status}" == "PASS" BuiltIn.Log ${ips_and_console_log[2]}
304 \ BuiltIn.Run Keyword If "${status}" == "PASS" Collections.Append To List ${vm_ips} ${ips_and_console_log[0]}
305 \ BuiltIn.Run Keyword If "${status}" == "FAIL" Collections.Append To List ${vm_ips} None
306 \ ${vm_console_output} = BuiltIn.Run Keyword If "${status}" == "FAIL" OpenStack CLI openstack console log show ${vm}
307 \ BuiltIn.Run Keyword If "${status}" == "FAIL" BuiltIn.Log ${vm_console_output}
308 OpenStackOperations.Copy DHCP Files From Control Node
309 [Return] @{vm_ips} ${ips_and_console_log[1]}
311 Get Subnet Gateway Ip
312 [Arguments] ${subnet_name}
313 [Documentation] Show information of a subnet and grep for subnet gateway ip address
314 ${output} = OpenStackOperations.OpenStack CLI openstack subnet show ${subnet_name} | grep gateway_ip | awk '{print $4}'
315 ${splitted_output} = String.Split String ${output} ${EMPTY}
316 ${matches} = Collections.Get Matches ${splitted_output} regexp=(\\d\.)+
317 ${subnet_gateway_ip} = String.Strip String ${matches[0]} characters=','
318 [Return] ${subnet_gateway_ip}
320 Collect VM IPv6 SLAAC Addresses
321 [Arguments] ${fail_on_none} ${vm_list} ${network} ${subnet}
322 [Documentation] For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
323 ... Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
324 ... obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
325 ... Returns an empty list if no IPv6 addresses found or if SSH connection fails.
326 ... Otherwise, returns a list of IPv6 addresses.
327 ${ipv6_list} = BuiltIn.Create List @{EMPTY}
328 : FOR ${vm} IN @{vm_list}
329 \ ${output} = OpenStack CLI openstack server show ${vm} -f shell
330 \ ${pattern} = String.Replace String ${subnet} ::/64 (:[a-f0-9]{,4}){,4}
331 \ @{vm_ipv6} = String.Get Regexp Matches ${output} ${pattern}
332 \ ${vm_ip_length} = BuiltIn.Get Length ${vm_ipv6}[0]
333 \ ${ipv6_data_from_vm} = BuiltIn.Run Keyword If ${vm_ip_length}>0 OpenStackOperations.Execute Command on VM Instance ${network} ${vm_ipv6[0]}
335 \ @{ipv6} = String.Get Regexp Matches ${ipv6_data_from_vm} ${pattern}
336 \ ${ipv6_addr_list_length} BuiltIn.Get Length @{ipv6}
337 \ BuiltIn.Run Keyword If ${ipv6_addr_list_length}>0 Collections.Append To List ${ipv6_list} ${ipv6[0]}
338 \ ... ELSE Collections.Append To List ${ipv6_list} None
339 [Return] ${ipv6_list}
342 [Arguments] ${vm_instance_names}
343 [Documentation] View Console log of the created vm instances using nova show.
344 : FOR ${vm} IN @{vm_instance_names}
345 \ ${output} = OpenStack CLI openstack server show ${vm}
346 \ ${output} = OpenStack CLI openstack console log show ${vm}
348 Ping Vm From DHCP Namespace
349 [Arguments] ${net_name} ${vm_ip}
350 [Documentation] Reach all Vm Instance with the net id of the Netowrk.
351 OpenStackOperations.Get ControlNode Connection
352 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
353 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
354 BuiltIn.Should Contain ${output} 64 bytes
356 Ping From DHCP Should Not Succeed
357 [Arguments] ${net_name} ${vm_ip}
358 [Documentation] Should Not Reach Vm Instance with the net id of the Netowrk.
359 Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
360 OpenStackOperations.Get ControlNode Connection
361 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
362 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
363 BuiltIn.Should Not Contain ${output} 64 bytes
365 Ping Vm From Control Node
366 [Arguments] ${vm_floating_ip} ${additional_args}=${EMPTY}
367 [Documentation] Ping VM floating IP from control node
368 OpenStackOperations.Get ControlNode Connection
369 ${output} = DevstackUtils.Write Commands Until Prompt And Log ping ${additional_args} -c 3 ${vm_floating_ip} 20s
370 BuiltIn.Should Contain ${output} 64 bytes
373 [Documentation] Ping to the expected destination ip.
374 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
375 DevstackUtils.Write Commands Until Prompt exit
376 BuiltIn.Should Contain ${output} 200
379 [Documentation] Exit the vm instance.
380 ${output} = DevstackUtils.Write Commands Until Prompt And Log exit
382 Check If Console Is VmInstance
383 [Arguments] ${console}=cirros
384 [Documentation] Check if the session has been able to login to the VM instance
385 ${output} = Utils.Write Commands Until Expected Prompt id ${OS_SYSTEM_PROMPT}
386 BuiltIn.Should Contain ${output} ${console}
389 [Documentation] Check if the session has been able to login to the VM instance and exit the instance
390 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance cirros
391 BuiltIn.Run Keyword If ${rcode} DevstackUtils.Write Commands Until Prompt exit
394 [Arguments] ${ip_address} ${ttl}=64
395 [Documentation] Run Ping command on the IP available as argument
396 ${ethertype} = String.Get Regexp Matches ${ip_address} ${IP_REGEX}
397 ${output} = BuiltIn.Run Keyword If ${ethertype} Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
398 ... ELSE Utils.Write Commands Until Expected Prompt ping6 -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
399 BuiltIn.Should Contain ${output} 64 bytes
402 [Arguments] ${ip_address} ${ttl}=64
403 [Documentation] Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
404 ${output} = Utils.Write Commands Until Expected Prompt ping -t ${ttl} -c 3 ${ip_address} ${OS_SYSTEM_PROMPT}
405 BuiltIn.Should Not Contain ${output} 64 bytes
407 Check Metadata Access
408 [Documentation] Try curl on the Metadataurl and check if it is okay
409 ${output} = Utils.Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
410 BuiltIn.Should Contain ${output} 200
412 Execute Command on VM Instance
413 [Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=cirros ${password}=cubswin:)
414 [Documentation] Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
415 OpenStackOperations.Get ControlNode Connection
416 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
417 ${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:
418 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
419 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
420 ${output} = BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT}
421 [Teardown] Exit From Vm Console
424 Test Operations From Vm Instance
425 [Arguments] ${net_name} ${src_ip} ${dest_ips} ${user}=cirros ${password}=cubswin:) ${ttl}=64
426 ... ${ping_should_succeed}=True ${check_metadata}=True
427 [Documentation] Login to the vm instance using ssh in the network.
428 OpenStackOperations.Get ControlNode Connection
429 ${net_id} = OpenStackOperations.Get Net Id ${net_name}
430 ${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:
431 ${output} = Utils.Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
432 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
433 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ifconfig ${OS_SYSTEM_PROMPT}
434 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -n ${OS_SYSTEM_PROMPT}
435 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt route -A inet6 ${OS_SYSTEM_PROMPT}
436 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt arp -an ${OS_SYSTEM_PROMPT}
437 BuiltIn.Run Keyword If ${rcode} Utils.Write Commands Until Expected Prompt ip -f inet6 neigh show ${OS_SYSTEM_PROMPT}
438 : FOR ${dest_ip} IN @{dest_ips}
439 \ ${string_empty} = BuiltIn.Run Keyword And Return Status Should Be Empty ${dest_ip}
440 \ BuiltIn.Run Keyword If ${string_empty} Continue For Loop
441 \ BuiltIn.Run Keyword If ${rcode} and "${ping_should_succeed}" == "True" OpenStackOperations.Check Ping ${dest_ip} ttl=${ttl}
442 \ ... ELSE OpenStackOperations.Check No Ping ${dest_ip} ttl=${ttl}
443 ${ethertype} = String.Get Regexp Matches ${src_ip} ${IP_REGEX}
444 BuiltIn.Run Keyword If ${rcode} and "${check_metadata}" and ${ethertype} == "True" OpenStackOperations.Check Metadata Access
445 [Teardown] Exit From Vm Console
447 Test Netcat Operations From Vm Instance
448 [Arguments] ${net_name} ${vm_ip} ${dest_ip} ${additional_args}=${EMPTY} ${port}=12345 ${user}=cirros
449 ... ${password}=cubswin:)
450 [Documentation] Use Netcat to test TCP/UDP connections to the controller
451 ${client_data} BuiltIn.Set Variable Test Client Data
452 ${server_data} BuiltIn.Set Variable Test Server Data
453 OpenStackOperations.Get ControlNode Connection
454 ${output} = DevstackUtils.Write Commands Until Prompt And Log ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
455 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo netstat -nlap | grep ${port}
456 ${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}
457 BuiltIn.Log ${output}
458 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo route -n
459 BuiltIn.Log ${output}
460 ${output} = OpenStackOperations.Execute Command on VM Instance ${net_name} ${vm_ip} sudo arp -an
461 BuiltIn.Log ${output}
462 BuiltIn.Should Match Regexp ${nc_output} ${server_data}
465 [Arguments] ${list_of_external_dst_ips}
466 [Documentation] Check reachability with other network's instances.
467 ${rcode} = BuiltIn.Run Keyword And Return Status OpenStackOperations.Check If Console Is VmInstance
468 : FOR ${dest_ip} IN @{list_of_external_dst_ips}
469 \ OpenStackOperations.Check Ping ${dest_ip}
472 [Arguments] ${router_name}
473 [Documentation] Create Router and Add Interface to the subnets.
474 ${output} = OpenStack CLI openstack router create ${router_name}
477 [Documentation] List Routers and return output with neutron client.
478 ${output} = OpenStack CLI openstack router list -f value
482 [Arguments] ${router_name} ${interface_name}
483 ${output} = OpenStack CLI openstack router add subnet ${router_name} ${interface_name}
485 Show Router Interface
486 [Arguments] ${router_name}
487 [Documentation] List Routers interface associated with given Router and return output with neutron client.
488 ${output} = OpenStack CLI openstack port list --router ${router_name} -f value
492 [Arguments] ${router_name} ${external_network_name} ${additional_args}=${EMPTY}
493 ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name} ${additional_args}
496 [Arguments] ${router_name} ${interface_name}
497 [Documentation] Remove Interface to the subnets.
498 ${output} = OpenStack CLI openstack router remove subnet ${router_name} ${interface_name}
501 [Arguments] ${router_name}
502 [Documentation] Remove external gateway from the router.
503 BuiltIn.Log openstack router unset ${router_name} --external-gateway
506 [Arguments] ${router_name} ${cmd}
507 [Documentation] Update the router with the command. Router name and command should be passed as argument.
508 ${output} = OpenStack CLI openstack router set ${router_name} ${cmd}
511 [Arguments] ${router_name} ${options}
512 [Documentation] Show information of a given router. Router name and optional fields should be sent as arguments.
513 ${output} = OpenStack CLI openstack router show ${router_name}
517 [Arguments] ${router_name}
518 [Documentation] Delete Router and Interface to the subnets.
519 ${output} = OpenStack CLI openstack router delete ${router_name}
521 Get DumpFlows And Ovsconfig
522 [Arguments] ${conn_id}
523 [Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
524 SSHLibrary.Switch Connection ${conn_id}
525 Utils.Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
526 Utils.Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
527 Utils.Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
528 Utils.Write Commands Until Expected Prompt arp -an ${DEFAULT_LINUX_PROMPT_STRICT}
529 ${nslist} = Utils.Write Commands Until Expected Prompt ip netns list | awk '{print $1}' ${DEFAULT_LINUX_PROMPT_STRICT}
530 @{lines} Split To Lines ${nslist} end=-1
531 : FOR ${line} IN @{lines}
532 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
533 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
534 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
535 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
536 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
537 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
538 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
539 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
540 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
542 Get ControlNode Connection
543 SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
544 [Return] ${OS_CNTL_CONN_ID}
547 [Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
548 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
549 \ OpenStackOperations.Get DumpFlows And Ovsconfig ${conn_id}
551 Get Test Teardown Debugs
552 [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME} ${fail}=${FAIL_ON_EXCEPTIONS}
553 OpenStackOperations.Get OvsDebugInfo
554 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_data_models}
555 BuiltIn.run Keyword And Ignore Error ODLTools.Get EOS ${HA_PROXY_IP}
556 KarafKeywords.Fail If Exceptions Found During Test ${test_name} fail=${fail}
559 Get Test Teardown Debugs test_name=${SUITE_NAME} fail=False
561 Get Test Teardown Debugs For SFC
562 [Arguments] ${test_name}=${TEST_NAME}
563 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_sfc_data_models}
566 [Arguments] @{vm_indices}
567 [Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
568 OpenStackOperations.Get ControlNode Connection
569 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns list
570 : FOR ${index} IN @{vm_indices}
571 \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
572 \ BuiltIn.Log ${output}
573 OpenStackOperations.List Nova VMs
574 OpenStackOperations.List Routers
575 OpenStackOperations.List Networks
576 OpenStackOperations.List Subnets
577 OpenStackOperations.List Ports
578 OpenStackOperations.List Security Groups
581 [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
582 ... credentials are already sourced
583 ${output} = OpenStack CLI openstack security group list
586 Neutron Security Group Show
587 [Arguments] ${SecurityGroupRuleName}
588 [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
589 ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
593 [Arguments] ${PortName}
594 [Documentation] Display the port configuration that belong to a given neutron port
595 ${output} = OpenStack CLI openstack port show ${PortName}
598 Neutron Security Group Create
599 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
600 [Documentation] Create a security group with specified name ,description & protocol value according to security group template
601 OpenStackOperations.Get ControlNode Connection
602 ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
603 ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
604 [Return] ${output} ${sgp_id}
606 Neutron Security Group Update
607 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
608 [Documentation] Updating security groups
609 ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
613 [Arguments] ${sg_name}
614 [Documentation] Delete Security group
615 ${output} = OpenStack CLI openstack security group delete ${sg_name}
617 Neutron Security Group Rule Create
618 [Arguments] ${Security_group_name} &{Kwargs}
619 [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]} ..."
620 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
621 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
622 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
623 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
624 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
625 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
626 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
627 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
628 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
629 ${cmd} = BuiltIn.Set Variable openstack security group rule create ${Security_group_name}
630 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
631 ... ELSE BuiltIn.Catenate ${cmd}
632 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --${direction}
633 ... ELSE BuiltIn.Catenate ${cmd}
634 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
635 ... ELSE BuiltIn.Catenate ${cmd}
636 ${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}
637 ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
638 ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}
639 ... ELSE BuiltIn.Catenate ${cmd}
640 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
641 ... ELSE BuiltIn.Catenate ${cmd}
642 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote-group ${remote_group_id}
643 ... ELSE BuiltIn.Catenate ${cmd}
644 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --src-ip ${remote_ip_prefix}
645 ... ELSE BuiltIn.Catenate ${cmd}
646 ${output} = OpenStack CLI ${cmd}
647 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
648 [Return] ${output} ${rule_id}
650 Security Group Create Without Default Security Rules
651 [Arguments] ${sg_name} ${additional_args}=${EMPTY}
652 [Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
653 OpenStackOperations.Neutron Security Group Create ${sg_name} ${additional_args}
654 Delete All Security Group Rules ${sg_name}
656 Delete All Security Group Rules
657 [Arguments] ${sg_name}
658 [Documentation] Delete all security rules from a specified security group
659 ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
660 @{sg_rules} = String.Split String ${sg_rules_output} \n
661 : FOR ${rule} IN @{sg_rules}
662 \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
664 Create Allow All SecurityGroup
665 [Arguments] ${sg_name} ${ether_type}=IPv4
666 [Documentation] Allow all TCP/UDP/ICMP packets for this suite
667 OpenStackOperations.Neutron Security Group Create ${sg_name}
668 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
669 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
670 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
671 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
672 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
673 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
675 Create Neutron Port With Additional Params
676 [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
677 [Documentation] Create Port With given additional parameters
678 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
679 BuiltIn.Log ${output}
680 BuiltIn.Should Be True '${rc}' == '0'
681 ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
682 [Return] ${OUTPUT} ${port_id}
686 [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
687 ${macs} BuiltIn.Create List
688 : FOR ${port} IN @{ports}
689 \ ${mac} = OpenStackOperations.Get Port Mac ${port}
690 \ Collections.Append To List ${macs} ${mac}
694 [Arguments] ${port_name}
695 [Documentation] Keyword would return the IP of the ${port_name} received.
696 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
697 ${splitted_output} = String.Split String ${output} ${EMPTY}
698 ${port_ip} = Collections.Get from List ${splitted_output} 0
702 [Arguments] ${port_name}
703 [Documentation] Keyword would return the MAC ID of the ${port_name} received.
704 ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
705 ${splitted_output} = String.Split String ${output} ${EMPTY}
706 ${port_mac} = Collections.Get from List ${splitted_output} 0
709 Get Port Mac Address From Ip
711 [Documentation] Retrieve the mac address for a port that matches any given ip.
712 ${output} = OpenStack CLI openstack port list | grep -w ${ip} | awk '{print $5}'
713 ${splitted_output} = String.Split String ${output} ${EMPTY}
714 ${mac_addr} = Collections.Get from List ${splitted_output} 0
718 [Arguments] ${bridge_name} ${intf_name} ${gw_name}
719 [Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
720 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
721 BuiltIn.Log ${l2gw_output}
722 [Return] ${l2gw_output}
725 [Arguments] ${bridge_name} ${gw_name} ${intf_name_1} ${intf_name_2}
726 [Documentation] Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
727 ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
729 [Return] ${l2gw_output}
731 Create L2Gateway Connection
732 [Arguments] ${gw_name} ${net_name}
733 [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
734 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
735 BuiltIn.Log ${l2gw_output}
736 BuiltIn.Should Be True '${rc}' == '0'
737 [Return] ${l2gw_output}
740 [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
741 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
742 BuiltIn.Should Be True '${rc}' == '0'
745 Get All L2Gateway Connection
746 [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
747 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
748 BuiltIn.Should Be True '${rc}' == '0'
753 [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
754 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
755 BuiltIn.Log ${output}
756 BuiltIn.Should Be True '${rc}' == '0'
760 [Arguments] ${l2gw_name}
761 [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
762 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
763 BuiltIn.Log ${output}
764 BuiltIn.Should Be True '${rc}' == '0'
765 ${splitted_output} = String.Split String ${output} ${EMPTY}
766 ${l2gw_id} = Collections.Get from List ${splitted_output} 0
769 Get L2gw Connection Id
770 [Arguments] ${l2gw_name}
771 [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
772 ${l2gw_id} = OpenStackOperations.Get L2gw Id ${l2gw_name}
773 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
774 BuiltIn.Should Be True '${rc}' == '0'
775 ${splitted_output} = String.Split String ${output} ${EMPTY}
776 ${splitted_output} = String.Split String ${output} ${EMPTY}
777 ${l2gw_conn_id} = Collections.Get from List ${splitted_output} 0
778 [Return] ${l2gw_conn_id}
780 Neutron Port List Rest
781 [Documentation] Keyword to get all ports details in Neutron (Using REST).
782 ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
783 BuiltIn.Log ${resp.content}
784 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
785 [Return] ${resp.content}
787 Get Neutron Port Rest
788 [Arguments] ${port_id}
789 [Documentation] Keyword to get the specific port details in Neutron (Using REST).
790 ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
791 BuiltIn.Log ${resp.content}
792 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
793 [Return] ${resp.content}
796 [Arguments] ${port_id} ${json_data}
797 [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
798 BuiltIn.Log ${json_data}
799 ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
800 BuiltIn.Log ${resp.content}
801 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
802 [Return] ${resp.content}
804 Get Neutron Network Rest
805 [Arguments] ${net_id}
806 [Documentation] Keyword to get the specific network details in Neutron (Using REST).
807 ${resp} = RequestsLibrary.Get Request session ${NETWORK_URL}/network/${net_id}
808 BuiltIn.Log ${resp.content}
809 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
810 [Return] ${resp.content}
812 Create And Configure Security Group
813 [Arguments] ${sg-name}
814 [Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
815 OpenStackOperations.Neutron Security Group Create ${sg-name}
816 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
817 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
818 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
819 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
820 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
821 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
823 Add Security Group To VM
824 [Arguments] ${vm} ${sg}
825 [Documentation] Add the security group provided to the given VM.
826 ${output} = OpenStack CLI openstack server add security group ${vm} ${sg}
828 Remove Security Group From VM
829 [Arguments] ${vm} ${sg}
830 [Documentation] Remove the security group provided to the given VM.
831 OpenStackOperations.Get ControlNode Connection
832 ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
834 Create SFC Flow Classifier
835 [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${dest_port} ${neutron_src_port}
836 [Documentation] Create a flow classifier for SFC
837 ${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}
838 BuiltIn.Should Contain ${output} ${name}
841 Delete SFC Flow Classifier
843 [Documentation] Delete a SFC flow classifier
844 OpenStackOperations.Get ControlNode Connection
845 ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
849 [Arguments] ${name} ${port_in} ${port_out}
850 [Documentation] Creates a neutron port pair for SFC
851 OpenStackOperations.Get ControlNode Connection
852 ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
853 BuiltIn.Should Contain ${output} ${name}
858 [Documentation] Delete a SFC port pair
859 ${output} = OpenStack CLI openstack sfc port pair delete ${name}
862 Create SFC Port Pair Group
863 [Arguments] ${name} ${port_pair}
864 [Documentation] Creates a port pair group with a single port pair for SFC
865 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
866 BuiltIn.Should Contain ${output} ${name}
869 Create SFC Port Pair Group With Two Pairs
870 [Arguments] ${name} ${port_pair1} ${port_pair2}
871 [Documentation] Creates a port pair group with two port pairs for SFC
872 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
873 BuiltIn.Should Contain ${output} ${name}
876 Delete SFC Port Pair Group
878 [Documentation] Delete a SFC port pair group
879 OpenStackOperations.Get ControlNode Connection
880 ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
883 Create SFC Port Chain
884 [Arguments] ${name} ${pg1} ${pg2} ${fc}
885 [Documentation] Creates a port pair chain with two port groups and a singel classifier.
886 ${output} = OpenStack CLI openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
887 BuiltIn.Should Contain ${output} ${name}
890 Delete SFC Port Chain
892 [Documentation] Delete a SFC port chain
893 ${output} = OpenStack CLI openstack sfc port chain delete ${name}
897 [Arguments] ${vm_name}
898 [Documentation] Reboot NOVA VM
899 ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
900 BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
902 Remove RSA Key From KnownHosts
904 [Documentation] Remove RSA
905 OpenStackOperations.Get ControlNode Connection
906 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
907 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
908 ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
910 Wait For Routes To Propogate
911 [Arguments] ${networks} ${subnets}
912 [Documentation] Check propagated routes
913 OpenStackOperations.Get ControlNode Connection
914 : FOR ${INDEX} IN RANGE 0 1
915 \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
916 \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
917 \ ${length} = BuiltIn.Get Length ${is_ipv6}
918 \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
919 \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ${DEFAULT_LINUX_PROMPT_STRICT}
920 \ BuiltIn.Should Contain ${output} @{subnets}[${INDEX}]
923 [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
924 : FOR ${vm} IN @{vms}
925 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
926 : FOR ${port} IN @{ports}
927 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
928 : FOR ${subnet} IN @{subnets}
929 \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
930 : FOR ${network} IN @{networks}
931 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
932 : FOR ${sg} IN @{sgs}
933 \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
936 [Documentation] Get a list of different OpenStack resources that might be in use.
937 @{modules} = BuiltIn.Create List server port network subnet security group
938 ... security group rule floating ip router
939 : FOR ${module} IN @{modules}
940 \ ${output} = OpenStack CLI openstack ${module} list
942 OpenStack CLI Get List
944 [Documentation] Return a json list from the output of an OpenStack command.
945 @{list} = BuiltIn.Create List
946 ${json} = OpenStack CLI ${cmd}
947 @{list} = RequestsLibrary.To Json ${json}
953 [Documentation] Run the given OpenStack ${cmd} and log the output.
954 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
955 BuiltIn.Log ${output}
956 BuiltIn.Should Be True '${rc}' == '0'
959 OpenStack CLI With No Log
961 [Documentation] Run the given OpenStack ${cmd} and do not log the output.
962 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
963 BuiltIn.Should Be True '${rc}' == '0'
966 OpenStack Cleanup All
967 [Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
968 ... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
969 @{fips} = OpenStack CLI Get List openstack floating ip list -f json
970 : FOR ${fip} IN @{fips}
971 \ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
972 @{vms} = OpenStack CLI Get List openstack server list -f json
973 : FOR ${vm} IN @{vms}
974 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
975 @{routers} = OpenStack CLI Get List openstack router list -f json
976 : FOR ${router} IN @{routers}
977 \ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
978 @{ports} = OpenStack CLI Get List openstack port list -f json
979 : FOR ${port} IN @{ports}
980 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
981 @{networks} = OpenStack CLI Get List openstack network list -f json
982 : FOR ${network} IN @{networks}
983 \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
984 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
985 @{security_groups} = OpenStack CLI Get List openstack security group list -f json
986 : FOR ${security_group} IN @{security_groups}
987 \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
992 [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
993 @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
994 : FOR ${port} IN @{ports}
995 \ ${subnet_id} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 0
996 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
997 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
998 BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
1000 OpenStack Suite Setup
1001 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1002 SetupUtils.Setup_Utils_For_Setup_And_Teardown
1003 @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil org.apache.sshd.server.session.ServerSessionImpl
1004 Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All OFF ${loggers}
1005 DevstackUtils.Devstack Suite Setup
1006 @{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
1007 BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
1008 BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
1009 OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1010 Run_Keyword_If_At_Least_Oxygen Wait Until Keyword Succeeds 60 2 ClusterManagement.Check Status Of Services Is OPERATIONAL @{NETVIRT_DIAG_SERVICES}
1011 ClusterManagement.Dump_Local_Shards_For_Each_Member
1012 Verify Expected Default Tables On Nodes
1014 OpenStack Suite Teardown
1015 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1016 ... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1017 ... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1018 ... benefit automatically.
1019 # TODO: followup patch will add the list of vms to pass to Show Debugs
1020 # OpenStackOperations.Show Debugs @{NET_1_VMS} @{NET_2_VMS}
1021 OpenStackOperations.Get Suite Debugs
1022 OpenStack Cleanup All
1023 OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
1024 SSHLibrary.Close All Connections
1025 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
1026 \ KarafKeywords.Issue Command On Karaf Console threads --list | wc -l ${ODL_SYSTEM_${i+1}_IP}
1028 Copy DHCP Files From Control Node
1029 [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
1030 ... after the subnet(s) are created and before the subnet(s) are deleted.
1031 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1032 ${dstdir} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
1033 OperatingSystem.Create Directory ${dstdir}
1034 OpenStackOperations.Get ControlNode Connection
1035 BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
1037 Is Feature Installed
1038 [Arguments] ${features}=none
1039 : FOR ${feature} IN @{features}
1040 \ ${status} ${output} BuiltIn.Run Keyword And Ignore Error BuiltIn.Should Contain ${CONTROLLERFEATURES} ${feature}
1041 \ Return From Keyword If "${status}" == "PASS" True
1044 Add OVS Logging On All OpenStack Nodes
1045 [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
1046 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1047 \ OVSDB.Add OVS Logging ${conn_id}
1049 Reset OVS Logging On All OpenStack Nodes
1050 [Documentation] Reset the OVS logging to all the OpenStack nodes
1051 : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
1052 \ OVSDB.Reset OVS Logging ${conn_id}
1054 Start Packet Capture On Nodes
1055 [Arguments] ${tag} ${filter} @{ips}
1056 [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1057 ... The caller must pass the three arguments with a variable number of ips at the end,
1058 ... but ${EMPTY} can be used for the tag and filter.
1059 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1060 ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
1061 @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
1062 [Return] @{conn_ids}
1064 Stop Packet Capture On Nodes
1065 [Arguments] ${conn_ids}=@{EMPTY}
1066 Tcpdump.Stop Packet Capture on Nodes ${conn_ids}
1069 [Arguments] ${vm_instance_name}
1070 [Documentation] Keyword for live migration of VM instance
1071 ... additional_agrs is to select particular migration(live/shared-migration/block-migration)
1072 ... if the additional_agrs is not given default migration(shared-migration) will happen
1073 ${output} = OpenStackOperations.OpenStack CLI nova live-migration ${vm_instance_name}
1075 Get Hypervisor Host Of Vm
1076 [Arguments] ${vm_name}
1077 [Documentation] Show server with neutron request.
1078 ${output} = OpenStackOperations.OpenStack CLI openstack server show -f value -c OS-EXT-SRV-ATTR:host ${vm_name}
1081 Check If Migration Is Complete
1082 [Arguments] ${vm_name}
1083 [Documentation] Show server and verify if task_state is not migrating
1084 ${output} = OpenStackOperations.OpenStack CLI openstack server show ${vm_name} | grep "OS-EXT-STS:task_state"
1085 BuiltIn.Should Not Contain ${output} migrating
1087 Modify OpenStack Configuration File
1088 [Arguments] ${conn_id} ${file_name} ${section} ${key} ${value}
1089 [Documentation] Use crudini to modify any parameter in any Openstack configuration File
1090 SSHLibrary.Switch Connection ${conn_id}
1091 ${output} ${rc} = SSHLibrary.Execute Command sudo crudini --verbose --set --inplace ${file_name} ${section} ${key} ${value} return_rc=True return_stdout=True
1092 BuiltIn.Log ${output}
1093 BuiltIn.Should Be True '${rc}' == '0'
1095 Restart DevStack Service
1096 [Arguments] ${conn_id} ${service_name}
1097 [Documentation] Restart the Openstack Service
1098 SSHLibrary.Switch Connection ${conn_id}
1099 ${output} ${rc} = SSHLibrary.Execute Command sudo systemctl restart devstack@${service_name}.service return_rc=True return_stdout=True
1100 BuiltIn.Log ${output}
1101 BuiltIn.Should Be True '${rc}' == '0'
1103 Get Network Segmentation Id
1104 [Arguments] ${network_name}
1105 [Documentation] Returns network segmentation id for the given network name.
1106 ${output} = OpenStack CLI openstack network show ${network_name} | grep segmentation_id | awk '{print $4}'
1107 @{list} = String.Split String ${output}
1110 Verify Expected Default Tables On Nodes
1111 [Arguments] ${node_ips}=@{OS_ALL_IPS}
1112 [Documentation] Verify if Default Table Entries are programmed on all Nodes
1113 ${resp} = RequestsLibrary.Get Request session ${CONFIG_NODES_API}
1114 Utils.Log Content ${resp.content}
1115 ${failed_node_list} = BuiltIn.Create List
1116 : FOR ${node_ip} IN @{node_ips}
1117 \ ${failed_table_list} = Verify Expected Default Tables ${node_ip}
1118 \ ${failed_table_list_size} = BuiltIn.Get Length ${failed_table_list}
1119 \ BuiltIn.Run Keyword If ${failed_table_list_size} > 0 Collections.Append To List ${failed_node_list} ${node_ip}
1120 Builtin.Should Be Empty ${failed_node_list}
1122 Verify Expected Default Tables
1123 [Arguments] ${ovs_ip}
1124 [Documentation] Verify if Default Table Entries are programmed on specific Node
1125 ${flow_dump} = Utils.Run Command On Remote System ${ovs_ip} sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13
1126 BuiltIn.Log ${flow_dump}
1127 ${failed_table_list} = BuiltIn.Create List
1128 : FOR ${table} IN @{DEFAULT_FLOW_TABLES}
1129 \ ${rc} = Builtin.Run Keyword And Return Status Builtin.Should Not Match Regexp ${flow_dump} .*table=${table}.*priority=0
1130 \ BuiltIn.Run Keyword If ${rc} Collections.Append To List ${failed_table_list} ${table}
1131 [Return] ${failed_table_list}
1134 [Arguments] ${project_name}
1135 [Documentation] Returns project ID for the given project name.
1136 ${project_id} = OpenStack CLI openstack project show ${project_name} -f value -c id
1137 [Return] ${project_id}
1139 Set Instance Quota For Project
1140 [Arguments] ${num_instances} ${project_id}
1141 [Documentation] Set quota for the created instances using the specific project id.
1142 ${output} = OpenStack CLI openstack quota set --instances ${num_instances} ${project_id}