moving provision state synchronization logic to sensor-ironic-oslo-event.yaml from sensor-ironic-node-update.yaml

Author: syedhaseebahmed

components/site-workflows/sensors/sensor-ironic-node-update.yaml

@@ -11,7 +11,6 @@ metadata:
       - baremetal.node.create.end which happens when a baremetal node is created
       - baremetal.node.update.end which happens when node fields are updated
       - baremetal.node.delete.end which happens when a node is deleted
-      - baremetal.node.provision_set.end which happens after a state change on the node
 
       Resulting code should be very similar to:
 
@@ -41,7 +40,6 @@ spec:
             - "baremetal.node.create.end"
             - "baremetal.node.update.end"
             - "baremetal.node.delete.end"
-            - "baremetal.node.provision_set.end"
   template:
     serviceAccountName: sensor-submit-workflow
   triggers:

components/site-workflows/sensors/sensor-ironic-oslo-event.yaml

@@ -10,11 +10,16 @@ metadata:
 
       - baremetal.node.provision_set.end which happens after a state change on the node
 
+      This sensor handles ALL provision state changes. The event handlers internally
+      filter for specific states:
+      - deploying: Sets up storage (volume connectors) for instances with storage enabled
+      - inspecting: Updates Nautobot device with inspection data (inventory, ports)
+
       Resulting code should be very similar to:
 
       ```
       argo -n argo-events submit --from workflowtemplate/openstack-oslo-event \
-      -p event-json "JSON-payload" -p device_id=<UUID> -p project_id=<UUID>
+      -p event-json "JSON-payload"
       ```
 
       Defined in `components/site-workflows/sensors/sensor-ironic-oslo-event.yaml`
@@ -39,11 +44,6 @@ spec:
           type: "string"
           value:
             - "baremetal.node.provision_set.end"
-        - path: "body.ironic_object.previous_provision_state"
-          type: "string"
-          value:
-            - "deploying"
-            - "inspecting"
   template:
     serviceAccountName: sensor-submit-workflow
   triggers:
@@ -57,18 +57,14 @@ spec:
               src:
                 dataKey: body
                 dependencyName: ironic-dep
-            - dest: spec.arguments.parameters.1.value # device_id
+            - dest: spec.arguments.parameters.1.value # previous_provision_state
               src:
-                dataKey: body.ironic_object.uuid
+                dataKey: body.ironic_object.previous_provision_state
                 dependencyName: ironic-dep
             - dest: spec.arguments.parameters.2.value # project_id
               src:
                 dataKey: body.ironic_object.lessee
                 dependencyName: ironic-dep
-            - dest: spec.arguments.parameters.3.value # previous_provision_state
-              src:
-                dataKey: body.ironic_object.previous_provision_state
-                dependencyName: ironic-dep
           source:
             # create a workflow in argo-events prefixed with ironic-prov-
             resource:
@@ -84,9 +80,8 @@ spec:
                 arguments:
                   parameters:
                     - name: event-json
-                    - name: device_id
-                    - name: project_id
                     - name: previous_provision_state
+                    - name: project_id
                 templates:
                 - name: main
                   steps:

python/understack-workflows/tests/test_oslo_event_ironic_node.py

@@ -59,7 +59,7 @@ def test_from_event_dict_missing_uuid(self):
         """Test event parsing with missing UUID field."""
         event_data = {"payload": {"ironic_object.data": {"name": "test-node"}}}
 
-        with pytest.raises(ValueError):  # Pydantic will raise validation error
+        with pytest.raises(KeyError):  # KeyError when uuid is missing
             IronicNodeEvent.from_event_dict(event_data)
 
     def test_direct_initialization(self):
@@ -182,6 +182,7 @@ def valid_event_data(self):
                     "lessee": uuid.uuid4(),
                     "event": "provision_end",
                     "uuid": uuid.uuid4(),
+                    "previous_provision_state": "deploying",
                 }
             },
         }
@@ -322,9 +323,26 @@ def test_handle_provision_end_storage_metadata_missing(
         mock_server.metadata = {"other_key": "value"}
         mock_conn.get_server_by_id.return_value = mock_server
 
-        # This should raise a KeyError when accessing metadata["storage"]
-        with pytest.raises(KeyError):
-            handle_provision_end(mock_conn, mock_nautobot, valid_event_data)
+        # When storage key is missing, it should treat it as "not-set"
+        result = handle_provision_end(mock_conn, mock_nautobot, valid_event_data)
+
+        assert result == 0
+        ironic_data = valid_event_data["payload"]["ironic_object.data"]
+        instance_uuid = ironic_data["instance_uuid"]
+        node_uuid = ironic_data["uuid"]
+
+        mock_conn.get_server_by_id.assert_called_once_with(instance_uuid)
+
+        # Check save_output calls - storage should be "not-set" when key is missing
+        expected_calls = [
+            ("storage", "not-set"),
+            ("node_uuid", str(node_uuid)),
+            ("instance_uuid", str(instance_uuid)),
+        ]
+        actual_calls = [call.args for call in mock_save_output.call_args_list]
+        assert actual_calls == expected_calls
+
+        mock_create_connector.assert_called_once()
 
     @patch("understack_workflows.oslo_event.ironic_node.is_project_svm_enabled")
     def test_handle_provision_end_invalid_event_data(