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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.0.1
+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.0.1 → splunk_soar_sdk-2.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "2.0.1"
+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.0.1 → splunk_soar_sdk-2.1.1}/src/soar_sdk/app.py

@@ -241,6 +241,7 @@ class App:
         view_template: Optional[str] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
+        enable_concurrency_lock: bool = False,
     ) -> Action:
         """Dynamically register an action function defined in another module.
 
@@ -301,6 +302,7 @@ class App:
             versions: Version constraint string for when this action is available.
                 Defaults to "EQ(*)" (all versions).
             summary_type: Pydantic model class for structuring action summary output.
+            enable_concurrency_lock: Whether to enable a concurrency lock for this action. Defaults to False.
 
         Returns:
             The registered Action instance with all metadata and handlers configured.
@@ -356,6 +358,7 @@ class App:
             view_handler=view_handler,
             versions=versions,
             summary_type=summary_type,
+            enable_concurrency_lock=enable_concurrency_lock,
         )(action)
 
     def _resolve_function_import(self, action_path: str) -> Callable:
@@ -421,6 +424,7 @@ class App:
         view_handler: Optional[Callable] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
+        enable_concurrency_lock: bool = False,
     ) -> ActionDecorator:
         """Decorator for registering an action function.
 
@@ -439,6 +443,7 @@ class App:
             view_handler=view_handler,
             versions=versions,
             summary_type=summary_type,
+            enable_concurrency_lock=enable_concurrency_lock,
         )
 
     def test_connectivity(self) -> ConnectivityTestDecorator:
@@ -642,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.0.1 → splunk_soar_sdk-2.1.1}/src/soar_sdk/decorators/action.py

@@ -42,6 +42,7 @@ class ActionDecorator:
         view_handler: Optional[Callable] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
+        enable_concurrency_lock: bool = False,
     ) -> None:
         self.app = app
         self.name = name
@@ -55,6 +56,7 @@ class ActionDecorator:
         self.view_handler = view_handler
         self.versions = versions
         self.summary_type = summary_type
+        self.enable_concurrency_lock = enable_concurrency_lock
 
     def __call__(self, function: Callable) -> Action:
         """Decorator for the action handling function.
@@ -152,6 +154,7 @@ class ActionDecorator:
             versions=self.versions,
             view_handler=self.view_handler,
             summary_type=self.summary_type,
+            enable_concurrency_lock=self.enable_concurrency_lock,
         )
 
         self.app.actions_manager.set_action(action_identifier, inner)

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.1}/src/soar_sdk/meta/actions.py

@@ -22,6 +22,7 @@ class ActionMeta(BaseModel):
     output: Type[ActionOutput] = Field(default=ActionOutput)  # noqa: UP006
     view_handler: Optional[Callable] = None
     summary_type: Optional[Type[ActionOutput]] = Field(default=None, exclude=True)  # noqa: UP006
+    enable_concurrency_lock: bool = False
 
     def dict(self, *args: Any, **kwargs: Any) -> dict[str, Any]:  # noqa: ANN401
         """Serializes the action metadata to a dictionary."""
@@ -52,4 +53,8 @@ class ActionMeta(BaseModel):
         # Remove view_handler from the output since in render
         data.pop("view_handler", None)
 
+        if self.enable_concurrency_lock:
+            data["lock"] = {"enabled": True}
+        data.pop("enable_concurrency_lock", None)
+
         return data

{splunk_soar_sdk-2.0.1 → 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.0.1 → 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.0.1 → splunk_soar_sdk-2.1.1}/tests/meta/test_actions.py

@@ -70,3 +70,24 @@ def test_action_meta_dict_without_view_handler():
 
     assert "render" not in result
     assert "view_handler" not in result
+
+
+def test_action_meta_dict_with_concurrency_lock():
+    """Test ActionMeta.dict() with enable_concurrency_lock set to True."""
+
+    meta = ActionMeta(
+        action="test_action",
+        identifier="test_identifier",
+        description="Test description",
+        verbose="Test verbose",
+        type="generic",
+        read_only=True,
+        versions="EQ(*)",
+        enable_concurrency_lock=True,
+    )
+
+    result = meta.dict()
+
+    assert "lock" in result
+    assert result["lock"]["enabled"] is True
+    assert "enable_concurrency_lock" not in result

{splunk_soar_sdk-2.0.1 → 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.0.1 → splunk_soar_sdk-2.1.1}/uv.lock

@@ -1291,7 +1291,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "2.0.1"
+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.0.1/release_notes.txt

@@ -1,21 +0,0 @@
-## [2.0.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.0...2.0.1) (2025-09-25)
-
-
-### Bug Fixes
-
-* handle lists and optionals of nested types properly ([98a84b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/98a84b52fa79aaf08b4ce7493abef76df94cfb37))
-
-
-
-
-
-## [2.0.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.0...2.0.1) (2025-09-25)
-
-
-### Bug Fixes
-
-* handle lists and optionals of nested types properly ([98a84b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/98a84b52fa79aaf08b4ce7493abef76df94cfb37))
-
-
-
-

splunk_soar_sdk-2.0.1/release_version.txt

@@ -1 +0,0 @@
-2.0.1