splunk-soar-sdk 3.6.0__tar.gz → 3.6.1__tar.gz

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/.github/workflows/integration_tests.yml

@@ -121,8 +121,7 @@ jobs:
           uv run soarapps package install \
             /tmp/example_app_with_webhook.tgz \
             "$phantom_ip" \
-            --username "${{ vars.PHANTOM_USERNAME }}" \
-            --force
+            --username "${{ vars.PHANTOM_USERNAME }}"
 
       - name: Run integration tests
         env:

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/PKG-INFO

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

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

splunk_soar_sdk-3.6.1/release_notes.txt

@@ -0,0 +1,21 @@
+## [3.6.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.6.0...3.6.1) (2025-12-15)
+
+
+### Bug Fixes
+
+* record paths in the manifest correctly when building wheels from source ([644889c](https://github.com/phantomcyber/splunk-soar-sdk/commit/644889c26bf2751df2d6166a30a47d0705b3344e))
+
+
+
+
+
+## [3.6.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.6.0...3.6.1) (2025-12-15)
+
+
+### Bug Fixes
+
+* record paths in the manifest correctly when building wheels from source ([644889c](https://github.com/phantomcyber/splunk-soar-sdk/commit/644889c26bf2751df2d6166a30a47d0705b3344e))
+
+
+
+

splunk_soar_sdk-3.6.1/release_version.txt

@@ -0,0 +1 @@
+3.6.1

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/src/soar_sdk/cli/package/cli.py

@@ -27,35 +27,51 @@ package = typer.Typer()
 console = Console()  # For printing lots of pretty colors and stuff
 
 
-async def collect_all_wheels(wheels: set[DependencyWheel]) -> list[tuple[str, bytes]]:
-    """Asynchronously collect all wheels from the given set of DependencyWheel objects."""
-    # Create progress bar for tracking wheel collection
+async def collect_all_wheels(wheels: list[DependencyWheel]) -> list[tuple[str, bytes]]:
+    """Asynchronously collect all wheels from the given list of DependencyWheel objects.
+
+    Downloads/builds each unique wheel once while updating every DependencyWheel instance
+    so the manifest records the final wheel filenames.
+    """
+    dedupe_map: dict[int, list[DependencyWheel]] = {}
+    for wheel in wheels:
+        key = hash(wheel)
+        dedupe_map.setdefault(key, []).append(wheel)
+
     progress = tqdm(
-        total=len(wheels),
+        total=len(dedupe_map),
         desc="Downloading wheels",
         unit="wheel",
         colour="green",
         ncols=80,
     )
 
-    async def collect_from_wheel(wheel: DependencyWheel) -> list[tuple[str, bytes]]:
-        result = []
-        # This actually is covered, but pytest-cov branch coverage
-        # has a bug with the end of async for loops
+    async def collect_from_wheel(
+        cache_key: int, wheel: DependencyWheel
+    ) -> tuple[int, list[tuple[str, bytes]]]:
+        result: list[tuple[str, bytes]] = []
         async for path, data in wheel.collect_wheels():  # pragma: no cover
             result.append((path, data))
-        # Update progress bar after each wheel is processed
         progress.update(1)
-        return result
+        return cache_key, result
 
-    # Use asyncio.gather to truly run all wheel collections concurrently
     with contextlib.closing(progress):
-        wheel_data_lists = await asyncio.gather(
-            *(collect_from_wheel(wheel) for wheel in wheels)
+        gathered_results = await asyncio.gather(
+            *(
+                collect_from_wheel(key, wheel_group[0])
+                for key, wheel_group in dedupe_map.items()
+            )
         )
 
-    # Use itertools.chain to flatten the list of lists
-    return list(chain.from_iterable(wheel_data_lists))
+    cache = dict(gathered_results)
+
+    for key, wheel_group in dedupe_map.items():
+        for path, _ in cache[key]:
+            wheel_name = Path(path).name
+            for wheel in wheel_group:
+                wheel._record_built_wheel(wheel_name)
+
+    return list(chain.from_iterable(cache.values()))
 
 
 @package.command()
@@ -124,13 +140,13 @@ def build(
 
         with tarfile.open(output_file, "w:gz") as app_tarball:
             # Collect all wheels from both Python versions
-            all_wheels = set(
+            all_wheels = (
                 app_meta.pip313_dependencies.wheel + app_meta.pip314_dependencies.wheel
             )
 
             # Run the async collection function within an event loop
             console.print(
-                f"[yellow]Collecting [bold]{len(all_wheels)}[/bold] wheel{'' if len(all_wheels) == 1 else 's'} for package[/]"
+                f"[yellow]Collecting [bold]{len(all_wheels)}[/bold] wheel{'' if len(set(all_wheels)) == 1 else 's'} for package[/]"
             )
             wheel_data = asyncio.run(collect_all_wheels(all_wheels))
 

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/src/soar_sdk/meta/dependencies.py

@@ -219,18 +219,41 @@ class DependencyWheel(BaseModel):
     sdist: UvSourceDistribution | None = Field(exclude=True, default=None)
     source_dir: UvSourceDirectory | None = Field(exclude=True, default=None)
 
+    def _set_wheel_paths(self, wheel_name: str) -> str:
+        """Assign the final wheel path (with any existing prefix) to both arches."""
+        base_path = Path(self.input_file or "wheels/shared")
+        # If there's already a filename component, replace it instead of nesting it
+        if base_path.suffix == ".whl":
+            base_path = base_path.parent
+        wheel_path = (base_path / wheel_name).as_posix()
+        self.input_file = wheel_path
+        self.input_file_aarch64 = wheel_path
+        return wheel_path
+
+    def set_placeholder_wheel_name(self, version: str) -> None:
+        """Populate a clearly placeholder wheel path when we expect to build from source."""
+        # Use only a filename here; platform-specific prefixes are added later.
+        self.input_file = "<to_be_built>.whl"
+        self.input_file_aarch64 = "<to_be_built>.whl"
+
+    def _record_built_wheel(self, wheel_name: str) -> str:
+        """Fill in missing wheel paths once a wheel has been built from source."""
+        return self._set_wheel_paths(wheel_name)
+
     async def collect_wheels(self) -> AsyncGenerator[tuple[str, bytes]]:
         """Collect a list of wheel files to fetch for this dependency across all platforms."""
         if self.wheel is None and self.sdist is not None:
             logger.info(f"Building sdist for {self.input_file}")
             wheel_name, wheel_bytes = await self.sdist.fetch_and_build()
-            yield (f"wheels/shared/{wheel_name}", wheel_bytes)
+            wheel_path = self._record_built_wheel(wheel_name)
+            yield (wheel_path, wheel_bytes)
             return
 
         if self.wheel is None and self.source_dir is not None:
             logger.info(f"Building local sources for {self.input_file}")
             wheel_name, wheel_bytes = self.source_dir.build()
-            yield (f"wheels/shared/{wheel_name}", wheel_bytes)
+            wheel_path = self._record_built_wheel(wheel_name)
+            yield (wheel_path, wheel_bytes)
             return
 
         if self.wheel is None:
@@ -398,12 +421,14 @@ class UvPackage(BaseModel):
             and UvLock.normalize_package_name(self.name) in DEPENDENCIES_TO_BUILD
         ):
             wheel.sdist = self.sdist
+            wheel.set_placeholder_wheel_name(self.version)
 
         if (
             self.source.directory is not None
             and UvLock.normalize_package_name(self.name) in DEPENDENCIES_TO_BUILD
         ):
             wheel.source_dir = UvSourceDirectory(directory=self.source.directory)
+            wheel.set_placeholder_wheel_name(self.version)
 
         try:
             wheel_x86_64 = self._find_wheel(
@@ -429,7 +454,7 @@ class UvPackage(BaseModel):
             wheel.input_file_aarch64 = f"{wheel_aarch64.basename}.whl"
             wheel.wheel_aarch64 = wheel_aarch64
         except FileNotFoundError:
-            if wheel.sdist is None:
+            if wheel.sdist is None and wheel.source_dir is None:
                 logger.warning(
                     f"Could not find a suitable aarch64 wheel for {self.name=}, {self.version=}, {abi_precedence=}, {python_precedence=} -- the built package might not work on ARM systems"
                 )

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/tests/cli/test_package_cli.py

@@ -1,3 +1,4 @@
+import json
 import tarfile
 from pathlib import Path
 from unittest.mock import patch
@@ -10,7 +11,7 @@ from typer.testing import CliRunner
 from soar_sdk.cli.package.cli import package
 from soar_sdk.cli.package.utils import phantom_get_login_session, phantom_install_app
 from soar_sdk.cli.path_utils import context_directory
-from soar_sdk.meta.dependencies import UvWheel
+from soar_sdk.meta.dependencies import UvSourceDirectory, UvWheel
 
 runner = CliRunner()
 
@@ -223,6 +224,57 @@ def test_package_build_with_sdk_templates(wheel_resp_mock, tmp_path: Path):
             assert any("templates/base/base_template.html" in name for name in members)
 
 
+def test_package_build_writes_manifest_wheel_paths(
+    wheel_resp_mock, tmp_path: Path
+) -> None:
+    """Ensure built package includes a manifest with real wheel filenames."""
+    example_app = Path.cwd() / "tests/example_app"
+    destination = tmp_path / "example_app.tgz"
+
+    local_wheel = "local-sdk-1.0.0.whl"
+
+    with (
+        context_directory(tmp_path),
+        patch.object(UvWheel, "validate_hash", return_value=None),
+        patch.object(UvSourceDirectory, "build", return_value=(local_wheel, b"data")),
+    ):
+        result = runner.invoke(
+            package,
+            [
+                "build",
+                example_app.as_posix(),
+            ],
+        )
+
+    assert result.exit_code == 0, result.stdout
+
+    with tarfile.open(destination, "r:gz") as tar:
+        manifest_member = next(
+            (m for m in tar.getmembers() if m.name.endswith("manifest.json")), None
+        )
+        assert manifest_member is not None
+
+        manifest_file = tar.extractfile(manifest_member)
+        assert manifest_file is not None
+
+        manifest = json.loads(manifest_file.read())
+
+    expected_path = f"wheels/shared/{local_wheel}"
+    expected_wheel = {
+        "module": "splunk-soar-sdk",
+        "input_file": expected_path,
+        "input_file_aarch64": expected_path,
+    }
+    for py_version in ["313", "314"]:
+        section = f"pip{py_version}_dependencies"
+        for wheel in manifest[section]["wheel"]:
+            print(wheel)
+            if wheel == expected_wheel:
+                break
+        else:
+            raise AssertionError(f"Expected wheel not found in {section}")
+
+
 def test_package_build_without_app_templates(wheel_resp_mock, tmp_path: Path):
     example_app = Path.cwd() / "tests/example_app"
 

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/tests/example_app/app.json

@@ -15,7 +15,7 @@
     "python_version": "3.13,3.14",
     "product_version_regex": ".*",
     "publisher": "Splunk Inc.",
-    "utctime_updated": "2025-12-11T18:07:07.208512Z",
+    "utctime_updated": "2025-12-12T23:35:54.322661Z",
     "fips_compliant": false,
     "contributors": [],
     "configuration": {
@@ -1138,7 +1138,8 @@
             },
             {
                 "module": "splunk-soar-sdk",
-                "input_file": "wheels/shared/"
+                "input_file": "wheels/shared/<to_be_built>.whl",
+                "input_file_aarch64": "wheels/shared/<to_be_built>.whl"
             },
             {
                 "module": "toml",
@@ -1346,7 +1347,8 @@
             },
             {
                 "module": "splunk-soar-sdk",
-                "input_file": "wheels/shared/"
+                "input_file": "wheels/shared/<to_be_built>.whl",
+                "input_file_aarch64": "wheels/shared/<to_be_built>.whl"
             },
             {
                 "module": "toml",

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/tests/example_app/uv.lock

@@ -979,7 +979,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "3.4.0"
+version = "3.6.0"
 source = { directory = "../../" }
 dependencies = [
     { name = "beautifulsoup4", marker = "(platform_machine == 'arm64' and sys_platform == 'darwin') or (platform_machine == 'x86_64' and sys_platform == 'darwin') or (platform_machine == 'aarch64' and sys_platform == 'linux') or (platform_machine == 'x86_64' and sys_platform == 'linux')" },
@@ -1015,12 +1015,14 @@ requires-dist = [
     { name = "jinja2", specifier = ">=3.1.0" },
     { name = "packaging", specifier = ">=25.0" },
     { name = "pydantic", specifier = ">=2,<3" },
+    { name = "python-magic", marker = "extra == 'email'", specifier = ">=0.4.27" },
     { name = "requests", specifier = "<3" },
     { name = "setuptools", specifier = ">=80.9.0" },
     { name = "toml", specifier = ">=0.10.2,<1" },
     { name = "tqdm", specifier = ">=4.67.1" },
     { name = "typer", specifier = ">=0.12.5,<1" },
 ]
+provides-extras = ["email"]
 
 [package.metadata.requires-dev]
 dev = [

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/tests/example_app_with_webhook/app.json

@@ -15,7 +15,7 @@
     "python_version": "3.13,3.14",
     "product_version_regex": ".*",
     "publisher": "Splunk Inc.",
-    "utctime_updated": "2025-12-11T18:07:29.807371Z",
+    "utctime_updated": "2025-12-12T23:36:44.577977Z",
     "fips_compliant": false,
     "contributors": [],
     "configuration": {
@@ -323,7 +323,8 @@
             },
             {
                 "module": "splunk-soar-sdk",
-                "input_file": "wheels/shared/"
+                "input_file": "wheels/shared/<to_be_built>.whl",
+                "input_file_aarch64": "wheels/shared/<to_be_built>.whl"
             },
             {
                 "module": "toml",
@@ -551,7 +552,8 @@
             },
             {
                 "module": "splunk-soar-sdk",
-                "input_file": "wheels/shared/"
+                "input_file": "wheels/shared/<to_be_built>.whl",
+                "input_file_aarch64": "wheels/shared/<to_be_built>.whl"
             },
             {
                 "module": "toml",

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/tests/example_app_with_webhook/uv.lock

@@ -1010,7 +1010,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "3.4.0"
+version = "3.6.0"
 source = { directory = "../../" }
 dependencies = [
     { name = "beautifulsoup4", marker = "(platform_machine == 'arm64' and sys_platform == 'darwin') or (platform_machine == 'x86_64' and sys_platform == 'darwin') or (platform_machine == 'aarch64' and sys_platform == 'linux') or (platform_machine == 'x86_64' and sys_platform == 'linux')" },
@@ -1046,12 +1046,14 @@ requires-dist = [
     { name = "jinja2", specifier = ">=3.1.0" },
     { name = "packaging", specifier = ">=25.0" },
     { name = "pydantic", specifier = ">=2,<3" },
+    { name = "python-magic", marker = "extra == 'email'", specifier = ">=0.4.27" },
     { name = "requests", specifier = "<3" },
     { name = "setuptools", specifier = ">=80.9.0" },
     { name = "toml", specifier = ">=0.10.2,<1" },
     { name = "tqdm", specifier = ">=4.67.1" },
     { name = "typer", specifier = ">=0.12.5,<1" },
 ]
+provides-extras = ["email"]
 
 [package.metadata.requires-dev]
 dev = [

{splunk_soar_sdk-3.6.0 → splunk_soar_sdk-3.6.1}/uv.lock

@@ -1209,7 +1209,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "3.6.0"
+version = "3.6.1"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4", marker = "(platform_machine == 'arm64' and sys_platform == 'darwin') or (platform_machine == 'x86_64' and sys_platform == 'darwin') or (platform_machine == 'aarch64' and sys_platform == 'linux') or (platform_machine == 'x86_64' and sys_platform == 'linux')" },

splunk_soar_sdk-3.6.0/release_notes.txt

@@ -1,37 +0,0 @@
-# [3.6.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.5.0...3.6.0) (2025-12-12)
-
-
-### Bug Fixes
-
-* remove the useless test files from the root of the repo ([f529497](https://github.com/phantomcyber/splunk-soar-sdk/commit/f529497a397a9879dbe5e264a2b562916b6bbcf8))
-
-
-### Features
-
-* add `supports_es_polling` field to manifest ([0eb75dd](https://github.com/phantomcyber/splunk-soar-sdk/commit/0eb75dd56a7fb512fff0533bdb64317d4de776d6))
-* add a client for submitting ES findings ([23bf0b7](https://github.com/phantomcyber/splunk-soar-sdk/commit/23bf0b7bea5e9437bffecfe783a20abf9c4eb35b))
-* enable building the SDK from a local directory instead of fetching wheel ([8ca7a6c](https://github.com/phantomcyber/splunk-soar-sdk/commit/8ca7a6c007b740c56db2407306a32363d203da76))
-* update ES polling to use the new workflow ([d69784c](https://github.com/phantomcyber/splunk-soar-sdk/commit/d69784c462eccab6f5a0796cc9573cff5e816a1c))
-
-
-
-
-
-# [3.6.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.5.0...3.6.0) (2025-12-12)
-
-
-### Bug Fixes
-
-* remove the useless test files from the root of the repo ([f529497](https://github.com/phantomcyber/splunk-soar-sdk/commit/f529497a397a9879dbe5e264a2b562916b6bbcf8))
-
-
-### Features
-
-* add `supports_es_polling` field to manifest ([0eb75dd](https://github.com/phantomcyber/splunk-soar-sdk/commit/0eb75dd56a7fb512fff0533bdb64317d4de776d6))
-* add a client for submitting ES findings ([23bf0b7](https://github.com/phantomcyber/splunk-soar-sdk/commit/23bf0b7bea5e9437bffecfe783a20abf9c4eb35b))
-* enable building the SDK from a local directory instead of fetching wheel ([8ca7a6c](https://github.com/phantomcyber/splunk-soar-sdk/commit/8ca7a6c007b740c56db2407306a32363d203da76))
-* update ES polling to use the new workflow ([d69784c](https://github.com/phantomcyber/splunk-soar-sdk/commit/d69784c462eccab6f5a0796cc9573cff5e816a1c))
-
-
-
-

splunk_soar_sdk-3.6.0/release_version.txt

@@ -1 +0,0 @@
-3.6.0