+ \ ${rc} ${output} = OperatingSystem.Run And Return Rc And Output nova show ${index}
+ \ BuiltIn.Log ${output}
+ OpenStackOperations.List Nova VMs
+ OpenStackOperations.List Routers
+ OpenStackOperations.List Networks
+ OpenStackOperations.List Subnets
+ OpenStackOperations.List Ports
+ OpenStackOperations.List Security Groups
+
+List Security Groups
+ [Documentation] Logging keyword to display all security groups using the openstack cli. Assumes openstack
+ ... credentials are already sourced
+ ${output} = OpenStack CLI openstack security group list
+ [Return] ${output}
+
+Neutron Security Group Show
+ [Arguments] ${SecurityGroupRuleName}
+ [Documentation] Displays the neutron security group configurations that belongs to a given neutron security group name
+ ${output} = OpenStack CLI openstack security group show ${SecurityGroupRuleName}
+ [Return] ${output}
+
+Neutron Port Show
+ [Arguments] ${PortName}
+ [Documentation] Display the port configuration that belong to a given neutron port
+ ${output} = OpenStack CLI openstack port show ${PortName}
+ [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
+ OpenStackOperations.Get ControlNode Connection
+ ${output} = OpenStack CLI openstack security group create ${SecurityGroupName} ${additional_args}
+ ${sgp_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
+ [Return] ${output} ${sgp_id}
+
+Neutron Security Group Update
+ [Arguments] ${SecurityGroupName} ${additional_args}=${EMPTY}
+ [Documentation] Updating security groups
+ ${output} = OpenStack CLI openstack security group set ${SecurityGroupName} ${additional_args}
+ [Return] ${output}
+
+Delete SecurityGroup
+ [Arguments] ${sg_name}
+ [Documentation] Delete Security group
+ ${output} = OpenStack CLI openstack security group delete ${sg_name}
+
+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 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 openstack 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}
+ ... 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_min}'!='None' and '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_min}:${port_range_max}
+ ... ELSE IF '${port_range_max}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${port_range_max}
+ ... ELSE IF '${port_range_min}'!='None' BuiltIn.Catenate ${cmd} --dst-port ${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 ${remote_group_id}
+ ... ELSE BuiltIn.Catenate ${cmd}
+ ${cmd} = BuiltIn.Run Keyword If '${remote_ip_prefix}'!='None' BuiltIn.Catenate ${cmd} --src-ip ${remote_ip_prefix}
+ ... ELSE BuiltIn.Catenate ${cmd}
+ ${output} = OpenStack CLI ${cmd}
+ ${rule_id} = BuiltIn.Should Match Regexp ${output} ${REGEX_UUID}
+ [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.
+ OpenStackOperations.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
+ ${sg_rules_output} = OpenStack CLI openstack security group rule list ${sg_name} -cID -fvalue
+ @{sg_rules} = String.Split String ${sg_rules_output} \n
+ : FOR ${rule} IN @{sg_rules}
+ \ ${output} = OpenStack CLI openstack security group rule delete ${rule}
+
+Create Allow All SecurityGroup
+ [Arguments] ${sg_name} ${ether_type}=IPv4 ${dual}=False
+ [Documentation] Allow all TCP/UDP/ICMP packets for this suite
+ OpenStackOperations.Neutron Security Group Create ${sg_name}
+ OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
+ OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=tcp
+ OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} protocol=icmp
+ OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} protocol=icmp
+ OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
+ OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=${ether_type} port_range_max=65535 port_range_min=1 protocol=udp
+ BuiltIn.Run Keyword If "${dual}"=="True" Run Keywords OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6
+ ... port_range_max=65535 port_range_min=1 protocol=tcp
+ ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 port_range_max=65535
+ ... port_range_min=1 protocol=tcp
+ ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6 protocol=icmp
+ ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 protocol=icmp
+ ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=ingress ethertype=IPv6 port_range_max=65535
+ ... port_range_min=1 protocol=udp
+ ... AND OpenStackOperations.Neutron Security Group Rule Create ${sg_name} direction=egress ethertype=IPv6 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} = OperatingSystem.Run And Return Rc And Output neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
+ BuiltIn.Log ${output}
+ BuiltIn.Should Be True '${rc}' == '0'
+ ${port_id} = BuiltIn.Should Match Regexp ${OUTPUT} ${REGEX_UUID}
+ [Return] ${OUTPUT} ${port_id}
+
+Get Ports MacAddr
+ [Arguments] ${ports}
+ [Documentation] Retrieve the port MacAddr for the given list of port name and return the MAC address list.
+ ${macs} BuiltIn.Create List
+ : FOR ${port} IN @{ports}
+ \ ${mac} = OpenStackOperations.Get Port Mac ${port}
+ \ Collections.Append To List ${macs} ${mac}
+ [Return] ${macs}
+
+Get Port Ip
+ [Arguments] ${port_name}
+ [Documentation] Keyword would return the IP of the ${port_name} received.
+ ${output} = OpenStack CLI openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
+ ${splitted_output} = String.Split String ${output} ${EMPTY}
+ ${port_ip} = Collections.Get from List ${splitted_output} 0
+ [Return] ${port_ip}
+
+Get Port Mac
+ [Arguments] ${port_name}
+ [Documentation] Keyword would return the MAC ID of the ${port_name} received.
+ ${output} = OpenStack CLI openstack port show ${port_name} | grep mac_address | awk '{print $4}'
+ ${splitted_output} = String.Split String ${output} ${EMPTY}
+ ${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).
+ ${rc} ${l2gw_output} = OperatingSystem.Run And Return Rc And Output ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
+ BuiltIn.Log ${l2gw_output}
+ [Return] ${l2gw_output}
+
+Update L2Gateway
+ [Arguments] ${bridge_name} ${gw_name} ${intf_name_1} ${intf_name_2}
+ [Documentation] Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
+ ${rc} ${l2gw_output}= Run And Return Rc And Output ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${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} = OperatingSystem.Run And Return Rc And Output ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
+ BuiltIn.Log ${l2gw_output}
+ BuiltIn.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} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_YAML}
+ BuiltIn.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} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN_YAML}
+ BuiltIn.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} = OperatingSystem.Run And Return Rc And Output ${L2GW_SHOW} ${gw_id}
+ BuiltIn.Log ${output}
+ BuiltIn.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} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
+ BuiltIn.Log ${output}
+ BuiltIn.Should Be True '${rc}' == '0'
+ ${splitted_output} = String.Split String ${output} ${EMPTY}
+ ${l2gw_id} = Collections.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} = OperatingSystem.Run And Return Rc And Output ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
+ BuiltIn.Should Be True '${rc}' == '0'
+ ${splitted_output} = String.Split String ${output} ${EMPTY}
+ ${splitted_output} = String.Split String ${output} ${EMPTY}
+ ${l2gw_conn_id} = Collections.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}
+ BuiltIn.Log ${resp.content}
+ BuiltIn.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}
+ BuiltIn.Log ${resp.content}
+ BuiltIn.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).
+ BuiltIn.Log ${json_data}
+ ${resp} = RequestsLibrary.Put Request session ${CONFIG_API}/${GET_PORT_URL}/${port_id} ${json_data}
+ BuiltIn.Log ${resp.content}
+ 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.
+ OpenStackOperations.Neutron Security Group Create ${sg-name}
+ 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
+ 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
+ OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=ingress protocol=icmp remote_ip_prefix=0.0.0.0/0
+ OpenStackOperations.Neutron Security Group Rule Create ${sg-name} direction=egress protocol=icmp remote_ip_prefix=0.0.0.0/0
+ 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
+ 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
+
+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.
+ OpenStackOperations.Get ControlNode Connection
+ ${output} = OpenStack CLI openstack server remove security group ${vm} ${sg}
+
+Create SFC Flow Classifier
+ [Arguments] ${name} ${src_ip} ${dest_ip} ${protocol} ${neutron_src_port} ${args}=${EMPTY}
+ [Documentation] Create a flow classifier for SFC
+ ${output} = OpenStack CLI openstack sfc flow classifier create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --logical-source-port ${neutron_src_port} ${args} ${name}
+ BuiltIn.Should Contain ${output} ${name}
+ [Return] ${output}
+
+Delete SFC Flow Classifier
+ [Arguments] ${name}
+ [Documentation] Delete a SFC flow classifier
+ ${output} = OpenStack CLI openstack sfc flow classifier delete ${name}
+ [Return] ${output}
+
+Create SFC Port Pair
+ [Arguments] ${name} ${port_in} ${port_out}
+ [Documentation] Creates a neutron port pair for SFC
+ ${output} = OpenStack CLI openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
+ BuiltIn.Should Contain ${output} ${name}
+ [Return] ${output}
+
+Delete SFC Port Pair
+ [Arguments] ${name}
+ [Documentation] Delete a SFC port pair
+ ${output} = OpenStack CLI openstack sfc port pair delete ${name}
+ [Return] ${output}
+
+Create SFC Port Pair Group
+ [Arguments] ${name} ${port_pair}
+ [Documentation] Creates a port pair group with a single port pair for SFC
+ ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair} ${name}
+ BuiltIn.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
+ ${output} = OpenStack CLI openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
+ BuiltIn.Should Contain ${output} ${name}
+ [Return] ${output}
+
+Delete SFC Port Pair Group
+ [Arguments] ${name}
+ [Documentation] Delete a SFC port pair group
+ OpenStackOperations.Get ControlNode Connection
+ ${output} = OpenStack CLI openstack sfc port pair group delete ${name}
+ [Return] ${output}
+
+Create SFC Port Chain
+ [Arguments] ${name} ${args}=${EMPTY}
+ [Documentation] Creates a port pair chain with two port groups and a singel classifier.
+ ${output} = OpenStack CLI openstack sfc port chain create ${name} ${args}
+ BuiltIn.Should Contain ${output} ${name}
+ [Return] ${output}
+
+Update SFC Port Chain With A New Flow Classifier
+ [Arguments] ${name} ${fc}
+ [Documentation] Adds a Flow Classifier to a Port Chain
+ ${output} = OpenStack CLI openstack sfc port chain set ${name} --flow-classifier ${fc}
+ [Return] ${output}
+
+Update SFC Port Chain Removing A Flow Classifier
+ [Arguments] ${name} ${fc}
+ [Documentation] Adds a Flow Classifier to a Port Chain
+ ${output} = OpenStack CLI openstack sfc port chain unset ${name} --flow-classifier ${fc}
+ [Return] ${output}
+
+Delete SFC Port Chain
+ [Arguments] ${name}
+ [Documentation] Delete a SFC port chain
+ ${output} = OpenStack CLI openstack sfc port chain delete ${name}
+ [Return] ${output}
+
+Reboot Nova VM
+ [Arguments] ${vm_name}
+ [Documentation] Reboot NOVA VM
+ ${output} = OpenStack CLI openstack server reboot --wait ${vm_name}
+ BuiltIn.Wait Until Keyword Succeeds 35s 10s OpenStackOperations.Verify VM Is ACTIVE ${vm_name}
+
+Remove RSA Key From KnownHosts
+ [Arguments] ${vm_ip}
+ [Documentation] Remove RSA
+ OpenStackOperations.Get ControlNode Connection
+ ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo cat /root/.ssh/known_hosts 30s
+ ${output} = DevstackUtils.Write Commands Until Prompt And Log sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip} 30s
+ ${output} = DevstackUtils.Write Commands Until Prompt sudo cat "/root/.ssh/known_hosts" 30s
+
+Wait For Routes To Propogate
+ [Arguments] ${networks} ${subnets}
+ [Documentation] Check propagated routes
+ OpenStackOperations.Get ControlNode Connection
+ : FOR ${INDEX} IN RANGE 0 1
+ \ ${net_id} = OpenStackOperations.Get Net Id @{networks}[${INDEX}]
+ \ ${is_ipv6} = String.Get Regexp Matches @{subnets}[${INDEX}] ${IP6_REGEX}
+ \ ${length} = BuiltIn.Get Length ${is_ipv6}
+ \ ${cmd} = BuiltIn.Set Variable If ${length} == 0 ip route ip -6 route
+ \ ${output} = Utils.Write Commands Until Expected Prompt sudo ip netns exec qdhcp-${net_id} ${cmd} ${DEFAULT_LINUX_PROMPT_STRICT}
+ \ BuiltIn.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 server port network subnet security group
+ ... security group rule floating ip router
+ : FOR ${module} IN @{modules}
+ \ ${output} = OpenStack CLI openstack ${module} list
+
+OpenStack CLI Get List
+ [Arguments] ${cmd}
+ [Documentation] Return a json list from the output of an OpenStack command.
+ @{list} = BuiltIn.Create List
+ ${json} = OpenStack CLI ${cmd}
+ @{list} = RequestsLibrary.To Json ${json}
+ BuiltIn.Log ${list}
+ [Return] @{list}
+
+OpenStack CLI
+ [Arguments] ${cmd}
+ [Documentation] Run the given OpenStack ${cmd} and log the 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.
+ ${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} = 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}
+ \ OpenStack CLI openstack server show ${vm['ID']}
+ \ 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} = OpenStackOperations.Get Match ${port['Fixed IP Addresses']} ${REGEX_UUID} 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
+ @{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
+ Validate Deployment
+
+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
+ : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
+ \ KarafKeywords.Issue Command On Karaf Console threads --list | wc -l ${ODL_SYSTEM_${i+1}_IP}
+
+Validate Deployment
+ [Documentation] Validate the deployment. Examples to validate are verifying default table
+ ... flows are installed and that the tunnel mesh has been built correctly.
+ Write To Validate File ----------------------------------------\n${SUITE_NAME}\n
+ : FOR ${keyword} IN @{VALIDATION_KEYWORDS}
+ \ ${status} = Builtin.Run Keyword And Return Status ${keyword}
+ \ BuiltIn.Run Keyword If "${status}" == "FAIL" or "${status}" == "False" BuiltIn.Run Keywords Write To Validate File Failed: ${keyword}
+ \ ... AND BuiltIn.Fail
+ \ ... ELSE Write To Validate File Passed: ${keyword}
+
+Write To Validate File
+ [Arguments] ${msg}
+ [Documentation] Write the given ${msg} to ${VALIDATION_FILE}. Create the file if not present.
+ ${status} = BuiltIn.Run Keyword And Return Status OperatingSystem.File Should Exist ${VALIDATION_FILE}
+ BuiltIn.Run Keyword If "${status}" == "False" OperatingSystem.Create File ${VALIDATION_FILE}
+ OperatingSystem.Append To File ${VALIDATION_FILE} ${msg}\n
+
+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} = BuiltIn.Set Variable /tmp/qdhcp/${suite_}
+ OperatingSystem.Create Directory ${dstdir}
+ OpenStackOperations.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} BuiltIn.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
+ : 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
+ : FOR ${conn_id} IN @{OS_ALL_CONN_IDS}
+ \ OVSDB.Reset OVS Logging ${conn_id}
+
+Start Packet Capture On Nodes
+ [Arguments] ${tag} ${filter} @{ips}
+ [Documentation] Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
+ ... The caller must pass the three arguments with a variable number of ips at the end,
+ ... but ${EMPTY} can be used for the tag and filter.
+ ${suite_} = BuiltIn.Evaluate """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
+ ${tag_} = BuiltIn.Catenate SEPARATOR=__ ${tag} ${suite_}
+ @{conn_ids} = Tcpdump.Start Packet Capture on Nodes tag=${tag_} filter=${filter} ips=${ips}
+ [Return] @{conn_ids}
+
+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 Services
+ [Documentation] Verify if the services are operational
+ Wait Until Keyword Succeeds 60 2 ClusterManagement.Check Status Of Services Is OPERATIONAL @{NETVIRT_DIAG_SERVICES}
+
+Verify Expected Default Tunnels
+ [Documentation] Verify if the default tunnels are created.
+ ... SFC jobs currently fail this validation because it uses of-tunnels.
+ ... This validation will be blocked for NEtvirt SFC jobs until support for of-tunnels
+ ... added to odltools.
+ ${check_feature_list} = BuiltIn.Create List odl-netvirt-sfc
+ ${is_sfc_enabled} = OpenStackOperations.Is Feature Installed features=${check_feature_list}
+ BuiltIn.Return From Keyword If ${is_sfc_enabled} == ${True} ${True}
+ BuiltIn.Return From Keyword If ${OS_NODE_CNT} == ${1} ${True}
+ ${output} = ODLTools.Analyze Tunnels test_name=${SUITE_NAME}.Suite Setup
+ BuiltIn.Should Contain ${output} All tunnels are up
+
+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}