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