From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D9AB1432D6; Wed, 8 Nov 2023 13:54:06 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BD6A142E27; Wed, 8 Nov 2023 13:53:35 +0100 (CET) Received: from mail-ed1-f47.google.com (mail-ed1-f47.google.com [209.85.208.47]) by mails.dpdk.org (Postfix) with ESMTP id 0BF4B42E14 for ; Wed, 8 Nov 2023 13:53:32 +0100 (CET) Received: by mail-ed1-f47.google.com with SMTP id 4fb4d7f45d1cf-53d9f001b35so11500774a12.2 for ; Wed, 08 Nov 2023 04:53:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1699448011; x=1700052811; 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=OsLxKn4mOXV2TuK2LbXZ03RA5dZb5BIPscylrtxoXE4=; b=Kdz3nbqogmOnXRb8gHCToGncsQiy43HDrIN4aTLSRmHYqxS99QGh7E5FneK5BqQfqH Q5y89LAI1wY9J/2n/vUdJ2ke/950XAcUTps9z/mUPHbhobgoSkE0Dt9yT0WwDRfEO2ty IyLZWDIBAZ2j45+kq2JaH4KCYzq5zIOHwS/oGPtAPuo9WtEfWq+Gfsyphg+uQnmkpELR InyGZbkd7LF+msie0cJgTTYluH0QH5u7nh4d8LB73fxv8ZM5RaveIFvNh2XUe5qfHOz+ ANhNTHKw0lG4JaU7JbN5uicr5cE8j5RI3HKYRdpfczkaOrwmhZFRx0+2ArvgcBsWW0zW 0ayg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699448011; x=1700052811; 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=OsLxKn4mOXV2TuK2LbXZ03RA5dZb5BIPscylrtxoXE4=; b=JdgwYHnB8bVy3jpU523ElSYz/pifNmgIEgRKs++3mqrfjh343s2OU24Yvw/MnQGQTv NKH3mNuXEbXFC4eHOAslyR5HEmCHG6fFxpv6SIlVt3/mStsLu3wQmZvJm3GHqf3eoNyb fB8Dng6UEcKlxy1q/KenCQ8BwXBdPdgjl7QDldc0sBEblqttk0sAdZXrfM5plW7peE9K DsziOpj00m5OEv5RBoZ6uU2ciU0Ff4NGw/q2AbQ1qcjYTjPigx6Da6Y25gGKqqljSCUn TAhoYqeCLF7XPPsN9Vujn6TOa6o6XQxjs3roa8imlx5Zqhe3tHzliWzDoCuulSLg/Z6x NUbw== X-Gm-Message-State: AOJu0YzXa0KOEUM2fZjyGASUSw4kAUwV1TCTAzb3t3BfKShpniu9orBo tKOI/X2Xlc70y7oqf3Ot3/fJWw== X-Google-Smtp-Source: AGHT+IEAoXMEOtFh78UqEzTVa5waRWL4Yg+Bcy90urSp+7bSnAEiUbQ9yTVAkIOaDKvCzBUvHHpfMA== X-Received: by 2002:a50:d51d:0:b0:543:b9ae:a0d5 with SMTP id u29-20020a50d51d000000b00543b9aea0d5mr1480197edi.4.1699448011768; Wed, 08 Nov 2023 04:53:31 -0800 (PST) Received: from jlinkes-PT-Latitude-5530.pantheon.local (81.89.53.154.host.vnet.sk. [81.89.53.154]) by smtp.gmail.com with ESMTPSA id v10-20020aa7dbca000000b0052ff9bae873sm6589289edt.5.2023.11.08.04.53.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Nov 2023 04:53:30 -0800 (PST) From: =?UTF-8?q?Juraj=20Linke=C5=A1?= To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= Subject: [PATCH v6 05/23] dts: settings docstring update Date: Wed, 8 Nov 2023 13:53:06 +0100 Message-Id: <20231108125324.191005-5-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231108125324.191005-1-juraj.linkes@pantheon.tech> References: <20231106171601.160749-1-juraj.linkes@pantheon.tech> <20231108125324.191005-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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Format according to the Google format and PEP257, with slight deviations. Signed-off-by: Juraj Linkeš --- dts/framework/settings.py | 101 +++++++++++++++++++++++++++++++++++++- 1 file changed, 100 insertions(+), 1 deletion(-) diff --git a/dts/framework/settings.py b/dts/framework/settings.py index 7f5841d073..787db7c198 100644 --- a/dts/framework/settings.py +++ b/dts/framework/settings.py @@ -3,6 +3,70 @@ # Copyright(c) 2022-2023 PANTHEON.tech s.r.o. # Copyright(c) 2022 University of New Hampshire +"""Environment variables and command line arguments parsing. + +This is a simple module utilizing the built-in argparse module to parse command line arguments, +augment them with values from environment variables and make them available across the framework. + +The command line value takes precedence, followed by the environment variable value, +followed by the default value defined in this module. + +The command line arguments along with the supported environment variables are: + +.. option:: --config-file +.. envvar:: DTS_CFG_FILE + + The path to the YAML test run configuration file. + +.. option:: --output-dir, --output +.. envvar:: DTS_OUTPUT_DIR + + The directory where DTS logs and results are saved. + +.. option:: --compile-timeout +.. envvar:: DTS_COMPILE_TIMEOUT + + The timeout for compiling DPDK. + +.. option:: -t, --timeout +.. envvar:: DTS_TIMEOUT + + The timeout for all DTS operation except for compiling DPDK. + +.. option:: -v, --verbose +.. envvar:: DTS_VERBOSE + + Set to any value to enable logging everything to the console. + +.. option:: -s, --skip-setup +.. envvar:: DTS_SKIP_SETUP + + Set to any value to skip building DPDK. + +.. option:: --tarball, --snapshot, --git-ref +.. envvar:: DTS_DPDK_TARBALL + + The path to a DPDK tarball, git commit ID, tag ID or tree ID to test. + +.. option:: --test-cases +.. envvar:: DTS_TESTCASES + + A comma-separated list of test cases to execute. Unknown test cases will be silently ignored. + +.. option:: --re-run, --re_run +.. envvar:: DTS_RERUN + + Re-run each test case this many times in case of a failure. + +Attributes: + SETTINGS: The module level variable storing framework-wide DTS settings. + +Typical usage example:: + + from framework.settings import SETTINGS + foo = SETTINGS.foo +""" + import argparse import os from collections.abc import Callable, Iterable, Sequence @@ -16,6 +80,23 @@ def _env_arg(env_var: str) -> Any: + """A helper method augmenting the argparse Action with environment variables. + + If the supplied environment variable is defined, then the default value + of the argument is modified. This satisfies the priority order of + command line argument > environment variable > default value. + + Arguments with no values (flags) should be defined using the const keyword argument + (True or False). When the argument is specified, it will be set to const, if not specified, + the default will be stored (possibly modified by the corresponding environment variable). + + Other arguments work the same as default argparse arguments, that is using + the default 'store' action. + + Returns: + The modified argparse.Action. + """ + class _EnvironmentArgument(argparse.Action): def __init__( self, @@ -68,14 +149,28 @@ def __call__( @dataclass(slots=True) class Settings: + """Default framework-wide user settings. + + The defaults may be modified at the start of the run. + """ + + #: config_file_path: Path = Path(__file__).parent.parent.joinpath("conf.yaml") + #: output_dir: str = "output" + #: timeout: float = 15 + #: verbose: bool = False + #: skip_setup: bool = False + #: dpdk_tarball_path: Path | str = "dpdk.tar.xz" + #: compile_timeout: float = 1200 + #: test_cases: list[str] = field(default_factory=list) + #: re_run: int = 0 @@ -169,7 +264,7 @@ def _get_parser() -> argparse.ArgumentParser: action=_env_arg("DTS_RERUN"), default=SETTINGS.re_run, type=int, - help="[DTS_RERUN] Re-run each test case the specified amount of times " + help="[DTS_RERUN] Re-run each test case the specified number of times " "if a test failure occurs", ) @@ -177,6 +272,10 @@ def _get_parser() -> argparse.ArgumentParser: def get_settings() -> Settings: + """Create new settings with inputs from the user. + + The inputs are taken from the command line and from environment variables. + """ parsed_args = _get_parser().parse_args() return Settings( config_file_path=parsed_args.config_file, -- 2.34.1