Refactor(pyavd): Rename ANTA-related classes and modules to follow codebase conventions (#6498)

Co-authored-by: Guillaume Mulocher <gmulocher@arista.com>

Author: carl-baillargeon

ansible_collections/arista/avd/plugins/action/anta_workflow.py

@@ -29,7 +29,7 @@
 try:
     from pyavd._anta.lib import AntaCatalog, AntaInventory, AsyncEOSDevice, MDReportGenerator, ReportCsv, ResultManager, TestResult, anta_runner
     from pyavd._utils import default, get, strip_empties_from_dict
-    from pyavd.api._anta import AvdCatalogGenerationSettings, AvdFabricData
+    from pyavd.api.anta import AVDCatalogGenerationSettings, AVDFabricData
     from pyavd.get_device_test_catalog import get_device_test_catalog
 
     HAS_PYAVD = True
@@ -137,7 +137,7 @@
 # Global variables to share data between processes. Since the plugin is forked, these variables are inherited by child processes.
 # TODO: Consider aggregating some of them into a SHARED_VARS dict or use multiprocessing.Manager()
 STRUCTURED_CONFIGS: dict[str, dict[str, Any]] | None = None
-FABRIC_DATA: AvdFabricData | None = None
+FABRIC_DATA: AVDFabricData | None = None
 PLUGIN_ARGS: dict[str, Any] | None = None
 ANSIBLE_VARS: dict[str, dict[str, Any]] | None = None
 USER_CATALOG: AntaCatalog | None = None
@@ -216,7 +216,7 @@ def run(self, tmp: Any = None, task_vars: dict | None = None) -> dict:
             # Load the structured configs and build the minimal structured configs if needed
             if generate_avd_catalogs:
                 STRUCTURED_CONFIGS = load_structured_configs(deployed_devices, structured_config_dir, get(PLUGIN_ARGS, "avd_catalogs.structured_config_suffix"))
-                FABRIC_DATA = AvdFabricData.from_structured_configs(STRUCTURED_CONFIGS)
+                FABRIC_DATA = AVDFabricData.from_structured_configs(STRUCTURED_CONFIGS)
 
             with ProcessPoolExecutor(max_workers=max((ansible_forks - 1), 1), mp_context=get_context("fork")) as executor:
                 batch_size = get(PLUGIN_ARGS, "runner.batch_size")
@@ -470,7 +470,7 @@ def build_anta_runner_objects(devices: list[str]) -> tuple[ResultManager, AntaIn
         inventory.add_device(anta_device)
         # We generate the device's AVD catalog only if structured configs are loaded
         if STRUCTURED_CONFIGS is not None and FABRIC_DATA is not None:
-            settings = AvdCatalogGenerationSettings(
+            settings = AVDCatalogGenerationSettings(
                 extra_fabric_validation=extra_fabric_validation,
                 output_dir=output_dir,
                 **get_device_catalog_filters(device, avd_catalogs_filters),

docs/porting-guides/6.x.x.md

@@ -1805,34 +1805,51 @@ See the PyAVD [migration example](#example-of-migration-from-pyavd-5x-to-600-for
 
 In AVD 6.0.0, `pyavd.get_device_test_catalog` has undergone a few changes to improve maintainability.
 
+#### `AvdCatalogGenerationSettings` renamed to `AVDCatalogGenerationSettings` and is now a Dataclass
+
+`AvdCatalogGenerationSettings` has been renamed to `AVDCatalogGenerationSettings` and converted from a Pydantic model to a standard Python `dataclass`.
+
+**Action Required:** If your code relies on Pydantic-specific methods (like validation error handling or serialization), updates are required.
+
+```diff
++ from dataclasses import asdict
+- from pyavd.api.anta import AvdCatalogGenerationSettings
++ from pyavd.api.anta import AVDCatalogGenerationSettings
+
+  settings = AVDCatalogGenerationSettings(run_tests=["VerifyReachability"])
+
+- serialized_settings = settings.model_dump()
++ serialized_settings = asdict(settings)
+```
+
 #### Updated Function Signature
 
-The function now accepts an `AvdFabricData` dataclass instance instead of a dictionary for the `minimal_structured_configs` argument. The argument name has changed to `fabric_data` for clarity.
+The function now accepts an `AVDFabricData` dataclass instance instead of a dictionary for the `minimal_structured_configs` argument. The argument name has changed to `fabric_data` for clarity.
 
 ```diff
   def get_device_test_catalog(
       hostname: str,
       structured_config: dict,
 -     minimal_structured_configs: dict[str, MinimalStructuredConfig],
-+     fabric_data: AvdFabricData,
-      settings: AvdCatalogGenerationSettings | None = None,
++     fabric_data: AVDFabricData,
+      settings: AVDCatalogGenerationSettings | None = None,
   ) -> AntaCatalog
 ```
 
-**Action Required:** Update your code to convert structured configurations into `AvdFabricData` before calling the function.
+**Action Required:** Update your code to convert structured configurations into `AVDFabricData` before calling the function.
 
 ```diff
   from pyavd import get_device_test_catalog
-- from pyavd.api._anta import get_minimal_structured_configs
-+ from pyavd.api._anta import AvdFabricData
+- from pyavd.api.anta import get_minimal_structured_configs
++ from pyavd.api.anta import AVDFabricData
 
   structured_configs = {
       "DC1-LEAF1A": {"hostname": "DC1-LEAF1A"},
       "DC1-LEAF1B": {"hostname": "DC1-LEAF1B"}
   }
 
 - minimal_structured_configs = get_minimal_structured_configs(structured_configs)
-+ fabric_data = AvdFabricData.from_structured_configs(structured_configs)
++ fabric_data = AVDFabricData.from_structured_configs(structured_configs)
 
 + anta_catalog = get_device_test_catalog(
 +     hostname="DC1-LEAF1A",
@@ -1844,7 +1861,7 @@ The function now accepts an `AvdFabricData` dataclass instance instead of a dict
 
 #### Removal of `ignored_is_deployed` Setting
 
-The `AvdCatalogGenerationSettings.ignored_is_deployed` attribute has been removed.
+The `AVDCatalogGenerationSettings.ignored_is_deployed` attribute has been removed.
 
 - **AVD 5.x:** The function checked `metadata.is_deployed` inside the structured config. If `False`, it returned an empty catalog *unless* `ignored_is_deployed` was set to `True`.
 - **AVD 6.0.0:** The function *always* generates a catalog, ignoring the `metadata.is_deployed` key.
@@ -1853,12 +1870,12 @@ The `AvdCatalogGenerationSettings.ignored_is_deployed` attribute has been remove
 
 ```diff
   from pyavd import get_device_test_catalog
-  from pyavd.api._anta import AvdFabricData
+  from pyavd.api.anta import AVDFabricData
 
   dc1_leaf1a_structured_config = {"hostname": "DC1-LEAF1A", "metadata": {"is_deployed": False}}
 
   structured_configs = {"DC1-LEAF1A": dc1_leaf1a_structured_config}
-  fabric_data = AvdFabricData.from_structured_configs(structured_configs)
+  fabric_data = AVDFabricData.from_structured_configs(structured_configs)
 
 - anta_catalog = get_device_test_catalog(hostname="DC1-LEAF1A", structured_config=dc1_leaf1a_structured_config, fabric_data=fabric_data)
 + is_deployed = dc1_leaf1a_structured_config.get("metadata", {}).get("is_deployed", True) is True
@@ -1868,14 +1885,14 @@ The `AvdCatalogGenerationSettings.ignored_is_deployed` attribute has been remove
 
 #### Removal of `input_factory_settings` Setting
 
-The `AvdCatalogGenerationSettings.input_factory_settings` attribute, previously used to globally enable BGP validation for VRF peers, has been removed. Control has moved to the device structured configuration.
+The `AVDCatalogGenerationSettings.input_factory_settings` attribute, previously used to globally enable BGP validation for VRF peers, has been removed. Control has moved to the device structured configuration.
 
 **Action Required:** Instead of passing `InputFactorySettings(allow_bgp_vrfs=True)`, you must now set `metadata.validate_state` to `True` on specific BGP neighbors or neighbor interfaces (RFC5549) within the structured configuration.
 
 ```diff
   from pyavd import get_device_test_catalog
-- from pyavd.api._anta import AvdCatalogGenerationSettings, AvdFabricData, InputFactorySettings
-+ from pyavd.api._anta import AvdCatalogGenerationSettings, AvdFabricData
+- from pyavd.api.anta import AVDCatalogGenerationSettings, AVDFabricData, InputFactorySettings
++ from pyavd.api.anta import AVDCatalogGenerationSettings, AVDFabricData
 
   # Update structured config to enable validation per neighbor/VRF
 - dc1_leaf1a_structured_config = {"hostname": "DC1-LEAF1A"}
@@ -1893,10 +1910,10 @@ The `AvdCatalogGenerationSettings.input_factory_settings` attribute, previously
 + }
 
   structured_configs = {"DC1-LEAF1A": dc1_leaf1a_structured_config}
-  fabric_data = AvdFabricData.from_structured_configs(structured_configs)
+  fabric_data = AVDFabricData.from_structured_configs(structured_configs)
 
 - input_factory_settings = InputFactorySettings(allow_bgp_vrfs=True)
-- settings = AvdCatalogGenerationSettings(input_factory_settings=input_factory_settings)
+- settings = AVDCatalogGenerationSettings(input_factory_settings=input_factory_settings)
 
   anta_catalog = get_device_test_catalog(
       hostname="DC1-LEAF1A",
@@ -1908,9 +1925,9 @@ The `AvdCatalogGenerationSettings.input_factory_settings` attribute, previously
 
 #### Changes to `custom_test_specs` Setting
 
-For users generating catalogs with custom test specifications, the `AvdCatalogGenerationSettings.custom_test_specs` attribute now expects a tuple of `AvdTestSpec` dataclass instances.
+For users generating catalogs with custom test specifications, the `AVDCatalogGenerationSettings.custom_test_specs` attribute now expects a tuple of `AVDTestSpec` dataclass instances.
 
-Additionally, the `conditional_keys` attribute has been removed from `AvdTestSpec`. Logic for skipping tests based on missing configuration must now be handled within the test factory implementation itself, using the `skip_if_missing_config` decorator.
+Additionally, the `conditional_keys` attribute has been removed from `AVDTestSpec`. Logic for skipping tests based on missing configuration must now be handled within the test factory implementation itself, using the `skip_if_missing_config` decorator.
 
 **Action Required:** Update your custom test specs to use the new dataclass and move conditional logic to the factory.
 
@@ -1919,9 +1936,9 @@ Additionally, the `conditional_keys` attribute has been removed from `AvdTestSpe
   from anta.tests.connectivity import VerifyReachability
 
 + from pyavd._anta.constants import StructuredConfigKey
-+ from pyavd._anta.input_factories._decorators import skip_if_missing_config
-- from pyavd.api._anta import AvdCatalogGenerationSettings, TestSpec
-+ from pyavd.api._anta import AvdCatalogGenerationSettings, AvdTestSpec
++ from pyavd._anta.input_factories.decorators import skip_if_missing_config
+- from pyavd.api.anta import AVDCatalogGenerationSettings, TestSpec
++ from pyavd.api.anta import AVDCatalogGenerationSettings, AVDTestSpec
 
   class CustomVerifyReachabilityInputFactory(AntaTestInputFactory[VerifyReachability.Input]):
       """Custom input factory class for the `VerifyReachability` test."""
@@ -1931,29 +1948,13 @@ Additionally, the `conditional_keys` attribute has been removed from `AvdTestSpe
           # Custom logic to generate the inputs
           ...
 
-+ test_spec = AvdTestSpec(
++ test_spec = AVDTestSpec(
 +     test_class=VerifyReachability,
 -     conditional_keys=[StructuredConfigKey.ETHERNET_INTERFACES],
 +     input_factory=CustomVerifyReachabilityInputFactory
 + )
 
-  settings = AvdCatalogGenerationSettings(custom_test_specs=(test_spec,))
-```
-
-#### `AvdCatalogGenerationSettings` is now a Dataclass
-
-`AvdCatalogGenerationSettings` has been converted from a Pydantic model to a standard Python `dataclass`.
-
-**Action Required:** If your code relies on Pydantic-specific methods (like validation error handling or serialization), updates are required.
-
-```diff
-+ from dataclasses import asdict
-  from pyavd.api._anta import AvdCatalogGenerationSettings
-
-  settings = AvdCatalogGenerationSettings(run_tests=["VerifyReachability"])
-
-- serialized_settings = settings.model_dump()
-+ serialized_settings = asdict(settings)
+  settings = AVDCatalogGenerationSettings(custom_test_specs=(test_spec,))
 ```
 
 ### Example of migration from PyAVD 5.x to 6.0.0 for a small build script

python-avd/pyavd/_anta/factories.py

@@ -14,12 +14,12 @@
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
-    from pyavd.api._anta import AvdTestSpec
+    from pyavd.api.anta import AVDTestSpec
 
     from .models import InputFactoryDataSource
 
 
-def create_catalog(data_source: InputFactoryDataSource, test_specs: list[AvdTestSpec]) -> AntaCatalog:
+def create_catalog(data_source: InputFactoryDataSource, test_specs: list[AVDTestSpec]) -> AntaCatalog:
     """Create an ANTA catalog for a device from the provided test specs."""
     all_test_defs_iterator = chain.from_iterable(create_test_definitions(test_spec, data_source) for test_spec in test_specs)
 
@@ -31,8 +31,8 @@ def create_catalog(data_source: InputFactoryDataSource, test_specs: list[AvdTest
     return AntaCatalog(tests=tests)
 
 
-def create_test_definitions(test_spec: AvdTestSpec, data_source: InputFactoryDataSource) -> Iterator[AntaTestDefinition]:
-    """Generate the AntaTestDefinition from this AvdTestSpec instance."""
+def create_test_definitions(test_spec: AVDTestSpec, data_source: InputFactoryDataSource) -> Iterator[AntaTestDefinition]:
+    """Generate the AntaTestDefinition from this AVDTestSpec instance."""
     # Generate the test definitions from the input factory if provided
     if test_spec.input_factory is not None:
         factory = test_spec.input_factory(data_source, test_spec.test_class.name)

python-avd/pyavd/_anta/index.py

@@ -7,50 +7,50 @@
 
 from pyavd._anta.input_factories import *
 from pyavd._anta.lib.tests import *
-from pyavd.api._anta.avd_test_spec import AvdTestSpec
+from pyavd.api.anta.avd_test_spec import AVDTestSpec
 
-AVD_TEST_INDEX: list[AvdTestSpec] = [
-    AvdTestSpec(test_class=VerifyAgentLogs),
-    AvdTestSpec(test_class=VerifyAPIHttpsSSL, input_factory=VerifyAPIHttpsSSLInputFactory),
-    AvdTestSpec(test_class=VerifyAVTSpecificPath, input_factory=VerifyAVTSpecificPathInputFactory),
-    AvdTestSpec(test_class=VerifyBGPPeerSession, input_factory=VerifyBGPPeerSessionInputFactory),
-    AvdTestSpec(test_class=VerifyCoredump),
-    AvdTestSpec(test_class=VerifyEnvironmentCooling, input_factory=VerifyEnvironmentCoolingInputFactory),
-    AvdTestSpec(test_class=VerifyEnvironmentPower, input_factory=VerifyEnvironmentPowerInputFactory),
-    AvdTestSpec(test_class=VerifyEnvironmentSystemCooling, input_factory=VerifyEnvironmentSystemCoolingInputFactory),
-    AvdTestSpec(test_class=VerifyFileSystemUtilization),
-    AvdTestSpec(test_class=VerifyIllegalLACP, input_factory=VerifyIllegalLACPInputFactory),
-    AvdTestSpec(test_class=VerifyInterfaceDiscards),
-    AvdTestSpec(test_class=VerifyInterfaceErrDisabled),
-    AvdTestSpec(test_class=VerifyInterfaceErrors),
-    AvdTestSpec(test_class=VerifyInterfaceUtilization),
-    AvdTestSpec(test_class=VerifyInterfacesStatus, input_factory=VerifyInterfacesStatusInputFactory),
-    AvdTestSpec(test_class=VerifyInventory, input_factory=VerifyInventoryInputFactory),
-    AvdTestSpec(test_class=VerifyPortChannels, input_factory=VerifyPortChannelsInputFactory),
-    AvdTestSpec(test_class=VerifyRunningConfigDiffs),
-    AvdTestSpec(test_class=VerifyStormControlDrops, input_factory=VerifyStormControlDropsInputFactory),
-    AvdTestSpec(test_class=VerifyLLDPNeighbors, input_factory=VerifyLLDPNeighborsInputFactory),
-    AvdTestSpec(test_class=VerifyLoggingErrors, input_factory=VerifyLoggingErrorsInputFactory),
-    AvdTestSpec(test_class=VerifyMaintenance),
-    AvdTestSpec(test_class=VerifyMemoryUtilization),
-    AvdTestSpec(test_class=VerifyMlagConfigSanity, input_factory=VerifyMlagConfigSanityInputFactory),
-    AvdTestSpec(test_class=VerifyMlagInterfaces, input_factory=VerifyMlagInterfacesInputFactory),
-    AvdTestSpec(test_class=VerifyMlagStatus, input_factory=VerifyMlagStatusInputFactory),
-    AvdTestSpec(test_class=VerifyNTP),
-    AvdTestSpec(test_class=VerifyOSPFNeighborState, input_factory=VerifyOSPFNeighborStateInputFactory),
-    AvdTestSpec(test_class=VerifyOSPFMaxLSA, input_factory=VerifyOSPFMaxLSAInputFactory),
-    AvdTestSpec(test_class=VerifySpecificPath, input_factory=VerifySpecificPathInputFactory),
-    AvdTestSpec(test_class=VerifyReachability, input_factory=VerifyReachabilityInputFactory),
-    AvdTestSpec(test_class=VerifyReloadCause, input_factory=VerifyReloadCauseInputFactory),
-    AvdTestSpec(test_class=VerifyRoutingProtocolModel, input_factory=VerifyRoutingProtocolModelInputFactory),
-    AvdTestSpec(test_class=VerifyRoutingTableEntry, input_factory=VerifyRoutingTableEntryInputFactory),
-    AvdTestSpec(test_class=VerifySpecificIPSecConn, input_factory=VerifySpecificIPSecConnInputFactory),
-    AvdTestSpec(test_class=VerifySTPCounters),
-    AvdTestSpec(test_class=VerifyTemperature, input_factory=VerifyTemperatureInputFactory),
-    AvdTestSpec(test_class=VerifyTransceiversManufacturers, input_factory=VerifyTransceiversManufacturersInputFactory),
-    AvdTestSpec(test_class=VerifyTransceiversTemperature, input_factory=VerifyTransceiversTemperatureInputFactory),
-    AvdTestSpec(test_class=VerifyVxlanConfigSanity, input_factory=VerifyVxlanConfigSanityInputFactory),
-    AvdTestSpec(test_class=VerifyZeroTouch),
+AVD_TEST_INDEX: list[AVDTestSpec] = [
+    AVDTestSpec(test_class=VerifyAgentLogs),
+    AVDTestSpec(test_class=VerifyAPIHttpsSSL, input_factory=VerifyAPIHttpsSSLInputFactory),
+    AVDTestSpec(test_class=VerifyAVTSpecificPath, input_factory=VerifyAVTSpecificPathInputFactory),
+    AVDTestSpec(test_class=VerifyBGPPeerSession, input_factory=VerifyBGPPeerSessionInputFactory),
+    AVDTestSpec(test_class=VerifyCoredump),
+    AVDTestSpec(test_class=VerifyEnvironmentCooling, input_factory=VerifyEnvironmentCoolingInputFactory),
+    AVDTestSpec(test_class=VerifyEnvironmentPower, input_factory=VerifyEnvironmentPowerInputFactory),
+    AVDTestSpec(test_class=VerifyEnvironmentSystemCooling, input_factory=VerifyEnvironmentSystemCoolingInputFactory),
+    AVDTestSpec(test_class=VerifyFileSystemUtilization),
+    AVDTestSpec(test_class=VerifyIllegalLACP, input_factory=VerifyIllegalLACPInputFactory),
+    AVDTestSpec(test_class=VerifyInterfaceDiscards),
+    AVDTestSpec(test_class=VerifyInterfaceErrDisabled),
+    AVDTestSpec(test_class=VerifyInterfaceErrors),
+    AVDTestSpec(test_class=VerifyInterfaceUtilization),
+    AVDTestSpec(test_class=VerifyInterfacesStatus, input_factory=VerifyInterfacesStatusInputFactory),
+    AVDTestSpec(test_class=VerifyInventory, input_factory=VerifyInventoryInputFactory),
+    AVDTestSpec(test_class=VerifyPortChannels, input_factory=VerifyPortChannelsInputFactory),
+    AVDTestSpec(test_class=VerifyRunningConfigDiffs),
+    AVDTestSpec(test_class=VerifyStormControlDrops, input_factory=VerifyStormControlDropsInputFactory),
+    AVDTestSpec(test_class=VerifyLLDPNeighbors, input_factory=VerifyLLDPNeighborsInputFactory),
+    AVDTestSpec(test_class=VerifyLoggingErrors, input_factory=VerifyLoggingErrorsInputFactory),
+    AVDTestSpec(test_class=VerifyMaintenance),
+    AVDTestSpec(test_class=VerifyMemoryUtilization),
+    AVDTestSpec(test_class=VerifyMlagConfigSanity, input_factory=VerifyMlagConfigSanityInputFactory),
+    AVDTestSpec(test_class=VerifyMlagInterfaces, input_factory=VerifyMlagInterfacesInputFactory),
+    AVDTestSpec(test_class=VerifyMlagStatus, input_factory=VerifyMlagStatusInputFactory),
+    AVDTestSpec(test_class=VerifyNTP),
+    AVDTestSpec(test_class=VerifyOSPFNeighborState, input_factory=VerifyOSPFNeighborStateInputFactory),
+    AVDTestSpec(test_class=VerifyOSPFMaxLSA, input_factory=VerifyOSPFMaxLSAInputFactory),
+    AVDTestSpec(test_class=VerifySpecificPath, input_factory=VerifySpecificPathInputFactory),
+    AVDTestSpec(test_class=VerifyReachability, input_factory=VerifyReachabilityInputFactory),
+    AVDTestSpec(test_class=VerifyReloadCause, input_factory=VerifyReloadCauseInputFactory),
+    AVDTestSpec(test_class=VerifyRoutingProtocolModel, input_factory=VerifyRoutingProtocolModelInputFactory),
+    AVDTestSpec(test_class=VerifyRoutingTableEntry, input_factory=VerifyRoutingTableEntryInputFactory),
+    AVDTestSpec(test_class=VerifySpecificIPSecConn, input_factory=VerifySpecificIPSecConnInputFactory),
+    AVDTestSpec(test_class=VerifySTPCounters),
+    AVDTestSpec(test_class=VerifyTemperature, input_factory=VerifyTemperatureInputFactory),
+    AVDTestSpec(test_class=VerifyTransceiversManufacturers, input_factory=VerifyTransceiversManufacturersInputFactory),
+    AVDTestSpec(test_class=VerifyTransceiversTemperature, input_factory=VerifyTransceiversTemperatureInputFactory),
+    AVDTestSpec(test_class=VerifyVxlanConfigSanity, input_factory=VerifyVxlanConfigSanityInputFactory),
+    AVDTestSpec(test_class=VerifyZeroTouch),
 ]
 """List of all ANTA tests with their specifications that AVD will run by default."""