splunk-soar-sdk 2.1.0__tar.gz → 2.1.1__tar.gz

{splunk_soar_sdk-2.1.0 → splunk_soar_sdk-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.1.0
+Version: 2.1.1
 Summary: The official framework for developing and testing Splunk SOAR Apps
 Project-URL: Homepage, https://github.com/phantomcyber/splunk-soar-sdk
 Project-URL: Documentation, https://github.com/phantomcyber/splunk-soar-sdk

{splunk_soar_sdk-2.1.0 → splunk_soar_sdk-2.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "2.1.0"
+version = "2.1.1"
 description = "The official framework for developing and testing Splunk SOAR Apps"
 readme = "README.md"
 requires-python = ">=3.9, <3.14"

splunk_soar_sdk-2.1.1/release_notes.txt

@@ -0,0 +1,21 @@
+## [2.1.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.1.0...2.1.1) (2025-09-30)
+
+
+### Bug Fixes
+
+* list output fixes ([f1d9b89](https://github.com/phantomcyber/splunk-soar-sdk/commit/f1d9b8998cbed7a82e83b3813b7fa0b61de13180))
+
+
+
+
+
+## [2.1.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.1.0...2.1.1) (2025-09-30)
+
+
+### Bug Fixes
+
+* list output fixes ([f1d9b89](https://github.com/phantomcyber/splunk-soar-sdk/commit/f1d9b8998cbed7a82e83b3813b7fa0b61de13180))
+
+
+
+

splunk_soar_sdk-2.1.1/release_version.txt

@@ -0,0 +1 @@
+2.1.1

{splunk_soar_sdk-2.1.0 → splunk_soar_sdk-2.1.1}/src/soar_sdk/app.py

@@ -647,9 +647,17 @@ class App:
             statuses = []
             for item in result:
                 statuses.append(
-                    App._adapt_action_result(item, actions_manager, action_params)
+                    App._adapt_action_result(
+                        item, actions_manager, action_params, message, summary
+                    )
+                )
+            # Handle empty list/iterator case
+            if not statuses:
+                result = ActionOutput(
+                    status=True, message=message or "Action completed successfully"
                 )
-            return all(statuses)
+            else:
+                return all(statuses)
 
         if isinstance(result, ActionOutput):
             output_dict = result.dict(by_alias=True)

{splunk_soar_sdk-2.1.0 → splunk_soar_sdk-2.1.1}/tests/example_app/app.json

@@ -99,6 +99,82 @@
                 }
             ]
         },
+        {
+            "action": "test summary with list output",
+            "description": "test summary with list output",
+            "identifier": "test_summary_with_list_output",
+            "output": [
+                {
+                    "data_path": "action_result.status",
+                    "data_type": "string",
+                    "example_values": [
+                        "success",
+                        "failure"
+                    ]
+                },
+                {
+                    "data_path": "action_result.message",
+                    "data_type": "string"
+                },
+                {
+                    "data_path": "summary.total_objects",
+                    "data_type": "numeric",
+                    "example_values": [
+                        1
+                    ]
+                },
+                {
+                    "data_path": "summary.total_objects_successful",
+                    "data_type": "numeric",
+                    "example_values": [
+                        1
+                    ]
+                }
+            ],
+            "parameters": {},
+            "read_only": true,
+            "type": "generic",
+            "verbose": "",
+            "versions": "EQ(*)"
+        },
+        {
+            "action": "test empty list output",
+            "description": "test empty list output",
+            "identifier": "test_empty_list_output",
+            "output": [
+                {
+                    "data_path": "action_result.status",
+                    "data_type": "string",
+                    "example_values": [
+                        "success",
+                        "failure"
+                    ]
+                },
+                {
+                    "data_path": "action_result.message",
+                    "data_type": "string"
+                },
+                {
+                    "data_path": "summary.total_objects",
+                    "data_type": "numeric",
+                    "example_values": [
+                        1
+                    ]
+                },
+                {
+                    "data_path": "summary.total_objects_successful",
+                    "data_type": "numeric",
+                    "example_values": [
+                        1
+                    ]
+                }
+            ],
+            "parameters": {},
+            "read_only": true,
+            "type": "generic",
+            "verbose": "",
+            "versions": "EQ(*)"
+        },
         {
             "action": "reverse string",
             "identifier": "reverse_string",

{splunk_soar_sdk-2.1.0 → splunk_soar_sdk-2.1.1}/tests/example_app/src/app.py

@@ -53,6 +53,25 @@ def test_connectivity(soar: SOARClient, asset: Asset) -> None:
     logger.progress("this is a progress message")
 
 
+class ActionOutputSummary(ActionOutput):
+    is_success: bool
+
+
+@app.action()
+def test_summary_with_list_output(
+    params: Params, asset: Asset, soar: SOARClient
+) -> list[ActionOutput]:
+    soar.set_summary(ActionOutputSummary(is_success=True))
+    return [ActionOutput(), ActionOutput()]
+
+
+@app.action()
+def test_empty_list_output(
+    params: Params, asset: Asset, soar: SOARClient
+) -> list[ActionOutput]:
+    return []
+
+
 app.register_action(
     "actions.reverse_string:reverse_string",
     action_type="investigate",

{splunk_soar_sdk-2.1.0 → splunk_soar_sdk-2.1.1}/tests/test_app_action.py

@@ -506,3 +506,26 @@ def test_register_action_with_view_handler_module_not_in_sys_modules(simple_app:
             view_handler=fake_module_view_handler,
             view_template="sample_template.html",
         )
+
+
+def test_empty_list_output(simple_app: App, mocker: pytest_mock.MockerFixture):
+    @simple_app.action()
+    def action_example(params: Params, soar: SOARClient) -> list[ActionOutput]:
+        return []
+
+    add_result_mock = mocker.patch.object(simple_app.actions_manager, "add_result")
+    result = action_example(Params(), soar=simple_app.soar_client)
+    assert result is True
+    assert add_result_mock.call_count == 1
+
+
+def test_list_output_with_summary(simple_app: App, mocker: pytest_mock.MockerFixture):
+    @simple_app.action()
+    def action_example(params: Params, soar: SOARClient) -> list[ActionOutput]:
+        soar.set_summary(ActionOutput())
+        return [ActionOutput()]
+
+    set_summary_mock = mocker.patch.object(simple_app.soar_client, "set_summary")
+    result = action_example(Params(), soar=simple_app.soar_client)
+    assert result is True
+    assert set_summary_mock.call_count == 1

{splunk_soar_sdk-2.1.0 → splunk_soar_sdk-2.1.1}/uv.lock

@@ -1291,7 +1291,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "2.1.0"
+version = "2.1.1"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4", marker = "(python_full_version < '3.10' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'linux')" },

splunk_soar_sdk-2.1.0/release_notes.txt

@@ -1,21 +0,0 @@
-# [2.1.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.1...2.1.0) (2025-09-26)
-
-
-### Features
-
-* add a parameter to enable the action concurrency lock ([6ec9a5f](https://github.com/phantomcyber/splunk-soar-sdk/commit/6ec9a5fc69dbfaa528105f9d983e83c5544d06ba))
-
-
-
-
-
-# [2.1.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.1...2.1.0) (2025-09-26)
-
-
-### Features
-
-* add a parameter to enable the action concurrency lock ([6ec9a5f](https://github.com/phantomcyber/splunk-soar-sdk/commit/6ec9a5fc69dbfaa528105f9d983e83c5544d06ba))
-
-
-
-

splunk_soar_sdk-2.1.0/release_version.txt

@@ -1 +0,0 @@
-2.1.0