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