*** Settings ***
Documentation Openstack library. This library is useful for tests to create network, subnet, router and vm instances
Library Collections
-Library SSHLibrary
Library OperatingSystem
Library RequestsLibrary
+Library SSHLibrary
Resource DataModels.robot
-Resource Utils.robot
-Resource SSHKeywords.robot
+Resource DevstackUtils.robot
Resource L2GatewayOperations.robot
+Resource SetupUtils.robot
+Resource SSHKeywords.robot
+Resource Utils.robot
Resource ../variables/Variables.robot
Resource ../variables/netvirt/Variables.robot
Variables ../variables/netvirt/Modules.py
Log ${output}
Get Net Id
- [Arguments] ${network_name} ${devstack_conn_id}
+ [Arguments] ${network_name}
[Documentation] Retrieve the net id for the given network name to create specific vm instance
${rc} ${output}= Run And Return Rc And Output openstack network list | grep "${network_name}" | awk '{print $2}'
Should Be True '${rc}' == '0'
[Return] ${net_id}
Get Subnet Id
- [Arguments] ${subnet_name} ${devstack_conn_id}
+ [Arguments] ${subnet_name}
[Documentation] Retrieve the subnet id for the given subnet name
${rc} ${output}= Run And Return Rc And Output openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
Should Be True '${rc}' == '0'
[Return] ${subnet_id}
Get Port Id
- [Arguments] ${port_name} ${devstack_conn_id}
+ [Arguments] ${port_name}
[Documentation] Retrieve the port id for the given port name to attach specific vm instance to a particular port
${rc} ${output}= Run And Return Rc And Output openstack port list | grep "${port_name}" | awk '{print $2}'
Should Be True '${rc}' == '0'
[Return] ${port_id}
Get Router Id
- [Arguments] ${router1} ${devstack_conn_id}
+ [Arguments] ${router1}
[Documentation] Retrieve the router id for the given router name
${rc} ${output}= Run And Return Rc And Output openstack router list -f table | grep "${router1}" | awk '{print $2}'
Should Be True '${rc}' == '0'
... ${max}=1
[Documentation] Create X Vm Instance with the net id of the Netowrk.
${image} Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
- ${net_id}= Get Net Id ${net_name} ${devstack_conn_id}
+ ${net_id}= Get Net Id ${net_name}
: FOR ${VmElement} IN @{vm_instance_names}
\ ${rc} ${output}= Run And Return Rc And Output openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${VmElement} --security-group ${sg} --min ${min} --max ${max}
\ Should Be True '${rc}' == '0'
[Arguments] ${port_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
[Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
${image} Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
- ${port_id}= Get Port Id ${port_name} ${devstack_conn_id}
+ ${port_id}= Get Port Id ${port_name}
${rc} ${output}= Run And Return Rc And Output openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-group ${sg}
Log ${output}
[Arguments] ${port_name} ${port2_name} ${vm_instance_name} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
[Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
${image} Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
- ${port_id}= Get Port Id ${port_name} ${devstack_conn_id}
- ${port2_id}= Get Port Id ${port2_name} ${devstack_conn_id}
+ ${port_id}= Get Port Id ${port_name}
+ ${port2_id}= Get Port Id ${port2_name}
${rc} ${output}= Run And Return Rc And Output openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --nic port-id=${port2_id} ${vm_instance_name} --security-group ${sg}
Log ${output}
Should Be True '${rc}' == '0'
[Arguments] ${port_name} ${vm_instance_name} ${compute_node} ${image}=${EMPTY} ${flavor}=m1.nano ${sg}=default
[Documentation] Create One VM instance using given ${port_name} and for given ${compute_node}
${image} Set Variable If "${image}"=="${EMPTY}" ${CIRROS_${OPENSTACK_BRANCH}} ${image}
- ${port_id}= Get Port Id ${port_name} ${devstack_conn_id}
+ ${port_id}= Get Port Id ${port_name}
${hostname_compute_node}= Get Hypervisor Hostname From IP ${compute_node}
${rc} ${output}= Run And Return Rc And Output openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --security-group ${sg} --availability-zone nova:${hostname_compute_node} ${vm_instance_name}
Log ${output}
Ping Vm From DHCP Namespace
[Arguments] ${net_name} ${vm_ip}
[Documentation] Reach all Vm Instance with the net id of the Netowrk.
- Log ${vm_ip}
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
- ${net_id}= Get Net Id ${net_name} ${devstack_conn_id}
- Log ${net_id}
+ Get ControlNode Connection
+ ${net_id}= Get Net Id ${net_name}
${output}= Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
- Close Connection
Should Contain ${output} 64 bytes
Ping From DHCP Should Not Succeed
[Arguments] ${net_name} ${vm_ip}
[Documentation] Should Not Reach Vm Instance with the net id of the Netowrk.
Return From Keyword If "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
- Log ${vm_ip}
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
- ${net_id}= Get Net Id ${net_name} ${devstack_conn_id}
- Log ${net_id}
- ${output}= Write Commands Until Prompt sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
- Close Connection
- Log ${output}
+ Get ControlNode Connection
+ ${net_id}= Get Net Id ${net_name}
+ ${output}= Write Commands Until Prompt And Log sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip} 20s
Should Not Contain ${output} 64 bytes
Ping Vm From Control Node
[Arguments] ${vm_floating_ip} ${additional_args}=${EMPTY}
[Documentation] Ping VM floating IP from control node
- Log ${vm_floating_ip}
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
${output}= Write Commands Until Prompt And Log ping ${additional_args} -c 3 ${vm_floating_ip} 20s
- Close Connection
Should Contain ${output} 64 bytes
-Ping From Instance
- [Arguments] ${dest_vm_ip}
- [Documentation] Ping to the expected destination ip.
- ${output}= Write Commands Until Expected Prompt ping -c 3 ${dest_vm_ip} ${OS_SYSTEM_PROMPT}
- Log ${output}
- [Return] ${output}
-
Curl Metadata Server
[Documentation] Ping to the expected destination ip.
${output}= Write Commands Until Expected Prompt curl -i http://169.254.169.254 ${OS_SYSTEM_PROMPT}
[Documentation] Check if the session has been able to login to the VM instance and exit the instance
${rcode}= Run Keyword And Return Status Check If Console Is VmInstance cirros
Run Keyword If ${rcode} Write Commands Until Prompt exit
- Close Connection
Check Ping
[Arguments] ${ip_address} ${ttl}=64
Execute Command on VM Instance
[Arguments] ${net_name} ${vm_ip} ${cmd} ${user}=cirros ${password}=cubswin:)
[Documentation] Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
- ${devstack_conn_id} = Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
- ${net_id} = Get Net Id ${net_name} ${devstack_conn_id}
- Log ${vm_ip}
+ Get ControlNode Connection
+ ${net_id} = Get Net Id ${net_name}
${output} = 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:
- Log ${output}
${output} = Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
- Log ${output}
${rcode} = Run Keyword And Return Status Check If Console Is VmInstance
${output} = Run Keyword If ${rcode} Write Commands Until Expected Prompt ${cmd} ${OS_SYSTEM_PROMPT}
[Teardown] Exit From Vm Console
[Arguments] ${net_name} ${src_ip} ${dest_ips} ${user}=cirros ${password}=cubswin:) ${ttl}=64
... ${ping_should_succeed}=True ${check_metadata}=True
[Documentation] Login to the vm instance using ssh in the network.
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
- Log ${src_ip}
- ${net_id}= Get Net Id ${net_name} ${devstack_conn_id}
+ Get ControlNode Connection
+ ${net_id}= Get Net Id ${net_name}
${output}= 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:
- Log ${output}
${output}= Write Commands Until Expected Prompt ${password} ${OS_SYSTEM_PROMPT}
- Log ${output}
${rcode}= Run Keyword And Return Status Check If Console Is VmInstance
Run Keyword If ${rcode} Write Commands Until Expected Prompt ifconfig ${OS_SYSTEM_PROMPT}
Run Keyword If ${rcode} Write Commands Until Expected Prompt route -n ${OS_SYSTEM_PROMPT}
Run Keyword If ${rcode} Write Commands Until Expected Prompt arp -an ${OS_SYSTEM_PROMPT}
Run Keyword If ${rcode} Write Commands Until Expected Prompt ip -f inet6 neigh show ${OS_SYSTEM_PROMPT}
: FOR ${dest_ip} IN @{dest_ips}
- \ Log ${dest_ip}
\ ${string_empty}= Run Keyword And Return Status Should Be Empty ${dest_ip}
\ Run Keyword If ${string_empty} Continue For Loop
\ Run Keyword If ${rcode} and "${ping_should_succeed}" == "True" Check Ping ${dest_ip} ttl=${ttl}
[Documentation] Use Netcat to test TCP/UDP connections to the controller
${client_data} Set Variable Test Client Data
${server_data} Set Variable Test Server Data
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
- Log ${vm_ip}
+ Get ControlNode Connection
${output}= Write Commands Until Prompt And Log ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
${output}= Write Commands Until Prompt And Log sudo netstat -nlap | grep ${port}
${nc_output}= Execute Command on VM Instance ${net_name} ${vm_ip} sudo echo "${client_data}" | nc -v -w 5 ${additional_args} ${dest_ip} ${port}
- Log ${nc_output}
${output}= Execute Command on VM Instance ${net_name} ${vm_ip} sudo route -n
Log ${output}
${output}= Execute Command on VM Instance ${net_name} ${vm_ip} sudo arp -an
[Documentation] Check reachability with other network's instances.
${rcode}= Run Keyword And Return Status Check If Console Is VmInstance
: FOR ${dest_ip} IN @{list_of_external_dst_ips}
- \ Log ${dest_ip}
\ Check Ping ${dest_ip}
Create Router
Should Be True '${rc}' == '0'
Get DumpFlows And Ovsconfig
- [Arguments] ${openstack_node_ip}
+ [Arguments] ${conn_id}
[Documentation] Get the OvsConfig and Flow entries from OVS from the Openstack Node
- Log ${openstack_node_ip}
- SSHLibrary.Open Connection ${openstack_node_ip} prompt=${DEFAULT_LINUX_PROMPT}
- SSHKeywords.Flexible SSH Login ${OS_USER} ${DEVSTACK_SYSTEM_PASSWORD}
- SSHLibrary.Set Client Configuration timeout=${default_devstack_prompt_timeout}
+ SSHLibrary.Switch Connection ${conn_id}
Write Commands Until Expected Prompt ip -o link ${DEFAULT_LINUX_PROMPT_STRICT}
Write Commands Until Expected Prompt ip -o addr ${DEFAULT_LINUX_PROMPT_STRICT}
Write Commands Until Expected Prompt ip route ${DEFAULT_LINUX_PROMPT_STRICT}
Run Keyword If 2 < ${NUM_ODL_SYSTEM} Get Karaf Log Types From Test Start ${ODL_SYSTEM_3_IP} ${test_name} ${log_types}
Get ControlNode Connection
- ${control_conn_id}= SSHLibrary.Open Connection ${OS_CONTROL_NODE_IP} prompt=${DEFAULT_LINUX_PROMPT_STRICT}
- SSHKeywords.Flexible SSH Login ${OS_USER} ${DEVSTACK_SYSTEM_PASSWORD}
- SSHLibrary.Set Client Configuration timeout=30s
- [Return] ${control_conn_id}
+ SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
+ [Return] ${OS_CNTL_CONN_ID}
Get OvsDebugInfo
[Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
- Run Keyword If 0 < ${NUM_OS_SYSTEM} Get DumpFlows And Ovsconfig ${OS_CONTROL_NODE_IP}
- Run Keyword If 1 < ${NUM_OS_SYSTEM} Get DumpFlows And Ovsconfig ${OS_COMPUTE_1_IP}
- Run Keyword If 2 < ${NUM_OS_SYSTEM} Get DumpFlows And Ovsconfig ${OS_COMPUTE_2_IP}
+ Run Keyword If 0 < ${NUM_OS_SYSTEM} Get DumpFlows And Ovsconfig ${OS_CNTL_CONN_ID}
+ Run Keyword If 1 < ${NUM_OS_SYSTEM} Get DumpFlows And Ovsconfig ${OS_CMP1_CONN_ID}
+ Run Keyword If 2 < ${NUM_OS_SYSTEM} Get DumpFlows And Ovsconfig ${OS_CMP2_CONN_ID}
Get Test Teardown Debugs
[Arguments] ${test_name}=${TEST_NAME}
Show Debugs
[Arguments] @{vm_indices}
[Documentation] Run these commands for debugging, it can list state of VM instances and ip information in control node
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
${output}= Write Commands Until Prompt And Log sudo ip netns list
- Close Connection
: FOR ${index} IN @{vm_indices}
\ ${rc} ${output}= Run And Return Rc And Output nova show ${index}
\ Log ${output}
Neutron Security Group Create
[Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
[Documentation] Create a security group with specified name ,description & protocol value according to security group template
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
${rc} ${output}= Run And Return Rc And Output openstack security group create ${SecurityGroupName} ${additional_args}
Log ${output}
Should Be True '${rc}' == '0'
[Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
${MacAddr-list} Create List
: FOR ${portName} IN @{portName_list}
- \ ${macAddr}= OpenStackOperations.Get Port Mac ${portName} ${devstack_conn_id}
+ \ ${macAddr}= OpenStackOperations.Get Port Mac ${portName}
\ Append To List ${MacAddr-list} ${macAddr}
[Return] ${MacAddr-list}
[Return] ${port_ip}
Get Port Mac
- [Arguments] ${port_name} ${conn_id}=${devstack_conn_id}
+ [Arguments] ${port_name}
[Documentation] Keyword would return the MAC ID of the ${port_name} received.
${rc} ${output}= Run And Return Rc And Output openstack port show ${port_name} | grep mac_address | awk '{print $4}'
${splitted_output}= Split String ${output} ${EMPTY}
Remove Security Group From VM
[Arguments] ${vm} ${sg}
[Documentation] Remove the security group provided to the given VM.
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
${output}= Write Commands Until Prompt And Log openstack server remove security group ${vm} ${sg}
- Close Connection
Create SFC Flow Classifier
[Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${dest_port} ${neutron_src_port}
Delete SFC Flow Classifier
[Arguments] ${name}
[Documentation] Delete a SFC flow classifier
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
${rc} ${output}= Run And Return Rc And Output openstack sfc flow classifier delete ${name}
Log ${output}
Should Be True '${rc}' == '0'
Create SFC Port Pair
[Arguments] ${name} ${port_in} ${port_out}
[Documentation] Creates a neutron port pair for SFC
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
${rc} ${output}= Run And Return Rc And Output openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
Log ${output}
Should Be True '${rc}' == '0'
Delete SFC Port Pair Group
[Arguments] ${name}
[Documentation] Delete a SFC port pair group
- ${devstack_conn_id}= Get ControlNode Connection
+ Get ControlNode Connection
${rc} ${output}= Run And Return Rc And Output openstack sfc port pair group delete ${name}
Log ${output}
Should Be True '${rc}' == '0'
Remove RSA Key From KnownHosts
[Arguments] ${vm_ip}
[Documentation] Remove RSA
- ${devstack_conn_id}= Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
${output}= Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
${output}= Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
${output}= Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
Wait For Routes To Propogate
[Arguments] ${networks} ${subnets}
[Documentation] Check propagated routes
- ${devstack_conn_id} = Get ControlNode Connection
- Switch Connection ${devstack_conn_id}
+ Get ControlNode Connection
: FOR ${INDEX} IN RANGE 0 1
- \ ${net_id}= Get Net Id @{networks}[${INDEX}] ${devstack_conn_id}
+ \ ${net_id}= Get Net Id @{networks}[${INDEX}]
\ ${is_ipv6}= Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
\ ${length}= Get Length ${is_ipv6}
\ ${cmd}= Set Variable If ${length} == 0 ip route ip -6 route
\ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_interface" BuiltIn.Run Keyword And Ignore Error Remove Interface ${id} ${subnet_id}
BuiltIn.Run Keyword And Ignore Error Delete Router ${id}
+OpenStack Suite Setup
+ [Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
+ SetupUtils.Setup_Utils_For_Setup_And_Teardown
+ DevstackUtils.Devstack Suite Setup
+
OpenStack Suite Teardown
[Documentation] Wrapper teardown keyword that can be used in any suite running in an openstack environement
... to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
OperatingSystem.Create Directory ${dstdir}
Get ControlNode Connection
BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
- SSHLibrary.Close Connection
Is Feature Installed
[Arguments] ${features}=none
: FOR ${feature} IN ${features}
- \ ${status} ${output} Run Keyword And Ignore Error Builtin.Should Contain ${CFEATURES} ${feature}
+ \ ${status} ${output} Run Keyword And Ignore Error Builtin.Should Contain ${CONTROLLERFEATURES} ${feature}
\ Return From Keyword If "${status}" == "PASS" True
[Return] False