nac-test-pyats-common 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

nac_test_pyats_common/sdwan/auth.py

@@ -1,8 +1,12 @@
+# SPDX-License-Identifier: MPL-2.0
+# Copyright (c) 2025 Daniel Schmidt
+
 """SDWAN Manager authentication implementation for Cisco SD-WAN.
 
 This module provides authentication functionality for Cisco SDWAN Manager (formerly
 vManage), which manages the software-defined WAN fabric. The authentication mechanism
-uses form-based login with JSESSIONID cookie and optional XSRF token for CSRF protection.
+uses form-based login with JSESSIONID cookie and optional XSRF token for CSRF
+protection.
 
 The module implements a two-tier API design:
 1. _authenticate() - Low-level method that performs direct SDWAN Manager authentication
@@ -16,7 +20,9 @@ import os
 from typing import Any
 
 import httpx
-from nac_test.pyats_core.common.auth_cache import AuthCache  # type: ignore[import-untyped]
+from nac_test.pyats_core.common.auth_cache import (
+    AuthCache,  # type: ignore[import-untyped]
+)
 
 # Default session lifetime for SDWAN Manager authentication in seconds
 # SDWAN Manager sessions are typically valid for 30 minutes (1800 seconds) by default
@@ -56,7 +62,9 @@ class SDWANManagerAuth:
     """
 
     @staticmethod
-    def _authenticate(url: str, username: str, password: str) -> tuple[dict[str, Any], int]:
+    def _authenticate(
+        url: str, username: str, password: str
+    ) -> tuple[dict[str, Any], int]:
         """Perform direct SDWAN Manager authentication and obtain session data.
 
         This method performs a direct authentication request to the SDWAN Manager
@@ -149,8 +157,9 @@ class SDWANManagerAuth:
         expired ones. This significantly reduces the number of authentication
         requests to the SDWAN Manager.
 
-        The method uses a cache key based on the controller type ("SDWAN_MANAGER") and
-        URL to ensure proper session isolation between different SDWAN Manager instances.
+        The method uses a cache key based on the controller type ("SDWAN_MANAGER")
+        and URL to ensure proper session isolation between different SDWAN Manager
+        instances.
 
         Environment Variables Required:
             SDWAN_URL: Base URL of the SDWAN Manager
@@ -197,7 +206,9 @@ class SDWANManagerAuth:
                 missing_vars.append("SDWAN_USERNAME")
             if not password:
                 missing_vars.append("SDWAN_PASSWORD")
-            raise ValueError(f"Missing required environment variables: {', '.join(missing_vars)}")
+            raise ValueError(
+                f"Missing required environment variables: {', '.join(missing_vars)}"
+            )
 
         # Normalize URL by removing trailing slash
         url = url.rstrip("/")  # type: ignore[union-attr]

nac_test_pyats_common/sdwan/device_resolver.py

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MPL-2.0
+# Copyright (c) 2025 Daniel Schmidt
+
 """SD-WAN-specific device resolver for parsing the NAC data model.
 
 This module provides the SDWANDeviceResolver class, which extends
@@ -22,13 +25,20 @@ class SDWANDeviceResolver(BaseDeviceResolver):
 
     Schema structure:
         sdwan:
+          management_ip_variable: "vpn511_int1_if_ipv4_address"  # Global default
           sites:
             - name: "site1"
               routers:
                 - chassis_id: "abc123"
+                  management_ip_variable: "custom_mgmt_ip"  # Router override
                   device_variables:
                     system_hostname: "router1"
-                    vpn10_mgmt_ip: "10.1.1.100/32"
+                    vpn511_int1_if_ipv4_address: "10.1.1.100/32"
+                    custom_mgmt_ip: "10.2.2.200/32"
+
+    Management IP Resolution Priority:
+        1. Router-level management_ip_variable (highest priority)
+        2. Global sdwan-level management_ip_variable (fallback)
 
     Credentials:
         Uses IOSXE_USERNAME and IOSXE_PASSWORD environment variables
@@ -53,7 +63,7 @@ class SDWANDeviceResolver(BaseDeviceResolver):
         """Return 'sdwan' as the root key in the data model.
 
         Returns:
-            Root key used when loading test inventory and navigating schema.
+            Root key used when navigating the schema.
         """
         return "sdwan"
 
@@ -111,7 +121,9 @@ class SDWANDeviceResolver(BaseDeviceResolver):
 
         # Fallback to chassis_id
         chassis_id = device_data.get("chassis_id", "unknown")
-        logger.warning(f"No system_hostname found for {chassis_id}, using chassis_id as hostname")
+        logger.warning(
+            f"No system_hostname found for {chassis_id}, using chassis_id as hostname"
+        )
         return str(chassis_id)
 
     def extract_host_ip(self, device_data: dict[str, Any]) -> str:
@@ -121,6 +133,10 @@ class SDWANDeviceResolver(BaseDeviceResolver):
         Uses management_ip_variable field to determine which variable
         contains the management IP.
 
+        Resolution priority:
+        1. Router-level management_ip_variable (highest priority)
+        2. Global sdwan-level management_ip_variable (fallback)
+
         Args:
             device_data: Router data dictionary from the data model.
 
@@ -128,27 +144,28 @@ class SDWANDeviceResolver(BaseDeviceResolver):
             IP address string without CIDR notation (e.g., "10.1.1.100").
 
         Raises:
-            ValueError: If no management IP can be found.
+            ValueError: If management_ip_variable is not configured or
+                the referenced variable is not found in device_variables.
         """
         device_vars = device_data.get("device_variables", {})
 
-        # Get the variable name that contains the management IP
+        # Cascading lookup: router-level > global sdwan-level
         ip_var = device_data.get("management_ip_variable")
+        if not ip_var:
+            ip_var = self.data_model.get("sdwan", {}).get("management_ip_variable")
+
+        if not ip_var:
+            raise ValueError(
+                "management_ip_variable not configured. "
+                "Set it at router level or sdwan level in sites.nac.yaml."
+            )
 
-        if ip_var and ip_var in device_vars:
-            ip_value = str(device_vars[ip_var])
-        else:
-            # Fallback: try common variable names
-            for fallback_var in ["mgmt_ip", "management_ip", "vpn0_ip"]:
-                if fallback_var in device_vars:
-                    ip_value = str(device_vars[fallback_var])
-                    break
-            else:
-                raise ValueError(
-                    "Could not find management IP for device. "
-                    "Set 'management_ip_variable' in test_inventory or use "
-                    "standard variable names (mgmt_ip, management_ip, vpn0_ip)."
-                )
+        if ip_var not in device_vars:
+            raise ValueError(
+                f"management_ip_variable '{ip_var}' not found in device_variables."
+            )
+
+        ip_value = str(device_vars[ip_var])
 
         # Strip CIDR notation if present
         if "/" in ip_value:
@@ -157,15 +174,35 @@ class SDWANDeviceResolver(BaseDeviceResolver):
         return ip_value
 
     def extract_os_type(self, device_data: dict[str, Any]) -> str:
-        """Extract OS type, defaulting to 'iosxe' for SD-WAN edges.
+        """Return 'iosxe' as all SD-WAN edge devices are IOS-XE based.
+
+        Args:
+            device_data: Router data dictionary (unused, OS is hardcoded).
+
+        Returns:
+            Always returns 'iosxe'.
+        """
+        return "iosxe"
+
+    def build_device_dict(self, device_data: dict[str, Any]) -> dict[str, Any]:
+        """Build device dictionary with SD-WAN specific defaults.
+
+        Extends the base implementation to add type='router' since
+        all SD-WAN edge devices are routers.
 
         Args:
             device_data: Router data dictionary from the data model.
 
         Returns:
-            OS type string (e.g., "iosxe", "nxos", "iosxr").
+            Device dictionary with hostname, host, os, device_id, and type.
         """
-        return str(device_data.get("os", "iosxe"))
+        # Get base device dict from parent
+        device_dict = super().build_device_dict(device_data)
+
+        # Add type - all SD-WAN edges are routers
+        device_dict["type"] = "router"
+
+        return device_dict
 
     def get_credential_env_vars(self) -> tuple[str, str]:
         """Return IOS-XE credential env vars for SD-WAN edge devices.

nac_test_pyats_common/sdwan/ssh_test_base.py

@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: MPL-2.0
+# Copyright (c) 2025 Daniel Schmidt
+
 """SD-WAN specific base test class for SSH/Direct-to-Device testing.
 
 This module provides the SDWANTestBase class, which extends the generic SSHTestBase
@@ -17,7 +20,9 @@ import logging
 import os
 from typing import Any
 
-from nac_test.pyats_core.common.ssh_base_test import SSHTestBase  # type: ignore[import-untyped]
+from nac_test.pyats_core.common.ssh_base_test import (
+    SSHTestBase,  # type: ignore[import-untyped]
+)
 
 from .device_resolver import SDWANDeviceResolver
 
@@ -43,18 +48,27 @@ class SDWANTestBase(SSHTestBase):  # type: ignore[misc]
                 pass
     """
 
+    # Class-level storage for the last resolver instance
+    # This allows nac-test to access skipped_devices after calling
+    # get_ssh_device_inventory()
+    _last_resolver: "SDWANDeviceResolver | None" = None
+
     @classmethod
-    def get_ssh_device_inventory(cls, data_model: dict[str, Any]) -> list[dict[str, Any]]:
+    def get_ssh_device_inventory(
+        cls, data_model: dict[str, Any]
+    ) -> list[dict[str, Any]]:
         """Parse the SD-WAN data model to retrieve the device inventory.
 
         This method is the entry point called by nac-test's orchestrator.
         All device inventory resolution is delegated to SDWANDeviceResolver,
         which handles:
-        - Test inventory loading (test_inventory.yaml)
         - Schema navigation (sites[].routers[])
-        - Variable resolution (hostnames, IPs)
+        - Management IP resolution via management_ip_variable
         - Credential injection (IOSXE_USERNAME, IOSXE_PASSWORD)
 
+        After calling this method, access cls._last_resolver.skipped_devices
+        to get information about devices that failed resolution.
+
         Args:
             data_model: The merged data model from nac-test containing all
                 sites.nac.yaml data with resolved variables.
@@ -73,13 +87,8 @@ class SDWANTestBase(SSHTestBase):  # type: ignore[misc]
         """
         logger.info("SDWANTestBase: Resolving device inventory via SDWANDeviceResolver")
 
-        # Delegate entirely to the resolver
-        # SDWANDeviceResolver handles:
-        # 1. Test inventory loading via BaseDeviceResolver._load_inventory()
-        # 2. Schema navigation via navigate_to_devices()
-        # 3. Credential injection via _inject_credentials() using IOSXE_* env vars
-        resolver = SDWANDeviceResolver(data_model)
-        return resolver.get_resolved_inventory()
+        cls._last_resolver = SDWANDeviceResolver(data_model)
+        return cls._last_resolver.get_resolved_inventory()
 
     def get_device_credentials(self, device: dict[str, Any]) -> dict[str, str | None]:
         """Get SD-WAN edge device SSH credentials from environment variables.

{nac_test_pyats_common-0.1.0.dist-info → nac_test_pyats_common-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nac-test-pyats-common
-Version: 0.1.0
+Version: 0.2.0
 Summary: Architecture adapters for Network as Code (NaC) PyATS testing - auth classes, test base classes, and device resolvers
 Project-URL: Homepage, https://github.com/netascode/nac-test-pyats-common
 Project-URL: Documentation, https://github.com/netascode/nac-test-pyats-common
@@ -24,6 +24,7 @@ Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: System :: Networking
 Requires-Python: >=3.10
 Requires-Dist: httpx>=0.28
+Requires-Dist: nac-test==1.1.0b2
 Provides-Extra: dev
 Requires-Dist: bandit[toml]>=1.8.6; extra == 'dev'
 Requires-Dist: mypy>=1.10; extra == 'dev'

nac_test_pyats_common-0.2.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+nac_test_pyats_common/__init__.py,sha256=4fOaRhzkJJDyW00-wPzEzgWdmLXSLfxkiV-Z39RWmq8,1770
+nac_test_pyats_common/py.typed,sha256=BrP39il8_cNN1K0KDeyBUtySS9oI2_SK5xKx1SxdSoY,59
+nac_test_pyats_common/aci/__init__.py,sha256=Y9VhBZ3_GXLBk3_Wtg1SRG_Dxx134Etf9k-0wvrOMwQ,1335
+nac_test_pyats_common/aci/auth.py,sha256=1Rk2uBGb_CGgkBh9dD3LagIsbJPKRgsSFDYEeyiC50U,7867
+nac_test_pyats_common/aci/test_base.py,sha256=SoPh91AXPvMshJXIyjiZumSgxOAN4xPkpSb3t0B9kdE,6256
+nac_test_pyats_common/catc/__init__.py,sha256=ZGOQBvjFvq7h9LtfOyxFEmlir7htpy8sfWoJuDwGjsA,1986
+nac_test_pyats_common/catc/api_test_base.py,sha256=kGp6rZ4S3zP3MW5BD02K5uVxmtE-vRlG2A99kaLgyDo,7507
+nac_test_pyats_common/catc/auth.py,sha256=1oDZr_PEWOz1IZOUm_kyKzIFPQubMo_wemj-Q3D7ALU,9522
+nac_test_pyats_common/catc/device_resolver.py,sha256=YgJJn1pXONXCAMnfXA-_Iuo6tkLtD9EekHbPbae6mRg,5363
+nac_test_pyats_common/catc/ssh_test_base.py,sha256=wUldp2T9cmSEALBtbOgUQvQ2txuid3ErJEO27kM-kiI,4482
+nac_test_pyats_common/common/__init__.py,sha256=Y0qrZEKx2g8Zm1CTHJpeLocwMasspP6NQuhyrRiA1wA,1084
+nac_test_pyats_common/common/base_device_resolver.py,sha256=xP4QF-kNp_8rFo9N6wzfJSIpNOgnPkeZmWAbH0k5tGo,15091
+nac_test_pyats_common/iosxe/__init__.py,sha256=GSuLGyxcu8dFouspTjXuQ1Mi27vDluVR8ZCcJrPcIiY,2147
+nac_test_pyats_common/iosxe/iosxe_resolver.py,sha256=XzzwRCa1cuQ6HmeUB1Z2vITOwYdhuDlugDD1eVXAoIE,2355
+nac_test_pyats_common/iosxe/registry.py,sha256=djRFzxuEu8IdyTmi1puhIHGZGSMjys0l1v4-uzYCwAU,5723
+nac_test_pyats_common/iosxe/test_base.py,sha256=NjXbf0ZY-CBWhd3jpIAhylL5kyRrHM6FlhGlFtjLSjM,4569
+nac_test_pyats_common/sdwan/__init__.py,sha256=mrziVp5kMgykKnFPvWykuVLuky6xwEv6oEcfrbxFXxY,1777
+nac_test_pyats_common/sdwan/api_test_base.py,sha256=NuqrxODrRw7ZvEIuoc1Bup60thKqJOfiGz96T4QJ8Ng,7632
+nac_test_pyats_common/sdwan/auth.py,sha256=CMgf_AYCalVQNjdUfDlE-0-z5tnhU_Wnscgt5ZW61RY,10322
+nac_test_pyats_common/sdwan/device_resolver.py,sha256=1GdM5QKftj4F5bGmsbH90--VqoFZaDPMerHF1dAceMQ,7169
+nac_test_pyats_common/sdwan/ssh_test_base.py,sha256=rZF7txhu0FGtPtTzGMZFqB9hwClmtggroZwRuX3BGU4,4210
+nac_test_pyats_common-0.2.0.dist-info/METADATA,sha256=9Qbd0AYAGd33wI1iwbynSClOmApEC-Iny0geUrBoIzA,13072
+nac_test_pyats_common-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+nac_test_pyats_common-0.2.0.dist-info/licenses/LICENSE,sha256=zt2sx-c0iEk6-OO0iqRQ4l6fIGazRKW_qLMqfDpLm6M,16295
+nac_test_pyats_common-0.2.0.dist-info/RECORD,,

nac_test_pyats_common/iosxe/catc_resolver.py

@@ -1,64 +0,0 @@
-"""Catalyst Center device resolver placeholder for D2D testing.
-
-This is a placeholder for the Catalyst Center resolver that will be implemented
-when Catalyst Center D2D testing support is added. This resolver will handle
-IOS-XE devices managed by Catalyst Center.
-
-Expected environment variables:
-    - CC_URL: Catalyst Center controller URL
-    - CC_USERNAME: Catalyst Center username
-    - CC_PASSWORD: Catalyst Center password
-    - IOSXE_USERNAME: SSH username for devices
-    - IOSXE_PASSWORD: SSH password for devices
-
-"""
-
-from typing import Any
-
-from nac_test_pyats_common.common import BaseDeviceResolver
-
-from .registry import register_iosxe_resolver
-
-
-@register_iosxe_resolver("CC")
-class CatalystCenterDeviceResolver(BaseDeviceResolver):
-    """Placeholder resolver for Catalyst Center D2D testing.
-
-    This resolver will be implemented when Catalyst Center D2D testing
-    support is added. Currently a placeholder to reserve the CC registry slot.
-    """
-
-    def get_architecture_name(self) -> str:
-        """Return architecture name."""
-        return "catalyst_center"
-
-    def get_schema_root_key(self) -> str:
-        """Return data model root key."""
-        return "catalyst_center"
-
-    def navigate_to_devices(self) -> list[dict[str, Any]]:
-        """Navigate to devices in data model."""
-        raise NotImplementedError(
-            "CatalystCenterDeviceResolver is not yet implemented. "
-            "This placeholder reserves the CC registry slot for future use."
-        )
-
-    def extract_device_id(self, device_data: dict[str, Any]) -> str:
-        """Extract device ID."""
-        raise NotImplementedError("CatalystCenterDeviceResolver is not yet implemented")
-
-    def extract_hostname(self, device_data: dict[str, Any]) -> str:
-        """Extract hostname."""
-        raise NotImplementedError("CatalystCenterDeviceResolver is not yet implemented")
-
-    def extract_host_ip(self, device_data: dict[str, Any]) -> str:
-        """Extract management IP."""
-        raise NotImplementedError("CatalystCenterDeviceResolver is not yet implemented")
-
-    def extract_os_type(self, device_data: dict[str, Any]) -> str:
-        """Extract OS type."""
-        raise NotImplementedError("CatalystCenterDeviceResolver is not yet implemented")
-
-    def get_credential_env_vars(self) -> tuple[str, str]:
-        """Return credential environment variable names."""
-        return ("IOSXE_USERNAME", "IOSXE_PASSWORD")

nac_test_pyats_common-0.1.0.dist-info/RECORD

@@ -1,24 +0,0 @@
-nac_test_pyats_common/__init__.py,sha256=yhvIGEkgMoZhwZKWxXUTzkzQT6-6YtpdOOa8mAVgNaY,1551
-nac_test_pyats_common/py.typed,sha256=BrP39il8_cNN1K0KDeyBUtySS9oI2_SK5xKx1SxdSoY,59
-nac_test_pyats_common/aci/__init__.py,sha256=hEqGdhP_DtCqmLnUncYdmmH5d5WFRsdIkoCzH3DbV1k,1263
-nac_test_pyats_common/aci/auth.py,sha256=CSBHmmN8GYNXP-uCC6u31S-AOWcUDhIeLwuolN4OEjU,7772
-nac_test_pyats_common/aci/test_base.py,sha256=Em0GTrU0lJLWhwoZOptwnEEDnY3L8YkB-2Sre4endzI,6131
-nac_test_pyats_common/catc/__init__.py,sha256=1e5RjeEKApalS9CqSRi_nvER1MRtaCfQJ-kVOq8zp0w,1247
-nac_test_pyats_common/catc/auth.py,sha256=yCp9NGe48CngxGN0QVLS17ukfJge7rdBcV-L2_lez7U,9350
-nac_test_pyats_common/catc/test_base.py,sha256=myhdMFN310z6D3IC_BcSvtNQ4iyGbZZtiROxoNAHs0I,7367
-nac_test_pyats_common/common/__init__.py,sha256=tMBObh27Bl3AHe4UVu3EoI6rbhxWV901WKw4SEMvnwk,1012
-nac_test_pyats_common/common/base_device_resolver.py,sha256=VQDkV6EzZCJL9TrJcB2i34BFz9Y8cK7g2Y_8NP7AVrQ,18420
-nac_test_pyats_common/iosxe/__init__.py,sha256=dIXPUdOJAy8P7KM4_scfkFSB4g1c-b7AdsEC3Ok8gEE,2075
-nac_test_pyats_common/iosxe/catc_resolver.py,sha256=YK8-1Y0EIkX5CBawAqAxYk2kMjYwoBWXLtM3Yz_7kfQ,2441
-nac_test_pyats_common/iosxe/iosxe_resolver.py,sha256=CmvbF8eFo5I_Uy_JDx1lO-2YaB_fiDxK-I7WBvu7X5o,2283
-nac_test_pyats_common/iosxe/registry.py,sha256=toRNcIcXkPPrm-kC4tpxOf6kTXgvC2Dsh8Vm5EXEwRY,5562
-nac_test_pyats_common/iosxe/test_base.py,sha256=dJrTpRy3V8Q0vK5FODHzDh85EZ7eM8dS9PnBvRF-i_0,4220
-nac_test_pyats_common/sdwan/__init__.py,sha256=QUnYDV25cwubonnpXkkhGrDcSOcDtmabAAx8fPnM4zQ,1697
-nac_test_pyats_common/sdwan/api_test_base.py,sha256=gTy57JSa6pjuCayfZMzS1lUPZHYSTqZjr8LeDNoLouc,7507
-nac_test_pyats_common/sdwan/auth.py,sha256=V_OVAZzCSOvfTYrPGyv-xXZEDDHIpTl2BBxDoB5Mwro,10189
-nac_test_pyats_common/sdwan/device_resolver.py,sha256=huAfUG6TADF3lWeOUyr244jRogC5SqWhz4k-1191ZnY,5968
-nac_test_pyats_common/sdwan/ssh_test_base.py,sha256=KvV_Hw56EiX5HcVRNG2A2ryLH0v6RbmLlUzyJMQ-424,4078
-nac_test_pyats_common-0.1.0.dist-info/METADATA,sha256=hZNaqHtElHIADhf2CumhWpg8qf9aEWEE_eM2tIr6IQw,13039
-nac_test_pyats_common-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-nac_test_pyats_common-0.1.0.dist-info/licenses/LICENSE,sha256=zt2sx-c0iEk6-OO0iqRQ4l6fIGazRKW_qLMqfDpLm6M,16295
-nac_test_pyats_common-0.1.0.dist-info/RECORD,,