From 7bc9844dda1521ba62c3465d60614d3c8c82ab43 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 13 Nov 2023 13:42:39 +0100 Subject: [PATCH 01/13] Unexpected unindent Sphinx-build warning fix Reference: #5757 Signed-off-by: Jan Richter --- avocado/core/plugin_interfaces.py | 2 +- avocado/core/task/runtime.py | 6 ++-- avocado/core/utils/messages.py | 4 +-- avocado/utils/cpu.py | 6 ++-- avocado/utils/network/interfaces.py | 6 ++-- avocado/utils/pci.py | 30 +++++++++---------- .../utils/software_manager/backends/rpm.py | 2 +- .../utils/software_manager/backends/yum.py | 2 +- .../utils/software_manager/backends/zypper.py | 2 +- docs/source/blueprints/BP005.rst | 6 ++-- docs/source/releases/lts/92_0.rst | 6 ++-- 11 files changed, 38 insertions(+), 34 deletions(-) diff --git a/avocado/core/plugin_interfaces.py b/avocado/core/plugin_interfaces.py index 51953bef77..01424149c2 100644 --- a/avocado/core/plugin_interfaces.py +++ b/avocado/core/plugin_interfaces.py @@ -194,7 +194,7 @@ def post_test_runnables(self, test_runnable, suite_config=None): :param suite_config: Configuration dict relevant for the whole suite. :return: PostTest task runnables created by plugin. :rtype: list of tuple(:class:`avocado.core.nrunner.Runnable`, - `avocado.core.task.runtime.RuntimeTask.possible_dependency_results`) + `avocado.core.task.runtime.RuntimeTask.possible_dependency_results`) """ diff --git a/avocado/core/task/runtime.py b/avocado/core/task/runtime.py index 1547d08b50..07d3648887 100644 --- a/avocado/core/task/runtime.py +++ b/avocado/core/task/runtime.py @@ -63,7 +63,8 @@ def from_runnable( make into the job's results. :type job_id: str :param satisfiable_deps_execution_statuses: The dependency result types that - satisfy the execution of this RuntimeTask. + satisfy the execution of this + RuntimeTask. :type satisfiable_deps_execution_statuses: list of test results. :returns: RuntimeTask of the test from runnable """ @@ -111,7 +112,8 @@ def __init__(self, task, satisfiable_deps_execution_statuses=None): :param task: The task to keep additional information about :type task: :class:`avocado.core.nrunner.Task` :param satisfiable_deps_execution_statuses: The dependency result types that - satisfy the execution of this RuntimeTask. + satisfy the execution of this + RuntimeTask. :type satisfiable_deps_execution_statuses: list of test results. """ #: The :class:`avocado.core.nrunner.Task` diff --git a/avocado/core/utils/messages.py b/avocado/core/utils/messages.py index 093e19a8f0..a705090942 100644 --- a/avocado/core/utils/messages.py +++ b/avocado/core/utils/messages.py @@ -65,8 +65,8 @@ def get( """Creates finished message with all necessary information. :param result: test result - :type result values for the statuses defined in - :class: avocado.core.teststatus.STATUSES + :type result: values for the statuses defined in + :class: avocado.core.teststatus.STATUSES :param fail_reason: parameter for brief specification, of the failed result. :type fail_reason: str diff --git a/avocado/utils/cpu.py b/avocado/utils/cpu.py index 81bbe943a5..aec356f397 100644 --- a/avocado/utils/cpu.py +++ b/avocado/utils/cpu.py @@ -514,9 +514,10 @@ def get_numa_node_has_cpus(): Get the list NUMA node numbers which has CPU's on the system, if there is no CPU associated to NUMA node,Those NUMA node number will not be appended to list. + :return: A list where NUMA node numbers only which has CPU's - as elements of The list. - :rtype : List + :rtype: List """ cpu_path = "/sys/devices/system/node/has_cpu" delim = ",", "-" @@ -529,9 +530,10 @@ def get_numa_node_has_cpus(): def numa_nodes_with_assigned_cpus(): """ Get NUMA nodes with associated CPU's on the system. + :return: A dictionary,in which "NUMA node numbers" as key and "NUMA node associated CPU's" as values. - :rtype : dictionary + :rtype: dictionary """ numa_nodes_with_cpus = {} for path in glob.glob("/sys/devices/system/node/node[0-9]*"): diff --git a/avocado/utils/network/interfaces.py b/avocado/utils/network/interfaces.py index 85aa9b0b46..3426d7ef42 100644 --- a/avocado/utils/network/interfaces.py +++ b/avocado/utils/network/interfaces.py @@ -716,7 +716,7 @@ def netmask_to_cidr(self, netmask): 255.255.252.0 = 22 :param netmask: Netmask value example 255.255.255.0 - :return : Returns mask value of given netmask + :return: Returns mask value of given netmask """ return sum(bin(int(bits)).count("1") for bits in netmask.split(".")) @@ -796,9 +796,9 @@ def ping_flood(self, int_name, peer_ip, ping_count): :param int_name: source interface name. :param peer_ip: Peer IP address (IPv4 or IPv6) :param ping_count: How many ICMP echo packets to send. - :return : returns True on successful ping flood. + :return: returns True on successful ping flood. returns False on ping flood failure. - :rtype : boolean + :rtype: boolean """ cmd = f"ping -I {int_name} {peer_ip} -c {ping_count} -f " ping_process = subprocess.Popen( diff --git a/avocado/utils/pci.py b/avocado/utils/pci.py index a4d8e690dc..0e32817b80 100644 --- a/avocado/utils/pci.py +++ b/avocado/utils/pci.py @@ -326,7 +326,7 @@ def unbind(driver, full_pci_address): :param driver: driver of the PCI address (full_pci_address) :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: None + :return: None """ genio.write_file_or_fail(f"/sys/bus/pci/drivers/{driver}/unbind", full_pci_address) if wait.wait_for( @@ -345,7 +345,7 @@ def bind(driver, full_pci_address): :param driver: driver of the PCI address (full_pci_address) :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: None + :return: None """ genio.write_file_or_fail(f"/sys/bus/pci/drivers/{driver}/bind", full_pci_address) if not wait.wait_for( @@ -363,8 +363,8 @@ def get_vendor_id(full_pci_address): Get vendor id of a PCI address :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: vendor id of PCI address - rtype: str + :return: vendor id of PCI address + :rtype: str """ cmd = f"lspci -n -s {full_pci_address}" out = process.run(cmd, ignore_status=True, shell=True).stdout_text @@ -378,8 +378,8 @@ def reset_check(full_pci_address): Check if reset for "full_pci_address" is successful :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: whether reset for "full_pci_address" is successful - rtype: bool + :return: whether reset for "full_pci_address" is successful + :rtype: bool """ cmd = f"lspci -vvs {full_pci_address}" output = process.run(cmd, ignore_status=True, shell=True).stdout_text @@ -393,8 +393,8 @@ def rescan_check(full_pci_address): Check if rescan for full_pci_address is successful :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: whether rescan for full_pci_address is successful - rtype: bool + :return: whether rescan for full_pci_address is successful + :rtype: bool """ cmd = f"lspci -vvs {full_pci_address}" output = process.run(cmd, ignore_status=True, shell=True).stdout_text @@ -410,8 +410,8 @@ def change_domain_check(dom, full_pci_address, def_dom): :param dom: domain type :param def_dom: default domain of pci device(full_pci_address) :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: whether domain changed successfully to "dom" - rtype: bool + :return: whether domain changed successfully to "dom" + :rtype: bool """ try: output = genio.read_one_line( @@ -430,7 +430,7 @@ def reset(full_pci_address): Remove the full_pci_address :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: None + :return: None """ genio.write_file_or_fail(f"/sys/bus/pci/devices/{full_pci_address}/remove", "1") if not wait.wait_for(lambda: reset_check(full_pci_address), timeout=5): @@ -442,7 +442,7 @@ def rescan(full_pci_address): Rescan the system and check for full_pci_address :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: None + :return: None """ genio.write_file_or_fail("/sys/bus/pci/rescan", "1") if not wait.wait_for(lambda: rescan_check(full_pci_address), timeout=5): @@ -454,8 +454,8 @@ def get_iommu_group(full_pci_address): Return the iommu group of full_pci_address :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: iommu group of full_pci_address - rtype: string + :return: iommu group of full_pci_address + :rtype: string """ cmd = f"lspci -vvvv -s {full_pci_address}" out = process.run(cmd, ignore_status=True, shell=True) @@ -472,7 +472,7 @@ def change_domain(dom, def_dom, full_pci_address): :param dom: domain type :param def_dom: default domain of pci device(full_pci_address) :param full_pci_address: Full PCI address including domain (0000:03:00.0) - return: None + :return: None """ genio.write_file_or_fail( f"/sys/bus/pci/devices/{full_pci_address}/iommu_group/type", dom diff --git a/avocado/utils/software_manager/backends/rpm.py b/avocado/utils/software_manager/backends/rpm.py index 89a6152d79..e9a2504a3b 100644 --- a/avocado/utils/software_manager/backends/rpm.py +++ b/avocado/utils/software_manager/backends/rpm.py @@ -185,7 +185,7 @@ def prepare_source(spec_file, dest_path=None, build_option=None): Rpmbuild the spec path and return build dir :param spec_path: spec path to install - :param build_option : rpmbuild option + :param build_option: rpmbuild option :return path: build directory """ diff --git a/avocado/utils/software_manager/backends/yum.py b/avocado/utils/software_manager/backends/yum.py index b9fb028b3e..4f8d1f4589 100644 --- a/avocado/utils/software_manager/backends/yum.py +++ b/avocado/utils/software_manager/backends/yum.py @@ -245,7 +245,7 @@ def get_source(self, name, dest_path, build_option=None): :param name: name of the package :param dest_path: destination_path - :param build_option : rpmbuild option + :param build_option: rpmbuild option :return final_dir: path of ready-to-build directory """ diff --git a/avocado/utils/software_manager/backends/zypper.py b/avocado/utils/software_manager/backends/zypper.py index d9d061358d..e4b737faa0 100644 --- a/avocado/utils/software_manager/backends/zypper.py +++ b/avocado/utils/software_manager/backends/zypper.py @@ -174,7 +174,7 @@ def get_source(self, name, dest_path, build_option=None): :param name: name of the package :param dest_path: destination_path - :param build_option : rpmbuild option + :param build_option: rpmbuild option :return final_dir: path of ready-to-build directory """ diff --git a/docs/source/blueprints/BP005.rst b/docs/source/blueprints/BP005.rst index 187c77b69b..dfc132e8db 100644 --- a/docs/source/blueprints/BP005.rst +++ b/docs/source/blueprints/BP005.rst @@ -202,11 +202,11 @@ potential need for a new release: * If the number of commits since last release has reached a threshold; AND * There is no open discussion with the tag “release-decision”: * Creates a new discussion (with the "release-decision" tag) to run a poll - between all the MAINTAINERS, so they will have the opportunity to thumbs - up if there is a need for a new release; + between all the MAINTAINERS, so they will have the opportunity to thumbs + up if there is a need for a new release; * The link to the new discussion should be sent to all MAINTAINERS; * If the decision is positive, a round-robin selected maintainer should be - responsible for coordinating the release it self; + responsible for coordinating the release it self; * And the discussion should be closed * If there is any existing open discussion, the bot job should comment on the same discussion with the updated list of commits and ping again the diff --git a/docs/source/releases/lts/92_0.rst b/docs/source/releases/lts/92_0.rst index 8109a85fa5..ef09faab5a 100644 --- a/docs/source/releases/lts/92_0.rst +++ b/docs/source/releases/lts/92_0.rst @@ -358,9 +358,9 @@ Bug Fixes meaningful exit code on some failures and success situations. * The extraction of DEB packages by means of -:meth:`avocado.utils.software_manager.SoftwareManager.extract_from_package` -was fixed and does not depend on the ``ar`` utility anymore (as it now -uses the :mod:`avocado.utils.ar` module). + :meth:`avocado.utils.software_manager.SoftwareManager.extract_from_package` + was fixed and does not depend on the ``ar`` utility anymore (as it now + uses the :mod:`avocado.utils.ar` module). * The ``--store-logging-stream`` parameter value was being incorrectly parsed as a list of characters. If a ``bar`` value is given, it From 91f113279cea46367cce2c99c85e73c142560c9c Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 27 Nov 2023 12:04:43 +0100 Subject: [PATCH 02/13] WARNING: duplicate object description fix Signed-off-by: Jan Richter --- docs/source/guides/contributor/chapters/plugins.rst | 1 + docs/source/guides/reference/chapters/runners.rst | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/docs/source/guides/contributor/chapters/plugins.rst b/docs/source/guides/contributor/chapters/plugins.rst index 9947f41ef1..72922d52d4 100644 --- a/docs/source/guides/contributor/chapters/plugins.rst +++ b/docs/source/guides/contributor/chapters/plugins.rst @@ -197,6 +197,7 @@ NORMAL (50). For easier usage, avocado has predefined values in: .. autoclass:: avocado.core.extension_manager.PluginPriority + :noindex: :members: :undoc-members: diff --git a/docs/source/guides/reference/chapters/runners.rst b/docs/source/guides/reference/chapters/runners.rst index 90cdc8c972..acc88e28ee 100644 --- a/docs/source/guides/reference/chapters/runners.rst +++ b/docs/source/guides/reference/chapters/runners.rst @@ -536,8 +536,10 @@ Supported message types ~~~~~~~~~~~~~~~~~~~~~~~ .. autoclass:: avocado.core.messages.StartMessageHandler + :noindex: .. autoclass:: avocado.core.messages.FinishMessageHandler + :noindex: Running messages ++++++++++++++++ @@ -545,11 +547,16 @@ This message can be used during the run-time and has different properties based on the information which is being transmitted. .. autoclass:: avocado.core.messages.LogMessageHandler + :noindex: .. autoclass:: avocado.core.messages.StdoutMessageHandler + :noindex: .. autoclass:: avocado.core.messages.StderrMessageHandler + :noindex: .. autoclass:: avocado.core.messages.WhiteboardMessageHandler + :noindex: .. autoclass:: avocado.core.messages.FileMessageHandler + :noindex: From 84b46cdb1cc5941625a5c37847ade939a7cf6ff2 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 27 Nov 2023 15:09:35 +0100 Subject: [PATCH 03/13] missing doc for optional-plugins API The sphinx-apidoc command didn't respect the namespaces of optional plugins, because of that the generated documentation didn't point to right modules. Signed-off-by: Jan Richter --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 4ae0e49b47..dbde8cd841 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -202,7 +202,7 @@ def generate_vmimage_distro(): continue output_dir = os.path.join(API_OPTIONAL_PLUGINS_PATH, name) params = {"API_SOURCE_DIR": path, "output_dir": output_dir, "exclude_dirs": ""} - process.run(APIDOC_TEMPLATE % params) + process.run(f"{APIDOC_TEMPLATE % params} --implicit-namespaces") # Remove the unnecessary generated files os.unlink(os.path.join(output_dir, "modules.rst")) optional_plugins_toc.write(f"\n {os.path.join(name, name)}") From 7149a502289d131e0db0c339f888be4bbd894884 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 27 Nov 2023 15:26:52 +0100 Subject: [PATCH 04/13] Inline emphasis start-string without end-string fix Signed-off-by: Jan Richter --- avocado/core/dispatcher.py | 2 +- avocado/utils/podman.py | 2 +- docs/source/conf.py | 3 ++- docs/source/releases/95_0.rst | 2 +- docs/source/releases/lts/92_0.rst | 4 ++-- 5 files changed, 7 insertions(+), 6 deletions(-) diff --git a/avocado/core/dispatcher.py b/avocado/core/dispatcher.py index 1421a8703f..2f00ffea2f 100644 --- a/avocado/core/dispatcher.py +++ b/avocado/core/dispatcher.py @@ -29,7 +29,7 @@ def get_dispatchers(module_name): """Returns the classes that implement plugin dispatching - These should inherit from the *ExtensionManager base classes + These should inherit from the *ExtensionManager* base classes and contain suitable descriptions. The produced values are tuples that contain the dispatcher class diff --git a/avocado/utils/podman.py b/avocado/utils/podman.py index ba2bf32561..a557559701 100644 --- a/avocado/utils/podman.py +++ b/avocado/utils/podman.py @@ -44,7 +44,7 @@ def __init__(self, podman_bin=None): async def execute(self, *args): """Execute a command and return the returncode, stdout and stderr. - :param *args: Variable length argument list to be used as argument + :param args: Variable length argument list to be used as argument during execution. :rtype: tuple with returncode, stdout and stderr. """ diff --git a/docs/source/conf.py b/docs/source/conf.py index dbde8cd841..689b0917ef 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -40,8 +40,9 @@ def generate_reference(): reference_path = os.path.join( ROOT_PATH, "docs", "source", "config", "reference.rst" ) + stdout_text = result.stdout_text.replace("['/run/*']", r"['/run/\*']") with open(reference_path, "w", encoding="utf-8") as reference: - reference.write(result.stdout_text) + reference.write(stdout_text) def generate_vmimage_distro(): diff --git a/docs/source/releases/95_0.rst b/docs/source/releases/95_0.rst index a3176a9e2b..7e15428058 100644 --- a/docs/source/releases/95_0.rst +++ b/docs/source/releases/95_0.rst @@ -51,7 +51,7 @@ Misc Changes * ``RuntimeTask`` instances are now comparable, and should now be unique when representing requirements, preventing having duplicates. -* The order of the ``RuntimeTask``s are now defined in a dependency +* The order of the ``RuntimeTask`` are now defined in a dependency graph, in accordance with BluePrint 004. Internal Changes diff --git a/docs/source/releases/lts/92_0.rst b/docs/source/releases/lts/92_0.rst index ef09faab5a..999773b1c3 100644 --- a/docs/source/releases/lts/92_0.rst +++ b/docs/source/releases/lts/92_0.rst @@ -580,10 +580,10 @@ Utility APIs :mod:`avocado.utils.distro` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* :mod:`avocado.utils.distro: can now detect the distribution on remote +* :mod:`avocado.utils.distro:` can now detect the distribution on remote machines. -* The :mod:`avocado.utils.distro: will now correctly return a +* The :mod:`avocado.utils.distro:` will now correctly return a ``avocado.utils.distro.UNKNOWN_DISTRO`` on non UNIX systems, instead of crashing. From 2287e0c53f40ed55acc129993d1d57a141024329 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 27 Nov 2023 15:51:19 +0100 Subject: [PATCH 05/13] toctree contains reference to nonexisting document fix varianter plugins doc has been moved to its own subsection therefore we need to remove them from toctree. Signed-off-by: Jan Richter --- docs/source/plugins/index.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/plugins/index.rst b/docs/source/plugins/index.rst index b644725734..c69b9c7216 100644 --- a/docs/source/plugins/index.rst +++ b/docs/source/plugins/index.rst @@ -34,6 +34,3 @@ Some of these plugins may have extra dependencies of their own. optional/results/index optional/robot optional/varianters/index - optional/varianter_pict - optional/multiplexer - optional/varianter_yaml_to_mux From 2d741f68909c7ae736830f6a76fd7c88554fa179 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 27 Nov 2023 16:54:12 +0100 Subject: [PATCH 06/13] ERROR: Undefined substitution referenced fix Signed-off-by: Jan Richter --- avocado/utils/external/gdbmi_parser.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/avocado/utils/external/gdbmi_parser.py b/avocado/utils/external/gdbmi_parser.py index 5e33816699..49ed28bfe8 100644 --- a/avocado/utils/external/gdbmi_parser.py +++ b/avocado/utils/external/gdbmi_parser.py @@ -104,7 +104,8 @@ def t_whitespace(self, s): # pylint: disable=W0613 r"[ \t\f\v]+" def t_symbol(self, s): - r",|\{|\}|\[|\]|\=" + """""" # pylint: disable=C0112 + r",|\{|\}|\[|\]|\=" # pylint: disable=w0105 self.rv.append(Token(s, s)) def t_result_type(self, s): From 3485e9cc30b315fa83afbf1de41468a872a975da Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 27 Nov 2023 17:08:49 +0100 Subject: [PATCH 07/13] 'intersphinx_mapping' format is deprecated fix Signed-off-by: Jan Richter --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 689b0917ef..96b16a5f53 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -263,6 +263,6 @@ def generate_vmimage_distro(): ), ] -intersphinx_mapping = {"http://docs.python.org/": None} # pylint: disable=C0103 +intersphinx_mapping = {"python": ("https://docs.python.org", None)} autoclass_content = "both" # pylint: disable=C0103 From af9a255978def175b576b7d934eab472008d9821 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Mon, 27 Nov 2023 17:11:01 +0100 Subject: [PATCH 08/13] Title underline too short fix Signed-off-by: Jan Richter --- docs/source/blueprints/BP003.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/blueprints/BP003.rst b/docs/source/blueprints/BP003.rst index eeb5314afb..b2ca3507bb 100644 --- a/docs/source/blueprints/BP003.rst +++ b/docs/source/blueprints/BP003.rst @@ -544,7 +544,7 @@ scheduler". They are provided for discussion only and do not constitute hard requirements for this or future work. Tasks' requirements fulfillment ------------------------------- +------------------------------- 1. Prepare for the execution of a task, such as the fulfillment of extra task requirements. The requirements resolver is one, if not the only way, From 2e527b141c69014bef205e11ab6b8b0a3ca8f724 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Tue, 28 Nov 2023 13:17:41 +0100 Subject: [PATCH 09/13] undefined label fix Signed-off-by: Jan Richter --- docs/source/releases/53_0.rst | 2 +- docs/source/releases/59_0.rst | 6 +++--- docs/source/releases/61_0.rst | 2 +- docs/source/releases/71_0.rst | 2 +- docs/source/releases/lts/69_0.rst | 10 +++++----- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/source/releases/53_0.rst b/docs/source/releases/53_0.rst index bba58048ae..d31c86c72b 100644 --- a/docs/source/releases/53_0.rst +++ b/docs/source/releases/53_0.rst @@ -18,7 +18,7 @@ Users/Test Writers input used for the varianter yaml_to_mux plugin. It allows the definition of test suite based on a YAML file, including different variants for different tests. For more information refer to - :ref:`yaml_loader`. + `yaml_loader`. * A better handling of interruption related signals, such as ``SIGINT`` and ``SIGTERM``. Avocado will now try harder to not diff --git a/docs/source/releases/59_0.rst b/docs/source/releases/59_0.rst index 598cd958f4..f9bdbea570 100644 --- a/docs/source/releases/59_0.rst +++ b/docs/source/releases/59_0.rst @@ -14,7 +14,7 @@ roughly categorized into major topics and intended audience: Users/Test Writers ================== -* A :ref:`new plugin ` enables users to list and execute +* A `new plugin glib-plugin` enables users to list and execute tests based on the `GLib test framework `_. This plugin allows individual tests inside a single binary to be listed @@ -24,8 +24,8 @@ Users/Test Writers that can tweak test attributes, including adding prefixes to test names. This allows users to easily differentiate among execution of the same test, but executed different configurations. For more - information, look for "special keys" in the :ref:`YAML Loader plugin - documentation `. + information, look for "special keys" in the `YAML Loader plugin + documentation yaml_loader`. * Users can now dump variants to a (JSON) file, and also reuse a previously created file in their future jobs execution. This allows diff --git a/docs/source/releases/61_0.rst b/docs/source/releases/61_0.rst index 3b318e1744..5d14dcf270 100644 --- a/docs/source/releases/61_0.rst +++ b/docs/source/releases/61_0.rst @@ -23,7 +23,7 @@ Users/Test Writers * SIMPLE tests can also finish with ``SKIP`` OR ``WARN`` status, depending on the output produced, and the Avocado test runner configuration. It now supports patterns that span across multiple - lines. For more information, refer to :ref:`test_type_simple_status`. + lines. For more information, refer to `test_type_simple_status`. * Simple bytes and "unicode strings" utility functions have been added to :mod:`avocado.utils.astring`, and can be used by extension and diff --git a/docs/source/releases/71_0.rst b/docs/source/releases/71_0.rst index 28e979e466..6cba3c2b58 100644 --- a/docs/source/releases/71_0.rst +++ b/docs/source/releases/71_0.rst @@ -61,7 +61,7 @@ Users/Test Writers and supported soon. * By means of a new plugin (``merge_files``, of type ``job.prepost``), - when using the :ref:`output check record ` + when using the `output check record output_check_record` features, duplicate files created by different tests/variants will be consolidated into unique files. diff --git a/docs/source/releases/lts/69_0.rst b/docs/source/releases/lts/69_0.rst index 21098da178..678b45ca59 100644 --- a/docs/source/releases/lts/69_0.rst +++ b/docs/source/releases/lts/69_0.rst @@ -498,7 +498,7 @@ Users OR ``WARN`` status, depending on the output produced, and the Avocado test runner configuration. It now supports patterns that span across multiple lines. For more information, refer to - :ref:`test_type_simple_status`. + `test_type_simple_status`. * A better handling of interruption related signals, such as ``SIGINT`` and ``SIGTERM``. Avocado will now try harder to not @@ -611,16 +611,16 @@ Test Loader Plugins input used for the varianter yaml_to_mux plugin. It allows the definition of test suite based on a YAML file, including different variants for different tests. For more information refer to - :ref:`yaml_loader`. + `yaml_loader`. * Users of the YAML test loader have now access to a few special keys that can tweak test attributes, including adding prefixes to test names. This allows users to easily differentiate among execution of the same test, but executed different configurations. For more - information, look for "special keys" in the :ref:`YAML Loader plugin - documentation `. + information, look for "special keys" in the `YAML Loader plugin + documentation yaml_loader`. -* A :ref:`new plugin ` enables users to list and execute +* A `new plugin glib-plugin` enables users to list and execute tests based on the `GLib test framework `_. This plugin allows individual tests inside a single binary to be listed From 4b65124ee73341efcc04d1f0f94dbacd3fdd9f6d Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Tue, 28 Nov 2023 13:32:26 +0100 Subject: [PATCH 10/13] Malformed table fix Signed-off-by: Jan Richter --- docs/source/guides/writer/chapters/writing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/writer/chapters/writing.rst b/docs/source/guides/writer/chapters/writing.rst index 8cd34726cc..7051367960 100644 --- a/docs/source/guides/writer/chapters/writing.rst +++ b/docs/source/guides/writer/chapters/writing.rst @@ -1310,7 +1310,7 @@ tests: +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ | AVOCADO_TEST_BASEDIR | Base directory of Avocado tests | $HOME/src/avocado/avocado.dev/examples/tests | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ -| AVOCADO_TEST_WORKDIR | Work directory for the test | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +| AVOCADO_TEST_WORKDIR | Work directory for the test | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ | AVOCADO_TESTS_COMMON_TMPDIR | Temporary directory created by the | /var/tmp/avocado_cp07qzd9 | | | :ref:`plugin_teststmpdir` plugin. The| | @@ -1336,7 +1336,7 @@ tests: +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ | AVOCADO_TEST_BASEDIR | Base directory of Avocado tests | $HOME/src/avocado/avocado.dev/examples/tests | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ -| AVOCADO_TEST_WORKDIR | Work directory for the test | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +| AVOCADO_TEST_WORKDIR | Work directory for the test | /var/tmp/.avocado-taskcx8of8di/test-results/tmp_dirfgqrnbu/1-Env.test | +-----------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------+ | AVOCADO_TESTS_COMMON_TMPDIR | Temporary directory created by the | /var/tmp/avocado_XhEdo/ | | | :ref:`plugin_teststmpdir` plugin. The| | From e2f3d579ba258ccf68c2638eae87681849864a4b Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Tue, 28 Nov 2023 13:35:43 +0100 Subject: [PATCH 11/13] Unknown interpreted text role fix Signed-off-by: Jan Richter --- docs/source/releases/84_0.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/releases/84_0.rst b/docs/source/releases/84_0.rst index 653a142936..c31b3afa0c 100644 --- a/docs/source/releases/84_0.rst +++ b/docs/source/releases/84_0.rst @@ -59,7 +59,7 @@ Utility APIs * :class:`avocado.utils.ssh.Session` now contains a :meth:`avocado.utils.ssh.Session.cleanup_master` method and a - :property:`avocado.utils.ssh.Session.control_master` property. + `avocado.utils.ssh.Session.control_master` property. Internal Changes ================ From 65bfbce54d43c7ea5f164f7112809422cbd8aea2 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Tue, 28 Nov 2023 13:40:54 +0100 Subject: [PATCH 12/13] template.rst document isn't included in any toctree fix Signed-off-by: Jan Richter --- docs/source/blueprints/template.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/blueprints/template.rst b/docs/source/blueprints/template.rst index 41e069dbd0..fa890f6515 100644 --- a/docs/source/blueprints/template.rst +++ b/docs/source/blueprints/template.rst @@ -1,8 +1,10 @@ +:orphan: + BP??? ##### .. Please refer to BP000 for detailed instructions on how to write a - BluePrint (and remove this comment from your final document). + BluePrint (and remove this comment and :orphan: tag from your final document). :Number: BP??? :Title: From b5008fc72415d7c805e334246a21522ad1621163 Mon Sep 17 00:00:00 2001 From: Jan Richter Date: Tue, 5 Dec 2023 11:03:02 +0100 Subject: [PATCH 13/13] Static checks for html documentation This commit introduces the static checks for avocado documentation. This change will help us avoid documentation issues in the future. It makes the readthedocs build more strict, which make it fail on any warning. Reference: #5757 Signed-off-by: Jan Richter --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7fd528d648..519e466fd1 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,6 +14,7 @@ build: # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py + fail_on_warning: true # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html