Add test VPP honors DHCPv4 lease time

-JIRA: CSIT-130

Change-Id: I1d0a92e8865021ac5c85e63256e1b75a839d4ce9
Signed-off-by: Matej Klotton <mklotton@cisco.com>

5 files changed, 315 insertions, 0 deletions

diff --git a/resources/libraries/robot/dhcp_client.robot b/resources/libraries/robot/dhcp_client.robot
index 99a772e273..0dd5e7bbe6 100644
--- a/resources/libraries/robot/dhcp_client.robot
+++ b/resources/libraries/robot/dhcp_client.robot
@@ -102,3 +102,37 @@
 | | ...      | 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}
+| | ${args}= | Catenate | --rx_if | ${tg_interface}
+| | ... | --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}
diff --git a/resources/libraries/robot/ipv4.robot b/resources/libraries/robot/ipv4.robot
index 9e31076772..4464cbc53c 100644
--- a/resources/libraries/robot/ipv4.robot
+++ b/resources/libraries/robot/ipv4.robot
@@ -125,3 +125,32 @@
 | | :FOR | ${dut_node} | ${interface} | ${address} | ${prefix} | IN | @{args}
 | | | Set Interface Address | ${dut_node} | ${interface} | ${address}
 | | | ... | ${prefix}
+
+| Node replies to ICMP echo request
+| | [Documentation] | Run traffic script that waits for ICMP reply and ignores
+| | ...             | all other packets.
+| | ...
+| | ... | *Arguments:*
+| | ... | - tg_node - TG node where run traffic script. Type: dictionary
+| | ... | - tg_interface - TG interface where send ICMP echo request.
+| | ... |   Type: string
+| | ... | - dst_mac - Destination MAC address. Type: string
+| | ... | - src_mac - Source MAC address. Type: string
+| | ... | - dst_ip - Destination IP address. Type: string
+| | ... | - src_ip - Source IP address. Type: string
+| | ... | - timeout - Wait timeout in seconds (Default: 10). Type: integer
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Node replies to ICMP echo request \
+| | ... | \| ${nodes['TG']} \| eth2 \
+| | ... | \| 08:00:27:46:2b:4c \| 08:00:27:66:b8:57 \
+| | ... | \| 192.168.23.10 \| 192.168.23.1 \| 10 \|
+| | ...
+| | [Arguments] | ${tg_node} | ${tg_interface}
+| | ... | ${dst_mac} | ${src_mac} | ${dst_ip} | ${src_ip} | ${timeout}=${10}
+| | ${args}= | Catenate | --rx_if | ${tg_interface} | --tx_if | ${tg_interface}
+| | ... | --dst_mac | ${dst_mac} | --src_mac | ${src_mac}
+| | ... | --dst_ip | ${dst_ip} | --src_ip | ${src_ip} | --timeout | ${timeout}
+| | Run Traffic Script On Node | send_icmp_wait_for_reply.py
+| | ... | ${tg_node} | ${args}
diff --git a/resources/traffic_scripts/dhcp/check_dhcp_request_ack.py b/resources/traffic_scripts/dhcp/check_dhcp_request_ack.py
new file mode 100755
index 0000000000..8a3839cda7
--- /dev/null
+++ b/resources/traffic_scripts/dhcp/check_dhcp_request_ack.py
@@ -0,0 +1,132 @@
+#!/usr/bin/env python
+# 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.
+
+"""Traffic script that sends a DHCP ACK message when DHCP REQUEST message is
+received."""
+
+import sys
+
+from scapy.layers.l2 import Ether
+from scapy.layers.inet import IP, UDP
+from scapy.layers.dhcp import BOOTP, DHCP
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+def is_discover(pkt):
+    """If DHCP message type option is set to dhcp discover return True,
+    else return False. False is returned also if exception occurs."""
+    dhcp_discover = 1
+    try:
+        dhcp_options = pkt['BOOTP']['DHCP options'].options
+        message_type = filter(lambda x: x[0] == 'message-type',
+                              dhcp_options)
+        message_type = message_type[0][1]
+        return message_type == dhcp_discover
+    except:
+        return False
+
+
+def is_request(pkt):
+    """If DHCP message type option is DHCP REQUEST return True,
+    else return False. False is returned also if exception occurs."""
+    dhcp_request = 3
+    try:
+        dhcp_options = pkt['BOOTP']['DHCP options'].options
+        message_type = filter(lambda x: x[0] == 'message-type',
+                              dhcp_options)
+        message_type = message_type[0][1]
+        return message_type == dhcp_request
+    except:
+        return False
+
+
+def main():
+    """Main function of the script file."""
+    args = TrafficScriptArg(['server_mac', 'server_ip', 'client_ip',
+                             'client_mask', 'lease_time'])
+
+    server_if = args.get_arg('rx_if')
+    server_mac = args.get_arg('server_mac')
+    server_ip = args.get_arg('server_ip')
+
+    client_ip = args.get_arg('client_ip')
+    client_mask = args.get_arg('client_mask')
+
+    lease_time = int(args.get_arg('lease_time'))
+
+    rxq = RxQueue(server_if)
+    txq = TxQueue(server_if)
+    sent_packets = []
+
+    for _ in range(10):
+        dhcp_discover = rxq.recv(10)
+        if is_discover(dhcp_discover):
+            break
+    else:
+        raise RuntimeError("DHCP DISCOVER Rx error.")
+
+    dhcp_offer = Ether(src=server_mac, dst=dhcp_discover.src)
+    dhcp_offer /= IP(src=server_ip, dst="255.255.255.255")
+    dhcp_offer /= UDP(sport=67, dport=68)
+    dhcp_offer /= BOOTP(op=2,
+                        xid=dhcp_discover['BOOTP'].xid,
+                        yiaddr=client_ip,
+                        siaddr=server_ip,
+                        chaddr=dhcp_discover['BOOTP'].chaddr)
+    dhcp_offer_options = [("message-type", "offer"),  # Option 53
+                          ("subnet_mask", client_mask),  # Option 1
+                          ("server_id", server_ip),  # Option 54, dhcp server
+                          ("lease_time", lease_time),  # Option 51
+                          "end"]
+    dhcp_offer /= DHCP(options=dhcp_offer_options)
+
+    txq.send(dhcp_offer)
+    sent_packets.append(dhcp_offer)
+
+    max_other_pkts = 10
+    for _ in range(0, max_other_pkts):
+        dhcp_request = rxq.recv(5, sent_packets)
+        if not dhcp_request:
+            raise RuntimeError("DHCP REQUEST Rx timeout.")
+        if is_request(dhcp_request):
+            break
+    else:
+        raise RuntimeError("Max RX packet limit reached.")
+
+    # Send dhcp ack
+    dhcp_ack = Ether(src=server_mac, dst=dhcp_request.src)
+    dhcp_ack /= IP(src=server_ip, dst="255.255.255.255")
+    dhcp_ack /= UDP(sport=67, dport=68)
+    dhcp_ack /= BOOTP(op=2,
+                      xid=dhcp_request['BOOTP'].xid,
+                      yiaddr=client_ip,
+                      siaddr=server_ip,
+                      flags=dhcp_request['BOOTP'].flags,
+                      chaddr=dhcp_request['BOOTP'].chaddr)
+    dhcp_ack_options = [("message-type", "ack"),  # Option 53. 5: ACK, 6: NAK
+                        ("subnet_mask", client_mask),  # Option 1
+                        ("server_id", server_ip),  # Option 54, dhcp server
+                        ("lease_time", lease_time),  # Option 51,
+                        "end"]
+    dhcp_ack /= DHCP(options=dhcp_ack_options)
+
+    txq.send(dhcp_ack)
+    sent_packets.append(dhcp_ack)
+
+    sys.exit(0)
+
+if __name__ == "__main__":
+    main()
diff --git a/resources/traffic_scripts/send_icmp_wait_for_reply.py b/resources/traffic_scripts/send_icmp_wait_for_reply.py
new file mode 100755
index 0000000000..3c8b71abc8
--- /dev/null
+++ b/resources/traffic_scripts/send_icmp_wait_for_reply.py
@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+# 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.
+
+"""Traffic script that sends an IP ICMPv4."""
+
+import sys
+
+from scapy.layers.inet import ICMP, IP
+from scapy.all import Ether
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+def is_icmp_reply(pkt):
+    """Return True if pkt is echo reply, else return False. If exception occurs
+    return False."""
+    try:
+        if pkt['IP']['ICMP'].type == 0:  # 0 - echo-reply
+            return True
+        else:
+            return False
+    except:
+        return False
+
+
+def address_check(request, reply):
+    """Compare request packet source address with reply destination address
+    and vice versa. If exception occurs return False."""
+    try:
+        return reply['IP'].src == request['IP'].dst \
+               and reply['IP'].dst == request['IP'].src
+    except:
+        return False
+
+
+def main():
+    """Send ICMP echo request and wait for ICMP echo reply. It ignores all other
+    packets."""
+    args = TrafficScriptArg(['dst_mac', 'src_mac', 'dst_ip', 'src_ip',
+                             'timeout'])
+
+    dst_mac = args.get_arg('dst_mac')
+    src_mac = args.get_arg('src_mac')
+    dst_ip = args.get_arg('dst_ip')
+    src_ip = args.get_arg('src_ip')
+    tx_if = args.get_arg('tx_if')
+    rx_if = args.get_arg('rx_if')
+    timeout = int(args.get_arg('timeout'))
+    wait_step = 1
+
+    rxq = RxQueue(rx_if)
+    txq = TxQueue(tx_if)
+    sent_packets = []
+
+    # Create empty ip ICMP packet
+    icmp_request = (Ether(src=src_mac, dst=dst_mac) /
+                    IP(src=src_ip, dst=dst_ip) /
+                    ICMP())
+    # Send created packet on the interface
+    sent_packets.append(icmp_request)
+    txq.send(icmp_request)
+
+    for _ in range(1000):
+        icmp_reply = rxq.recv(wait_step)
+        if icmp_reply is None:
+            timeout -= wait_step
+            if timeout < 0:
+                raise RuntimeError("ICMP echo Rx timeout")
+        elif is_icmp_reply(icmp_reply):
+            if address_check(icmp_request, icmp_reply):
+                break
+    else:
+        raise RuntimeError("Max packet count limit reached")
+
+    print "ICMP echo reply received."
+
+    sys.exit(0)
+
+if __name__ == "__main__":
+    main()
diff --git a/tests/suites/dhcp/dhcp_client.robot b/tests/suites/dhcp/dhcp_client.robot
index 44a6d54c2a..bf019320ad 100644
--- a/tests/suites/dhcp/dhcp_client.robot
+++ b/tests/suites/dhcp/dhcp_client.robot
@@ -29,6 +29,7 @@
 | ${client_mask}= | 255.255.255.0
 | ${server_ip}= | 192.168.23.1
 | ${own_xid}= | 11112222
+| ${lease_time}= | ${15}
 
 *** Test Cases ***
 | VPP sends a DHCP DISCOVER
@@ -87,3 +88,30 @@
 | |       ... | ${tg_to_dut_if1_mac} | ${server_ip}
 | |       ... | ${dut_to_tg_if1_mac} | ${client_ip} | ${client_mask}
 | |       ... | offer_xid=${own_xid}
+
+| VPP honors DHCPv4 lease time
+| | [Documentation] | Send IP configuration to the VPP client via DHCP. Address
+| | ...             | is checked with ICMP echo request and there should be no
+| | ...             | reply for echo request when lease has expired.
+| | ...
+| | Given Path for 2-node testing is set
+| |       ... | ${nodes['TG']} | ${nodes['DUT1']} | ${nodes['TG']}
+| | And   Interfaces in 2-node path are up
+| | And   VPP Route Add | ${dut_node} | 255.255.255.255 | 32 | ${NONE} | local
+| |       ... | ${FALSE} | ${NONE}
+| | When  Set DHCP client on Interface | ${dut_node} | ${dut_to_tg_if1}
+| | And   Send IP configuration to client via DHCP
+| |       ... | ${tg_node} | ${tg_to_dut_if1}
+| |       ... | ${tg_to_dut_if1_mac} | ${server_ip}
+| |       ... | ${client_ip} | ${client_mask}
+| |       ... | ${lease_time}
+| | And   Add Arp On Dut | ${dut_node} | ${dut_to_tg_if1} | ${server_ip}
+| |       ... | ${tg_to_dut_if1_mac}
+| | Then  Node replies to ICMP echo request | ${tg_node} | ${tg_to_dut_if1}
+| |       ... | ${dut_to_tg_if1_mac} | ${tg_to_dut_if1_mac} | ${client_ip}
+| |       ... | ${server_ip}
+| | And   Sleep | ${lease_time}
+| | And   Run Keyword And Expect Error | ICMP echo Rx timeout
+| |       ... | Node replies to ICMP echo request | ${tg_node}
+| |       ... | ${tg_to_dut_if1} | ${dut_to_tg_if1_mac} | ${tg_to_dut_if1_mac}
+| |       ... | ${client_ip} | ${server_ip}
\ No newline at end of file