refactor: reorganize test resources and improve SAMM CLI command handling

Author: Oleksandr Muzyka (EPAM)

.gitignore

@@ -70,4 +70,4 @@ 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/tests/integration/java_models/resources/
+/core/esmf-aspect-meta-model-python/tests/integration/pymodels/java_models/resources/

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/samm_cli_functions.py

@@ -8,8 +8,6 @@
 #  file, You can obtain one at https://mozilla.org/MPL/2.0/.
 #
 #   SPDX-License-Identifier: MPL-2.0
-import platform
-import shlex
 import subprocess
 
 from os.path import exists, join
@@ -26,13 +24,42 @@ class SammCli:
     SAMM CLI version.
     """
 
+    # Command names
+    CMD_VALIDATE = "validate"
+    CMD_TO_OPENAPI = "to openapi"
+    CMD_TO_SCHEMA = "to schema"
+    CMD_TO_JSON = "to json"
+    CMD_TO_HTML = "to html"
+    CMD_TO_PNG = "to png"
+    CMD_TO_SVG = "to svg"
+    CMD_PRETTYPRINT = "prettyprint"
+    CMD_TO_JAVA = "to java"
+    CMD_TO_ASYNCAPI = "to asyncapi"
+    CMD_TO_JSONLD = "to jsonld"
+    CMD_TO_SQL = "to sql"
+    CMD_TO_AAS = "to aas"
+    CMD_EDIT_MOVE = "edit move"
+    CMD_EDIT_NEWVERSION = "edit newversion"
+    CMD_USAGE = "usage"
+    CMD_AAS_TO_ASPECT = "to aspect"
+    CMD_AAS_LIST = "list"
+    CMD_PACKAGE_IMPORT = "import"
+    CMD_PACKAGE_EXPORT = "export"
+
+    # Command types
+    TYPE_ASPECT = "aspect"
+    TYPE_AAS = "aas"
+    TYPE_PACKAGE = "package"
+
+    ALLOWED_COMMAND_TYPES = {TYPE_ASPECT, TYPE_AAS, TYPE_PACKAGE}
+
     def __init__(self):
         self._samm = self._get_client_path()
         self._validate_client()
 
     @staticmethod
     def _get_client_path():
-        """Get path to the SAMM CLI executable file.."""
+        """Get path to the SAMM CLI executable file."""
         base_path = Path(__file__).resolve()
         cli_path = join(base_path.parents[1], "samm-cli", "samm.exe")
 
@@ -42,9 +69,28 @@ def _get_client_path():
     def _format_argument(key: str, value: Any) -> str:
         """Helper method to format command line arguments."""
         if len(key) == 1:
-            return f"-{key}={value}"
-        key_formatted = key.replace("_", "-")
-        return f"--{key_formatted}={value}"
+            formatted = f"-{key}={value}"
+        else:
+            formatted = f"--{key.replace('_', '-')}={value}"
+        return formatted
+
+    def _process_kwargs(self, kwargs: dict) -> list[str]:
+        """Process keyword arguments and return formatted command line arguments.
+
+        Args:
+            kwargs: Dictionary of keyword arguments where values can be single items or lists/tuples
+
+        Returns:
+            List of formatted command line arguments
+        """
+        args = []
+        for key, value in kwargs.items():
+            if isinstance(value, (list, tuple)):
+                for item in value:
+                    args.append(self._format_argument(key, item))
+            else:
+                args.append(self._format_argument(key, value))
+        return args
 
     def _validate_client(self):
         """Validate SAMM CLI.
@@ -54,25 +100,22 @@ def _validate_client(self):
         if not exists(self._samm):
             download_samm_cli()
 
-    def _call_function(self, function_name, path_to_model, *args, command_type="aspect", **kwargs):
+    def _call_function(self, function_name, path_to_model, *args, command_type=None, **kwargs):
         """Run a SAMM CLI function as a subprocess."""
+        if command_type is None:
+            command_type = self.TYPE_ASPECT
+        elif command_type not in self.ALLOWED_COMMAND_TYPES:
+            raise ValueError(f"Invalid command type: '{command_type}'. ")
+
         call_args = [self._samm, command_type, path_to_model] + function_name.split()
 
         if args:
             call_args.extend([f"-{param}" for param in args])
 
         if kwargs:
-            for key, value in kwargs.items():
-                if isinstance(value, (list, tuple)):
-                    for item in value:
-                        call_args.append(self._format_argument(key, item))
-                else:
-                    call_args.append(self._format_argument(key, value))
-
-        if platform.system() == "Darwin":  # macOS
-            call_args = shlex.join(call_args)
+            call_args.extend(self._process_kwargs(kwargs))
 
-        subprocess.run(call_args, shell=True, check=True)
+        subprocess.run(call_args)
 
     def validate(self, path_to_model, *args, **kwargs):
         """Validate Aspect Model.
@@ -81,7 +124,7 @@ def validate(self, path_to_model, *args, **kwargs):
         possible arguments:
             custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("validate", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_VALIDATE, path_to_model, *args, **kwargs)
 
     def prettyprint(self, path_to_model, *args, **kwargs):
         """Pretty-print Aspect Model.
@@ -94,7 +137,7 @@ def prettyprint(self, path_to_model, *args, **kwargs):
             - overwrite, w: overwrite the input file (use as flag without value)
             - custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("prettyprint", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_PRETTYPRINT, path_to_model, *args, **kwargs)
 
     def usage(self, path_to_model, *args, **kwargs):
         """Shows where model elements are used in an Aspect.
@@ -111,7 +154,7 @@ def usage(self, path_to_model, *args, **kwargs):
             # Show usage for an element URN with models root
             samm_cli.usage("urn:samm:org.eclipse.example:1.0.0#MyElement", models_root="/path/to/models")
         """
-        self._call_function("usage", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_USAGE, path_to_model, *args, **kwargs)
 
     def to_openapi(self, path_to_model, *args, **kwargs):
         """Generate OpenAPI specification for an Aspect Model.
@@ -136,7 +179,7 @@ def to_openapi(self, path_to_model, *args, **kwargs):
             - language, l: the language from the model for which an OpenAPI specification should be generated (default: en)
             custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to openapi", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_OPENAPI, path_to_model, *args, **kwargs)
 
     def to_schema(self, path_to_model, *args, **kwargs):
         """Generate JSON schema for an Aspect Model.
@@ -147,7 +190,7 @@ def to_schema(self, path_to_model, *args, **kwargs):
             - language, -l: the language from the model for which a JSON schema should be generated (default: en)
             - custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to schema", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_SCHEMA, path_to_model, *args, **kwargs)
 
     def to_json(self, path_to_model, *args, **kwargs):
         """Generate example JSON payload data for an Aspect Model.
@@ -157,7 +200,7 @@ def to_json(self, path_to_model, *args, **kwargs):
             - output, -o: output file path (default: stdout)
             - custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to json", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_JSON, path_to_model, *args, **kwargs)
 
     def to_html(self, path_to_model, *args, **kwargs):
         """Generate HTML documentation for an Aspect Model.
@@ -169,7 +212,7 @@ def to_html(self, path_to_model, *args, **kwargs):
             - language, -l: the language from the model for which the HTML should be generated (default: en)
             - custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to html", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_HTML, path_to_model, *args, **kwargs)
 
     def to_png(self, path_to_model, *args, **kwargs):
         """Generate PNG diagram for Aspect Model.
@@ -182,7 +225,7 @@ def to_png(self, path_to_model, *args, **kwargs):
             - language, -l: the language from the model for which the diagram should be generated (default: en)
             - custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to png", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_PNG, path_to_model, *args, **kwargs)
 
     def to_svg(self, path_to_model, *args, **kwargs):
         """Generate SVG diagram for Aspect Model.
@@ -193,7 +236,7 @@ def to_svg(self, path_to_model, *args, **kwargs):
             - language, -l: the language from the model for which the diagram should be generated (default: en)
             - custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to svg", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_SVG, path_to_model, *args, **kwargs)
 
     def to_java(self, path_to_model, *args, **kwargs):
         """Generate Java classes from an Aspect Model.
@@ -216,7 +259,7 @@ def to_java(self, path_to_model, *args, **kwargs):
             - name_prefix, namePrefix: name prefix for generated Aspect, Entity Java classes
             - name_postfix, namePostfix: name postfix for generated Aspect, Entity Java classes
         """
-        self._call_function("to java", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_JAVA, path_to_model, *args, **kwargs)
 
     def to_asyncapi(self, path_to_model, *args, **kwargs):
         """Generate AsyncAPI specification for an Aspect Model.
@@ -233,7 +276,7 @@ def to_asyncapi(self, path_to_model, *args, **kwargs):
             - separate_files, sf: create separate files for each schema (use as flag without value)
             - custom_resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to asyncapi", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_ASYNCAPI, path_to_model, *args, **kwargs)
 
     def to_jsonld(self, path_to_model, *args, **kwargs):
         """Generate JSON-LD representation of an Aspect Model.
@@ -243,7 +286,7 @@ def to_jsonld(self, path_to_model, *args, **kwargs):
             - output, o: output file path (default: stdout)
             - custom_resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function("to jsonld", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_JSONLD, path_to_model, *args, **kwargs)
 
     def to_sql(self, path_to_model, *args, **kwargs):
         """Generate SQL script that sets up a table for data for this Aspect.
@@ -288,19 +331,19 @@ def to_sql(self, path_to_model, *args, **kwargs):
             # or call the CLI directly. Current implementation supports single custom column.
             samm_cli.to_sql("AspectModel.ttl", custom_column=("column1 STRING", "column2 INT"))
         """
-        self._call_function("to sql", path_to_model, *args, **kwargs)
-
-    def to_aas(self, path_to_model, *args, **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)
-        possible arguments:
-            - output, o: output file path (default: stdout)
-            - format, f: output file format (XML, JSON, or AASX, default: XML)
-            - aspect_data, a: path to a JSON file containing aspect data corresponding to the Aspect Model
-            - custom_resolver: use an external resolver for the resolution of the model elements
-        """
-        self._call_function("to aas", path_to_model, *args, **kwargs)
+        self._call_function(self.CMD_TO_SQL, path_to_model, *args, **kwargs)
+
+    # def to_aas(self, path_to_model, *args, **kwargs):  # FIXME: https://github.com/eclipse-esmf/esmf-sdk/issues/802
+    #     """Generate an Asset Administration Shell (AAS) submodel template from an Aspect Model.
+    #
+    #     param path_to_model: local path to the aspect model file (*.ttl)
+    #     possible arguments:
+    #         - output, o: output file path (default: stdout)
+    #         - format, f: output file format (XML, JSON, or AASX, default: XML)
+    #         - aspect_data, a: path to a JSON file containing aspect data corresponding to the Aspect Model
+    #         - custom_resolver: use an external resolver for the resolution of the model elements
+    #     """
+    #     self._call_function(self.CMD_AAS_TO_ASPECT, path_to_model, *args, **kwargs)
 
     def edit_move(self, path_to_model, element, namespace=None, *args, **kwargs):
         """Move a model element definition from its current place to another existing or
@@ -334,7 +377,7 @@ def edit_move(self, path_to_model, element, namespace=None, *args, **kwargs):
             samm_cli.edit_move("AspectModel.ttl", "MyAspect newFile.ttl", None, "copy-file-header", "force")
         """
         # Build the function name with positional arguments
-        function_name = f"edit move {element}"
+        function_name = f"{self.CMD_EDIT_MOVE} {element}"
         if namespace:
             function_name += f" {namespace}"
 
@@ -380,7 +423,7 @@ def edit_newversion(self, path_to_model, version_type=None, *args, **kwargs):
         if version_type and version_type in ("major", "minor", "micro"):
             args_list.insert(0, version_type)
 
-        self._call_function("edit newversion", path_to_model, *args_list, **kwargs)
+        self._call_function(self.CMD_EDIT_NEWVERSION, path_to_model, *args_list, **kwargs)
 
     def aas_to_aspect(self, aas_file, *args, **kwargs):
         """Translate Asset Administration Shell (AAS) Submodel Templates to Aspect Models.
@@ -408,7 +451,7 @@ def aas_to_aspect(self, aas_file, *args, **kwargs):
             # or using short form
             samm_cli.aas_to_aspect("AssetAdminShell.aasx", s=["1", "2"])
         """
-        self._call_function("to aspect", aas_file, *args, command_type="aas", **kwargs)
+        self._call_function(self.CMD_AAS_TO_ASPECT, aas_file, *args, command_type=self.TYPE_AAS, **kwargs)
 
     def aas_list(self, aas_file, *args, **kwargs):
         """Retrieve a list of submodel templates contained within the provided Asset Administration Shell (AAS) file.
@@ -419,7 +462,7 @@ def aas_list(self, aas_file, *args, **kwargs):
             # List all submodel templates in an AAS file
             samm_cli.aas_list("AssetAdminShell.aasx")
         """
-        self._call_function("list", aas_file, *args, command_type="aas", **kwargs)
+        self._call_function(self.CMD_AAS_LIST, aas_file, *args, command_type=self.TYPE_AAS, **kwargs)
 
     def package_import(self, namespace_package, *args, **kwargs):
         """Imports a Namespace Package (file or URL) into a given models' directory.
@@ -446,7 +489,7 @@ def package_import(self, namespace_package, *args, **kwargs):
             # Force import
             samm_cli.package_import("MyPackage.zip", "force", models_root="c:\\models")
         """
-        self._call_function("import", namespace_package, *args, command_type="package", **kwargs)
+        self._call_function(self.CMD_PACKAGE_IMPORT, namespace_package, *args, command_type=self.TYPE_PACKAGE, **kwargs)
 
     def package_export(self, model_or_urn, *args, **kwargs):
         """Exports an Aspect Model with its dependencies or a complete namespace to a Namespace Package (.zip).
@@ -473,4 +516,4 @@ def package_export(self, model_or_urn, *args, **kwargs):
             # Export to specific location
             samm_cli.package_export("AspectModel.ttl", output="c:\\exports\\my-package.zip")
         """
-        self._call_function("export", model_or_urn, *args, command_type="package", **kwargs)
+        self._call_function(self.CMD_PACKAGE_EXPORT, model_or_urn, *args, command_type=self.TYPE_PACKAGE, **kwargs)

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

@@ -34,4 +34,4 @@ class TestModelConstants:
         "esmf-test-aspect-models-$version_number.jar"
     )
     SAMM_VERSION = SAMM_VERSION
-    TEST_MODELS_PATH = join("tests", "integration", "java_models", "resources")
+    TEST_MODELS_PATH = join("tests", "integration", "pymodels", "java_models", "resources")