Syncs UCVNIs, IPAM namespaces, and prefixes

Adds ability to run Neutron resync before Ironic resync to ensure IPAM data exists in Nautobot.

Author: syedhaseebahmed

python/understack-workflows/pyproject.toml

@@ -40,6 +40,7 @@ netapp-create-svm = "understack_workflows.main.netapp_create_svm:main"
 openstack-oslo-event = "understack_workflows.main.openstack_oslo_event:main"
 resync-ironic-nautobot = "understack_workflows.main.resync_ironic_to_nautobot:main"
 resync-keystone-nautobot = "understack_workflows.main.resync_keystone_to_nautobot:main"
+resync-neutron-nautobot = "understack_workflows.main.resync_neutron_to_nautobot:main"
 sync-keystone = "understack_workflows.main.sync_keystone:main"
 sync-network-segment-range = "understack_workflows.main.sync_ucvni_group_range:main"
 undersync-switch = "understack_workflows.main.undersync_switch:main"

python/understack-workflows/tests/test_oslo_event_neutron_network.py

@@ -33,6 +33,13 @@ def test_handle_network_create(network_create_event_data):
     mock_nautobot = Mock()
     mock_nautobot.ipam.namespaces.create.return_value = "123"
 
+    # Mock update to return 404 so create path is taken
+    mock_pynautobot_req = Mock()
+    mock_pynautobot_req.status_code = 404
+    mock_nautobot.plugins.undercloud_vni.ucvnis.update.side_effect = (
+        pynautobot.RequestError(mock_pynautobot_req)
+    )
+
     result = neutron_network.handle_network_create_or_update(
         None, mock_nautobot, network_create_event_data, ucvni_group_name="FOO"
     )
@@ -59,7 +66,8 @@ def test_handle_network_create(network_create_event_data):
 
 def test_handle_network_update(network_update_event_data):
     mock_nautobot = Mock()
-    mock_nautobot.ipam.namespaces.update.return_value = "123"
+    mock_nautobot.ipam.namespaces.create.return_value = "123"
+    mock_nautobot.plugins.undercloud_vni.ucvnis.update.return_value = "updated"
 
     result = neutron_network.handle_network_create_or_update(
         None, mock_nautobot, network_update_event_data, ucvni_group_name="FOO"
@@ -68,9 +76,9 @@ def test_handle_network_update(network_update_event_data):
     mock_nautobot.ipam.namespaces.create.assert_called_once_with(
         name="f4aa4b99-2c2f-4698-a2f0-ac9920b1ee81"
     )
-    mock_nautobot.plugins.undercloud_vni.ucvnis.create.assert_called_once_with(
-        {
-            "id": "f4aa4b99-2c2f-4698-a2f0-ac9920b1ee81",
+    mock_nautobot.plugins.undercloud_vni.ucvnis.update.assert_called_once_with(
+        id="f4aa4b99-2c2f-4698-a2f0-ac9920b1ee81",
+        data={
             "name": "service-net",
             "status": {
                 "name": "Active",

python/understack-workflows/tests/test_resync_ironic_to_nautobot.py

@@ -15,18 +15,7 @@ class TestArgumentParser:
     def test_default_args(self):
         parser = argument_parser()
         args = parser.parse_args([])
-        assert args.node is None
-        assert args.dry_run is False
-
-    def test_node_arg(self):
-        parser = argument_parser()
-        args = parser.parse_args(["--node", "test-uuid"])
-        assert args.node == "test-uuid"
-
-    def test_dry_run_arg(self):
-        parser = argument_parser()
-        args = parser.parse_args(["--dry-run"])
-        assert args.dry_run is True
+        assert args.nautobot_url is not None or args.nautobot_token is None
 
 
 class TestSyncNodes:
@@ -59,15 +48,15 @@ def test_sync_single_node(self, mock_sync, mock_ironic_class):
         mock_ironic = MagicMock()
         mock_ironic_class.return_value = mock_ironic
         mock_node = MagicMock(uuid="uuid-1", name="node-1")
-        mock_ironic.get_node.return_value = mock_node
+        mock_ironic.list_nodes.return_value = [mock_node]
         mock_sync.return_value = 0
 
         nautobot = MagicMock()
-        result = sync_nodes(nautobot, node_uuid="uuid-1")
+        result = sync_nodes(nautobot)
 
         assert result.total == 1
         assert result.failed == 0
-        mock_ironic.get_node.assert_called_once_with("uuid-1")
+        mock_ironic.list_nodes.assert_called_once()
 
     @patch("understack_workflows.main.resync_ironic_to_nautobot.IronicClient")
     @patch(
@@ -89,16 +78,18 @@ def test_sync_with_failures(self, mock_sync, mock_ironic_class):
         assert result.succeeded == 1
 
     @patch("understack_workflows.main.resync_ironic_to_nautobot.IronicClient")
-    def test_dry_run_skips_sync(self, mock_ironic_class):
+    @patch(
+        "understack_workflows.main.resync_ironic_to_nautobot.sync_device_to_nautobot"
+    )
+    def test_sync_no_nodes(self, mock_sync, mock_ironic_class):
         mock_ironic = MagicMock()
         mock_ironic_class.return_value = mock_ironic
-        mock_node = MagicMock(uuid="uuid-1", name="node-1")
-        mock_ironic.list_nodes.return_value = [mock_node]
+        mock_ironic.list_nodes.return_value = []
 
         nautobot = MagicMock()
-        result = sync_nodes(nautobot, dry_run=True)
+        result = sync_nodes(nautobot)
 
-        assert result.total == 1
+        assert result.total == 0
         assert result.failed == 0
 
 

python/understack-workflows/tests/test_resync_keystone_to_nautobot.py

@@ -34,18 +34,7 @@ class TestArgumentParser:
     def test_default_args(self):
         parser = argument_parser()
         args = parser.parse_args([])
-        assert args.project is None
-        assert args.dry_run is False
-
-    def test_project_arg(self):
-        parser = argument_parser()
-        args = parser.parse_args(["--project", "test-uuid"])
-        assert args.project == "test-uuid"
-
-    def test_dry_run_arg(self):
-        parser = argument_parser()
-        args = parser.parse_args(["--dry-run"])
-        assert args.dry_run is True
+        assert args.nautobot_url is not None or args.nautobot_token is None
 
 
 class TestSyncProjects:
@@ -85,23 +74,19 @@ def test_sync_single_project(self):
             name="project-1",
             is_domain=False,
         )
-        conn.identity.get_project.return_value = project
+        conn.identity.projects.return_value = [project]
 
         nautobot = MagicMock()
 
         with patch(
             "understack_workflows.main.resync_keystone_to_nautobot.handle_project_update"
         ) as mock_update:
             mock_update.return_value = 0
-            result = sync_projects(
-                conn, nautobot, project_uuid="12345678-1234-5678-1234-567812345678"
-            )
+            result = sync_projects(conn, nautobot)
 
         assert result.total == 1
         assert result.failed == 0
-        conn.identity.get_project.assert_called_once_with(
-            "12345678-1234-5678-1234-567812345678"
-        )
+        conn.identity.projects.assert_called_once()
 
     def test_sync_with_failures(self):
         conn = MagicMock()
@@ -156,21 +141,16 @@ def test_sync_skips_domains(self):
         assert result.succeeded == 1
         mock_update.assert_called_once()
 
-    def test_dry_run_skips_sync(self):
+    def test_sync_no_projects(self):
         conn = MagicMock()
-        project = MagicMock(id="uuid-1", name="project-1", is_domain=False)
-        conn.identity.projects.return_value = [project]
+        conn.identity.projects.return_value = []
 
         nautobot = MagicMock()
 
-        with patch(
-            "understack_workflows.main.resync_keystone_to_nautobot.handle_project_update"
-        ) as mock_update:
-            result = sync_projects(conn, nautobot, dry_run=True)
+        result = sync_projects(conn, nautobot)
 
-        assert result.total == 1
+        assert result.total == 0
         assert result.failed == 0
-        mock_update.assert_not_called()
 
 
 class TestMain:

python/understack-workflows/understack_workflows/main/resync_ironic_to_nautobot.py

@@ -11,48 +11,30 @@
 
 import pynautobot
 
+from understack_workflows.helpers import parser_nautobot_args
 from understack_workflows.helpers import setup_logger
 from understack_workflows.ironic.client import IronicClient
 from understack_workflows.oslo_event.nautobot_device_sync import sync_device_to_nautobot
 from understack_workflows.resync import SyncResult
 from understack_workflows.resync import get_nautobot_client
 from understack_workflows.resync import log_sync_result
-from understack_workflows.resync import parser_resync_args
 
 logger = logging.getLogger(__name__)
 
 
 def argument_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(description="Resync Ironic nodes to Nautobot")
-    return parser_resync_args(parser, item_name="node", item_flag="--node")
+    return parser_nautobot_args(parser)
 
 
-def sync_nodes(
-    nautobot: pynautobot.api,
-    node_uuid: str | None = None,
-    dry_run: bool = False,
-) -> SyncResult:
-    """Sync Ironic nodes to Nautobot.
-
-    Args:
-        nautobot: Nautobot API instance
-        node_uuid: Optional specific node UUID to sync (syncs all if None)
-        dry_run: If True, only log what would be synced
-
-    Returns:
-        SyncResult with total and failed counts
-    """
+def sync_nodes(nautobot: pynautobot.api) -> SyncResult:
+    """Sync Ironic nodes to Nautobot."""
     ironic = IronicClient()
-    nodes = [ironic.get_node(node_uuid)] if node_uuid else ironic.list_nodes()
+    nodes = ironic.list_nodes()
     result = SyncResult()
 
     for node in nodes:
         result.total += 1
-
-        if dry_run:
-            logger.info("Would sync node: %s (%s)", node.uuid, node.name)
-            continue
-
         logger.info("Syncing node: %s (%s)", node.uuid, node.name)
         if sync_device_to_nautobot(node.uuid, nautobot) != 0:
             result.failed += 1
@@ -66,6 +48,6 @@ def main() -> int:
     args = argument_parser().parse_args()
 
     nautobot = get_nautobot_client(args)
-    result = sync_nodes(nautobot, args.node or None, args.dry_run)
+    result = sync_nodes(nautobot)
 
-    return log_sync_result(result, "node", args.dry_run)
+    return log_sync_result(result, "node")

python/understack-workflows/understack_workflows/main/resync_keystone_to_nautobot.py

@@ -12,6 +12,7 @@
 
 import pynautobot
 
+from understack_workflows.helpers import parser_nautobot_args
 from understack_workflows.helpers import setup_logger
 from understack_workflows.main.sync_keystone import handle_project_update
 from understack_workflows.main.sync_keystone import is_domain
@@ -20,7 +21,6 @@
 from understack_workflows.resync import SyncResult
 from understack_workflows.resync import get_nautobot_client
 from understack_workflows.resync import log_sync_result
-from understack_workflows.resync import parser_resync_args
 
 logger = logging.getLogger(__name__)
 
@@ -29,32 +29,13 @@ def argument_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         description="Resync Keystone projects to Nautobot tenants"
     )
-    return parser_resync_args(parser, item_name="project", item_flag="--project")
-
-
-def sync_projects(
-    conn: Connection,
-    nautobot: pynautobot.api,
-    project_uuid: str | None = None,
-    dry_run: bool = False,
-) -> SyncResult:
-    """Sync Keystone projects to Nautobot tenants.
-
-    Args:
-        conn: OpenStack connection
-        nautobot: Nautobot API instance
-        project_uuid: Optional specific project UUID to sync (syncs all if None)
-        dry_run: If True, only log what would be synced
-
-    Returns:
-        SyncResult with total, failed, and skipped counts
-    """
-    result = SyncResult()
+    return parser_nautobot_args(parser)
+
 
-    if project_uuid:
-        projects = [conn.identity.get_project(project_uuid)]  # pyright: ignore[reportAttributeAccessIssue]
-    else:
-        projects = list(conn.identity.projects())  # pyright: ignore[reportAttributeAccessIssue]
+def sync_projects(conn: Connection, nautobot: pynautobot.api) -> SyncResult:
+    """Sync Keystone projects to Nautobot tenants."""
+    result = SyncResult()
+    projects = list(conn.identity.projects())  # pyright: ignore[reportAttributeAccessIssue]
 
     for project in projects:
         result.total += 1
@@ -64,10 +45,6 @@ def sync_projects(
             result.skipped += 1
             continue
 
-        if dry_run:
-            logger.info("Would sync project: %s (%s)", project.id, project.name)
-            continue
-
         logger.info("Syncing project: %s (%s)", project.id, project.name)
         if handle_project_update(conn, nautobot, uuid.UUID(project.id)) != 0:
             result.failed += 1
@@ -82,6 +59,6 @@ def main() -> int:
 
     conn = get_openstack_client()
     nautobot = get_nautobot_client(args)
-    result = sync_projects(conn, nautobot, args.project or None, args.dry_run)
+    result = sync_projects(conn, nautobot)
 
-    return log_sync_result(result, "project", args.dry_run)
+    return log_sync_result(result, "project")