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