csit/libraries/OpenStackOperations.robot

   1 *** Settings ***
   2 Documentation     Openstack library. This library is useful for tests to create network, subnet, router and vm instances
   3 Library           Collections
   4 Library           OperatingSystem
   5 Library           RequestsLibrary
   6 Library           SSHLibrary
   7 Library           String
   8 Resource          DataModels.robot
   9 Resource          DevstackUtils.robot
  10 Resource          KarafKeywords.robot
  11 Resource          L2GatewayOperations.robot
  12 Resource          OVSDB.robot
  13 Resource          SetupUtils.robot
  14 Resource          SSHKeywords.robot
  15 Resource          Tcpdump.robot
  16 Resource          Utils.robot
  17 Resource          ../variables/Variables.robot
  18 Resource          ../variables/netvirt/Variables.robot
  19 Variables         ../variables/netvirt/Modules.py
  20 Variables         ../variables/netvirt/Exceptions_Whitelist.py
  21
  22 *** Keywords ***
  23 Get Tenant ID From Security Group
  24     [Documentation]    Returns tenant ID by reading it from existing default security-group.
  25     ${output} =    OpenStack CLI    openstack security group show default | grep "| tenant_id" | awk '{print $4}'
  26     [Return]    ${output}
  27
  28 Get Tenant ID From Network
  29     [Arguments]    ${network_uuid}
  30     [Documentation]    Returns tenant ID by reading it from existing network.
  31     ${resp} =    TemplatedRequests.Get_From_Uri    uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/    accept=${ACCEPT_EMPTY}    session=session
  32     ${tenant_id} =    Utils.Extract Value From Content    ${resp}    /network/0/tenant-id    strip
  33     [Return]    ${tenant_id}
  34
  35 Create Network
  36     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}    ${verbose}=TRUE
  37     [Documentation]    Create Network with neutron request.
  38     ${output} =    OpenStack CLI    openstack network create ${network_name} ${additional_args}
  39     [Return]    ${output}
  40
  41 Update Network
  42     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}
  43     [Documentation]    Update Network with neutron request.
  44     ${output} =    OpenStack CLI    openstack network set ${network_name} ${additional_args}
  45     [Return]    ${output}
  46
  47 Show Network
  48     [Arguments]    ${network_name}
  49     [Documentation]    Show Network with neutron request.
  50     ${output} =    OpenStack CLI    openstack network show ${network_name}
  51     [Return]    ${output}
  52
  53 List Networks
  54     [Documentation]    List networks and return output with neutron client.
  55     ${output} =    OpenStack CLI    openstack network list
  56     [Return]    ${output}
  57
  58 List Subnets
  59     [Documentation]    List subnets and return output with neutron client.
  60     ${output} =    OpenStack CLI    openstack subnet list
  61     [Return]    ${output}
  62
  63 Delete Network
  64     [Arguments]    ${network_name}
  65     [Documentation]    Delete Network with neutron request.
  66     ${output} =    OpenStack CLI    openstack network delete ${network_name}
  67
  68 Create SubNet
  69     [Arguments]    ${network_name}    ${subnet_name}    ${range_ip}    ${additional_args}=${EMPTY}
  70     [Documentation]    Create SubNet for the Network with neutron request.
  71     ${output} =    OpenStack CLI    openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet_name} ${additional_args}
  72
  73 Update SubNet
  74     [Arguments]    ${subnet_name}    ${additional_args}=${EMPTY}
  75     [Documentation]    Update subnet with neutron request.
  76     ${output} =    OpenStack CLI    openstack subnet set ${subnet_name} ${additional_args}
  77     [Return]    ${output}
  78
  79 Show SubNet
  80     [Arguments]    ${subnet_name}
  81     [Documentation]    Show subnet with neutron request.
  82     ${output} =    OpenStack CLI    openstack subnet show ${subnet_name}
  83     [Return]    ${output}
  84
  85 Create Port
  86     [Arguments]    ${network_name}    ${port_name}    ${sg}=default    ${additional_args}=${EMPTY}    ${allowed_address_pairs}=${EMPTY}
  87     [Documentation]    Create Port with neutron request.
  88     # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
  89     # in a different format with the neutron vs openstack cli.
  90     ${address_pair_length} =    BuiltIn.Get Length    ${allowed_address_pairs}
  91     ${allowed_pairs_argv} =    BuiltIn.Set Variable    ${EMPTY}
  92     ${allowed_pairs_argv} =    BuiltIn.Set Variable If    '${address_pair_length}'=='2'    --allowed-address ip-address=@{allowed_address_pairs}[0] --allowed-address ip-address=@{allowed_address_pairs}[1]    ${allowed_pairs_argv}
  93     ${output} =    OpenStack CLI    openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
  94
  95 Update Port
  96     [Arguments]    ${port_name}    ${additional_args}=${EMPTY}
  97     [Documentation]    Update port with neutron request.
  98     ${output} =    OpenStack CLI    openstack port set ${port_name} ${additional_args}
  99     [Return]    ${output}
 100
 101 Show Port
 102     [Arguments]    ${port_name}
 103     [Documentation]    Show port with neutron request.
 104     ${output} =    OpenStack CLI    openstack port show ${port_name}
 105     [Return]    ${output}
 106
 107 Delete Port
 108     [Arguments]    ${port_name}
 109     [Documentation]    Delete Port with neutron request.
 110     ${output} =    OpenStack CLI    openstack port delete ${port_name}
 111
 112 List Ports
 113     [Documentation]    List ports and return output with neutron client.
 114     ${output} =    OpenStack CLI    openstack port list
 115     [Return]    ${output}
 116
 117 List Nova VMs
 118     [Documentation]    List VMs and return output with nova client.
 119     ${output} =    OpenStack CLI    openstack server list --all-projects
 120     [Return]    ${output}
 121
 122 Create And Associate Floating IPs
 123     [Arguments]    ${external_net}    @{vm_list}
 124     [Documentation]    Create and associate floating IPs to VMs with nova request
 125     ${ip_list} =    BuiltIn.Create List    @{EMPTY}
 126     : FOR    ${vm}    IN    @{vm_list}
 127     \    ${output} =    OpenStack CLI    openstack floating ip create ${external_net}
 128     \    @{ip} =    String.Get Regexp Matches    ${output}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
 129     \    ${ip_length} =    BuiltIn.Get Length    ${ip}
 130     \    BuiltIn.Run Keyword If    ${ip_length}>0    Collections.Append To List    ${ip_list}    @{ip}[0]
 131     \    ...    ELSE    Collections.Append To List    ${ip_list}    None
 132     \    ${output} =    OpenStack CLI    openstack server add floating ip ${vm} @{ip}[0]
 133     [Return]    ${ip_list}
 134
 135 Remove Floating Ip From Vm
 136     [Arguments]    ${vm_name}    ${fip}
 137     [Documentation]    Remove the Floating IP From VM Instance
 138     ${output} =    OpenStack CLI    openstack server remove floating ip ${vm_name} ${fip}
 139
 140 Delete Floating IP
 141     [Arguments]    ${fip}
 142     [Documentation]    Delete floating ip with neutron request.
 143     ${output} =    OpenStack CLI    openstack floating ip delete ${fip}
 144
 145 Delete SubNet
 146     [Arguments]    ${subnet}
 147     [Documentation]    Delete SubNet for the Network with neutron request.
 148     ${output} =    OpenStack CLI    openstack subnet delete ${subnet}
 149
 150 Delete Vm Instance
 151     [Arguments]    ${vm_name}
 152     [Documentation]    Delete Vm instances using instance names.
 153     ${output} =    OpenStack CLI    openstack server delete ${vm_name}
 154
 155 Get Net Id
 156     [Arguments]    ${network_name}
 157     [Documentation]    Retrieve the net id for the given network name to create specific vm instance
 158     ${output} =    OpenStack CLI    openstack network list | grep "${network_name}" | awk '{print $2}'
 159     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 160     ${net_id} =    Collections.Get from List    ${splitted_output}    0
 161     [Return]    ${net_id}
 162
 163 Get Subnet Id
 164     [Arguments]    ${subnet_name}
 165     [Documentation]    Retrieve the subnet id for the given subnet name
 166     ${output} =    OpenStack CLI    openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
 167     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 168     ${subnet_id} =    Collections.Get from List    ${splitted_output}    0
 169     [Return]    ${subnet_id}
 170
 171 Get Port Id
 172     [Arguments]    ${port_name}
 173     [Documentation]    Retrieve the port id for the given port name to attach specific vm instance to a particular port
 174     ${output} =    OpenStack CLI    openstack port list | grep "${port_name}" | awk '{print $2}'
 175     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 176     ${port_id} =    Collections.Get from List    ${splitted_output}    0
 177     [Return]    ${port_id}
 178
 179 Get Router Id
 180     [Arguments]    ${router1}
 181     [Documentation]    Retrieve the router id for the given router name
 182     ${output} =    OpenStack CLI    openstack router show "${router1}" |awk '/ id / {print $4}'
 183     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 184     ${router_id} =    Collections.Get from List    ${splitted_output}    0
 185     [Return]    ${router_id}
 186
 187 Create Vm Instances
 188     [Arguments]    ${net_name}    ${vm_instance_names}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default    ${min}=1
 189     ...    ${max}=1
 190     [Documentation]    Create X Vm Instance with the net id of the Netowrk.
 191     ${image}    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 192     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 193     : FOR    ${vm}    IN    @{vm_instance_names}
 194     \    ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${vm} --security-group ${sg} --min ${min} --max ${max}
 195
 196 Create Vm Instance On Compute Node
 197     [Arguments]    ${net_name}    ${vm_name}    ${node_hostname}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
 198     [Documentation]    Create a VM instance on a specific compute node.
 199     ${image} =    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 200     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 201     ${output} =    OpenStack CLI    openstack server create ${vm_name} --image ${image} --flavor ${flavor} --nic net-id=${net_id} --security-group ${sg} --availability-zone nova:${node_hostname}
 202
 203 Create Vm Instance With Port
 204     [Arguments]    ${port_name}    ${vm_instance_name}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
 205     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
 206     ${image} =    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 207     ${port_id} =    OpenStackOperations.Get Port Id    ${port_name}
 208     ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-group ${sg}
 209
 210 Create Vm Instance With Ports
 211     [Arguments]    ${port_name}    ${port2_name}    ${vm_instance_name}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
 212     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
 213     ${image}    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 214     ${port_id} =    OpenStackOperations.Get Port Id    ${port_name}
 215     ${port2_id} =    OpenStackOperations.Get Port Id    ${port2_name}
 216     ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --nic port-id=${port2_id} ${vm_instance_name} --security-group ${sg}
 217
 218 Create Vm Instance With Port On Compute Node
 219     [Arguments]    ${port_name}    ${vm_instance_name}    ${node_hostname}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
 220     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
 221     ${image} =    BuiltIn.Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
 222     ${port_id} =    OpenStackOperations.Get Port Id    ${port_name}
 223     ${output} =    OpenStack CLI    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --security-group ${sg} --availability-zone nova:${node_hostname} ${vm_instance_name}
 224
 225 Get Hypervisor Hostname From IP
 226     [Arguments]    ${hypervisor_ip}
 227     [Documentation]    Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
 228     ...    the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
 229     ${output} =    OpenStack CLI    openstack hypervisor list
 230     ${hostname} =    OpenStack CLI    openstack hypervisor list -f value | grep "${hypervisor_ip} " | cut -d" " -f 2
 231     [Return]    ${hostname}
 232
 233 Create Nano Flavor
 234     [Documentation]    Create a nano flavor
 235     ${output} =    OpenStack CLI    openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
 236
 237 Verify VM Is ACTIVE
 238     [Arguments]    ${vm_name}
 239     [Documentation]    Run these commands to check whether the created vm instance is active or not.
 240     ${output} =    OpenStack CLI    openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
 241     BuiltIn.Should Contain    ${output}    active
 242
 243 Poll VM Is ACTIVE
 244     [Arguments]    ${vm_name}    ${retry}=600s    ${retry_interval}=30s
 245     [Documentation]    Run these commands to check whether the created vm instance is active or not.
 246     BuiltIn.Wait Until Keyword Succeeds    ${retry}    ${retry_interval}    OpenStackOperations.Verify VM Is ACTIVE    ${vm_name}
 247
 248 Get Match
 249     [Arguments]    ${text}    ${regexp}    ${index}=0
 250     [Documentation]    Wrapper around String.Get Regexp Matches to return None if not found or the first match if found.
 251     @{matches} =    String.Get Regexp Matches    ${text}    ${regexp}
 252     ${matches_length} =    BuiltIn.Get Length    ${matches}
 253     BuiltIn.Set Suite Variable    ${OS_MATCH}    None
 254     BuiltIn.Run Keyword If    ${matches_length} > ${index}    BuiltIn.Set Suite Variable    ${OS_MATCH}    @{matches}[${index}]
 255     [Return]    ${OS_MATCH}
 256
 257 Get VM IP
 258     [Arguments]    ${fail_on_none}    ${vm}
 259     [Documentation]    Get the vm ip address and nameserver by scraping the vm's console log.
 260     ...    Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
 261     ${vm_console_output} =    OpenStack CLI With No Log    openstack console log show ${vm}
 262     ${vm_ip} =    BuiltIn.Set Variable    None
 263     ${dhcp_ip} =    BuiltIn.Set Variable    None
 264     ${match} =    OpenStackOperations.Get Match    ${vm_console_output}    ${REGEX_OBTAINED}
 265     ${vm_ip} =    OpenStackOperations.Get Match    ${match}    ${REGEX_IPV4}    0
 266     ${match} =    OpenStackOperations.Get Match    ${vm_console_output}    ${REGEX_IPROUTE}
 267     ${dhcp_ip} =    OpenStackOperations.Get Match    ${match}    ${REGEX_IPV4}    1
 268     BuiltIn.Run Keyword If    '${fail_on_none}' == 'true'    BuiltIn.Should Not Contain    ${vm_ip}    None
 269     BuiltIn.Run Keyword If    '${fail_on_none}' == 'true'    BuiltIn.Should Not Contain    ${dhcp_ip}    None
 270     [Return]    ${vm_ip}    ${dhcp_ip}    ${vm_console_output}
 271
 272 Get VM IPs
 273     [Arguments]    @{vms}
 274     [Documentation]    Get the instance IP addresses and nameserver address for the list of given vms.
 275     ...    First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
 276     ...    Get VM IPs returns two things: [0] a list of the ips for the vms passed to this keyword (may contain values
 277     ...    of None) and [1] the dhcp ip address found in the last vm checked.
 278     ...    TODO: there is a potential issue for a caller that passes in VMs belonging to different networks that
 279     ...    may have different dhcp server addresses. Not sure what TODO about that, but noting it here for reference.
 280     @{vm_ips}    BuiltIn.Create List    @{EMPTY}
 281     : FOR    ${vm}    IN    @{vms}
 282     \    OpenStackOperations.Poll VM Is ACTIVE    ${vm}
 283     \    ${status}    ${ips_and_console_log}    BuiltIn.Run Keyword And Ignore Error    BuiltIn.Wait Until Keyword Succeeds    180s    15s
 284     \    ...    OpenStackOperations.Get VM IP    true    ${vm}
 285     \    # If there is trouble with Get VM IP, the status will be FAIL and the return value will be a string of what went
 286     \    # wrong. We need to handle both the PASS and FAIL cases. In the FAIL case we know we wont have access to the
 287     \    # console log, as it would not be returned; so we need to grab it again to log it. We also can append 'None' to
 288     \    # the vm ip list if status is FAIL.
 289     \    BuiltIn.Run Keyword If    "${status}" == "PASS"    BuiltIn.Log    ${ips_and_console_log[2]}
 290     \    BuiltIn.Run Keyword If    "${status}" == "PASS"    Collections.Append To List    ${vm_ips}    ${ips_and_console_log[0]}
 291     \    BuiltIn.Run Keyword If    "${status}" == "FAIL"    Collections.Append To List    ${vm_ips}    None
 292     \    ${vm_console_output} =    BuiltIn.Run Keyword If    "${status}" == "FAIL"    OpenStack CLI    openstack console log show ${vm}
 293     \    BuiltIn.Run Keyword If    "${status}" == "FAIL"    BuiltIn.Log    ${vm_console_output}
 294     OpenStackOperations.Copy DHCP Files From Control Node
 295     [Return]    @{vm_ips}    ${ips_and_console_log[1]}
 296
 297 Collect VM IPv6 SLAAC Addresses
 298     [Arguments]    ${fail_on_none}    ${vm_list}    ${network}    ${subnet}
 299     [Documentation]    For each VM parse output of "openstack server show" to get its IPv6 address from Neutron DB.
 300     ...    Then try to connect to each VM by SSH and execute there "ip -6 a" command. This double-check allows to
 301     ...    obtain and compare IP info (Neutron DB vs dnsmasque/ODL DHCP) and to test L2 connectivity as well.
 302     ...    Returns an empty list if no IPv6 addresses found or if SSH connection fails.
 303     ...    Otherwise, returns a list of IPv6 addresses.
 304     ${ipv6_list} =    BuiltIn.Create List    @{EMPTY}
 305     : FOR    ${vm}    IN    @{vm_list}
 306     \    ${output} =    OpenStack CLI    openstack server show ${vm} -f shell
 307     \    ${pattern} =    String.Replace String    ${subnet}    ::/64    (:[a-f0-9]{,4}){,4}
 308     \    @{vm_ipv6} =    String.Get Regexp Matches    ${output}    ${pattern}
 309     \    ${vm_ip_length} =    BuiltIn.Get Length    ${vm_ipv6}[0]
 310     \    ${ipv6_data_from_vm} =    BuiltIn.Run Keyword If    ${vm_ip_length}>0    OpenStackOperations.Execute Command on VM Instance    ${network}    ${vm_ipv6[0]}
 311     \    ...    ip -6 a
 312     \    @{ipv6} =    String.Get Regexp Matches    ${ipv6_data_from_vm}    ${pattern}
 313     \    ${ipv6_addr_list_length}    BuiltIn.Get Length    @{ipv6}
 314     \    BuiltIn.Run Keyword If    ${ipv6_addr_list_length}>0    Collections.Append To List    ${ipv6_list}    ${ipv6[0]}
 315     \    ...    ELSE    Collections.Append To List    ${ipv6_list}    None
 316     [Return]    ${ipv6_list}
 317
 318 View Vm Console
 319     [Arguments]    ${vm_instance_names}
 320     [Documentation]    View Console log of the created vm instances using nova show.
 321     : FOR    ${vm}    IN    @{vm_instance_names}
 322     \    ${output} =    OpenStack CLI    openstack server show ${vm}
 323     \    ${output} =    OpenStack CLI    openstack console log show ${vm}
 324
 325 Ping Vm From DHCP Namespace
 326     [Arguments]    ${net_name}    ${vm_ip}
 327     [Documentation]    Reach all Vm Instance with the net id of the Netowrk.
 328     OpenStackOperations.Get ControlNode Connection
 329     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 330     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
 331     BuiltIn.Should Contain    ${output}    64 bytes
 332
 333 Ping From DHCP Should Not Succeed
 334     [Arguments]    ${net_name}    ${vm_ip}
 335     [Documentation]    Should Not Reach Vm Instance with the net id of the Netowrk.
 336     Return From Keyword If    "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
 337     OpenStackOperations.Get ControlNode Connection
 338     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 339     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
 340     BuiltIn.Should Not Contain    ${output}    64 bytes
 341
 342 Ping Vm From Control Node
 343     [Arguments]    ${vm_floating_ip}    ${additional_args}=${EMPTY}
 344     [Documentation]    Ping VM floating IP from control node
 345     OpenStackOperations.Get ControlNode Connection
 346     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    ping ${additional_args} -c 3 ${vm_floating_ip}    20s
 347     BuiltIn.Should Contain    ${output}    64 bytes
 348
 349 Curl Metadata Server
 350     [Documentation]    Ping to the expected destination ip.
 351     ${output} =    Utils.Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
 352     DevstackUtils.Write Commands Until Prompt    exit
 353     BuiltIn.Should Contain    ${output}    200
 354
 355 Close Vm Instance
 356     [Documentation]    Exit the vm instance.
 357     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    exit
 358
 359 Check If Console Is VmInstance
 360     [Arguments]    ${console}=cirros
 361     [Documentation]    Check if the session has been able to login to the VM instance
 362     ${output} =    Utils.Write Commands Until Expected Prompt    id    ${OS_SYSTEM_PROMPT}
 363     BuiltIn.Should Contain    ${output}    ${console}
 364
 365 Exit From Vm Console
 366     [Documentation]    Check if the session has been able to login to the VM instance and exit the instance
 367     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance    cirros
 368     BuiltIn.Run Keyword If    ${rcode}    DevstackUtils.Write Commands Until Prompt    exit
 369
 370 Check Ping
 371     [Arguments]    ${ip_address}    ${ttl}=64
 372     [Documentation]    Run Ping command on the IP available as argument
 373     ${ethertype} =    String.Get Regexp Matches    ${ip_address}    ${IP_REGEX}
 374     ${output} =    BuiltIn.Run Keyword If    ${ethertype}    Utils.Write Commands Until Expected Prompt    ping -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
 375     ...    ELSE    Utils.Write Commands Until Expected Prompt    ping6 -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
 376     BuiltIn.Should Contain    ${output}    64 bytes
 377
 378 Check No Ping
 379     [Arguments]    ${ip_address}    ${ttl}=64
 380     [Documentation]    Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
 381     ${output} =    Utils.Write Commands Until Expected Prompt    ping -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
 382     BuiltIn.Should Not Contain    ${output}    64 bytes
 383
 384 Check Metadata Access
 385     [Documentation]    Try curl on the Metadataurl and check if it is okay
 386     ${output} =    Utils.Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
 387     BuiltIn.Should Contain    ${output}    200
 388
 389 Execute Command on VM Instance
 390     [Arguments]    ${net_name}    ${vm_ip}    ${cmd}    ${user}=cirros    ${password}=cubswin:)
 391     [Documentation]    Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
 392     OpenStackOperations.Get ControlNode Connection
 393     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 394     ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh ${user}@${vm_ip} -o ConnectTimeout=10 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null    password:
 395     ${output} =    Utils.Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
 396     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance
 397     ${output} =    BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    ${cmd}    ${OS_SYSTEM_PROMPT}
 398     [Teardown]    Exit From Vm Console
 399     [Return]    ${output}
 400
 401 Test Operations From Vm Instance
 402     [Arguments]    ${net_name}    ${src_ip}    ${dest_ips}    ${user}=cirros    ${password}=cubswin:)    ${ttl}=64
 403     ...    ${ping_should_succeed}=True    ${check_metadata}=True
 404     [Documentation]    Login to the vm instance using ssh in the network.
 405     OpenStackOperations.Get ControlNode Connection
 406     ${net_id} =    OpenStackOperations.Get Net Id    ${net_name}
 407     ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh -o ConnectTimeout=10 -o StrictHostKeyChecking=no ${user}@${src_ip} -o UserKnownHostsFile=/dev/null    password:
 408     ${output} =    Utils.Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
 409     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance
 410     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    ifconfig    ${OS_SYSTEM_PROMPT}
 411     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    route -n    ${OS_SYSTEM_PROMPT}
 412     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    route -A inet6    ${OS_SYSTEM_PROMPT}
 413     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    arp -an    ${OS_SYSTEM_PROMPT}
 414     BuiltIn.Run Keyword If    ${rcode}    Utils.Write Commands Until Expected Prompt    ip -f inet6 neigh show    ${OS_SYSTEM_PROMPT}
 415     : FOR    ${dest_ip}    IN    @{dest_ips}
 416     \    ${string_empty} =    BuiltIn.Run Keyword And Return Status    Should Be Empty    ${dest_ip}
 417     \    BuiltIn.Run Keyword If    ${string_empty}    Continue For Loop
 418     \    BuiltIn.Run Keyword If    ${rcode} and "${ping_should_succeed}" == "True"    OpenStackOperations.Check Ping    ${dest_ip}    ttl=${ttl}
 419     \    ...    ELSE    OpenStackOperations.Check No Ping    ${dest_ip}    ttl=${ttl}
 420     ${ethertype} =    String.Get Regexp Matches    ${src_ip}    ${IP_REGEX}
 421     BuiltIn.Run Keyword If    ${rcode} and "${check_metadata}" and ${ethertype} == "True"    OpenStackOperations.Check Metadata Access
 422     [Teardown]    Exit From Vm Console
 423
 424 Test Netcat Operations From Vm Instance
 425     [Arguments]    ${net_name}    ${vm_ip}    ${dest_ip}    ${additional_args}=${EMPTY}    ${port}=12345    ${user}=cirros
 426     ...    ${password}=cubswin:)
 427     [Documentation]    Use Netcat to test TCP/UDP connections to the controller
 428     ${client_data}    BuiltIn.Set Variable    Test Client Data
 429     ${server_data}    BuiltIn.Set Variable    Test Server Data
 430     OpenStackOperations.Get ControlNode Connection
 431     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
 432     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo netstat -nlap | grep ${port}
 433     ${nc_output} =    OpenStackOperations.Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo echo "${client_data}" | nc -v -w 5 ${additional_args} ${dest_ip} ${port}
 434     BuiltIn.Log    ${output}
 435     ${output} =    OpenStackOperations.Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo route -n
 436     BuiltIn.Log    ${output}
 437     ${output} =    OpenStackOperations.Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo arp -an
 438     BuiltIn.Log    ${output}
 439     BuiltIn.Should Match Regexp    ${nc_output}    ${server_data}
 440
 441 Ping Other Instances
 442     [Arguments]    ${list_of_external_dst_ips}
 443     [Documentation]    Check reachability with other network's instances.
 444     ${rcode} =    BuiltIn.Run Keyword And Return Status    OpenStackOperations.Check If Console Is VmInstance
 445     : FOR    ${dest_ip}    IN    @{list_of_external_dst_ips}
 446     \    OpenStackOperations.Check Ping    ${dest_ip}
 447
 448 Create Router
 449     [Arguments]    ${router_name}
 450     [Documentation]    Create Router and Add Interface to the subnets.
 451     ${output} =    OpenStack CLI    openstack router create ${router_name}
 452
 453 List Routers
 454     [Documentation]    List Routers and return output with neutron client.
 455     ${output} =    OpenStack CLI    openstack router list -f value
 456     [Return]    ${output}
 457
 458 Add Router Interface
 459     [Arguments]    ${router_name}    ${interface_name}
 460     ${output} =    OpenStack CLI    openstack router add subnet ${router_name} ${interface_name}
 461
 462 Show Router Interface
 463     [Arguments]    ${router_name}
 464     [Documentation]    List Routers interface associated with given Router and return output with neutron client.
 465     ${output} =    OpenStack CLI    openstack port list --router ${router_name} -f value
 466     [Return]    ${output}
 467
 468 Add Router Gateway
 469     [Arguments]    ${router_name}    ${external_network_name}
 470     ${output} =    OpenStack CLI    openstack router set ${router_name} --external-gateway ${external_network_name}
 471
 472 Remove Interface
 473     [Arguments]    ${router_name}    ${interface_name}
 474     [Documentation]    Remove Interface to the subnets.
 475     ${output} =    OpenStack CLI    openstack router remove subnet ${router_name} ${interface_name}
 476
 477 Remove Gateway
 478     [Arguments]    ${router_name}
 479     [Documentation]    Remove external gateway from the router.
 480     BuiltIn.Log    openstack router unset ${router_name} --external-gateway
 481
 482 Update Router
 483     [Arguments]    ${router_name}    ${cmd}
 484     [Documentation]    Update the router with the command. Router name and command should be passed as argument.
 485     ${output} =    OpenStack CLI    openstack router set ${router_name} ${cmd}
 486
 487 Show Router
 488     [Arguments]    ${router_name}    ${options}
 489     [Documentation]    Show information of a given router. Router name and optional fields should be sent as arguments.
 490     ${output} =    OpenStack CLI    openstack router show ${router_name}
 491
 492 Delete Router
 493     [Arguments]    ${router_name}
 494     [Documentation]    Delete Router and Interface to the subnets.
 495     ${output} =    OpenStack CLI    openstack router delete ${router_name}
 496
 497 Get DumpFlows And Ovsconfig
 498     [Arguments]    ${conn_id}
 499     [Documentation]    Get the OvsConfig and Flow entries from OVS from the Openstack Node
 500     SSHLibrary.Switch Connection    ${conn_id}
 501     Utils.Write Commands Until Expected Prompt    ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
 502     Utils.Write Commands Until Expected Prompt    ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
 503     Utils.Write Commands Until Expected Prompt    ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
 504     Utils.Write Commands Until Expected Prompt    arp -an    ${DEFAULT_LINUX_PROMPT_STRICT}
 505     ${nslist} =    Utils.Write Commands Until Expected Prompt    ip netns list | awk '{print $1}'    ${DEFAULT_LINUX_PROMPT_STRICT}
 506     @{lines}    Split To Lines    ${nslist}    end=-1
 507     : FOR    ${line}    IN    @{lines}
 508     \    Utils.Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
 509     \    Utils.Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
 510     \    Utils.Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
 511     Utils.Write Commands Until Expected Prompt    sudo ovs-vsctl show    ${DEFAULT_LINUX_PROMPT_STRICT}
 512     Utils.Write Commands Until Expected Prompt    sudo ovs-vsctl list Open_vSwitch    ${DEFAULT_LINUX_PROMPT_STRICT}
 513     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl show br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 514     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl dump-flows br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 515     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl dump-groups br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 516     Utils.Write Commands Until Expected Prompt    sudo ovs-ofctl dump-group-stats br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
 517
 518 Get ControlNode Connection
 519     SSHLibrary.Switch Connection    ${OS_CNTL_CONN_ID}
 520     [Return]    ${OS_CNTL_CONN_ID}
 521
 522 Get OvsDebugInfo
 523     [Documentation]    Get the OvsConfig and Flow entries from all Openstack nodes
 524     BuiltIn.Run Keyword If    0 < ${NUM_OS_SYSTEM}    OpenStackOperations.Get DumpFlows And Ovsconfig    ${OS_CNTL_CONN_ID}
 525     BuiltIn.Run Keyword If    1 < ${NUM_OS_SYSTEM}    OpenStackOperations.Get DumpFlows And Ovsconfig    ${OS_CMP1_CONN_ID}
 526     BuiltIn.Run Keyword If    2 < ${NUM_OS_SYSTEM}    OpenStackOperations.Get DumpFlows And Ovsconfig    ${OS_CMP2_CONN_ID}
 527
 528 Get Test Teardown Debugs
 529     [Arguments]    ${test_name}=${SUITE_NAME}.${TEST_NAME}
 530     OpenStackOperations.Get OvsDebugInfo
 531     BuiltIn.Run Keyword And Ignore Error    DataModels.Get Model Dump    ${HA_PROXY_IP}    ${netvirt_data_models}
 532     KarafKeywords.Get Karaf Log Events From Test Start    ${test_name}
 533     Run Keyword If    "${FAIL_ON_EXCEPTIONS}"=="True"    Fail If Exceptions Found During Test    ${test_name}    ${NETVIRT_EXCEPTIONS_WHITELIST}
 534
 535 Get Test Teardown Debugs For SFC
 536     [Arguments]    ${test_name}=${TEST_NAME}
 537     BuiltIn.Run Keyword And Ignore Error    DataModels.Get Model Dump    ${HA_PROXY_IP}    ${netvirt_sfc_data_models}
 538
 539 Show Debugs
 540     [Arguments]    @{vm_indices}
 541     [Documentation]    Run these commands for debugging, it can list state of VM instances and ip information in control node
 542     OpenStackOperations.Get ControlNode Connection
 543     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ip netns list
 544     : FOR    ${index}    IN    @{vm_indices}
 545     \    ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    nova show ${index}
 546     \    BuiltIn.Log    ${output}
 547     OpenStackOperations.List Nova VMs
 548     OpenStackOperations.List Routers
 549     OpenStackOperations.List Networks
 550     OpenStackOperations.List Subnets
 551     OpenStackOperations.List Ports
 552     OpenStackOperations.List Security Groups
 553
 554 List Security Groups
 555     [Documentation]    Logging keyword to display all security groups using the openstack cli. Assumes openstack
 556     ...    credentials are already sourced
 557     ${output} =    OpenStack CLI    openstack security group list
 558     [Return]    ${output}
 559
 560 Neutron Security Group Show
 561     [Arguments]    ${SecurityGroupRuleName}
 562     [Documentation]    Displays the neutron security group configurations that belongs to a given neutron security group name
 563     ${output} =    OpenStack CLI    openstack security group show ${SecurityGroupRuleName}
 564     [Return]    ${output}
 565
 566 Neutron Port Show
 567     [Arguments]    ${PortName}
 568     [Documentation]    Display the port configuration that belong to a given neutron port
 569     ${output} =    OpenStack CLI    openstack port show ${PortName}
 570     [Return]    ${output}
 571
 572 Neutron Security Group Create
 573     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
 574     [Documentation]    Create a security group with specified name ,description & protocol value according to security group template
 575     OpenStackOperations.Get ControlNode Connection
 576     ${output} =    OpenStack CLI    openstack security group create ${SecurityGroupName} ${additional_args}
 577     ${sgp_id} =    BuiltIn.Should Match Regexp    ${output}    ${REGEX_UUID}
 578     [Return]    ${output}    ${sgp_id}
 579
 580 Neutron Security Group Update
 581     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
 582     [Documentation]    Updating security groups
 583     ${output} =    OpenStack CLI    openstack security group set ${SecurityGroupName} ${additional_args}
 584     [Return]    ${output}
 585
 586 Delete SecurityGroup
 587     [Arguments]    ${sg_name}
 588     [Documentation]    Delete Security group
 589     ${output} =    OpenStack CLI    openstack security group delete ${sg_name}
 590
 591 Neutron Security Group Rule Create
 592     [Arguments]    ${Security_group_name}    &{Kwargs}
 593     [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]} ..."
 594     BuiltIn.Run Keyword If    ${Kwargs}    BuiltIn.Log    ${Kwargs}
 595     ${description}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    description    default=${None}
 596     ${direction}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    direction    default=${None}
 597     ${ethertype}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    ethertype    default=${None}
 598     ${port_range_max}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    port_range_max    default=${None}
 599     ${port_range_min}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    port_range_min    default=${None}
 600     ${protocol}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    protocol    default=${None}
 601     ${remote_group_id}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    remote_group_id    default=${None}
 602     ${remote_ip_prefix}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    remote_ip_prefix    default=${None}
 603     ${cmd} =    BuiltIn.Set Variable    openstack security group rule create ${Security_group_name}
 604     ${cmd} =    BuiltIn.Run Keyword If    '${description}'!='None'    BuiltIn.Catenate    ${cmd}    --description ${description}
 605     ...    ELSE    BuiltIn.Catenate    ${cmd}
 606     ${cmd} =    BuiltIn.Run Keyword If    '${direction}'!='None'    BuiltIn.Catenate    ${cmd}    --${direction}
 607     ...    ELSE    BuiltIn.Catenate    ${cmd}
 608     ${cmd} =    BuiltIn.Run Keyword If    '${ethertype}'!='None'    BuiltIn.Catenate    ${cmd}    --ethertype ${ethertype}
 609     ...    ELSE    BuiltIn.Catenate    ${cmd}
 610     ${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}
 611     ...    ELSE IF    '${port_range_max}'!='None'    BuiltIn.Catenate    ${cmd}    --dst-port ${port_range_max}
 612     ...    ELSE IF    '${port_range_min}'!='None'    BuiltIn.Catenate    ${cmd}    --dst-port ${port_range_min}
 613     ...    ELSE    BuiltIn.Catenate    ${cmd}
 614     ${cmd} =    BuiltIn.Run Keyword If    '${protocol}'!='None'    BuiltIn.Catenate    ${cmd}    --protocol ${protocol}
 615     ...    ELSE    BuiltIn.Catenate    ${cmd}
 616     ${cmd} =    BuiltIn.Run Keyword If    '${remote_group_id}'!='None'    BuiltIn.Catenate    ${cmd}    --remote-group ${remote_group_id}
 617     ...    ELSE    BuiltIn.Catenate    ${cmd}
 618     ${cmd} =    BuiltIn.Run Keyword If    '${remote_ip_prefix}'!='None'    BuiltIn.Catenate    ${cmd}    --src-ip ${remote_ip_prefix}
 619     ...    ELSE    BuiltIn.Catenate    ${cmd}
 620     ${output} =    OpenStack CLI    ${cmd}
 621     ${rule_id} =    BuiltIn.Should Match Regexp    ${output}    ${REGEX_UUID}
 622     [Return]    ${output}    ${rule_id}
 623
 624 Neutron Security Group Rule Create Legacy Cli
 625     [Arguments]    ${Security_group_name}    &{Kwargs}
 626     [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]} ..."
 627     BuiltIn.Run Keyword If    ${Kwargs}    BuiltIn.Log    ${Kwargs}
 628     ${description}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    description    default=${None}
 629     ${direction}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    direction    default=${None}
 630     ${ethertype}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    ethertype    default=${None}
 631     ${port_range_max}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    port_range_max    default=${None}
 632     ${port_range_min}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    port_range_min    default=${None}
 633     ${protocol}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    protocol    default=${None}
 634     ${remote_group_id}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    remote_group_id    default=${None}
 635     ${remote_ip_prefix}    BuiltIn.Run Keyword If    ${Kwargs}    Collections.Pop From Dictionary    ${Kwargs}    remote_ip_prefix    default=${None}
 636     ${cmd} =    BuiltIn.Set Variable    neutron security-group-rule-create ${Security_group_name}
 637     ${cmd} =    BuiltIn.Run Keyword If    '${description}'!='None'    BuiltIn.Catenate    ${cmd}    --description ${description}
 638     ...    ELSE    BuiltIn.Catenate    ${cmd}
 639     ${cmd} =    BuiltIn.Run Keyword If    '${direction}'!='None'    BuiltIn.Catenate    ${cmd}    --direction ${direction}
 640     ...    ELSE    BuiltIn.Catenate    ${cmd}
 641     ${cmd} =    BuiltIn.Run Keyword If    '${ethertype}'!='None'    BuiltIn.Catenate    ${cmd}    --ethertype ${ethertype}
 642     ...    ELSE    BuiltIn.Catenate    ${cmd}
 643     ${cmd} =    BuiltIn.Run Keyword If    '${port_range_max}'!='None'    BuiltIn.Catenate    ${cmd}    --port_range_max ${port_range_max}
 644     ...    ELSE    BuiltIn.Catenate    ${cmd}
 645     ${cmd} =    BuiltIn.Run Keyword If    '${port_range_min}'!='None'    BuiltIn.Catenate    ${cmd}    --port_range_min ${port_range_min}
 646     ...    ELSE    BuiltIn.Catenate    ${cmd}
 647     ${cmd} =    BuiltIn.Run Keyword If    '${protocol}'!='None'    BuiltIn.Catenate    ${cmd}    --protocol ${protocol}
 648     ...    ELSE    BuiltIn.Catenate    ${cmd}
 649     ${cmd} =    BuiltIn.Run Keyword If    '${remote_group_id}'!='None'    BuiltIn.Catenate    ${cmd}    --remote_group_id ${remote_group_id}
 650     ...    ELSE    BuiltIn.Catenate    ${cmd}
 651     ${cmd} =    BuiltIn.Run Keyword If    '${remote_ip_prefix}'!='None'    BuiltIn.Catenate    ${cmd}    --remote_ip_prefix ${remote_ip_prefix}
 652     ...    ELSE    BuiltIn.Catenate    ${cmd}
 653     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${cmd}
 654     ${rule_id} =    BuiltIn.Should Match Regexp    ${output}    ${REGEX_UUID}
 655     BuiltIn.Log    ${rule_id}
 656     BuiltIn.Should Be True    '${rc}' == '0'
 657     [Return]    ${output}    ${rule_id}
 658
 659 Security Group Create Without Default Security Rules
 660     [Arguments]    ${sg_name}    ${additional_args}=${EMPTY}
 661     [Documentation]    Create Neutron Security Group with no default rules, using specified name and optional arguments.
 662     OpenStackOperations.Neutron Security Group Create    ${sg_name}    ${additional_args}
 663     Delete All Security Group Rules    ${sg_name}
 664
 665 Delete All Security Group Rules
 666     [Arguments]    ${sg_name}
 667     [Documentation]    Delete all security rules from a specified security group
 668     ${sg_rules_output} =    OpenStack CLI    openstack security group rule list ${sg_name} -cID -fvalue
 669     @{sg_rules} =    String.Split String    ${sg_rules_output}    \n
 670     : FOR    ${rule}    IN    @{sg_rules}
 671     \    ${output} =    OpenStack CLI    openstack security group rule delete ${rule}
 672
 673 Create Allow All SecurityGroup
 674     [Arguments]    ${sg_name}    ${ether_type}=IPv4
 675     [Documentation]    Allow all TCP/UDP/ICMP packets for this suite
 676     OpenStackOperations.Neutron Security Group Create    ${sg_name}
 677     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=tcp
 678     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=tcp
 679     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    protocol=icmp
 680     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    protocol=icmp
 681     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=udp
 682     OpenStackOperations.Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=udp
 683
 684 Create Neutron Port With Additional Params
 685     [Arguments]    ${network_name}    ${port_name}    ${additional_args}=${EMPTY}
 686     [Documentation]    Create Port With given additional parameters
 687     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
 688     BuiltIn.Log    ${output}
 689     BuiltIn.Should Be True    '${rc}' == '0'
 690     ${port_id} =    BuiltIn.Should Match Regexp    ${OUTPUT}    ${REGEX_UUID}
 691     [Return]    ${OUTPUT}    ${port_id}
 692
 693 Get Ports MacAddr
 694     [Arguments]    ${ports}
 695     [Documentation]    Retrieve the port MacAddr for the given list of port name and return the MAC address list.
 696     ${macs}    BuiltIn.Create List
 697     : FOR    ${port}    IN    @{ports}
 698     \    ${mac} =    OpenStackOperations.Get Port Mac    ${port}
 699     \    Collections.Append To List    ${macs}    ${mac}
 700     [Return]    ${macs}
 701
 702 Get Port Ip
 703     [Arguments]    ${port_name}
 704     [Documentation]    Keyword would return the IP of the ${port_name} received.
 705     ${output} =    OpenStack CLI    openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
 706     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 707     ${port_ip} =    Collections.Get from List    ${splitted_output}    0
 708     [Return]    ${port_ip}
 709
 710 Get Port Mac
 711     [Arguments]    ${port_name}
 712     [Documentation]    Keyword would return the MAC ID of the ${port_name} received.
 713     ${output} =    OpenStack CLI    openstack port show ${port_name} | grep mac_address | awk '{print $4}'
 714     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 715     ${port_mac} =    Collections.Get from List    ${splitted_output}    0
 716     [Return]    ${port_mac}
 717
 718 Create L2Gateway
 719     [Arguments]    ${bridge_name}    ${intf_name}    ${gw_name}
 720     [Documentation]    Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
 721     ${rc}    ${l2gw_output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
 722     BuiltIn.Log    ${l2gw_output}
 723     [Return]    ${l2gw_output}
 724
 725 Update L2Gateway
 726     [Arguments]    ${bridge_name}    ${gw_name}    ${intf_name_1}    ${intf_name_2}
 727     [Documentation]    Keyword to add {intf_name_list} to an existing L2 Gateway ${gw_name} (Using Neutron CLI).
 728     ${rc}    ${l2gw_output}=    Run And Return Rc And Output    ${L2GW_UPDATE} name=${bridge_name},interface_names="${intf_name_1};${intf_name_2}" ${gw_name}
 729     Log    ${l2gw_output}
 730     [Return]    ${l2gw_output}
 731
 732 Create L2Gateway Connection
 733     [Arguments]    ${gw_name}    ${net_name}
 734     [Documentation]    Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
 735     ${rc}    ${l2gw_output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
 736     BuiltIn.Log    ${l2gw_output}
 737     BuiltIn.Should Be True    '${rc}' == '0'
 738     [Return]    ${l2gw_output}
 739
 740 Get All L2Gateway
 741     [Documentation]    Keyword to return all the L2 Gateways available (Using Neutron CLI).
 742     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET_YAML}
 743     BuiltIn.Should Be True    '${rc}' == '0'
 744     [Return]    ${output}
 745
 746 Get All L2Gateway Connection
 747     [Documentation]    Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
 748     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET_CONN_YAML}
 749     BuiltIn.Should Be True    '${rc}' == '0'
 750     [Return]    ${output}
 751
 752 Get L2Gateway
 753     [Arguments]    ${gw_id}
 754     [Documentation]    Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
 755     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_SHOW} ${gw_id}
 756     BuiltIn.Log    ${output}
 757     BuiltIn.Should Be True    '${rc}' == '0'
 758     [Return]    ${output}
 759
 760 Get L2gw Id
 761     [Arguments]    ${l2gw_name}
 762     [Documentation]    Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
 763     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
 764     BuiltIn.Log    ${output}
 765     BuiltIn.Should Be True    '${rc}' == '0'
 766     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 767     ${l2gw_id} =    Collections.Get from List    ${splitted_output}    0
 768     [Return]    ${l2gw_id}
 769
 770 Get L2gw Connection Id
 771     [Arguments]    ${l2gw_name}
 772     [Documentation]    Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
 773     ${l2gw_id} =    OpenStackOperations.Get L2gw Id    ${l2gw_name}
 774     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
 775     BuiltIn.Should Be True    '${rc}' == '0'
 776     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 777     ${splitted_output} =    String.Split String    ${output}    ${EMPTY}
 778     ${l2gw_conn_id} =    Collections.Get from List    ${splitted_output}    0
 779     [Return]    ${l2gw_conn_id}
 780
 781 Neutron Port List Rest
 782     [Documentation]    Keyword to get all ports details in Neutron (Using REST).
 783     ${resp} =    RequestsLibrary.Get Request    session    ${PORT_URL}
 784     BuiltIn.Log    ${resp.content}
 785     BuiltIn.Should Be Equal As Strings    ${resp.status_code}    200
 786     [Return]    ${resp.content}
 787
 788 Get Neutron Port Rest
 789     [Arguments]    ${port_id}
 790     [Documentation]    Keyword to get the specific port details in Neutron (Using REST).
 791     ${resp} =    RequestsLibrary.Get Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}
 792     BuiltIn.Log    ${resp.content}
 793     BuiltIn.Should Be Equal As Strings    ${resp.status_code}    200
 794     [Return]    ${resp.content}
 795
 796 Update Port Rest
 797     [Arguments]    ${port_id}    ${json_data}
 798     [Documentation]    Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
 799     BuiltIn.Log    ${json_data}
 800     ${resp} =    RequestsLibrary.Put Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}    ${json_data}
 801     BuiltIn.Log    ${resp.content}
 802     BuiltIn.Should Be Equal As Strings    ${resp.status_code}    200
 803     [Return]    ${resp.content}
 804
 805 Create And Configure Security Group
 806     [Arguments]    ${sg-name}
 807     [Documentation]    Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
 808     OpenStackOperations.Neutron Security Group Create    ${sg-name}
 809     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
 810     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
 811     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=ingress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
 812     OpenStackOperations.Neutron Security Group Rule Create    ${sg-name}    direction=egress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
 813     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
 814     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
 815
 816 Add Security Group To VM
 817     [Arguments]    ${vm}    ${sg}
 818     [Documentation]    Add the security group provided to the given VM.
 819     ${output} =    OpenStack CLI    openstack server add security group ${vm} ${sg}
 820
 821 Remove Security Group From VM
 822     [Arguments]    ${vm}    ${sg}
 823     [Documentation]    Remove the security group provided to the given VM.
 824     OpenStackOperations.Get ControlNode Connection
 825     ${output} =    OpenStack CLI    openstack server remove security group ${vm} ${sg}
 826
 827 Create SFC Flow Classifier
 828     [Arguments]    ${name}    ${src_ip}    ${dest_ip}    ${protocol}    ${dest_port}    ${neutron_src_port}
 829     [Documentation]    Create a flow classifier for SFC
 830     ${output} =    OpenStack CLI    openstack sfc flow classifier create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --destination-port ${dest_port}:${dest_port} --logical-source-port ${neutron_src_port} ${name}
 831     BuiltIn.Should Contain    ${output}    ${name}
 832     [Return]    ${output}
 833
 834 Delete SFC Flow Classifier
 835     [Arguments]    ${name}
 836     [Documentation]    Delete a SFC flow classifier
 837     OpenStackOperations.Get ControlNode Connection
 838     ${output} =    OpenStack CLI    openstack sfc flow classifier delete ${name}
 839     [Return]    ${output}
 840
 841 Create SFC Port Pair
 842     [Arguments]    ${name}    ${port_in}    ${port_out}
 843     [Documentation]    Creates a neutron port pair for SFC
 844     OpenStackOperations.Get ControlNode Connection
 845     ${output} =    OpenStack CLI    openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
 846     BuiltIn.Should Contain    ${output}    ${name}
 847     [Return]    ${output}
 848
 849 Delete SFC Port Pair
 850     [Arguments]    ${name}
 851     [Documentation]    Delete a SFC port pair
 852     ${output} =    OpenStack CLI    openstack sfc port pair delete ${name}
 853     [Return]    ${output}
 854
 855 Create SFC Port Pair Group
 856     [Arguments]    ${name}    ${port_pair}
 857     [Documentation]    Creates a port pair group with a single port pair for SFC
 858     ${output} =    OpenStack CLI    openstack sfc port pair group create --port-pair ${port_pair} ${name}
 859     BuiltIn.Should Contain    ${output}    ${name}
 860     [Return]    ${output}
 861
 862 Create SFC Port Pair Group With Two Pairs
 863     [Arguments]    ${name}    ${port_pair1}    ${port_pair2}
 864     [Documentation]    Creates a port pair group with two port pairs for SFC
 865     ${output} =    OpenStack CLI    openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
 866     BuiltIn.Should Contain    ${output}    ${name}
 867     [Return]    ${output}
 868
 869 Delete SFC Port Pair Group
 870     [Arguments]    ${name}
 871     [Documentation]    Delete a SFC port pair group
 872     OpenStackOperations.Get ControlNode Connection
 873     ${output} =    OpenStack CLI    openstack sfc port pair group delete ${name}
 874     [Return]    ${output}
 875
 876 Create SFC Port Chain
 877     [Arguments]    ${name}    ${pg1}    ${pg2}    ${fc}
 878     [Documentation]    Creates a port pair chain with two port groups and a singel classifier.
 879     ${output} =    OpenStack CLI    openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
 880     BuiltIn.Should Contain    ${output}    ${name}
 881     [Return]    ${output}
 882
 883 Delete SFC Port Chain
 884     [Arguments]    ${name}
 885     [Documentation]    Delete a SFC port chain
 886     ${output} =    OpenStack CLI    openstack sfc port chain delete ${name}
 887     [Return]    ${output}
 888
 889 Reboot Nova VM
 890     [Arguments]    ${vm_name}
 891     [Documentation]    Reboot NOVA VM
 892     ${output} =    OpenStack CLI    openstack server reboot --wait ${vm_name}
 893     BuiltIn.Wait Until Keyword Succeeds    35s    10s    OpenStackOperations.Verify VM Is ACTIVE    ${vm_name}
 894
 895 Remove RSA Key From KnownHosts
 896     [Arguments]    ${vm_ip}
 897     [Documentation]    Remove RSA
 898     OpenStackOperations.Get ControlNode Connection
 899     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo cat /root/.ssh/known_hosts    30s
 900     ${output} =    DevstackUtils.Write Commands Until Prompt And Log    sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip}    30s
 901     ${output} =    DevstackUtils.Write Commands Until Prompt    sudo cat "/root/.ssh/known_hosts"    30s
 902
 903 Wait For Routes To Propogate
 904     [Arguments]    ${networks}    ${subnets}
 905     [Documentation]    Check propagated routes
 906     OpenStackOperations.Get ControlNode Connection
 907     : FOR    ${INDEX}    IN RANGE    0    1
 908     \    ${net_id} =    OpenStackOperations.Get Net Id    @{networks}[${INDEX}]
 909     \    ${is_ipv6} =    String.Get Regexp Matches    @{subnets}[${INDEX}]    ${IP6_REGEX}
 910     \    ${length} =    BuiltIn.Get Length    ${is_ipv6}
 911     \    ${cmd} =    BuiltIn.Set Variable If    ${length} == 0    ip route    ip -6 route
 912     \    ${output} =    Utils.Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ${cmd}    ]>
 913     \    BuiltIn.Should Contain    ${output}    @{subnets}[${INDEX}]
 914
 915 Neutron Cleanup
 916     [Arguments]    ${vms}=@{EMPTY}    ${networks}=@{EMPTY}    ${subnets}=@{EMPTY}    ${ports}=@{EMPTY}    ${sgs}=@{EMPTY}
 917     : FOR    ${vm}    IN    @{vms}
 918     \    BuiltIn.Run Keyword And Ignore Error    Delete Vm Instance    ${vm}
 919     : FOR    ${port}    IN    @{ports}
 920     \    BuiltIn.Run Keyword And Ignore Error    Delete Port    ${port}
 921     : FOR    ${subnet}    IN    @{subnets}
 922     \    BuiltIn.Run Keyword And Ignore Error    Delete SubNet    ${subnet}
 923     : FOR    ${network}    IN    @{networks}
 924     \    BuiltIn.Run Keyword And Ignore Error    Delete Network    ${network}
 925     : FOR    ${sg}    IN    @{sgs}
 926     \    BuiltIn.Run Keyword And Ignore Error    Delete SecurityGroup    ${sg}
 927
 928 OpenStack List All
 929     [Documentation]    Get a list of different OpenStack resources that might be in use.
 930     @{modules} =    BuiltIn.Create List    server    port    network    subnet    security group
 931     ...    security group rule
 932     BuiltIn.Run Keyword If    "${ODL_ENABLE_L3_FWD}"=="yes"    Collections.Append To List    ${modules}    floating ip    router
 933     : FOR    ${module}    IN    @{modules}
 934     \    ${output} =    OpenStack CLI    openstack ${module} list
 935
 936 OpenStack CLI Get List
 937     [Arguments]    ${cmd}
 938     [Documentation]    Return a json list from the output of an OpenStack command.
 939     @{list} =    BuiltIn.Create List
 940     ${json} =    OpenStack CLI    ${cmd}
 941     @{list} =    RequestsLibrary.To Json    ${json}
 942     BuiltIn.Log    ${list}
 943     [Return]    @{list}
 944
 945 OpenStack CLI
 946     [Arguments]    ${cmd}
 947     [Documentation]    Run the given OpenStack ${cmd} and log the output.
 948     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${cmd}
 949     BuiltIn.Log    ${output}
 950     BuiltIn.Should Be True    '${rc}' == '0'
 951     [Return]    ${output}
 952
 953 OpenStack CLI With No Log
 954     [Arguments]    ${cmd}
 955     [Documentation]    Run the given OpenStack ${cmd} and do not log the output.
 956     ${rc}    ${output} =    OperatingSystem.Run And Return Rc And Output    ${cmd}
 957     BuiltIn.Should Be True    '${rc}' == '0'
 958     [Return]    ${output}
 959
 960 OpenStack Cleanup All
 961     [Documentation]    Cleanup all Openstack resources with best effort. The keyword will query for all resources
 962     ...    in use and then attempt to delete them. Errors are ignored to allow the cleanup to continue.
 963     @{fips} =    BuiltIn.Run Keyword If    "${ODL_ENABLE_L3_FWD}"=="yes"    OpenStack CLI Get List    openstack floating ip list -f json
 964     ...    ELSE    BuiltIn.Create List    @{EMPTY}
 965     : FOR    ${fip}    IN    @{fips}
 966     \    BuiltIn.Run Keyword And Ignore Error    Delete Floating IP    ${fip['ID']}
 967     @{vms} =    OpenStack CLI Get List    openstack server list -f json
 968     : FOR    ${vm}    IN    @{vms}
 969     \    BuiltIn.Run Keyword And Ignore Error    Delete Vm Instance    ${vm['ID']}
 970     @{routers} =    BuiltIn.Run Keyword If    "${ODL_ENABLE_L3_FWD}"=="yes"    OpenStack CLI Get List    openstack router list -f json
 971     ...    ELSE    BuiltIn.Create List    @{EMPTY}
 972     : FOR    ${router}    IN    @{routers}
 973     \    BuiltIn.Run Keyword And Ignore Error    Cleanup Router    ${router['ID']}
 974     @{ports} =    OpenStack CLI Get List    openstack port list -f json
 975     : FOR    ${port}    IN    @{ports}
 976     \    BuiltIn.Run Keyword And Ignore Error    Delete Port    ${port['ID']}
 977     @{networks} =    OpenStack CLI Get List    openstack network list -f json
 978     : FOR    ${network}    IN    @{networks}
 979     \    BuiltIn.Run Keyword And Ignore Error    Delete Subnet    ${network['Subnets']}
 980     \    BuiltIn.Run Keyword And Ignore Error    Delete Network    ${network['ID']}
 981     @{security_groups} =    OpenStack CLI Get List    openstack security group list -f json
 982     : FOR    ${security_group}    IN    @{security_groups}
 983     \    BuiltIn.Run Keyword If    "${security_group['Name']}" != "default"    BuiltIn.Run Keyword And Ignore Error    Delete SecurityGroup    ${security_group['ID']}
 984     OpenStack List All
 985
 986 Cleanup Router
 987     [Arguments]    ${id}
 988     [Documentation]    Delete a router, but first remove any interfaces or gateways so that the delete will be successful.
 989     @{ports} =    OpenStack CLI Get List    openstack port list --router ${id} -f json --long
 990     : FOR    ${port}    IN    @{ports}
 991     \    ${subnet_id} =    OpenStackOperations.Get Match    ${port['Fixed IP Addresses']}    ${REGEX_UUID}    0
 992     \    BuiltIn.Run Keyword If    "${port['Device Owner']}" == "network:router_gateway"    BuiltIn.Run Keyword And Ignore Error    Remove Gateway    ${id}
 993     \    BuiltIn.Run Keyword If    "${port['Device Owner']}" == "network:router_interface"    BuiltIn.Run Keyword And Ignore Error    Remove Interface    ${id}    ${subnet_id}
 994     BuiltIn.Run Keyword And Ignore Error    Delete Router    ${id}
 995
 996 OpenStack Suite Setup
 997     [Documentation]    Wrapper teardown keyword that can be used in any suite running in an openstack environement
 998     SetupUtils.Setup_Utils_For_Setup_And_Teardown
 999     @{loggers} =    BuiltIn.Create List    org.apache.karaf.shell.support.ShellUtil
1000     Setuputils.Setup_Logging_For_Debug_Purposes_On_List_Or_All    OFF    ${loggers}
1001     DevstackUtils.Devstack Suite Setup
1002     @{tcpdump_port_6653_conn_ids} =    OpenStackOperations.Start Packet Capture On Nodes    tcpdump_port_6653    port 6653    @{OS_ALL_IPS}
1003     BuiltIn.Set Suite Variable    @{tcpdump_port_6653_conn_ids}
1004     BuiltIn.Run Keyword If    "${PRE_CLEAN_OPENSTACK_ALL}"=="True"    OpenStack Cleanup All
1005     OpenStackOperations.Add OVS Logging On All OpenStack Nodes
1006
1007 OpenStack Suite Teardown
1008     [Documentation]    Wrapper teardown keyword that can be used in any suite running in an openstack environement
1009     ...    to clean up all openstack resources. For example, all instances, networks, ports, etc will be listed and
1010     ...    and deleted. As other global cleanup tasks are needed, they can be added here and the suites will all
1011     ...    benefit automatically.
1012     OpenStack Cleanup All
1013     OpenStackOperations.Stop Packet Capture On Nodes    ${tcpdump_port_6653_conn_ids}
1014     SSHLibrary.Close All Connections
1015     : FOR    ${i}    IN RANGE    ${NUM_ODL_SYSTEM}
1016     \    KarafKeywords.Issue Command On Karaf Console    threads --list | wc -l    ${ODL_SYSTEM_${i+1}_IP}
1017
1018 Copy DHCP Files From Control Node
1019     [Documentation]    Copy the current DHCP files to the robot vm. The keyword must be called
1020     ...    after the subnet(s) are created and before the subnet(s) are deleted.
1021     ${suite_} =    BuiltIn.Evaluate    """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1022     ${dstdir} =    BuiltIn.Set Variable    /tmp/qdhcp/${suite_}
1023     OperatingSystem.Create Directory    ${dstdir}
1024     OpenStackOperations.Get ControlNode Connection
1025     BuiltIn.Run Keyword And Ignore Error    SSHLibrary.Get Directory    /opt/stack/data/neutron/dhcp    ${dstdir}    recursive=True
1026
1027 Is Feature Installed
1028     [Arguments]    ${features}=none
1029     : FOR    ${feature}    IN    @{features}
1030     \    ${status}    ${output}    BuiltIn.Run Keyword And Ignore Error    BuiltIn.Should Contain    ${CONTROLLERFEATURES}    ${feature}
1031     \    Return From Keyword If    "${status}" == "PASS"    True
1032     [Return]    False
1033
1034 Add OVS Logging On All OpenStack Nodes
1035     [Documentation]    Add higher levels of OVS logging to all the OpenStack nodes
1036     BuiltIn.Run Keyword If    0 < ${NUM_OS_SYSTEM}    OVSDB.Add OVS Logging    ${OS_CNTL_CONN_ID}
1037     BuiltIn.Run Keyword If    1 < ${NUM_OS_SYSTEM}    OVSDB.Add OVS Logging    ${OS_CMP1_CONN_ID}
1038     BuiltIn.Run Keyword If    2 < ${NUM_OS_SYSTEM}    OVSDB.Add OVS Logging    ${OS_CMP2_CONN_ID}
1039
1040 Reset OVS Logging On All OpenStack Nodes
1041     [Documentation]    Reset the OVS logging to all the OpenStack nodes
1042     BuiltIn.Run Keyword If    0 < ${NUM_OS_SYSTEM}    OVSDB.Reset OVS Logging    ${OS_CNTL_CONN_ID}
1043     BuiltIn.Run Keyword If    1 < ${NUM_OS_SYSTEM}    OVSDB.Reset OVS Logging    ${OS_CMP1_CONN_ID}
1044     BuiltIn.Run Keyword If    2 < ${NUM_OS_SYSTEM}    OVSDB.Reset OVS Logging    ${OS_CMP2_CONN_ID}
1045
1046 Start Packet Capture On Nodes
1047     [Arguments]    ${tag}    ${filter}    @{ips}
1048     [Documentation]    Wrapper keyword around the TcpDump packet capture that is catered to the Openstack setup.
1049     ...    The caller must pass the three arguments with a variable number of ips at the end,
1050     ...    but ${EMPTY} can be used for the tag and filter.
1051     ${suite_} =    BuiltIn.Evaluate    """${SUITE_NAME}""".replace(" ","_").replace("/","_").replace(".","_")
1052     ${tag_} =    BuiltIn.Catenate    SEPARATOR=__    ${tag}    ${suite_}
1053     @{conn_ids} =    Tcpdump.Start Packet Capture on Nodes    tag=${tag_}    filter=${filter}    ips=${ips}
1054     [Return]    @{conn_ids}
1055
1056 Stop Packet Capture On Nodes
1057     [Arguments]    ${conn_ids}=@{EMPTY}
1058     Tcpdump.Stop Packet Capture on Nodes    ${conn_ids}