*** Settings ***
Documentation Openstack library. This library is useful for tests to create network, subnet, router and vm instances
Library Collections
+Library Process
Library OperatingSystem
Library RequestsLibrary
Library SSHLibrary
Resource DevstackUtils.robot
Resource KarafKeywords.robot
Resource L2GatewayOperations.robot
+Resource ODLTools.robot
Resource OVSDB.robot
Resource SetupUtils.robot
Resource SSHKeywords.robot
Resource ../variables/Variables.robot
Resource ../variables/netvirt/Variables.robot
Variables ../variables/netvirt/Modules.py
-Variables ../variables/netvirt/Exceptions_Whitelist.py
*** Keywords ***
Get Tenant ID From Security Group
\ ${output} = OpenStack CLI openstack server add floating ip ${vm} @{ip}[0]
[Return] ${ip_list}
+Remove Floating Ip From Vm
+ [Arguments] ${vm_name} ${fip}
+ [Documentation] Remove the Floating IP From VM Instance
+ ${output} = OpenStack CLI openstack server remove floating ip ${vm_name} ${fip}
+
Delete Floating IP
[Arguments] ${fip}
[Documentation] Delete floating ip with neutron request.
${port_id} = Collections.Get from List ${splitted_output} 0
[Return] ${port_id}
+Get Sub Port Id
+ [Arguments] ${portname}
+ [Documentation] Retrieve the first 10 chars of the UUID for the given port name
+ ${port_id} = OpenStackOperations.Get Port Id ${portname}
+ ${output} = String.Get Regexp Matches ${port_id} \\w{8}-\\w{2}
+ ${subport_id} = Collections.Get from List ${output} 0
+ [Return] ${subport_id}
+
Get Router Id
[Arguments] ${router1}
[Documentation] Retrieve the router id for the given router name
[Return] ${output}
Add Router Gateway
- [Arguments] ${router_name} ${external_network_name}
- ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name}
+ [Arguments] ${router_name} ${external_network_name} ${additional_args}=${EMPTY}
+ ${output} = OpenStack CLI openstack router set ${router_name} --external-gateway ${external_network_name} ${additional_args}
Remove Interface
[Arguments] ${router_name} ${interface_name}
Remove Gateway
[Arguments] ${router_name}
[Documentation] Remove external gateway from the router.
- BuiltIn.Log openstack router unset ${router_name} --external-gateway
+ ${output} = OpenStack CLI openstack router unset ${router_name} --external-gateway
Update Router
[Arguments] ${router_name} ${cmd}
${output} = OpenStack CLI openstack router set ${router_name} ${cmd}
Show Router
- [Arguments] ${router_name} ${options}
+ [Arguments] ${router_name} ${additional_args}=${EMPTY}
[Documentation] Show information of a given router. Router name and optional fields should be sent as arguments.
- ${output} = OpenStack CLI openstack router show ${router_name}
+ ${output} = OpenStack CLI openstack router show ${router_name} ${additional_args}
+ [Return] ${output}
Delete Router
[Arguments] ${router_name}
\ Utils.Write Commands Until Expected Prompt sudo ip netns exec ${line} ip route ${DEFAULT_LINUX_PROMPT_STRICT}
Utils.Write Commands Until Expected Prompt sudo ovs-vsctl show ${DEFAULT_LINUX_PROMPT_STRICT}
Utils.Write Commands Until Expected Prompt sudo ovs-vsctl list Open_vSwitch ${DEFAULT_LINUX_PROMPT_STRICT}
- Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
- Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
- Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
- Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats br-int -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
+ Utils.Write Commands Until Expected Prompt sudo ovs-ofctl show ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
+ Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
+ Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-groups ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
+ Utils.Write Commands Until Expected Prompt sudo ovs-ofctl dump-group-stats ${INTEGRATION_BRIDGE} -OOpenFlow13 ${DEFAULT_LINUX_PROMPT_STRICT}
Get ControlNode Connection
SSHLibrary.Switch Connection ${OS_CNTL_CONN_ID}
Get OvsDebugInfo
[Documentation] Get the OvsConfig and Flow entries from all Openstack nodes
- BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CNTL_CONN_ID}
- BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP1_CONN_ID}
- BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OpenStackOperations.Get DumpFlows And Ovsconfig ${OS_CMP2_CONN_ID}
+ : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
+ \ OpenStackOperations.Get DumpFlows And Ovsconfig ${conn_id}
Get Test Teardown Debugs
- [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME}
+ [Arguments] ${test_name}=${SUITE_NAME}.${TEST_NAME} ${fail}=${FAIL_ON_EXCEPTIONS}
+ ODLTools.Get All test_name=${test_name}
OpenStackOperations.Get OvsDebugInfo
BuiltIn.Run Keyword And Ignore Error DataModels.Get Model Dump ${HA_PROXY_IP} ${netvirt_data_models}
- KarafKeywords.Get Karaf Log Events From Test Start ${test_name}
- Run Keyword If "${FAIL_ON_EXCEPTIONS}"=="True" Fail If Exceptions Found During Test ${test_name} ${NETVIRT_EXCEPTIONS_WHITELIST}
+ KarafKeywords.Fail If Exceptions Found During Test ${test_name} fail=${fail}
+
+Get Suite Debugs
+ Get Test Teardown Debugs test_name=${SUITE_NAME} fail=False
Get Test Teardown Debugs For SFC
[Arguments] ${test_name}=${TEST_NAME}
${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
[Return] ${output} ${rule_id}
-Neutron Security Group Rule Create Legacy Cli
- [Arguments] ${Security_group_name} &{Kwargs}
- [Documentation] Creates neutron security rule with neutron request with or without optional params, here security group name is mandatory args, rule with optional params can be created by passing the optional args values ex: direction=${INGRESS_EGRESS}, Then these optional params are BuiltIn.Catenated with mandatory args, example of usage: "OpenStack Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
- BuiltIn.Run Keyword If ${Kwargs} BuiltIn.Log ${Kwargs}
- ${description} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} description default=${None}
- ${direction} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} direction default=${None}
- ${ethertype} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} ethertype default=${None}
- ${port_range_max} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_max default=${None}
- ${port_range_min} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} port_range_min default=${None}
- ${protocol} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} protocol default=${None}
- ${remote_group_id} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_group_id default=${None}
- ${remote_ip_prefix} BuiltIn.Run Keyword If ${Kwargs} Collections.Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
- ${cmd} = BuiltIn.Set Variable neutron security-group-rule-create ${Security_group_name}
- ${cmd} = BuiltIn.Run Keyword If '${description}'!='None' BuiltIn.Catenate ${cmd} --description ${description}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${cmd} = BuiltIn.Run Keyword If '${direction}'!='None' BuiltIn.Catenate ${cmd} --direction ${direction}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${cmd} = BuiltIn.Run Keyword If '${ethertype}'!='None' BuiltIn.Catenate ${cmd} --ethertype ${ethertype}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${cmd} = BuiltIn.Run Keyword If '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --port_range_max ${port_range_max}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${cmd} = BuiltIn.Run Keyword If '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --port_range_min ${port_range_min}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${cmd} = BuiltIn.Run Keyword If '${protocol}'!='None' BuiltIn.Catenate ${cmd} --protocol ${protocol}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${cmd} = BuiltIn.Run Keyword If '${remote_group_id}'!='None' BuiltIn.Catenate ${cmd} --remote_group_id ${remote_group_id}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --remote_ip_prefix ${remote_ip_prefix}
- ... ELSE BuiltIn.Catenate ${cmd}
- ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
- ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
- BuiltIn.Log ${rule_id}
- BuiltIn.Should Be True '${rc}' == '0'
- [Return] ${output} ${rule_id}
-
Security Group Create Without Default Security Rules
[Arguments] ${sg_name} ${additional_args}=${EMPTY}
[Documentation] Create Neutron Security Group with no default rules, using specified name and optional arguments.
${port_mac} = Collections.Get from List ${splitted_output} 0
[Return] ${port_mac}
+Get Port Mac Address From Ip
+ [Arguments] ${ip}
+ [Documentation] Retrieve the mac address for a port that matches any given ip.
+ ${output} = OpenStack CLI openstack port list | grep -w ${ip} | awk '{print $5}'
+ ${splitted_output} = String.Split String ${output} ${EMPTY}
+ ${mac_addr} = Collections.Get from List ${splitted_output} 0
+ [Return] ${mac_addr}
+
Create L2Gateway
[Arguments] ${bridge_name} ${intf_name} ${gw_name}
[Documentation] Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
[Return] ${resp.content}
+Get Neutron Network Rest
+ [Arguments] ${net_id}
+ [Documentation] Keyword to get the specific network details in Neutron (Using REST).
+ ${resp} = RequestsLibrary.Get Request session ${NETWORK_URL}/network/${net_id}
+ BuiltIn.Log ${resp.content}
+ BuiltIn.Should Be Equal As Strings ${resp.status_code} 200
+ [Return] ${resp.content}
+
Create And Configure Security Group
[Arguments] ${sg-name}
[Documentation] Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
OpenStack List All
[Documentation] Get a list of different OpenStack resources that might be in use.
@{modules} = BuiltIn.Create List server port network subnet security group
- ... security group rule
- BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" Collections.Append To List ${modules} floating ip router
+ ... security group rule floating ip router
: FOR ${module} IN @{modules}
\ ${output} = OpenStack CLI openstack ${module} list
OpenStack CLI
[Arguments] ${cmd}
[Documentation] Run the given OpenStack ${cmd} and log the output.
- ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
- BuiltIn.Log ${output}
- BuiltIn.Should Be True '${rc}' == '0'
- [Return] ${output}
+ ${result} = Process.Run Process ${cmd} shell=True
+ BuiltIn.Log ${result.stdout}
+ BuiltIn.Log ${result.stderr}
+ BuiltIn.Should Be True '${result.rc}' == '0'
+ [Return] ${result.stdout}
OpenStack CLI With No Log
[Arguments] ${cmd}
[Documentation] Run the given OpenStack ${cmd} and do not log the output.
- ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
- BuiltIn.Should Be True '${rc}' == '0'
- [Return] ${output}
+ ${result} = Process.Run Process ${cmd} shell=True
+ BuiltIn.Should Be True '${result.rc}' == '0'
+ [Return] ${result.stdout}
OpenStack Cleanup All
[Documentation] Cleanup all Openstack resources with best effort. The keyword will query for all resources
... in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
- @{fips} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack floating ip list -f json
- ... ELSE BuiltIn.Create List @{EMPTY}
+ @{fips} = OpenStack CLI Get List openstack floating ip list -f json
: FOR ${fip} IN @{fips}
\ BuiltIn.Run Keyword And Ignore Error Delete Floating IP ${fip['ID']}
@{vms} = OpenStack CLI Get List openstack server list -f json
: FOR ${vm} IN @{vms}
\ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm['ID']}
- @{routers} = BuiltIn.Run Keyword If "${ODL_ENABLE_L3_FWD}"=="yes" OpenStack CLI Get List openstack router list -f json
- ... ELSE BuiltIn.Create List @{EMPTY}
+ @{routers} = OpenStack CLI Get List openstack router list -f json
: FOR ${router} IN @{routers}
\ BuiltIn.Run Keyword And Ignore Error Cleanup Router ${router['ID']}
@{ports} = OpenStack CLI Get List openstack port list -f json
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
- @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil
+ @{loggers} = BuiltIn.Create List org.apache.karaf.shell.support.ShellUtil org.apache.sshd.server.session.ServerSessionImpl
Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All OFF ${loggers}
DevstackUtils.Devstack Suite Setup
@{tcpdump_port_6653_conn_ids} = OpenStackOperations.Start Packet Capture On Nodes tcpdump_port_6653 port 6653 @{OS_ALL_IPS}
BuiltIn.Set Suite Variable @{tcpdump_port_6653_conn_ids}
BuiltIn.Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
OpenStackOperations.Add OVS Logging On All OpenStack Nodes
+ Run_Keyword_If_At_Least_Oxygen Wait Until Keyword Succeeds 60 2 ClusterManagement.Check Status Of Services Is OPERATIONAL @{NETVIRT_DIAG_SERVICES}
+ Verify Expected Default Tables On Nodes
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
... and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
... benefit automatically.
+ # TODO: followup patch will add the list of vms to pass to Show Debugs
+ # OpenStackOperations.Show Debugs @{NET_1_VMS} @{NET_2_VMS}
+ OpenStackOperations.Get Suite Debugs
OpenStack Cleanup All
OpenStackOperations.Stop Packet Capture On Nodes ${tcpdump_port_6653_conn_ids}
SSHLibrary.Close All Connections
Add OVS Logging On All OpenStack Nodes
[Documentation] Add higher levels of OVS logging to all the OpenStack nodes
- BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CNTL_CONN_ID}
- BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP1_CONN_ID}
- BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP2_CONN_ID}
+ : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
+ \ OVSDB.Add OVS Logging ${conn_id}
Reset OVS Logging On All OpenStack Nodes
[Documentation] Reset the OVS logging to all the OpenStack nodes
- BuiltIn.Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CNTL_CONN_ID}
- BuiltIn.Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP1_CONN_ID}
- BuiltIn.Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Reset OVS Logging ${OS_CMP2_CONN_ID}
+ : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
+ \ OVSDB.Reset OVS Logging ${conn_id}
Start Packet Capture On Nodes
[Arguments] ${tag} ${filter} @{ips}
Stop Packet Capture On Nodes
[Arguments] ${conn_ids}=@{EMPTY}
Tcpdump.Stop Packet Capture on Nodes ${conn_ids}
+
+Server Live Migrate
+ [Arguments] ${vm_instance_name}
+ [Documentation] Keyword for live migration of VM instance
+ ... additional_agrs is to select particular migration(live/shared-migration/block-migration)
+ ... if the additional_agrs is not given default migration(shared-migration) will happen
+ ${output} = OpenStackOperations.OpenStack CLI nova live-migration ${vm_instance_name}
+
+Get Hypervisor Host Of Vm
+ [Arguments] ${vm_name}
+ [Documentation] Show server with neutron request.
+ ${output} = OpenStackOperations.OpenStack CLI openstack server show -f value -c OS-EXT-SRV-ATTR:host ${vm_name}
+ [Return] ${output}
+
+Check If Migration Is Complete
+ [Arguments] ${vm_name}
+ [Documentation] Show server and verify if task_state is not migrating
+ ${output} = OpenStackOperations.OpenStack CLI openstack server show ${vm_name} | grep "OS-EXT-STS:task_state"
+ BuiltIn.Should Not Contain ${output} migrating
+
+Modify OpenStack Configuration File
+ [Arguments] ${conn_id} ${file_name} ${section} ${key} ${value}
+ [Documentation] Use crudini to modify any parameter in any Openstack configuration File
+ SSHLibrary.Switch Connection ${conn_id}
+ ${output} ${rc} = SSHLibrary.Execute Command sudo crudini --verbose --set --inplace ${file_name} ${section} ${key} ${value} return_rc=True return_stdout=True
+ BuiltIn.Log ${output}
+ BuiltIn.Should Be True '${rc}' == '0'
+
+Restart DevStack Service
+ [Arguments] ${conn_id} ${service_name}
+ [Documentation] Restart the Openstack Service
+ SSHLibrary.Switch Connection ${conn_id}
+ ${output} ${rc} = SSHLibrary.Execute Command sudo systemctl restart devstack@${service_name}.service return_rc=True return_stdout=True
+ BuiltIn.Log ${output}
+ BuiltIn.Should Be True '${rc}' == '0'
+
+Get Network Segmentation Id
+ [Arguments] ${network_name}
+ [Documentation] Returns network segmentation id for the given network name.
+ ${output} = OpenStack CLI openstack network show ${network_name} | grep segmentation_id | awk '{print $4}'
+ @{list} = String.Split String ${output}
+ [Return] @{list}[0]
+
+Verify Expected Default Tables On Nodes
+ [Arguments] ${node_ips}=@{OS_ALL_IPS}
+ [Documentation] Verify if Default Table Entries are programmed on all Nodes
+ ${resp} = RequestsLibrary.Get Request session ${CONFIG_NODES_API}
+ Utils.Log Content ${resp.content}
+ ${failed_node_list} = BuiltIn.Create List
+ : FOR ${node_ip} IN @{node_ips}
+ \ ${failed_table_list} = Verify Expected Default Tables ${node_ip}
+ \ ${failed_table_list_size} = BuiltIn.Get Length ${failed_table_list}
+ \ BuiltIn.Run Keyword If ${failed_table_list_size} > 0 Collections.Append To List ${failed_node_list} ${node_ip}
+ Builtin.Should Be Empty ${failed_node_list}
+
+Verify Expected Default Tables
+ [Arguments] ${ovs_ip}
+ [Documentation] Verify if Default Table Entries are programmed on specific Node
+ ${flow_dump} = Utils.Run Command On Remote System ${ovs_ip} sudo ovs-ofctl dump-flows ${INTEGRATION_BRIDGE} -OOpenFlow13
+ BuiltIn.Log ${flow_dump}
+ ${failed_table_list} = BuiltIn.Create List
+ : FOR ${table} IN @{DEFAULT_FLOW_TABLES}
+ \ ${rc} = Builtin.Run Keyword And Return Status Builtin.Should Not Match Regexp ${flow_dump} .*table=${table}.*priority=0
+ \ BuiltIn.Run Keyword If ${rc} Collections.Append To List ${failed_table_list} ${table}
+ [Return] ${failed_table_list}
+
+Get Project Id
+ [Arguments] ${project_name}
+ [Documentation] Returns project ID for the given project name.
+ ${project_id} = OpenStack CLI openstack project show ${project_name} -f value -c id
+ [Return] ${project_id}
+
+Set Instance Quota For Project
+ [Arguments] ${num_instances} ${project_id}
+ [Documentation] Set quota for the created instances using the specific project id.
+ ${output} = OpenStack CLI openstack quota set --instances ${num_instances} ${project_id}
+ [Return] ${output}
Code Review / integration / test.git / blobdiff