splunk-soar-sdk 1.5.0__tar.gz → 1.5.1__tar.gz

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/PKG-INFO

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

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "1.5.0"
+version = "1.5.1"
 description = "The official framework for developing and testing Splunk SOAR Apps"
 readme = "README.md"
 requires-python = ">=3.9, <3.14"
@@ -137,10 +137,7 @@ source = [
     "src/soar_sdk"
 ]
 omit = [
-    "src/soar_sdk/api_callers.py",  # moved 1:1 from App Wizard, not re-designed yet
     "src/soar_sdk/shims/*",  # shims for BaseConnector, should not need testing
-    "src/soar_sdk/views/components/*",  # reusable components, testing deferred till actual usage
-    "src/soar_sdk/views/template_filters.py", # ported from platform, need to decide what we're keeping
     "src/soar_sdk/code_renderers/templates/*"  # jinja templates, not code
 ]
 

splunk_soar_sdk-1.5.1/release_notes.txt

@@ -0,0 +1,23 @@
+## [1.5.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.5.0...1.5.1) (2025-09-16)
+
+
+### Bug Fixes
+
+* **cli:** add missing ActionResult.get_message() shim, resolving CLI bug ([e38f06b](https://github.com/phantomcyber/splunk-soar-sdk/commit/e38f06b32093c0157978725ab2bacc414671f8f9)), closes [#116](https://github.com/phantomcyber/splunk-soar-sdk/issues/116)
+* **docs:** remove reference to defunct 'order' arg of 'Param' ([0c112e4](https://github.com/phantomcyber/splunk-soar-sdk/commit/0c112e4ac5c73791647eab0c6eec31dc3943ae64))
+
+
+
+
+
+## [1.5.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.5.0...1.5.1) (2025-09-16)
+
+
+### Bug Fixes
+
+* **cli:** add missing ActionResult.get_message() shim, resolving CLI bug ([e38f06b](https://github.com/phantomcyber/splunk-soar-sdk/commit/e38f06b32093c0157978725ab2bacc414671f8f9)), closes [#116](https://github.com/phantomcyber/splunk-soar-sdk/issues/116)
+* **docs:** remove reference to defunct 'order' arg of 'Param' ([0c112e4](https://github.com/phantomcyber/splunk-soar-sdk/commit/0c112e4ac5c73791647eab0c6eec31dc3943ae64))
+
+
+
+

splunk_soar_sdk-1.5.1/release_version.txt

@@ -0,0 +1 @@
+1.5.1

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/src/soar_sdk/actions_manager.py

@@ -84,11 +84,9 @@ class ActionsManager(BaseConnector):
         if handler := self.get_action(action_id):
             try:
                 params = handler.meta.parameters.parse_obj(param)
-            except (ValueError, ValidationError):
-                # FIXME: Consider adding more details to this error, but be aware
-                #  of possible PIIs.
+            except (ValueError, ValidationError) as e:
                 self.save_progress(
-                    "Validation Error - the params data for action could not be parsed"
+                    f"Validation Error - the params data for action could not be parsed: {e!s}"
                 )
                 return
             handler(params)

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/src/soar_sdk/app_cli_runner.py

@@ -257,20 +257,15 @@ class AppCliRunner:
         )
         print(f"Parsed webhook request: {args.webhook_request}")
 
-    def run(self) -> None:
+    def run(self, argv: Optional[list[str]] = None) -> None:
         """Run the app CLI."""
-        args = self.parse_args()
+        args = self.parse_args(argv=argv)
 
         logger = PhantomLogger()
 
         if input_data := getattr(args, "raw_input_data", None):
             self.app.handle(input_data)
-            # FIXME: ActionResult mock isn't quite right. Choosing not to unit test this section
-            # yet, because the test will need to be rewritten. We shouldn't be posting our results
-            # into ActionResult.param...
-            for (
-                result
-            ) in self.app.actions_manager.get_action_results():  # pragma: no cover
+            for result in self.app.actions_manager.get_action_results():
                 params_pretty = json.dumps(result.param, indent=2, ensure_ascii=False)
                 data_pretty = json.dumps(
                     result.get_data(), indent=2, ensure_ascii=False

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/src/soar_sdk/params.py

@@ -28,8 +28,6 @@ def Param(
     Use this function to define the default value for an action parameter that requires
     extra metadata for the manifest. This function is a thin wrapper around pydantic.Field.
 
-    :param order: The order key, starting at 0, allows the app
-      author to control the display order of the controls in the UI.
     :param description: A short description of this parameter.
       The description is shown in the user interface when running an action manually.
     :param default: To set the default value of a variable in the UI, use this key.

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/src/soar_sdk/shims/phantom/action_result.py

@@ -52,5 +52,8 @@ if TYPE_CHECKING or not _soar_is_available:
         def get_summary(self) -> dict:
             return self.summary
 
+        def get_message(self) -> str:
+            return self.message
+
 
 __all__ = ["ActionResult"]

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/src/soar_sdk/views/template_filters.py

@@ -10,7 +10,7 @@ import uuid
 import humanize
 import bleach  # type: ignore[import-untyped]
 from datetime import datetime, timedelta
-from typing import Optional, Union
+from typing import Optional, TypeVar, Union
 from collections.abc import Iterable
 from collections.abc import Iterator
 from jinja2 import Environment
@@ -47,7 +47,10 @@ def sorteditems(dictionary: dict) -> list:
     return sorted(dictionary.items())
 
 
-def batch(iterable: Iterable, count: int) -> Iterator[list]:
+T = TypeVar("T")
+
+
+def batch(iterable: Iterable[T], count: int) -> Iterator[list[T]]:
     """Batch items into groups of specified count."""
     result = []
     for item in iterable:

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/tests/cli/manifests/test_processors.py

@@ -4,19 +4,20 @@ from unittest import mock
 import json
 from datetime import datetime
 
+import pytest_mock
+
 from soar_sdk.cli.manifests.processors import ManifestProcessor
 from soar_sdk.compat import UPDATE_TIME_FORMAT
 
 
-def test_manifest_processor_creating_json_from_meta():
+def test_manifest_processor_creating_json_from_meta(mocker: pytest_mock.MockerFixture):
     processor = ManifestProcessor(
         "example_app.json", project_context="./tests/example_app"
     )
-    processor.save_json_manifest = mock.Mock()
 
+    save_json_manifest = mocker.patch.object(processor, "save_json_manifest")
     processor.create()
-
-    processor.save_json_manifest.assert_called_once()
+    save_json_manifest.assert_called_once()
 
 
 @mock.patch("builtins.open", new_callable=mock.mock_open, read_data="data")

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/tests/conftest.py

@@ -1,4 +1,3 @@
-import json
 from unittest import mock
 
 import pytest
@@ -45,12 +44,6 @@ def example_app() -> App:
         product_name="Example App",
         publisher="Splunk",
     )
-    app.actions_manager._load_app_json = mock.Mock(return_value=True)
-    app.actions_manager.get_state_dir = mock.Mock(return_value="/tmp/")
-    app.actions_manager._load_app_json = mock.Mock(return_value=True)
-
-    with open("tests/example_app/app.json") as app_json:
-        app.actions_manager._BaseConnector__app_json = json.load(app_json)
 
     return app
 

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/tests/stubs.py

@@ -6,7 +6,7 @@ from soar_sdk.params import Param, Params
 
 
 class SampleActionParams(Params):
-    field1: int = Param(0, "Some description")
+    field1: int = Param(description="Some description", required=False, default=5)
 
 
 class BaseConnectorMock(mock.Mock):

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/tests/test_actions_manager.py

@@ -3,6 +3,7 @@ from unittest import mock
 from zoneinfo import ZoneInfo
 
 import pytest
+import pytest_mock
 
 from soar_sdk.asset import AssetField, BaseAsset
 from soar_sdk.input_spec import AppConfig, InputSpecification
@@ -238,15 +239,17 @@ def test_actions_provider_running_undefined_action(
 
 
 def test_app_connector_handle_action_runs_app_action(
-    app_actions_manager: ActionsManager,
+    app_actions_manager: ActionsManager, mocker: pytest_mock.MockerFixture
 ):
     mocked_handler = mock.Mock()
 
-    app_actions_manager.get_action_identifier = mock.Mock(  # type: ignore[method-assign]
-        return_value="testing_handler"
+    mocker.patch.object(
+        app_actions_manager, "get_action_identifier", return_value="testing_handler"
     )
-    app_actions_manager.get_actions = mock.Mock(
-        return_value={"testing_handler": mocked_handler}
+    mocker.patch.object(
+        app_actions_manager,
+        "get_actions",
+        return_value={"testing_handler": mocked_handler},
     )
 
     app_actions_manager.handle_action({})
@@ -254,9 +257,13 @@ def test_app_connector_handle_action_runs_app_action(
     assert mocked_handler.call_count == 1
 
 
-def test_handle_action_handler_not_existing(app_actions_manager: ActionsManager):
-    app_actions_manager.get_action_identifier = mock.Mock(  # type: ignore[method-assign]
-        return_value="not_existing_handler"
+def test_handle_action_handler_not_existing(
+    app_actions_manager: ActionsManager, mocker: pytest_mock.MockerFixture
+):
+    mocker.patch.object(
+        app_actions_manager,
+        "get_action_identifier",
+        return_value="not_existing_handler",
     )
 
     with pytest.raises(RuntimeError):
@@ -264,17 +271,17 @@ def test_handle_action_handler_not_existing(app_actions_manager: ActionsManager)
 
 
 def test_handle_raises_validation_error(
-    app_actions_manager: ActionsManager,
+    app_actions_manager: ActionsManager, mocker: pytest_mock.MockerFixture
 ):
     testing_handler = mock.Mock()
     testing_handler.meta.parameters = SampleActionParams
 
-    app_actions_manager.get_action_identifier = mock.Mock()
-    app_actions_manager.get_action = mock.Mock(return_value=testing_handler)
-    app_actions_manager.save_progress = mock.Mock()
+    mocker.patch.object(app_actions_manager, "get_action_identifier")
+    mocker.patch.object(app_actions_manager, "get_action", return_value=testing_handler)
+    save_progress_mock = mocker.patch.object(app_actions_manager, "save_progress")
 
     app_actions_manager.handle_action({"field1": "five"})
-    assert app_actions_manager.save_progress.call_count == 1
+    assert save_progress_mock.call_count == 1
 
 
 def test_app_connector_delegates_get_phantom_base_url():
@@ -286,7 +293,9 @@ def test_app_connector_delegates_get_phantom_base_url():
         assert ActionsManager.get_soar_base_url() == "some_url"
 
 
-def test_app_connector_initialize_loads_state(app_actions_manager: ActionsManager):
+def test_app_connector_initialize_loads_state(
+    app_actions_manager: ActionsManager, mocker: pytest_mock.MockerFixture
+):
     """Test that initialize loads the state from load_state method."""
     # Mock the load_state method to return a specific state
     test_state_inner = {"test_key": "test_value"}
@@ -296,7 +305,9 @@ def test_app_connector_initialize_loads_state(app_actions_manager: ActionsManage
         _CACHE_STATE_KEY: test_state_inner,
     }
 
-    app_actions_manager.load_state = mock.Mock(return_value=test_state)
+    load_state = mocker.patch.object(
+        app_actions_manager, "load_state", return_value=test_state
+    )
 
     # Call initialize
     result = app_actions_manager.initialize()
@@ -305,7 +316,7 @@ def test_app_connector_initialize_loads_state(app_actions_manager: ActionsManage
     assert result is True
 
     # Verify load_state was called
-    app_actions_manager.load_state.assert_called_once()
+    load_state.assert_called_once()
 
     # Verify the state was stored correctly
     assert app_actions_manager.ingestion_state == test_state_inner
@@ -314,11 +325,13 @@ def test_app_connector_initialize_loads_state(app_actions_manager: ActionsManage
 
 
 def test_app_connector_initialize_handles_empty_state(
-    app_actions_manager: ActionsManager,
+    app_actions_manager: ActionsManager, mocker: pytest_mock.MockerFixture
 ):
     """Test that initialize handles None return from load_state."""
     # Mock the load_state method to return None
-    app_actions_manager.load_state = mock.Mock(return_value=None)
+    load_state = mocker.patch.object(
+        app_actions_manager, "load_state", return_value=None
+    )
 
     # Call initialize
     result = app_actions_manager.initialize()
@@ -327,7 +340,7 @@ def test_app_connector_initialize_handles_empty_state(
     assert result is True
 
     # Verify load_state was called
-    app_actions_manager.load_state.assert_called_once()
+    load_state.assert_called_once()
 
     # Verify the state was initialized to an empty dict
     assert app_actions_manager.ingestion_state == {}
@@ -335,7 +348,9 @@ def test_app_connector_initialize_handles_empty_state(
     assert app_actions_manager.asset_cache == {}
 
 
-def test_app_connector_finalize_saves_state(app_actions_manager: ActionsManager):
+def test_app_connector_finalize_saves_state(
+    app_actions_manager: ActionsManager, mocker: pytest_mock.MockerFixture
+):
     """Test that finalize saves the current state using save_state."""
     # Set up a test state
     test_state = {"key1": "value1", "key2": "value2"}
@@ -344,7 +359,7 @@ def test_app_connector_finalize_saves_state(app_actions_manager: ActionsManager)
     app_actions_manager.asset_cache = test_state
 
     # Mock the save_state method
-    app_actions_manager.save_state = mock.Mock()
+    save_state = mocker.patch.object(app_actions_manager, "save_state")
 
     # Call finalize
     result = app_actions_manager.finalize()
@@ -353,7 +368,7 @@ def test_app_connector_finalize_saves_state(app_actions_manager: ActionsManager)
     assert result is True
 
     # Verify save_state was called with the correct state
-    app_actions_manager.save_state.assert_called_once_with(
+    save_state.assert_called_once_with(
         {
             _INGEST_STATE_KEY: test_state,
             _AUTH_STATE_KEY: test_state,
@@ -362,9 +377,11 @@ def test_app_connector_finalize_saves_state(app_actions_manager: ActionsManager)
     )
 
 
-def test_app_connector_delegates_set_csrf_info(app_actions_manager: ActionsManager):
-    app_actions_manager._set_csrf_info = mock.Mock()  # type: ignore[method-assign]
+def test_app_connector_delegates_set_csrf_info(
+    app_actions_manager: ActionsManager, mocker: pytest_mock.MockerFixture
+):
+    set_csrf_info = mocker.patch.object(app_actions_manager, "_set_csrf_info")
 
     app_actions_manager.set_csrf_info("", "")
 
-    assert app_actions_manager._set_csrf_info.call_count == 1
+    assert set_csrf_info.call_count == 1

{splunk_soar_sdk-1.5.0 → splunk_soar_sdk-1.5.1}/tests/test_app_action.py

@@ -6,6 +6,8 @@ import inspect
 import sys
 import types
 
+import pytest_mock
+
 from soar_sdk.abstract import SOARClient
 from soar_sdk.app import App
 from soar_sdk.params import Param, Params
@@ -115,7 +117,7 @@ def test_action_call_with_params_dict(simple_app, sample_params):
         assert params.pass_value == "<PASSWORD>"
         assert params.bool_value
 
-    client_mock = mock.Mock()
+    client_mock = mock.Mock(spec=SOARClient)
 
     action_function(sample_params, soar=client_mock)
 
@@ -134,7 +136,7 @@ def test_action_call_with_state(simple_app, sample_params):
         soar.auth_state = updated_state
         soar.asset_cache = updated_state
 
-    client_mock = mock.Mock()
+    client_mock = mock.Mock(spec=SOARClient)
 
     client_mock.ingestion_state = initial_state
     client_mock.auth_state = initial_state
@@ -202,14 +204,13 @@ def test_action_with_mocked_client(simple_app, sample_params):
     @simple_app.action()
     def action_function(params: SampleParams, soar: SOARClient) -> ActionOutput:
         container_id = str(soar.get_executing_container_id())
-        soar.save_progress(f"Container ID is: {container_id}")
+        soar.set_summary(f"Container ID is: {container_id}")
 
-    client_mock = mock.Mock()
-    client_mock.save_progress = mock.Mock()
+    client_mock = mock.Mock(spec=SOARClient)
 
     action_function(sample_params, soar=client_mock)
 
-    assert client_mock.save_progress.call_count == 1
+    assert client_mock.set_summary.call_count == 1
 
 
 def test_action_decoration_fails_without_return_type(simple_app):
@@ -269,17 +270,17 @@ def test_action_decoration_passing_output_type_as_argument(simple_app):
     foo(SampleActionParams())
 
 
-def test_action_failure_raised(simple_app: App):
+def test_action_failure_raised(simple_app: App, mocker: pytest_mock.MockerFixture):
     @simple_app.action()
     def action_function(params: Params, soar: SOARClient) -> ActionOutput:
         raise ActionFailure("Action failed")
 
     # Mock the add_result method
-    simple_app.actions_manager.add_result = mock.Mock()
+    add_result_mock = mocker.patch.object(simple_app.actions_manager, "add_result")
 
     result = action_function(Params(), soar=simple_app.soar_client)
     assert not result
-    assert simple_app.actions_manager.add_result.call_count == 1
+    assert add_result_mock.call_count == 1
 
 
 def test_other_failure_raised(simple_app: App):