spl-core 7.14.0rc3.dev1__tar.gz → 7.14.0rc4.dev2__tar.gz

{spl_core-7.14.0rc3.dev1 → spl_core-7.14.0rc4.dev2}/PKG-INFO

@@ -1,43 +1,44 @@
 Metadata-Version: 2.4
 Name: spl-core
-Version: 7.14.0rc3.dev1
+Version: 7.14.0rc4.dev2
 Summary: Software Product Line Support for CMake
 License: MIT
 License-File: LICENSE
 Author: Avengineers
 Author-email: karsten.guenther@kamg.de
-Requires-Python: >=3.11,<3.12
+Requires-Python: >=3.10,<3.12
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: cookiecutter (>=2.6,<3.0)
+Requires-Dist: cookiecutter (==2.6.0)
 Requires-Dist: doxysphinx (>=3.3,<4.0)
 Requires-Dist: gcovr (>=8.3,<9.0)
 Requires-Dist: hammocking (>=0.8,<0.10)
 Requires-Dist: kconfiglib (>=14.1,<15.0)
-Requires-Dist: mlx-traceability (>=10,<13)
+Requires-Dist: mlx-traceability (>=10,<12)
 Requires-Dist: myst-parser (>=0.16)
 Requires-Dist: py-app-dev (>=2.1,<3.0)
 Requires-Dist: py7zr (>=1.0.0,<2.0.0)
 Requires-Dist: pypeline-runner (>=1,<=2)
 Requires-Dist: pypeline-semantic-release (>=0.4.1,<=0.5.0)
-Requires-Dist: sphinx (>=8.2,<9.0)
+Requires-Dist: sphinx (>=7.3,<8.0)
 Requires-Dist: sphinx-book-theme (>=1.1,<2.0)
 Requires-Dist: sphinx-copybutton (>=0.5,<0.6)
-Requires-Dist: sphinx-design (>=0.5,<0.8)
-Requires-Dist: sphinx-needs (>=2,<7)
-Requires-Dist: sphinx-new-tab-link (>=0.4,<0.10)
+Requires-Dist: sphinx-design (>=0.5,<0.7)
+Requires-Dist: sphinx-needs (>=2.0,<3.0)
+Requires-Dist: sphinx-new-tab-link (>=0.4,<0.9)
 Requires-Dist: sphinx-rtd-size (>=0.2,<0.3)
-Requires-Dist: sphinx-rtd-theme (>=2,<4)
+Requires-Dist: sphinx-rtd-theme (>=2.0,<3.0)
 Requires-Dist: sphinx-test-reports (>=1.0,<2.0)
 Requires-Dist: sphinxcontrib-datatemplates (>=0.11,<0.12)
-Requires-Dist: sphinxcontrib-mermaid (>=1.1,<2.0)
-Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.33)
+Requires-Dist: sphinxcontrib-mermaid (>=0.9,<0.10)
+Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.31)
 Requires-Dist: typer (>=0,<1)
 Project-URL: Bug Tracker, https://github.com/avengineers/spl-core/issues
 Project-URL: Changelog, https://github.com/avengineers/spl-core/blob/develop/CHANGELOG.md

{spl_core-7.14.0rc3.dev1 → spl_core-7.14.0rc4.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spl-core"
-version = "7.14.0-rc3.dev.1"
+version = "7.14.0-rc4.dev.2"
 description = "Software Product Line Support for CMake"
 authors = ["Avengineers <karsten.guenther@kamg.de>"]
 license = "MIT"
@@ -24,37 +24,37 @@ please = "spl_core.main:main"
 "Changelog" = "https://github.com/avengineers/spl-core/blob/develop/CHANGELOG.md"
 
 [tool.poetry.dependencies]
-python = ">=3.11,<3.12"
+python = ">=3.10,<3.12"
 py-app-dev = "^2.1"
-cookiecutter = "^2.6"
+cookiecutter = "==2.6.0"
 gcovr = "^8.3"
 hammocking = ">=0.8,<0.10"
 kconfiglib = "^14.1"
 typer = "^0"
 doxysphinx = "^3.3"
-sphinx = "^8.2"
-sphinx-rtd-theme = ">=2,<4"
-sphinxcontrib-mermaid = "^1.1"
-sphinx-needs = ">=2,<7"
+sphinx = "^7.3"
+sphinx-rtd-theme = "^2.0"
+sphinxcontrib-mermaid = "^0.9"
+sphinx-needs = "^2.0"
 sphinx-test-reports = "^1.0"
 sphinx-rtd-size = "^0.2"
 sphinxcontrib-datatemplates = "^0.11"
-sphinxcontrib-plantuml = ">=0.29,<0.33"
+sphinxcontrib-plantuml = ">=0.29,<0.31"
 sphinx-copybutton = "^0.5"
-sphinx-new-tab-link = ">=0.4,<0.10"
+sphinx-new-tab-link = ">=0.4,<0.9"
 myst-parser = ">=0.16"
-mlx-traceability = ">=10,<13"
+mlx-traceability = ">=10,<12"
 sphinx-book-theme = "^1.1"
-sphinx-design = ">=0.5,<0.8"
+sphinx-design = ">=0.5,<0.7"
 pypeline-semantic-release = ">=0.4.1,<=0.5.0"
 pypeline-runner = ">=1,<=2"
 py7zr = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = ">=7,<11"
-pytest-cov = ">=4,<9"
-pre-commit = "^4.4"
-ruff = ">=0.5,<0.20"
+pytest = ">=7,<9"
+pytest-cov = "^4.0"
+pre-commit = "^3.1.1"
+ruff = ">=0.5,<0.13"
 jinja2 = "*"
 testfixtures = "*"
 junitparser = "*"
@@ -62,7 +62,7 @@ mashumaro = "*"
 loguru = "*"
 flake8 = "*"
 pipenv = "*"
-python-semantic-release = "^9.21"
+python-semantic-release = "^9.16.1"
 
 [tool.semantic_release]
 version_toml = ["pyproject.toml:tool.poetry.version"]

spl_core-7.14.0rc4.dev2/src/spl_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.14.0-rc4.dev.2"

{spl_core-7.14.0rc3.dev1 → spl_core-7.14.0rc4.dev2}/src/spl_core/test_utils/artifacts_archiver.py

@@ -1,6 +1,7 @@
 import json
 import os
 from dataclasses import dataclass
+from datetime import datetime, timezone
 from pathlib import Path
 from typing import Dict, List, Optional
 
@@ -122,6 +123,7 @@ class ArtifactsArchiver:
     def __init__(self) -> None:
         self.archives: Dict[str, ArtifactsArchive] = {}
         self._target_repos: Dict[str, str] = {}
+        # self._artifacts_metadata: Dict[str, Dict[str, Dict[str, str]]] = {}  # variant -> category -> artifacts
 
     def add_archive(self, out_dir: Path, archive_filename: str, target_repo: Optional[str] = None, archive_name: str = "default") -> ArtifactsArchive:
         """
@@ -214,28 +216,24 @@ class ArtifactsArchiver:
         else:
             return 28  # 4 weeks for PRs, feature branches, and other branches
 
-    def create_rt_upload_json(self, out_dir: Path) -> Path:
+    @staticmethod
+    def _get_build_metadata() -> tuple[str, str, bool]:
         """
-        Create a single rt-upload.json file containing all archives.
-
-        This function replicates the logic from the Jenkinsfile for determining the RT_TARGET
-        and creating the upload specification file. It uses Jenkins environment variables
-        when available, otherwise falls back to default values.
+        Get build metadata from environment variables or defaults.
 
-        Args:
-            output_dir: Directory where the rt-upload.json file will be created
+        Detects Jenkins environment variables when available, otherwise falls back
+        to local development defaults.
 
         Returns:
-            Path to the created rt-upload.json file
+            Tuple of (branch_name, build_number, is_tag):
+            - branch_name: The branch or PR identifier
+            - build_number: The build number or "local_build"
+            - is_tag: Whether this is a tag build
         """
-        # Set local defaults first
-        change_id = None
         branch_name = "local_branch"
         build_number = "local_build"
         is_tag = False
 
-        # Adapt values when Jenkins environment is detected
-        # TODO: check if an existing library can be used for CI context detection
         if os.environ.get("JENKINS_URL"):
             change_id = os.environ.get("CHANGE_ID")
             jenkins_branch_name = os.environ.get("BRANCH_NAME")
@@ -256,6 +254,25 @@ class ArtifactsArchiver:
             if jenkins_build_number:
                 build_number = jenkins_build_number
 
+        return branch_name, build_number, is_tag
+
+    def create_rt_upload_json(self, out_dir: Path) -> Path:
+        """
+        Create a single rt-upload.json file containing all archives.
+
+        This function replicates the logic from the Jenkinsfile for determining the RT_TARGET
+        and creating the upload specification file. It uses Jenkins environment variables
+        when available, otherwise falls back to default values.
+
+        Args:
+            output_dir: Directory where the rt-upload.json file will be created
+
+        Returns:
+            Path to the created rt-upload.json file
+        """
+        # Get build metadata from environment or defaults
+        branch_name, build_number, is_tag = self._get_build_metadata()
+
         # Calculate retention period based on branch/tag
         retention_period = self.calculate_retention_period(branch_name, is_tag)
 
@@ -291,6 +308,94 @@ class ArtifactsArchiver:
 
         return json_path
 
+    def create_artifacts_json(self, variant: str, out_dir: Path) -> Path:
+        """
+        Create an initial artifacts.json file with build metadata structure.
+
+        This function creates a fresh artifacts.json file with build metadata
+        but no artifacts. Use update_artifacts_json() to add artifact categories.
+        It uses Jenkins environment variables when available, otherwise falls back to default values.
+
+        Args:
+            variant: The variant name (e.g., "Disco")
+            out_dir: Directory where the artifacts.json file will be created
+
+        Returns:
+            Path to the created artifacts.json file
+
+        Raises:
+            ValueError: If variant is empty or None
+        """
+        # Input validation
+        if not variant or not variant.strip():
+            raise ValueError("Variant name cannot be empty or None")
+
+        # Get build metadata from environment or defaults
+        branch_name, build_number, _ = self._get_build_metadata()
+
+        # Create the initial artifacts.json structure
+        artifacts_data = {"variant": variant, "build_timestamp": datetime.now(timezone.utc).isoformat(timespec="seconds") + "Z", "build_number": build_number, "branch_name": branch_name, "artifacts": {}}
+
+        # Create the artifacts.json file
+        json_path = out_dir / "artifacts.json"
+        json_path.parent.mkdir(parents=True, exist_ok=True)
+
+        with open(json_path, "w") as f:
+            json.dump(artifacts_data, f, indent=2)
+
+        return json_path
+
+    def update_artifacts_json(self, category: str, artifacts: Dict[str, str], artifacts_json_path: Path) -> Path:
+        """
+        Add or update artifacts in a specific category for the artifacts.json file.
+
+        Args:
+            category: The artifact category (e.g., "test_reports", "sca_reports", "build_binaries")
+            artifacts: Dictionary mapping artifact names to their URLs/paths
+            artifacts_json_path: Path to the artifacts.json file to be updated
+
+        Returns:
+            Path to the updated artifacts.json file
+
+        Raises:
+            ValueError: If category is empty, artifacts dictionary is empty, or JSON structure is invalid
+            FileNotFoundError: If artifacts.json file does not exist
+        """
+        # Input validation
+        if not category or not category.strip():
+            raise ValueError("Category name cannot be empty or None")
+        if not artifacts:
+            raise ValueError("Artifacts dictionary cannot be empty")
+
+        # Check if artifacts.json file exists
+        if not artifacts_json_path.exists():
+            raise FileNotFoundError(f"artifacts.json file does not exist at {artifacts_json_path}. Please create it first using create_artifacts_json().")
+
+        # Read existing artifacts.json file
+        try:
+            with open(artifacts_json_path) as f:
+                artifacts_data = json.load(f)
+        except json.JSONDecodeError as e:
+            raise ValueError(f"Could not parse artifacts.json: {e}") from e
+        except OSError as e:
+            raise ValueError(f"Could not read artifacts.json: {e}") from e
+
+        # Validate that the file has the expected structure
+        if not artifacts_data or "artifacts" not in artifacts_data:
+            raise ValueError("artifacts.json file has invalid structure. Expected 'artifacts' section not found.")
+
+        # Update the specific category with new artifacts
+        if category in artifacts_data["artifacts"]:
+            artifacts_data["artifacts"][category].update(artifacts)
+        else:
+            artifacts_data["artifacts"][category] = artifacts.copy()
+
+        # Write the updated data back to the file
+        with open(artifacts_json_path, "w") as f:
+            json.dump(artifacts_data, f, indent=2)
+
+        return artifacts_json_path
+
     def list_archives(self) -> List[str]:
         """
         Get a list of all archive names.
@@ -347,3 +452,14 @@ class ArtifactsArchiver:
 #
 # created_files = archiver.create_all_archives()
 # upload_json = archiver.create_rt_upload_json(Path("./build/output"))  # only includes archives with target repos
+#
+# ## Artifacts.json use case (variant-specific metadata):
+# archiver = ArtifactsArchiver()
+# variant = "Disco"
+# out_dir = Path("./build/output")
+#
+# # Create initial artifacts.json file first, then add categories
+# artifacts_json_path = archiver.create_artifacts_json(variant, out_dir)
+# archiver.update_artifacts_json("test_reports", test_reports, artifacts_json_path)
+# archiver.update_artifacts_json("sca_reports", sca_reports, artifacts_json_path)
+# archiver.update_artifacts_json("build_binaries", build_binaries, artifacts_json_path)

spl_core-7.14.0rc3.dev1/src/spl_core/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.14.0-rc3.dev.1"