netdoc-sdk 0.2.4__tar.gz → 0.3.0__tar.gz

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/.github/workflows/ci.yml

@@ -12,11 +12,11 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - name: Checkout (SDK)
         uses: actions/checkout@v6
         with:
           path: netdoc-sdk
-      - name: Checkout backend
+      - name: Checkout (backend)
         uses: actions/checkout@v6
         with:
           repository: NetDocLab/netdoc
@@ -29,23 +29,20 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Poetry
         run: pip install --no-cache-dir poetry
-        working-directory: netdoc-sdk
       - name: Display Poetry version
         run: poetry --version
-        working-directory: netdoc-sdk
       - name: Configure Poetry
         run: poetry config virtualenvs.in-project true
-        working-directory: netdoc-sdk
-      - name: Install
+      - name: Install SDK
         run: make install
         working-directory: netdoc-sdk
-      - name: Code linting (make lint)
+      - name: Code linting on SDK (make lint)
         run: make lint
         working-directory: netdoc-sdk
-      - name: Run checks (pre-commit)
+      - name: Run checks on SDK (pre-commit)
         run: make check
         working-directory: netdoc-sdk
-      - name: Run tests
+      - name: Run tests on SDK (make coverage)
         run: make coverage
         working-directory: netdoc-sdk
   snyk:
@@ -59,4 +56,4 @@ jobs:
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
         with:
-          args: --severity-threshold=high
+          args: --severity-threshold=high --all-projects

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/.pre-commit-config.yaml

@@ -7,6 +7,7 @@ exclude: >-
     \.venv/.*|
     \.vscode/.*|
     build/.*|
+    CHANGELOG.md|
     dist/.*|
     env/.*|
     venv/.*|

netdoc_sdk-0.3.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.3.0"
+}

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.3.0](https://github.com/NetDocLab/netdoc-sdk/compare/v0.2.5...v0.3.0) (2026-06-09)
+
+
+### Bug Fixes
+
+* intercept 429 and retry ([06c2e59](https://github.com/NetDocLab/netdoc-sdk/commit/06c2e590203cee937247b0bbc068c4ff165c053e))
+
+## [0.2.5](https://github.com/NetDocLab/netdoc-sdk/compare/v0.2.4...v0.2.5) (2026-06-01)
+
+
+### Bug Fixes
+
+* add parsed_output_count on DiscoveryRun model ([d808f17](https://github.com/NetDocLab/netdoc-sdk/commit/d808f1732b445a47babf1a2af5d5e9c85bc1c1f8))
+
 ## [0.2.4](https://github.com/NetDocLab/netdoc-sdk/compare/v0.2.3...v0.2.4) (2026-05-30)
 
 

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netdoc-sdk
-Version: 0.2.4
+Version: 0.3.0
 Summary: Network Documentation Platform - SDK
 Project-URL: homepage, https://github.com/NetDocLab/netdoc-sdk
 Project-URL: documentation, https://github.com/NetDocLab/netdoc-sdk/wiki

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/poetry.lock

@@ -2314,6 +2314,25 @@ files = [
 [package.dependencies]
 pytest = ">=7.0.0"
 
+[[package]]
+name = "pytest-env"
+version = "1.6.0"
+description = "pytest plugin that allows you to add environment variables."
+optional = false
+python-versions = ">=3.10"
+groups = ["dev"]
+files = [
+    {file = "pytest_env-1.6.0-py3-none-any.whl", hash = "sha256:1e7f8a62215e5885835daaed694de8657c908505b964ec8097a7ce77b403d9a3"},
+    {file = "pytest_env-1.6.0.tar.gz", hash = "sha256:ac02d6fba16af54d61e311dd70a3c61024a4e966881ea844affc3c8f0bf207d3"},
+]
+
+[package.dependencies]
+pytest = ">=9.0.2"
+python-dotenv = ">=1.2.2"
+
+[package.extras]
+testing = ["covdefaults (>=2.3)", "coverage (>=7.13.4)", "pytest-mock (>=3.15.1)"]
+
 [[package]]
 name = "python-dateutil"
 version = "2.9.0.post0"
@@ -2361,6 +2380,21 @@ platformdirs = ">=4.3.6,<5"
 docs = ["furo (>=2025.12.19)", "sphinx (>=9.1)", "sphinx-autodoc-typehints (>=3.6.3)", "sphinxcontrib-mermaid (>=2)"]
 testing = ["covdefaults (>=2.3)", "coverage (>=7.5.4)", "pytest (>=8.3.5)", "pytest-mock (>=3.14)", "setuptools (>=75.1)"]
 
+[[package]]
+name = "python-dotenv"
+version = "1.2.2"
+description = "Read key-value pairs from a .env file and set them as environment variables"
+optional = false
+python-versions = ">=3.10"
+groups = ["dev"]
+files = [
+    {file = "python_dotenv-1.2.2-py3-none-any.whl", hash = "sha256:1d8214789a24de455a8b8bd8ae6fe3c6b69a5e3d64aa8a8e5d68e694bbcb285a"},
+    {file = "python_dotenv-1.2.2.tar.gz", hash = "sha256:2c371a91fbd7ba082c2c1dc1f8bf89ca22564a087c2c287cd9b662adde799cf3"},
+]
+
+[package.extras]
+cli = ["click (>=5.0)"]
+
 [[package]]
 name = "pyyaml"
 version = "6.0.3"
@@ -2972,4 +3006,4 @@ brotli = ["brotli"]
 [metadata]
 lock-version = "2.1"
 python-versions = ">=3.12,<3.14"
-content-hash = "f7c41355008cd6c23ff019485f4d907924c4c241828571cecf0587513f4d921f"
+content-hash = "ca847814e3a43c2471a8930a695b0b1032e13d2dc31f301988722148b7a8e4f3"

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "netdoc-sdk"
 description = "Network Documentation Platform - SDK"
-version = "0.2.4"
+version = "0.3.0"
 authors = [
     {name = "Andrea Cavazzini", email = "cavazzini.andrea@gmail.com"},
     {name = "Andrea Dainese", email = "andrea.dainese@gmail.com"},
@@ -58,6 +58,7 @@ pre-commit = "^4.5.1"
 pytest = ">=7.4"
 pytest-asyncio = "^1.3.0"
 pytest-cov = ">=4.1"
+pytest-env = "^1.6.0"
 responses = "^0.26.0"
 respx = "^0.23.1"
 
@@ -149,6 +150,7 @@ typeCheckingMode = "off"
 
 [tool.pytest.ini_options]
 DJANGO_SETTINGS_MODULE = "netdoc.settings.test"
+env = ["DJANGO_ENV=test"]
 minversion = "7.0"
 addopts = "-v -ra --strict-markers --strict-config --cov=netdoc_sdk --cov-report=term-missing"
 filterwarnings = [
@@ -178,6 +180,7 @@ exclude = [
     "dist",
     "env",
     "migrations",
+    "scripts",
     "venv",
 ]
 

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/src/netdoc_sdk/client.py

@@ -1,5 +1,7 @@
 """Async HTTP client for the NetDoc OpenAPI surface."""
 
+import asyncio
+import logging
 from collections.abc import Iterable, Mapping
 from typing import Any
 
@@ -39,7 +41,10 @@ from netdoc_sdk.models.discovery import (
     CredentialCreate,
     CredentialDetail,
     CredentialUpdate,
+    DiscoveredDeviceSubmit,
     DiscoveryJobClaim,
+    DiscoveryJobDetail,
+    DiscoveryJobStatusEnum,
     DiscoveryRunDetail,
     PaginatedCollectorList,
     PaginatedCredentialList,
@@ -79,6 +84,7 @@ class NetDocClient:
         cookies: Mapping[str, str] | None = None,
         headers: Mapping[str, str] | None = None,
         tenant_id: str | None = None,
+        max_retries: int = 5,
         timeout: float = 30.0,
         transport: httpx.AsyncBaseTransport | None = None,
     ):
@@ -88,6 +94,7 @@ class NetDocClient:
         self.cookies = dict(cookies or {})
         self.extra_headers = dict(headers or {})
         self.tenant_id = tenant_id
+        self.max_retries = max_retries
         self.timeout = timeout
         self.token = token
         self.transport = transport
@@ -196,25 +203,52 @@ class NetDocClient:
                 {expected_status} if isinstance(expected_status, int) else set(expected_status)
             )
 
-        try:
-            response = await self.client.request(
-                content=content,
-                headers=request_headers,
-                json=self._serialize_body(json) if json is not None else None,
-                method=method,
-                params=self._clean_params(params),
-                url=self._api_path(path),
-            )
-        except (httpx.ConnectError, httpx.NetworkError) as exc:
-            raise ConnectionError(f'Failed to connect: {exc}') from exc
-        except httpx.TimeoutException as exc:
-            raise ConnectionError(f'Request timed out: {exc}') from exc
-
-        if expected is None:
-            ok = 200 <= response.status_code < 300
-        else:
-            ok = response.status_code in expected
-        if not ok:
+        for attempt in range(self.max_retries + 1):
+            try:
+                response = await self.client.request(
+                    content=content,
+                    headers=request_headers,
+                    json=self._serialize_body(json) if json is not None else None,
+                    method=method,
+                    params=self._clean_params(params),
+                    url=self._api_path(path),
+                )
+            except (httpx.ConnectError, httpx.NetworkError) as exc:
+                raise ConnectionError(f'Failed to connect: {exc}') from exc
+            except httpx.TimeoutException as exc:
+                raise ConnectionError(f'Request timed out: {exc}') from exc
+
+            if expected is None:
+                ok = 200 <= response.status_code < 300
+            else:
+                ok = response.status_code in expected
+
+            if ok:
+                break
+
+            if response.status_code == 429 and attempt < self.max_retries:
+                # Retry with rate limit
+                default_retry_after = '1.0'
+                retry_after = response.headers.get('Retry-After')
+                if not retry_after:
+                    logging.warning(f'Retry value not set, using {default_retry_after}')
+                    retry_after = default_retry_after
+                try:
+                    wait = float(retry_after)
+                except (ValueError, TypeError):
+                    logging.warning(
+                        f'Retry value of {retry_after} is not valid, using {default_retry_after}'
+                    )
+                    wait = float(default_retry_after)
+                logging.warning(
+                    'Rate limited (attempt %d/%d), retrying in %.1fs',
+                    attempt + 1,
+                    self.max_retries,
+                    wait,
+                )
+                await asyncio.sleep(wait)
+                continue
+
             self._raise_for_error(response)
 
         if response.status_code == 204 or not response.content:
@@ -457,11 +491,72 @@ class NetDocClient:
             'POST', 'discovery-jobs/claim/', response_model=DiscoveryJobClaim
         )
 
+    async def discoveryjob_complete(
+        self,
+        id: str,
+        claim_token: str,
+        data: JsonMapping | CollectorUpdate | None = None,
+        **fields: Any,
+    ) -> DiscoveryJobDetail:
+        # TODO: could be no content
+        headers = {'X-Claim-Token': claim_token}
+        return await self._request(
+            'POST',
+            f'discovery-jobs/{id}/complete/',
+            json=self._serialize_body(data, **fields),
+            headers=headers,
+            response_model=DiscoveryJobDetail,
+        )
+
+    async def discoveryjob_heartbeat(self, id: str, claim_token: str) -> DiscoveryJobDetail:
+        # TODO: could be no content
+        headers = {'X-Claim-Token': claim_token}
+        return await self._request(
+            'POST',
+            f'discovery-jobs/{id}/heartbeat/',
+            headers=headers,
+            response_model=DiscoveryJobDetail,
+        )
+
+    async def discoveryjob_push_discovered_device(
+        self,
+        id: str,
+        claim_token: str,
+        data: JsonMapping | DiscoveredDeviceSubmit | None = None,
+        **fields: Any,
+    ) -> DiscoveryJobDetail:
+        # TODO: could be no content
+        headers = {'X-Claim-Token': claim_token}
+        return await self._request(
+            'POST',
+            f'discovery-jobs/{id}/push-discovered-device/',
+            json=self._serialize_body(data, **fields),
+            headers=headers,
+            response_model=DiscoveryJobDetail,
+        )
+
+    async def discoveryjob_status(
+        self, id: str, claim_token: str, status: DiscoveryJobStatusEnum | None = None
+    ) -> DiscoveryJobDetail:
+        headers = {'X-Claim-Token': claim_token}
+        if status is not None:
+            return await self._request(
+                'PATCH',
+                f'discovery-jobs/{id}/status/',
+                headers=headers,
+                json={'status': status},
+                response_model=DiscoveryJobDetail,
+            )
+        return await self._request(
+            'GET',
+            f'discovery-jobs/{id}/status/',
+            headers=headers,
+            response_model=DiscoveryJobDetail,
+        )
+
     # TODO
-    # claim
-    # heartbeat
     # push_discovered_device
-    # status
+    # status --> implement both GET and PATCH to update the status (e.g. to mark complete or failed)
     # complete
 
     # ---------------------------------------------------------------------------

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/src/netdoc_sdk/models/core.py

@@ -17,7 +17,7 @@ class Severity(Enum):
 
 
 class APIModel(BaseModel):
-    """Base model that tolerates additive API fields without dropping them."""
+    """Base model that doesn't tolerates additive API fields without dropping them."""
 
     model_config = ConfigDict(extra='forbid', populate_by_name=True)
 
@@ -63,7 +63,9 @@ class TenantDetail(APIModel):
     id: UUID4Str
     name: str
     is_active: bool
+    log_retention_days: int
     max_snapshots: int
+    snapshot_retention_days: int
     created_at: datetime
     updated_at: datetime
 
@@ -72,7 +74,9 @@ class TenantList(APIModel):
     id: UUID4Str
     name: str
     is_active: bool
+    log_retention_days: int
     max_snapshots: int
+    snapshot_retention_days: int
     created_at: datetime
     updated_at: datetime
 
@@ -83,13 +87,17 @@ PaginatedTenantList = PaginatedResponse[TenantList]
 class TenantCreate(APIModel):
     name: str
     is_active: bool | None = None
+    log_retention_days: int | None = None
     max_snapshots: int | None = None
+    snapshot_retention_days: int | None = None
 
 
 class TenantUpdate(APIModel):
     name: str | None = None
     is_active: bool | None = None
+    log_retention_days: int | None = None
     max_snapshots: int | None = None
+    snapshot_retention_days: int | None = None
 
 
 # ---------------------------------------------------------------------------

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/src/netdoc_sdk/models/discovery.py

@@ -4,7 +4,7 @@ from datetime import datetime
 from enum import Enum
 from uuid import UUID
 
-from pydantic import Field
+from pydantic import BaseModel, field_validator
 
 from netdoc_sdk.models.core import APIModel, LogMessage, PaginatedResponse, UUID4Str
 
@@ -43,10 +43,10 @@ PaginatedCollectorList = PaginatedResponse[CollectorList]
 
 
 class CollectorUpdate(APIModel):
-    canonical_devices: list[UUID] = Field(default_factory=list)
-    sites: list[UUID] = Field(default_factory=list)
-    domain_range: list[str] = Field(default_factory=list)
-    network_range: list[str] = Field(default_factory=list)
+    canonical_devices: list[UUID] | None = None
+    sites: list[UUID] | None = None
+    domain_range: list[str] | None = None
+    network_range: list[str] | None = None
     is_active: bool | None = None
 
 
@@ -126,6 +126,7 @@ class DiscoveryRunDetail(APIModel):
     failed_job_count: int
     job_count: int
     raw_output_count: int
+    parsed_output_count: int
     cancellation_requested_at: datetime | None
     completed_at: datetime | None
     created_at: datetime
@@ -144,6 +145,7 @@ class DiscoveryRunList(APIModel):
     failed_job_count: int
     job_count: int
     raw_output_count: int
+    parsed_output_count: int
     cancellation_requested_at: datetime | None
     completed_at: datetime | None
     created_at: datetime
@@ -165,13 +167,27 @@ PaginatedDiscoveryRunList = PaginatedResponse[DiscoveryRunList]
 # complete
 
 
+class DiscoveryJobStatusEnum(Enum):
+    """Discovery job lifecycle statuses."""
+
+    QUEUED = 'queued'
+    CLAIMED = 'claimed'
+    RUNNING = 'running'
+    CANCELLING = 'cancelling'
+    CANCELLED = 'cancelled'
+    COMPLETED = 'completed'
+    FAILED = 'failed'
+    EXPIRED = 'expired'
+
+
 class DiscoveryJobDetail(APIModel):
     id: str
     run: UUID4Str
     collector: UUID4Str
     collector_name: str
     snapshot: UUID4Str
-    status: str
+    status: DiscoveryJobStatusEnum
+    canonical_devices: list[dict]  # TODO should be part of the inventory
     attempt: int
     max_attempts: int
     idempotency_key: str
@@ -182,11 +198,27 @@ class DiscoveryJobDetail(APIModel):
     timeout_at: datetime | None
     created_at: datetime
     updated_at: datetime
+    claim_token: str | None = (
+        None  # TODO: should be on claim only | if this isn't passed back, in case of crash/restart of a collector, there's no way to get back the claim token --> maybe re-think the workflow to not require the claim token for heartbeats and completion updates? Or have a way to retrieve the claim token for active jobs for a collector?
+    )
 
 
 PaginatedDiscoveryJobList = PaginatedResponse[DiscoveryJobDetail]
 
 
+class InventoryMeta(BaseModel):
+    hostvars: dict[str, dict]
+
+
+class InventoryAll(BaseModel):
+    hosts: list[str]
+
+
+class DiscoveryJobInventory(BaseModel):
+    _meta: InventoryMeta
+    all: InventoryAll
+
+
 class DiscoveryJobClaim(APIModel):
     id: str
     run: UUID4Str
@@ -194,6 +226,8 @@ class DiscoveryJobClaim(APIModel):
     collector_name: str
     snapshot: UUID4Str
     status: str
+    canonical_devices: list[dict]  # TODO should be part of the inventory
+    claim_token: str
     attempt: int
     max_attempts: int
     idempotency_key: str
@@ -206,6 +240,20 @@ class DiscoveryJobClaim(APIModel):
     created_at: datetime
     updated_at: datetime
 
+    @field_validator('inventory')
+    @classmethod
+    def validate_inventory(cls, inventory: dict) -> dict:
+        DiscoveryJobInventory.model_validate(inventory)
+        return inventory  # Return original inventory
+
+
+class DiscoveredDeviceSubmit(APIModel):
+    raw_payload: dict | None = None
+    # TODO: send also parsed_payload
+    idempotency_key: str
+    canonical_device: UUID4Str
+    attempt: int
+
 
 # class DiscoveryJobHeartbeat(APIModel):
 #     claim_token: str

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/src/netdoc_sdk/models/inventory.py

@@ -55,7 +55,7 @@ class SiteCreate(APIModel):
 
 
 class SiteUpdate(APIModel):
-    name: str
+    name: str | None = None
     site_type: SiteTypeEnum | None = None
     address: str | None = None
     city: str | None = None

netdoc_sdk-0.3.0/tests/integration/core/test_001_filters.py

@@ -0,0 +1,32 @@
+import pytest
+
+
+@pytest.mark.django_db
+class TestFilter:
+    @pytest.mark.django_db(transaction=True)
+    async def test_filter_name(self, superuser_client):
+        await superuser_client.tenant_add(name='test-tenant-01', is_active=True, max_snapshots=3)
+        await superuser_client.tenant_add(name='test-tenant-02', is_active=True, max_snapshots=3)
+        await superuser_client.tenant_add(name='test-tenant-03', is_active=True, max_snapshots=3)
+        res = await superuser_client.tenant_list(name='test-tenant-01')
+        assert res.count == 1
+
+    @pytest.mark.django_db(transaction=True)
+    async def test_filter_name_in(self, superuser_client):
+        await superuser_client.tenant_add(name='test-tenant-01', is_active=True, max_snapshots=3)
+        await superuser_client.tenant_add(name='test-tenant-02', is_active=True, max_snapshots=3)
+        await superuser_client.tenant_add(name='test-03', is_active=True, max_snapshots=3)
+        res = await superuser_client.tenant_list(name_in='test-tenant')
+        assert res.count == 2
+
+    @pytest.mark.django_db(transaction=True)
+    async def test_filter_name_nonexistent(self, superuser_client):
+        await superuser_client.tenant_add(name='test-tenant-01', is_active=True, max_snapshots=3)
+        res = await superuser_client.tenant_list(name='nonexistent')
+        assert res.count == 0
+
+    @pytest.mark.django_db(transaction=True)
+    async def test_filter_name_in_nonexistent(self, superuser_client):
+        await superuser_client.tenant_add(name='test-tenant-01', is_active=True, max_snapshots=3)
+        res = await superuser_client.tenant_list(name_in='nonexistent')
+        assert res.count == 0

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/tests/integration/core/test_002_tenant.py

@@ -10,7 +10,8 @@ class TestTenant:
         )
         res = await superuser_client.tenant_list()
         assert res.count == 1
-        await superuser_client.tenant_get(id=tenant.id)
+        await superuser_client.tenant_get(tenant.id)
+        await superuser_client.tenant_get(tenant.name)
         await superuser_client.tenant_update(
             id=tenant.id, name='test-new-tenant', is_active=False, max_snapshots=1
         )

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/tests/integration/core/test_003_user.py

@@ -16,7 +16,8 @@ class TestUser:
         )
         res = await admin_client.user_list()
         assert res.count == 2
-        await admin_client.user_get(id=user.id)
+        await admin_client.user_get(user.id)
+        await admin_client.user_get(user.username)
         await admin_client.user_update(
             id=user.id,
             username='test-new-user',

{netdoc_sdk-0.2.4 → netdoc_sdk-0.3.0}/tests/integration/discovery/test_003_discovery_run.py

@@ -28,10 +28,14 @@ class TestDiscoveryRun:
         # Activate collector
         await admin_client.collector_update(collector.id, is_active=True)
 
-        # Test functions
+        # Create run
         discovery_run = await admin_client.discovery_add()
         res = await admin_client.discovery_list()
         assert res.count == 1
         await admin_client.discovery_get(id=discovery_run.id)
-        # TODO: await admin_client.discovery_jobs(id=discovery_run.id)
+
+        # Verify jobs
+        await admin_client.discovery_jobs(id=discovery_run.id)
+
+        # Cancel the run
         await admin_client.discovery_cancel(id=discovery_run.id)

netdoc_sdk-0.3.0/tests/integration/discovery/test_004_discovery_job.py

@@ -0,0 +1,391 @@
+import pytest
+
+from netdoc_sdk.client import NetDocClient
+
+RAW_SHOW_VERSION = """
+Cisco IOS Software, Catalyst 4500 L3 Switch Software (cat4500e-ENTSERVICESK9-M), Version 12.2(54)SG1, RELEASE SOFTWARE (fc1)
+Technical Support: http://www.cisco.com/techsupport
+Copyright (c) 1986-2011 by Cisco Systems, Inc.
+Compiled Thu 27-Jan-11 12:07 by prod_rel_team
+Image text-base: 0x10000000, data-base: 0x12E16D24
+
+ROM: 12.2(44r)SG9
+Hobgoblin Revision 20, Fortooine Revision 1.22
+
+router1 uptime is 2 years, 31 weeks, 6 days, 9 hours, 55 minutes
+System returned to ROM by reload
+System restarted at 09:09:22 UTC Tue Apr 9 2013
+System image file is "bootflash:cat4500e-entservicesk9-mz.122-54.SG1.bin"
+
+
+This product contains cryptographic features and is subject to United
+States and local country laws governing import, export, transfer and
+use. Delivery of Cisco cryptographic products does not imply
+third-party authority to import, export, distribute or use encryption.
+Importers, exporters, distributors and users are responsible for
+compliance with U.S. and local country laws. By using this product you
+agree to comply with applicable laws and regulations. If you are unable
+to comply with U.S. and local laws, return this product immediately.
+
+A summary of U.S. laws governing Cisco cryptographic products may be found at:
+http://www.cisco.com/wwl/export/crypto/tool/stqrg.html
+
+If you require further assistance please contact us by sending email to
+export@cisco.com.
+
+cisco WS-C4948E (MPC8548) processor (revision 4) with 1048576K bytes of memory.
+Processor board ID CAT1451S15C
+MPC8548 CPU at 1GHz, Cisco Catalyst 4948E
+Last reset from Reload
+17 Virtual Ethernet interfaces
+48 Gigabit Ethernet interfaces
+4 Ten Gigabit Ethernet interfaces
+511K bytes of non-volatile configuration memory.
+
+Configuration register is 0x2102
+"""
+RAW_SHOW_INTERFACES = """
+GigabitEthernet0/0 is reset, line protocol is down (notconnect)
+  Hardware is iGbE, address is fa16.3e57.336f (bia fa16.3e57.336f)
+  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive set (10 sec)
+  Unknown, Unknown, link type is auto, media type is unknown media type
+  output flow-control is unsupported, input flow-control is unsupported
+  Auto-duplex, Auto-speed, link type is auto, media type is unknown
+  input flow-control is off, output flow-control is unsupported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input 1d21h, output 1d21h, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/0 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 0 bits/sec, 0 packets/sec
+     324 packets input, 48614 bytes, 0 no buffer
+     Received 0 broadcasts (0 multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     0 watchdog, 0 multicast, 0 pause input
+     703 packets output, 62737 bytes, 0 underruns
+     0 output errors, 0 collisions, 2 interface resets
+     0 unknown protocol drops
+     0 babbles, 0 late collision, 0 deferred
+     0 lost carrier, 0 no carrier, 0 pause output
+     0 output buffer failures, 0 output buffers swapped out
+GigabitEthernet0/1 is up, line protocol is up (connected)
+  Hardware is iGbE, address is fa16.3e4f.41cc (bia fa16.3e4f.41cc)
+  Description: to iosvl2-2
+  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive set (10 sec)
+  Auto Duplex, Auto Speed, link type is auto, media type is unknown media type
+  output flow-control is unsupported, input flow-control is unsupported
+  Auto-duplex, Auto-speed, link type is auto, media type is unknown
+  input flow-control is off, output flow-control is unsupported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input 1d21h, output 00:00:02, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/0 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 0 bits/sec, 0 packets/sec
+     83 packets input, 14855 bytes, 0 no buffer
+     Received 0 broadcasts (0 multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     0 watchdog, 0 multicast, 0 pause input
+     15513 packets output, 2510810 bytes, 0 underruns
+     0 output errors, 0 collisions, 3 interface resets
+     0 unknown protocol drops
+     0 babbles, 0 late collision, 0 deferred
+     0 lost carrier, 0 no carrier, 0 pause output
+     0 output buffer failures, 0 output buffers swapped out
+GigabitEthernet0/2 is up, line protocol is up (connected)
+  Hardware is iGbE, address is fa16.3ea3.3e49 (bia fa16.3ea3.3e49)
+  Description: to iosvl2-4
+  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive set (10 sec)
+  Unknown, Unknown, link type is auto, media type is unknown media type
+  output flow-control is unsupported, input flow-control is unsupported
+  Auto-duplex, Auto-speed, link type is auto, media type is unknown
+  input flow-control is off, output flow-control is unsupported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input 00:00:13, output 00:00:00, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/0 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 1000 bits/sec, 2 packets/sec
+     8677 packets input, 1698461 bytes, 0 no buffer
+     Received 0 broadcasts (0 multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     0 watchdog, 0 multicast, 0 pause input
+     420798 packets output, 29058795 bytes, 0 underruns
+     0 output errors, 0 collisions, 2 interface resets
+     0 unknown protocol drops
+     0 babbles, 0 late collision, 0 deferred
+     0 lost carrier, 0 no carrier, 0 pause output
+     0 output buffer failures, 0 output buffers swapped out
+GigabitEthernet0/3 is up, line protocol is up (connected)
+  Hardware is iGbE, address is fa16.3e31.2c47 (bia fa16.3e31.2c47)
+  Description: to iosvl2-3
+  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive set (10 sec)
+  Unknown, Unknown, link type is auto, media type is unknown media type
+  output flow-control is unsupported, input flow-control is unsupported
+  Auto-duplex, Auto-speed, link type is auto, media type is unknown
+  input flow-control is off, output flow-control is unsupported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input 00:00:28, output 00:00:00, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/0 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 1000 bits/sec, 2 packets/sec
+     8638 packets input, 1689698 bytes, 0 no buffer
+     Received 0 broadcasts (0 multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     0 watchdog, 0 multicast, 0 pause input
+     420819 packets output, 29060539 bytes, 0 underruns
+     0 output errors, 0 collisions, 2 interface resets
+     0 unknown protocol drops
+     0 babbles, 0 late collision, 0 deferred
+     0 lost carrier, 0 no carrier, 0 pause output
+     0 output buffer failures, 0 output buffers swapped out
+GigabitEthernet1/0 is up, line protocol is up (connected)
+  Hardware is iGbE, address is fa16.3ec8.50ab (bia fa16.3ec8.50ab)
+  Description: to iosvl2-3
+  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive set (10 sec)
+  Unknown, Unknown, link type is auto, media type is unknown media type
+  output flow-control is unsupported, input flow-control is unsupported
+  Auto-duplex, Auto-speed, link type is auto, media type is unknown
+  input flow-control is off, output flow-control is unsupported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input 00:00:26, output 00:00:00, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/0 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 2000 bits/sec, 2 packets/sec
+     8627 packets input, 1690235 bytes, 0 no buffer
+     Received 0 broadcasts (0 multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     0 watchdog, 0 multicast, 0 pause input
+     420790 packets output, 29056035 bytes, 0 underruns
+     0 output errors, 0 collisions, 2 interface resets
+     0 unknown protocol drops
+     0 babbles, 0 late collision, 0 deferred
+     0 lost carrier, 0 no carrier, 0 pause output
+     0 output buffer failures, 0 output buffers swapped out
+Port-channel1 is down, line protocol is down (notconnect)
+  Hardware is EtherChannel, address is fa16.3e4f.41cc (bia fa16.3e4f.41cc)
+  MTU 1500 bytes, BW 100000 Kbit/sec, DLY 100 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive set (10 sec)
+  Auto-duplex, Auto-speed, media type is unknown
+  input flow-control is off, output flow-control is unsupported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input 1d21h, output never, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/2000/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/40 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 0 bits/sec, 0 packets/sec
+     85 packets input, 7037 bytes, 0 no buffer
+     Received 0 broadcasts (0 multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     0 input packets with dribble condition detected
+     0 packets output, 0 bytes, 0 underruns
+     0 output errors, 0 collisions, 0 interface resets
+     0 unknown protocol drops
+     0 babbles, 0 late collision, 0 deferred
+     0 lost carrier, 0 no carrier
+     0 output buffer failures, 0 output buffers swapped out
+Loopback0 is up, line protocol is up
+  Hardware is Loopback
+  Description: Loopback
+  MTU 1514 bytes, BW 8000000 Kbit/sec, DLY 5000 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation LOOPBACK, loopback not set
+  Keepalive set (10 sec)
+  Last input never, output never, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/0 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 0 bits/sec, 0 packets/sec
+     0 packets input, 0 bytes, 0 no buffer
+     Received 0 broadcasts (0 IP multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored, 0 abort
+     0 packets output, 0 bytes, 0 underruns
+     0 output errors, 0 collisions, 0 interface resets
+     0 unknown protocol drops
+     0 output buffer failures, 0 output buffers swapped out
+Vlan1 is up, line protocol is up
+  Hardware is Ethernet SVI, address is fa16.3e57.8001 (bia fa16.3e57.8001)
+  Description: OOB Management
+  Internet address is 10.255.0.16/16
+  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive not supported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input never, output never, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/40 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 0 bits/sec, 0 packets/sec
+     0 packets input, 0 bytes, 0 no buffer
+     Received 0 broadcasts (0 IP multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     4 packets output, 240 bytes, 0 underruns
+     0 output errors, 0 interface resets
+     0 unknown protocol drops
+     0 output buffer failures, 0 output buffers swapped out
+GigabitEthernet0/2 is administratively down, line protocol is down
+  Hardware is ASR1001, address is 78da.6eaf.3b82 (bia 78da.6eaf.3b82)
+  Description: Port
+  MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec,
+     reliability 255/255, txload 1/255, rxload 1/255
+  Encapsulation ARPA, loopback not set
+  Keepalive not supported
+  Full Duplex, 1000Mbps, link type is auto, media type is unknown media type
+  output flow-control is unsupported, input flow-control is unsupported
+  ARP type: ARPA, ARP Timeout 04:00:00
+  Last input never, output never, output hang never
+  Last clearing of "show interface" counters never
+  Input queue: 0/375/0/0 (size/max/drops/flushes); Total output drops: 0
+  Queueing strategy: fifo
+  Output queue: 0/40 (size/max)
+  5 minute input rate 0 bits/sec, 0 packets/sec
+  5 minute output rate 0 bits/sec, 0 packets/sec
+     0 packets input, 0 bytes, 0 no buffer
+     Received 0 broadcasts (0 IP multicasts)
+     0 runts, 0 giants, 0 throttles
+     0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
+     0 watchdog, 0 multicast, 0 pause input
+     0 packets output, 0 bytes, 0 underruns
+     0 output errors, 0 collisions, 1 interface resets
+     0 unknown protocol drops
+     0 babbles, 0 late collision, 0 deferred
+     0 lost carrier, 0 no carrier, 0 pause output
+     0 output buffer failures, 0 output buffers swapped out
+"""
+
+
+@pytest.mark.django_db
+class TestDiscoveryRun:
+    @pytest.mark.django_db(transaction=True)
+    async def test_discovery_job(self, admin_client, live_server):
+        collector_username = 'test-collector-user'
+        collector_password = 'test-password'
+
+        # Add collector user
+        await admin_client.user_add(
+            username=collector_username, password=collector_password, role='collector'
+        )
+        collector_client = await NetDocClient.from_credentials(
+            base_url=live_server.url,
+            username=collector_username,
+            password=collector_password,
+        )
+
+        # Create canonical device
+        canonical_device = await admin_client.canonicaldevice_add(
+            label='r1.example.com',
+            discovery_mode='netmiko:cisco:ios:ssh',
+            is_discoverable=True,
+            identifiers={'hostname': 'r1'},
+        )
+
+        # Create collector (heartbeat)
+        collector = await collector_client.collector_heartbeat(
+            name='collector@host.example.com', version='0.1.0'
+        )
+
+        # Activate collector
+        await admin_client.collector_update(collector.id, is_active=True)
+
+        # Create run
+        discovery_run = await admin_client.discovery_add()
+        res = await admin_client.discovery_list()
+        assert res.count == 1
+        await admin_client.discovery_get(id=discovery_run.id)
+
+        # Verify jobs
+        await admin_client.discovery_jobs(id=discovery_run.id)
+
+        # Claim job
+        res = await collector_client.discoveryjob_claim()
+        job_id = res.id
+        claim_token = res.claim_token
+        idempotency_key = res.idempotency_key
+
+        # Job heartbeat
+        await collector_client.discoveryjob_heartbeat(id=job_id, claim_token=claim_token)
+
+        # Get job status
+        # TODO: await admin_client.discoveryjob_status(id=job_id)
+        # TODO: should be GET only (not PATCH)
+
+        # Push discovered devices
+        payload = {
+            'canonical_device': canonical_device.id,
+            'command_name': 'show version',
+            'raw_payload': {
+                'show version': RAW_SHOW_VERSION,
+                'show interfaces': RAW_SHOW_INTERFACES,
+            },
+            'idempotency_key': idempotency_key,
+        }
+        await collector_client.discoveryjob_push_discovered_device(
+            id=job_id, claim_token=claim_token, **payload
+        )
+
+        # Complete job
+        payload = {
+            'status': 'completed',
+            'log_messages': [
+                {
+                    'severity': 'INFO',
+                    'timestamp': '2026-05-17T09:36:45.244045+00:00',
+                    'message': "Running netmiko command 'show ip route vrf Mgmt-vrf' on mgmtswitch1.example.com",
+                },
+                {
+                    'severity': 'WARNING',
+                    'timestamp': '2026-05-17T09:36:45.387987+00:00',
+                    'message': "Cannot parse command 'show ip route vrf Mgmt-vrf'",
+                },
+                {
+                    'severity': 'INFO',
+                    'timestamp': '2026-05-17T09:36:45.390002+00:00',
+                    'message': 'Discovery completed (failed on 0 hosts)',
+                },
+            ],
+        }
+        await collector_client.discoveryjob_complete(id=job_id, claim_token=claim_token, **payload)

netdoc_sdk-0.2.4/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.2.4"
-}

netdoc_sdk-0.2.4/tests/integration/discovery/test_004_discovery_job.py

@@ -1,36 +0,0 @@
-import pytest
-
-from netdoc_sdk.client import NetDocClient
-
-
-@pytest.mark.django_db
-class TestDiscoveryRun:
-    @pytest.mark.django_db(transaction=True)
-    async def test_discovery_run(self, admin_client, live_server):
-        collector_username = 'test-collector-user'
-        collector_password = 'test-password'
-
-        # Add collector user
-        await admin_client.user_add(
-            username=collector_username, password=collector_password, role='collector'
-        )
-        collector_client = await NetDocClient.from_credentials(
-            base_url=live_server.url,
-            username=collector_username,
-            password=collector_password,
-        )
-
-        # Create collector (heartbeat)
-        collector = await collector_client.collector_heartbeat(
-            name='collector@host.example.com', version='0.1.0'
-        )
-
-        # Activate collector
-        await admin_client.collector_update(collector.id, is_active=True)
-
-        # Test functions
-        await collector_client.discoveryjob_claim()
-        # TODO heartbeat
-        # TODO push_discovered_device
-        # TODO status
-        # TODO complete