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