get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/129642/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 129642,
    "url": "http://patchwork.dpdk.org/api/patches/129642/?format=api",
    "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20230719141303.33284-3-juraj.linkes@pantheon.tech/",
    "project": {
        "id": 1,
        "url": "http://patchwork.dpdk.org/api/projects/1/?format=api",
        "name": "DPDK",
        "link_name": "dpdk",
        "list_id": "dev.dpdk.org",
        "list_email": "dev@dpdk.org",
        "web_url": "http://core.dpdk.org",
        "scm_url": "git://dpdk.org/dpdk",
        "webscm_url": "http://git.dpdk.org/dpdk",
        "list_archive_url": "https://inbox.dpdk.org/dev",
        "list_archive_url_format": "https://inbox.dpdk.org/dev/{}",
        "commit_url_format": ""
    },
    "msgid": "<20230719141303.33284-3-juraj.linkes@pantheon.tech>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20230719141303.33284-3-juraj.linkes@pantheon.tech",
    "date": "2023-07-19T14:12:59",
    "name": "[v3,2/6] dts: add traffic generator config",
    "commit_ref": null,
    "pull_url": null,
    "state": "accepted",
    "archived": true,
    "hash": "b034ff4a8c61769a6478aefa8361ab34d842d230",
    "submitter": {
        "id": 1626,
        "url": "http://patchwork.dpdk.org/api/people/1626/?format=api",
        "name": "Juraj Linkeš",
        "email": "juraj.linkes@pantheon.tech"
    },
    "delegate": {
        "id": 1,
        "url": "http://patchwork.dpdk.org/api/users/1/?format=api",
        "username": "tmonjalo",
        "first_name": "Thomas",
        "last_name": "Monjalon",
        "email": "thomas@monjalon.net"
    },
    "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20230719141303.33284-3-juraj.linkes@pantheon.tech/mbox/",
    "series": [
        {
            "id": 28973,
            "url": "http://patchwork.dpdk.org/api/series/28973/?format=api",
            "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=28973",
            "date": "2023-07-19T14:12:57",
            "name": "dts: tg abstractions and scapy tg",
            "version": 3,
            "mbox": "http://patchwork.dpdk.org/series/28973/mbox/"
        }
    ],
    "comments": "http://patchwork.dpdk.org/api/patches/129642/comments/",
    "check": "success",
    "checks": "http://patchwork.dpdk.org/api/patches/129642/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@inbox.dpdk.org",
        "Delivered-To": "patchwork@inbox.dpdk.org",
        "Received": [
            "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 1EBFD42EB9;\n\tWed, 19 Jul 2023 16:13:19 +0200 (CEST)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id BA18042B8E;\n\tWed, 19 Jul 2023 16:13:09 +0200 (CEST)",
            "from mail-ed1-f46.google.com (mail-ed1-f46.google.com\n [209.85.208.46]) by mails.dpdk.org (Postfix) with ESMTP id 7F91740F16\n for <dev@dpdk.org>; Wed, 19 Jul 2023 16:13:07 +0200 (CEST)",
            "by mail-ed1-f46.google.com with SMTP id\n 4fb4d7f45d1cf-51f90f713b2so10425118a12.1\n for <dev@dpdk.org>; Wed, 19 Jul 2023 07:13:07 -0700 (PDT)",
            "from jlinkes-PT-Latitude-5530.. (ip-46.34.247.144.o2inet.sk.\n [46.34.247.144]) by smtp.gmail.com with ESMTPSA id\n q8-20020a056402040800b0051e2809395bsm2721979edv.63.2023.07.19.07.13.06\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Wed, 19 Jul 2023 07:13:06 -0700 (PDT)"
        ],
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1689775987; x=1690380787;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=0HoQxKjOSEmlpyi5I7Z/o2GdsKqCSB/veXBPkZGCVSI=;\n b=PS8B7wNfpnu9ZNb8PZOWKVXscNVdLbJxKWbuecBVoeJKspM4KAJzfsrz6H37rd61Li\n OJYUIYC+xUeZ4hrMvV2yMMw0j4/WaRKlzcwDCy5ZGgYEqVfXMxjXZUW7Cs651EhxR05R\n Ofmv1Qzfo0vvSnDXtMTlUxidLp4kj5rIH3lZRs6edonFSIqTSn19exmfao214WkN2yy2\n YzvVPImNca4HEVOjLtzUAGRLHqTVruaAg2ydYrXKCqKkrcjNY4lszgxJuAY7hfGbxIJ1\n VfTaMR3npyO+dSUOFDwyfPbrdMv6hv0S4EviPIAW4wU8Nkawk16o+Y9PRx9SysHT6C/C\n ZM3w==",
        "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20221208; t=1689775987; x=1690380787;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=0HoQxKjOSEmlpyi5I7Z/o2GdsKqCSB/veXBPkZGCVSI=;\n b=iKHv7cN8c85LnMRQqNRC3osf/DELE84INnnVHL5VYPhu/+GtnBV0G/F+T3Vzm+jIpl\n WVwM3Ck5T/iljpFx7N+tJI79WQEUasrSfFhNIQKCVf22NiF/2zv2kqNvpQAVbJV4n+op\n HczKV0JXusB88hcJoYNvz9XYEQqCJamkgj3zRpBJZfTFnbbsDFX8jBcKKxtaVJOZvF/k\n gaFn7AHAfgRNJkXk8xB1Nuy2dgNMgaoEePwHrWfKrF/BLgJsI665G8Bf4NPEvfLv0/Qu\n nXfF8Yd4z5nFHeWICcKMVSa1rcp+BDrE9Dck2bQFDQaxJdZtw5bWCpCl91X/HldGjTyh\n obLg==",
        "X-Gm-Message-State": "ABy/qLa54BT8UgZAQdmCH+Vj3JnWng0ob6D+ZxBFzPWPiH7GwYIoeRoH\n XoKJILabVP0HzwF6/xLjt3qK3A==",
        "X-Google-Smtp-Source": "\n APBJJlEbXv5seKxF6mIN5LUNu6CIGUjhErb60lo9I8fyeR4QKqSJtHznd2dPmbV8LnpBmnEn+UOZjQ==",
        "X-Received": "by 2002:a05:6402:1b19:b0:51e:253e:1e0c with SMTP id\n by25-20020a0564021b1900b0051e253e1e0cmr2656819edb.25.1689775986935;\n Wed, 19 Jul 2023 07:13:06 -0700 (PDT)",
        "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>",
        "To": "thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, lijuan.tu@intel.com,\n bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu",
        "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>",
        "Subject": "[PATCH v3 2/6] dts: add traffic generator config",
        "Date": "Wed, 19 Jul 2023 16:12:59 +0200",
        "Message-Id": "<20230719141303.33284-3-juraj.linkes@pantheon.tech>",
        "X-Mailer": "git-send-email 2.34.1",
        "In-Reply-To": "<20230719141303.33284-1-juraj.linkes@pantheon.tech>",
        "References": "<20230717110709.39220-1-juraj.linkes@pantheon.tech>\n <20230719141303.33284-1-juraj.linkes@pantheon.tech>",
        "MIME-Version": "1.0",
        "Content-Type": "text/plain; charset=UTF-8",
        "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>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org"
    },
    "content": "Node configuration - where to connect, what ports to use and what TG to\nuse.\n\nSigned-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>\n---\n dts/conf.yaml                              | 26 ++++++-\n dts/framework/config/__init__.py           | 84 +++++++++++++++++++---\n dts/framework/config/conf_yaml_schema.json | 29 +++++++-\n dts/framework/dts.py                       | 12 ++--\n dts/framework/testbed_model/sut_node.py    |  5 +-\n 5 files changed, 135 insertions(+), 21 deletions(-)",
    "diff": "diff --git a/dts/conf.yaml b/dts/conf.yaml\nindex 0825d958a6..0440d1d20a 100644\n--- a/dts/conf.yaml\n+++ b/dts/conf.yaml\n@@ -13,10 +13,11 @@ executions:\n     skip_smoke_tests: false # optional flag that allows you to skip smoke tests\n     test_suites:\n       - hello_world\n-    system_under_test:\n+    system_under_test_node:\n       node_name: \"SUT 1\"\n       vdevs: # optional; if removed, vdevs won't be used in the execution\n         - \"crypto_openssl\"\n+    traffic_generator_node: \"TG 1\"\n nodes:\n   - name: \"SUT 1\"\n     hostname: sut1.change.me.localhost\n@@ -40,3 +41,26 @@ nodes:\n         os_driver: i40e\n         peer_node: \"TG 1\"\n         peer_pci: \"0000:00:08.1\"\n+  - name: \"TG 1\"\n+    hostname: tg1.change.me.localhost\n+    user: dtsuser\n+    arch: x86_64\n+    os: linux\n+    lcores: \"\"\n+    ports:\n+      - pci: \"0000:00:08.0\"\n+        os_driver_for_dpdk: rdma\n+        os_driver: rdma\n+        peer_node: \"SUT 1\"\n+        peer_pci: \"0000:00:08.0\"\n+      - pci: \"0000:00:08.1\"\n+        os_driver_for_dpdk: rdma\n+        os_driver: rdma\n+        peer_node: \"SUT 1\"\n+        peer_pci: \"0000:00:08.1\"\n+    use_first_core: false\n+    hugepages:  # optional; if removed, will use system hugepage configuration\n+        amount: 256\n+        force_first_numa: false\n+    traffic_generator:\n+        type: SCAPY\ndiff --git a/dts/framework/config/__init__.py b/dts/framework/config/__init__.py\nindex aa7ff358a2..9b5aff8509 100644\n--- a/dts/framework/config/__init__.py\n+++ b/dts/framework/config/__init__.py\n@@ -12,7 +12,7 @@\n import pathlib\n from dataclasses import dataclass\n from enum import auto, unique\n-from typing import Any, TypedDict\n+from typing import Any, TypedDict, Union\n \n import warlock  # type: ignore\n import yaml\n@@ -54,6 +54,11 @@ class Compiler(StrEnum):\n     msvc = auto()\n \n \n+@unique\n+class TrafficGeneratorType(StrEnum):\n+    SCAPY = auto()\n+\n+\n # Slots enables some optimizations, by pre-allocating space for the defined\n # attributes in the underlying data structure.\n #\n@@ -79,6 +84,26 @@ def from_dict(node: str, d: dict) -> \"PortConfig\":\n         return PortConfig(node=node, **d)\n \n \n+@dataclass(slots=True, frozen=True)\n+class TrafficGeneratorConfig:\n+    traffic_generator_type: TrafficGeneratorType\n+\n+    @staticmethod\n+    def from_dict(d: dict):\n+        # This looks useless now, but is designed to allow expansion to traffic\n+        # generators that require more configuration later.\n+        match TrafficGeneratorType(d[\"type\"]):\n+            case TrafficGeneratorType.SCAPY:\n+                return ScapyTrafficGeneratorConfig(\n+                    traffic_generator_type=TrafficGeneratorType.SCAPY\n+                )\n+\n+\n+@dataclass(slots=True, frozen=True)\n+class ScapyTrafficGeneratorConfig(TrafficGeneratorConfig):\n+    pass\n+\n+\n @dataclass(slots=True, frozen=True)\n class NodeConfiguration:\n     name: str\n@@ -89,17 +114,17 @@ class NodeConfiguration:\n     os: OS\n     lcores: str\n     use_first_core: bool\n-    memory_channels: int\n     hugepages: HugepageConfiguration | None\n     ports: list[PortConfig]\n \n     @staticmethod\n-    def from_dict(d: dict) -> \"NodeConfiguration\":\n+    def from_dict(d: dict) -> Union[\"SutNodeConfiguration\", \"TGNodeConfiguration\"]:\n         hugepage_config = d.get(\"hugepages\")\n         if hugepage_config:\n             if \"force_first_numa\" not in hugepage_config:\n                 hugepage_config[\"force_first_numa\"] = False\n             hugepage_config = HugepageConfiguration(**hugepage_config)\n+\n         common_config = {\n             \"name\": d[\"name\"],\n             \"hostname\": d[\"hostname\"],\n@@ -109,12 +134,31 @@ def from_dict(d: dict) -> \"NodeConfiguration\":\n             \"os\": OS(d[\"os\"]),\n             \"lcores\": d.get(\"lcores\", \"1\"),\n             \"use_first_core\": d.get(\"use_first_core\", False),\n-            \"memory_channels\": d.get(\"memory_channels\", 1),\n             \"hugepages\": hugepage_config,\n             \"ports\": [PortConfig.from_dict(d[\"name\"], port) for port in d[\"ports\"]],\n         }\n \n-        return NodeConfiguration(**common_config)\n+        if \"traffic_generator\" in d:\n+            return TGNodeConfiguration(\n+                traffic_generator=TrafficGeneratorConfig.from_dict(\n+                    d[\"traffic_generator\"]\n+                ),\n+                **common_config,\n+            )\n+        else:\n+            return SutNodeConfiguration(\n+                memory_channels=d.get(\"memory_channels\", 1), **common_config\n+            )\n+\n+\n+@dataclass(slots=True, frozen=True)\n+class SutNodeConfiguration(NodeConfiguration):\n+    memory_channels: int\n+\n+\n+@dataclass(slots=True, frozen=True)\n+class TGNodeConfiguration(NodeConfiguration):\n+    traffic_generator: ScapyTrafficGeneratorConfig\n \n \n @dataclass(slots=True, frozen=True)\n@@ -193,23 +237,40 @@ class ExecutionConfiguration:\n     perf: bool\n     func: bool\n     test_suites: list[TestSuiteConfig]\n-    system_under_test: NodeConfiguration\n+    system_under_test_node: SutNodeConfiguration\n+    traffic_generator_node: TGNodeConfiguration\n     vdevs: list[str]\n     skip_smoke_tests: bool\n \n     @staticmethod\n-    def from_dict(d: dict, node_map: dict) -> \"ExecutionConfiguration\":\n+    def from_dict(\n+        d: dict, node_map: dict[str, Union[SutNodeConfiguration | TGNodeConfiguration]]\n+    ) -> \"ExecutionConfiguration\":\n         build_targets: list[BuildTargetConfiguration] = list(\n             map(BuildTargetConfiguration.from_dict, d[\"build_targets\"])\n         )\n         test_suites: list[TestSuiteConfig] = list(\n             map(TestSuiteConfig.from_dict, d[\"test_suites\"])\n         )\n-        sut_name = d[\"system_under_test\"][\"node_name\"]\n+        sut_name = d[\"system_under_test_node\"][\"node_name\"]\n         skip_smoke_tests = d.get(\"skip_smoke_tests\", False)\n         assert sut_name in node_map, f\"Unknown SUT {sut_name} in execution {d}\"\n+        system_under_test_node = node_map[sut_name]\n+        assert isinstance(\n+            system_under_test_node, SutNodeConfiguration\n+        ), f\"Invalid SUT configuration {system_under_test_node}\"\n+\n+        tg_name = d[\"traffic_generator_node\"]\n+        assert tg_name in node_map, f\"Unknown TG {tg_name} in execution {d}\"\n+        traffic_generator_node = node_map[tg_name]\n+        assert isinstance(\n+            traffic_generator_node, TGNodeConfiguration\n+        ), f\"Invalid TG configuration {traffic_generator_node}\"\n+\n         vdevs = (\n-            d[\"system_under_test\"][\"vdevs\"] if \"vdevs\" in d[\"system_under_test\"] else []\n+            d[\"system_under_test_node\"][\"vdevs\"]\n+            if \"vdevs\" in d[\"system_under_test_node\"]\n+            else []\n         )\n         return ExecutionConfiguration(\n             build_targets=build_targets,\n@@ -217,7 +278,8 @@ def from_dict(d: dict, node_map: dict) -> \"ExecutionConfiguration\":\n             func=d[\"func\"],\n             skip_smoke_tests=skip_smoke_tests,\n             test_suites=test_suites,\n-            system_under_test=node_map[sut_name],\n+            system_under_test_node=system_under_test_node,\n+            traffic_generator_node=traffic_generator_node,\n             vdevs=vdevs,\n         )\n \n@@ -228,7 +290,7 @@ class Configuration:\n \n     @staticmethod\n     def from_dict(d: dict) -> \"Configuration\":\n-        nodes: list[NodeConfiguration] = list(\n+        nodes: list[Union[SutNodeConfiguration | TGNodeConfiguration]] = list(\n             map(NodeConfiguration.from_dict, d[\"nodes\"])\n         )\n         assert len(nodes) > 0, \"There must be a node to test\"\ndiff --git a/dts/framework/config/conf_yaml_schema.json b/dts/framework/config/conf_yaml_schema.json\nindex 67722213dd..936a4bac5b 100644\n--- a/dts/framework/config/conf_yaml_schema.json\n+++ b/dts/framework/config/conf_yaml_schema.json\n@@ -164,6 +164,11 @@\n         \"amount\"\n       ]\n     },\n+    \"mac_address\": {\n+      \"type\": \"string\",\n+      \"description\": \"A MAC address\",\n+      \"pattern\": \"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\"\n+    },\n     \"pci_address\": {\n       \"type\": \"string\",\n       \"pattern\": \"^[\\\\da-fA-F]{4}:[\\\\da-fA-F]{2}:[\\\\da-fA-F]{2}.\\\\d:?\\\\w*$\"\n@@ -286,6 +291,22 @@\n               ]\n             },\n             \"minimum\": 1\n+          },\n+          \"traffic_generator\": {\n+            \"oneOf\": [\n+              {\n+                \"type\": \"object\",\n+                \"description\": \"Scapy traffic generator. Used for functional testing.\",\n+                \"properties\": {\n+                  \"type\": {\n+                    \"type\": \"string\",\n+                    \"enum\": [\n+                      \"SCAPY\"\n+                    ]\n+                  }\n+                }\n+              }\n+            ]\n           }\n         },\n         \"additionalProperties\": false,\n@@ -336,7 +357,7 @@\n             \"description\": \"Optional field that allows you to skip smoke testing\",\n             \"type\": \"boolean\"\n           },\n-          \"system_under_test\": {\n+          \"system_under_test_node\": {\n             \"type\":\"object\",\n             \"properties\": {\n               \"node_name\": {\n@@ -353,6 +374,9 @@\n             \"required\": [\n               \"node_name\"\n             ]\n+          },\n+          \"traffic_generator_node\": {\n+            \"$ref\": \"#/definitions/node_name\"\n           }\n         },\n         \"additionalProperties\": false,\n@@ -361,7 +385,8 @@\n           \"perf\",\n           \"func\",\n           \"test_suites\",\n-          \"system_under_test\"\n+          \"system_under_test_node\",\n+          \"traffic_generator_node\"\n         ]\n       },\n       \"minimum\": 1\ndiff --git a/dts/framework/dts.py b/dts/framework/dts.py\nindex 3ba7fd2478..1c4a637fbd 100644\n--- a/dts/framework/dts.py\n+++ b/dts/framework/dts.py\n@@ -38,17 +38,17 @@ def run_all() -> None:\n         # for all Execution sections\n         for execution in CONFIGURATION.executions:\n             sut_node = None\n-            if execution.system_under_test.name in nodes:\n+            if execution.system_under_test_node.name in nodes:\n                 # a Node with the same name already exists\n-                sut_node = nodes[execution.system_under_test.name]\n+                sut_node = nodes[execution.system_under_test_node.name]\n             else:\n                 # the SUT has not been initialized yet\n                 try:\n-                    sut_node = SutNode(execution.system_under_test)\n+                    sut_node = SutNode(execution.system_under_test_node)\n                     result.update_setup(Result.PASS)\n                 except Exception as e:\n                     dts_logger.exception(\n-                        f\"Connection to node {execution.system_under_test} failed.\"\n+                        f\"Connection to node {execution.system_under_test_node} failed.\"\n                     )\n                     result.update_setup(Result.FAIL, e)\n                 else:\n@@ -87,7 +87,9 @@ def _run_execution(\n     Run the given execution. This involves running the execution setup as well as\n     running all build targets in the given execution.\n     \"\"\"\n-    dts_logger.info(f\"Running execution with SUT '{execution.system_under_test.name}'.\")\n+    dts_logger.info(\n+        f\"Running execution with SUT '{execution.system_under_test_node.name}'.\"\n+    )\n     execution_result = result.add_execution(sut_node.config)\n     execution_result.add_sut_info(sut_node.node_info)\n \ndiff --git a/dts/framework/testbed_model/sut_node.py b/dts/framework/testbed_model/sut_node.py\nindex e3227d9bc2..ad3bffd9d3 100644\n--- a/dts/framework/testbed_model/sut_node.py\n+++ b/dts/framework/testbed_model/sut_node.py\n@@ -12,8 +12,8 @@\n from framework.config import (\n     BuildTargetConfiguration,\n     BuildTargetInfo,\n-    NodeConfiguration,\n     NodeInfo,\n+    SutNodeConfiguration,\n )\n from framework.remote_session import CommandResult, InteractiveShellType, OSSession\n from framework.settings import SETTINGS\n@@ -77,6 +77,7 @@ class SutNode(Node):\n     Another key capability is building DPDK according to given build target.\n     \"\"\"\n \n+    config: SutNodeConfiguration\n     _dpdk_prefix_list: list[str]\n     _dpdk_timestamp: str\n     _build_target_config: BuildTargetConfiguration | None\n@@ -89,7 +90,7 @@ class SutNode(Node):\n     _node_info: NodeInfo | None\n     _compiler_version: str | None\n \n-    def __init__(self, node_config: NodeConfiguration):\n+    def __init__(self, node_config: SutNodeConfiguration):\n         super(SutNode, self).__init__(node_config)\n         self._dpdk_prefix_list = []\n         self._build_target_config = None\n",
    "prefixes": [
        "v3",
        "2/6"
    ]
}