fix(anta)!: Make multiple tags filtering work properly (and fall pytest cleaning)

.gitignore

@@ -1,8 +1,10 @@
 __pycache__
 *.pyc
 .pages
-.coverage
 .pytest_cache
+.mypy_cache
+.ruff_cache
+.cache
 build
 dist
 *.egg-info
@@ -46,14 +48,13 @@ htmlcov/
 .tox/
 .nox/
 .coverage
+coverage_html_report
 .coverage.*
-.cache
 nosetests.xml
 coverage.xml
 *.cover
 *.py,cover
 .hypothesis/
-.pytest_cache/
 cover/
 report.html
 
@@ -97,17 +98,4 @@ venv.bak/
 /site
 
 # VScode settings
-.vscode
-test.env
-tech-support/
-tech-support/*
-2*
-
-**/report.html
-.*report.html
-
-# direnv file
-.envrc
-
-clab-atd-anta/*
-clab-atd-anta/
+.vscode

.vscode/settings.json

@@ -3,28 +3,13 @@
   "ruff.configuration": "pyproject.toml",
   "python.testing.unittestEnabled": false,
   "python.testing.pytestEnabled": true,
-  "pylint.importStrategy": "fromEnvironment",
-  "pylint.severity": {
-    "refactor": "Warning"
-  },
-  "pylint.args": [
-    "--load-plugins",
-    "pylint_pydantic",
-    "--rcfile=pyproject.toml"
-  ],
   "python.testing.pytestArgs": [
     "tests"
   ],
-  "autoDocstring.docstringFormat": "numpy",
-  "autoDocstring.includeName": false,
-  "autoDocstring.includeExtendedSummary": true,
-  "autoDocstring.startOnNewLine": true,
-  "autoDocstring.guessTypes": true,
   "python.languageServer": "Pylance",
   "githubIssues.issueBranchTitle": "issues/${issueNumber}-${issueTitle}",
   "editor.formatOnPaste": true,
   "files.trimTrailingWhitespace": true,
-  "mypy.configFile": "pyproject.toml",
   "workbench.remoteIndicator.showExtensionRecommendations": true,
 
 }

anta/tests/logging.py

@@ -100,13 +100,13 @@ class VerifyLoggingSourceIntf(AntaTest):
     ```
     """
 
-    name = "VerifyLoggingSourceInt"
+    name = "VerifyLoggingSourceIntf"
     description = "Verifies logging source-interface for a specified VRF."
     categories: ClassVar[list[str]] = ["logging"]
     commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show logging", ofmt="text")]
 
     class Input(AntaTest.Input):
-        """Input model for the VerifyLoggingSourceInt test."""
+        """Input model for the VerifyLoggingSourceIntf test."""
 
         interface: str
         """Source-interface to use as source IP of log messages."""
@@ -115,7 +115,7 @@ class Input(AntaTest.Input):
 
     @AntaTest.anta_test
     def test(self) -> None:
-        """Main test function for VerifyLoggingSourceInt."""
+        """Main test function for VerifyLoggingSourceIntf."""
         output = self.instance_commands[0].text_output
         pattern = rf"Logging source-interface '{self.inputs.interface}'.*VRF {self.inputs.vrf}"
         if re.search(pattern, _get_logging_states(self.logger, output)):

docs/contribution.md

@@ -116,7 +116,7 @@ Test example for `anta.tests.system.VerifyUptime` AntaTest.
 
 ``` python
 # Import the generic test function
-from tests.lib.anta import test  # noqa: F401
+from tests.units.anta_tests import test  # noqa: F401
 
 # Import your AntaTest
 from anta.tests.system import VerifyUptime

pyproject.toml

@@ -168,8 +168,9 @@ addopts = "-ra -q -vv --cov --cov-report term:skip-covered --color yes"
 log_level = "WARNING"
 render_collapsed = true
 testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
 filterwarnings = [
-  "error",
   # cvprac is raising the next warning
   "default:pkg_resources is deprecated:DeprecationWarning",
   # Need to investigate the following - only occuring when running the full pytest suite
@@ -337,7 +338,8 @@ select = ["ALL",
     # "D417",
 ]
 ignore = [
-  "ANN101",  # Missing type annotation for `self` in method - we know what self is..
+  "D203",    # Ignoring conflicting D* warnings - one-blank-line-before-class
+  "D213",    # Ignoring conflicting D* warnings - multi-line-summary-second-line
   "COM812",  # Ignoring conflicting rules that may cause conflicts when used with the formatter
   "ISC001",  # Ignoring conflicting rules that may cause conflicts when used with the formatter
   "TD002",   # We don't have require authors in TODO
@@ -382,6 +384,7 @@ runtime-evaluated-base-classes = ["pydantic.BaseModel", "anta.models.AntaTest.In
   "SLF001",  # Lots of private member accessed for test purposes
 ]
 "tests/units/*" = [
+  "ARG002",  # Sometimes we need to declare unused arguments when a parameter is not used but declared in @pytest.mark.parametrize
   "BLE001",  # Do not catch blind exception: `Exception` - already disabling this in pylint
   "FBT001",  # Boolean-typed positional argument in function definition
   "PLR0913", # Too many arguments to function call (8 > 5)

tests/conftest.py

@@ -1,53 +1,17 @@
 # Copyright (c) 2023-2024 Arista Networks, Inc.
 # Use of this source code is governed by the Apache License 2.0
 # that can be found in the LICENSE file.
-"""conftest.py - used to store anta specific fixtures used for tests."""
+"""See https://docs.pytest.org/en/stable/reference/fixtures.html#conftest-py-sharing-fixtures-across-multiple-files."""
 
 from __future__ import annotations
 
-import logging
-from typing import Any
-
 import pytest
 
 # Load fixtures from dedicated file tests/lib/fixture.py
-# As well as pytest_asyncio plugin to test co-routines
 pytest_plugins = [
     "tests.lib.fixture",
-    "pytest_asyncio",
 ]
 
 # Enable nice assert messages
 # https://docs.pytest.org/en/7.1.x/how-to/writing_plugins.html#assertion-rewriting
-pytest.register_assert_rewrite("tests.lib.anta")
-
-# Placeholder to disable logging of some external libs
-for _ in ("asyncio", "httpx"):
-    logging.getLogger(_).setLevel(logging.CRITICAL)
-
-
-def build_test_id(val: dict[str, Any]) -> str:
-    """Build id for a unit test of an AntaTest subclass.
-
-    {
-        "name": "meaniful test name",
-        "test": <AntaTest instance>,
-        ...
-    }
-    """
-    return f"{val['test'].module}.{val['test'].__name__}-{val['name']}"
-
-
-def pytest_generate_tests(metafunc: pytest.Metafunc) -> None:
-    """Generate ANTA testts unit tests dynamically during test collection.
-
-    It will parametrize test cases based on the `DATA` data structure defined in `tests.units.anta_tests` modules.
-    See `tests/units/anta_tests/README.md` for more information on how to use it.
-    Test IDs are generated using the `build_test_id` function above.
-
-    Checking that only the function "test" is parametrized with data to allow for writing tests for helper functions
-    in each module.
-    """
-    if "tests.units.anta_tests" in metafunc.module.__package__ and metafunc.function.__name__ == "test":
-        # This is a unit test for an AntaTest subclass
-        metafunc.parametrize("data", metafunc.module.DATA, ids=build_test_id)
+pytest.register_assert_rewrite("tests.unit.anta_tests")