unify the outputs and behaviors

- no direct exit() calls, these are handled by oslo_event processor
- always save the svm_enabled output so it can be relied upon later

Author: skrobul

python/understack-workflows/pyproject.toml

@@ -74,7 +74,9 @@ testpaths = [
 ]
 filterwarnings = [
   # sushy
-  "ignore:pkg_resources is deprecated as an API.:DeprecationWarning"
+  "ignore:pkg_resources is deprecated as an API.:DeprecationWarning",
+  # netapp
+  "ignore:.*Number` field should not be instantiated.*"
 ]
 
 [tool.ruff]

python/understack-workflows/tests/test_keystone_project.py

@@ -123,22 +123,29 @@ def test_handle_project_created_wrong_event_type(self, mock_conn, mock_nautobot)
         assert result == 1
 
     @patch("understack_workflows.oslo_event.keystone_project._keystone_project_tags")
+    @patch("builtins.open")
     def test_handle_project_created_no_svm_tag(
-        self, mock_tags, mock_conn, mock_nautobot, valid_event_data
+        self, mock_open, mock_tags, mock_conn, mock_nautobot, valid_event_data
     ):
         """Test handling project creation without SVM tag."""
         mock_tags.return_value = ["tag1", "tag2"]
 
-        with pytest.raises(SystemExit) as exc_info:
-            handle_project_created(mock_conn, mock_nautobot, valid_event_data)
-
-        assert exc_info.value.code == 0
+        result = handle_project_created(mock_conn, mock_nautobot, valid_event_data)
+        assert result == 0
         mock_tags.assert_called_once_with(mock_conn, "test-project-123")
+        mock_open.assert_called_with("/var/run/argo/output.svm_enabled", "w")
 
     @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
     @patch("understack_workflows.oslo_event.keystone_project._keystone_project_tags")
+    @patch("builtins.open")
     def test_handle_project_created_with_svm_tag(
-        self, mock_tags, mock_netapp_class, mock_conn, mock_nautobot, valid_event_data
+        self,
+        mock_open,
+        mock_tags,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_event_data,
     ):
         """Test successful project creation handling with SVM tag."""
         mock_tags.return_value = ["tag1", SVM_PROJECT_TAG, "tag2"]
@@ -158,11 +165,19 @@ def test_handle_project_created_with_svm_tag(
             volume_size=VOLUME_SIZE,
             aggregate_name=AGGREGATE_NAME,
         )
+        mock_open.assert_called()
 
     @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
     @patch("understack_workflows.oslo_event.keystone_project._keystone_project_tags")
+    @patch("builtins.open")
     def test_handle_project_created_netapp_manager_failure(
-        self, mock_tags, mock_netapp_class, mock_conn, mock_nautobot, valid_event_data
+        self,
+        mock_open,
+        mock_tags,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_event_data,
     ):
         """Test handling when NetAppManager creation fails."""
         mock_tags.return_value = [SVM_PROJECT_TAG]
@@ -173,11 +188,19 @@ def test_handle_project_created_netapp_manager_failure(
 
         mock_tags.assert_called_once_with(mock_conn, "test-project-123")
         mock_netapp_class.assert_called_once()
+        mock_open.assert_called()
 
     @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
     @patch("understack_workflows.oslo_event.keystone_project._keystone_project_tags")
+    @patch("builtins.open")
     def test_handle_project_created_svm_creation_failure(
-        self, mock_tags, mock_netapp_class, mock_conn, mock_nautobot, valid_event_data
+        self,
+        mock_open,
+        mock_tags,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_event_data,
     ):
         """Test handling when SVM creation fails."""
         mock_tags.return_value = [SVM_PROJECT_TAG]
@@ -196,8 +219,15 @@ def test_handle_project_created_svm_creation_failure(
 
     @patch("understack_workflows.oslo_event.keystone_project.NetAppManager")
     @patch("understack_workflows.oslo_event.keystone_project._keystone_project_tags")
+    @patch("builtins.open")
     def test_handle_project_created_volume_creation_failure(
-        self, mock_tags, mock_netapp_class, mock_conn, mock_nautobot, valid_event_data
+        self,
+        mock_open,
+        mock_tags,
+        mock_netapp_class,
+        mock_conn,
+        mock_nautobot,
+        valid_event_data,
     ):
         """Test handling when volume creation fails."""
         mock_tags.return_value = [SVM_PROJECT_TAG]
@@ -232,8 +262,9 @@ def test_handle_project_created_invalid_event_data(self, mock_conn, mock_nautobo
             handle_project_created(mock_conn, mock_nautobot, invalid_event_data)
 
     @patch("understack_workflows.oslo_event.keystone_project._keystone_project_tags")
+    @patch("builtins.open")
     def test_handle_project_created_constants_used(
-        self, mock_tags, mock_conn, mock_nautobot, valid_event_data
+        self, mock_open, mock_tags, mock_conn, mock_nautobot, valid_event_data
     ):
         """Test constants used for aggregate name and volume size."""
         mock_tags.return_value = [SVM_PROJECT_TAG]
@@ -253,6 +284,7 @@ def test_handle_project_created_constants_used(
             )
             mock_netapp_manager.create_volume.assert_called_once_with(
                 project_id="test-project-123",
-                volume_size="1GB",  # VOLUME_SIZE constant
+                volume_size="514GB",  # VOLUME_SIZE constant
                 aggregate_name="aggr02_n02_NVME",  # AGGREGATE_NAME constant
             )
+        mock_open.assert_called()

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

@@ -12,6 +12,7 @@
 SVM_PROJECT_TAG = "UNDERSTACK_SVM"
 AGGREGATE_NAME = "aggr02_n02_NVME"
 VOLUME_SIZE = "514GB"
+OUTPUT_BASE_PATH = "/var/run/argo"
 
 
 @dataclass
@@ -47,38 +48,39 @@ def handle_project_created(
     conn: Connection, _nautobot: Nautobot, event_data: dict
 ) -> int:
     if event_data.get("event_type") != "identity.project.created":
+        logger.error("Received event that is not identity.project.created")
         return 1
 
     event = KeystoneProjectEvent.from_event_dict(event_data)
     logger.info("Starting ONTAP SVM and Volume creation workflow.")
     tags = _keystone_project_tags(conn, event.project_id)
     logger.debug("Project %s has tags: %s", event.project_id, tags)
-    if SVM_PROJECT_TAG not in tags:
+
+    project_is_svm_enabled = SVM_PROJECT_TAG in tags
+    _save_output("svm_enabled", str(project_is_svm_enabled))
+
+    if not project_is_svm_enabled:
         logger.info("The %s is missing, not creating SVM.", SVM_PROJECT_TAG)
         return 0
 
-    netapp_manager = NetAppManager()
-    netapp_manager.create_svm(
-        project_id=event.project_id, aggregate_name=AGGREGATE_NAME
-    )
-    svm_name = netapp_manager.create_volume(
-        project_id=event.project_id,
-        volume_size=VOLUME_SIZE,
-        aggregate_name=AGGREGATE_NAME,
-    )
-    with open("/var/run/argo/output.svm_name", "w") as f:  # noqa: S108
+    svm_name = None
+    try:
+        netapp_manager = NetAppManager()
+        netapp_manager.create_svm(
+            project_id=event.project_id, aggregate_name=AGGREGATE_NAME
+        )
+        svm_name = netapp_manager.create_volume(
+            project_id=event.project_id,
+            volume_size=VOLUME_SIZE,
+            aggregate_name=AGGREGATE_NAME,
+        )
+    finally:
         if not svm_name:
             svm_name = "not_returned"
-
-        f.write(svm_name)
-
-    _save_result("success", 0)
+        _save_output("svm_name", svm_name)
     return 0
 
 
-def _save_result(msg, exit_code):
-    with open("/var/run/argo/output.msg", "w") as f:  # noqa: S108
-        f.write(msg)
-    with open("/var/run/argo/output.exit_code", "w") as f:  # noqa: S108
-        f.write(str(exit_code))
-    exit(exit_code)
+def _save_output(name, value):
+    with open(f"{OUTPUT_BASE_PATH}/output.{name}", "w") as f:
+        return f.write(value)