svm handling: cleanup SVM and volume when project is deleted

This behaves more or less the same as removal of the UNDERSTACK_SVM tag

Author: skrobul

python/understack-workflows/tests/test_keystone_project.py

@@ -10,6 +10,7 @@
 from understack_workflows.oslo_event.keystone_project import KeystoneProjectEvent
 from understack_workflows.oslo_event.keystone_project import _keystone_project_tags
 from understack_workflows.oslo_event.keystone_project import handle_project_created
+from understack_workflows.oslo_event.keystone_project import handle_project_deleted
 from understack_workflows.oslo_event.keystone_project import handle_project_updated
 
 
@@ -593,3 +594,133 @@ def test_handle_project_updated_output_files_written(
                 call("/var/run/argo/output.svm_name", "w"),
             ]
             mock_open.assert_has_calls(expected_calls, any_order=True)
+
+
+class TestHandleProjectDeleted:
+    """Test cases for handle_project_deleted function."""
+
+    @pytest.fixture
+    def mock_conn(self):
+        """Create a mock OpenStack connection."""
+        return MagicMock()
+
+    @pytest.fixture
+    def mock_nautobot(self):
+        """Create a mock Nautobot instance."""
+        return MagicMock()
+
+    @pytest.fixture
+    def valid_delete_event_data(self):
+        """Create valid delete event data for testing."""
+        return {
+            "event_type": "identity.project.deleted",
+            "payload": {"target": {"id": "test-project-123"}},
+        }
+
+    def test_handle_project_deleted_wrong_event_type(self, mock_conn, mock_nautobot):
+        """Test handling event with wrong event type."""
+        event_data = {
+            "event_type": "identity.project.created",
+            "payload": {"target": {"id": "test-project-123"}},
+        }
+
+        result = handle_project_deleted(mock_conn, mock_nautobot, event_data)
+        assert result == 1
+
+    @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
+    def test_handle_project_deleted_svm_exists(
+        self,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_delete_event_data,
+    ):
+        """Test project deletion when SVM exists."""
+        mock_netapp_manager = MagicMock()
+        mock_netapp_manager.check_if_svm_exists.return_value = True
+        mock_netapp_class.return_value = mock_netapp_manager
+
+        result = handle_project_deleted(
+            mock_conn, mock_nautobot, valid_delete_event_data
+        )
+
+        assert result == 0
+        mock_netapp_manager.check_if_svm_exists.assert_called_once_with(
+            project_id="test-project-123"
+        )
+        mock_netapp_manager.cleanup_project.assert_called_once_with("test-project-123")
+
+    @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
+    def test_handle_project_deleted_svm_does_not_exist(
+        self,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_delete_event_data,
+    ):
+        """Test project deletion when SVM does not exist."""
+        mock_netapp_manager = MagicMock()
+        mock_netapp_manager.check_if_svm_exists.return_value = False
+        mock_netapp_class.return_value = mock_netapp_manager
+
+        result = handle_project_deleted(
+            mock_conn, mock_nautobot, valid_delete_event_data
+        )
+
+        assert result == 0
+        mock_netapp_manager.check_if_svm_exists.assert_called_once_with(
+            project_id="test-project-123"
+        )
+        mock_netapp_manager.cleanup_project.assert_not_called()
+
+    @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
+    def test_handle_project_deleted_netapp_manager_failure(
+        self,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_delete_event_data,
+    ):
+        """Test handling when NetAppManager creation fails during deletion."""
+        mock_netapp_class.side_effect = Exception("NetApp connection failed")
+
+        result = handle_project_deleted(
+            mock_conn, mock_nautobot, valid_delete_event_data
+        )
+
+        assert result == 1  # Should return 1 on exception
+        mock_netapp_class.assert_called_once()
+
+    @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
+    def test_handle_project_deleted_cleanup_failure(
+        self,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_delete_event_data,
+    ):
+        """Test handling when cleanup_project fails during deletion."""
+        mock_netapp_manager = MagicMock()
+        mock_netapp_manager.check_if_svm_exists.return_value = True
+        mock_netapp_manager.cleanup_project.side_effect = Exception("Cleanup failed")
+        mock_netapp_class.return_value = mock_netapp_manager
+
+        result = handle_project_deleted(
+            mock_conn, mock_nautobot, valid_delete_event_data
+        )
+
+        assert result == 1  # Should return 1 on exception
+        mock_netapp_manager.check_if_svm_exists.assert_called_once_with(
+            project_id="test-project-123"
+        )
+        mock_netapp_manager.cleanup_project.assert_called_once_with("test-project-123")
+
+    def test_handle_project_deleted_invalid_event_data(self, mock_conn, mock_nautobot):
+        """Test handling deletion with invalid event data."""
+        invalid_event_data = {
+            "event_type": "identity.project.deleted",
+            "payload": {},  # Missing target
+        }
+
+        with pytest.raises(Exception, match="no target information in payload"):
+            handle_project_deleted(mock_conn, mock_nautobot, invalid_event_data)

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

@@ -66,6 +66,7 @@ class NoEventHandlerError(Exception):
     "baremetal.port.delete.end": ironic_port.handle_port_delete,
     "identity.project.created": keystone_project.handle_project_created,
     "identity.project.updated": keystone_project.handle_project_updated,
+    "identity.project.deleted": keystone_project.handle_project_deleted,
 }
 
 

python/understack-workflows/understack_workflows/oslo_event/keystone_project.py

@@ -118,6 +118,31 @@ def handle_project_updated(
     return 0
 
 
+def handle_project_deleted(
+    conn: Connection, _nautobot: Nautobot, event_data: dict
+) -> int:
+    if event_data.get("event_type") != "identity.project.deleted":
+        logger.error("Received event that is not identity.project.deleted")
+        return 1
+
+    event = KeystoneProjectEvent.from_event_dict(event_data)
+    logger.info("Starting ONTAP SVM and Volume delete workflow.")
+    try:
+        netapp_manager = NetAppManager()
+        svm_exists = netapp_manager.check_if_svm_exists(project_id=event.project_id)
+
+        if svm_exists:
+            logger.info("SVM for project %s exists - cleaning it up.", event.project_id)
+            netapp_manager.cleanup_project(event.project_id)
+        else:
+            logger.info("SVM for project %s did not exist.", event.project_id)
+        _save_output("svm_created", str(False))
+    except Exception as e:
+        logger.error(e)
+        return 1
+    return 0
+
+
 def _create_svm_and_volume(netapp_manager, event) -> str:
     svm_name = netapp_manager.create_svm(
         project_id=event.project_id, aggregate_name=AGGREGATE_NAME

workflows/openstack/sensors/sensor-keystone-oslo-event.yaml

@@ -10,7 +10,7 @@ metadata:
 
       - identity.project.created
       - identity.project.updated
-      - other events are silently ignored now
+      - identity.project.deleted
 
       Resulting code should be very similar to:
 
@@ -39,6 +39,7 @@ spec:
           value:
             - "identity.project.created"
             - "identity.project.updated"
+            - "identity.project.deleted"
   template:
     serviceAccountName: sensor-submit-workflow
   triggers: