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}
493 ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name}
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}
516 [Arguments] ${router_name}
517 [Documentation] Delete Router and Interface to the subnets.
518 ${output} = OpenStack CLI openstack router delete ${router_name}
520 Get DumpFlows And Ovsconfig
521 [Arguments] ${conn_id}
522 [Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
523 SSHLibrary.Switch Connection ${conn_id}
524 Utils.Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
525 Utils.Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
526 Utils.Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
527 Utils.Write Commands Until Expected Prompt arp -an ${DEFAULT_LINUX_PROMPT_STRICT}
528 ${nslist} = Utils.Write Commands Until Expected Prompt ip netns list | awk '{print $1}' ${DEFAULT_LINUX_PROMPT_STRICT}
529 @{lines} Split To Lines ${nslist} end=-1
530 : FOR ${line} IN @{lines}
531 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
532 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
533 \ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
534 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
535 Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
536 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
537 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
538 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
539 Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
541 Get ControlNode Connection
542 SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
543 [Return] ${OS_CNTL_CONN_ID}
546 [Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
547 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CNTL_CONN_ID}
548 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP1_CONN_ID}
549 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP2_CONN_ID}
551 Get Test Teardown Debugs
552 [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME}
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 Run Keyword If "${FAIL_ON_EXCEPTIONS}"=="True" KarafKeywords.Fail If Exceptions Found During Test ${test_name}
558 Get Test Teardown Debugs For SFC
559 [Arguments] ${test_name}=${TEST_NAME}
560 BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_sfc_data_models}
563 [Arguments] @{vm_indices}
564 [Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
565 OpenStackOperations.Get ControlNode Connection
566 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ip netns list
567 : FOR ${index} IN @{vm_indices}
568 \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
569 \ BuiltIn.Log ${output}
570 OpenStackOperations.List Nova VMs
571 OpenStackOperations.List Routers
572 OpenStackOperations.List Networks
573 OpenStackOperations.List Subnets
574 OpenStackOperations.List Ports
575 OpenStackOperations.List Security Groups
578 [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
579 ... credentials are already sourced
580 ${output} = OpenStack CLI openstack security group list
583 Neutron Security Group Show
584 [Arguments] ${SecurityGroupRuleName}
585 [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
586 ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
590 [Arguments] ${PortName}
591 [Documentation] Display the port configuration that belong to a given neutron port
592 ${output} = OpenStack CLI openstack port show ${PortName}
595 Neutron Security Group Create
596 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
597 [Documentation] Create a security group with specified name ,description & protocol value according to security group template
598 OpenStackOperations.Get ControlNode Connection
599 ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
600 ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
601 [Return] ${output} ${sgp_id}
603 Neutron Security Group Update
604 [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
605 [Documentation] Updating security groups
606 ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
610 [Arguments] ${sg_name}
611 [Documentation] Delete Security group
612 ${output} = OpenStack CLI openstack security group delete ${sg_name}
614 Neutron Security Group Rule Create
615 [Arguments] ${Security_group_name} &{Kwargs}
616 [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]} ..."
617 BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
618 ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
619 ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
620 ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
621 ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
622 ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
623 ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
624 ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
625 ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
626 ${cmd} = BuiltIn.Set Variable openstack security group rule create ${Security_group_name}
627 ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
628 ... ELSE BuiltIn.Catenate ${cmd}
629 ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --${direction}
630 ... ELSE BuiltIn.Catenate ${cmd}
631 ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
632 ... ELSE BuiltIn.Catenate ${cmd}
633 ${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}
634 ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
635 ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}
636 ... ELSE BuiltIn.Catenate ${cmd}
637 ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
638 ... ELSE BuiltIn.Catenate ${cmd}
639 ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote-group ${remote_group_id}
640 ... ELSE BuiltIn.Catenate ${cmd}
641 ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --src-ip ${remote_ip_prefix}
642 ... ELSE BuiltIn.Catenate ${cmd}
643 ${output} = OpenStack CLI ${cmd}
644 ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
645 [Return] ${output} ${rule_id}
647 Security Group Create Without Default Security Rules
648 [Arguments] ${sg_name} ${additional_args}=${EMPTY}
649 [Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
650 OpenStackOperations.Neutron Security Group Create ${sg_name} ${additional_args}
651 Delete All Security Group Rules ${sg_name}
653 Delete All Security Group Rules
654 [Arguments] ${sg_name}
655 [Documentation] Delete all security rules from a specified security group
656 ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
657 @{sg_rules} = String.Split String ${sg_rules_output} \n
658 : FOR ${rule} IN @{sg_rules}
659 \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
661 Create Allow All SecurityGroup
662 [Arguments] ${sg_name} ${ether_type}=IPv4 ${additional_args}=${EMPTY}
663 [Documentation] Allow all TCP/UDP/ICMP packets for this suite
664 OpenStackOperations.Neutron Security Group Create ${sg_name}
665 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
666 ... ${additional_args}
667 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
668 ... ${additional_args}
669 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp ${additional_args}
670 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp ${additional_args}
671 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
672 ... ${additional_args}
673 OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
674 ... ${additional_args}
676 Create Neutron Port With Additional Params
677 [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
678 [Documentation] Create Port With given additional parameters
679 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
680 BuiltIn.Log ${output}
681 BuiltIn.Should Be True '${rc}' == '0'
682 ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
683 [Return] ${OUTPUT} ${port_id}
687 [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
688 ${macs} BuiltIn.Create List
689 : FOR ${port} IN @{ports}
690 \ ${mac} = OpenStackOperations.Get Port Mac ${port}
691 \ Collections.Append To List ${macs} ${mac}
695 [Arguments] ${port_name}
696 [Documentation] Keyword would return the IP of the ${port_name} received.
697 ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
698 ${splitted_output} = String.Split String ${output} ${EMPTY}
699 ${port_ip} = Collections.Get from List ${splitted_output} 0
703 [Arguments] ${port_name}
704 [Documentation] Keyword would return the MAC ID of the ${port_name} received.
705 ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
706 ${splitted_output} = String.Split String ${output} ${EMPTY}
707 ${port_mac} = Collections.Get from List ${splitted_output} 0
710 Get Port Mac Address From Ip
712 [Documentation] Retrieve the mac address for a port that matches any given ip.
713 ${output} = OpenStack CLI openstack port list | grep -w ${ip} | awk '{print $5}'
714 ${splitted_output} = String.Split String ${output} ${EMPTY}
715 ${mac_addr} = Collections.Get from List ${splitted_output} 0
719 [Arguments] ${bridge_name} ${intf_name} ${gw_name}
720 [Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
721 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
722 BuiltIn.Log ${l2gw_output}
723 [Return] ${l2gw_output}
726 [Arguments] ${bridge_name} ${gw_name} ${intf_name_1} ${intf_name_2}
727 [Documentation] Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
728 ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
730 [Return] ${l2gw_output}
732 Create L2Gateway Connection
733 [Arguments] ${gw_name} ${net_name}
734 [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
735 ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
736 BuiltIn.Log ${l2gw_output}
737 BuiltIn.Should Be True '${rc}' == '0'
738 [Return] ${l2gw_output}
741 [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
742 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
743 BuiltIn.Should Be True '${rc}' == '0'
746 Get All L2Gateway Connection
747 [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
748 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
749 BuiltIn.Should Be True '${rc}' == '0'
754 [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
755 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
756 BuiltIn.Log ${output}
757 BuiltIn.Should Be True '${rc}' == '0'
761 [Arguments] ${l2gw_name}
762 [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
763 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
764 BuiltIn.Log ${output}
765 BuiltIn.Should Be True '${rc}' == '0'
766 ${splitted_output} = String.Split String ${output} ${EMPTY}
767 ${l2gw_id} = Collections.Get from List ${splitted_output} 0
770 Get L2gw Connection Id
771 [Arguments] ${l2gw_name}
772 [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
773 ${l2gw_id} = OpenStackOperations.Get L2gw Id ${l2gw_name}
774 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
775 BuiltIn.Should Be True '${rc}' == '0'
776 ${splitted_output} = String.Split String ${output} ${EMPTY}
777 ${splitted_output} = String.Split String ${output} ${EMPTY}
778 ${l2gw_conn_id} = Collections.Get from List ${splitted_output} 0
779 [Return] ${l2gw_conn_id}
781 Neutron Port List Rest
782 [Documentation] Keyword to get all ports details in Neutron (Using REST).
783 ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
784 BuiltIn.Log ${resp.content}
785 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
786 [Return] ${resp.content}
788 Get Neutron Port Rest
789 [Arguments] ${port_id}
790 [Documentation] Keyword to get the specific port details in Neutron (Using REST).
791 ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
792 BuiltIn.Log ${resp.content}
793 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
794 [Return] ${resp.content}
797 [Arguments] ${port_id} ${json_data}
798 [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
799 BuiltIn.Log ${json_data}
800 ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
801 BuiltIn.Log ${resp.content}
802 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
803 [Return] ${resp.content}
805 Get Neutron Network Rest
806 [Arguments] ${net_id}
807 [Documentation] Keyword to get the specific network details in Neutron (Using REST).
808 ${resp} = RequestsLibrary.Get Request session ${NETWORK_URL}/network/${net_id}
809 BuiltIn.Log ${resp.content}
810 BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
811 [Return] ${resp.content}
813 Create And Configure Security Group
814 [Arguments] ${sg-name}
815 [Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
816 OpenStackOperations.Neutron Security Group Create ${sg-name}
817 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
818 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
819 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
820 OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
821 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
822 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
824 Add Security Group To VM
825 [Arguments] ${vm} ${sg}
826 [Documentation] Add the security group provided to the given VM.
827 ${output} = OpenStack CLI openstack server add security group ${vm} ${sg}
829 Remove Security Group From VM
830 [Arguments] ${vm} ${sg}
831 [Documentation] Remove the security group provided to the given VM.
832 OpenStackOperations.Get ControlNode Connection
833 ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
835 Create SFC Flow Classifier
836 [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${dest_port} ${neutron_src_port}
837 [Documentation] Create a flow classifier for SFC
838 ${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}
839 BuiltIn.Should Contain ${output} ${name}
842 Delete SFC Flow Classifier
844 [Documentation] Delete a SFC flow classifier
845 OpenStackOperations.Get ControlNode Connection
846 ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
850 [Arguments] ${name} ${port_in} ${port_out}
851 [Documentation] Creates a neutron port pair for SFC
852 OpenStackOperations.Get ControlNode Connection
853 ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
854 BuiltIn.Should Contain ${output} ${name}
859 [Documentation] Delete a SFC port pair
860 ${output} = OpenStack CLI openstack sfc port pair delete ${name}
863 Create SFC Port Pair Group
864 [Arguments] ${name} ${port_pair}
865 [Documentation] Creates a port pair group with a single port pair for SFC
866 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
867 BuiltIn.Should Contain ${output} ${name}
870 Create SFC Port Pair Group With Two Pairs
871 [Arguments] ${name} ${port_pair1} ${port_pair2}
872 [Documentation] Creates a port pair group with two port pairs for SFC
873 ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
874 BuiltIn.Should Contain ${output} ${name}
877 Delete SFC Port Pair Group
879 [Documentation] Delete a SFC port pair group
880 OpenStackOperations.Get ControlNode Connection
881 ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
884 Create SFC Port Chain
885 [Arguments] ${name} ${pg1} ${pg2} ${fc}
886 [Documentation] Creates a port pair chain with two port groups and a singel classifier.
887 ${output} = OpenStack CLI openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
888 BuiltIn.Should Contain ${output} ${name}
891 Delete SFC Port Chain
893 [Documentation] Delete a SFC port chain
894 ${output} = OpenStack CLI openstack sfc port chain delete ${name}
898 [Arguments] ${vm_name}
899 [Documentation] Reboot NOVA VM
900 ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
901 BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
903 Remove RSA Key From KnownHosts
905 [Documentation] Remove RSA
906 OpenStackOperations.Get ControlNode Connection
907 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
908 ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
909 ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
911 Wait For Routes To Propogate
912 [Arguments] ${networks} ${subnets}
913 [Documentation] Check propagated routes
914 OpenStackOperations.Get ControlNode Connection
915 : FOR ${INDEX} IN RANGE 0 1
916 \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
917 \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
918 \ ${length} = BuiltIn.Get Length ${is_ipv6}
919 \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
920 \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ${DEFAULT_LINUX_PROMPT_STRICT}
921 \ BuiltIn.Should Contain ${output} @{subnets}[${INDEX}]
924 [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
925 : FOR ${vm} IN @{vms}
926 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
927 : FOR ${port} IN @{ports}
928 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
929 : FOR ${subnet} IN @{subnets}
930 \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
931 : FOR ${network} IN @{networks}
932 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
933 : FOR ${sg} IN @{sgs}
934 \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
937 [Documentation] Get a list of different OpenStack resources that might be in use.
938 @{modules} = BuiltIn.Create List server port network subnet security group
939 ... security group rule
940 BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" Collections.Append To List ${modules} floating ip router
941 : FOR ${module} IN @{modules}
942 \ ${output} = OpenStack CLI openstack ${module} list
944 OpenStack CLI Get List
946 [Documentation] Return a json list from the output of an OpenStack command.
947 @{list} = BuiltIn.Create List
948 ${json} = OpenStack CLI ${cmd}
949 @{list} = RequestsLibrary.To Json ${json}
955 [Documentation] Run the given OpenStack ${cmd} and log the output.
956 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
957 BuiltIn.Log ${output}
958 BuiltIn.Should Be True '${rc}' == '0'
961 OpenStack CLI With No Log
963 [Documentation] Run the given OpenStack ${cmd} and do not log the output.
964 ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
965 BuiltIn.Should Be True '${rc}' == '0'
968 OpenStack Cleanup All
969 [Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
970 ... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
971 @{fips} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack floating ip list -f json
972 ... ELSE BuiltIn.Create List @{EMPTY}
973 : FOR ${fip} IN @{fips}
974 \ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
975 @{vms} = OpenStack CLI Get List openstack server list -f json
976 : FOR ${vm} IN @{vms}
977 \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
978 @{routers} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack router list -f json
979 ... ELSE BuiltIn.Create List @{EMPTY}
980 : FOR ${router} IN @{routers}
981 \ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
982 @{ports} = OpenStack CLI Get List openstack port list -f json
983 : FOR ${port} IN @{ports}
984 \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
985 @{networks} = OpenStack CLI Get List openstack network list -f json
986 : FOR ${network} IN @{networks}
987 \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
988 \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
989 @{security_groups} = OpenStack CLI Get List openstack security group list -f json
990 : FOR ${security_group} IN @{security_groups}
991 \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
996 [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
997 @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
998 : FOR ${port} IN @{ports}
999 \ ${subnet_id} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 0
1000 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
1001 \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
1002 BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
1004 OpenStack Suite Setup
1005 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1006 SetupUtils.Setup_Utils_For_Setup_And_Teardown
1007 @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil org.apache.sshd.server.session.ServerSessionImpl
1008 Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All OFF ${loggers}
1009 DevstackUtils.Devstack Suite Setup
1010 @{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
1011 BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
1012 BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
1013 OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1014 ClusterManagement.Dump_Local_Shards_For_Each_Member
1016 OpenStack Suite Teardown
1017 [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
1018 ... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1019 ... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1020 ... benefit automatically.
1021 OpenStack Cleanup All
1022 OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
1023 SSHLibrary.Close All Connections
1024 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
1025 \ KarafKeywords.Issue Command On Karaf Console threads --list | wc -l ${ODL_SYSTEM_${i+1}_IP}
1027 Copy DHCP Files From Control Node
1028 [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
1029 ... after the subnet(s) are created and before the subnet(s) are deleted.
1030 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1031 ${dstdir} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
1032 OperatingSystem.Create Directory ${dstdir}
1033 OpenStackOperations.Get ControlNode Connection
1034 BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
1036 Is Feature Installed
1037 [Arguments] ${features}=none
1038 : FOR ${feature} IN @{features}
1039 \ ${status} ${output} BuiltIn.Run Keyword And Ignore Error BuiltIn.Should Contain ${CONTROLLERFEATURES} ${feature}
1040 \ Return From Keyword If "${status}" == "PASS" True
1043 Add OVS Logging On All OpenStack Nodes
1044 [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
1045 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CNTL_CONN_ID}
1046 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP1_CONN_ID}
1047 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP2_CONN_ID}
1049 Reset OVS Logging On All OpenStack Nodes
1050 [Documentation] Reset the OVS logging to all the OpenStack nodes
1051 BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CNTL_CONN_ID}
1052 BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP1_CONN_ID}
1053 BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP2_CONN_ID}
1055 Start Packet Capture On Nodes
1056 [Arguments] ${tag} ${filter} @{ips}
1057 [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1058 ... The caller must pass the three arguments with a variable number of ips at the end,
1059 ... but ${EMPTY} can be used for the tag and filter.
1060 ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1061 ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
1062 @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
1063 [Return] @{conn_ids}
1065 Stop Packet Capture On Nodes
1066 [Arguments] ${conn_ids}=@{EMPTY}
1067 Tcpdump.Stop Packet Capture on Nodes ${conn_ids}
1070 [Arguments] ${vm_instance_name}
1071 [Documentation] Keyword for live migration of VM instance
1072 ... additional_agrs is to select particular migration(live/shared-migration/block-migration)
1073 ... if the additional_agrs is not given default migration(shared-migration) will happen
1074 ${output} = OpenStackOperations.OpenStack CLI nova live-migration ${vm_instance_name}
1076 Get Hypervisor Host Of Vm
1077 [Arguments] ${vm_name}
1078 [Documentation] Show server with neutron request.
1079 ${output} = OpenStackOperations.OpenStack CLI openstack server show -f value -c OS-EXT-SRV-ATTR:host ${vm_name}
1082 Check If Migration Is Complete
1083 [Arguments] ${vm_name}
1084 [Documentation] Show server and verify if task_state is not migrating
1085 ${output} = OpenStackOperations.OpenStack CLI openstack server show ${vm_name} | grep "OS-EXT-STS:task_state"
1086 BuiltIn.Should Not Contain ${output} migrating
1088 Modify OpenStack Configuration File
1089 [Arguments] ${conn_id} ${file_name} ${section} ${key} ${value}
1090 [Documentation] Use crudini to modify any parameter in any Openstack configuration File
1091 SSHLibrary.Switch Connection ${conn_id}
1092 ${output} ${rc} = SSHLibrary.Execute Command sudo crudini --verbose --set --inplace ${file_name} ${section} ${key} ${value} return_rc=True return_stdout=True
1093 BuiltIn.Log ${output}
1094 BuiltIn.Should Be True '${rc}' == '0'
1096 Restart DevStack Service
1097 [Arguments] ${conn_id} ${service_name}
1098 [Documentation] Restart the Openstack Service
1099 SSHLibrary.Switch Connection ${conn_id}
1100 ${output} ${rc} = SSHLibrary.Execute Command sudo systemctl restart devstack@${service_name}.service return_rc=True return_stdout=True
1101 BuiltIn.Log ${output}
1102 BuiltIn.Should Be True '${rc}' == '0'
1104 Get Network Segmentation Id
1105 [Arguments] ${network_name}
1106 [Documentation] Returns network segmentation id for the given network name.
1107 ${output} = OpenStack CLI openstack network show ${network_name} | grep segmentation_id | awk '{print $4}'
1108 @{list} = String.Split String ${output}
1112 [Arguments] ${project_name}
1113 [Documentation] Returns project ID for the given project name.
1114 ${project_id} = OpenStack CLI openstack project show ${project_name} -f value -c id
1115 [Return] ${project_id}
1117 Set Instance Quota For Project
1118 [Arguments] ${num_instances} ${project_id}
1119 [Documentation] Set quota for the created instances using the specific project id.
1120 ${output} = OpenStack CLI openstack quota set --instances ${num_instances} ${project_id}