From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id D5A3545825;
	Fri, 23 Aug 2024 23:16:32 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 6E01A43396;
	Fri, 23 Aug 2024 23:16:24 +0200 (CEST)
Received: from mail-oo1-f45.google.com (mail-oo1-f45.google.com
 [209.85.161.45]) by mails.dpdk.org (Postfix) with ESMTP id 4AB8E4338E
 for <dev@dpdk.org>; Fri, 23 Aug 2024 23:16:21 +0200 (CEST)
Received: by mail-oo1-f45.google.com with SMTP id
 006d021491bc7-5d5b22f97b7so2460177eaf.2
 for <dev@dpdk.org>; Fri, 23 Aug 2024 14:16:21 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=iol.unh.edu; s=unh-iol; t=1724447780; x=1725052580; darn=dpdk.org;
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:from:to:cc:subject:date
 :message-id:reply-to;
 bh=65MAFDlNd63SKMuOD5B7yEm/OVIlg/LFZDZeKmvNMEE=;
 b=JUSecGgr9ZuswnCkQB+yKbLbI1H+3QrGKTzJzjkJfyZBKA6qK38EuJ9dQd7eJOXUkD
 j7MD0KZ52UyouMA2M1c9DW3nWJQ4RMa5xROs8vs1c2hgQckqsZ9sIQ4SpWzwWEAgEIkY
 M8RDlP4tWBPIft5RgZEalxp8WdyTqw0O+7O7A=
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1724447780; x=1725052580;
 h=content-transfer-encoding:mime-version:references:in-reply-to
 :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
 :subject:date:message-id:reply-to;
 bh=65MAFDlNd63SKMuOD5B7yEm/OVIlg/LFZDZeKmvNMEE=;
 b=ha7gxu2hSe92PN+79kkCj+v5OkrEga5O7qYAxQxU/PAZcT+veOHzZ3+z78McOV6g9J
 taJqZcWqs0tTxn0T9wikwUOe2xv2eKIQZW3BQ1DvEf2xK2YdmFu8gd3k1VcdgejW7DKZ
 rOZt5v2xPX9FQ5OfjY3z2dNgFVqr+CKb4vP1vpkh9ntk5pEEbkVYHQ0cApGTgSpp6K/E
 VuWI5bc04YKmWPWmAneTbptR3QsPBxKGSx5jS7LvhM/zbkvqYX/0OchOKf20Kx4OJ1xe
 PTD5Pn1yLMaqjSdZt7D3dcBqaXH1TBQ5Bs8vXpFMh3ztftI5Jierk22NJppC53soPXGb
 3uHg==
X-Gm-Message-State: AOJu0Yx/N9YvJ92F/4MgHh6+oVqJ5K82lbLOQDNyHgnak+fC+MXyh4GX
 MWOpxG+ZXS5bg+o9bpwifV0l1TooOKsLonsFEq8P+y3187JTeW0h18SejjiaAlU=
X-Google-Smtp-Source: AGHT+IH8daYwCF78q0/c6Q2XaPXVEPb4vAbNE+PqnWw5o4yAv0GsBY7xEZ8BDaVkSF6eucI0ph3Cpw==
X-Received: by 2002:a05:6808:1908:b0:3dd:3303:1d51 with SMTP id
 5614622812f47-3de2a872282mr4361559b6e.4.1724447780472; 
 Fri, 23 Aug 2024 14:16:20 -0700 (PDT)
Received: from dean-laptop.iol.unh.edu
 ([2606:4100:3880:1271:f9bd:24da:464d:6294])
 by smtp.gmail.com with ESMTPSA id
 d75a77b69052e-454fe0f75b5sm21177671cf.58.2024.08.23.14.16.19
 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
 Fri, 23 Aug 2024 14:16:19 -0700 (PDT)
From: Dean Marx <dmarx@iol.unh.edu>
To: probb@iol.unh.edu, npratte@iol.unh.edu, jspewock@iol.unh.edu,
 luca.vizzarro@arm.com, yoan.picchi@foss.arm.com,
 Honnappa.Nagarahalli@arm.com, paul.szczepanek@arm.com,
 juraj.linkes@pantheon.tech
Cc: dev@dpdk.org,
	Dean Marx <dmarx@iol.unh.edu>
Subject: [PATCH v14 2/2] dts: VLAN test suite implementation
Date: Fri, 23 Aug 2024 17:16:37 -0400
Message-ID: <20240823211637.30046-3-dmarx@iol.unh.edu>
X-Mailer: git-send-email 2.44.0
In-Reply-To: <20240823211637.30046-1-dmarx@iol.unh.edu>
References: <20240807194341.26102-1-dmarx@iol.unh.edu>
 <20240823211637.30046-1-dmarx@iol.unh.edu>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

Test suite for verifying VLAN filtering, stripping, and insertion
functionality on Poll Mode Driver.

Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
---
 dts/framework/config/conf_yaml_schema.json |   3 +-
 dts/tests/TestSuite_vlan.py                | 167 +++++++++++++++++++++
 2 files changed, 169 insertions(+), 1 deletion(-)
 create mode 100644 dts/tests/TestSuite_vlan.py

diff --git a/dts/framework/config/conf_yaml_schema.json b/dts/framework/config/conf_yaml_schema.json
index f02a310bb5..cd45902cc4 100644
--- a/dts/framework/config/conf_yaml_schema.json
+++ b/dts/framework/config/conf_yaml_schema.json
@@ -187,7 +187,8 @@
       "enum": [
         "hello_world",
         "os_udp",
-        "pmd_buffer_scatter"
+        "pmd_buffer_scatter",
+        "vlan"
       ]
     },
     "test_target": {
diff --git a/dts/tests/TestSuite_vlan.py b/dts/tests/TestSuite_vlan.py
new file mode 100644
index 0000000000..4f722b775e
--- /dev/null
+++ b/dts/tests/TestSuite_vlan.py
@@ -0,0 +1,167 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2024 University of New Hampshire
+
+"""Test the support of VLAN Offload Features by Poll Mode Drivers.
+
+This test suite verifies that VLAN filtering, stripping, and header insertion all
+function as expected. When a VLAN ID is in the filter list, all packets with that
+ID should be forwarded and all others should be dropped. While stripping is enabled,
+packets sent with a VLAN ID should have the ID removed and then be forwarded.
+Additionally, when header insertion is enabled packets without a
+VLAN ID should have a specified ID inserted and then be forwarded.
+
+"""
+
+from scapy.layers.l2 import Dot1Q, Ether  # type: ignore[import-untyped]
+from scapy.packet import Raw  # type: ignore[import-untyped]
+
+from framework.remote_session.testpmd_shell import SimpleForwardingModes, TestPmdShell
+from framework.test_suite import TestSuite
+
+
+class TestVlan(TestSuite):
+    """DPDK VLAN test suite.
+
+    Ensures VLAN packet reception, stripping, and insertion on the Poll Mode Driver
+    when the appropriate conditions are met. The suite contains four test cases:
+
+    1. VLAN reception no stripping - verifies that a vlan packet with a tag
+    within the filter list is received.
+    2. VLAN reception stripping - verifies that a vlan packet with a tag
+    within the filter list is received without the vlan tag.
+    3. VLAN no reception - verifies that a vlan packet with a tag not within
+    the filter list is dropped.
+    4. VLAN insertion - verifies that a non vlan packet is received with a vlan
+    tag when insertion is enabled.
+    """
+
+    def set_up_suite(self) -> None:
+        """Set up the test suite.
+
+        Setup:
+            Verify that at least two ports are open for session.
+        """
+        self.verify(len(self._port_links) > 1, "Not enough ports")
+
+    def send_vlan_packet_and_verify(self, should_receive: bool, strip: bool, vlan_id: int) -> None:
+        """Generate a vlan packet, send and verify packet with same payload is received on the dut.
+
+        Args:
+            should_receive: Indicate whether the packet should be successfully received.
+            strip: If :data:`False`, will verify received packets match the given VLAN ID,
+                otherwise verifies that the received packet has no VLAN ID
+                (as it has been stripped off.)
+            vlan_id: Expected vlan ID.
+        """
+        packet = Ether() / Dot1Q(vlan=vlan_id) / Raw(load="xxxxx")
+        received_packets = self.send_packet_and_capture(packet)
+        test_packet = None
+        for packet in received_packets:
+            if hasattr(packet, "load") and b"xxxxx" in packet.load:
+                test_packet = packet
+                break
+        if should_receive:
+            self.verify(
+                test_packet is not None, "Packet was dropped when it should have been received"
+            )
+            if test_packet is not None:
+                if strip:
+                    self.verify(
+                        not test_packet.haslayer(Dot1Q), "Vlan tag was not stripped successfully"
+                    )
+                else:
+                    self.verify(
+                        test_packet.vlan == vlan_id,
+                        "The received tag did not match the expected tag",
+                    )
+        else:
+            self.verify(
+                test_packet is None,
+                "Packet was received when it should have been dropped",
+            )
+
+    def send_packet_and_verify_insertion(self, expected_id: int) -> None:
+        """Generate a packet with no vlan tag, send and verify on the dut.
+
+        Args:
+            expected_id: The vlan id that is being inserted through tx_offload configuration.
+        """
+        packet = Ether() / Raw(load="xxxxx")
+        received_packets = self.send_packet_and_capture(packet)
+        test_packet = None
+        for packet in received_packets:
+            if b"xxxxx" in packet.load:
+                test_packet = packet
+                break
+        self.verify(test_packet is not None, "Packet was dropped when it should have been received")
+        if test_packet is not None:
+            self.verify(test_packet.haslayer(Dot1Q), "The received packet did not have a vlan tag")
+            self.verify(
+                test_packet.vlan == expected_id, "The received tag did not match the expected tag"
+            )
+
+    def vlan_setup(self, testpmd: TestPmdShell, port_id: int, filtered_id: int) -> TestPmdShell:
+        """Setup method for all test cases.
+
+        Args:
+            testpmd: Testpmd shell session to send commands to.
+            port_id: Number of port to use for setup.
+            filtered_id: ID to be added to the vlan filter list.
+
+        Returns:
+            TestPmdShell: Testpmd session being configured.
+        """
+        testpmd.set_forward_mode(SimpleForwardingModes.mac)
+        testpmd.set_promisc(port_id, False)
+        testpmd.vlan_filter_set(port=port_id, on=True)
+        testpmd.rx_vlan(vlan=filtered_id, port=port_id, add=True)
+        return testpmd
+
+    def test_vlan_receipt_no_stripping(self) -> None:
+        """Verify packets are received with their VLAN IDs when stripping is disabled.
+
+        Test:
+            Create an interactive testpmd shell and verify a vlan packet.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd = self.vlan_setup(testpmd=testpmd, port_id=0, filtered_id=1)
+            testpmd.start()
+            self.send_vlan_packet_and_verify(True, strip=False, vlan_id=1)
+
+    def test_vlan_receipt_stripping(self) -> None:
+        """Ensure vlan packet received with no tag when receipts and header stripping are enabled.
+
+        Test:
+            Create an interactive testpmd shell and verify a vlan packet.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd = self.vlan_setup(testpmd=testpmd, port_id=0, filtered_id=1)
+            testpmd.vlan_strip_set(port=0, on=True)
+            testpmd.start()
+            self.send_vlan_packet_and_verify(should_receive=True, strip=True, vlan_id=1)
+
+    def test_vlan_no_receipt(self) -> None:
+        """Ensure vlan packet dropped when filter is on and sent tag not in the filter list.
+
+        Test:
+            Create an interactive testpmd shell and verify a vlan packet.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd = self.vlan_setup(testpmd=testpmd, port_id=0, filtered_id=1)
+            testpmd.start()
+            self.send_vlan_packet_and_verify(should_receive=False, strip=False, vlan_id=2)
+
+    def test_vlan_header_insertion(self) -> None:
+        """Ensure that vlan packet is received with the correct inserted vlan tag.
+
+        Test:
+            Create an interactive testpmd shell and verify a non-vlan packet.
+        """
+        with TestPmdShell(node=self.sut_node) as testpmd:
+            testpmd.set_forward_mode(SimpleForwardingModes.mac)
+            testpmd.set_promisc(port=0, on=False)
+            testpmd.port_stop_all()
+            testpmd.tx_vlan_set(port=1, vlan=51)
+            testpmd.port_start_all()
+            testpmd.start()
+            self.send_packet_and_verify_insertion(expected_id=51)
-- 
2.44.0