using enriched data updated by inspect hooks from both agent and redfish interfaces

Author: syedhaseebahmed

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

@@ -8,18 +8,16 @@ metadata:
     workflows.argoproj.io/description: |+
       Triggers on the following Ironic Events:
 
+      - 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
-      - baremetal.node.update.end which happens when node fields are updated.
-
-      Currently parses out the following fields:
-
-      - provision_state
 
       Resulting code should be very similar to:
 
       ```
-      argo -n argo-events submit --from workflowtemplate/sync-provision-state-to-nautobot \
-      -p device_uuid=00000000-0000-0000-0000-000000000000 -p provision_state=available
+      argo -n argo-events submit --from workflowtemplate/openstack-oslo-event \
+      -p event-json "JSON-payload"
       ```
 
       Defined in `workflows/argo-events/sensors/ironic-node-update.yaml`
@@ -30,15 +28,19 @@ spec:
     name: ironic-dep
     transform:
       # the event is a string-ified JSON so we need to decode it
-      jq: ".body[\"oslo.message\"] | fromjson"
+      # replace the whole event body
+      jq: |
+        .body = (.body["oslo.message"] | fromjson)
     filters:
       # applies each of the items in data with 'and' but there's only one
       dataLogicalOperator: "and"
       data:
-        - path: "event_type"
+        - path: "body.event_type"
           type: "string"
           value:
+            - "baremetal.node.create.end"
             - "baremetal.node.update.end"
+            - "baremetal.node.delete.end"
             - "baremetal.node.provision_set.end"
   template:
     serviceAccountName: sensor-submit-workflow
@@ -49,25 +51,10 @@ spec:
         k8s:
           operation: create
           parameters:
-            # first parameter's value is replaced with the uuid
+            # first parameter is the parsed oslo.message
             - dest: spec.arguments.parameters.0.value
               src:
-                dataKey: payload.ironic_object\.data.uuid
-                dependencyName: ironic-dep
-            # second parameter's value is replaced with the provision_state
-            - dest: spec.arguments.parameters.1.value
-              src:
-                dataKey: payload.ironic_object\.data.provision_state
-                dependencyName: ironic-dep
-            # third parameter's value is replaced with the lessee
-            - dest: spec.arguments.parameters.2.value
-              src:
-                dataKey: payload.ironic_object\.data.lessee
-                dependencyName: ironic-dep
-            # fourth parameter's value is replaced with the resource_class
-            - dest: spec.arguments.parameters.3.value
-              src:
-                dataKey: payload.ironic_object\.data.resource_class
+                dataKey: body
                 dependencyName: ironic-dep
           source:
             # create a workflow in argo-events prefixed with ironic-node-update-
@@ -81,10 +68,7 @@ spec:
                 # defines the parameters being replaced above
                 arguments:
                   parameters:
-                    - name: device_uuid
-                    - name: provision_state
-                    - name: lessee
-                    - name: resource_class
+                    - name: event-json
                 # references the workflow
                 workflowTemplateRef:
-                  name: sync-provision-state-to-nautobot
+                  name: openstack-oslo-event

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

@@ -13,11 +13,11 @@ metadata:
       Resulting code should be very similar to:
 
       ```
-      argo -n argo-events submit --from workflowtemplate/ironic-oslo-event \
+      argo -n argo-events submit --from workflowtemplate/openstack-oslo-event \
       -p event-json "JSON-payload" -p device_id=<UUID> -p project_id=<UUID>
       ```
 
-      Defined in `workflows/argo-events/sensors/sensor-ironic-oslo-event.yaml`
+      Defined in `components/site-workflows/sensors/sensor-ironic-oslo-event.yaml`
 spec:
   dependencies:
   - eventName: openstack
@@ -43,6 +43,7 @@ spec:
           type: "string"
           value:
             - "deploying"
+            - "inspecting"
   template:
     serviceAccountName: sensor-submit-workflow
   triggers:
@@ -64,6 +65,10 @@ spec:
               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:
@@ -81,6 +86,7 @@ spec:
                     - name: event-json
                     - name: device_id
                     - name: project_id
+                    - name: previous_provision_state
                 templates:
                 - name: main
                   steps:
@@ -93,6 +99,7 @@ spec:
                         - name: event-json
                           value: "{{workflow.parameters.event-json}}"
                     - name: convert-project-id
+                      when: "\"{{workflow.parameters.previous_provision_state}}\" == deploying"
                       inline:
                         script:
                           image: python:alpine
@@ -102,7 +109,7 @@ spec:
                               project_id_without_dashes = "{{workflow.parameters.project_id}}"
                               print(str(uuid.UUID(project_id_without_dashes)))
                   - - name: ansible-storage-update
-                      when: "\"{{steps.oslo-events.outputs.parameters.storage}}\" == wanted"
+                      when: "\"{{steps.oslo-events.outputs.parameters.storage}}\" == wanted && \"{{workflow.parameters.previous_provision_state}}\" == deploying"
                       templateRef:
                         name: ansible-workflow-template
                         template: ansible-run

python/understack-workflows/tests/test_oslo_event_ironic_node.py

@@ -5,12 +5,70 @@
 
 import pytest
 
+from understack_workflows.oslo_event.ironic_node import IronicNodeEvent
 from understack_workflows.oslo_event.ironic_node import IronicProvisionSetEvent
 from understack_workflows.oslo_event.ironic_node import create_volume_connector
 from understack_workflows.oslo_event.ironic_node import handle_provision_end
 from understack_workflows.oslo_event.ironic_node import instance_nqn
 
 
+class TestIronicNodeEvent:
+    """Test cases for IronicNodeEvent class."""
+
+    def test_from_event_dict_success(self):
+        """Test successful node event parsing."""
+        event_data = {
+            "payload": {
+                "ironic_object.data": {
+                    "uuid": "test-uuid-123",
+                    "name": "test-node",
+                    "provision_state": "available",
+                }
+            }
+        }
+
+        event = IronicNodeEvent.from_event_dict(event_data)
+
+        assert event.uuid == "test-uuid-123"
+
+    def test_from_event_dict_minimal_data(self):
+        """Test parsing with only required UUID field."""
+        event_data = {"payload": {"ironic_object.data": {"uuid": "minimal-uuid"}}}
+
+        event = IronicNodeEvent.from_event_dict(event_data)
+
+        assert event.uuid == "minimal-uuid"
+
+    def test_from_event_dict_no_payload(self):
+        """Test event parsing with missing payload."""
+        event_data = {}
+
+        with pytest.raises(ValueError, match="Invalid event. No 'payload'"):
+            IronicNodeEvent.from_event_dict(event_data)
+
+    def test_from_event_dict_no_ironic_object_data(self):
+        """Test event parsing with missing ironic_object.data."""
+        event_data = {"payload": {"other_field": "value"}}
+
+        with pytest.raises(
+            ValueError, match="Invalid event. No 'ironic_object.data' in payload"
+        ):
+            IronicNodeEvent.from_event_dict(event_data)
+
+    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
+            IronicNodeEvent.from_event_dict(event_data)
+
+    def test_direct_initialization(self):
+        """Test direct initialization of IronicNodeEvent."""
+        event = IronicNodeEvent(uuid="direct-uuid")
+
+        assert event.uuid == "direct-uuid"
+
+
 class TestIronicProvisionSetEvent:
     """Test cases for IronicProvisionSetEvent class."""