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

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

@@ -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 → splunk_soar_sdk-1.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "1.3.4"
+version = "1.4.1"
 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.1/release_notes.txt

@@ -0,0 +1,31 @@
+## [1.4.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.4.0...1.4.1) (2025-09-10)
+
+
+### Bug Fixes
+
+* cleanup based on pytest and pr review ([8de0911](https://github.com/phantomcyber/splunk-soar-sdk/commit/8de0911de5c1929aaed898ea81e92a38b7a03974))
+* convert illegal field names to aliases when converting asset or action params ([9cde111](https://github.com/phantomcyber/splunk-soar-sdk/commit/9cde111dfb245fb8e2604e59a8a4fc8512768b7d))
+* normalize_field_names removes leading underscores ([3880b09](https://github.com/phantomcyber/splunk-soar-sdk/commit/3880b09f438c8734c506c146cbe5cdd4521219cd))
+* update converted apps to use the default python versions ([156853c](https://github.com/phantomcyber/splunk-soar-sdk/commit/156853cfe3376ab89f37692e52dc343468a314af))
+* use correct datatypes for default asset values when converting ([c2838ff](https://github.com/phantomcyber/splunk-soar-sdk/commit/c2838ff172517d7f38650692f8e6e61176268382))
+* when deserializing action params, treat them as optional by default ([d2d3b48](https://github.com/phantomcyber/splunk-soar-sdk/commit/d2d3b48ddd1ded8a6b432d33f6867fb394fe17ab))
+
+
+
+
+
+## [1.4.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.4.0...1.4.1) (2025-09-10)
+
+
+### Bug Fixes
+
+* cleanup based on pytest and pr review ([8de0911](https://github.com/phantomcyber/splunk-soar-sdk/commit/8de0911de5c1929aaed898ea81e92a38b7a03974))
+* convert illegal field names to aliases when converting asset or action params ([9cde111](https://github.com/phantomcyber/splunk-soar-sdk/commit/9cde111dfb245fb8e2604e59a8a4fc8512768b7d))
+* normalize_field_names removes leading underscores ([3880b09](https://github.com/phantomcyber/splunk-soar-sdk/commit/3880b09f438c8734c506c146cbe5cdd4521219cd))
+* update converted apps to use the default python versions ([156853c](https://github.com/phantomcyber/splunk-soar-sdk/commit/156853cfe3376ab89f37692e52dc343468a314af))
+* use correct datatypes for default asset values when converting ([c2838ff](https://github.com/phantomcyber/splunk-soar-sdk/commit/c2838ff172517d7f38650692f8e6e61176268382))
+* when deserializing action params, treat them as optional by default ([d2d3b48](https://github.com/phantomcyber/splunk-soar-sdk/commit/d2d3b48ddd1ded8a6b432d33f6867fb394fe17ab))
+
+
+
+

splunk_soar_sdk-1.4.1/release_version.txt

@@ -0,0 +1 @@
+1.4.1

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/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.1}/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.1}/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.1}/src/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
 

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/src/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,
             )
         )
 

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/src/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)

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/src/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):

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/src/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,

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/src/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 → splunk_soar_sdk-1.4.1}/tests/cli/test_convert_cli.py

@@ -6,6 +6,7 @@ import json
 
 from typer.testing import CliRunner
 
+from soar_sdk.compat import PythonVersion
 from soar_sdk.meta.actions import ActionMeta
 from soar_sdk.meta.app import AppMeta, AssetFieldSpecification
 
@@ -68,6 +69,16 @@ def test_generate_asset_definition(app_meta, tmp_path):
             data_type="timezone",
             default="UTC",
         ),
+        "number": AssetFieldSpecification(
+            label="Number",
+            required=False,
+            data_type="numeric",
+            default=42,
+        ),
+        "boolean": AssetFieldSpecification(
+            label="boolean", required=False, data_type="boolean", default=True
+        ),
+        "_underscore": AssetFieldSpecification(data_type="string"),
     }
     asset_class = cli.generate_asset_definition_ast(app_meta=app_meta)
 
@@ -78,6 +89,9 @@ def test_generate_asset_definition(app_meta, tmp_path):
             "    username: str = AssetField(required=True, description='The username for the application')",
             "    color: str = AssetField(required=False, default='blue', value_list=['red', 'green', 'blue'])",
             "    timezone: ZoneInfo = AssetField(required=False, default=ZoneInfo('UTC'))",
+            "    number: float = AssetField(required=False, default=42)",
+            "    boolean: bool = AssetField(required=False, default=True)",
+            "    underscore: str = AssetField(required=False, alias='_underscore')",
         ]
     )
 
@@ -173,6 +187,50 @@ def test_convert_cli(runner, tmp_path, app_meta):
     assert (output_dir / "logo_dark.svg").exists()
 
 
+def test_convert_cli_updates_py_versions(runner, tmp_path, app_meta):
+    """Test that convert command generates the expected app structure."""
+
+    app_meta.configuration = {
+        "username": AssetFieldSpecification(
+            label="Username",
+            description="The username for the application",
+            required=True,
+            data_type="string",
+        )
+    }
+
+    app_meta.python_version = [PythonVersion.PY_3_9]
+
+    app_dir = tmp_path / "test_app"
+    app_dir.mkdir()
+    (app_dir / "app.json").write_text(app_meta.json())
+    (app_dir / app_meta.logo).touch()
+    (app_dir / app_meta.logo_dark).touch()
+
+    output_dir = tmp_path / "output"
+
+    with patch("subprocess.run"), patch("shutil.which") as mock_which:
+        mock_which.return_value = "/usr/bin/example"
+
+        result = runner.invoke(
+            cli.convert,
+            [
+                str(app_dir),
+                str(output_dir),
+            ],
+        )
+
+    print(result.output)  # For debugging purposes
+
+    assert result.exit_code == 0
+    assert "declares support for Python versions ['3.9']" in result.output
+    assert "will support the default versions ['3.9', '3.13']" in result.output
+    assert (
+        'requires-python = ">=3.9, <3.14"'
+        in (output_dir / "pyproject.toml").read_text()
+    )
+
+
 def test_convert_cli_with_default_output(runner, tmp_path, app_meta):
     """Test that convert command uses default output directory if not specified."""
 

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/tests/cli/test_deserializers.py

@@ -278,7 +278,21 @@ def test_from_app_json_complex_example(create_app_json):
                 "required": True,
                 "description": "Base Url",
                 "order": 0,
-            }
+            },
+            "port": {
+                "data_type": "numeric",
+                "required": False,
+                "description": "Port Number",
+                "default": 8080,
+                "order": 1,
+            },
+            "verify": {
+                "data_type": "boolean",
+                "required": False,
+                "description": "Verify",
+                "default": True,
+                "order": 2,
+            },
         },
         "actions": [
             {
@@ -313,6 +327,9 @@ def test_from_app_json_complex_example(create_app_json):
         assert len(result.actions) == 1
         assert result.fips_compliant is False
         assert result.configuration["base_url"]["data_type"] == "string"
+        assert result.configuration["port"]["default"] == 8080
+        assert type(result.configuration["verify"]["default"]) is bool
+        assert result.configuration["verify"]["default"]
 
 
 @pytest.mark.parametrize(
@@ -406,7 +423,19 @@ def test_from_action_json_with_parameters_and_output(mock_action_deserializer):
                 "data_type": "string",
                 "required": True,
                 "description": "Test parameter",
-            }
+            },
+            "param2": {
+                "data_type": "numeric",
+                "required": False,
+                "description": "Another parameter",
+                "default": 42,
+            },
+            "param3": {
+                "data_type": "boolean",
+                "required": False,
+                "description": "Yet another parameter",
+                "default": True,
+            },
         },
         "output": [
             {"data_path": "action_result.data.*.result"},
@@ -427,6 +456,23 @@ def test_from_action_json_with_parameters_and_output(mock_action_deserializer):
         "custom action", original_parameters
     )
     mocks["parse_output"].assert_called_once_with("custom action", original_output)
+    assert original_parameters["param1"] == {
+        "data_type": "string",
+        "description": "Test parameter",
+        "required": True,
+    }
+    assert original_parameters["param2"] == {
+        "data_type": "numeric",
+        "description": "Another parameter",
+        "required": False,
+        "default": 42,
+    }
+    assert original_parameters["param3"] == {
+        "data_type": "boolean",
+        "description": "Yet another parameter",
+        "required": False,
+        "default": True,
+    }
 
 
 def test_from_action_json_missing_optional_fields(mock_action_deserializer):
@@ -502,6 +548,28 @@ def test_action_deserializer_parse_parameters(input_data, expects_base_class):
         assert result.__name__ == "TestActionParams"
 
 
+def test_action_deserializer_uses_correct_default_params():
+    """Test ActionDeserializer sets `required`, `primary`, and `allow_list` false when no defaults are provided."""
+    result = ActionDeserializer.parse_parameters(
+        "test_action", {"param1": {"data_type": "string", "description": "test param"}}
+    )
+
+    field = result.__fields__["param1"]
+    assert not field.field_info.extra.get("required")
+    assert not field.field_info.extra.get("primary")
+    assert not field.field_info.extra.get("allow_list")
+
+
+def test_action_deserializer_with_underscored_params():
+    """Test that the ActionDeserializer handles underscored parameters as expected"""
+    result = ActionDeserializer.parse_parameters(
+        "test_action", {"_underscore": {"data_type": "string"}}
+    )
+
+    field = result.__fields__["underscore"]
+    assert field.alias == "_underscore"
+
+
 @pytest.mark.parametrize(
     "input_data,expects_base_class",
     [
@@ -619,6 +687,12 @@ def test_parse_parameters_with_complex_params():
             "description": "Placeholder parameter",
             "order": 3,
         },
+        "_param5": {
+            "data_type": "string",
+            "required": False,
+            "description": "Placeholder parameter",
+            "order": 3,
+        },
     }
 
     result = ActionDeserializer.parse_parameters("complex_action", complex_params)
@@ -633,6 +707,10 @@ def test_parse_parameters_with_complex_params():
     assert "param1" in result.__annotations__
     assert "param2" in result.__annotations__
     assert "param3" in result.__annotations__
+    assert "param4" not in result.__annotations__
+
+    assert "param5" in result.__fields__
+    assert result.__fields__["param5"].alias == "_param5"
 
 
 def test_complex_output_specification():

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/tests/cli/test_serializers.py

@@ -41,6 +41,7 @@ def test_params_serialize_fields_info():
         send_notifications: bool = Param(default=True)
         platform: str = Param(value_list=["windows", "linux", "mac"])
         api_key: str = Param(sensitive=True)
+        underscored_field: str = Param(alias="_underscored_field")
 
     serialized_params = ParamsSerializer.serialize_fields_info(SampleParams)
 
@@ -112,6 +113,15 @@ def test_params_serialize_fields_info():
             "allow_list": False,
             "order": 6,
         },
+        "_underscored_field": {
+            "name": "underscored_field",
+            "description": "Underscored Field",
+            "data_type": "string",
+            "required": True,
+            "primary": False,
+            "allow_list": False,
+            "order": 7,
+        },
     }
 
     assert serialized_params == expected_params
@@ -152,6 +162,7 @@ def test_outputs_serialize_output_class():
         list_value: list[str]
         cef_value: str = OutputField(cef_types=["ip"], example_values=["1.1.1.1"])
         nested_value: SampleNestedOutput
+        underscored_value: str = OutputField(alias="_underscored_value")
 
     serialized_outputs = OutputsSerializer.serialize_datapaths(Params, SampleOutput)
 
@@ -188,6 +199,10 @@ def test_outputs_serialize_output_class():
             "data_type": "boolean",
             "example_values": [True, False],
         },
+        {
+            "data_path": "action_result.data.*._underscored_value",
+            "data_type": "string",
+        },
         {
             "data_path": "summary.total_objects",
             "data_type": "numeric",

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/tests/cli/test_utils.py

@@ -13,21 +13,21 @@ class TestNormalizeFieldName:
             # Valid identifiers that shouldn't be modified
             ("valid_name", "valid_name", False),
             ("ValidName", "ValidName", False),
-            ("_private", "_private", False),
             ("name123", "name123", False),
-            ("_", "_", False),
-            ("__dunder__", "__dunder__", False),
+            # Names starting with underscores
+            ("_private", "private", True),
+            ("__dunder__", "dunder__", True),
             # Names starting with digits
-            ("123invalid", "_123invalid", True),
+            ("123invalid", "n123invalid", True),
             # Names with invalid characters
             (
                 "a-b.c d@e$f#g%h!i+j=k/l\\m|n&o*p(q)r[s]t{u}v<w>x:y;z,?'\"",
                 "a_b_c_d_e_f_g_h_i_j_k_l_m_n_o_p_q_r_s_t_u_v_w_x_y_z____",
                 True,
             ),
-            ("🚀rocket-ship🚀", "_rocket_ship_", True),
+            ("🚀rocket-ship🚀", "rocket_ship_", True),
             # Mixed issues: starting with digit and invalid characters
-            ("123field@name", "_123field_name", True),
+            ("123field@name", "n123field_name", True),
         ],
     )
     def test_basic_normalization(
@@ -41,7 +41,9 @@ class TestNormalizeFieldName:
         assert result.modified == expected_modified
         assert result.normalized.isidentifier()
 
-    @pytest.mark.parametrize("keyword", keyword.kwlist)
+    @pytest.mark.parametrize(
+        "keyword", [kw for kw in keyword.kwlist if not kw.startswith("_")]
+    )
     def test_python_keywords(self, keyword: str):
         """Test that Python keywords get an underscore appended."""
         result = normalize_field_name(keyword)
@@ -55,3 +57,6 @@ class TestNormalizeFieldName:
         """Test edge cases and boundary conditions."""
         with pytest.raises(ValueError, match="empty"):
             normalize_field_name("")
+
+        with pytest.raises(ValueError, match="must contain at least one letter"):
+            normalize_field_name("______")

{splunk_soar_sdk-1.3.4 → splunk_soar_sdk-1.4.1}/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.1}/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.1}/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