Refactor SAMM CLI, add archive extraction, update CI & version bump

- Enhance SAMM CLI functions with capture output option and update tests
- Add ability to download samm-cli for macOS
- Add archive extraction functionality to download_samm_cli
- Add SAMM CLI installation and native dependencies to CI workflow
- Stop running tests after the first failure
- Refactor resource path in test_cli_functions to improve clarity and maintainability
- Refactor SAMM CLI path retrieval for cross-platform compatibility

Author: Oleksandr Muzyka (EPAM)

.github/workflows/push_request_check.yml

@@ -35,6 +35,7 @@ jobs:
           cd core/esmf-aspect-meta-model-python
           poetry install
           poetry run download-samm-release
+          poetry run download-samm-cli
           poetry build
 
       - name: run tests

.gitignore

@@ -69,5 +69,5 @@ dmypy.json
 
 # SAMM
 core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_aspect_meta_model/samm/
-/core/esmf-aspect-meta-model-python/samm-cli/
+core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_cli/samm-cli/
 /core/esmf-aspect-meta-model-python/tests/integration/aspect_model_loader/java_models/resources/

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_cli/base.py

@@ -16,11 +16,14 @@
 
 
 class SAMMCliConstants:
-    BASE_PATH = Template("https://github.com/eclipse-esmf/esmf-sdk/releases/download/v$version_number/$file_name")
-    JAVA_CLI_VERSION = JAVA_CLI_VERSION
-    LINUX_FILE_NAME = Template("samm-cli-$version_number-linux-x86_64.tar.gz")
     SAMM_VERSION = SAMM_VERSION
+    JAVA_CLI_VERSION = JAVA_CLI_VERSION
+
+    BASE_PATH = Template("https://github.com/eclipse-esmf/esmf-sdk/releases/download/v$version_number/$file_name")
+
     WIN_FILE_NAME = Template("samm-cli-$version_number-windows-x86_64.zip")
+    LINUX_FILE_NAME = Template("samm-cli-$version_number-linux-x86_64.tar.gz")
+    MAC_FILE_NAME = Template("samm-cli-$version_number-macos-x86_64.tar.gz")
 
 
 class SAMMCLICommands:

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_cli/constants.py

@@ -1,13 +1,14 @@
 """Download SAMM CLI.
 
-Windows: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.10.2/samm-cli-2.10.2-windows-x86_64.zip
-  Linux: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.10.2/samm-cli-2.10.2-linux-x86_64.tar.gz
-    JAR: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.10.2/samm-cli-2.10.2.jar
+Windows: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.11.1/samm-cli-2.11.1-windows-x86_64.zip
+  Linux: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.11.1/samm-cli-2.11.1-linux-x86_64.tar.gz
+    JAR: https://github.com/eclipse-esmf/esmf-sdk/releases/download/v2.11.1/samm-cli-2.11.1.jar
 """
 
 import os
 import platform
 import sys
+import tarfile
 import zipfile
 
 from pathlib import Path
@@ -24,6 +25,8 @@ def get_samm_cli_file_name():
         file_name = Const.WIN_FILE_NAME.substitute(version_number=Const.JAVA_CLI_VERSION)
     elif platform.system() == "Linux":
         file_name = Const.LINUX_FILE_NAME.substitute(version_number=Const.JAVA_CLI_VERSION)
+    elif platform.system() == "Darwin":  # macOS
+        file_name = Const.MAC_FILE_NAME.substitute(version_number=Const.JAVA_CLI_VERSION)
     else:
         raise NotImplementedError(
             f"Please download a SAMM CLI manually for your operation system from '{Const.BASE_PATH}'"
@@ -37,6 +40,8 @@ def download_archive_file(url, archive_file):
     with open(archive_file, "wb") as f:
         print("Downloading %s" % archive_file)
         response = requests.get(url, allow_redirects=True, stream=True)
+        response.raise_for_status()  # Fail fast if HTTP error
+
         content_len = response.headers.get("content-length")
 
         if content_len is None:
@@ -57,6 +62,18 @@ def download_archive_file(url, archive_file):
                 sys.stdout.flush()
 
 
+def extract_archive(archive_file, dest_dir):
+    """Extract archive depending on its file type."""
+    if archive_file.endswith(".zip"):
+        with zipfile.ZipFile(archive_file) as archive:
+            archive.extractall(dest_dir)
+    elif archive_file.endswith((".tar.gz", ".tgz")):
+        with tarfile.open(archive_file, mode="r:gz") as archive:
+            archive.extractall(dest_dir)
+    else:
+        raise ValueError(f"Unsupported archive format: {archive_file}")
+
+
 def download_samm_cli():
     try:
         samm_cli_file_name = get_samm_cli_file_name()
@@ -72,11 +89,7 @@ def download_samm_cli():
         print("\nSAMM CLI archive file downloaded")
 
         print("Start extracting files")
-        archive = zipfile.ZipFile(archive_file)
-        extracted_files_path = os.path.join(dir_path, "samm-cli")
-        for file in archive.namelist():
-            archive.extract(file, extracted_files_path)
-        archive.close()
+        extract_archive(archive_file, dest_dir=os.path.join(dir_path, "samm-cli"))
         print("Done extracting files")
 
         print("Deleting SAMM CLI archive file")

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_cli/download.py

@@ -1,3 +1,13 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
 """Integration tests for SAMM CLI functions."""
 
 import json
@@ -11,7 +21,7 @@
 
 from esmf_aspect_meta_model_python.samm_cli.base import SammCli
 
-RESOURCE_PATH = os.getcwd() / Path("tests/integration/resources/org.eclipse.esmf.test.general/2.1.0")
+RESOURCE_PATH = Path(__file__).parent / "resources" / "org.eclipse.esmf.test.general" / "2.1.0"
 
 
 @pytest.fixture(scope="module")
@@ -41,18 +51,29 @@ def samm_cli():
 class TestSammCliIntegration:
     """Integration tests for SAMM CLI transformations."""
 
-    def test_prettyprint(self, samm_cli, file_path, temp_output_dir):
-        """Test pretty-printing the model."""
-        output_file = os.path.join(temp_output_dir, "prettyprinted.ttl")
+    class TestPrettyPrint:
+        """Test pretty-printing functionality."""
 
-        samm_cli.prettyprint(file_path, output=output_file)
+        def test_file_output(self, samm_cli, file_path, temp_output_dir):
+            """Test pretty-printing to a file."""
+            output_file = os.path.join(temp_output_dir, "prettyprinted.ttl")
 
-        assert os.path.exists(output_file)
-        assert os.path.getsize(output_file) > 0
-        with open(output_file, "r") as f:
-            content = f.read()
-            assert "@prefix" in content
-            assert ":SampleAspect" in content
+            samm_cli.prettyprint(file_path, output=output_file)
+
+            assert os.path.exists(output_file)
+            assert os.path.getsize(output_file) > 0
+            with open(output_file, "r") as f:
+                content = f.read()
+                assert "@prefix" in content
+                assert ":SampleAspect" in content
+
+        def test_capture_output(self, samm_cli, file_path):
+            """Test pretty-printing with captured output."""
+            prettyprinted_content = samm_cli.prettyprint(file_path, capture=True)
+
+            assert isinstance(prettyprinted_content, str)
+            assert "@prefix" in prettyprinted_content
+            assert ":SampleAspect" in prettyprinted_content
 
     def test_to_json(self, samm_cli, file_path, temp_output_dir):
         """Test generating example JSON payload."""