splunk-soar-sdk 1.5.0__py3-none-any.whl → 1.5.1__py3-none-any.whl

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)

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

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.

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"]

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.dist-info → splunk_soar_sdk-1.5.1.dist-info}/METADATA

@@ -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.dist-info → splunk_soar_sdk-1.5.1.dist-info}/RECORD

@@ -1,9 +1,9 @@
 soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
 soar_sdk/abstract.py,sha256=ExsLCY99aoPRFHsUfw7yIVdWJeZjq1ahQCVwQmZyYh8,7798
 soar_sdk/action_results.py,sha256=gAQwHjXbkkzOJTmQnLwBjKjwbuz8mSPyqIVcirVS598,10114
-soar_sdk/actions_manager.py,sha256=U8OZmNCjuwtLKlC19BsVIvDyeJDS_ZiTyZIHA4SS1go,5885
+soar_sdk/actions_manager.py,sha256=wJCyfzkI_6OKZ-Kmll4vRJpGvYdL93Uw-JyEEGnKcw0,5779
 soar_sdk/app.py,sha256=9zI8RM6uo4V0Bj4cgCvJzSOjIBPrvt2meXVAMaPhVrE,32882
-soar_sdk/app_cli_runner.py,sha256=uk9V-cbAHx1tzK_1gCYpfdF7IJ_ZwuWV2Ak4NMOvKGA,11873
+soar_sdk/app_cli_runner.py,sha256=fJoozhyAt7QUMuc02nE5RL_InpsjQBpr6U4rF9sey3E,11627
 soar_sdk/app_client.py,sha256=UVCMFYweaYcFk7WrtoVsCoprYZ7JlzMBR108ZQRV8SE,6051
 soar_sdk/asset.py,sha256=deS8_B5hr7W2fED8_6wUpVriRgiQ5r8TkGVHiasIaro,10666
 soar_sdk/async_utils.py,sha256=gND8ZiVTqDYLQ88Ua6SN1mInJaEcfa168eOaRoURt3E,1441
@@ -13,7 +13,7 @@ soar_sdk/crypto.py,sha256=qiBMHUQqgn5lPI1DbujSj700s89FuLJrkQgCO9_eBn4,392
 soar_sdk/exceptions.py,sha256=CxJ_Q6N1jlknO_3ItDQNhHEw2pNWZr3sMLqutYmr5HA,1863
 soar_sdk/input_spec.py,sha256=BAa36l8IKDvM8SVMjgZ1XcnWZ2F7O052n2415tLeKK8,4690
 soar_sdk/logging.py,sha256=lSz8PA6hOCw2MHGE0ZSKbw-FzSr1WdbfQ7BHnXBUUY0,11440
-soar_sdk/params.py,sha256=JKhlyBlYDdgUpQv1G6QEnJiY5G1XkiQ364_iNmyjxks,7623
+soar_sdk/params.py,sha256=vUicPw6cdepEbwgg5A2DgIjSSUbhnlOXz_U1jxFH45Q,7491
 soar_sdk/paths.py,sha256=XhpanQCAiTXaulRx440oKu36mnll7P05TethHXgMpgQ,239
 soar_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/types.py,sha256=uMFnNOHpmCLrbAhQOgmXjScXiGE67sM8ySN04MhkC3U,602
@@ -67,7 +67,7 @@ soar_sdk/models/artifact.py,sha256=MWEjMNxPVCCEyAin8NW646bm8xGDmc7NAJGLZFyKCSw,1
 soar_sdk/models/container.py,sha256=TWdTB0Wy3CzOYmBOxCtEi2zn90N_lRDuor0MxkGBprA,1622
 soar_sdk/models/vault_attachment.py,sha256=_ARh74nv6iD9nH0dN3uayUYA7O8wIIiIKW98w4FUVQc,1107
 soar_sdk/models/view.py,sha256=fgPEdUNxu-Kbi4J0nOk16lkD0uof-PkxDumBcaQqKTE,832
-soar_sdk/shims/phantom/action_result.py,sha256=xUe_bJ5yYbn9S_gcNrvSffjpOQQJ-OOpazU34GTTykI,1564
+soar_sdk/shims/phantom/action_result.py,sha256=jCZPljCcW5RMFA_Pp0OQ2Dg9c9c_PjDM9bm7Jj3wJrg,1635
 soar_sdk/shims/phantom/app.py,sha256=PpNj9FoXjyj6r5w9S2fpElKFS6EcBIqsnpaTSvnIzyI,303
 soar_sdk/shims/phantom/base_connector.py,sha256=s8sHCXX2LbnsSjfbzRm4UMsHRZNsx-jcvjIT80kye-I,4490
 soar_sdk/shims/phantom/connector_result.py,sha256=T6eDXdMyblWB0Xa3RW4ojuhy9wJmWZTpY8Oojl5sYYk,641
@@ -88,7 +88,7 @@ soar_sdk/templates/widgets/widget_resize_snippet.html,sha256=nGAXhYLlnyrEtdDqSjz
 soar_sdk/templates/widgets/widget_template.html,sha256=aQTVtU-96QLwRyA2yYskJeq4a2otqlDa6V0EamHBDEY,3751
 soar_sdk/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/views/component_registry.py,sha256=cN2F2XHGSR5Ddv6hihloCe0_4MD83BMpdNPod7nbu3A,119
-soar_sdk/views/template_filters.py,sha256=0KAJ68nIGXGFUtmzU8EuPYsz1faNa9lQP1-tnGftaTs,5419
+soar_sdk/views/template_filters.py,sha256=8GEl2ghmsZOkhJhLmjDL8JrPO-M5ZkWavi7ywqr6YUA,5453
 soar_sdk/views/template_renderer.py,sha256=t1elD9Y7wn4k7W4RBE1Mt6gaqXMGAo68c5KUYxl-UNs,5402
 soar_sdk/views/view_parser.py,sha256=IlRr_d_Ol4VjovKv7drmHPNXutJi_khfNtY1E05l8n4,3956
 soar_sdk/views/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -96,8 +96,8 @@ soar_sdk/views/components/pie_chart.py,sha256=LVTeHVJN6nf2vjUs9y7PDBhS0U1fKW750l
 soar_sdk/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/webhooks/models.py,sha256=-rjuFA9cRX5zTLp7cHSHVTkt5eVJD6BdESGbj_qkyHI,4540
 soar_sdk/webhooks/routing.py,sha256=BKbURSrBPdOTS5UFL-mHzFEr-Fj04mJMx9KeiPrZ2VQ,6872
-splunk_soar_sdk-1.5.0.dist-info/METADATA,sha256=l89BBxU2lNASu9LoIr9GU9iEBItjPj3Z-RY1zhN3kX0,7355
-splunk_soar_sdk-1.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-1.5.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-1.5.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-1.5.0.dist-info/RECORD,,
+splunk_soar_sdk-1.5.1.dist-info/METADATA,sha256=_gOg3kisT5fgH-hw-QwB2xbX5SbaiC_VmZzX-4l2tyM,7355
+splunk_soar_sdk-1.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-1.5.1.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-1.5.1.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-1.5.1.dist-info/RECORD,,