Merge pull request #1172 from rackerlabs/trigger-ansible-on-svm

cardoe · web-flow · commit 8490db613237 · 2025-08-21T16:51:23.000Z
feat: Trigger Ansible on SVM creation
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -116,4 +116,4 @@ repos:
         # entry: bash -c 'trufflehog --no-update git file://. --since-commit HEAD --results=verified,unknown --fail'
         entry: bash -c 'docker run --rm -v "$(pwd):/workdir" -i --rm trufflesecurity/trufflehog:latest git file:///workdir --since-commit HEAD --results=verified,unknown --fail'
         language: system
-        stages: ["pre-commit", "pre-push"]
+        stages: ["pre-push"]
diff --git a/python/understack-workflows/pyproject.toml b/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]
diff --git a/python/understack-workflows/tests/test_keystone_project.py b/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()
diff --git a/python/understack-workflows/understack_workflows/oslo_event/keystone_project.py b/python/understack-workflows/understack_workflows/oslo_event/keystone_project.py
@@ -11,7 +11,8 @@
 
 SVM_PROJECT_TAG = "UNDERSTACK_SVM"
 AGGREGATE_NAME = "aggr02_n02_NVME"
-VOLUME_SIZE = "1GB"
+VOLUME_SIZE = "514GB"
+OUTPUT_BASE_PATH = "/var/run/argo"
 
 
 @dataclass
@@ -47,23 +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)
-        exit(0)
-
-    netapp_manager = NetAppManager()
-    netapp_manager.create_svm(
-        project_id=event.project_id, aggregate_name=AGGREGATE_NAME
-    )
-    netapp_manager.create_volume(
-        project_id=event.project_id,
-        volume_size=VOLUME_SIZE,
-        aggregate_name=AGGREGATE_NAME,
-    )
+        return 0
+
+    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"
+        _save_output("svm_name", svm_name)
     return 0
+
+
+def _save_output(name, value):
+    with open(f"{OUTPUT_BASE_PATH}/output.{name}", "w") as f:
+        return f.write(value)
diff --git a/scripts/delete_volumes_and_svms_netapp.py b/scripts/delete_volumes_and_svms_netapp.py
@@ -0,0 +1,128 @@
+#!/usr/bin/env python3
+
+import argparse
+import os
+import requests
+import sys
+import urllib3
+from requests.auth import HTTPBasicAuth
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+
+def delete_volume(hostname, login, password, project_id):
+    """Delete volume named vol_$project_id"""
+    volume_name = f"vol_{project_id}"
+    url = f"https://{hostname}/api/storage/volumes"
+
+    # First, find the volume by name
+    params = {"name": volume_name}
+    response = requests.get(
+        url, auth=HTTPBasicAuth(login, password), params=params, verify=False
+    )
+
+    if response.status_code != 200:
+        print(
+            f"Error finding volume {volume_name}: {response.status_code} - {response.text}"
+        )
+        return False
+
+    volumes = response.json().get("records", [])
+    if not volumes:
+        print(f"Volume {volume_name} not found")
+        return False
+
+    volume_uuid = volumes[0]["uuid"]
+
+    # Delete the volume
+    delete_url = f"{url}/{volume_uuid}"
+    response = requests.delete(
+        delete_url, auth=HTTPBasicAuth(login, password), verify=False
+    )
+
+    if response.status_code == 202:
+        print(f"Volume {volume_name} deletion initiated successfully")
+        return True
+    else:
+        print(
+            f"Error deleting volume {volume_name}: {response.status_code} - {response.text}"
+        )
+        return False
+
+
+def delete_svm(hostname, login, password, project_id):
+    """Delete SVM named os-$project_id"""
+    svm_name = f"os-{project_id}"
+    url = f"https://{hostname}/api/svm/svms"
+
+    # First, find the SVM by name
+    params = {"name": svm_name}
+    response = requests.get(
+        url, auth=HTTPBasicAuth(login, password), params=params, verify=False
+    )
+
+    if response.status_code != 200:
+        print(f"Error finding SVM {svm_name}: {response.status_code} - {response.text}")
+        return False
+
+    svms = response.json().get("records", [])
+    if not svms:
+        print(f"SVM {svm_name} not found")
+        return False
+
+    svm_uuid = svms[0]["uuid"]
+
+    # Delete the SVM
+    delete_url = f"{url}/{svm_uuid}"
+    response = requests.delete(
+        delete_url, auth=HTTPBasicAuth(login, password), verify=False
+    )
+
+    if response.status_code == 202:
+        print(f"SVM {svm_name} deletion initiated successfully")
+        return True
+    else:
+        print(
+            f"Error deleting SVM {svm_name}: {response.status_code} - {response.text}"
+        )
+        return False
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Delete NetApp ONTAP volume and SVM for a project"
+    )
+    parser.add_argument("project_id", help="Project ID")
+
+    args = parser.parse_args()
+
+    # Get credentials from environment variables
+    hostname = os.getenv("NETAPP_HOST")
+    login = os.getenv("NETAPP_LOGIN")
+    password = os.getenv("NETAPP_PASSWORD")
+
+    if not hostname or not login or not password:
+        print(
+            "Error: NETAPP_HOST, NETAPP_LOGIN, and NETAPP_PASSWORD environment variables must be set"
+        )
+        sys.exit(1)
+
+    print(f"Deleting resources for project: {args.project_id}")
+    print(f"Connecting to ONTAP: {hostname}")
+
+    # Delete volume first
+    volume_success = delete_volume(hostname, login, password, args.project_id)
+
+    # Delete SVM
+    svm_success = delete_svm(hostname, login, password, args.project_id)
+
+    if volume_success and svm_success:
+        print("All resources deleted successfully")
+        sys.exit(0)
+    else:
+        print("Some resources failed to delete")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/workflows/argo-events/workflowtemplates/openstack-oslo-event.yaml b/workflows/argo-events/workflowtemplates/openstack-oslo-event.yaml
@@ -62,3 +62,11 @@ spec:
         - name: netapp-ini
           secret:
             secretName: netapp-config
+      outputs:
+        parameters:
+          - name: exit_code
+            valueFrom:
+              path: /var/run/argo/output.exit_code
+          - name: msg
+            valueFrom:
+              path: /var/run/argo/output.msg
diff --git a/workflows/openstack/sensors/sensor-keystone-oslo-event.yaml b/workflows/openstack/sensors/sensor-keystone-oslo-event.yaml

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,9 @@ testpaths = [`
`74`	`74`	`]`
`75`	`75`	`filterwarnings = [`
`76`	`76`	`# sushy`
`77`		`- "ignore:pkg_resources is deprecated as an API.:DeprecationWarning"`
	`77`	`+ "ignore:pkg_resources is deprecated as an API.:DeprecationWarning",`
	`78`	`+ # netapp`
	`79`	+ "ignore:.Number` field should not be instantiated."
`78`	`80`	`]`
`79`	`81`
`80`	`82`	`[tool.ruff]`