splunk-soar-sdk 1.3.4__tar.gz → 1.4.0__tar.gz

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/PKG-INFO

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

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

splunk_soar_sdk-1.4.0/release_notes.txt

@@ -0,0 +1,21 @@
+# [1.4.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.3.4...1.4.0) (2025-09-10)
+
+
+### Features
+
+* function to get container id on soar client ([2329956](https://github.com/phantomcyber/splunk-soar-sdk/commit/232995679cc5c568fc9ebd895c96aaf8f3f6448e))
+
+
+
+
+
+# [1.4.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.3.4...1.4.0) (2025-09-10)
+
+
+### Features
+
+* function to get container id on soar client ([2329956](https://github.com/phantomcyber/splunk-soar-sdk/commit/232995679cc5c568fc9ebd895c96aaf8f3f6448e))
+
+
+
+

splunk_soar_sdk-1.4.0/release_version.txt

@@ -0,0 +1 @@
+1.4.0

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/src/soar_sdk/abstract.py

@@ -63,6 +63,11 @@ class SOARClient(Generic[SummaryType]):
         """Object governing interaction with the SOAR container API. Subclasses must define."""
         pass
 
+    @abstractmethod
+    def get_executing_container_id(self) -> int:
+        """Return the current Container ID passed in the Connector Run Action JSON."""
+        pass
+
     def get(
         self,
         endpoint: str,
@@ -202,7 +207,9 @@ class SOARClient(Generic[SummaryType]):
         return "https://localhost:9999/"
 
     @abstractmethod
-    def update_client(self, soar_auth: SOARClientAuth, asset_id: str) -> None:
+    def update_client(
+        self, soar_auth: SOARClientAuth, asset_id: str, container_id: int = 0
+    ) -> None:
         """Hook to update the SOAR API client before any actions run with the input data.
 
         An example of what this function might do is authenticate the API client.

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/src/soar_sdk/app.py

@@ -187,7 +187,9 @@ class App:
 
         self.__logger.handler.set_handle(handle)
         soar_auth = App.create_soar_client_auth_object(input_data)
-        self.soar_client.update_client(soar_auth, input_data.asset_id)
+        self.soar_client.update_client(
+            soar_auth, input_data.asset_id, input_data.container_id
+        )
         return self.actions_manager.handle(input_data, handle=handle)
 
     @staticmethod

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/src/soar_sdk/app_client.py

@@ -45,6 +45,7 @@ class AppClient(SOARClient[SummaryType]):
 
         self._summary: Optional[SummaryType] = None
         self._message: Optional[str] = None
+        self.__container_id: int = 0
 
     @property
     def client(self) -> httpx.Client:
@@ -66,10 +67,17 @@ class AppClient(SOARClient[SummaryType]):
         """The SOAR Vault API."""
         return self._vault_api
 
-    def update_client(self, soar_auth: SOARClientAuth, asset_id: str) -> None:
+    def get_executing_container_id(self) -> int:
+        """Return the current Container ID passed in the Connector Run Action JSON."""
+        return self.__container_id
+
+    def update_client(
+        self, soar_auth: SOARClientAuth, asset_id: str, container_id: int = 0
+    ) -> None:
         """Update the SOAR client with the given authentication and asset ID."""
         self.authenticate_soar_client(soar_auth)
         self._containers_api.set_executing_asset(asset_id)
+        self.__container_id = container_id
 
     def authenticate_soar_client(self, soar_auth: SOARClientAuth) -> None:
         """Authenticate the SOAR client with the given authentication credentials."""

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/tests/example_app/src/app.py

@@ -43,6 +43,8 @@ app = App(
 @app.test_connectivity()
 def test_connectivity(soar: SOARClient, asset: Asset) -> None:
     soar.get("rest/version")
+    container_id = soar.get_executing_container_id()
+    logger.info(f"current executing container's container_id is: {container_id}")
     logger.info(f"testing connectivity against {asset.base_url}")
     logger.debug("hello")
     logger.warning("this is a warning")

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/tests/test_app_action.py

@@ -198,7 +198,8 @@ def test_action_decoration_uses_meta_identifier_for_action_name(simple_app):
 def test_action_with_mocked_client(simple_app, sample_params):
     @simple_app.action()
     def action_function(params: SampleParams, soar: SOARClient) -> ActionOutput:
-        soar.save_progress("Progress was made")
+        container_id = str(soar.get_executing_container_id())
+        soar.save_progress(f"Container ID is: {container_id}")
 
     client_mock = mock.Mock()
     client_mock.save_progress = mock.Mock()

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/tests/test_app_client.py

@@ -31,3 +31,7 @@ def test_authenticate_soar_client_on_platform(
 ):
     simple_connector.authenticate_soar_client(soar_client_auth_token)
     assert mock_get_any_soar_call.call_count == 1
+
+
+def test_get_executing_container_id(simple_connector: AppClient):
+    assert simple_connector.get_executing_container_id() == 0

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.0}/uv.lock

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

@@ -1,23 +0,0 @@
-## [1.3.4](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.3.3...1.3.4) (2025-09-09)
-
-
-### Bug Fixes
-
-* **docs:** fetch a deep changelog when generating docs ([2baf81a](https://github.com/phantomcyber/splunk-soar-sdk/commit/2baf81a334ecf8b1556f79c5a3c8217f6acc696b))
-* **docs:** resolve all remaining pydocstyle warnings and make it fail pre-commit ([b97095f](https://github.com/phantomcyber/splunk-soar-sdk/commit/b97095f0c2ef5dfcb39e9b2cc206afbf56bba403))
-
-
-
-
-
-## [1.3.4](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.3.3...1.3.4) (2025-09-09)
-
-
-### Bug Fixes
-
-* **docs:** fetch a deep changelog when generating docs ([2baf81a](https://github.com/phantomcyber/splunk-soar-sdk/commit/2baf81a334ecf8b1556f79c5a3c8217f6acc696b))
-* **docs:** resolve all remaining pydocstyle warnings and make it fail pre-commit ([b97095f](https://github.com/phantomcyber/splunk-soar-sdk/commit/b97095f0c2ef5dfcb39e9b2cc206afbf56bba403))
-
-
-
-

splunk_soar_sdk-1.3.4/release_version.txt

@@ -1 +0,0 @@
-1.3.4