spl-core 7.14.0__tar.gz → 7.14.0rc2.dev1__tar.gz

{spl_core-7.14.0 → spl_core-7.14.0rc2.dev1}/PKG-INFO

@@ -1,45 +1,44 @@
 Metadata-Version: 2.4
 Name: spl-core
-Version: 7.14.0
+Version: 7.14.0rc2.dev1
 Summary: Software Product Line Support for CMake
 License: MIT
 License-File: LICENSE
 Author: Avengineers
 Author-email: karsten.guenther@kamg.de
-Requires-Python: >=3.10,<3.12
+Requires-Python: >=3.11,<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.0)
+Requires-Dist: cookiecutter (>=2.6,<3.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,<12)
+Requires-Dist: mlx-traceability (>=10,<13)
 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 (>=7.3,<8.0)
+Requires-Dist: sphinx (>=8.2,<9.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-new-tab-link (>=0.4,<0.9)
+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-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: typer (>=0,<1)
+Requires-Dist: sphinxcontrib-mermaid (>=1.1,<2.0)
+Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.33)
+Requires-Dist: typer (>=0.20,<0.21)
 Project-URL: Bug Tracker, https://github.com/avengineers/spl-core/issues
 Project-URL: Changelog, https://github.com/avengineers/spl-core/blob/develop/CHANGELOG.md
 Project-URL: Documentation, https://spl-core.readthedocs.io

{spl_core-7.14.0 → spl_core-7.14.0rc2.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spl-core"
-version = "7.14.0"
+version = "7.14.0-rc2.dev.1"
 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.10,<3.12"
+python = ">=3.11,<3.12"
 py-app-dev = "^2.1"
-cookiecutter = "==2.6.0"
+cookiecutter = "^2.6"
 gcovr = "^8.3"
 hammocking = ">=0.8,<0.10"
 kconfiglib = "^14.1"
-typer = "^0"
+typer = "^0.20"
 doxysphinx = "^3.3"
-sphinx = "^7.3"
-sphinx-rtd-theme = "^2.0"
-sphinxcontrib-mermaid = "^0.9"
-sphinx-needs = "^2.0"
+sphinx = "^8.2"
+sphinx-rtd-theme = ">=2,<4"
+sphinxcontrib-mermaid = "^1.1"
+sphinx-needs = ">=2,<7"
 sphinx-test-reports = "^1.0"
 sphinx-rtd-size = "^0.2"
 sphinxcontrib-datatemplates = "^0.11"
-sphinxcontrib-plantuml = ">=0.29,<0.31"
+sphinxcontrib-plantuml = ">=0.29,<0.33"
 sphinx-copybutton = "^0.5"
-sphinx-new-tab-link = ">=0.4,<0.9"
+sphinx-new-tab-link = ">=0.4,<0.10"
 myst-parser = ">=0.16"
-mlx-traceability = ">=10,<12"
+mlx-traceability = ">=10,<13"
 sphinx-book-theme = "^1.1"
-sphinx-design = ">=0.5,<0.7"
+sphinx-design = ">=0.5,<0.8"
 pypeline-semantic-release = ">=0.4.1,<=0.5.0"
 pypeline-runner = ">=1,<=2"
 py7zr = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = ">=7,<9"
-pytest-cov = "^4.0"
-pre-commit = "^3.1.1"
-ruff = ">=0.5,<0.13"
+pytest = ">=7,<11"
+pytest-cov = ">=4,<9"
+pre-commit = "^4.4"
+ruff = ">=0.5,<0.20"
 jinja2 = "*"
 testfixtures = "*"
 junitparser = "*"
@@ -62,7 +62,7 @@ mashumaro = "*"
 loguru = "*"
 flake8 = "*"
 pipenv = "*"
-python-semantic-release = "^9.16.1"
+python-semantic-release = "^9.21"
 
 [tool.semantic_release]
 version_toml = ["pyproject.toml:tool.poetry.version"]

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

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

spl_core-7.14.0rc2.dev1/src/spl_core/test_utils/artifacts_archiver.py

@@ -0,0 +1,349 @@
+import json
+import os
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Dict, List, Optional
+
+import py7zr
+
+
+class ArtifactsArchive:
+    """
+    This class represents a single archive containing artifacts.
+    It collects artifacts to be packed and archived.
+
+    Currently supports 7z and Artifactory.
+    """
+
+    @dataclass
+    class ArchiveArtifact:
+        """
+        Represents a single artifact to be archived.
+        This class holds the archive path (relative to the output directory of the 7z archive)
+        and the absolute path of the artifact.
+        It is used to ensure that artifacts are correctly archived with their intended paths.
+        """
+
+        archive_path: Path
+        absolute_path: Path
+
+    def __init__(self, out_dir: Path, archive_name: str) -> None:
+        self.out_dir: Path = out_dir
+        self.archive_name: str = archive_name
+        self.archive_artifacts: List[ArtifactsArchive.ArchiveArtifact] = []
+
+    def register(self, artifacts: List[Path]) -> None:
+        """
+        Register artifacts for archiving.
+        Args:
+            artifacts: List of paths to artifacts (files or directories) to be archived.
+        """
+        for artifact in artifacts:
+            self._add_artifact(artifact)
+
+    def _add_artifact(self, artifact_path: Path) -> None:
+        """
+        Add an artifact (file or directory) to the archive list.
+        Args:
+            artifact_path: path to the artifact to be archived.
+        """
+        # Convert to absolute path first
+        absolute_path = artifact_path.resolve() if not artifact_path.is_absolute() else artifact_path
+
+        # Calculate the relative path from out_dir for the archive
+        if absolute_path.is_relative_to(self.out_dir.absolute()):
+            archive_path = absolute_path.relative_to(self.out_dir.absolute())
+        else:
+            # If not relative to out_dir, just use the name
+            archive_path = Path(absolute_path.name)
+
+        self.archive_artifacts.append(
+            self.ArchiveArtifact(
+                archive_path=archive_path,
+                absolute_path=absolute_path,
+            )
+        )
+
+    def create_archive(self) -> Path:
+        """
+        Create a 7z file containing the collected artifacts.
+        Returns:
+            Path: The path to the created 7z file.
+        Raises:
+            Exception: If there is an error creating the 7z file.
+        """
+        # Construct the full archive path
+        archive_path = self.out_dir / self.archive_name
+
+        # Create output directory if it doesn't exist
+        archive_path.parent.mkdir(parents=True, exist_ok=True)
+
+        # Delete the file if it already exists
+        if archive_path.exists():
+            archive_path.unlink()
+
+        if not self.archive_artifacts:
+            print("Warning: No artifacts registered for archiving")
+            # Create empty 7z file
+            with py7zr.SevenZipFile(archive_path, "w") as archive:
+                pass
+            return archive_path
+
+        try:
+            with py7zr.SevenZipFile(archive_path, "w") as archive:
+                for artifact in self.archive_artifacts:
+                    if not artifact.absolute_path.exists():
+                        print(f"Warning: Artifact {artifact.absolute_path} does not exist, skipping")
+                        continue
+
+                    try:
+                        if artifact.absolute_path.is_file():
+                            archive.write(artifact.absolute_path, arcname=str(artifact.archive_path))
+                        elif artifact.absolute_path.is_dir():
+                            # py7zr can handle directories directly
+                            archive.writeall(artifact.absolute_path, arcname=str(artifact.archive_path))
+                    except Exception as file_error:
+                        print(f"Warning: Failed to add {artifact.absolute_path} to archive: {file_error}")
+                        continue
+
+            print(f"7z file created at: {archive_path}")
+            return archive_path
+        except Exception as e:
+            print(f"Error creating artifacts 7z file: {e}")
+            raise e
+
+
+class ArtifactsArchiver:
+    """
+    This class manages multiple ArtifactsArchive instances.
+    It provides a unified interface for registering artifacts to different archives.
+    """
+
+    def __init__(self) -> None:
+        self.archives: Dict[str, ArtifactsArchive] = {}
+        self._target_repos: Dict[str, str] = {}
+
+    def add_archive(self, out_dir: Path, archive_filename: str, target_repo: Optional[str] = None, archive_name: str = "default") -> ArtifactsArchive:
+        """
+        Add a new archive to the archiver.
+
+        Args:
+            out_dir: Output directory for the archive
+            archive_filename: Filename for the archive
+            target_repo: Target repository path for Artifactory upload (optional)
+            archive_name: Name identifier for the archive (defaults to "default")
+
+        Returns:
+            The created ArtifactsArchive instance
+        """
+        archive = ArtifactsArchive(out_dir, archive_filename)
+        self.archives[archive_name] = archive
+        # Store the target repo information for this archive only if provided
+        if target_repo is not None:
+            self._target_repos[archive_name] = target_repo
+        return archive
+
+    def register(self, artifacts: List[Path], archive_name: str = "default") -> None:
+        """
+        Register artifacts for archiving to a specific archive.
+
+        Args:
+            artifacts: List of paths to artifacts (files or directories) to be archived.
+            archive_name: Name of the archive to register artifacts to (defaults to "default")
+
+        Raises:
+            KeyError: If the specified archive_name doesn't exist
+        """
+        if archive_name not in self.archives:
+            raise KeyError(f"Archive '{archive_name}' not found. Available archives: {list(self.archives.keys())}")
+
+        self.archives[archive_name].register(artifacts)
+
+    def get_archive(self, archive_name: str) -> ArtifactsArchive:
+        """
+        Get a specific archive by name.
+
+        Args:
+            archive_name: Name of the archive to retrieve
+
+        Returns:
+            The ArtifactsArchive instance
+
+        Raises:
+            KeyError: If the specified archive_name doesn't exist
+        """
+        if archive_name not in self.archives:
+            raise KeyError(f"Archive '{archive_name}' not found. Available archives: {list(self.archives.keys())}")
+
+        return self.archives[archive_name]
+
+    def create_all_archives(self) -> Dict[str, Path]:
+        """
+        Create all registered archives.
+
+        Returns:
+            Dictionary mapping archive names to their created file paths
+        """
+        created_archives = {}
+        for archive_name, archive in self.archives.items():
+            created_archives[archive_name] = archive.create_archive()
+        return created_archives
+
+    @staticmethod
+    def calculate_retention_period(branch_name: str, is_tag: bool) -> int:
+        """
+        Calculate the retention period in days based on branch name or tag.
+
+        Args:
+            branch_name: The name of the branch
+            is_tag: Whether this is a tag build
+
+        Returns:
+            Retention period in days:
+            - 84 days for "develop" branch
+            - -1 (infinite) for release branches (release/*)
+            - -1 (infinite) for tags
+            - 28 days for everything else (PRs, feature branches, etc.)
+        """
+        if is_tag:
+            return -1  # Infinite retention for tags
+        elif branch_name == "develop":
+            return 84  # Length of a PI (Program Increment)
+        elif branch_name.startswith("release/"):
+            return -1  # Infinite retention for release branches
+        else:
+            return 28  # 4 weeks for PRs, feature branches, and other branches
+
+    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
+        """
+        # 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")
+            jenkins_build_number = os.environ.get("BUILD_NUMBER")
+            tag_name = os.environ.get("TAG_NAME")
+
+            if change_id:
+                # Pull request case
+                branch_name = f"PR-{change_id}"
+            elif tag_name:
+                # Tag build case
+                branch_name = tag_name
+                is_tag = True
+            elif jenkins_branch_name:
+                # Regular branch case
+                branch_name = jenkins_branch_name
+
+            if jenkins_build_number:
+                build_number = jenkins_build_number
+
+        # Calculate retention period based on branch/tag
+        retention_period = self.calculate_retention_period(branch_name, is_tag)
+
+        # Create the files array for Artifactory upload format
+        files_array = []
+
+        for archive_name, archive in self.archives.items():
+            if archive_name in self._target_repos:
+                target_repo = self._target_repos[archive_name]
+
+                # Construct the RT target path
+                rt_target = f"{target_repo}/{branch_name}/{build_number}/"
+
+                # Add this archive to the files array with retention_period property
+                files_array.append(
+                    {
+                        "pattern": archive.archive_name,
+                        "target": rt_target,
+                        "recursive": "false",
+                        "flat": "false",
+                        "regexp": "false",
+                        "props": f"retention_period={retention_period}",
+                    }
+                )
+
+        # Create the single rt-upload.json file
+        json_path = out_dir / "rt-upload.json"
+
+        spec = {"files": files_array}
+
+        with open(json_path, "w") as f:
+            json.dump(spec, f, indent=4)
+
+        return json_path
+
+    def list_archives(self) -> List[str]:
+        """
+        Get a list of all archive names.
+
+        Returns:
+            List of archive names
+        """
+        return list(self.archives.keys())
+
+    def create_archive(self, archive_name: str = "default") -> Path:
+        """
+        Create a specific archive (convenience method for single-archive use case).
+
+        Args:
+            archive_name: Name of the archive to create (defaults to "default")
+
+        Returns:
+            Path to the created archive file
+
+        Raises:
+            KeyError: If the specified archive_name doesn't exist
+        """
+        if archive_name not in self.archives:
+            raise KeyError(f"Archive '{archive_name}' not found. Available archives: {list(self.archives.keys())}")
+
+        return self.archives[archive_name].create_archive()
+
+
+# Example usage:
+#
+# ## Simple single-archive use case with target repo:
+# archiver = ArtifactsArchiver()
+# archiver.add_archive(Path("./build/output"), "results.7z", "my-repo/results")  # uses "default" name
+# archiver.register([Path("./build/test_report.xml"), Path("./build/coverage.html")])  # registers to "default"
+# archive_path = archiver.create_archive()  # creates the "default" archive
+# upload_json = archiver.create_rt_upload_json(Path("./build/output"))
+#
+# ## Simple single-archive use case without target repo (archive only):
+# archiver = ArtifactsArchiver()
+# archiver.add_archive(Path("./build/output"), "results.7z")  # no target repo, uses "default" name
+# archiver.register([Path("./build/test_report.xml"), Path("./build/coverage.html")])
+# archive_path = archiver.create_archive()  # creates the "default" archive
+# # upload_json = archiver.create_rt_upload_json(Path("./build/output"))  # would create empty JSON
+#
+# ## Multi-archive use case:
+# archiver = ArtifactsArchiver()
+# archiver.add_archive(Path("./build/output"), "test_results.7z", "my-repo/test-results", "test_results")
+# archiver.add_archive(Path("./build/output"), "coverage.7z", "my-repo/coverage", "coverage_reports")
+# archiver.add_archive(Path("./build/output"), "docs.7z", None, "documentation")  # no target repo for docs
+#
+# archiver.register([Path("./build/test_report.xml")], "test_results")
+# archiver.register([Path("./build/coverage.html")], "coverage_reports")
+# archiver.register([Path("./build/docs/")], "documentation")
+#
+# created_files = archiver.create_all_archives()
+# upload_json = archiver.create_rt_upload_json(Path("./build/output"))  # only includes archives with target repos

spl_core-7.14.0/src/spl_core/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.14.0"