fix: building json file in each job

Author: tapishj-splunk

local_hooks/app_tests/json_tests.py

@@ -22,6 +22,8 @@
 from packaging.version import Version
 from pathlib import Path
 
+SKIP_SDK_APP = {"success": True, "message": "TEST SKIPPED - SDK app detected"}
+
 
 class JSONTests(TestSuite):
     def __init__(self, repo_location: Path) -> None:
@@ -30,12 +32,6 @@ def __init__(self, repo_location: Path) -> None:
 
         self._app_is_certified = self._parser.app_json["publisher"] == "Splunk"
 
-    def _skip_if_sdk_app(self):
-        """Helper method to skip tests for SDK apps"""
-        if self._parser.uv_lock_file is not None:
-            return {"success": True, "message": "TEST SKIPPED - SDK app detected"}
-        return None
-
     @staticmethod
     def format_as_index(indices: list[Any], container: str = "schema") -> str:
         """
@@ -64,8 +60,8 @@ def validate_json_schema(self):
         """
         Validates the structure of the app json
         """
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         APP_TESTS_DIR = Path(__file__).parent.resolve()
         schema_path = APP_TESTS_DIR / "app_schema.json"
@@ -97,8 +93,8 @@ def check_extra_fields_app_json(self):
         """
         Makes sure certain fields are not in the app json
         """
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         to_remove = []
         msg = TEST_PASS_MESSAGE
@@ -123,8 +119,8 @@ def check_sequential_order(self):
         are sequential and zero-indexed
         """
 
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         def check_sequence(order_tuples):
             try:
@@ -190,8 +186,8 @@ def check_main_module(self):
         """
         Verifies that the main module field of the json is a valid connector filename
         """
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         app_json = self._app_json
         verbose = []
@@ -324,8 +320,8 @@ def check_action_param_prefixes(self):
         """
         Every parameter has an action_result.parameter associated with it
         """
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         app_json_actions = self._app_json.get("actions")
 
@@ -378,8 +374,8 @@ def check_action_param_matching_contains(self):
         """
         Every parameter for an action with contains has an action_result.parameter with the same contains
         """
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         action_list = [act for act in self._app_json["actions"]]
         verbose = []
@@ -422,8 +418,8 @@ def check_minimal_data_paths(self):
         """
         Checks to make sure each action includes the minimal required data paths
         """
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         app_json_actions = [act for act in self._app_json["actions"]]
         verbose = []
@@ -534,8 +530,8 @@ def check_pip313_dependencies(self):
         """
         Ensures pip313_dependencies key exists and has appropriate content based on requirements.txt
         """
-        if skip_result := self._skip_if_sdk_app():
-            return skip_result
+        if self._parser.uv_lovk_filepath:
+            return SKIP_SDK_APP
 
         verbose = []
         message = TEST_PASS_MESSAGE

local_hooks/app_tests/utils/app_parser.py

@@ -9,6 +9,11 @@
 from functools import cached_property
 from pathlib import Path
 from typing import Optional
+from local_hooks.helpers import (
+    find_uv_lock_file,
+    load_sdk_apps_enviornment,
+    generate_sdk_app_manifest,
+)
 
 
 class ParserError(Exception):
@@ -103,16 +108,24 @@ def find_app_json_name(self, json_filenames):
 
     @property
     def _app_json_filepath(self) -> Path:
-        sdk_app_path = self._app_code_dir / "sdk_app_manifest.json"
-        if sdk_app_path.exists():
-            return sdk_app_path
-
         return self._app_code_dir / self.app_json_name
 
+    @cached_property
+    def sdk_app_json(self) -> Path:
+        uv_lock_dir = self.uv_lovk_filepath.parent
+        load_sdk_apps_enviornment(uv_lock_dir)
+        return generate_sdk_app_manifest(uv_lock_dir)
+
+    @cached_property
+    def uv_lovk_filepath(self) -> Optional[Path]:
+        return find_uv_lock_file(self._app_code_dir)
+
     @cached_property
     def app_json(self):
         # Gets the loaded json, preserving key order
         try:
+            if self.uv_lovk_filepath:
+                return self.sdk_app_json
             json_content = json.loads(self._app_json_filepath.read_text())
             return json_content
         except FileNotFoundError as e:

local_hooks/build_docs.py

@@ -21,6 +21,11 @@
 from jinja2 import Environment, FileSystemLoader, select_autoescape
 from jinja2.ext import Extension
 from jinja2.lexer import Token, TokenStream
+from local_hooks.helpers import (
+    find_uv_lock_file,
+    load_sdk_apps_enviornment,
+    generate_sdk_app_manifest,
+)
 
 SCRIPT_DIR = Path(__file__).parent.resolve()
 TEMPLATE_DIR = SCRIPT_DIR / "templates"
@@ -88,6 +93,20 @@ def escape_markdown(data: Any) -> Any:
 
 def get_app_json(app_json_dir, json_name):
     logging.info("Looking for app JSON in: %s", app_json_dir)
+
+    # Check if this is an SDK app and generate manifest if needed
+    if uv_lock_path := find_uv_lock_file(app_json_dir):
+        uv_lock_dir = uv_lock_path.parent
+        logging.info("SDK app detected, generating manifest: UV_LOCK_DIR=%s", uv_lock_dir)
+
+        # Install dependencies from pyproject.toml using uv
+        load_sdk_apps_enviornment(uv_lock_dir)
+
+        # Generate the SDK manifest in a temporary directory
+        logging.info("Generating SDK app manifest in temporary directory")
+        return generate_sdk_app_manifest(uv_lock_dir)
+
+    # Handle non-SDK apps - file-based JSON loading
     if not json_name:
         try:
             app_json_name = next(
@@ -210,6 +229,7 @@ def parse_args() -> BuildDocsArgs:
     help_str = " ".join(line.strip() for line in (__doc__ or "").strip().splitlines())
     parser = argparse.ArgumentParser(description=help_str)
     parser.add_argument("connector_path", help="Path to the connector", type=Path)
+    # prob have to build the manifest here instead of in a seperate hook
     parser.add_argument("--json-name", help="JSON file name")
     return BuildDocsArgs(**vars(parser.parse_args()))
 

local_hooks/generate_notice.py

@@ -13,6 +13,7 @@
 import logging
 from pathlib import Path
 import toml
+from local_hooks.helpers import find_uv_lock_file
 
 
 # pip-licenses is used to query all python packages for license information
@@ -164,10 +165,18 @@ def get_python_license_info(packages: list[str]):
             yield LicenseLine.make_from_pip_json(license_info)
 
 
-def get_app_json(connector_path: Path) -> tuple[str, str]:
+def get_app_json(connector_path: Path, uv_lock_path: Optional[Path]) -> tuple[str, str]:
     """
     Get the app name and license from the app.json file.
     """
+
+    if uv_lock_path:
+        with open(uv_lock_path / "pyproject.toml") as f:
+            toml_data = toml.load(f)
+            app_name = toml_data.get("project", {}).get("name")
+            app_license = toml_data.get("project", {}).get("license")
+            return app_name, app_license
+
     logging.info("Looking for app JSON in: %s", connector_path)
     json_files = glob.glob(os.path.join(connector_path, "*.json"))
     # Exclude files with the pattern '*.postman_collection.json'
@@ -226,25 +235,6 @@ def remove_trailing_blank_lines(notice_file_path: Path):
         f.write("\n")
 
 
-def find_uv_lock_file(connector_path: Path) -> Optional[Path]:
-    """
-    Find uv.lock file in the connector_path or its subdirectories.
-    Returns the path to the uv.lock file if found, None otherwise.
-    """
-    # Check top level directory first
-    uv_lock_path = connector_path / "uv.lock"
-    if uv_lock_path.exists():
-        logging.info("Found uv.lock in top level directory: %s", uv_lock_path)
-        return uv_lock_path
-
-    # Check subdirectories
-    for uv_lock_path in connector_path.rglob("uv.lock"):
-        logging.info("Found uv.lock in subdirectory: %s", uv_lock_path)
-        return uv_lock_path
-
-    return None
-
-
 def get_sdkfied_app_dependencies(pyproject_toml_path: Path) -> list[str]:
     """
     Get the dependencies from the pyproject.toml file.
@@ -265,7 +255,8 @@ def main():
     args = parse_args()
     connector_path = Path(args.connector_path)
 
-    app_name, app_license = get_app_json(connector_path)
+    uv_lock_path = find_uv_lock_file(connector_path)
+    app_name, app_license = get_app_json(connector_path, uv_lock_path.parent)
     notice_file_path = connector_path / "NOTICE"
     logging.info("Creating NOTICE file at %s", Path(notice_file_path.resolve()))
 
@@ -274,7 +265,7 @@ def main():
         f.write(f"Splunk SOAR App: {app_name}\n{app_license}\n")
 
         # Get all python package dependencies
-        if uv_lock_path := find_uv_lock_file(connector_path):
+        if uv_lock_path:
             uv_lock_dir = uv_lock_path.parent
             packages = get_sdkfied_app_dependencies(uv_lock_dir / "pyproject.toml")
         else:

local_hooks/helpers.py

@@ -0,0 +1,65 @@
+import logging
+from pathlib import Path
+from typing import Optional
+import subprocess
+import tempfile
+import json
+
+
+def find_uv_lock_file(connector_path: Path) -> Optional[Path]:
+    """
+    Find uv.lock file in the connector_path or its subdirectories.
+    Returns the path to the uv.lock file if found, None otherwise.
+    """
+    # By convention, SDK apps are managed by uv and old apps are not
+    for uv_lock_path in connector_path.rglob("uv.lock"):
+        logging.info("Found uv.lock at: %s", uv_lock_path)
+        return uv_lock_path
+
+
+def load_sdk_apps_enviornment(uv_lock_dir: Path):
+    """
+    Load the SDK app's environment.
+    """
+    pyproject_path = uv_lock_dir / "pyproject.toml"
+    if pyproject_path.exists():
+        logging.info("Installing dependencies from pyproject.toml")
+        try:
+            subprocess.run(
+                ["uv", "sync"], cwd=uv_lock_dir, check=True, capture_output=True, text=True
+            )
+            logging.info("Successfully installed dependencies")
+
+        except subprocess.CalledProcessError as e:
+            logging.error("Failed to install dependencies: %s", e)
+            raise e
+    else:
+        raise ValueError("No pyproject.toml found in %s", uv_lock_dir)
+
+
+def generate_sdk_app_manifest(uv_lock_dir: Path) -> dict:
+    with tempfile.TemporaryDirectory() as temp_dir:
+        temp_manifest_path = Path(temp_dir) / "sdk_app_manifest.json"
+        try:
+            # Use uv run to execute soarapps in the SDK app's environment
+            subprocess.run(
+                [
+                    "uv",
+                    "run",
+                    "soarapps",
+                    "manifests",
+                    "create",
+                    str(temp_manifest_path),
+                    ".",
+                ],
+                check=True,
+                cwd=uv_lock_dir,  # Run from the SDK app directory
+            )
+            logging.info("Successfully generated SDK manifest in temp directory")
+
+            with open(temp_manifest_path) as f:
+                return json.load(f)
+
+        except subprocess.CalledProcessError as e:
+            logging.error("Failed to generate SDK manifest: %s", e)
+            raise e

local_hooks/tests/data/static_tests/sdk_app_dir/pyproject.toml

@@ -0,0 +1,13 @@
+[project]
+name = "test"
+version = "4.0.0"
+description = "This is a test app"
+license = "Copyright (c) 2025 Splunk Inc."
+requires-python = ">=3.9, <3.14"
+authors = [
+]
+dependencies = [
+    "splunk-soar-sdk==1.6.0",
+    "validators",
+    "xmltodict",
+]

pyproject.toml

@@ -16,6 +16,7 @@ dependencies = [
     "requests>=2.32.3",
     "pip-licenses",
     "toml",
+    "splunk-soar-sdk",
 ]
 
 [project.scripts]