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

nac_test_pyats_common-0.1.0.dist-info/METADATA

@@ -0,0 +1,304 @@
+Metadata-Version: 2.4
+Name: nac-test-pyats-common
+Version: 0.1.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
+Project-URL: Repository, https://github.com/netascode/nac-test-pyats-common
+Project-URL: Issues, https://github.com/netascode/nac-test-pyats-common/issues
+Author-email: Andrea Testino <atestini@cisco.com>
+Maintainer-email: Andrea Testino <atestini@cisco.com>
+License: MPL-2.0
+License-File: LICENSE
+Keywords: aci,catalyst-center,cisco,nac,network,pyats,sdwan,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.28
+Provides-Extra: dev
+Requires-Dist: bandit[toml]>=1.8.6; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+[![Tests](https://github.com/netascode/nac-test-pyats-common/actions/workflows/test.yml/badge.svg)](https://github.com/netascode/nac-test-pyats-common/actions/workflows/test.yml)
+![Python Support](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-informational "Python Support: 3.10, 3.11, 3.12")
+
+# nac-test-pyats-common
+
+> **⚠️ INITIAL DEVELOPMENT**: This package is under active initial development and not yet ready for production use.
+
+A shared library consolidating duplicated PyATS testing infrastructure across NAC (Network as Code) architecture repositories. This package serves as a Layer 2 adapter between architecture-specific test repositories (ACI, SD-WAN, Catalyst Center) and the core nac-test framework.
+
+## Overview
+
+The `nac-test-pyats-common` package addresses the architectural challenge of duplicated `pyats_common/` directories across NAC architecture repositories. It consolidates shared PyATS testing infrastructure—including authentication classes, test base classes, and device resolvers—into a centralized, maintainable package.
+
+### Problem Solved
+
+Each NAC architecture repository previously contained duplicated PyATS infrastructure code:
+- ~90% of base test class code was identical across architectures
+- Bug fixes and improvements required manual propagation to all repos
+- Each architecture team maintained essentially the same code
+- Adding new architectures (ISE, Meraki, IOS-XE) compounded the duplication problem
+
+### Solution Architecture
+
+```
+┌─────────────────────────────────────────────────────────────────────┐
+│               Layer 3: Architecture Repositories                     │
+│     (nac-aci-terraform, nac-sdwan-terraform, nac-catc-terraform)    │
+│                                                                      │
+│  ┌─────────────────┐  ┌─────────────────┐                          │
+│  │ Test Files      │  │ NAC Schema      │                          │
+│  │ (verify_*.py)   │  │ Definitions     │                          │
+│  └────────┬────────┘  └─────────────────┘                          │
+│           │                                                          │
+│           │ imports                                                  │
+│           ▼                                                          │
+└───────────┼──────────────────────────────────────────────────────────┘
+            │
+┌───────────▼──────────────────────────────────────────────────────────┐
+│       Layer 2: nac-test-pyats-common (Architecture Adapters)        │
+│                    DEPENDS ON nac-test                               │
+│                                                                      │
+│  • Architecture-specific authentication (APICAuth, VManageAuth)      │
+│  • Architecture-specific test base classes (APICTestBase, etc.)      │
+│  • Architecture-specific device resolvers (SDWANDeviceResolver)      │
+│                       │                                              │
+│                       │ imports NACTestBase, SSHTestBase, AuthCache │
+│                       ▼                                              │
+└───────────────────────┼──────────────────────────────────────────────┘
+                        │
+┌───────────────────────▼──────────────────────────────────────────────┐
+│                Layer 1: nac-test (Core Framework)                    │
+│                    Orchestration + Generic Infrastructure            │
+│                                                                      │
+│  • Test orchestration (discovering tests, running them)              │
+│  • Testbed generation (generic device dict → PyATS YAML)            │
+│  • Connection brokering (SSH connection pooling)                     │
+│  • HTML report generation                                            │
+│  • Generic base classes (NACTestBase, SSHTestBase)                  │
+└─────────────────────────────────────────────────────────────────────┘
+```
+
+## Supported Architectures
+
+### Currently Supported
+- **ACI (Application Centric Infrastructure)**
+  - `APICAuth` - APIC authentication with cookie-based sessions
+  - `APICTestBase` - Base class for ACI/APIC tests
+  - `ACIDeviceResolver` - Device inventory from ACI data models
+
+- **SD-WAN**
+  - `VManageAuth` - vManage authentication with token-based sessions
+  - `VManageTestBase` - Base class for vManage API tests
+  - `SDWANSSHTestBase` - Base class for SD-WAN D2D/SSH tests
+  - `SDWANDeviceResolver` - Device inventory from sites.nac.yaml
+
+- **Catalyst Center**
+  - `CatalystCenterAuth` - Token-based authentication (X-Auth-Token)
+  - `CatalystCenterTestBase` - Base class for Catalyst Center API tests
+  - `CatalystCenterDeviceResolver` - Device inventory from NAC schemas
+
+### Planned Support
+- ISE (Identity Services Engine)
+- Meraki
+- IOS-XE (Direct device access)
+
+## Installation
+
+Python 3.10+ is required. Don't have Python 3.10 or later? See [Python 3 Installation & Setup Guide](https://realpython.com/installing-python/).
+
+```shell
+pip install nac-test-pyats-common
+```
+
+This will automatically install the required dependencies:
+- `nac-test~=1.1.0` - Core testing framework (brings PyATS as transitive dependency)
+- `httpx>=0.28` - HTTP client for authentication
+
+## Usage
+
+### Import Pattern
+
+Replace the old fragile imports from architecture repos:
+
+```python
+# Old pattern (remove this)
+from templates.catc.test.pyats_common.catc_base_test import CatalystCenterTestBase
+
+# New pattern (use this)
+from nac_test_pyats_common.catc import CatalystCenterTestBase
+```
+
+### Example Test File
+
+```python
+# In nac-catalystcenter-terraform/tests/templates/catc/test/api/verify_something.py
+
+from nac_test_pyats_common.catc import CatalystCenterTestBase
+from nac_test.pyats_core.reporting.types import ResultStatus
+from pyats import aetest
+
+class TestCatalystCenterFeature(CatalystCenterTestBase):
+    """Test class for Catalyst Center feature verification."""
+
+    @aetest.test
+    def verify_feature(self):
+        """Verify feature configuration."""
+        # self.client is already configured with auth headers
+        response = self.client.get("/api/v1/feature")
+
+        if response.status_code == 200:
+            self.result = ResultStatus.PASS
+        else:
+            self.result = ResultStatus.FAIL
+```
+
+## API Structure
+
+### Authentication Classes
+
+Each architecture provides an authentication class that handles controller-specific authentication:
+
+```python
+from nac_test_pyats_common.aci import APICAuth
+from nac_test_pyats_common.sdwan import VManageAuth
+from nac_test_pyats_common.catc import CatalystCenterAuth
+
+# Authentication is handled automatically when using test base classes
+# But can be used directly if needed:
+auth_data = CatalystCenterAuth.get_auth()  # Uses AuthCache internally
+```
+
+### Test Base Classes
+
+Test base classes extend `NACTestBase` from nac-test with architecture-specific setup:
+
+```python
+from nac_test_pyats_common.catc import CatalystCenterTestBase
+
+class MyTest(CatalystCenterTestBase):
+    """Your test class."""
+
+    @aetest.setup
+    def setup(self):
+        """Setup is handled by base class."""
+        super().setup()
+        # self.client is now available with auth headers configured
+        # self.auth_data contains authentication tokens/cookies
+```
+
+### Device Resolvers
+
+Device resolvers parse NAC schemas to provide device inventory for SSH tests:
+
+```python
+from nac_test_pyats_common.sdwan import SDWANDeviceResolver
+
+# Used by nac-test orchestrator internally
+devices = SDWANDeviceResolver.get_ssh_device_inventory(data_model)
+```
+
+## Environment Variables
+
+Each architecture requires specific environment variables for authentication:
+
+### Catalyst Center
+- `CC_URL` - Controller URL
+- `CC_USERNAME` - Username
+- `CC_PASSWORD` - Password
+- `CC_INSECURE` - Skip SSL verification (optional, default: "True")
+
+### SD-WAN
+- `VMANAGE_URL` - vManage URL
+- `VMANAGE_USERNAME` - Username
+- `VMANAGE_PASSWORD` - Password
+- `VMANAGE_INSECURE` - Skip SSL verification (optional, default: "True")
+
+### ACI
+- `APIC_URL` - APIC URL
+- `APIC_USERNAME` - Username
+- `APIC_PASSWORD` - Password
+- `APIC_INSECURE` - Skip SSL verification (optional, default: "True")
+
+## Development
+
+### Local Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/netascode/nac-test-pyats-common.git
+cd nac-test-pyats-common
+
+# Install in editable mode with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/unit/ -v
+pytest tests/integration/ -v  # Requires nac-test
+
+# Type checking
+mypy --strict src/
+
+# Linting
+ruff check src/
+```
+
+### Contributing
+
+When contributing, understand which repository to modify:
+
+| Change Type | Repository | Example |
+|-------------|------------|---------|
+| Auth endpoint change | nac-test-pyats-common | Catalyst Center adds new auth API |
+| Test base setup logic | nac-test-pyats-common | Add new setup step for all CC tests |
+| Generic orchestration | nac-test | Change how tests are discovered/run |
+| HTML report format | nac-test | Modify report template |
+| Test file (verify_*.py) | Architecture repo | Add new verification test |
+
+## Dependencies
+
+- `nac-test~=1.1.0` - Core testing framework
+  - Provides: `NACTestBase`, `SSHTestBase`, `AuthCache`, orchestration
+  - Brings PyATS as transitive dependency
+- `httpx>=0.28` - Modern async-capable HTTP client
+
+## Versioning
+
+This package follows [Semantic Versioning 2.0.0](https://semver.org/):
+- **MAJOR**: Breaking API changes
+- **MINOR**: New features, backward compatible
+- **PATCH**: Bug fixes, backward compatible
+
+### Compatibility Matrix
+
+| nac-test-pyats-common | nac-test Required | Notes |
+|-----------------------|-------------------|-------|
+| 1.0.x | ~=1.1.0 | Initial release |
+| 1.1.x | ~=1.1.0 | New architecture added |
+| 2.0.x | ~=2.0.0 | Breaking changes |
+
+## License
+
+This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For issues, questions, or contributions, please visit the [GitHub repository](https://github.com/netascode/nac-test-pyats-common).

nac_test_pyats_common-0.1.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+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,,

nac_test_pyats_common-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any