Add test VPP honors DHCPv4 lease time

-JIRA: CSIT-130

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

2 files changed, 224 insertions, 0 deletions

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()