spl-core 7.14.0__py3-none-any.whl → 7.14.0rc1.dev1__py3-none-any.whl

spl_core/__init__.py

@@ -1 +1 @@
-__version__ = "7.14.0"
+__version__ = "7.14.0-rc1.dev.1"

spl_core/test_utils/artifacts_archiver.py

@@ -1,47 +1,10 @@
 import json
 import os
 from dataclasses import dataclass
-from datetime import datetime, timezone
 from pathlib import Path
-from typing import Any, Dict, List, Optional
+from typing import Dict, List, Optional
 
 import py7zr
-from py_app_dev.core.logging import logger
-from py_app_dev.core.subprocess import SubprocessExecutor
-
-
-@dataclass
-class BuildMetadata:
-    """
-    Contains build metadata extracted from environment variables.
-
-    Attributes:
-        branch_name: The branch name, PR identifier (e.g., "PR-123"), or tag name
-        build_number: The build number or "local_build"
-        is_tag: Whether this is a tag build
-        pr_number: The PR number (without "PR-" prefix) for pull request builds, None otherwise
-    """
-
-    branch_name: str
-    build_number: str
-    is_tag: bool
-    pr_number: Optional[str]
-
-
-@dataclass
-class GitMetadata:
-    """
-    Contains git metadata extracted from environment variables or git commands.
-
-    Attributes:
-        commit_id: The git commit SHA (full hash)
-        commit_message: The git commit message subject line (first line only)
-        repository_url: The git repository URL (from remote.origin.url)
-    """
-
-    commit_id: Optional[str]
-    commit_message: Optional[str]
-    repository_url: Optional[str]
 
 
 class ArtifactsArchive:
@@ -120,7 +83,7 @@ class ArtifactsArchive:
             archive_path.unlink()
 
         if not self.archive_artifacts:
-            logger.warning("No artifacts registered for archiving")
+            print("Warning: No artifacts registered for archiving")
             # Create empty 7z file
             with py7zr.SevenZipFile(archive_path, "w") as archive:
                 pass
@@ -130,7 +93,7 @@ class ArtifactsArchive:
             with py7zr.SevenZipFile(archive_path, "w") as archive:
                 for artifact in self.archive_artifacts:
                     if not artifact.absolute_path.exists():
-                        logger.warning(f"Artifact {artifact.absolute_path} does not exist, skipping")
+                        print(f"Warning: Artifact {artifact.absolute_path} does not exist, skipping")
                         continue
 
                     try:
@@ -140,13 +103,13 @@ class ArtifactsArchive:
                             # py7zr can handle directories directly
                             archive.writeall(artifact.absolute_path, arcname=str(artifact.archive_path))
                     except Exception as file_error:
-                        logger.warning(f"Failed to add {artifact.absolute_path} to archive: {file_error}")
+                        print(f"Warning: Failed to add {artifact.absolute_path} to archive: {file_error}")
                         continue
 
-            logger.info(f"7z file created at: {archive_path}")
+            print(f"7z file created at: {archive_path}")
             return archive_path
         except Exception as e:
-            logger.error(f"Error creating artifacts 7z file: {e}")
+            print(f"Error creating artifacts 7z file: {e}")
             raise e
 
 
@@ -156,10 +119,9 @@ class ArtifactsArchiver:
     It provides a unified interface for registering artifacts to different archives.
     """
 
-    def __init__(self, artifactory_base_url: Optional[str] = None) -> None:
+    def __init__(self) -> None:
         self.archives: Dict[str, ArtifactsArchive] = {}
         self._target_repos: Dict[str, str] = {}
-        self.artifactory_base_url = artifactory_base_url
 
     def add_archive(self, out_dir: Path, archive_filename: str, target_repo: Optional[str] = None, archive_name: str = "default") -> ArtifactsArchive:
         """
@@ -215,37 +177,6 @@ class ArtifactsArchiver:
 
         return self.archives[archive_name]
 
-    def get_archive_url(self, archive_name: str = "default") -> Optional[str]:
-        """
-        Get the Artifactory URL for a specific archive.
-
-        Args:
-            archive_name: Name of the archive (defaults to "default")
-
-        Returns:
-            The full Artifactory URL for the archive, or None if no target repo configured
-
-        Example:
-            "https://artifactory.example.com/artifactory/my-repo/results/develop/123/result.7z"
-        """
-        if archive_name not in self.archives:
-            return None
-
-        if archive_name not in self._target_repos:
-            return None
-
-        if self.artifactory_base_url is None:
-            return None
-
-        archive = self.archives[archive_name]
-        target_repo = self._target_repos[archive_name]
-        metadata = self._get_build_metadata()
-
-        # Construct the URL following the same pattern as create_rt_upload_json
-        archive_url = f"{self.artifactory_base_url}/{target_repo}/{metadata.branch_name}/{metadata.build_number}/{archive.archive_name}"
-
-        return archive_url
-
     def create_all_archives(self) -> Dict[str, Path]:
         """
         Create all registered archives.
@@ -283,26 +214,28 @@ class ArtifactsArchiver:
         else:
             return 28  # 4 weeks for PRs, feature branches, and other branches
 
-    @staticmethod
-    def _get_build_metadata() -> BuildMetadata:
+    def create_rt_upload_json(self, out_dir: Path) -> Path:
         """
-        Get build metadata from environment variables or defaults.
+        Create a single rt-upload.json file containing all archives.
 
-        Detects Jenkins environment variables when available, otherwise falls back
-        to local development defaults.
+        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:
-            BuildMetadata instance containing:
-            - branch_name: The branch name, PR identifier (e.g., "PR-123"), or tag name
-            - build_number: The build number or "local_build"
-            - is_tag: Whether this is a tag build
-            - pr_number: The PR number (without "PR-" prefix) for pull requests, None otherwise
+            Path to the created rt-upload.json file
         """
+        # Set local defaults first
+        change_id = None
         branch_name = "local_branch"
         build_number = "local_build"
         is_tag = False
-        pr_number = None
 
+        # 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")
@@ -312,7 +245,6 @@ class ArtifactsArchiver:
             if change_id:
                 # Pull request case
                 branch_name = f"PR-{change_id}"
-                pr_number = change_id
             elif tag_name:
                 # Tag build case
                 branch_name = tag_name
@@ -324,99 +256,8 @@ class ArtifactsArchiver:
             if jenkins_build_number:
                 build_number = jenkins_build_number
 
-        return BuildMetadata(
-            branch_name=branch_name,
-            build_number=build_number,
-            is_tag=is_tag,
-            pr_number=pr_number,
-        )
-
-    @staticmethod
-    def _get_git_metadata() -> GitMetadata:
-        """
-        Get git metadata from environment variables or git commands.
-
-        Attempts to retrieve git information in the following order:
-        1. Environment variables (GIT_COMMIT, GIT_URL) - typically set by Jenkins Git plugin
-        2. Git commands as fallback - executed locally using git CLI
-
-        The commit message captured is only the subject line (first line), not the full message.
-
-        Returns:
-            GitMetadata instance containing:
-            - commit_id: The git commit SHA, or None if unavailable
-            - commit_message: The commit subject line (first line only), or None if unavailable
-            - repository_url: The git repository URL, or None if unavailable
-        """
-        commit_id = None
-        commit_message = None
-        repository_url = None
-
-        # Try environment variables first (Jenkins Git plugin)
-        env_commit = os.environ.get("GIT_COMMIT")
-        env_url = os.environ.get("GIT_URL")
-
-        if env_commit:
-            commit_id = env_commit if env_commit.strip() else None
-        if env_url:
-            repository_url = env_url if env_url.strip() else None
-
-        # Fallback to git commands if environment variables not available
-        # Get commit ID
-        if not commit_id:
-            try:
-                result = SubprocessExecutor(["git", "rev-parse", "HEAD"]).execute(handle_errors=False)
-                if result and result.returncode == 0:
-                    value = result.stdout.strip()
-                    commit_id = value if value else None
-            except Exception as e:
-                logger.warning(f"Failed to get commit ID from git: {e}")
-
-        # Get commit message (subject line only)
-        if not commit_message:
-            try:
-                result = SubprocessExecutor(["git", "log", "-1", "--format=%s"]).execute(handle_errors=False)
-                if result and result.returncode == 0:
-                    value = result.stdout.strip()
-                    commit_message = value if value else None
-            except Exception as e:
-                logger.warning(f"Failed to get commit message from git: {e}")
-
-        # Get repository URL
-        if not repository_url:
-            try:
-                result = SubprocessExecutor(["git", "config", "--get", "remote.origin.url"]).execute(handle_errors=False)
-                if result and result.returncode == 0:
-                    value = result.stdout.strip()
-                    repository_url = value if value else None
-            except Exception as e:
-                logger.warning(f"Failed to get repository URL from git: {e}")
-
-        return GitMetadata(
-            commit_id=commit_id,
-            commit_message=commit_message,
-            repository_url=repository_url,
-        )
-
-    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
-        metadata = self._get_build_metadata()
-
         # Calculate retention period based on branch/tag
-        retention_period = self.calculate_retention_period(metadata.branch_name, metadata.is_tag)
+        retention_period = self.calculate_retention_period(branch_name, is_tag)
 
         # Create the files array for Artifactory upload format
         files_array = []
@@ -426,7 +267,7 @@ class ArtifactsArchiver:
                 target_repo = self._target_repos[archive_name]
 
                 # Construct the RT target path
-                rt_target = f"{target_repo}/{metadata.branch_name}/{metadata.build_number}/"
+                rt_target = f"{target_repo}/{branch_name}/{build_number}/"
 
                 # Add this archive to the files array with retention_period property
                 files_array.append(
@@ -450,137 +291,6 @@ 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.
-
-        The JSON file includes conditional keys based on the build type:
-        - For pull requests: includes "pull_request" key with the PR number (e.g., "117")
-        - For tag builds: includes "tag" key with the tag name (e.g., "v1.2.3")
-        - For regular branch builds: includes "branch" key with the branch name (e.g., "develop")
-
-        Optional fields (included only if available):
-        - build_url: Jenkins build URL from BUILD_URL environment variable
-        - commit_id: Git commit SHA from GIT_COMMIT env var or git rev-parse HEAD
-        - commit_message: Git commit subject line from git log (first line only)
-        - repository_url: Git repository URL from GIT_URL env var or git config
-
-        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 metadata from environment or defaults
-        build_metadata = self._get_build_metadata()
-        git_metadata = self._get_git_metadata()
-
-        # Create the initial artifacts.json structure with base metadata
-        artifacts_data: Dict[str, Any] = {
-            "variant": variant,
-            "build_timestamp": datetime.now(timezone.utc).isoformat(timespec="seconds") + "Z",
-            "build_number": build_metadata.build_number,
-        }
-
-        # Add build_url if available
-        build_url = os.environ.get("BUILD_URL")
-        if build_url:
-            artifacts_data["build_url"] = build_url
-
-        # Add conditional keys based on build type
-        if build_metadata.pr_number:
-            # Pull request build
-            artifacts_data["pull_request"] = build_metadata.pr_number
-        elif build_metadata.is_tag:
-            # Tag build
-            artifacts_data["tag"] = build_metadata.branch_name
-        else:
-            # Regular branch build (or local build)
-            artifacts_data["branch"] = build_metadata.branch_name
-
-        # Add git metadata if available
-        if git_metadata.commit_id:
-            artifacts_data["commit_id"] = git_metadata.commit_id
-        if git_metadata.commit_message:
-            artifacts_data["commit_message"] = git_metadata.commit_message
-        if git_metadata.repository_url:
-            artifacts_data["repository_url"] = git_metadata.repository_url
-
-        # Add empty artifacts dictionary
-        artifacts_data["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.
@@ -637,18 +347,3 @@ 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
-# # The resulting JSON will contain conditional keys based on build type:
-# # - For PRs: {"variant": "Disco", "build_timestamp": "...", "build_number": "123", "pull_request": "117", "artifacts": {}}
-# # - For tags: {"variant": "Disco", "build_timestamp": "...", "build_number": "123", "tag": "v1.2.3", "artifacts": {}}
-# # - For branches: {"variant": "Disco", "build_timestamp": "...", "build_number": "123", "branch": "develop", "artifacts": {}}
-# 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.0.dist-info → spl_core-7.14.0rc1.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spl-core
-Version: 7.14.0
+Version: 7.14.0rc1.dev1
 Summary: Software Product Line Support for CMake
 License: MIT
 License-File: LICENSE
@@ -31,14 +31,14 @@ 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.7)
-Requires-Dist: sphinx-needs (>=2.0,<3.0)
+Requires-Dist: sphinx-needs (>=2,<7)
 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.0,<3.0)
+Requires-Dist: sphinx-rtd-theme (>=2,<4)
 Requires-Dist: sphinx-test-reports (>=1.0,<2.0)
 Requires-Dist: sphinxcontrib-datatemplates (>=0.11,<0.12)
-Requires-Dist: sphinxcontrib-mermaid (>=0.9,<0.10)
-Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.31)
+Requires-Dist: sphinxcontrib-mermaid (>=0.9,<1.1)
+Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.32)
 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.0.dist-info → spl_core-7.14.0rc1.dev1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-spl_core/__init__.py,sha256=HyLrDM036NFqqqTSta893ALzgsTY2LDDQ1vUG5gp5B8,23
+spl_core/__init__.py,sha256=G6RF3CCenxPNRixbd1rxgiDN02DG4kg0q5CrKmjUKso,33
 spl_core/__run.py,sha256=DphnN7_Bjiw_mOOztsHxTDHS8snz1g2MMWAaJpZxPKM,361
 spl_core/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spl_core/common/path.py,sha256=sDujd3n4XP1XGjHc7ImXEdjihO6A8BOIDbKCf7HgQ0Y,462
@@ -61,11 +61,11 @@ spl_core/main.py,sha256=_hL4j155WZMXog_755bgAH1PeUwvTdJZvVdVw9EWhvo,1225
 spl_core/spl.cmake,sha256=YQMhpSJ9yZaJ34m_W1UqrlTh_r7AKMDuH6-hzK4w98A,4585
 spl_core/steps/collect_pr_changes.py,sha256=su3yCtSJM9XDlMNOD0L72ooQdKzruc0lUat858Na0Kg,5539
 spl_core/test_utils/archive_artifacts_collection.py,sha256=x7LH5dGIvssyhXsTFzB6rjgb5D2efKvHVpnjId3MNDk,5126
-spl_core/test_utils/artifacts_archiver.py,sha256=xrsYbjlqpg4M0Xy1zSjQNcxDXJctom1ZtzR74ZJp-rs,25996
+spl_core/test_utils/artifacts_archiver.py,sha256=z1ckuHkgCpEFpTBc4HDGHbV3lp2-bUpZS0coxZ8BIUw,13368
 spl_core/test_utils/base_variant_test_runner.py,sha256=Oq27lkJlpB_y-p2_8S23F5zjn1438HW148q-hQNz3EY,3795
 spl_core/test_utils/spl_build.py,sha256=bSM6hwhTH9aRryvUvtSPDfk_zoZuKEO5g3QXK4SIrco,8442
-spl_core-7.14.0.dist-info/METADATA,sha256=ohKP-TUwbk9qndKLblwSRdOxRn6pB2rNgjy7gKZQ3f0,5314
-spl_core-7.14.0.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
-spl_core-7.14.0.dist-info/entry_points.txt,sha256=18_sdVY93N1GVBiAHxQ_F9ZM-bBvOmVMOMn7PNe2EqU,45
-spl_core-7.14.0.dist-info/licenses/LICENSE,sha256=UjjA0o8f5tT3wVm7qodTLAhPWLl6kgVyn9FPAd1VeYY,1099
-spl_core-7.14.0.dist-info/RECORD,,
+spl_core-7.14.0rc1.dev1.dist-info/METADATA,sha256=9lPlCYpWcLRc6gerhqZaag7vlvlVPGNItUZEglRZmBg,5313
+spl_core-7.14.0rc1.dev1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+spl_core-7.14.0rc1.dev1.dist-info/entry_points.txt,sha256=18_sdVY93N1GVBiAHxQ_F9ZM-bBvOmVMOMn7PNe2EqU,45
+spl_core-7.14.0rc1.dev1.dist-info/licenses/LICENSE,sha256=UjjA0o8f5tT3wVm7qodTLAhPWLl6kgVyn9FPAd1VeYY,1099
+spl_core-7.14.0rc1.dev1.dist-info/RECORD,,

{spl_core-7.14.0.dist-info → spl_core-7.14.0rc1.dev1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.3.0
+Generator: poetry-core 2.2.1
 Root-Is-Purelib: true
 Tag: py3-none-any