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