csit/libraries/OpenStackOperations.robot

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