splunk-soar-sdk 1.3.4__py3-none-any.whl → 1.4.1__py3-none-any.whl

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.

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

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

soar_sdk/asset.py

@@ -21,6 +21,7 @@ def AssetField(
     default: Optional[Any] = None,  # noqa: ANN401
     value_list: Optional[list] = None,
     sensitive: bool = False,
+    alias: Optional[str] = None,
 ) -> Any:  # noqa: ANN401
     """Representation of an asset configuration field.
 
@@ -47,6 +48,7 @@ def AssetField(
         required=required,
         value_list=value_list,
         sensitive=sensitive,
+        alias=alias,
     )
 
 
@@ -239,7 +241,7 @@ class BaseAsset(BaseModel):
             if value_list := field.field_info.extra.get("value_list"):
                 params_field["value_list"] = value_list
 
-            params[field_name] = params_field
+            params[field.alias] = params_field
 
         return params
 

soar_sdk/cli/init/cli.py

@@ -16,6 +16,7 @@ from rich import print as rprint
 from rich.markup import escape as rescape
 
 from soar_sdk.cli.manifests.deserializers import AppMetaDeserializer
+from soar_sdk.cli.utils import normalize_field_name
 from soar_sdk.code_renderers.action_renderer import ActionRenderer
 from soar_sdk.code_renderers.app_renderer import AppContext, AppRenderer
 from soar_sdk.code_renderers.asset_renderer import AssetContext, AssetRenderer
@@ -42,7 +43,7 @@ def init_callback(
             "--python-version",
             "-p",
             help="Supported Python versions for the app.",
-            default_factory=lambda: [str(py) for py in PythonVersion.all()],
+            default_factory=PythonVersion.all,
         ),
     ],
     dependencies: Annotated[list[str], typer.Option(default_factory=list)],
@@ -268,11 +269,21 @@ def convert_connector_to_sdk(
     # Convert the main module path to the SDK format, but save a reference to the original
     app_meta.main_module = "src.app:app"
 
+    app_python_versions = app_meta.python_version
+    enforced_python_versions = PythonVersion.all()
+    if set(app_python_versions) != set(enforced_python_versions):
+        rprint(
+            f"[yellow]The provided app declares support for Python versions {[str(v) for v in app_python_versions]}.[/]"
+        )
+        rprint(
+            f"[yellow]The converted app will support the default versions {[str(v) for v in enforced_python_versions]}.[/]"
+        )
+
     init_sdk_app(
         name=app_meta.project_name,
         description=app_meta.description,
         authors=[author.name for author in app_meta.contributors],
-        python_versions=app_meta.python_version,
+        python_versions=enforced_python_versions,
         dependencies=[],
         app_dir=output_dir,
         copyright=app_meta.license,
@@ -385,18 +396,20 @@ def generate_asset_definition_ast(app_meta: AppMeta) -> ast.ClassDef:
     """
     asset_context: list[AssetContext] = []
     for name, config_spec in app_meta.configuration.items():
+        normalized = normalize_field_name(name)
         if config_spec["data_type"].startswith("ph"):
             # Skip the cosmetic placeholder fields
             continue
 
         asset_context.append(
             AssetContext(
-                name=name,
+                name=normalized.normalized,
                 description=config_spec.get("description"),
                 required=config_spec.get("required", False),
                 default=config_spec.get("default"),
                 data_type=config_spec["data_type"],
                 value_list=config_spec.get("value_list"),
+                alias=normalized.original if normalized.modified else None,
             )
         )
 

soar_sdk/cli/manifests/deserializers.py

@@ -6,7 +6,7 @@ import pydantic
 
 from soar_sdk.action_results import ActionOutput, OutputFieldSpecification, OutputField
 from soar_sdk.cli.utils import normalize_field_name, NormalizationResult
-from soar_sdk.compat import PythonVersion
+from soar_sdk.compat import PythonVersion, remove_when_soar_newer_than
 from soar_sdk.meta.actions import ActionMeta
 from soar_sdk.meta.app import AppMeta
 from soar_sdk.params import Params, Param
@@ -64,6 +64,21 @@ class AppMetaDeserializer:
         ]
         app_meta = AppMeta(project_name=json_path.parent.name, **manifest)
 
+        remove_when_soar_newer_than(
+            "7.1.0",
+            "Revisit this after upgrading to Pydantic 2.x. If the issue is still present, we might need to consider making `AssetFieldSpecification` a Pydantic model instead of a TypedDict, but that's a pretty big change.",
+        )
+        # Pydantic converts the default value into a string for some reason, even for non-string types.
+        # We will go through and convert it back.
+        # This has the side effect of implicitly validating that the default value matches the type.
+        for _, spec in app_meta.configuration.items():
+            if "default" not in spec:
+                continue
+            if spec["data_type"] == "numeric":
+                spec["default"] = float(spec["default"])
+            if spec["data_type"] == "boolean":
+                spec["default"] = bool(spec["default"])
+
         has_rest_handlers = isinstance(manifest.get("rest_handler"), str)
         has_webhooks = isinstance(manifest.get("webhooks"), dict)
 
@@ -142,7 +157,10 @@ class ActionDeserializer:
             if param_spec["data_type"].startswith("ph"):
                 # Skip parameters that are placeholders
                 continue
-            fields[param_name] = cls._create_param_field(param_spec)
+            normalized = normalize_field_name(param_name)
+            if normalized.modified:
+                param_spec["alias"] = normalized.original
+            fields[normalized.normalized] = cls._create_param_field(param_spec)
 
         # Dynamically create a subclass of Params
         action_name = cls._clean_action_name(action_name).normalized
@@ -164,13 +182,14 @@ class ActionDeserializer:
         # Create Param field with all the metadata
         param_field = Param(
             description=param_spec.get("description"),
-            required=param_spec.get("required", True),
+            required=param_spec.get("required", False),
             primary=param_spec.get("primary", False),
             default=param_spec.get("default"),
             value_list=param_spec.get("value_list"),
             cef_types=param_spec.get("contains"),  # 'contains' maps to 'cef_types'
             allow_list=param_spec.get("allow_list", False),
             sensitive=(data_type == "password"),
+            alias=param_spec.get("alias"),
         )
 
         return FieldSpec(python_type, param_field)

soar_sdk/cli/utils.py

@@ -32,7 +32,12 @@ def normalize_field_name(field_name: str) -> NormalizationResult:
 
         # Ensure the first character is a letter or underscore
         if field_name[0].isdigit():
-            field_name = f"_{field_name}"
+            field_name = f"n{field_name}"
+
+    # Drop leading underscores to avoid Pydantic marking a field as private
+    field_name = field_name.lstrip("_")
+    if not field_name:
+        raise ValueError("Field name must contain at least one letter")
 
     # Finally, ensure the field name is not a Python keyword
     if keyword.iskeyword(field_name):

soar_sdk/code_renderers/asset_renderer.py

@@ -17,6 +17,7 @@ class AssetContext:
     default: Union[str, int, float, bool, None]
     data_type: str
     value_list: Optional[list[str]]
+    alias: Optional[str] = None
 
     @property
     def is_str(self) -> bool:
@@ -38,7 +39,7 @@ class AssetContext:
 
 
 class AssetRenderer(AstRenderer[list[AssetContext]]):
-    """A class to render an app's Asset class using Jinja2 templates."""
+    """A class to render an app's Asset class using ASTs."""
 
     def render_ast(self) -> Iterator[ast.stmt]:
         """Render the Asset class by building an AST.
@@ -96,6 +97,11 @@ class AssetRenderer(AstRenderer[list[AssetContext]]):
                     )
                 )
 
+            if field.alias is not None:
+                field_kwargs.append(
+                    ast.keyword(arg="alias", value=ast.Constant(value=field.alias))
+                )
+
             field_statement = ast.AnnAssign(
                 target=field_name,
                 annotation=field_type,

soar_sdk/params.py

@@ -21,6 +21,7 @@ def Param(
     cef_types: Optional[list] = None,
     allow_list: bool = False,
     sensitive: bool = False,
+    alias: Optional[str] = None,
 ) -> Any:  # noqa: ANN401
     """Representation of a single complex action parameter.
 
@@ -64,6 +65,7 @@ def Param(
         cef_types=cef_types,
         allow_list=allow_list,
         sensitive=sensitive,
+        alias=alias,
     )
 
 
@@ -135,7 +137,7 @@ class Params(BaseModel):
             if value_list := field.field_info.extra.get("value_list"):
                 params_field["value_list"] = value_list
 
-            params[field_name] = params_field
+            params[field.alias] = params_field
 
         return params
 

{splunk_soar_sdk-1.3.4.dist-info → splunk_soar_sdk-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 1.3.4
+Version: 1.4.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.3.4.dist-info → splunk_soar_sdk-1.4.1.dist-info}/RECORD

@@ -1,11 +1,11 @@
 soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
-soar_sdk/abstract.py,sha256=2PHRzvQSTOx5jjfshwV9XBK96UD7FAzY9lAE8K7wkyU,7656
+soar_sdk/abstract.py,sha256=2fYEc_xdhz635RnUn5Fn7odTuNkzqQ_YjKF25A-KjNM,7863
 soar_sdk/action_results.py,sha256=gAQwHjXbkkzOJTmQnLwBjKjwbuz8mSPyqIVcirVS598,10114
 soar_sdk/actions_manager.py,sha256=vYglKejmPX1MldTzafCVE2K60UiSLhNGfYcVOxD4YwU,5884
-soar_sdk/app.py,sha256=E0XMDEa0ol_Dayxbyo6ITw_YJflCswnW_Gk0n6tyGnM,29160
+soar_sdk/app.py,sha256=lCCOLKfpUxE9WgLYn_S83riHe4vL2Kzcgda2ra4xNs4,29207
 soar_sdk/app_cli_runner.py,sha256=uk9V-cbAHx1tzK_1gCYpfdF7IJ_ZwuWV2Ak4NMOvKGA,11873
-soar_sdk/app_client.py,sha256=Oh8OqU6lbD6CdR47A4maZJKlzXlfwpzPmw3N0gXtqOs,5762
-soar_sdk/asset.py,sha256=_PZnbroenzfyGup7wcFsyJG_2TFcy19hf0Gi1gkBdsQ,10611
+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
 soar_sdk/colors.py,sha256=--i_iXqfyITUz4O95HMjfZQGbwFZ34bLmBhtfpXXqlQ,1095
 soar_sdk/compat.py,sha256=jW3l9vJ7jLUicZ9SvfFrL4l3H84DQHUYSBy0-51VE3s,2620
@@ -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=BKhS71uEqWUG4Wb8vIrY3lpp6-c6H6Pv8I2U4XFyA6A,7560
+soar_sdk/params.py,sha256=K16_umW_dAfvqa2QcHR2XHc93py-k7SVOHdz3GUGFGk,7615
 soar_sdk/paths.py,sha256=XhpanQCAiTXaulRx440oKu36mnll7P05TethHXgMpgQ,239
 soar_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/types.py,sha256=uMFnNOHpmCLrbAhQOgmXjScXiGE67sM8ySN04MhkC3U,602
@@ -31,12 +31,12 @@ soar_sdk/app_templates/basic_app/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeu
 soar_sdk/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/cli/cli.py,sha256=62n6b41bjXILtkqLTpeID8JyDYMbkfXNV1LCo52YUsA,926
 soar_sdk/cli/path_utils.py,sha256=rFJDAe-sTC_6KgSiidlD3JcpygFmyHAEsn1j_6eWpIc,1263
-soar_sdk/cli/utils.py,sha256=9apx_uUU84pIlPa-KVTLVKTM1osmVfAF_gdn2vQlv6Q,1229
+soar_sdk/cli/utils.py,sha256=GNZLFAMH_BKQo2-D5GvweWxeuR7DfR8eMZS4-sJUggU,1441
 soar_sdk/cli/init/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-soar_sdk/cli/init/cli.py,sha256=h0sqAOYl1xB039YKC1sB4bP2iA2hvZM72ywx3wvBORc,13866
+soar_sdk/cli/init/cli.py,sha256=bVp8t28FYCS_wP2FhLWqmIvCkFbqmO1-7Dw8PpTFNq0,14495
 soar_sdk/cli/manifests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/cli/manifests/cli.py,sha256=cly5xVdj4bBIdZVMQPIWTXRgUfd1ON3qKO-76Fwql18,524
-soar_sdk/cli/manifests/deserializers.py,sha256=lw8tRIN1qWf9XPeb3HocFFa-QVyZEoVU3Jn9bs4qf90,15936
+soar_sdk/cli/manifests/deserializers.py,sha256=FtXv-OywYGb_O5TptS2Hg6niWcfihRPF_RaS5zDBXRk,17045
 soar_sdk/cli/manifests/processors.py,sha256=anR_7TledkYvPWtcMakzO4JWO1iNWlj6lQBx7cD5hmE,4140
 soar_sdk/cli/manifests/serializers.py,sha256=HA7a3DSzB3P-v2yomAMZW0M1__wY2yCNLU_v0QZv7Vo,3245
 soar_sdk/cli/package/cli.py,sha256=oCpP9E3PtXq-zCdzQD8Z-4dowKF1YT-uKjTpbt_YT-A,9516
@@ -44,7 +44,7 @@ soar_sdk/cli/package/utils.py,sha256=JmVf_PwoXiuypE1DZ1-k4sFjZszD0c_BYTiLtwy9jDk
 soar_sdk/code_renderers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/code_renderers/action_renderer.py,sha256=Un2QwuYwa3kX0IiTdrjx_nsfszorfbGxK2stXbC5E1g,13938
 soar_sdk/code_renderers/app_renderer.py,sha256=cxXj0BwWY_1qOcmdWZ-2s6l8x1XEMRm20_LIKv5Dx5g,7408
-soar_sdk/code_renderers/asset_renderer.py,sha256=LNVVqVqbkgocTipwYMoJlO6z5MEyykNo4N6kHCIkWmA,3680
+soar_sdk/code_renderers/asset_renderer.py,sha256=f2e2jC43nD0S_bOOfABs-e6Okcyn8znHd_H46TOaue0,3880
 soar_sdk/code_renderers/renderer.py,sha256=oDlmU-MzDqpc4Yq6zupoT4XN-vRjgL4UV5lOGTLeqkg,1242
 soar_sdk/code_renderers/toml_renderer.py,sha256=-zP8UzlYMCVVA5ex9slaNLeFTu4xLjkv88YLmRNLrTM,1505
 soar_sdk/code_renderers/templates/pyproject.toml.jinja,sha256=Ti6A5kWMb902Lbd1kmw8qPgVDPNNzlV6rd0pcVEbVUo,3917
@@ -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.3.4.dist-info/METADATA,sha256=kfGr_Urdi1ATwcPSb5z5ZyAtYpkKzCp-kXWXaokO21g,7355
-splunk_soar_sdk-1.3.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-1.3.4.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-1.3.4.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-1.3.4.dist-info/RECORD,,
+splunk_soar_sdk-1.4.1.dist-info/METADATA,sha256=mAYVSNDk067JSRxMrKll00jaNgNZWH5tF5syV5fZxoQ,7355
+splunk_soar_sdk-1.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-1.4.1.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-1.4.1.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-1.4.1.dist-info/RECORD,,