9052d2a369d9f7ed672958069e4d8eec81aaf1f7
[integration/test.git] / 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           SSHLibrary
5 Library           OperatingSystem
6 Resource          DataModels.robot
7 Resource          Utils.robot
8 Resource          SSHKeywords.robot
9 Resource          L2GatewayOperations.robot
10 Resource          ../variables/Variables.robot
11 Resource          ../variables/netvirt/Variables.robot
12 Variables         ../variables/netvirt/Modules.py
13
14 *** Keywords ***
15 Get Tenant ID From Security Group
16     [Documentation]    Returns tenant ID by reading it from existing default security-group.
17     ${rc}    ${output}=    Run And Return Rc And Output    openstack security group show default | grep "| tenant_id" | awk '{print $4}'
18     Should Not Be True    ${rc}
19     [Return]    ${output}
20
21 Get Tenant ID From Network
22     [Arguments]    ${network_uuid}
23     [Documentation]    Returns tenant ID by reading it from existing network.
24     ${resp}=    Get_From_Uri    uri=${CONFIG_API}/neutron:neutron/networks/network/${network_uuid}/    accept=${ACCEPT_EMPTY}    session=session
25     ${tenant_id}=    Utils.Extract Value From Content    ${resp}    /network/0/tenant-id    strip
26     [Return]    ${tenant_id}
27
28 Create Network
29     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}    ${verbose}=TRUE
30     [Documentation]    Create Network with neutron request.
31     ${rc}    ${output}=    Run And Return Rc And Output    openstack network create ${network_name} ${additional_args}
32     Log    ${output}
33     Should Not Be True    ${rc}
34     [Return]    ${output}
35
36 Update Network
37     [Arguments]    ${network_name}    ${additional_args}=${EMPTY}
38     [Documentation]    Update Network with neutron request.
39     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v net-update ${network_name} ${additional_args}    openstack network set ${network_name} ${additional_args}
40     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
41     Log    ${output}
42     Should Not Be True    ${rc}
43     [Return]    ${output}
44
45 Show Network
46     [Arguments]    ${network_name}
47     [Documentation]    Show Network with neutron request.
48     ${rc}    ${output}=    Run And Return Rc And Output    openstack network show ${network_name}
49     Log    ${output}
50     Should Not Be True    ${rc}
51     [Return]    ${output}
52
53 List Networks
54     [Documentation]    List networks and return output with neutron client.
55     ${rc}    ${output}=    Run And Return Rc And Output    openstack network list
56     Log    ${output}
57     Should Not Be True    ${rc}
58     [Return]    ${output}
59
60 List Subnets
61     [Documentation]    List subnets and return output with neutron client.
62     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet list
63     Log    ${output}
64     Should Not Be True    ${rc}
65     [Return]    ${output}
66
67 Delete Network
68     [Arguments]    ${network_name}
69     [Documentation]    Delete Network with neutron request.
70     ${rc}    ${output}=    Run And Return Rc And Output    openstack network delete ${network_name}
71     Log    ${output}
72     Should Not Be True    ${rc}
73
74 Create SubNet
75     [Arguments]    ${network_name}    ${subnet}    ${range_ip}    ${additional_args}=${EMPTY}
76     [Documentation]    Create SubNet for the Network with neutron request.
77     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet create --network ${network_name} --subnet-range ${range_ip} ${subnet} ${additional_args}
78     Log    ${output}
79     Should Not Be True    ${rc}
80
81 Update SubNet
82     [Arguments]    ${subnet_name}    ${additional_args}=${EMPTY}
83     [Documentation]    Update subnet with neutron request.
84     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v subnet-update ${subnet_name} ${additional_args}    openstack subnet set ${subnet_name} ${additional_args}
85     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
86     Log    ${output}
87     Should Not Be True    ${rc}
88     [Return]    ${output}
89
90 Show SubNet
91     [Arguments]    ${subnet_name}
92     [Documentation]    Show subnet with neutron request.
93     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet show ${subnet_name}
94     Log    ${output}
95     Should Not Be True    ${rc}
96     [Return]    ${output}
97
98 Create Port
99     [Arguments]    ${network_name}    ${port_name}    ${sg}=default    ${additional_args}=${EMPTY}    ${allowed_address_pairs}=${EMPTY}
100     [Documentation]    Create Port with neutron request.
101     # if allowed_address_pairs is not empty we need to create the arguments to pass to the port create command. They are
102     # in a different format with the neutron vs openstack cli.
103     ${address_pair_length}=    Get Length    ${allowed_address_pairs}
104     ${allowed_pairs_argv}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton' and '${address_pair_length}'=='2'    --allowed-address-pairs type=dict list=true ip_address=@{allowed_address_pairs}[0] ip_address=@{allowed_address_pairs}[1]
105     ${allowed_pairs_argv}=    Set Variable If    '${OPENSTACK_BRANCH}'!='stable/newton' and '${address_pair_length}'=='2'    --allowed-address ip-address=@{allowed_address_pairs}[0] --allowed-address ip-address=@{allowed_address_pairs}[1]    ${allowed_pairs_argv}
106     ${allowed_pairs_argv}=    Set Variable If    '${address_pair_length}'=='0'    ${EMPTY}    ${allowed_pairs_argv}
107     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v port-create ${network_name} --name ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}    openstack port create --network ${network_name} ${port_name} --security-group ${sg} ${additional_args} ${allowed_pairs_argv}
108     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
109     Log    ${output}
110     Should Not Be True    ${rc}
111
112 Update Port
113     [Arguments]    ${port_name}    ${additional_args}=${EMPTY}
114     [Documentation]    Update port with neutron request.
115     ${rc}    ${output}=    Run And Return Rc And Output    openstack port set ${port_name} ${additional_args}
116     Log    ${output}
117     Should Not Be True    ${rc}
118     [Return]    ${output}
119
120 Show Port
121     [Arguments]    ${port_name}
122     [Documentation]    Show port with neutron request.
123     ${rc}    ${output}=    Run And Return Rc And Output    openstack port show ${port_name}
124     Log    ${output}
125     Should Not Be True    ${rc}
126     [Return]    ${output}
127
128 Delete Port
129     [Arguments]    ${port_name}
130     [Documentation]    Delete Port with neutron request.
131     ${rc}    ${output}=    Run And Return Rc And Output    openstack port delete ${port_name}
132     Log    ${output}
133     Should Not Be True    ${rc}
134
135 List Ports
136     [Documentation]    List ports and return output with neutron client.
137     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list
138     Log    ${output}
139     Should Not Be True    ${rc}
140     [Return]    ${output}
141
142 List Nova VMs
143     [Documentation]    List VMs and return output with nova client.
144     ${rc}    ${output}=    Run And Return Rc And Output    openstack server list --all-projects
145     Log    ${output}
146     Should Not Be True    ${rc}
147     [Return]    ${output}
148
149 Create And Associate Floating IPs
150     [Arguments]    ${external_net}    @{vm_list}
151     [Documentation]    Create and associate floating IPs to VMs with nova request
152     ${ip_list}=    Create List    @{EMPTY}
153     : FOR    ${vm}    IN    @{vm_list}
154     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack floating ip create ${external_net}
155     \    Log    ${output}
156     \    Should Not Be True    ${rc}
157     \    @{ip}    Get Regexp Matches    ${output}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
158     \    ${ip_length}    Get Length    ${ip}
159     \    Run Keyword If    ${ip_length}>0    Append To List    ${ip_list}    @{ip}[0]
160     \    ...    ELSE    Append To List    ${ip_list}    None
161     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack server add floating ip ${vm} @{ip}[0]
162     \    Log    ${output}
163     \    Should Not Be True    ${rc}
164     [Return]    ${ip_list}
165
166 Verify Gateway Ips
167     [Documentation]    Verifies the Gateway Ips with dump flow.
168     ${output}=    Write Commands Until Prompt And Log    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
169     : FOR    ${GatewayIpElement}    IN    @{GATEWAY_IPS}
170     \    Should Contain    ${output}    ${GatewayIpElement}
171
172 Verify Dhcp Ips
173     [Documentation]    Verifies the Dhcp Ips with dump flow.
174     ${output}=    Write Commands Until Prompt And Log    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
175     : FOR    ${DhcpIpElement}    IN    @{DHCP_IPS}
176     \    Should Contain    ${output}    ${DhcpIpElement}
177
178 Verify No Dhcp Ips
179     [Documentation]    Verifies the Dhcp Ips with dump flow.
180     ${output}=    Write Commands Until Prompt And Log    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
181     : FOR    ${DhcpIpElement}    IN    @{DHCP_IPS}
182     \    Should Not Contain    ${output}    ${DhcpIpElement}
183
184 Delete SubNet
185     [Arguments]    ${subnet}
186     [Documentation]    Delete SubNet for the Network with neutron request.
187     Log    ${subnet}
188     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet delete ${subnet}
189     Should Not Be True    ${rc}
190
191 Verify No Gateway Ips
192     [Documentation]    Verifies the Gateway Ips removed with dump flow.
193     ${output}=    Write Commands Until Prompt And Log    sudo ovs-ofctl -O OpenFlow13 dump-flows br-int
194     : FOR    ${GatewayIpElement}    IN    @{GATEWAY_IPS}
195     \    Should Not Contain    ${output}    ${GatewayIpElement}
196
197 Delete Vm Instance
198     [Arguments]    ${vm_name}
199     [Documentation]    Delete Vm instances using instance names.
200     ${rc}    ${output}=    Run And Return Rc And Output    openstack server delete ${vm_name}
201     Log    ${output}
202
203 Get Net Id
204     [Arguments]    ${network_name}    ${devstack_conn_id}
205     [Documentation]    Retrieve the net id for the given network name to create specific vm instance
206     ${rc}    ${output}=    Run And Return Rc And Output    openstack network list | grep "${network_name}" | awk '{print $2}'
207     Should Not Be True    ${rc}
208     ${splitted_output}=    Split String    ${output}    ${EMPTY}
209     ${net_id}=    Get from List    ${splitted_output}    0
210     [Return]    ${net_id}
211
212 Get Subnet Id
213     [Arguments]    ${subnet_name}    ${devstack_conn_id}
214     [Documentation]    Retrieve the subnet id for the given subnet name
215     ${rc}    ${output}=    Run And Return Rc And Output    openstack subnet show "${subnet_name}" | grep " id " | awk '{print $4}'
216     Should Not Be True    ${rc}
217     ${splitted_output}=    Split String    ${output}    ${EMPTY}
218     ${subnet_id}=    Get from List    ${splitted_output}    0
219     [Return]    ${subnet_id}
220
221 Get Port Id
222     [Arguments]    ${port_name}    ${devstack_conn_id}
223     [Documentation]    Retrieve the port id for the given port name to attach specific vm instance to a particular port
224     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list | grep "${port_name}" | awk '{print $2}'
225     Should Not Be True    ${rc}
226     ${splitted_output}=    Split String    ${output}    ${EMPTY}
227     ${port_id}=    Get from List    ${splitted_output}    0
228     [Return]    ${port_id}
229
230 Get Router Id
231     [Arguments]    ${router1}    ${devstack_conn_id}
232     [Documentation]    Retrieve the router id for the given router name
233     ${rc}    ${output}=    Run And Return Rc And Output    openstack router list -f table | grep "${router1}" | awk '{print $2}'
234     Should Not Be True    ${rc}
235     ${splitted_output}=    Split String    ${output}    ${EMPTY}
236     ${router_id}=    Get from List    ${splitted_output}    0
237     [Return]    ${router_id}
238
239 Create Vm Instances
240     [Arguments]    ${net_name}    ${vm_instance_names}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default    ${min}=1
241     ...    ${max}=1
242     [Documentation]    Create X Vm Instance with the net id of the Netowrk.
243     ${image}    Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
244     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
245     : FOR    ${VmElement}    IN    @{vm_instance_names}
246     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic net-id=${net_id} ${VmElement} --security-group ${sg} --min ${min} --max ${max}
247     \    Should Not Be True    ${rc}
248     \    Log    ${output}
249
250 Create Vm Instance With Port
251     [Arguments]    ${port_name}    ${vm_instance_name}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
252     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
253     ${image}    Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
254     ${port_id}=    Get Port Id    ${port_name}    ${devstack_conn_id}
255     ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} ${vm_instance_name} --security-group ${sg}
256     Log    ${output}
257
258 Create Vm Instance With Ports
259     [Arguments]    ${port_name}    ${port2_name}    ${vm_instance_name}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
260     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
261     ${image}    Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
262     ${port_id}=    Get Port Id    ${port_name}    ${devstack_conn_id}
263     ${port2_id}=    Get Port Id    ${port2_name}    ${devstack_conn_id}
264     ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --nic port-id=${port2_id} ${vm_instance_name} --security-group ${sg}
265     Log    ${output}
266     Should Not Be True    ${rc}
267
268 Create Vm Instance With Port On Compute Node
269     [Arguments]    ${port_name}    ${vm_instance_name}    ${compute_node}    ${image}=${EMPTY}    ${flavor}=m1.nano    ${sg}=default
270     [Documentation]    Create One VM instance using given ${port_name} and for given ${compute_node}
271     ${image}    Set Variable If    "${image}"=="${EMPTY}"    ${CIRROS_${OPENSTACK_BRANCH}}    ${image}
272     ${port_id}=    Get Port Id    ${port_name}    ${devstack_conn_id}
273     ${hostname_compute_node}=    Get Hypervisor Hostname From IP    ${compute_node}
274     ${rc}    ${output}=    Run And Return Rc And Output    openstack server create --image ${image} --flavor ${flavor} --nic port-id=${port_id} --security-group ${sg} --availability-zone nova:${hostname_compute_node} ${vm_instance_name}
275     Log    ${output}
276     Should Not Be True    ${rc}
277
278 Get Hypervisor Hostname From IP
279     [Arguments]    ${hypervisor_ip}
280     [Documentation]    Returns the hostname found for the given IP address if it's listed in hypervisor list. For debuggability
281     ...    the full listing is logged first, then followed by a grep | cut to focus on the actual hostname to return
282     ${rc}    ${output}    Run And Return Rc And Output    openstack hypervisor list
283     Log    ${output}
284     ${rc}    ${hostname}=    Run And Return Rc And Output    openstack hypervisor list -f value | grep ${hypervisor_ip} | cut -d" " -f 2
285     Log    ${hostname}
286     Should Not Be True    ${rc}
287     [Return]    ${hostname}
288
289 Create Nano Flavor
290     [Documentation]    Create a nano flavor
291     ${rc}    ${output}=    Run And Return Rc And Output    openstack flavor create m1.nano --id auto --ram 64 --disk 0 --vcpus 1
292     Log    ${output}
293     Should Not Be True    ${rc}
294
295 Verify VM Is ACTIVE
296     [Arguments]    ${vm_name}
297     [Documentation]    Run these commands to check whether the created vm instance is active or not.
298     ${rc}    ${output}=    Run And Return Rc And Output    openstack server show ${vm_name} | grep OS-EXT-STS:vm_state
299     Should Be True    '${rc}' == '0'
300     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     Wait Until Keyword Succeeds    ${retry}    ${retry_interval}    Verify VM Is ACTIVE    ${vm_name}
306
307 Collect VM IP Addresses
308     [Arguments]    ${fail_on_none}    @{vm_list}
309     [Documentation]    Using the console-log on the provided ${vm_list} to search for the string "obtained" which
310     ...    correlates to the instance receiving it's IP address via DHCP. Also retrieved is the ip of the nameserver
311     ...    if available in the console-log output. The keyword will also return a list of the learned ips as it
312     ...    finds them in the console log output, and will have "None" for Vms that no ip was found.
313     ${ip_list}    Create List    @{EMPTY}
314     : FOR    ${vm}    IN    @{vm_list}
315     \    ${rc}    ${vm_ip_line}=    Run And Return Rc And Output    openstack console log show ${vm} | grep -i "obtained"
316     \    @{vm_ip}    Get Regexp Matches    ${vm_ip_line}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
317     \    ${vm_ip_length}    Get Length    ${vm_ip}
318     \    Run Keyword If    ${vm_ip_length}>0    Append To List    ${ip_list}    @{vm_ip}[0]
319     \    ...    ELSE    Append To List    ${ip_list}    None
320     \    ${rc}    ${dhcp_ip_line}=    Run And Return Rc And Output    openstack console log show ${vm} | grep "^nameserver"
321     \    ${dhcp_ip}    Get Regexp Matches    ${dhcp_ip_line}    [0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}
322     \    ${dhcp_ip_length}    Get Length    ${dhcp_ip}
323     \    Run Keyword If    ${dhcp_ip_length}<=0    Append To List    ${dhcp_ip}    None
324     \    ${vm_console_output}=    Run    openstack console log show ${vm}
325     \    Log    ${vm_console_output}
326     ${dhcp_length}    Get Length    ${dhcp_ip}
327     Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${ip_list}    None
328     Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${dhcp_ip}    None
329     Should Be True    ${dhcp_length} <= 1
330     Return From Keyword If    ${dhcp_length}==0    ${ip_list}    ${EMPTY}
331     [Return]    ${ip_list}    ${dhcp_ip}
332
333 Get Match
334     [Arguments]    ${text}    ${regexp}
335     [Documentation]    Wrapper around Get Regexp Matches to return None if not found or the first match if found.
336     @{matches} =    String.Get Regexp Matches    ${text}    ${regexp}
337     ${matches_length} =    Get Length    ${matches}
338     BuiltIn.Set Test Variable    ${match}    None
339     BuiltIn.Run Keyword If    ${matches_length} > 0    BuiltIn.Set Test Variable    ${match}    @{matches}[0]
340     [Return]    ${match}
341
342 Get VM IP
343     [Arguments]    ${fail_on_none}    ${vm}
344     [Documentation]    Get the vm ip address and nameserver by scraping the vm's console log.
345     ...    Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
346     ${rc}    ${vm_console_output} =    Run And Return Rc And Output    openstack console log show ${vm}
347     ${vm_ip}=    Set Variable    None
348     ${dhcp_ip}=    Set Variable    None
349     ${match} =    Get Match    ${vm_console_output}    ${REGEX_OBTAINED}
350     ${vm_ip} =    Get Match    ${match}    ${REGEX_IPV4}
351     ${match} =    Get Match    ${vm_console_output}    ${REGEX_NAMESERVER}
352     ${dhcp_ip} =    Get Match    ${match}    ${REGEX_IPV4}
353     BuiltIn.Set Test Variable    ${vm_ip}
354     BuiltIn.Set Test Variable    ${dhcp_ip}
355     BuiltIn.Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${vm_ip}    None
356     BuiltIn.Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${dhcp_ip}    None
357     [Return]    ${vm_ip}    ${dhcp_ip}    ${vm_console_output}
358
359 Get VM IPs
360     [Arguments]    @{vms}
361     [Documentation]    Get the instance IP addresses and nameserver address for the list of given vms.
362     ...    First poll for the vm instance to be in the active state, then poll for the vm ip address and nameserver.
363     ...    Get VM IP returns three values: [0] the vm IP, [1] the DHCP IP and [2] the vm console log.
364     @{vm_ips}    BuiltIn.Create List    @{EMPTY}
365     : FOR    ${vm}    IN    @{vms}
366     \    Poll VM Is ACTIVE    ${vm}
367     \    ${status}    ${ips_and_console_log}    Run Keyword And Ignore Error    Wait Until Keyword Succeeds    60s    15s
368     \    ...    Get VM IP    true    ${vm}
369     \    BuiltIn.Log    ${ips_and_console_log[2]}
370     \    BuiltIn.Run Keyword If    '${ips_and_console_log[0]}' != 'None'    Collections.Append To List    ${vm_ips}    ${ips_and_console_log[0]}
371     [Return]    @{vm_ips}    ${ips_and_console_log[1]}
372
373 Collect VM IPv6 SLAAC Addresses
374     [Arguments]    ${fail_on_none}    ${prefix}    @{vm_list}
375     [Documentation]    Using the console-log on the provided ${vm_list} to search for the string "inet6" which
376     ...    correlates to the instance generated IPv6 address, based on the ${prefix} received from ODL (SLAAC mode).
377     ${ip_list}    Create List    @{EMPTY}
378     : FOR    ${vm}    IN    @{vm_list}
379     \    Log    ${vm}
380     \    ${rc}    ${vm_ip_line}=    Run And Return Rc And Output    openstack console log show ${vm} | grep -i "inet6"
381     \    Log    ${vm_ip_line}
382     \    Log    ${rc}
383     \    @{vm_ip_list}    Get Regexp Matches    ${vm_ip_line}    ${prefix}
384     \    ${vm_ip_length}    Get Length    ${vm_ip_list}
385     \    Run Keyword If    ${vm_ip_length}>0    Append To List    ${ip_list}    @{vm_ip_list}[0]
386     \    ...    ELSE    Append To List    ${ip_list}    None
387     \    Log    ${ip_list}
388     Run Keyword If    '${fail_on_none}' == 'true'    Should Not Contain    ${ip_list}    None
389     Log    ${ip_list}
390     [Return]    ${ip_list}
391
392 View Vm Console
393     [Arguments]    ${vm_instance_names}
394     [Documentation]    View Console log of the created vm instances using nova show.
395     : FOR    ${VmElement}    IN    @{vm_instance_names}
396     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack server show ${VmElement}
397     \    Log    ${output}
398     \    Should Not Be True    ${rc}
399     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack console log show ${VmElement}
400     \    Log    ${output}
401     \    Should Not Be True    ${rc}
402
403 Ping Vm From DHCP Namespace
404     [Arguments]    ${net_name}    ${vm_ip}
405     [Documentation]    Reach all Vm Instance with the net id of the Netowrk.
406     Log    ${vm_ip}
407     ${devstack_conn_id}=    Get ControlNode Connection
408     Switch Connection    ${devstack_conn_id}
409     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
410     Log    ${net_id}
411     ${output}=    Write Commands Until Prompt And Log    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
412     Close Connection
413     Should Contain    ${output}    64 bytes
414
415 Ping From DHCP Should Not Succeed
416     [Arguments]    ${net_name}    ${vm_ip}
417     [Documentation]    Should Not Reach Vm Instance with the net id of the Netowrk.
418     Return From Keyword If    "skip_if_${SECURITY_GROUP_MODE}" in @{TEST_TAGS}
419     Log    ${vm_ip}
420     ${devstack_conn_id}=    Get ControlNode Connection
421     Switch Connection    ${devstack_conn_id}
422     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
423     Log    ${net_id}
424     ${output}=    Write Commands Until Prompt    sudo ip netns exec qdhcp-${net_id} ping -c 3 ${vm_ip}    20s
425     Close Connection
426     Log    ${output}
427     Should Not Contain    ${output}    64 bytes
428
429 Ping Vm From Control Node
430     [Arguments]    ${vm_floating_ip}    ${additional_args}=${EMPTY}
431     [Documentation]    Ping VM floating IP from control node
432     Log    ${vm_floating_ip}
433     ${devstack_conn_id}=    Get ControlNode Connection
434     Switch Connection    ${devstack_conn_id}
435     ${output}=    Write Commands Until Prompt And Log    ping ${additional_args} -c 3 ${vm_floating_ip}    20s
436     Close Connection
437     Should Contain    ${output}    64 bytes
438
439 Ping From Instance
440     [Arguments]    ${dest_vm_ip}
441     [Documentation]    Ping to the expected destination ip.
442     ${output}=    Write Commands Until Expected Prompt    ping -c 3 ${dest_vm_ip}    ${OS_SYSTEM_PROMPT}
443     Log    ${output}
444     [Return]    ${output}
445
446 Curl Metadata Server
447     [Documentation]    Ping to the expected destination ip.
448     ${output}=    Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
449     Write Commands Until Prompt    exit
450     Should Contain    ${output}    200
451
452 Close Vm Instance
453     [Documentation]    Exit the vm instance.
454     ${output}=    Write Commands Until Prompt And Log    exit
455
456 Check If Console Is VmInstance
457     [Arguments]    ${console}=cirros
458     [Documentation]    Check if the session has been able to login to the VM instance
459     ${output}=    Write Commands Until Expected Prompt    id    ${OS_SYSTEM_PROMPT}
460     Should Contain    ${output}    ${console}
461
462 Exit From Vm Console
463     [Documentation]    Check if the session has been able to login to the VM instance and exit the instance
464     ${rcode}=    Run Keyword And Return Status    Check If Console Is VmInstance    cirros
465     Run Keyword If    ${rcode}    Write Commands Until Prompt    exit
466     Close Connection
467
468 Check Ping
469     [Arguments]    ${ip_address}    ${ttl}=64
470     [Documentation]    Run Ping command on the IP available as argument
471     ${ethertype}=    Get Regexp Matches    ${ip_address}    ${IP_REGEX}
472     ${output}=    Run Keyword If    ${ethertype}    Write Commands Until Expected Prompt    ping -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
473     ...    ELSE    Write Commands Until Expected Prompt    ping6 -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
474     Should Contain    ${output}    64 bytes
475
476 Check No Ping
477     [Arguments]    ${ip_address}    ${ttl}=64
478     [Documentation]    Run Ping command to the IP given as argument, executing 3 times and expecting NOT to see "64 bytes"
479     ${output}=    Write Commands Until Expected Prompt    ping -t ${ttl} -c 3 ${ip_address}    ${OS_SYSTEM_PROMPT}
480     Should Not Contain    ${output}    64 bytes
481
482 Check Metadata Access
483     [Documentation]    Try curl on the Metadataurl and check if it is okay
484     ${output}=    Write Commands Until Expected Prompt    curl -i http://169.254.169.254    ${OS_SYSTEM_PROMPT}
485     Should Contain    ${output}    200
486
487 Execute Command on VM Instance
488     [Arguments]    ${net_name}    ${vm_ip}    ${cmd}    ${user}=cirros    ${password}=cubswin:)
489     [Documentation]    Login to the vm instance using ssh in the network, executes a command inside the VM and returns the ouput.
490     ${devstack_conn_id} =    Get ControlNode Connection
491     Switch Connection    ${devstack_conn_id}
492     ${net_id} =    Get Net Id    ${net_name}    ${devstack_conn_id}
493     Log    ${vm_ip}
494     ${output} =    Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ssh ${user}@${vm_ip} -o ConnectTimeout=10 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null    password:
495     Log    ${output}
496     ${output} =    Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
497     Log    ${output}
498     ${rcode} =    Run Keyword And Return Status    Check If Console Is VmInstance
499     ${output} =    Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    ${cmd}    ${OS_SYSTEM_PROMPT}
500     [Teardown]    Exit From Vm Console
501     [Return]    ${output}
502
503 Test Operations From Vm Instance
504     [Arguments]    ${net_name}    ${src_ip}    ${dest_ips}    ${user}=cirros    ${password}=cubswin:)    ${ttl}=64
505     ...    ${ping_should_succeed}=True    ${check_metadata}=True
506     [Documentation]    Login to the vm instance using ssh in the network.
507     ${devstack_conn_id}=    Get ControlNode Connection
508     Switch Connection    ${devstack_conn_id}
509     Log    ${src_ip}
510     ${net_id}=    Get Net Id    ${net_name}    ${devstack_conn_id}
511     ${output}=    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:
512     Log    ${output}
513     ${output}=    Write Commands Until Expected Prompt    ${password}    ${OS_SYSTEM_PROMPT}
514     Log    ${output}
515     ${rcode}=    Run Keyword And Return Status    Check If Console Is VmInstance
516     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    ifconfig    ${OS_SYSTEM_PROMPT}
517     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    route -n    ${OS_SYSTEM_PROMPT}
518     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    route -A inet6    ${OS_SYSTEM_PROMPT}
519     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    arp -an    ${OS_SYSTEM_PROMPT}
520     Run Keyword If    ${rcode}    Write Commands Until Expected Prompt    ip -6 neigh    ${OS_SYSTEM_PROMPT}
521     : FOR    ${dest_ip}    IN    @{dest_ips}
522     \    Log    ${dest_ip}
523     \    ${string_empty}=    Run Keyword And Return Status    Should Be Empty    ${dest_ip}
524     \    Run Keyword If    ${string_empty}    Continue For Loop
525     \    Run Keyword If    ${rcode} and "${ping_should_succeed}" == "True"    Check Ping    ${dest_ip}    ttl=${ttl}
526     \    ...    ELSE    Check No Ping    ${dest_ip}    ttl=${ttl}
527     ${ethertype}=    Get Regexp Matches    ${src_ip}    ${IP_REGEX}
528     Run Keyword If    ${rcode} and "${check_metadata}" and ${ethertype} == "True"    Check Metadata Access
529     [Teardown]    Exit From Vm Console
530
531 Test Netcat Operations From Vm Instance
532     [Arguments]    ${net_name}    ${vm_ip}    ${dest_ip}    ${additional_args}=${EMPTY}    ${port}=12345    ${user}=cirros
533     ...    ${password}=cubswin:)
534     [Documentation]    Use Netcat to test TCP/UDP connections to the controller
535     ${client_data}    Set Variable    Test Client Data
536     ${server_data}    Set Variable    Test Server Data
537     ${devstack_conn_id}=    Get ControlNode Connection
538     Switch Connection    ${devstack_conn_id}
539     Log    ${vm_ip}
540     ${output}=    Write Commands Until Prompt And Log    ( ( echo "${server_data}" | sudo timeout 60 nc -l ${additional_args} ${port} ) & )
541     ${output}=    Write Commands Until Prompt And Log    sudo netstat -nlap | grep ${port}
542     ${nc_output}=    Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo echo "${client_data}" | nc -v -w 5 ${additional_args} ${dest_ip} ${port}
543     Log    ${nc_output}
544     ${output}=    Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo route -n
545     Log    ${output}
546     ${output}=    Execute Command on VM Instance    ${net_name}    ${vm_ip}    sudo arp -an
547     Log    ${output}
548     Should Match Regexp    ${nc_output}    ${server_data}
549
550 Ping Other Instances
551     [Arguments]    ${list_of_external_dst_ips}
552     [Documentation]    Check reachability with other network's instances.
553     ${rcode}=    Run Keyword And Return Status    Check If Console Is VmInstance
554     : FOR    ${dest_ip}    IN    @{list_of_external_dst_ips}
555     \    Log    ${dest_ip}
556     \    Check Ping    ${dest_ip}
557
558 Create Router
559     [Arguments]    ${router_name}
560     [Documentation]    Create Router and Add Interface to the subnets.
561     ${rc}    ${output}=    Run And Return Rc And Output    openstack router create ${router_name}
562     Should Not Be True    ${rc}
563
564 List Router
565     [Documentation]    List Router and return output with neutron client.
566     ${rc}    ${output}=    Run And Return Rc And Output    openstack router list -f value
567     Log    ${output}
568     Should Not Be True    ${rc}
569     [Return]    ${output}
570
571 Add Router Interface
572     [Arguments]    ${router_name}    ${interface_name}
573     ${rc}    ${output}=    Run And Return Rc And Output    openstack router add subnet ${router_name} ${interface_name}
574     Should Not Be True    ${rc}
575
576 Show Router Interface
577     [Arguments]    ${router_name}
578     [Documentation]    List Router interface associated with given Router and return output with neutron client.
579     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list --router ${router_name} -f value
580     Should Not Be True    ${rc}
581     [Return]    ${output}
582
583 Add Router Gateway
584     [Arguments]    ${router_name}    ${external_network_name}
585     ${cmd}=    Set Variable If    '${OPENSTACK_BRANCH}'=='stable/newton'    neutron -v router-gateway-set ${router_name} ${external_network_name}    openstack router set ${router_name} --external-gateway ${external_network_name}
586     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
587     Should Not Be True    ${rc}
588
589 Remove Interface
590     [Arguments]    ${router_name}    ${interface_name}
591     [Documentation]    Remove Interface to the subnets.
592     ${rc}    ${output}=    Run And Return Rc And Output    openstack router remove subnet ${router_name} ${interface_name}
593     Should Not Be True    ${rc}
594
595 Update Router
596     [Arguments]    ${router_name}    ${cmd}
597     [Documentation]    Update the router with the command. Router name and command should be passed as argument.
598     ${rc}    ${output} =    Run And Return Rc And Output    openstack router set ${router_name} ${cmd}
599     Should Not Be True    ${rc}
600
601 Show Router
602     [Arguments]    ${router_name}    ${options}
603     [Documentation]    Show information of a given router. Router name and optional fields should be sent as arguments.
604     ${rc}    ${output} =    Run And Return Rc And Output    openstack router show ${router_name}
605     Log    ${output}
606
607 Delete Router
608     [Arguments]    ${router_name}
609     [Documentation]    Delete Router and Interface to the subnets.
610     ${rc}    ${output}=    Run And Return Rc And Output    openstack router delete ${router_name}
611     Should Not Be True    ${rc}
612
613 Get DumpFlows And Ovsconfig
614     [Arguments]    ${openstack_node_ip}
615     [Documentation]    Get the OvsConfig and Flow entries from OVS from the Openstack Node
616     Log    ${openstack_node_ip}
617     SSHLibrary.Open Connection    ${openstack_node_ip}    prompt=${DEFAULT_LINUX_PROMPT}
618     SSHKeywords.Flexible SSH Login    ${OS_USER}    ${DEVSTACK_SYSTEM_PASSWORD}
619     SSHLibrary.Set Client Configuration    timeout=${default_devstack_prompt_timeout}
620     Write Commands Until Expected Prompt    ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
621     Write Commands Until Expected Prompt    ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
622     Write Commands Until Expected Prompt    ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
623     Write Commands Until Expected Prompt    arp -an    ${DEFAULT_LINUX_PROMPT_STRICT}
624     ${nslist}=    Write Commands Until Expected Prompt    ip netns list | awk '{print $1}'    ${DEFAULT_LINUX_PROMPT_STRICT}
625     @{lines}    Split To Lines    ${nslist}    end=-1
626     : FOR    ${line}    IN    @{lines}
627     \    Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o link    ${DEFAULT_LINUX_PROMPT_STRICT}
628     \    Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip -o addr    ${DEFAULT_LINUX_PROMPT_STRICT}
629     \    Write Commands Until Expected Prompt    sudo ip netns exec ${line} ip route    ${DEFAULT_LINUX_PROMPT_STRICT}
630     Write Commands Until Expected Prompt    sudo ovs-vsctl show    ${DEFAULT_LINUX_PROMPT_STRICT}
631     Write Commands Until Expected Prompt    sudo ovs-vsctl list Open_vSwitch    ${DEFAULT_LINUX_PROMPT_STRICT}
632     Write Commands Until Expected Prompt    sudo ovs-ofctl show br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
633     Write Commands Until Expected Prompt    sudo ovs-ofctl dump-flows br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
634     Write Commands Until Expected Prompt    sudo ovs-ofctl dump-groups br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
635     Write Commands Until Expected Prompt    sudo ovs-ofctl dump-group-stats br-int -OOpenFlow13    ${DEFAULT_LINUX_PROMPT_STRICT}
636
637 Get Karaf Log Type From Test Start
638     [Arguments]    ${ip}    ${test_name}    ${type}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
639     ...    ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
640     ${cmd}    Set Variable    sed '1,/ROBOT MESSAGE: Starting test ${test_name}/d' ${log_file} | grep '${type}'
641     ${output}    Run Command On Controller    ${ip}    ${cmd}    ${user}    ${password}    ${prompt}
642     [Return]    ${output}
643
644 Get Karaf Log Types From Test Start
645     [Arguments]    ${ip}    ${test_name}    ${types}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
646     ...    ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
647     : FOR    ${type}    IN    @{types}
648     \    Get Karaf Log Type From Test Start    ${ip}    ${test_name}    ${type}    ${user}    ${password}
649     \    ...    ${prompt}    ${log_file}
650
651 Get Karaf Log Events From Test Start
652     [Arguments]    ${test_name}    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${prompt}=${ODL_SYSTEM_PROMPT}
653     ${log_types} =    Create List    ERROR    WARN    Exception
654     Run Keyword If    0 < ${NUM_ODL_SYSTEM}    Get Karaf Log Types From Test Start    ${ODL_SYSTEM_IP}    ${test_name}    ${log_types}
655     Run Keyword If    1 < ${NUM_ODL_SYSTEM}    Get Karaf Log Types From Test Start    ${ODL_SYSTEM_2_IP}    ${test_name}    ${log_types}
656     Run Keyword If    2 < ${NUM_ODL_SYSTEM}    Get Karaf Log Types From Test Start    ${ODL_SYSTEM_3_IP}    ${test_name}    ${log_types}
657
658 Get ControlNode Connection
659     ${control_conn_id}=    SSHLibrary.Open Connection    ${OS_CONTROL_NODE_IP}    prompt=${DEFAULT_LINUX_PROMPT_STRICT}
660     SSHKeywords.Flexible SSH Login    ${OS_USER}    ${DEVSTACK_SYSTEM_PASSWORD}
661     SSHLibrary.Set Client Configuration    timeout=30s
662     [Return]    ${control_conn_id}
663
664 Get OvsDebugInfo
665     [Documentation]    Get the OvsConfig and Flow entries from all Openstack nodes
666     Run Keyword If    0 < ${NUM_OS_SYSTEM}    Get DumpFlows And Ovsconfig    ${OS_CONTROL_NODE_IP}
667     Run Keyword If    1 < ${NUM_OS_SYSTEM}    Get DumpFlows And Ovsconfig    ${OS_COMPUTE_1_IP}
668     Run Keyword If    2 < ${NUM_OS_SYSTEM}    Get DumpFlows And Ovsconfig    ${OS_COMPUTE_2_IP}
669
670 Get Test Teardown Debugs
671     [Arguments]    ${test_name}=${TEST_NAME}
672     Get OvsDebugInfo
673     Run Keyword And Ignore Error    Get Model Dump    ${HA_PROXY_IP}    ${netvirt_data_models}
674     Get Karaf Log Events From Test Start    ${test_name}
675
676 Get Test Teardown Debugs For SFC
677     [Arguments]    ${test_name}=${TEST_NAME}
678     Run Keyword And Ignore Error    Get Model Dump    ${HA_PROXY_IP}    ${netvirt_sfc_data_models}
679
680 Show Debugs
681     [Arguments]    @{vm_indices}
682     [Documentation]    Run these commands for debugging, it can list state of VM instances and ip information in control node
683     ${devstack_conn_id}=    Get ControlNode Connection
684     Switch Connection    ${devstack_conn_id}
685     ${output}=    Write Commands Until Prompt And Log    sudo ip netns list
686     Close Connection
687     : FOR    ${index}    IN    @{vm_indices}
688     \    ${rc}    ${output}=    Run And Return Rc And Output    nova show ${index}
689     \    Log    ${output}
690     List Nova VMs
691     List Networks
692     List Subnets
693     List Ports
694
695 Neutron Security Group Show
696     [Arguments]    ${SecurityGroupRuleName}
697     [Documentation]    Displays the neutron security group configurations that belongs to a given neutron security group name
698     ${rc}    ${output}=    Run And Return Rc And Output    openstack security group show ${SecurityGroupRuleName}
699     Log    ${output}
700     Should Not Be True    ${rc}
701     [Return]    ${output}
702
703 Neutron Port Show
704     [Arguments]    ${PortName}
705     [Documentation]    Display the port configuration that belong to a given neutron port
706     ${rc}    ${output}=    Run And Return Rc And Output    openstack port show ${PortName}
707     Log    ${output}
708     Should Not Be True    ${rc}
709     [Return]    ${output}
710
711 Neutron Security Group Create
712     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
713     [Documentation]    Create a security group with specified name ,description & protocol value according to security group template
714     ${devstack_conn_id}=    Get ControlNode Connection
715     Switch Connection    ${devstack_conn_id}
716     ${rc}    ${output}=    Run And Return Rc And Output    openstack security group create ${SecurityGroupName} ${additional_args}
717     Log    ${output}
718     Should Not Be True    ${rc}
719     ${sgp_id}=    Should Match Regexp    ${output}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
720     Log    ${sgp_id}
721     [Return]    ${output}    ${sgp_id}
722
723 Neutron Security Group Update
724     [Arguments]    ${SecurityGroupName}    ${additional_args}=${EMPTY}
725     [Documentation]    Updating security groups
726     ${rc}    ${output}=    Run And Return Rc And Output    openstack security group set ${SecurityGroupName} ${additional_args}
727     Log    ${output}
728     Should Not Be True    ${rc}
729     [Return]    ${output}
730
731 Delete SecurityGroup
732     [Arguments]    ${sg_name}
733     [Documentation]    Delete Security group
734     ${rc}    ${output}=    Run And Return Rc And Output    openstack security group delete ${sg_name}
735     Log    ${output}
736     Should Not Be True    ${rc}
737
738 Neutron Security Group Rule Create
739     [Arguments]    ${Security_group_name}    &{Kwargs}
740     [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 catenated with mandatory args, example of usage: "Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
741     Run Keyword If    ${Kwargs}    Log    ${Kwargs}
742     ${description}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    description    default=${None}
743     ${direction}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    direction    default=${None}
744     ${ethertype}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    ethertype    default=${None}
745     ${port_range_max}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_max    default=${None}
746     ${port_range_min}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_min    default=${None}
747     ${protocol}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    protocol    default=${None}
748     ${remote_group_id}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_group_id    default=${None}
749     ${remote_ip_prefix}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_ip_prefix    default=${None}
750     ${cmd}=    Set Variable    openstack security group rule create ${Security_group_name}
751     ${cmd}=    Run Keyword If    '${description}'!='None'    Catenate    ${cmd}    --description ${description}
752     ...    ELSE    Catenate    ${cmd}
753     ${cmd}=    Run Keyword If    '${direction}'!='None'    Catenate    ${cmd}    --${direction}
754     ...    ELSE    Catenate    ${cmd}
755     ${cmd}=    Run Keyword If    '${ethertype}'!='None'    Catenate    ${cmd}    --ethertype ${ethertype}
756     ...    ELSE    Catenate    ${cmd}
757     ${cmd}=    Run Keyword If    '${port_range_min}'!='None' and '${port_range_max}'!='None'    Catenate    ${cmd}    --dst-port ${port_range_min}:${port_range_max}
758     ...    ELSE IF    '${port_range_max}'!='None'    Catenate    ${cmd}    --dst-port ${port_range_max}
759     ...    ELSE IF    '${port_range_min}'!='None'    Catenate    ${cmd}    --dst-port ${port_range_min}
760     ...    ELSE    Catenate    ${cmd}
761     ${cmd}=    Run Keyword If    '${protocol}'!='None'    Catenate    ${cmd}    --protocol ${protocol}
762     ...    ELSE    Catenate    ${cmd}
763     ${cmd}=    Run Keyword If    '${remote_group_id}'!='None'    Catenate    ${cmd}    --remote-group ${remote_group_id}
764     ...    ELSE    Catenate    ${cmd}
765     ${cmd}=    Run Keyword If    '${remote_ip_prefix}'!='None'    Catenate    ${cmd}    --src-ip ${remote_ip_prefix}
766     ...    ELSE    Catenate    ${cmd}
767     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
768     ${rule_id}=    Should Match Regexp    ${output}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
769     Log    ${rule_id}
770     Should Not Be True    ${rc}
771     [Return]    ${output}    ${rule_id}
772
773 Neutron Security Group Rule Create Legacy Cli
774     [Arguments]    ${Security_group_name}    &{Kwargs}
775     [Documentation]    Creates neutron security rule with neutron request 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 catenated with mandatory args, example of usage: "Neutron Security Group Rule Create ${SGP_SSH} direction=${RULE_PARAMS[0]} ethertype=${RULE_PARAMS[1]} ..."
776     Run Keyword If    ${Kwargs}    Log    ${Kwargs}
777     ${description}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    description    default=${None}
778     ${direction}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    direction    default=${None}
779     ${ethertype}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    ethertype    default=${None}
780     ${port_range_max}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_max    default=${None}
781     ${port_range_min}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    port_range_min    default=${None}
782     ${protocol}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    protocol    default=${None}
783     ${remote_group_id}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_group_id    default=${None}
784     ${remote_ip_prefix}    Run Keyword If    ${Kwargs}    Pop From Dictionary    ${Kwargs}    remote_ip_prefix    default=${None}
785     ${cmd}=    Set Variable    neutron security-group-rule-create ${Security_group_name}
786     ${cmd}=    Run Keyword If    '${description}'!='None'    Catenate    ${cmd}    --description ${description}
787     ...    ELSE    Catenate    ${cmd}
788     ${cmd}=    Run Keyword If    '${direction}'!='None'    Catenate    ${cmd}    --direction ${direction}
789     ...    ELSE    Catenate    ${cmd}
790     ${cmd}=    Run Keyword If    '${ethertype}'!='None'    Catenate    ${cmd}    --ethertype ${ethertype}
791     ...    ELSE    Catenate    ${cmd}
792     ${cmd}=    Run Keyword If    '${port_range_max}'!='None'    Catenate    ${cmd}    --port_range_max ${port_range_max}
793     ...    ELSE    Catenate    ${cmd}
794     ${cmd}=    Run Keyword If    '${port_range_min}'!='None'    Catenate    ${cmd}    --port_range_min ${port_range_min}
795     ...    ELSE    Catenate    ${cmd}
796     ${cmd}=    Run Keyword If    '${protocol}'!='None'    Catenate    ${cmd}    --protocol ${protocol}
797     ...    ELSE    Catenate    ${cmd}
798     ${cmd}=    Run Keyword If    '${remote_group_id}'!='None'    Catenate    ${cmd}    --remote_group_id ${remote_group_id}
799     ...    ELSE    Catenate    ${cmd}
800     ${cmd}=    Run Keyword If    '${remote_ip_prefix}'!='None'    Catenate    ${cmd}    --remote_ip_prefix ${remote_ip_prefix}
801     ...    ELSE    Catenate    ${cmd}
802     ${rc}    ${output}=    Run And Return Rc And Output    ${cmd}
803     ${rule_id}=    Should Match Regexp    ${output}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
804     Log    ${rule_id}
805     Should Not Be True    ${rc}
806     [Return]    ${output}    ${rule_id}
807
808 Security Group Create Without Default Security Rules
809     [Arguments]    ${sg_name}    ${additional_args}=${EMPTY}
810     [Documentation]    Create Neutron Security Group with no default rules, using specified name and optional arguments.
811     Neutron Security Group Create    ${sg_name}    ${additional_args}
812     Delete All Security Group Rules    ${sg_name}
813
814 Delete All Security Group Rules
815     [Arguments]    ${sg_name}
816     [Documentation]    Delete all security rules from a specified security group
817     ${rc}    ${sg_rules_output}=    Run And Return Rc And Output    openstack security group rule list ${sg_name} -cID -fvalue
818     Log    ${sg_rules_output}
819     Should Not Be True    ${rc}
820     @{sg_rules}=    Split String    ${sg_rules_output}    \n
821     : FOR    ${rule}    IN    @{sg_rules}
822     \    ${rc}    ${output}=    Run And Return Rc And Output    openstack security group rule delete ${rule}
823     \    Log    ${output}
824     \    Should Not Be True    ${rc}
825
826 Create Allow All SecurityGroup
827     [Arguments]    ${sg_name}    ${ether_type}=IPv4
828     [Documentation]    Allow all TCP/UDP/ICMP packets for this suite
829     Neutron Security Group Create    ${sg_name}
830     Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=tcp
831     Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=tcp
832     Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    protocol=icmp
833     Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    protocol=icmp
834     Neutron Security Group Rule Create    ${sg_name}    direction=ingress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=udp
835     Neutron Security Group Rule Create    ${sg_name}    direction=egress    ethertype=${ether_type}    port_range_max=65535    port_range_min=1    protocol=udp
836
837 Create Neutron Port With Additional Params
838     [Arguments]    ${network_name}    ${port_name}    ${additional_args}=${EMPTY}
839     [Documentation]    Create Port With given additional parameters
840     ${rc}    ${output}=    Run And Return Rc And Output    neutron -v port-create ${network_name} --name ${port_name} ${additional_args}
841     Log    ${output}
842     Should Not Be True    ${rc}
843     ${port_id}=    Should Match Regexp    ${OUTPUT}    [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
844     Log    ${port_id}
845     [Return]    ${OUTPUT}    ${port_id}
846
847 Get Ports MacAddr
848     [Arguments]    ${portName_list}
849     [Documentation]    Retrieve the port MacAddr for the given list of port name and return the MAC address list.
850     ${MacAddr-list}    Create List
851     : FOR    ${portName}    IN    @{portName_list}
852     \    ${macAddr}=    OpenStackOperations.Get Port Mac    ${portName}    ${devstack_conn_id}
853     \    Append To List    ${MacAddr-list}    ${macAddr}
854     [Return]    ${MacAddr-list}
855
856 Get Port Ip
857     [Arguments]    ${port_name}
858     [Documentation]    Keyword would return the IP of the ${port_name} received.
859     ${rc}    ${output}=    Run And Return Rc And Output    openstack port list | grep "${port_name}" | awk -F\\' '{print $2}'
860     ${splitted_output}=    Split String    ${output}    ${EMPTY}
861     ${port_ip}=    Get from List    ${splitted_output}    0
862     Should Not Be True    ${rc}
863     [Return]    ${port_ip}
864
865 Get Port Mac
866     [Arguments]    ${port_name}    ${conn_id}=${devstack_conn_id}
867     [Documentation]    Keyword would return the MAC ID of the ${port_name} received.
868     ${rc}    ${output}=    Run And Return Rc And Output    openstack port show ${port_name} | grep mac_address | awk '{print $4}'
869     ${splitted_output}=    Split String    ${output}    ${EMPTY}
870     ${port_mac}=    Get from List    ${splitted_output}    0
871     Should Not Be True    ${rc}
872     [Return]    ${port_mac}
873
874 Create L2Gateway
875     [Arguments]    ${bridge_name}    ${intf_name}    ${gw_name}
876     [Documentation]    Keyword to create an L2 Gateway ${gw_name} for bridge ${bridge_name} connected to interface ${intf_name} (Using Neutron CLI).
877     ${rc}    ${l2gw_output}=    Run And Return Rc And Output    ${L2GW_CREATE} name=${bridge_name},interface_names=${intf_name} ${gw_name}
878     Log    ${l2gw_output}
879     [Return]    ${l2gw_output}
880
881 Create L2Gateway Connection
882     [Arguments]    ${gw_name}    ${net_name}
883     [Documentation]    Keyword would create a new L2 Gateway Connection for ${gw_name} to ${net_name} (Using Neutron CLI).
884     ${rc}    ${l2gw_output}=    Run And Return Rc And Output    ${L2GW_CONN_CREATE} ${gw_name} ${net_name}
885     Log    ${l2gw_output}
886     Should Not Be True    ${rc}
887     [Return]    ${l2gw_output}
888
889 Get All L2Gateway
890     [Documentation]    Keyword to return all the L2 Gateways available (Using Neutron CLI).
891     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET_YAML}
892     Should Not Be True    ${rc}
893     [Return]    ${output}
894
895 Get All L2Gateway Connection
896     [Documentation]    Keyword to return all the L2 Gateway connections available (Using Neutron CLI).
897     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET_CONN_YAML}
898     Should Not Be True    ${rc}
899     [Return]    ${output}
900
901 Get L2Gateway
902     [Arguments]    ${gw_id}
903     [Documentation]    Keyword to check if the ${gw_id} is available in the L2 Gateway list (Using Neutron CLI).
904     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_SHOW} ${gw_id}
905     Log    ${output}
906     Should Not Be True    ${rc}
907     [Return]    ${output}
908
909 Get L2gw Id
910     [Arguments]    ${l2gw_name}
911     [Documentation]    Keyword to retrieve the L2 Gateway ID for the ${l2gw_name} (Using Neutron CLI).
912     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET} | grep "${l2gw_name}" | awk '{print $2}'
913     Log    ${output}
914     Should Not Be True    ${rc}
915     ${splitted_output}=    Split String    ${output}    ${EMPTY}
916     ${l2gw_id}=    Get from List    ${splitted_output}    0
917     [Return]    ${l2gw_id}
918
919 Get L2gw Connection Id
920     [Arguments]    ${l2gw_name}
921     [Documentation]    Keyword to retrieve the L2 Gateway Connection ID for the ${l2gw_name} (Using Neutron CLI).
922     ${l2gw_id}=    OpenStackOperations.Get L2gw Id    ${l2gw_name}
923     ${rc}    ${output}=    Run And Return Rc And Output    ${L2GW_GET_CONN} | grep "${l2gw_id}" | awk '{print $2}'
924     Should Not Be True    ${rc}
925     ${splitted_output}=    Split String    ${output}    ${EMPTY}
926     ${splitted_output}=    Split String    ${output}    ${EMPTY}
927     ${l2gw_conn_id}=    Get from List    ${splitted_output}    0
928     [Return]    ${l2gw_conn_id}
929
930 Neutron Port List Rest
931     [Documentation]    Keyword to get all ports details in Neutron (Using REST).
932     ${resp} =    RequestsLibrary.Get Request    session    ${PORT_URL}
933     Log    ${resp.content}
934     Should Be Equal As Strings    ${resp.status_code}    200
935     [Return]    ${resp.content}
936
937 Get Neutron Port Rest
938     [Arguments]    ${port_id}
939     [Documentation]    Keyword to get the specific port details in Neutron (Using REST).
940     ${resp} =    RequestsLibrary.Get Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}
941     Log    ${resp.content}
942     Should Be Equal As Strings    ${resp.status_code}    200
943     [Return]    ${resp.content}
944
945 Update Port Rest
946     [Arguments]    ${port_id}    ${json_data}
947     [Documentation]    Keyword to update ${port_id} with json data received in ${json_data} (Using REST).
948     Log    ${json_data}
949     ${resp} =    RequestsLibrary.Put Request    session    ${CONFIG_API}/${GET_PORT_URL}/${port_id}    ${json_data}
950     Log    ${resp.content}
951     Should Be Equal As Strings    ${resp.status_code}    200
952     [Return]    ${resp.content}
953
954 Create And Configure Security Group
955     [Arguments]    ${sg-name}
956     [Documentation]    Create Security Group with given name, and default allow rules for TCP/UDP/ICMP protocols.
957     Neutron Security Group Create    ${sg-name}
958     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
959     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
960     Neutron Security Group Rule Create    ${sg-name}    direction=ingress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
961     Neutron Security Group Rule Create    ${sg-name}    direction=egress    protocol=icmp    remote_ip_prefix=0.0.0.0/0
962     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
963     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
964
965 Add Security Group To VM
966     [Arguments]    ${vm}    ${sg}
967     [Documentation]    Add the security group provided to the given VM.
968     ${rc}    ${output}=    Run And Return Rc And Output    openstack server add security group ${vm} ${sg}
969     Log    ${output}
970     Should Not Be True    ${rc}
971
972 Remove Security Group From VM
973     [Arguments]    ${vm}    ${sg}
974     [Documentation]    Remove the security group provided to the given VM.
975     ${devstack_conn_id}=    Get ControlNode Connection
976     Switch Connection    ${devstack_conn_id}
977     ${output}=    Write Commands Until Prompt And Log    openstack server remove security group ${vm} ${sg}
978     Close Connection
979
980 Create SFC Flow Classifier
981     [Arguments]    ${name}    ${src_ip}    ${dest_ip}    ${protocol}    ${dest_port}    ${neutron_src_port}
982     [Documentation]    Create a flow classifier for SFC
983     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc flow classifier create --ethertype IPv4 --source-ip-prefix ${src_ip}/32 --destination-ip-prefix ${dest_ip}/32 --protocol ${protocol} --destination-port ${dest_port}:${dest_port} --logical-source-port ${neutron_src_port} ${name}
984     Log    ${output}
985     Should Not Be True    ${rc}
986     Should Contain    ${output}    ${name}
987     [Return]    ${output}
988
989 Delete SFC Flow Classifier
990     [Arguments]    ${name}
991     [Documentation]    Delete a SFC flow classifier
992     ${devstack_conn_id}=    Get ControlNode Connection
993     Switch Connection    ${devstack_conn_id}
994     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc flow classifier delete ${name}
995     Log    ${output}
996     Should Not Be True    ${rc}
997     [Return]    ${output}
998
999 Create SFC Port Pair
1000     [Arguments]    ${name}    ${port_in}    ${port_out}
1001     [Documentation]    Creates a neutron port pair for SFC
1002     ${devstack_conn_id}=    Get ControlNode Connection
1003     Switch Connection    ${devstack_conn_id}
1004     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc port pair create --ingress=${port_in} --egress=${port_out} ${name}
1005     Log    ${output}
1006     Should Not Be True    ${rc}
1007     Should Contain    ${output}    ${name}
1008     [Return]    ${output}
1009
1010 Delete SFC Port Pair
1011     [Arguments]    ${name}
1012     [Documentation]    Delete a SFC port pair
1013     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc port pair delete ${name}
1014     Log    ${output}
1015     Should Not Be True    ${rc}
1016     [Return]    ${output}
1017
1018 Create SFC Port Pair Group
1019     [Arguments]    ${name}    ${port_pair}
1020     [Documentation]    Creates a port pair group with a single port pair for SFC
1021     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc port pair group create --port-pair ${port_pair} ${name}
1022     Log    ${output}
1023     Should Not Be True    ${rc}
1024     Should Contain    ${output}    ${name}
1025     [Return]    ${output}
1026
1027 Create SFC Port Pair Group With Two Pairs
1028     [Arguments]    ${name}    ${port_pair1}    ${port_pair2}
1029     [Documentation]    Creates a port pair group with two port pairs for SFC
1030     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc port pair group create --port-pair ${port_pair1} --port-pair ${port_pair2} ${name}
1031     Log    ${output}
1032     Should Not Be True    ${rc}
1033     Should Contain    ${output}    ${name}
1034     [Return]    ${output}
1035
1036 Delete SFC Port Pair Group
1037     [Arguments]    ${name}
1038     [Documentation]    Delete a SFC port pair group
1039     ${devstack_conn_id}=    Get ControlNode Connection
1040     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc port pair group delete ${name}
1041     Log    ${output}
1042     Should Not Be True    ${rc}
1043     [Return]    ${output}
1044
1045 Create SFC Port Chain
1046     [Arguments]    ${name}    ${pg1}    ${pg2}    ${fc}
1047     [Documentation]    Creates a port pair chain with two port groups and a singel classifier.
1048     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc port chain create --port-pair-group ${pg1} --port-pair-group ${pg2} --flow-classifier ${fc} ${name}
1049     Log    ${output}
1050     Should Not Be True    ${rc}
1051     Should Contain    ${output}    ${name}
1052     [Return]    ${output}
1053
1054 Delete SFC Port Chain
1055     [Arguments]    ${name}
1056     [Documentation]    Delete a SFC port chain
1057     ${rc}    ${output}=    Run And Return Rc And Output    openstack sfc port chain delete ${name}
1058     Log    ${output}
1059     Should Not Be True    ${rc}
1060     [Return]    ${output}
1061
1062 Reboot Nova VM
1063     [Arguments]    ${vm_name}
1064     [Documentation]    Reboot NOVA VM
1065     ${rc}    ${output}=    Run And Return Rc And Output    openstack server reboot --wait ${vm_name}
1066     Log    ${output}
1067     Should Not Be True    ${rc}
1068     Wait Until Keyword Succeeds    35s    10s    Verify VM Is ACTIVE    ${vm_name}
1069
1070 Remove RSA Key From KnowHosts
1071     [Arguments]    ${vm_ip}
1072     [Documentation]    Remove RSA
1073     ${devstack_conn_id}=    Get ControlNode Connection
1074     Switch Connection    ${devstack_conn_id}
1075     ${output}=    Write Commands Until Prompt And Log    sudo cat /root/.ssh/known_hosts    30s
1076     ${output}=    Write Commands Until Prompt And Log    sudo ssh-keygen -f "/root/.ssh/known_hosts" -R ${vm_ip}    30s
1077     ${output}=    Write Commands Until Prompt    sudo cat "/root/.ssh/known_hosts"    30s
1078
1079 Wait For Routes To Propogate
1080     [Arguments]    ${networks}    ${subnets}
1081     [Documentation]    Check propagated routes
1082     ${devstack_conn_id} =    Get ControlNode Connection
1083     Switch Connection    ${devstack_conn_id}
1084     : FOR    ${INDEX}    IN RANGE    0    1
1085     \    ${net_id}=    Get Net Id    @{networks}[${INDEX}]    ${devstack_conn_id}
1086     \    ${is_ipv6}=    Get Regexp Matches    @{subnets}[${INDEX}]    ${IP6_REGEX}
1087     \    ${length}=    Get Length    ${is_ipv6}
1088     \    ${cmd}=    Set Variable If    ${length} == 0    ip route    ip -6 route
1089     \    ${output}=    Write Commands Until Expected Prompt    sudo ip netns exec qdhcp-${net_id} ${cmd}    ]>
1090     \    Should Contain    ${output}    @{subnets}[${INDEX}]