+ List Security Groups
+
+List Security Groups
+ [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
+ ... credentials are already sourced
+ ${rc} ${output}= Run And Return Rc And Output openstack security group list
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Neutron Security Group Show
+ [Arguments] ${SecurityGroupRuleName}
+ [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
+ ${rc} ${output}= Run And Return Rc And Output openstack security group show ${SecurityGroupRuleName}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Neutron Port Show
+ [Arguments] ${PortName}
+ [Documentation] Display the port configuration that belong to a given neutron port
+ ${rc} ${output}= Run And Return Rc And Output openstack port show ${PortName}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${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
+ 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'
+ ${sgp_id}= Should Match Regexp ${output} [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
+ Log ${sgp_id}
+ [Return] ${output} ${sgp_id}
+
+Neutron Security Group Update
+ [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
+ [Documentation] Updating security groups
+ ${rc} ${output}= Run And Return Rc And Output openstack security group set ${SecurityGroupName} ${additional_args}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Delete SecurityGroup
+ [Arguments] ${sg_name}
+ [Documentation] Delete Security group
+ ${rc} ${output}= Run And Return Rc And Output openstack security group delete ${sg_name}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+
+Neutron Security Group Rule Create
+ [Arguments] ${Security_group_name} &{Kwargs}
+ [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 catenated with mandatory args, example of usage: "Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
+ Run Keyword If ${Kwargs} Log ${Kwargs}
+ ${description} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} description default=${None}
+ ${direction} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} direction default=${None}
+ ${ethertype} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} ethertype default=${None}
+ ${port_range_max} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} port_range_max default=${None}
+ ${port_range_min} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} port_range_min default=${None}
+ ${protocol} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} protocol default=${None}
+ ${remote_group_id} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} remote_group_id default=${None}
+ ${remote_ip_prefix} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
+ ${cmd}= Set Variable openstack security group rule create ${Security_group_name}
+ ${cmd}= Run Keyword If '${description}'!='None' Catenate ${cmd} --description ${description}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${direction}'!='None' Catenate ${cmd} --${direction}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${ethertype}'!='None' Catenate ${cmd} --ethertype ${ethertype}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${port_range_min}'!='None' and '${port_range_max}'!='None' Catenate ${cmd} --dst-port ${port_range_min}:${port_range_max}
+ ... ELSE IF '${port_range_max}'!='None' Catenate ${cmd} --dst-port ${port_range_max}
+ ... ELSE IF '${port_range_min}'!='None' Catenate ${cmd} --dst-port ${port_range_min}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${protocol}'!='None' Catenate ${cmd} --protocol ${protocol}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${remote_group_id}'!='None' Catenate ${cmd} --remote-group ${remote_group_id}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${remote_ip_prefix}'!='None' Catenate ${cmd} --src-ip ${remote_ip_prefix}
+ ... ELSE Catenate ${cmd}
+ ${rc} ${output}= Run And Return Rc And Output ${cmd}
+ ${rule_id}= Should Match Regexp ${output} [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
+ Log ${rule_id}
+ Should Be True '${rc}' == '0'
+ [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 catenated with mandatory args, example of usage: "Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
+ Run Keyword If ${Kwargs} Log ${Kwargs}
+ ${description} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} description default=${None}
+ ${direction} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} direction default=${None}
+ ${ethertype} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} ethertype default=${None}
+ ${port_range_max} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} port_range_max default=${None}
+ ${port_range_min} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} port_range_min default=${None}
+ ${protocol} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} protocol default=${None}
+ ${remote_group_id} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} remote_group_id default=${None}
+ ${remote_ip_prefix} Run Keyword If ${Kwargs} Pop From Dictionary ${Kwargs} remote_ip_prefix default=${None}
+ ${cmd}= Set Variable neutron security-group-rule-create ${Security_group_name}
+ ${cmd}= Run Keyword If '${description}'!='None' Catenate ${cmd} --description ${description}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${direction}'!='None' Catenate ${cmd} --direction ${direction}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${ethertype}'!='None' Catenate ${cmd} --ethertype ${ethertype}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${port_range_max}'!='None' Catenate ${cmd} --port_range_max ${port_range_max}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${port_range_min}'!='None' Catenate ${cmd} --port_range_min ${port_range_min}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${protocol}'!='None' Catenate ${cmd} --protocol ${protocol}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${remote_group_id}'!='None' Catenate ${cmd} --remote_group_id ${remote_group_id}
+ ... ELSE Catenate ${cmd}
+ ${cmd}= Run Keyword If '${remote_ip_prefix}'!='None' Catenate ${cmd} --remote_ip_prefix ${remote_ip_prefix}
+ ... ELSE Catenate ${cmd}
+ ${rc} ${output}= Run And Return Rc And Output ${cmd}
+ ${rule_id}= Should Match Regexp ${output} [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
+ Log ${rule_id}
+ 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.
+ Neutron Security Group Create ${sg_name} ${additional_args}
+ Delete All Security Group Rules ${sg_name}
+
+Delete All Security Group Rules
+ [Arguments] ${sg_name}
+ [Documentation] Delete all security rules from a specified security group
+ ${rc} ${sg_rules_output}= Run And Return Rc And Output openstack security group rule list ${sg_name} -cID -fvalue
+ Log ${sg_rules_output}
+ Should Be True '${rc}' == '0'
+ @{sg_rules}= Split String ${sg_rules_output} \n
+ : FOR ${rule} IN @{sg_rules}
+ \ ${rc} ${output}= Run And Return Rc And Output openstack security group rule delete ${rule}
+ \ Log ${output}
+ \ Should Be True '${rc}' == '0'
+
+Create Allow All SecurityGroup
+ [Arguments] ${sg_name} ${ether_type}=IPv4
+ [Documentation] Allow all TCP/UDP/ICMP packets for this suite
+ Neutron Security Group Create ${sg_name}
+ Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
+ Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
+ Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
+ Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
+ Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
+ Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
+
+Create Neutron Port With Additional Params
+ [Arguments] ${network_name} ${port_name} ${additional_args}=${EMPTY}
+ [Documentation] Create Port With given additional parameters
+ ${rc} ${output}= Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ ${port_id}= Should Match Regexp ${OUTPUT} [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
+ Log ${port_id}
+ [Return] ${OUTPUT} ${port_id}
+
+Get Ports MacAddr
+ [Arguments] ${portName_list}
+ [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}
+ \ Append To List ${MacAddr-list} ${macAddr}
+ [Return] ${MacAddr-list}
+
+Get Port Ip
+ [Arguments] ${port_name}
+ [Documentation] Keyword would return the IP of the ${port_name} received.
+ ${rc} ${output}= Run And Return Rc And Output openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
+ ${splitted_output}= Split String ${output} ${EMPTY}
+ ${port_ip}= Get from List ${splitted_output} 0
+ Should Be True '${rc}' == '0'
+ [Return] ${port_ip}
+
+Get Port Mac
+ [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}
+ ${port_mac}= Get from List ${splitted_output} 0
+ Should Be True '${rc}' == '0'
+ [Return] ${port_mac}
+
+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).
+ ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
+ Log ${l2gw_output}
+ [Return] ${l2gw_output}
+
+Create L2Gateway Connection
+ [Arguments] ${gw_name} ${net_name}
+ [Documentation] Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
+ ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
+ Log ${l2gw_output}
+ Should Be True '${rc}' == '0'
+ [Return] ${l2gw_output}
+
+Get All L2Gateway
+ [Documentation] Keyword to return all the L2 Gateways available (Using Neutron CLI).
+ ${rc} ${output}= Run And Return Rc And Output ${L2GW_GET_YAML}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Get All L2Gateway Connection
+ [Documentation] Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
+ ${rc} ${output}= Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Get L2Gateway
+ [Arguments] ${gw_id}
+ [Documentation] Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
+ ${rc} ${output}= Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Get L2gw Id
+ [Arguments] ${l2gw_name}
+ [Documentation] Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
+ ${rc} ${output}= Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ ${splitted_output}= Split String ${output} ${EMPTY}
+ ${l2gw_id}= Get from List ${splitted_output} 0
+ [Return] ${l2gw_id}
+
+Get L2gw Connection Id
+ [Arguments] ${l2gw_name}
+ [Documentation] Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
+ ${l2gw_id}= OpenStackOperations.Get L2gw Id ${l2gw_name}
+ ${rc} ${output}= Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
+ Should Be True '${rc}' == '0'
+ ${splitted_output}= Split String ${output} ${EMPTY}
+ ${splitted_output}= Split String ${output} ${EMPTY}
+ ${l2gw_conn_id}= Get from List ${splitted_output} 0
+ [Return] ${l2gw_conn_id}
+
+Neutron Port List Rest
+ [Documentation] Keyword to get all ports details in Neutron (Using REST).
+ ${resp} = RequestsLibrary.Get Request session ${PORT_URL}
+ Log ${resp.content}
+ Should Be Equal As Strings ${resp.status_code} 200
+ [Return] ${resp.content}
+
+Get Neutron Port Rest
+ [Arguments] ${port_id}
+ [Documentation] Keyword to get the specific port details in Neutron (Using REST).
+ ${resp} = RequestsLibrary.Get Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id}
+ Log ${resp.content}
+ Should Be Equal As Strings ${resp.status_code} 200
+ [Return] ${resp.content}
+
+Update Port Rest
+ [Arguments] ${port_id} ${json_data}
+ [Documentation] Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
+ Log ${json_data}
+ ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
+ Log ${resp.content}
+ 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.
+ Neutron Security Group Create ${sg-name}
+ 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
+ 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
+ Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
+ Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
+ 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
+ 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
+
+Add Security Group To VM
+ [Arguments] ${vm} ${sg}
+ [Documentation] Add the security group provided to the given VM.
+ ${output}= OpenStack CLI openstack server add security group ${vm} ${sg}
+
+Remove Security Group From VM
+ [Arguments] ${vm} ${sg}
+ [Documentation] Remove the security group provided to the given VM.
+ Get ControlNode Connection
+ OpenStack CLI openstack server remove security group ${vm} ${sg}
+
+Create SFC Flow Classifier
+ [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${dest_port} ${neutron_src_port}
+ [Documentation] Create a flow classifier for SFC
+ ${rc} ${output}= Run And Return Rc And Output 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}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ Should Contain ${output} ${name}
+ [Return] ${output}
+
+Delete SFC Flow Classifier
+ [Arguments] ${name}
+ [Documentation] Delete a SFC flow classifier
+ Get ControlNode Connection
+ ${rc} ${output}= Run And Return Rc And Output openstack sfc flow classifier delete ${name}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Create SFC Port Pair
+ [Arguments] ${name} ${port_in} ${port_out}
+ [Documentation] Creates a neutron port pair for SFC
+ 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'
+ Should Contain ${output} ${name}
+ [Return] ${output}
+
+Delete SFC Port Pair
+ [Arguments] ${name}
+ [Documentation] Delete a SFC port pair
+ ${rc} ${output}= Run And Return Rc And Output openstack sfc port pair delete ${name}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Create SFC Port Pair Group
+ [Arguments] ${name} ${port_pair}
+ [Documentation] Creates a port pair group with a single port pair for SFC
+ ${rc} ${output}= Run And Return Rc And Output openstack sfc port pair group create --port-pair ${port_pair} ${name}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ Should Contain ${output} ${name}
+ [Return] ${output}
+
+Create SFC Port Pair Group With Two Pairs
+ [Arguments] ${name} ${port_pair1} ${port_pair2}
+ [Documentation] Creates a port pair group with two port pairs for SFC
+ ${rc} ${output}= Run And Return Rc And Output openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ Should Contain ${output} ${name}
+ [Return] ${output}
+
+Delete SFC Port Pair Group
+ [Arguments] ${name}
+ [Documentation] Delete a SFC port pair group
+ 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'
+ [Return] ${output}
+
+Create SFC Port Chain
+ [Arguments] ${name} ${pg1} ${pg2} ${fc}
+ [Documentation] Creates a port pair chain with two port groups and a singel classifier.
+ ${rc} ${output}= Run And Return Rc And Output openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ Should Contain ${output} ${name}
+ [Return] ${output}
+
+Delete SFC Port Chain
+ [Arguments] ${name}
+ [Documentation] Delete a SFC port chain
+ ${rc} ${output}= Run And Return Rc And Output openstack sfc port chain delete ${name}
+ Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+Reboot Nova VM
+ [Arguments] ${vm_name}
+ [Documentation] Reboot NOVA VM
+ OpenStack CLI openstack server reboot --wait ${vm_name}
+ Wait Until Keyword Succeeds 35s 10s Verify VM Is ACTIVE ${vm_name}
+
+Remove RSA Key From KnownHosts
+ [Arguments] ${vm_ip}
+ [Documentation] Remove RSA
+ 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
+ Get ControlNode Connection
+ : FOR ${INDEX} IN RANGE 0 1
+ \ ${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
+ \ ${output}= Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ]>
+ \ Should Contain ${output} @{subnets}[${INDEX}]
+
+Neutron Cleanup
+ [Arguments] ${vms}=@{EMPTY} ${networks}=@{EMPTY} ${subnets}=@{EMPTY} ${ports}=@{EMPTY} ${sgs}=@{EMPTY}
+ : FOR ${vm} IN @{vms}
+ \ BuiltIn.Run Keyword And Ignore Error Delete Vm Instance ${vm}
+ : FOR ${port} IN @{ports}
+ \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port}
+ : FOR ${subnet} IN @{subnets}
+ \ BuiltIn.Run Keyword And Ignore Error Delete SubNet ${subnet}
+ : FOR ${network} IN @{networks}
+ \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network}
+ : FOR ${sg} IN @{sgs}
+ \ BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${sg}
+
+OpenStack List All
+ [Documentation] Get a list of different OpenStack resources that might be in use.
+ @{modules} = BuiltIn.Create List floating ip server router port network
+ ... subnet security group security group rule
+ : FOR ${module} IN @{modules}
+ \ OpenStack CLI openstack ${module} list
+
+OpenStack CLI Get List
+ [Arguments] ${cmd}
+ [Documentation] Return a json list from the output of an OpenStack command.
+ ${json} = OpenStack CLI ${cmd}
+ @{list} = RequestsLibrary.To Json ${json}
+ BuiltIn.Log ${list}
+ [Return] @{list}
+
+OpenStack CLI
+ [Arguments] ${cmd}
+ [Documentation] Run the given OpenStack ${cmd}.
+ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output ${cmd}
+ BuiltIn.Log ${output}
+ Should Be True '${rc}' == '0'
+ [Return] ${output}
+
+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} = 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} = 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
+ : FOR ${port} IN @{ports}
+ \ BuiltIn.Run Keyword And Ignore Error Delete Port ${port['ID']}
+ @{networks} = OpenStack CLI Get List openstack network list -f json
+ : FOR ${network} IN @{networks}
+ \ BuiltIn.Run Keyword And Ignore Error Delete Subnet ${network['Subnets']}
+ \ BuiltIn.Run Keyword And Ignore Error Delete Network ${network['ID']}
+ @{security_groups} = OpenStack CLI Get List openstack security group list -f json
+ : FOR ${security_group} IN @{security_groups}
+ \ BuiltIn.Run Keyword If "${security_group['Name']}" != "default" BuiltIn.Run Keyword And Ignore Error Delete SecurityGroup ${security_group['ID']}
+ OpenStack List All
+
+Cleanup Router
+ [Arguments] ${id}
+ [Documentation] Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
+ @{ports} = OpenStack CLI Get List openstack port list --router ${id} -f json --long
+ : FOR ${port} IN @{ports}
+ \ ${subnet_id} = Get Match ${port['Fixed IP Addresses']} [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} 0
+ \ BuiltIn.Run Keyword If "${port['Device Owner']}" == "network:router_gateway" BuiltIn.Run Keyword And Ignore Error Remove Gateway ${id}
+ \ 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
+ Run Keyword If "${PRE_CLEAN_OPENSTACK_ALL}"=="True" OpenStack Cleanup All
+ DevstackUtils.Devstack Suite Setup
+ Add OVS Logging On All OpenStack 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.
+ OpenStack Cleanup All
+ SSHLibrary.Close All Connections
+
+Copy DHCP Files From Control Node
+ [Documentation] Copy the current DHCP files to the robot vm. The keyword must be called
+ ... after the subnet(s) are created and before the subnet(s) are deleted.
+ ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
+ ${dstdir} = Set Variable /tmp/qdhcp/${suite_}
+ OperatingSystem.Create Directory ${dstdir}
+ Get ControlNode Connection
+ BuiltIn.Run Keyword And Ignore Error SSHLibrary.Get Directory /opt/stack/data/neutron/dhcp ${dstdir} recursive=True
+
+Is Feature Installed
+ [Arguments] ${features}=none
+ : FOR ${feature} IN ${features}
+ \ ${status} ${output} Run Keyword And Ignore Error Builtin.Should Contain ${CONTROLLERFEATURES} ${feature}
+ \ Return From Keyword If "${status}" == "PASS" True
+ [Return] False
+
+Add OVS Logging On All OpenStack Nodes
+ [Documentation] Add higher levels of OVS logging to all the OpenStack nodes
+ Run Keyword If 0 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CNTL_CONN_ID}
+ Run Keyword If 1 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP1_CONN_ID}
+ Run Keyword If 2 < ${NUM_OS_SYSTEM} OVSDB.Add OVS Logging ${OS_CMP2_CONN_ID}