spl-core 7.5.1__py3-none-any.whl → 7.6.0__py3-none-any.whl

spl_core/__init__.py

@@ -1 +1 @@
-__version__ = "7.5.1"
+__version__ = "7.6.0"

spl_core/test_utils/archive_artifacts_collection.py

@@ -0,0 +1,120 @@
+import json
+import zipfile
+from dataclasses import dataclass
+from pathlib import Path
+from typing import List, Optional
+
+
+class ArchiveArtifactsCollection:
+    """
+    Collection of artifacts to be archived.
+    This class collects artifacts from a list of paths, handling both individual files and directories.
+    It supports absolute paths and ensures that the paths are relative to the build directory when archived.
+    """
+
+    @dataclass
+    class ArchiveArtifact:
+        """
+        Represents a single artifact to be archived.
+        This class holds the archive path (relative to the build directory) 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, artifacts: List[Path], build_dir: Path):
+        self.build_dir = build_dir
+        self.archive_artifacts: List[ArchiveArtifactsCollection.ArchiveArtifact] = []
+        for artifact in artifacts:
+            # Convert all artifacts to absolute paths first
+            artifact_path = artifact.resolve() if not artifact.is_absolute() else artifact
+
+            # Handle directories by recursively adding all files within them
+            if artifact_path.is_dir():
+                for file_artifact in artifact_path.glob("**/*"):
+                    if file_artifact.is_file():
+                        # Calculate the relative path from build_dir for the archive
+                        if file_artifact.is_relative_to(build_dir.absolute()):
+                            archive_path = file_artifact.relative_to(build_dir.absolute())
+                        else:
+                            # If not relative to build_dir, just use the filename
+                            archive_path = Path(file_artifact.name)
+
+                        self.archive_artifacts.append(self.ArchiveArtifact(archive_path=archive_path, absolute_path=file_artifact))
+            else:
+                # Handle individual files
+                # Calculate the relative path from build_dir for the archive
+                if artifact_path.is_relative_to(build_dir.absolute()):
+                    archive_path = artifact_path.relative_to(build_dir.absolute())
+                else:
+                    # If not relative to build_dir, just use the filename
+                    archive_path = Path(artifact_path.name)
+
+                self.archive_artifacts.append(self.ArchiveArtifact(archive_path=archive_path, absolute_path=artifact_path))
+
+    def create_archive(self, zip_filename: Optional[str] = None) -> Path:
+        """
+        Create a zip file containing the collected artifacts.
+        Args:
+            zip_filename: Optional custom name for the zip file (without extension).
+                         If None, defaults to "artifacts.zip"
+        Returns:
+            Path: The path to the created zip file.
+        Raises:
+            Exception: If there is an error creating the zip file.
+        """
+        if zip_filename is None:
+            zip_path = self.build_dir / "artifacts.zip"
+        else:
+            # Ensure the filename has .zip extension
+            if not zip_filename.endswith(".zip"):
+                zip_filename += ".zip"
+            zip_path = self.build_dir / zip_filename
+
+        # Delete the file if it already exists
+        if zip_path.exists():
+            zip_path.unlink()
+
+        try:
+            with zipfile.ZipFile(zip_path, "w") as zip_file:
+                for artifact in self.archive_artifacts:
+                    zip_file.write(artifact.absolute_path, arcname=artifact.archive_path)
+            print(f"Zip file created at: {zip_path}")
+            return zip_path
+        except Exception as e:
+            print(f"Error creating artifacts zip file: {e}")
+            raise e
+
+    def create_json(self, json_filename: Optional[str] = None) -> Path:
+        """
+        Create a JSON file containing the collected artifacts.
+        Args:
+            json_filename: Optional custom name for the JSON file (without extension).
+                           If None, defaults to "artifacts.json"
+        Returns:
+            Path: The path to the created JSON file.
+        Raises:
+            Exception: If there is an error creating the JSON file.
+        """
+        if json_filename is None:
+            json_path = self.build_dir / "artifacts.json"
+        else:
+            # Ensure the filename has .json extension
+            if not json_filename.endswith(".json"):
+                json_filename += ".json"
+            json_path = self.build_dir / json_filename
+
+        # Delete the file if it already exists
+        if json_path.exists():
+            json_path.unlink()
+
+        try:
+            json_content = {
+                "artifacts": [str(artifact.archive_path.as_posix()) for artifact in self.archive_artifacts],
+            }
+            json_path.write_text(json.dumps(json_content, indent=4))
+            return json_path
+        except Exception as e:
+            print(f"Error creating artifacts JSON file: {e}")
+            raise e

spl_core/test_utils/base_variant_test_runner.py

@@ -9,6 +9,11 @@ from spl_core.test_utils.spl_build import SplBuild
 
 
 class BaseVariantTestRunner(ABC):
+    """
+    Obsolete class for running tests on a specific variant of the SPL.
+    Instead use SplBuild directly in your test cases.
+    """
+
     @property
     def variant(self) -> str:
         return re.sub(r"^Test_", "", self.__class__.__name__).replace("__", "/")

spl_core/test_utils/spl_build.py

@@ -12,11 +12,15 @@ from spl_core.common.command_line_executor import CommandLineExecutor
 
 @dataclass
 class ArchiveArtifact:
+    """Obsolete class for storing archive artifacts."""
+
     archive_path: Path
     absolute_path: Path
 
 
 class ArtifactsCollection:
+    """Obsolete class for collecting artifacts to be archived."""
+
     def __init__(self, artifacts: List[Path], build_dir: Path):
         self.archive_artifacts: List[ArchiveArtifact] = []
         for artifact in artifacts:
@@ -161,7 +165,7 @@ class SplBuild:
 
     def create_artifacts_archive(self, expected_artifacts: List[Path]) -> Path:
         """
-        Create a zip file containing the collected artifacts.
+        Obsolete method for creating an archive of artifacts.
 
         Args:
             expected_artifacts: List of Path of artifacts which should be archived
@@ -192,7 +196,7 @@ class SplBuild:
 
     def create_artifacts_json(self, expected_artifacts: List[Path]) -> Path:
         """
-        Create a JSON file listing the collected artifacts.
+        Obsolete method to create a JSON file listing the collected artifacts.
 
         Returns:
             Path: The path to the created JSON file.

{spl_core-7.5.1.dist-info → spl_core-7.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: spl-core
-Version: 7.5.1
+Version: 7.6.0
 Summary: Software Product Line Support for CMake
 License: MIT
 Author: Avengineers

{spl_core-7.5.1.dist-info → spl_core-7.6.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-spl_core/__init__.py,sha256=7vQ6Qcfa2cKVApeGf8DgZrqPj1SIk9k4gQziWrjB-ug,22
+spl_core/__init__.py,sha256=RS7ZvpeTsPTr9tY3yeVA3qW0ISlF5jRmARJfzG9UJLs,22
 spl_core/__run.py,sha256=DphnN7_Bjiw_mOOztsHxTDHS8snz1g2MMWAaJpZxPKM,361
 spl_core/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spl_core/common/command_line_executor.py,sha256=GHIMpNiMD_eP44vq7L_HiC08aKt7lgW_wn_omU6REwQ,2217
@@ -60,10 +60,11 @@ spl_core/kickstart/templates/project/tools/toolchains/clang/toolchain.cmake,sha2
 spl_core/kickstart/templates/project/tools/toolchains/gcc/toolchain.cmake,sha256=AmLzPyhTgfc_Dsre4AlsvSOkVGW6VswWvrEnUL8JLhA,183
 spl_core/main.py,sha256=_hL4j155WZMXog_755bgAH1PeUwvTdJZvVdVw9EWhvo,1225
 spl_core/spl.cmake,sha256=W8h-Zj-N302qxMrRG8MhoEkJ0io92bWGp4Y5r8LBQnc,4535
-spl_core/test_utils/base_variant_test_runner.py,sha256=0q3jejtj4aEPnlK2mTsgVEaxMP6TZ3Isq-JqZvBeZNo,3653
-spl_core/test_utils/spl_build.py,sha256=wRCtCgnptQaB4Tc_shAmcjJid9mxdYLR910G-PTL9TI,8090
-spl_core-7.5.1.dist-info/LICENSE,sha256=UjjA0o8f5tT3wVm7qodTLAhPWLl6kgVyn9FPAd1VeYY,1099
-spl_core-7.5.1.dist-info/METADATA,sha256=WxByLTGkaMnj8OggCewHYYfmgovm_QTHYtQKUtNH81o,5157
-spl_core-7.5.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-spl_core-7.5.1.dist-info/entry_points.txt,sha256=18_sdVY93N1GVBiAHxQ_F9ZM-bBvOmVMOMn7PNe2EqU,45
-spl_core-7.5.1.dist-info/RECORD,,
+spl_core/test_utils/archive_artifacts_collection.py,sha256=x7LH5dGIvssyhXsTFzB6rjgb5D2efKvHVpnjId3MNDk,5126
+spl_core/test_utils/base_variant_test_runner.py,sha256=Oq27lkJlpB_y-p2_8S23F5zjn1438HW148q-hQNz3EY,3795
+spl_core/test_utils/spl_build.py,sha256=o3MCWYRb769bXut_9EM_ZEweRKH7SSAuajh9277mKuI,8233
+spl_core-7.6.0.dist-info/LICENSE,sha256=UjjA0o8f5tT3wVm7qodTLAhPWLl6kgVyn9FPAd1VeYY,1099
+spl_core-7.6.0.dist-info/METADATA,sha256=Huw1KNDwaxEKkGMYwclTYg3cg_n-8HU6KfbTmXRktko,5157
+spl_core-7.6.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+spl_core-7.6.0.dist-info/entry_points.txt,sha256=18_sdVY93N1GVBiAHxQ_F9ZM-bBvOmVMOMn7PNe2EqU,45
+spl_core-7.6.0.dist-info/RECORD,,