pytest

Author: petercrocker

templates/clab_topology.j2

@@ -1,20 +1,38 @@
+{#- ============================================================================
+    Containerlab Topology Generator Template
+
+    Generates a Containerlab topology YAML file from Infrahub TopologyDeployment data.
+    Supports Arista cEOS devices with management network configuration and
+    automated link generation between devices.
+    ============================================================================ -#}
+{#- Define default container images for each device kind -#}
 {% set default_images = {
   "arista_ceos": "registry.opsmill.io/external/ceos-image:4.29.0.2F"
 } -%}
+
+{# Iterate through all topology deployments #}
 {% for topology in data.TopologyDeployment.edges -%}
 
 
 ---
+{# ============================================================================
+   Basic Topology Configuration
+   ============================================================================ #}
 name: {{ topology.node.name.value }}
 prefix: ""
 
+{# Management network configuration #}
 mgmt:
   network: {{ topology.node.name.value | lower() }}
   ipv4-subnet: {{ topology.node.management_subnet.node.prefix.value }}
 
 {% if topology.node.devices.edges is defined -%}
 
 topology:
+  {# ============================================================================
+     Device Kind Definitions
+     Configure base images and startup commands for each device type
+     ============================================================================ #}
   kinds:
     arista_ceos:
       image: "{{ default_images.arista_ceos }}"
@@ -23,52 +41,73 @@ topology:
         - FastCli -p 15 -c 'security pki key generate rsa 4096 eAPI.key'
         - FastCli -p 15 -c 'security pki certificate generate self-signed eAPI.crt key eAPI.key generate rsa 4096 validity 30000 parameters common-name eAPI'
 
+  {# ============================================================================
+     Node Definitions
+     Define individual device nodes with their configuration
+     ============================================================================ #}
   nodes:
-{%- for device in topology.node.devices.edges %}
+{% for device in topology.node.devices.edges %}
+{#- Only include devices that are Arista cEOS platform #}
 {%- if device.node.platform.node.containerlab_os.value == "arista_ceos" %}
     {{ device.node.name.value }}:
       kind: {{ device.node.platform.node.containerlab_os.value }}
       type: {{ device.node.device_type.node.name.value }}
+{#- Add custom OS version if specified #}
 {%- if device.node.os_version.value %}
       image: {{ device.node.os_version.value }}
 {%- endif %}
+{#- Extract and set management IP (strip subnet mask) #}
 {%- if device.node.primary_address.node.address is defined %}
 {%- set mgmt_ip = device.node.primary_address.node.address.value.split('/') %}
       mgmt-ipv4: {{ mgmt_ip[0] }}
 {%- endif %}
       startup-config: ../devices/{{ device.node.name.value }}.cfg
 {%- endif %}
-{%- endfor %}
+{% endfor %}
 
 
+  {# ============================================================================
+     Link Definitions
+     Generate physical connections between devices from interface connectors.
+     Deduplicates bidirectional links and normalizes interface naming.
+     ============================================================================ #}
   links:
-{%- set processed_endpoints = [] %}
+{% set processed_endpoints = [] %}
+{#- Build a mapping of device names to their platform kinds for interface name normalization -#}
 {%- set device_kinds = {} %}
 {%- for device in topology.node.devices.edges %}
 {%- set _ = device_kinds.update({device.node.name.value: device.node.platform.node.containerlab_os.value}) %}
 {%- endfor %}
+{#- Iterate through all devices and their interfaces to find connections -#}
 {%- for device in topology.node.devices.edges %}
 {%- for interface in device.node.interfaces.edges %}
+{#- Only process interfaces with valid connectors (skip console/management) -#}
 {%- if interface.node.connector is defined and interface.node.connector.node is not none and interface.node.role.value not in ["console", "management"] %}
 {%- set connected_endpoint = interface.node.connector.node %}
+{#- Build endpoint identifiers (device:interface) -#}
 {%- set endpoint1 = device.node.name.value + ":" + interface.node.name.value %}
 {%- set endpoint2 = connected_endpoint.hfid | join(":") %}
+{#- Create sorted tuple to ensure consistent ordering for deduplication -#}
 {%- set endpoint_tuple = [endpoint1, endpoint2] | sort %}
 {%- set endpoint_key = endpoint_tuple | join("|") %}
+{#- Only process each unique link once (prevents duplicates for bidirectional connections) -#}
 {%- if endpoint_key not in processed_endpoints %}
 {%- set _ = processed_endpoints.append(endpoint_key) %}
+{#- Normalize interface naming: "Ethernet" -> "eth" for containerlab -#}
 {%- set endpoint1 = endpoint1.replace("Ethernet", "eth") %}
 {%- set endpoint2 = endpoint2.replace("Ethernet", "eth") %}
+{#- Extract device names from endpoints -#}
 {%- set device1_name = endpoint1.split(":")[0] %}
 {%- set device2_name = endpoint2.split(":")[0] %}
+{#- Arista cEOS: Strip subinterface notation (e.g., "eth1/1/1" -> "eth1/1") -#}
 {%- if device_kinds.get(device1_name) == "arista_ceos" %}
 {%- set endpoint1 = endpoint1.split("/")[0] %}
 {%- endif %}
 {%- if device_kinds.get(device2_name) == "arista_ceos" %}
 {%- set endpoint2 = endpoint2.split("/")[0] %}
 {%- endif %}
     - endpoints: ["{{ endpoint1 }}", "{{ endpoint2 }}"]
-{%- endif %}
+{% endif %}
 {%- endif %}
 {%- endfor %}
 {%- endfor %}

tests/integration/test_workflow.py

@@ -17,7 +17,6 @@
 
 import logging
 import time
-from pathlib import Path
 
 import pytest
 from infrahub_sdk import InfrahubClient, InfrahubClientSync
@@ -99,9 +98,6 @@ def test_04_load_security_data(self, client_main: InfrahubClientSync) -> None:
             f"Security data load failed: {load_security.stdout}\n{load_security.stderr}"
         )
 
-    @pytest.mark.skip(
-        reason="Repository sync fails due to group resolution issue during import"
-    )
     async def test_05_add_repository(
         self, async_client_main: InfrahubClient, remote_repos_dir: str
     ) -> None:
@@ -113,7 +109,7 @@ async def test_05_add_repository(
         git_repository = GitRepo(
             name="demo_repo",
             src_directory=src_directory,
-            dst_directory=Path(remote_repos_dir),
+            dst_directory=remote_repos_dir,
         )
 
         response = await git_repository.add_to_infrahub(client=client)
@@ -127,7 +123,6 @@ async def test_05_add_repository(
         # Wait for repository to sync
         synchronized = False
         max_attempts, attempts = 60, 0
-        repository = None
 
         while not synchronized and attempts < max_attempts:
             repository = await client.get(
@@ -148,7 +143,6 @@ async def test_05_add_repository(
             )
             time.sleep(10)
 
-        assert repository is not None, "Failed to retrieve repository"
         assert synchronized, (
             f"Repository failed to sync. Status: {repository.sync_status.value}"
         )
@@ -209,9 +203,6 @@ async def test_08_verify_dc3_created(
         assert dc3.name.value == "DC-3", f"Expected DC-3, got {dc3.name.value}"
         logging.info("DC-3 topology verified: %s", dc3.name.value)
 
-    @pytest.mark.skip(
-        reason="Repository not loaded - generator definitions not available"
-    )
     async def test_09_run_generator(
         self, async_client_main: InfrahubClient, default_branch: str
     ) -> None:
@@ -251,10 +242,10 @@ async def test_09_run_generator(
             attempts += 1
             time.sleep(10)
 
-        if not definition:
-            pytest.skip(
-                "Generator definition 'create_dc' not available - skipping generator test"
-            )
+        assert definition, (
+            "Generator definition 'create_dc' not available after waiting. "
+            "Repository may not have synced properly in test_05."
+        )
 
         logging.info("Found generator: %s", definition.name.value)
 
@@ -288,7 +279,6 @@ async def test_09_run_generator(
         )
         logging.info("Generator completed successfully")
 
-    @pytest.mark.skip(reason="Generator not run - no devices to verify")
     async def test_10_verify_devices_created(
         self, async_client_main: InfrahubClient, default_branch: str
     ) -> None:
@@ -301,10 +291,10 @@ async def test_10_verify_devices_created(
         # Query for devices
         devices = await client.all(kind="DcimGenericDevice")
 
-        if not devices:
-            pytest.skip(
-                "No devices found - generator may not have run (test_09 may have been skipped)"
-            )
+        assert devices, (
+            "No devices found after generator run. "
+            "Generator in test_09 may not have completed successfully."
+        )
 
         logging.info("Found %d devices after generator run", len(devices))
 
@@ -471,7 +461,6 @@ def test_13_merge_proposed_change(
         )
         logging.info("Proposed change merged successfully")
 
-    @pytest.mark.skip(reason="Generator not run - no devices to verify in main")
     async def test_14_verify_merge_to_main(
         self, async_client_main: InfrahubClient
     ) -> None: