anta 1.10.0.dev1__tar.gz → 1.10.0.dev2__tar.gz

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anta
-Version: 1.10.0.dev1
+Version: 1.10.0.dev2
 Summary: Arista Network Test Automation (ANTA) Framework
 Author-email: Arista Networks ANTA maintainers <anta-dev@arista.com>
 Maintainer-email: Arista Networks ANTA maintainers <anta-dev@arista.com>, Khelil Sator <ksator@arista.com>, Matthieu Tâche <mtache@arista.com>, Thomas Grimonet <tgrimonet@arista.com>, Guillaume Mulocher <gmulocher@arista.com>, Carl Baillargeon <carl.baillargeon@arista.com>

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/anta/_advisory/reporter/md_reporter.py

@@ -7,9 +7,9 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, ClassVar
 
-from anta._advisory.models import _AdvisoryMetadata, _AdvisoryVulnerabilitySeverity
+from anta._advisory.models import _ADVISORY_VULNERABILITY_SEVERITY_RANK, _AdvisoryMetadata, _AdvisoryVulnerabilitySeverity
 from anta._advisory.reporter.reporting import SecurityAdvisoryRunOverviewData, _get_advisory_result
-from anta._advisory.results import _get_atomic_vulnerability_ids
+from anta._advisory.results import _AdvisoryAtomicTestResult, _AdvisoryTestResult, _get_atomic_vulnerability_ids
 from anta.reporter.md_reporter import MDReportBase
 from anta.result_manager.models import AntaTestStatus
 
@@ -64,6 +64,27 @@ class SecurityAdvisoryMDReportBase(MDReportBase):
         """Format an ANTA result using advisory-facing terminology."""
         return f"{RESULT_ICONS[result.result]} {_get_advisory_result(result).title()}"
 
+    @staticmethod
+    def format_severity(severity: _AdvisoryVulnerabilitySeverity) -> str:
+        """Format a vulnerability severity with its identifying icon."""
+        return f"{SEVERITY_ICONS[severity]} {severity.value.title()}"
+
+    def format_remediations(self, result: TestResult | AtomicTestResult) -> str:
+        """Format advisory remediation entries for a Markdown table cell."""
+        if not isinstance(result, (_AdvisoryTestResult, _AdvisoryAtomicTestResult)):
+            return "-"
+        remediations = list(result.remediations)
+        atomic_remediations: list[str] = []
+        if isinstance(result, _AdvisoryTestResult):
+            atomic_remediations = [
+                remediation for atomic in result.atomic_results if isinstance(atomic, _AdvisoryAtomicTestResult) for remediation in atomic.remediations
+            ]
+            remediations.extend(atomic_remediations)
+        unique_remediations = dict.fromkeys(remediations)
+        if atomic_remediations:
+            return "<br>".join(f"•&nbsp;{self.safe_markdown(remediation)}" for remediation in unique_remediations)
+        return self.safe_markdown("\n".join(unique_remediations)) or "-"
+
 
 class ANTASecurityAdvisoryReport(SecurityAdvisoryMDReportBase):
     """Generate the title and table of contents for a security advisory report."""
@@ -72,15 +93,18 @@ class ANTASecurityAdvisoryReport(SecurityAdvisoryMDReportBase):
 
     def generate_section(self) -> None:
         """Generate the security advisory report heading and table of contents."""
-        self.write_heading(heading_level=1)
-        toc = "**Table of Contents:**\n\n- [ANTA Security Advisory Report](#anta-security-advisory-report)\n"
+        self.mdfile.write('<h1 id="anta-security-advisory-report" align="center">🛡️ ANTA Security Advisory Report 🛡️</h1>\n\n')
+        toc = "**Table of Contents:**\n\n"
         if self.groups:
-            toc += "  - [Advisory Exposure Summary](#advisory-exposure-summary)\n  - [Security Advisory Details](#security-advisory-details)\n"
-        toc += "  - [Security Advisory Run Overview](#security-advisory-run-overview)"
+            toc += "- [Advisory Assessment Summary](#advisory-assessment-summary)\n- [Security Advisory Details](#security-advisory-details)\n"
+            for group in self.groups:
+                advisory = group.advisory
+                toc += f"  - [SA{advisory.sa_number}: {self.safe_markdown(advisory.title)}](#sa-{advisory.sa_number.lower()})\n"
+        toc += "- [Run Overview](#run-overview)"
         self.mdfile.write(toc + "\n\n")
 
 
-class AdvisoryExposureSummary(SecurityAdvisoryMDReportBase):
+class AdvisoryAssessmentSummary(SecurityAdvisoryMDReportBase):
     """Generate a compact status summary grouped by security advisory."""
 
     ICON = "📊"
@@ -107,8 +131,7 @@ class AdvisoryExposureSummary(SecurityAdvisoryMDReportBase):
         for group in self.groups:
             advisory = group.advisory
             advisory_link = f"[SA{advisory.sa_number}: {self.safe_markdown(advisory.title)}](#sa-{advisory.sa_number.lower()})"
-            advisory_severity = group.severity
-            severity = f"{SEVERITY_ICONS[advisory_severity]}&nbsp;{advisory_severity.value.title()}"
+            severity = self.format_severity(group.severity)
             devices = len({result.name for result in group.results})
             yield (
                 f"| {advisory_link} | {severity} | {devices} "
@@ -121,7 +144,7 @@ class AdvisoryExposureSummary(SecurityAdvisoryMDReportBase):
             )
 
     def generate_section(self) -> None:
-        """Generate the advisory exposure summary section."""
+        """Generate the advisory assessment summary section."""
         self.write_heading(heading_level=2)
         self.write_table(table_heading=self.TABLE_HEADING)
 
@@ -133,29 +156,34 @@ class SecurityAdvisoryDetails(SecurityAdvisoryMDReportBase):
 
     def _write_vulnerabilities(self, advisory: _AdvisoryMetadata) -> None:
         """Write vulnerability details for an advisory."""
-        self.mdfile.write("#### Vulnerabilities\n\n")
-        heading = self.generate_table_heading(["Vulnerability", "Description", "Severity"])
-        self.mdfile.write("\n".join(heading) + "\n")
-        for vulnerability in advisory.vulnerabilities:
+        # NOTE: Nested tables are not supported consistently by every Markdown renderer. Prefix every table line and pad it with quoted blank lines to maximize
+        # compatibility across renderers that support Markdown tables.
+        heading = self.generate_table_heading(["Vulnerability", "Severity", "Description"])
+        self.mdfile.write("\n".join(f"> {line}" for line in heading) + "\n")
+        vulnerabilities = sorted(
+            advisory.vulnerabilities,
+            key=lambda vulnerability: (-_ADVISORY_VULNERABILITY_SEVERITY_RANK[vulnerability.severity], vulnerability.id.casefold()),
+        )
+        for vulnerability in vulnerabilities:
             vulnerability_id = self.safe_markdown(vulnerability.id)
             description = self.safe_markdown(vulnerability.description)
-            self.mdfile.write(f"| {vulnerability_id} | {description} | {vulnerability.severity.value.title()} |\n")
-        self.mdfile.write("\n")
+            self.mdfile.write(f"> | {vulnerability_id} | {self.format_severity(vulnerability.severity)} | {description} |\n")
+        self.mdfile.write(">\n\n")
 
     def _write_findings(self, group: AdvisoryResultGroup) -> None:
         """Write per-device findings for an advisory."""
         # TODO: When revisiting Markdown reports, fall back to atomic descriptions and messages if the parent result has no messages.
-        # TODO: Render parent and atomic remediation lists once the Markdown remediation presentation is defined.
         self.mdfile.write("#### 🔎 Device Findings\n\n")
         if self.config.expand_results:
             self._write_expanded_findings(group)
             return
 
-        heading = self.generate_table_heading(["Device", "Test", "Result", "Messages"])
+        heading = self.generate_table_heading(["Device", "Result", "Findings", "Remediations"])
         self.mdfile.write("\n".join(heading) + "\n")
         for result in group.results:
-            messages = self.safe_markdown("<br>".join(result.messages)) or "-"
-            self.mdfile.write(f"| {self.safe_markdown(result.name)} | {self.safe_markdown(result.test)} | {self.format_advisory_result(result)} | {messages} |\n")
+            findings = self.safe_markdown("<br>".join(result.messages)) or "-"
+            remediation = self.format_remediations(result)
+            self.mdfile.write(f"| {self.safe_markdown(result.name)} | {self.format_advisory_result(result)} | {findings} | {remediation} |\n")
 
     @staticmethod
     def _atomic_summary(result: TestResult) -> str:
@@ -175,29 +203,39 @@ class SecurityAdvisoryDetails(SecurityAdvisoryMDReportBase):
 
     def _write_expanded_findings(self, group: AdvisoryResultGroup) -> None:
         """Write parent advisory results followed by their actual detailed issue results."""
-        heading = self.generate_table_heading(["Device", "Test", "Description", "Vulnerability ID(s)", "Result", "Messages"])
+        heading = self.generate_table_heading(["Device", "Description", "Vulnerability ID(s)", "Result", "Findings", "Remediations"])
         self.mdfile.write("\n".join(heading) + "\n")
+        vulnerability_by_id = {vulnerability.id: vulnerability for vulnerability in group.advisory.vulnerabilities}
         for result in group.results:
             has_details = bool(result.atomic_results)
             if has_details:
-                messages = f"**Detailed findings:** {self._atomic_summary(result)}"
+                findings = f"**Detailed findings:** {self._atomic_summary(result)}"
                 if result.messages:
-                    messages += f"<br>**Overall evidence:** {self.safe_markdown('<br>'.join(result.messages))}"
+                    findings += f"<br>**Overall evidence:** {self.safe_markdown('<br>'.join(result.messages))}"
             else:
-                messages = self.safe_markdown("<br>".join(result.messages)) or "-"
+                findings = self.safe_markdown("<br>".join(result.messages)) or "-"
             description = self.safe_markdown(result.description) or "-"
-            self.mdfile.write(
-                f"| {self.safe_markdown(result.name)} | {self.safe_markdown(result.test)} | {description} | - "
-                f"| {self.format_advisory_result(result)} | {messages} |\n"
-            )
+            remediation = self.format_remediations(result)
+            self.mdfile.write(f"| {self.safe_markdown(result.name)} | {description} | - | {self.format_advisory_result(result)} | {findings} | {remediation} |\n")
             for index, atomic in enumerate(result.atomic_results):
                 tree = "└──" if index == len(result.atomic_results) - 1 else "├──"
-                atomic_description = self.safe_markdown(atomic.description) or "-"
-                description = f"&nbsp;&nbsp;{tree}&nbsp;{atomic_description}"
                 vulnerability_ids = _get_atomic_vulnerability_ids(atomic)
-                vulnerabilities = self.safe_markdown(", ".join(vulnerability_ids)) if vulnerability_ids else "-"
-                atomic_messages = self.safe_markdown("<br>".join(atomic.messages)) or "-"
-                self.mdfile.write(f"| | | {description} | {vulnerabilities} | {self.format_advisory_result(atomic)} | {atomic_messages} |\n")
+                if vulnerability_ids:
+                    atomic_description = "<br>".join(self.safe_markdown(vulnerability_by_id[vulnerability_id].description) for vulnerability_id in vulnerability_ids)
+                else:
+                    atomic_description = self.safe_markdown(atomic.description) or "-"
+                description = f"&nbsp;&nbsp;{tree}&nbsp;{atomic_description}"
+                vulnerabilities = (
+                    "<br>".join(
+                        f"{SEVERITY_ICONS[vulnerability_by_id[vulnerability_id].severity]}&nbsp;{self.safe_markdown(vulnerability_id)}"
+                        for vulnerability_id in vulnerability_ids
+                    )
+                    if vulnerability_ids
+                    else "-"
+                )
+                atomic_findings = self.safe_markdown("<br>".join(atomic.messages)) or "-"
+                remediation = self.format_remediations(atomic)
+                self.mdfile.write(f"| | {description} | {vulnerabilities} | {self.format_advisory_result(atomic)} | {atomic_findings} | {remediation} |\n")
 
     def generate_section(self) -> None:
         """Generate detailed advisory metadata and findings."""
@@ -206,10 +244,11 @@ class SecurityAdvisoryDetails(SecurityAdvisoryMDReportBase):
             advisory = group.advisory
             anchor = f"sa-{advisory.sa_number.lower()}"
             title = self.safe_markdown(advisory.title)
-            self.mdfile.write(f'### [SA{advisory.sa_number}: {title}]({advisory.url}) <a id="{anchor}"></a>\n\n')
+            self.mdfile.write(f'### SA{advisory.sa_number}: {title} <a id="{anchor}"></a>\n\n')
             advisory_severity = group.severity
-            severity = f"{SEVERITY_ICONS[advisory_severity]} **Severity:** {advisory_severity.value.title()}"
-            self.mdfile.write(f"{severity}\n\n{self.safe_markdown(advisory.description)}\n\n")
+            severity = f"**Severity:** {SEVERITY_ICONS[advisory_severity]} {advisory_severity.value.title()}"
+            description = self.safe_markdown(advisory.description)
+            self.mdfile.write(f"> {severity}\\\n> **URL:** <{advisory.url}>\n>\n> {description}\n>\n")
             self._write_vulnerabilities(advisory)
             self._write_findings(group)
             if index < len(self.groups) - 1:
@@ -217,14 +256,11 @@ class SecurityAdvisoryDetails(SecurityAdvisoryMDReportBase):
         self.mdfile.write("\n")
 
 
-class SecurityAdvisoryRunOverview(SecurityAdvisoryMDReportBase):
+class RunOverview(SecurityAdvisoryMDReportBase):
     """Generate the Run Overview section for a security advisory report."""
 
     ICON = "📋"
 
-    _TABLE_COLUMNS: ClassVar[list[str]] = ["⚙️ Run Metric", "📝 Details"]
-    TABLE_HEADING: ClassVar[list[str]] = MDReportBase.generate_table_heading(columns=_TABLE_COLUMNS)
-
     def _format_row_value(self, value: object) -> str:
         """Format one run overview value for Markdown table rendering."""
         if isinstance(value, list | tuple):
@@ -241,14 +277,25 @@ class SecurityAdvisoryRunOverview(SecurityAdvisoryMDReportBase):
             return "<br>".join(items)
         return self.safe_markdown(self.format_value(value))
 
-    def generate_rows(self) -> Generator[str, None, None]:
-        """Generate the rows for the security advisory run overview table."""
-        run_overview = SecurityAdvisoryRunOverviewData.from_context(self.run_context)
-        for label, value in run_overview.iter_rows():
-            row_value = self._format_row_value(value)
-            yield f"| **{label}** | {row_value} |\n"
-
     def generate_section(self) -> None:
-        """Generate the security advisory run overview section."""
+        """Generate the Run Overview section."""
         self.write_heading(heading_level=2)
-        self.write_table(table_heading=self.TABLE_HEADING, last_table=True)
+        run_overview = SecurityAdvisoryRunOverviewData.from_context(self.run_context)
+        start_time = self._format_row_value(run_overview.test_execution_start_time)
+        end_time = self._format_row_value(run_overview.test_execution_end_time)
+        duration = self._format_row_value(run_overview.total_duration)
+        overview_metrics: list[tuple[str, object]] = [
+            ("ANTA Version", run_overview.anta_version),
+            ("Duration", f"{duration} ({start_time} → {end_time})"),
+            ("Security Advisories Tested", run_overview.security_advisories_assessed),
+            ("Total Devices In Inventory", run_overview.total_devices_in_inventory),
+            ("Devices Assessed", run_overview.devices_assessed),
+            ("Devices Unreachable At Setup", run_overview.devices_unreachable_at_setup),
+            ("Devices Filtered At Setup", run_overview.devices_filtered_at_setup),
+            ("Filters Applied", run_overview.filters_applied),
+        ]
+        if run_overview.warnings_at_setup:
+            overview_metrics.append(("Warnings At Setup", run_overview.warnings_at_setup))
+        self.mdfile.write("| | |\n| :- | :- |\n")
+        for label, value in overview_metrics:
+            self.mdfile.write(f"| **{label}** | {self._format_row_value(value)} |\n")

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/anta/_advisory/reporter/reporting.py

@@ -220,19 +220,19 @@ def generate_security_advisory_md_report(
     validate_advisory_results(run_context.manager.results)
 
     from anta._advisory.reporter.md_reporter import (  # noqa: PLC0415
-        AdvisoryExposureSummary,
+        AdvisoryAssessmentSummary,
         ANTASecurityAdvisoryReport,
+        RunOverview,
         SecurityAdvisoryDetails,
-        SecurityAdvisoryRunOverview,
     )
 
     try:
         with md_filename.open("w", encoding="utf-8") as mdfile:
             ANTASecurityAdvisoryReport(mdfile, report, config, run_context).generate_section()
             if report.groups:
-                AdvisoryExposureSummary(mdfile, report, config, run_context).generate_section()
+                AdvisoryAssessmentSummary(mdfile, report, config, run_context).generate_section()
                 SecurityAdvisoryDetails(mdfile, report, config, run_context).generate_section()
-            SecurityAdvisoryRunOverview(mdfile, report, config, run_context).generate_section()
+            RunOverview(mdfile, report, config, run_context).generate_section()
     except OSError as exc:
         message = f"OSError caught while writing the Markdown file '{md_filename.resolve()}'."
         anta_log_exception(exc, message, logger)

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/anta/constants.py

@@ -86,6 +86,7 @@ UNSUPPORTED_PLATFORM_ERRORS = [
     "Invalid input (at token 1: 'supervisor-peer:/mnt/flash')",
     "Incomplete command (at token 1: 'module')",
     "Incomplete command (at token 1: 'ptp')",
+    "Invalid input (at token 1: 'directflow')",
 ]
 """Error messages indicating platform or hardware unsupported commands. Includes both general hardware
 platform errors and specific ASIC family limitations.

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/anta/tests/advisories/sa_117.py

@@ -75,16 +75,32 @@ ADVISORY = _AdvisoryMetadata(
 )
 
 
-def _evaluate_gnmi_transport_enabled(gnmi_output: Mapping[str, object]) -> bool | None:
-    """Return whether at least one gNMI transport is enabled."""
+def _gnmi_transport_values(gnmi_output: Mapping[str, object]) -> tuple[object, ...] | None:
+    """Return transport values from nested or flattened EOS gNMI output.
+
+    EOS 4.33 eAPI revision 1 exposes a single transport at the top level, while
+    newer schemas expose named transports below ``transports``.
+    """
+    if "transports" not in gnmi_output:
+        enabled = gnmi_output.get("enabled")
+        if not isinstance(enabled, bool):
+            return None
+        return (gnmi_output,) if enabled else ()
+
     transports = gnmi_output.get("transports")
     if not isinstance(transports, Mapping):
         return None
-    if not transports:
-        return False
+    return tuple(transports.values())
+
+
+def _evaluate_gnmi_transport_enabled(gnmi_output: Mapping[str, object]) -> bool | None:
+    """Return whether at least one gNMI transport is enabled."""
+    transports = _gnmi_transport_values(gnmi_output)
+    if transports is None:
+        return None
 
     unknown = False
-    for transport in transports.values():
+    for transport in transports:
         if not isinstance(transport, Mapping):
             unknown = True
             continue
@@ -99,12 +115,12 @@ def _evaluate_gnmi_transport_enabled(gnmi_output: Mapping[str, object]) -> bool
 
 def _evaluate_gnmi_accounting_enabled(gnmi_output: Mapping[str, object]) -> bool | None:
     """Return whether an enabled gNMI transport has accounting enabled."""
-    transports = gnmi_output.get("transports")
-    if not isinstance(transports, Mapping):
+    transports = _gnmi_transport_values(gnmi_output)
+    if transports is None:
         return None
 
     unknown = False
-    for transport in transports.values():
+    for transport in transports:
         if not isinstance(transport, Mapping):
             unknown = True
             continue

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/anta/tests/advisories/sa_146.py

@@ -474,7 +474,7 @@ class VerifySA146(OptionalCommandsMixin, _AntaAdvisoryTest):
         AntaCommand(command="show version detail", revision=1),
         OptionalAntaCommand(command="show management api gnmi", revision=1),
         OptionalAntaCommand(command="show management api gribi", revision=1),
-        OptionalAntaCommand(command="show daemon TerminAttr", revision=1),
+        OptionalAntaCommand(command="show daemon", revision=1),
         OptionalAntaCommand(command="show running-config section grpcaddr", ofmt="text"),
         OptionalAntaCommand(command="show management security ssl profile", revision=1),
     ]

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/anta/tests/stp.py

@@ -316,7 +316,10 @@ class VerifyStpTopologyChanges(AntaTest):
         # Verifies the number of changes across all interfaces
         for topology, topology_details in stp_topologies.items():
             for interface, details in topology_details.get("interfaces", {}).items():
-                if (num_of_changes := details.get("numChanges")) > self.inputs.threshold:
+                num_of_changes = details.get("numChanges")
+                if num_of_changes is None:
+                    self.result.is_failure(f"Topology: {topology} Interface: {interface} - Number of changes counter not found")
+                elif num_of_changes > self.inputs.threshold:
                     self.result.is_failure(
                         f"Topology: {topology} Interface: {interface} - Number of changes not within the threshold - Expected: "
                         f"{self.inputs.threshold} Actual: {num_of_changes}"

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/anta.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anta
-Version: 1.10.0.dev1
+Version: 1.10.0.dev2
 Summary: Arista Network Test Automation (ANTA) Framework
 Author-email: Arista Networks ANTA maintainers <anta-dev@arista.com>
 Maintainer-email: Arista Networks ANTA maintainers <anta-dev@arista.com>, Khelil Sator <ksator@arista.com>, Matthieu Tâche <mtache@arista.com>, Thomas Grimonet <tgrimonet@arista.com>, Guillaume Mulocher <gmulocher@arista.com>, Carl Baillargeon <carl.baillargeon@arista.com>

{anta-1.10.0.dev1 → anta-1.10.0.dev2}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "anta"
-version = "v1.10.0.dev1"
+version = "v1.10.0.dev2"
 readme = "README.md"
 authors = [{ name = "Arista Networks ANTA maintainers", email = "anta-dev@arista.com" }]
 maintainers = [
@@ -94,7 +94,7 @@ doc = [
   "griffe >=2.2.0,<2.3",
   "griffe-warnings-deprecated~=1.1.1",
   "mike @ git+https://github.com/squidfunk/mike.git@2d4ad799442f4592db8ad53b179bfb33db8c69ac",
-  "zensical==0.0.56",
+  "zensical==0.0.57",
   "mkdocs~=1.6",
   "mkdocs-autorefs~=1.4",
   "mkdocs-material~=9.7",
@@ -121,7 +121,7 @@ namespaces = false
 # Version
 ################################
 [tool.bumpver]
-current_version = "1.10.0.dev1"
+current_version = "1.10.0.dev2"
 version_pattern = "MAJOR.MINOR.PATCH[.PYTAGNUM]"
 commit_message  = "bump: Version {old_version} -> {new_version}"
 commit = true