Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/134381/?format=api
{ "id": 134381, "url": "http://patches.dpdk.org/api/patches/134381/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231115130959.39420-5-juraj.linkes@pantheon.tech/", "project": { "id": 1, "url": "http://patches.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": "<20231115130959.39420-5-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20231115130959.39420-5-juraj.linkes@pantheon.tech", "date": "2023-11-15T13:09:42", "name": "[v7,04/21] dts: exceptions docstring update", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "74ebb9a58a1249cf29624c87dbc633a23a70f086", "submitter": { "id": 1626, "url": "http://patches.dpdk.org/api/people/1626/?format=api", "name": "Juraj Linkeš", "email": "juraj.linkes@pantheon.tech" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231115130959.39420-5-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 30302, "url": "http://patches.dpdk.org/api/series/30302/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30302", "date": "2023-11-15T13:09:38", "name": "dts: docstrings update", "version": 7, "mbox": "http://patches.dpdk.org/series/30302/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/134381/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/134381/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 E35A243339;\n\tWed, 15 Nov 2023 14:12:06 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 5FE3F40A84;\n\tWed, 15 Nov 2023 14:11:59 +0100 (CET)", "from mail-ed1-f53.google.com (mail-ed1-f53.google.com\n [209.85.208.53]) by mails.dpdk.org (Postfix) with ESMTP id 79E3540A70\n for <dev@dpdk.org>; Wed, 15 Nov 2023 14:11:55 +0100 (CET)", "by mail-ed1-f53.google.com with SMTP id\n 4fb4d7f45d1cf-53dd752685fso10371786a12.3\n for <dev@dpdk.org>; Wed, 15 Nov 2023 05:11:55 -0800 (PST)", "from jlinkes-PT-Latitude-5530.pantheon.local\n (81.89.53.154.host.vnet.sk. [81.89.53.154])\n by smtp.gmail.com with ESMTPSA id\n tb16-20020a1709078b9000b009f2b7282387sm1011914ejc.46.2023.11.15.05.11.53\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Wed, 15 Nov 2023 05:11:54 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1700053915; x=1700658715; darn=dpdk.org;\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=1nf+Rn9xF8AJgKgVM5dfS3bAeJ3oXogtFzeJDmarYnY=;\n b=FFPMUDlgbVhm8wlwfUR29ILh9s3DRU/19hvBczjyNKb/NSjlMLYxCvfGGV1NzTWURg\n fRgpV8sCd/Wd1SPLlPgBBrL5rWiCc/cRBQjIOVW235Bfd2qvfQ0/fyZNNzB4/DatufoU\n Ss5KiiKsNTR9LI5n2VyWB4PhCkPWZ1Jmq60SSWqojYbE1JWKAahA6ZgG0Ja+ZGBj7cpE\n b5s9aVyldKjMtKLqG4S6BVzoehZ0K9ddkXx3Js8cj1BriDmpPfbEkKW5xj8oNtXkcZa2\n fUSqD1U7iQ8Fxif9vX71+PkvsbSjJwjOEenZLJJnkw9vXqKpzpStWl4qSxLPIY06qbAX\n QlCA==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1700053915; x=1700658715;\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=1nf+Rn9xF8AJgKgVM5dfS3bAeJ3oXogtFzeJDmarYnY=;\n b=mmBld+RivwqlZ5YIII8PNfRguqspgNryfxbw30cs+hnz06sG2WfnrR058+UM7eXmaA\n fbahSjMuOSFV9HnY28ZV/7LvqYS5fByw+WsTd61p4Scg7a+z6G3iTp4mDD45jn3Xcyx3\n XyTyJCDADCXnLXldzMFHYcZ8myOLgOZHrFxH/3+9jWf1zae5AvI4WqXnq9iVKb/+2vmw\n SOCYg+AzHSVAZz1jPO1OJ+FQp6Jsb72YBH6WsbKctuDuaV+zV91CKb8OC+LzNsDWKz/k\n wmBgkvcMAl6qLVmzlYfI56Yc8EVOJohZKrV16Yfx89RseSCSOVt5eqMTOjCEnd3MS/Hd\n i2nQ==", "X-Gm-Message-State": "AOJu0YxtmKbuYJno58Ph4qv1UbXnFklqiWn7QlP9Ifgxy4miao4uyxsL\n ES6ZDU4g1a0di4kUdGXEioN2Jw==", "X-Google-Smtp-Source": "\n AGHT+IENqC8b+dvKHfDexRMH1Uhg4H07vLp58PB/IESMHhSMRZVlVItsoZSxaBafVVjTh+SerlxHsQ==", "X-Received": "by 2002:a17:906:3e50:b0:9bd:f3b0:c087 with SMTP id\n t16-20020a1709063e5000b009bdf3b0c087mr9991921eji.2.1700053915185;\n Wed, 15 Nov 2023 05:11:55 -0800 (PST)", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, jspewock@iol.unh.edu,\n probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[PATCH v7 04/21] dts: exceptions docstring update", "Date": "Wed, 15 Nov 2023 14:09:42 +0100", "Message-Id": "<20231115130959.39420-5-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20231115130959.39420-1-juraj.linkes@pantheon.tech>", "References": "<20231108125324.191005-23-juraj.linkes@pantheon.tech>\n <20231115130959.39420-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": "Format according to the Google format and PEP257, with slight\ndeviations.\n\nSigned-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>\n---\n dts/framework/__init__.py | 12 ++++-\n dts/framework/exception.py | 106 +++++++++++++++++++++++++------------\n 2 files changed, 83 insertions(+), 35 deletions(-)", "diff": "diff --git a/dts/framework/__init__.py b/dts/framework/__init__.py\nindex d551ad4bf0..662e6ccad2 100644\n--- a/dts/framework/__init__.py\n+++ b/dts/framework/__init__.py\n@@ -1,3 +1,13 @@\n # SPDX-License-Identifier: BSD-3-Clause\n-# Copyright(c) 2022 PANTHEON.tech s.r.o.\n+# Copyright(c) 2022-2023 PANTHEON.tech s.r.o.\n # Copyright(c) 2022 University of New Hampshire\n+\n+\"\"\"Libraries and utilities for running DPDK Test Suite (DTS).\n+\n+The various modules in the DTS framework offer:\n+\n+* Connections to nodes, both interactive and non-interactive,\n+* A straightforward way to add support for different operating systems of remote nodes,\n+* Test suite setup, execution and teardown, along with test case setup, execution and teardown,\n+* Pre-test suite setup and post-test suite teardown.\n+\"\"\"\ndiff --git a/dts/framework/exception.py b/dts/framework/exception.py\nindex 7489c03570..ee1562c672 100644\n--- a/dts/framework/exception.py\n+++ b/dts/framework/exception.py\n@@ -3,8 +3,10 @@\n # Copyright(c) 2022-2023 PANTHEON.tech s.r.o.\n # Copyright(c) 2022-2023 University of New Hampshire\n \n-\"\"\"\n-User-defined exceptions used across the framework.\n+\"\"\"DTS exceptions.\n+\n+The exceptions all have different severities expressed as an integer.\n+The highest severity of all raised exception is used as the exit code of DTS.\n \"\"\"\n \n from enum import IntEnum, unique\n@@ -13,59 +15,79 @@\n \n @unique\n class ErrorSeverity(IntEnum):\n- \"\"\"\n- The severity of errors that occur during DTS execution.\n+ \"\"\"The severity of errors that occur during DTS execution.\n+\n All exceptions are caught and the most severe error is used as return code.\n \"\"\"\n \n+ #:\n NO_ERR = 0\n+ #:\n GENERIC_ERR = 1\n+ #:\n CONFIG_ERR = 2\n+ #:\n REMOTE_CMD_EXEC_ERR = 3\n+ #:\n SSH_ERR = 4\n+ #:\n DPDK_BUILD_ERR = 10\n+ #:\n TESTCASE_VERIFY_ERR = 20\n+ #:\n BLOCKING_TESTSUITE_ERR = 25\n \n \n class DTSError(Exception):\n- \"\"\"\n- The base exception from which all DTS exceptions are derived.\n- Stores error severity.\n+ \"\"\"The base exception from which all DTS exceptions are subclassed.\n+\n+ Do not use this exception, only use subclassed exceptions.\n \"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.GENERIC_ERR\n \n \n class SSHTimeoutError(DTSError):\n- \"\"\"\n- Command execution timeout.\n- \"\"\"\n+ \"\"\"The SSH execution of a command timed out.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR\n _command: str\n \n def __init__(self, command: str):\n+ \"\"\"Define the meaning of the first argument.\n+\n+ Args:\n+ command: The executed command.\n+ \"\"\"\n self._command = command\n \n def __str__(self) -> str:\n- return f\"TIMEOUT on {self._command}\"\n+ \"\"\"Add some context to the string representation.\"\"\"\n+ return f\"{self._command} execution timed out.\"\n \n \n class SSHConnectionError(DTSError):\n- \"\"\"\n- SSH connection error.\n- \"\"\"\n+ \"\"\"An unsuccessful SSH connection.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR\n _host: str\n _errors: list[str]\n \n def __init__(self, host: str, errors: list[str] | None = None):\n+ \"\"\"Define the meaning of the first two arguments.\n+\n+ Args:\n+ host: The hostname to which we're trying to connect.\n+ errors: Any errors that occurred during the connection attempt.\n+ \"\"\"\n self._host = host\n self._errors = [] if errors is None else errors\n \n def __str__(self) -> str:\n+ \"\"\"Include the errors in the string representation.\"\"\"\n message = f\"Error trying to connect with {self._host}.\"\n if self._errors:\n message += f\" Errors encountered while retrying: {', '.join(self._errors)}\"\n@@ -74,43 +96,53 @@ def __str__(self) -> str:\n \n \n class SSHSessionDeadError(DTSError):\n- \"\"\"\n- SSH session is not alive.\n- It can no longer be used.\n- \"\"\"\n+ \"\"\"The SSH session is no longer alive.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR\n _host: str\n \n def __init__(self, host: str):\n+ \"\"\"Define the meaning of the first argument.\n+\n+ Args:\n+ host: The hostname of the disconnected node.\n+ \"\"\"\n self._host = host\n \n def __str__(self) -> str:\n- return f\"SSH session with {self._host} has died\"\n+ \"\"\"Add some context to the string representation.\"\"\"\n+ return f\"SSH session with {self._host} has died.\"\n \n \n class ConfigurationError(DTSError):\n- \"\"\"\n- Raised when an invalid configuration is encountered.\n- \"\"\"\n+ \"\"\"An invalid configuration.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.CONFIG_ERR\n \n \n class RemoteCommandExecutionError(DTSError):\n- \"\"\"\n- Raised when a command executed on a Node returns a non-zero exit status.\n- \"\"\"\n+ \"\"\"An unsuccessful execution of a remote command.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.REMOTE_CMD_EXEC_ERR\n+ #: The executed command.\n command: str\n _command_return_code: int\n \n def __init__(self, command: str, command_return_code: int):\n+ \"\"\"Define the meaning of the first two arguments.\n+\n+ Args:\n+ command: The executed command.\n+ command_return_code: The return code of the executed command.\n+ \"\"\"\n self.command = command\n self._command_return_code = command_return_code\n \n def __str__(self) -> str:\n+ \"\"\"Include both the command and return code in the string representation.\"\"\"\n return (\n f\"Command {self.command} returned a non-zero exit code: \"\n f\"{self._command_return_code}\"\n@@ -118,35 +150,41 @@ def __str__(self) -> str:\n \n \n class RemoteDirectoryExistsError(DTSError):\n- \"\"\"\n- Raised when a remote directory to be created already exists.\n- \"\"\"\n+ \"\"\"A directory that exists on a remote node.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.REMOTE_CMD_EXEC_ERR\n \n \n class DPDKBuildError(DTSError):\n- \"\"\"\n- Raised when DPDK build fails for any reason.\n- \"\"\"\n+ \"\"\"A DPDK build failure.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.DPDK_BUILD_ERR\n \n \n class TestCaseVerifyError(DTSError):\n- \"\"\"\n- Used in test cases to verify the expected behavior.\n- \"\"\"\n+ \"\"\"A test case failure.\"\"\"\n \n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.TESTCASE_VERIFY_ERR\n \n \n class BlockingTestSuiteError(DTSError):\n+ \"\"\"A failure in a blocking test suite.\"\"\"\n+\n+ #:\n severity: ClassVar[ErrorSeverity] = ErrorSeverity.BLOCKING_TESTSUITE_ERR\n _suite_name: str\n \n def __init__(self, suite_name: str) -> None:\n+ \"\"\"Define the meaning of the first argument.\n+\n+ Args:\n+ suite_name: The blocking test suite.\n+ \"\"\"\n self._suite_name = suite_name\n \n def __str__(self) -> str:\n+ \"\"\"Add some context to the string representation.\"\"\"\n return f\"Blocking suite {self._suite_name} failed.\"\n", "prefixes": [ "v7", "04/21" ] }