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