- Refactor SAMM CLI path retrieval for cross-platform compatibility

- Add archive extraction functionality to download_samm_cli
- Add SAMM CLI installation and native dependencies to CI workflow
- Refactor resource path in test_cli_functions to improve clarity and maintainability
- Stop running tests after the first failure
- Upgrade JAVA_CLI_VERSION from 2.10.2 to 2.11.1

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

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

@@ -8,6 +8,7 @@
 #  file, You can obtain one at https://mozilla.org/MPL/2.0/.
 #
 #   SPDX-License-Identifier: MPL-2.0
+import platform
 import subprocess
 
 from os.path import exists, join
@@ -33,9 +34,14 @@ def __init__(self):
     def _get_client_path():
         """Get path to the SAMM CLI executable file."""
         base_path = Path(__file__).resolve()
-        cli_path = join(base_path.parents[2], "samm-cli", "samm.exe")
+        cli_dir = join(base_path.parents[2], "samm-cli")
 
-        return cli_path
+        if platform.system() == "Windows":
+            cli_file = "samm.exe"
+        else:
+            cli_file = "samm"  # Unix-like systems
+
+        return join(cli_dir, cli_file)
 
     @staticmethod
     def _format_argument(key: str, value: Any) -> str:
@@ -327,7 +333,8 @@ def to_sql(self, path_to_model, *args, capture=False, **kwargs):
         """
         return self._call_function(SAMMCLICommands.TO_SQL, path_to_model, *args, capture=capture, **kwargs)
 
-    # def to_aas(self, path_to_model, *args, capture=False, **kwargs):  # FIXME: https://github.com/eclipse-esmf/esmf-sdk/issues/802
+    # FIXME: https://github.com/eclipse-esmf/esmf-sdk/issues/802
+    # def to_aas(self, path_to_model, *args, capture=False, **kwargs):
     #     """Generate an Asset Administration Shell (AAS) submodel template from an Aspect Model.
     #
     #     param path_to_model: local path to the aspect model file (*.ttl)

core/esmf-aspect-meta-model-python/scripts/constants.py

@@ -14,7 +14,7 @@
 
 
 SAMM_VERSION = "2.2.0"
-JAVA_CLI_VERSION = "2.10.2"
+JAVA_CLI_VERSION = "2.11.1"
 
 
 class SAMMCliConstants:

core/esmf-aspect-meta-model-python/scripts/download_samm_cli.py

@@ -6,6 +6,7 @@
 """
 
 import os
+import tarfile
 from pathlib import Path
 import platform
 import requests
@@ -35,6 +36,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:
@@ -55,6 +58,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()
@@ -70,10 +85,7 @@ def download_samm_cli():
         print("\nSAMM CLI archive file downloaded")
 
         print("Start extracting files")
-        archive = zipfile.ZipFile(archive_file)
-        for file in archive.namelist():
-            archive.extract(file, "samm-cli")
-        archive.close()
+        extract_archive(archive_file, os.path.join(dir_path, "samm-cli"))
         print("Done extracting files.")
 
         print("Deleting SAMM CLI archive file.")

core/esmf-aspect-meta-model-python/tests/integration/test_cli_functions.py

@@ -21,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")

core/esmf-aspect-meta-model-python/tests/unit/samm_cli/test_base.py

@@ -63,7 +63,7 @@ def test_get_client_path(_, path_mock, join_mock):
 
     assert result == "cli_path"
     path_mock.resolve.assert_called_once()
-    join_mock.assert_called_once_with("parent_2", "samm-cli", "samm.exe")
+    join_mock.assert_has_calls([mock.call('parent_2', 'samm-cli'), mock.call('cli_path', 'samm')])
 
 
 @mock.patch(f"{BASE_PATH}.download_samm_cli")

core/esmf-aspect-meta-model-python/tox.ini

@@ -11,7 +11,7 @@ description = Run the tests
 commands_pre = poetry install
 commands =
     poetry run pytest {posargs: \
-    -s -vv \
+    -x -s -vv \
     --cov=esmf_aspect_meta_model_python/ \
     --cov-fail-under=85 \
     tests/ \
@@ -42,4 +42,4 @@ known_first_party = esmf_aspect_meta_model_python, tests
 line_length = 120
 lines_between_types = 1
 multi_line_output = 3
-sections = STDLIB, THIRDPARTY, FIRSTPARTY, LOCALFOLDER
+sections = STDLIB, THIRDPARTY, FIRSTPARTY, LOCALFOLDER