Rebase with latest main

Author: carl-baillargeon

.github/workflows/code-testing.yml

@@ -122,7 +122,7 @@ jobs:
   test-documentation:
     name: Build offline documentation for testing
     runs-on: ubuntu-20.04
-    needs: [lint-python, type-python, test-python]
+    needs: [test-python]
     steps:
       - uses: actions/checkout@v4
       - name: Setup Python

.github/workflows/on-demand.yml

@@ -39,7 +39,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: Dockerfile

.github/workflows/pr-triage.yml

@@ -13,7 +13,7 @@ jobs:
     # https://github.com/marketplace/actions/auto-author-assign
     runs-on: ubuntu-latest
     steps:
-      - uses: toshimaru/[email protected].0
+      - uses: toshimaru/[email protected].1
         with:
           repo-token: "${{ secrets.GITHUB_TOKEN }}"
 
@@ -22,7 +22,7 @@ jobs:
     steps:
       # Please look up the latest version from
       # https://github.com/amannn/action-semantic-pull-request/releases
-      - uses: amannn/[email protected].2
+      - uses: amannn/[email protected].3
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.github/workflows/release.yml

@@ -100,7 +100,7 @@ jobs:
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: Dockerfile

.github/workflows/secret-scanner.yml

@@ -10,21 +10,6 @@ jobs:
   scan_secret:
     name: Scan incoming changes
     runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/aristanetworks/secret-scanner-service:main
-      options: --name sss-scanner
-    steps:
-      - name: Checkout ${{ github.ref }}
-        # Hitting https://github.com/actions/checkout/issues/334 so trying v1
-        uses: actions/checkout@v1
-        with:
-          fetch-depth: 0
+    steps: 
       - name: Run scanner
-        run: |
-          git config --global --add safe.directory $GITHUB_WORKSPACE
-          scanner commit . github ${{ github.repository }} \
-             --markdown-file job_summary.md \
-             ${{ github.event_name == 'pull_request' && format('--since-commit {0}', github.event.pull_request.base.sha) || ''}}
-      - name: Write result to summary
-        run: cat ./job_summary.md >> $GITHUB_STEP_SUMMARY
-        if: ${{ always() }}
+        uses: aristanetworks/secret-scanner-service-public@main

.github/workflows/sonar.yml

@@ -0,0 +1,44 @@
+---
+name: Analysis with Sonarlint and publish to SonarCloud
+on:
+  push:
+    branches:
+      - main
+  # Need to do this to be able to have coverage on PR across forks.
+  pull_request_target:
+
+# TODO this can be made better by running only coverage, it happens that today
+# in tox gh-actions we have configured 3.11 to run the report side in
+# pyproject.toml
+
+jobs:
+  sonarcloud:
+    name: Run Sonarlint analysis and upload to SonarCloud.
+    if: github.repository == 'aristanetworks/anta'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: pip install tox tox-gh-actions
+      - name: "Run pytest via tox for ${{ matrix.python }}"
+        run: tox
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          # Using ACTION_STEP_DEBUG to trigger verbose when debugging in Github Action
+          args: >
+            -Dsonar.scm.revision=${{ github.event.pull_request.head.sha }}
+            -Dsonar.pullrequest.key=${{ github.event.number }}
+            -Dsonar.pullrequest.branch=${{ github.event.pull_request.head.ref }}
+            -Dsonar.pullrequest.base=${{ github.event.pull_request.base.ref }}
+            -Dsonar.verbose=${{ secrets.ACTIONS_STEP_DEBUG }}

.pre-commit-config.yaml

@@ -43,7 +43,7 @@ repos:
           - '<!--|  ~|  -->'
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.8
+    rev: v0.5.5
     hooks:
     - id: ruff
       name: Run Ruff linter
@@ -52,7 +52,7 @@ repos:
       name: Run Ruff formatter
 
   - repo: https://github.com/pycqa/pylint
-    rev: "v3.2.3"
+    rev: "v3.2.6"
     hooks:
       - id: pylint
         name: Check code style with pylint
@@ -80,7 +80,7 @@ repos:
         types: [text]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.0
+    rev: v1.11.0
     hooks:
       - id: mypy
         name: Check typing with mypy

anta/__init__.py

@@ -20,7 +20,10 @@
 __copyright__ = "Copyright 2022-2024, Arista Networks, Inc."
 
 # ANTA Debug Mode environment variable
-__DEBUG__ = bool(os.environ.get("ANTA_DEBUG", "").lower() == "true")
+__DEBUG__ = os.environ.get("ANTA_DEBUG", "").lower() == "true"
+if __DEBUG__:
+    # enable asyncio DEBUG mode when __DEBUG__ is enabled
+    os.environ["PYTHONASYNCIODEBUG"] = "1"
 
 
 # Source: https://rich.readthedocs.io/en/stable/appendix/colors.html

anta/catalog.py

@@ -11,14 +11,14 @@
 from collections import defaultdict
 from inspect import isclass
 from itertools import chain
+from json import load as json_load
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Optional, Union
+from typing import TYPE_CHECKING, Any, Literal, Optional, Union
 
-import yaml
 from pydantic import BaseModel, ConfigDict, RootModel, ValidationError, ValidationInfo, field_validator, model_serializer, model_validator
 from pydantic.types import ImportString
 from pydantic_core import PydanticCustomError
-from yaml import YAMLError, safe_load
+from yaml import YAMLError, safe_dump, safe_load
 
 from anta.logger import anta_log_exception
 from anta.models import AntaTest
@@ -239,7 +239,16 @@ def yaml(self) -> str:
         # This could be improved.
         # https://github.com/pydantic/pydantic/issues/1043
         # Explore if this worth using this: https://github.com/NowanIlfideme/pydantic-yaml
-        return yaml.safe_dump(yaml.safe_load(self.model_dump_json(serialize_as_any=True, exclude_unset=True)), indent=2, width=math.inf)
+        return safe_dump(safe_load(self.model_dump_json(serialize_as_any=True, exclude_unset=True)), indent=2, width=math.inf)
+
+    def to_json(self) -> str:
+        """Return a JSON representation string of this model.
+
+        Returns
+        -------
+            The JSON representation string of this model.
+        """
+        return self.model_dump_json(serialize_as_any=True, exclude_unset=True, indent=2)
 
 
 class AntaCatalog:
@@ -255,8 +264,8 @@ def __init__(
     ) -> None:
         """Instantiate an AntaCatalog instance.
 
-        Args:
-        ----
+        Parameters
+        ----------
             tests: A list of AntaTestDefinition instances.
             filename: The path from which the catalog is loaded.
 
@@ -299,19 +308,24 @@ def tests(self, value: list[AntaTestDefinition]) -> None:
         self._tests = value
 
     @staticmethod
-    def parse(filename: str | Path) -> AntaCatalog:
+    def parse(filename: str | Path, file_format: Literal["yaml", "json"] = "yaml") -> AntaCatalog:
         """Create an AntaCatalog instance from a test catalog file.
 
-        Args:
-        ----
-            filename: Path to test catalog YAML file
+        Parameters
+        ----------
+            filename: Path to test catalog YAML or JSON fil
+            file_format: Format of the file, either 'yaml' or 'json'
 
         """
+        if file_format not in ["yaml", "json"]:
+            message = f"'{file_format}' is not a valid format for an AntaCatalog file. Only 'yaml' and 'json' are supported."
+            raise ValueError(message)
+
         try:
             file: Path = filename if isinstance(filename, Path) else Path(filename)
             with file.open(encoding="UTF-8") as f:
-                data = safe_load(f)
-        except (TypeError, YAMLError, OSError) as e:
+                data = safe_load(f) if file_format == "yaml" else json_load(f)
+        except (TypeError, YAMLError, OSError, ValueError) as e:
             message = f"Unable to parse ANTA Test Catalog file '{filename}'"
             anta_log_exception(e, message, logger)
             raise
@@ -326,8 +340,8 @@ def from_dict(data: RawCatalogInput, filename: str | Path | None = None) -> Anta
         It is the data structure returned by `yaml.load()` function of a valid
         YAML Test Catalog file.
 
-        Args:
-        ----
+        Parameters
+        ----------
             data: Python dictionary used to instantiate the AntaCatalog instance
             filename: value to be set as AntaCatalog instance attribute
 
@@ -360,8 +374,8 @@ def from_list(data: ListAntaTestTuples) -> AntaCatalog:
 
         See ListAntaTestTuples type alias for details.
 
-        Args:
-        ----
+        Parameters
+        ----------
             data: Python list used to instantiate the AntaCatalog instance
 
         """
@@ -378,8 +392,8 @@ def from_list(data: ListAntaTestTuples) -> AntaCatalog:
     def merge(catalogs: list[AntaCatalog]) -> AntaCatalog:
         """Merge multiple AntaCatalog instances.
 
-        Args:
-        ----
+        Parameters
+        ----------
             catalogs: List of AntaCatalog instances to merge.
 
         Returns
@@ -431,8 +445,8 @@ def build_indexes(self, filtered_tests: set[str] | None = None) -> None:
     def get_tests_by_tags(self, tags: set[str], *, strict: bool = False) -> set[AntaTestDefinition]:
         """Return all tests that match a given set of tags, according to the specified strictness.
 
-        Args:
-        ----
+        Parameters
+        ----------
             tags: The tags to filter tests by. If empty, return all tests without tags.
             strict: If True, returns only tests that contain all specified tags (intersection).
                     If False, returns tests that contain any of the specified tags (union).

anta/cli/get/utils.py

@@ -82,8 +82,8 @@ def get_cv_token(cvp_ip: str, cvp_username: str, cvp_password: str, *, verify_ce
 
     TODO: need to handle requests error
 
-    Args:
-    ----
+    Parameters
+    ----------
         cvp_ip: IP address of CloudVision.
         cvp_username: Username to connect to CloudVision.
         cvp_password: Password to connect to CloudVision.
@@ -161,8 +161,8 @@ def deep_yaml_parsing(data: dict[str, Any], hosts: list[AntaInventoryHost] | Non
 def create_inventory_from_ansible(inventory: Path, output: Path, ansible_group: str = "all") -> None:
     """Create an ANTA inventory from an Ansible inventory YAML file.
 
-    Args:
-    ----
+    Parameters
+    ----------
         inventory: Ansible Inventory file to read
         output: ANTA inventory file to generate.
         ansible_group: Ansible group from where to extract data.

anta/cli/nrfu/__init__.py

@@ -5,19 +5,14 @@
 
 from __future__ import annotations
 
-import asyncio
 from typing import TYPE_CHECKING, get_args
 
 import click
 
 from anta.cli.nrfu import commands
 from anta.cli.utils import AliasedGroup, catalog_options, inventory_options
 from anta.custom_types import TestStatus
-from anta.models import AntaTest
 from anta.result_manager import ResultManager
-from anta.runner import main
-
-from .utils import anta_progress_bar, print_settings
 
 if TYPE_CHECKING:
     from anta.catalog import AntaCatalog
@@ -37,6 +32,7 @@ def parse_args(self, ctx: click.Context, args: list[str]) -> list[str]:
         """Ignore MissingParameter exception when parsing arguments if `--help` is present for a subcommand."""
         # Adding a flag for potential callbacks
         ctx.ensure_object(dict)
+        ctx.obj["args"] = args
         if "--help" in args:
             ctx.obj["_anta_help"] = True
 
@@ -96,7 +92,7 @@ def parse_args(self, ctx: click.Context, args: list[str]) -> list[str]:
     default=None,
     type=click.Choice(HIDE_STATUS, case_sensitive=False),
     multiple=True,
-    help="Group result by test or device.",
+    help="Hide results by type: success / failure / error / skipped'.",
     required=False,
 )
 @click.option(
@@ -120,38 +116,34 @@ def nrfu(
     ignore_status: bool,
     ignore_error: bool,
     dry_run: bool,
+    catalog_format: str = "yaml",
 ) -> None:
     """Run ANTA tests on selected inventory devices."""
     # If help is invoke somewhere, skip the command
     if ctx.obj.get("_anta_help"):
         return
+
     # We use ctx.obj to pass stuff to the next Click functions
     ctx.ensure_object(dict)
     ctx.obj["result_manager"] = ResultManager()
     ctx.obj["ignore_status"] = ignore_status
     ctx.obj["ignore_error"] = ignore_error
     ctx.obj["hide"] = set(hide) if hide else None
-    print_settings(inventory, catalog)
-    with anta_progress_bar() as AntaTest.progress:
-        asyncio.run(
-            main(
-                ctx.obj["result_manager"],
-                inventory,
-                catalog,
-                tags=tags,
-                devices=set(device) if device else None,
-                tests=set(test) if test else None,
-                dry_run=dry_run,
-            )
-        )
-    if dry_run:
-        return
+    ctx.obj["catalog"] = catalog
+    ctx.obj["catalog_format"] = catalog_format
+    ctx.obj["inventory"] = inventory
+    ctx.obj["tags"] = tags
+    ctx.obj["device"] = device
+    ctx.obj["test"] = test
+    ctx.obj["dry_run"] = dry_run
+
     # Invoke `anta nrfu table` if no command is passed
-    if ctx.invoked_subcommand is None:
+    if not ctx.invoked_subcommand:
         ctx.invoke(commands.table)
 
 
 nrfu.add_command(commands.table)
+nrfu.add_command(commands.csv)
 nrfu.add_command(commands.json)
 nrfu.add_command(commands.text)
 nrfu.add_command(commands.tpl_report)