aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/robot/dhcp_client.robot
blob: 6c21fc8903300e8b959eaef38029463082ef3a35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Copyright (c) 2016 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

*** Settings ***
| Library  | Collections
| Resource | resources/libraries/robot/default.robot
| Library  | resources.libraries.python.Dhcp.DhcpClient
| Library  | resources.libraries.python.TrafficScriptExecutor
| Documentation | DHCP Client specific keywords.

*** Keywords ***
| Check DHCP DISCOVER header
| | [Documentation] | Check if DHCP DISCOVER message contains all required
| | ... | fields.
| | ...
| | ... | *Arguments:*
| | ... | - tg_node - TG node. Type: dictionary
| | ... | - interface - TG interface where listen for DHCP DISCOVER message.
| | ... |   Type: string
| | ... | - src_mac - DHCP client MAC address. Type: string
| | ... | - hostname - DHCP client hostname (Optional, Default="", if not
| | ... |   specified, the hostname is not checked). Type: string
| | ...
| | ... | *Return:*
| | ... | - No value returned.
| | ...
| | ... | *Example:*
| | ...
| | ... | \| Check DHCP DISCOVER header \| ${nodes['TG']} \
| | ... | \| eth2 \| 08:00:27:66:b8:57 \|
| | ... | \| Check DHCP DISCOVER header \| ${nodes['TG']} \
| | ... | \| eth2 \| 08:00:27:66:b8:57 \| client-hostname \|
| | ...
| | [Arguments] | ${tg_node} | ${interface} | ${src_mac} | ${hostname}=${EMPTY}
| | ${interface_name}= | Get interface name | ${tg_node} | ${interface}
| | ${args}= | Catenate | --rx_if | ${interface_name} | --rx_src_mac | ${src_mac}
| | ${args}= | Run Keyword If | "${hostname}" == "" | Set Variable | ${args}
| | ...      | ELSE | Catenate | ${args} | --hostname | ${hostname}
| | Run Traffic Script On Node | dhcp/check_dhcp_discover.py
| | ... | ${tg_node} | ${args}


| Check DHCP REQUEST after OFFER
| | [Documentation] | Check if DHCP REQUEST message contains all required
| | ... | fields. DHCP REQUEST should be send by a client after DHCP OFFER
| | ... | message sent by a server.
| | ...
| | ... | *Arguments:*
| | ... | - tg_node - TG node. Type: dictionary
| | ... | - tg_interface - TG interface where listen for DHCP DISCOVER,
| | ... |   send DHCP OFFER and listen for DHCP REQUEST messages. Type: string
| | ... | - server_mac - DHCP server MAC address. Type: string
| | ... | - server_ip - DHCP server IP address. Type: string
| | ... | - client_mac - DHCP client MAC address. Type: string
| | ... | - client_ip - IP address that should be offered to client.
| | ... |   Type: string
| | ... | - client_mask - IP netmask that should be offered to client.
| | ... |   Type: string
| | ... | - hostname - DHCP client hostname (Optional, Default="", if not
| | ... |   specified, the hostname is not checked). Type: string
| | ... | - offer_xid - Transaction ID (Optional, Default="", if not specified
| | ... |   xid field in DHCP OFFER is same as in DHCP DISCOVER message).
| | ... |   Type: integer
| | ...
| | ... | *Return:*
| | ... | - No value returned.
| | ...
| | ... | *Raises:*
| | ... | - DHCP REQUEST Rx timeout - if no DHCP REQUEST is received.
| | ...
| | ... | *Example:*
| | ...
| | ... | \| Check DHCP REQUEST after OFFER \| ${nodes['TG']} \
| | ... | \| eth2 \| 08:00:27:66:b8:57 \| 192.168.23.1 \
| | ... | \| 08:00:27:46:2b:4c \| 192.168.23.10 \| 255.255.255.0 \|
| | ...
| | ... | \| Run Keyword And Expect Error \| DHCP REQUEST Rx timeout \
| | ... | \| Check DHCP REQUEST after OFFER \
| | ... | \| ${nodes['TG']} \| eth2 \| 08:00:27:66:b8:57 \| 192.168.23.1 \
| | ... | \| 08:00:27:46:2b:4c \| 192.168.23.10 \| 255.255.255.0 \
| | ... | \| offer_xid=11113333 \|
| | ...
| | [Arguments] | ${tg_node} | ${tg_interface} | ${server_mac} | ${server_ip}
| | ... | ${client_mac} | ${client_ip} | ${client_mask}
| | ... | ${hostname}=${EMPTY} | ${offer_xid}=${EMPTY}
| | ${tg_interface_name}= | Get interface name | ${tg_node} | ${tg_interface}
| | ${args}= | Catenate | --rx_if | ${tg_interface_name} | --server_mac
| | ... | ${server_mac} | --server_ip | ${server_ip} | --client_mac
| | ... | ${client_mac} | --client_ip | ${client_ip} | --client_mask
| | ... | ${client_mask}
| | ${args}= | Run Keyword If | "${hostname}" == "" | Set Variable | ${args}
| | ...      | ELSE | Catenate | ${args} | --hostname | ${hostname}
| | ${args}= | Run Keyword If | "${offer_xid}" == "" | Set Variable | ${args}
| | ...      | ELSE | Catenate | ${args} | --offer_xid | ${offer_xid}
| | Run Traffic Script On Node | dhcp/check_dhcp_request.py
| | ... | ${tg_node} | ${args}


| Send IP configuration to client via DHCP
| | [Documentation] | Run script that sends IP configuration to the DHCP client.
| | ...
| | ... | *Arguments:*
| | ... | - tg_node - TG node. Type: dictionary
| | ... | - tg_interface - TG interface where listen for DHCP DISCOVER,
| | ... |   send DHCP OFFER and DHCP ACK after DHCP REQUEST messages.
| | ... |   Type: string
| | ... | - server_mac - DHCP server MAC address. Type: string
| | ... | - server_ip - DHCP server IP address. Type: string
| | ... | - client_ip - IP address that is offered to client. Type: string
| | ... | - client_mask - IP netmask that is offered to client. Type: string
| | ... | - lease_time - IP lease time in seconds. Type: integer
| | ...
| | ... | *Return:*
| | ... | - No value returned.
| | ...
| | ... | *Example:*
| | ...
| | ... | \| Send IP configuration to client via DHCP \| ${nodes['TG']} \
| | ... | \| eth2 \| 08:00:27:66:b8:57 \| 192.168.23.1 \
| | ... | \| 192.168.23.10 \| 255.255.255.0 \| 86400 \|
| | ...
| | [Arguments] | ${tg_node} | ${tg_interface}
| | ... | ${server_mac} | ${server_ip} | ${client_ip} | ${client_mask}
| | ... | ${lease_time}
| | ${tg_interface_name}= | Get interface name | ${tg_node} | ${tg_interface}
| | ${args}= | Catenate | --rx_if | ${tg_interface_name}
| | ... | --server_mac | ${server_mac} | --server_ip | ${server_ip}
| | ... | --client_ip | ${client_ip} | --client_mask | ${client_mask}
| | ... | --lease_time | ${lease_time}
| | Run Traffic Script On Node | dhcp/check_dhcp_request_ack.py
| | ... | ${tg_node} | ${args}