Enhance SAMM CLI functions with capture output option and update tests

Author: Oleksandr Muzyka (EPAM)

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

@@ -74,22 +74,28 @@ def _validate_client(self):
         if not exists(self._samm):
             download_samm_cli()
 
-    def _call_function(self, function_name, path_to_model, *args, command_type=None, **kwargs):
+    def _call_function(self, function_name, path_to_model, *args, command_type=None, capture=False, **kwargs) -> str:
         """Run a SAMM CLI function as a subprocess.
 
         Args:
             function_name: The SAMM CLI function to call
             path_to_model: Path to the model file
             *args: Positional arguments (flags)
             command_type: Command type (must be one of SAMMCLICommandTypes values)
+            capture: If True, run with capture_output=True, text=True, check=True and return stdout
             **kwargs: Keyword arguments
 
         Raises:
             ValueError: If command_type is not one of the allowed types
+            [subprocess.CalledProcessError]: If capture is True and the subprocess call fails
+
+        Returns:
+            The stdout of the subprocess if capture is True, otherwise None
         """
         if command_type is None:
             command_type = SAMMCLICommandTypes.ASPECT
 
+        call_kwargs = dict()
         call_args = [self._samm, command_type, path_to_model] + function_name.split()
 
         if args:
@@ -98,18 +104,23 @@ def _call_function(self, function_name, path_to_model, *args, command_type=None,
         if kwargs:
             call_args.extend(self._process_kwargs(kwargs))
 
-        subprocess.run(call_args)
+        if capture:
+            call_kwargs.update(capture_output=True, text=True, check=True)
+
+        result = subprocess.run(call_args, **call_kwargs)
+
+        return result.stdout
 
-    def validate(self, path_to_model, *args, **kwargs):
+    def validate(self, path_to_model, *args, capture=False, **kwargs):
         """Validate Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
         possible arguments:
             custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function(SAMMCLICommands.VALIDATE, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.VALIDATE, path_to_model, *args, capture=capture, **kwargs)
 
-    def prettyprint(self, path_to_model, *args, **kwargs):
+    def prettyprint(self, path_to_model, *args, capture=False, **kwargs):
         """Pretty-print Aspect Model.
 
         Formats the Aspect Model file with proper indentation and structure.
@@ -120,9 +131,9 @@ 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(SAMMCLICommands.PRETTYPRINT, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.PRETTYPRINT, path_to_model, *args, capture=capture, **kwargs)
 
-    def usage(self, path_to_model, *args, **kwargs):
+    def usage(self, path_to_model, *args, capture=False, **kwargs):
         """Shows where model elements are used in an Aspect.
 
         param path_to_model: local path to the aspect model file (*.ttl) or an element URN
@@ -137,9 +148,9 @@ 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(SAMMCLICommands.USAGE, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.USAGE, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_openapi(self, path_to_model, *args, **kwargs):
+    def to_openapi(self, path_to_model, *args, capture=False, **kwargs):
         """Generate OpenAPI specification for an Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -162,9 +173,9 @@ 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(SAMMCLICommands.TO_OPENAPI, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_OPENAPI, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_schema(self, path_to_model, *args, **kwargs):
+    def to_schema(self, path_to_model, *args, capture=False, **kwargs):
         """Generate JSON schema for an Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -173,19 +184,19 @@ 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(SAMMCLICommands.TO_SCHEMA, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_SCHEMA, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_json(self, path_to_model, *args, **kwargs):
+    def to_json(self, path_to_model, *args, capture=False, **kwargs):
         """Generate example JSON payload data for an Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
         possible arguments:
             - output, -o: output file path (default: stdout)
             - custom-resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function(SAMMCLICommands.TO_JSON, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_JSON, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_html(self, path_to_model, *args, **kwargs):
+    def to_html(self, path_to_model, *args, capture=False, **kwargs):
         """Generate HTML documentation for an Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -195,9 +206,9 @@ 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(SAMMCLICommands.TO_HTML, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_HTML, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_png(self, path_to_model, *args, **kwargs):
+    def to_png(self, path_to_model, *args, capture=False, **kwargs):
         """Generate PNG diagram for Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -208,9 +219,9 @@ 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(SAMMCLICommands.TO_PNG, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_PNG, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_svg(self, path_to_model, *args, **kwargs):
+    def to_svg(self, path_to_model, *args, capture=False, **kwargs):
         """Generate SVG diagram for Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -219,9 +230,9 @@ 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(SAMMCLICommands.TO_SVG, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_SVG, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_java(self, path_to_model, *args, **kwargs):
+    def to_java(self, path_to_model, *args, capture=False, **kwargs):
         """Generate Java classes from an Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -242,9 +253,9 @@ 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(SAMMCLICommands.TO_JAVA, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_JAVA, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_asyncapi(self, path_to_model, *args, **kwargs):
+    def to_asyncapi(self, path_to_model, *args, capture=False, **kwargs):
         """Generate AsyncAPI specification for an Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -259,19 +270,19 @@ 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(SAMMCLICommands.TO_ASYNCAPI, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_ASYNCAPI, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_jsonld(self, path_to_model, *args, **kwargs):
+    def to_jsonld(self, path_to_model, *args, capture=False, **kwargs):
         """Generate JSON-LD representation of an Aspect Model.
 
         param path_to_model: local path to the aspect model file (*.ttl)
         possible arguments:
             - output, o: output file path (default: stdout)
             - custom_resolver: use an external resolver for the resolution of the model elements
         """
-        self._call_function(SAMMCLICommands.TO_JSONLD, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_JSONLD, path_to_model, *args, capture=capture, **kwargs)
 
-    def to_sql(self, path_to_model, *args, **kwargs):
+    def to_sql(self, path_to_model, *args, capture=False, **kwargs):
         """Generate SQL script that sets up a table for data for this Aspect.
 
         param path_to_model: local path to the aspect model file (*.ttl)
@@ -314,9 +325,9 @@ 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(SAMMCLICommands.TO_SQL, path_to_model, *args, **kwargs)
+        return self._call_function(SAMMCLICommands.TO_SQL, path_to_model, *args, capture=capture, **kwargs)
 
-    # def to_aas(self, path_to_model, *args, **kwargs):  # FIXME: https://github.com/eclipse-esmf/esmf-sdk/issues/802
+    # def to_aas(self, path_to_model, *args, capture=False, **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)
@@ -326,9 +337,9 @@ def to_sql(self, path_to_model, *args, **kwargs):
     #         - 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(SAMMCLICommands.AAS_TO_ASPECT, path_to_model, *args, **kwargs)
+    #     return self._call_function(SAMMCLICommands.AAS_TO_ASPECT, path_to_model, *args, capture=capture, **kwargs)
 
-    def edit_move(self, path_to_model, element, namespace=None, *args, **kwargs):
+    def edit_move(self, path_to_model, element, namespace=None, *args, capture=False, **kwargs):
         """Move a model element definition from its current place to another existing or
             new file in the same or another namespace.
 
@@ -364,9 +375,9 @@ def edit_move(self, path_to_model, element, namespace=None, *args, **kwargs):
         if namespace:
             function_name += f" {namespace}"
 
-        self._call_function(function_name, path_to_model, *args, **kwargs)
+        return self._call_function(function_name, path_to_model, *args, capture=capture, **kwargs)
 
-    def edit_newversion(self, path_to_model, version_type=None, *args, **kwargs):
+    def edit_newversion(self, path_to_model, version_type=None, *args, capture=False, **kwargs):
         """Create a new version of an existing file or a complete namespace.
 
         param path_to_model: local path to the aspect model file (*.ttl) or a namespace URN
@@ -405,10 +416,11 @@ def edit_newversion(self, path_to_model, version_type=None, *args, **kwargs):
         args_list = list(args)
         if version_type and version_type in ("major", "minor", "micro"):
             args_list.insert(0, version_type)
+        return self._call_function(
+            SAMMCLICommands.EDIT_NEWVERSION, path_to_model, *args_list, capture=capture, **kwargs
+        )
 
-        self._call_function(SAMMCLICommands.EDIT_NEWVERSION, path_to_model, *args_list, **kwargs)
-
-    def aas_to_aspect(self, aas_file, *args, **kwargs):
+    def aas_to_aspect(self, aas_file, *args, capture=False, **kwargs):
         """Translate Asset Administration Shell (AAS) Submodel Templates to Aspect Models.
 
         param aas_file: path to the AAS file (*.aasx, *.xml, *.json)
@@ -434,11 +446,16 @@ 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(
-            SAMMCLICommands.AAS_TO_ASPECT, aas_file, *args, command_type=SAMMCLICommandTypes.AAS, **kwargs
+        return self._call_function(
+            SAMMCLICommands.AAS_TO_ASPECT,
+            aas_file,
+            *args,
+            command_type=SAMMCLICommandTypes.AAS,
+            capture=capture,
+            **kwargs,
         )
 
-    def aas_list(self, aas_file, *args, **kwargs):
+    def aas_list(self, aas_file, *args, capture=False, **kwargs):
         """Retrieve a list of submodel templates contained within the provided Asset Administration Shell (AAS) file.
 
         param aas_file: path to the AAS file (*.aasx, *.xml, *.json)
@@ -447,9 +464,16 @@ 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(SAMMCLICommands.AAS_LIST, aas_file, *args, command_type=SAMMCLICommandTypes.AAS, **kwargs)
+        return self._call_function(
+            SAMMCLICommands.AAS_LIST,
+            aas_file,
+            *args,
+            command_type=SAMMCLICommandTypes.AAS,
+            capture=capture,
+            **kwargs,
+        )
 
-    def package_import(self, namespace_package, *args, **kwargs):
+    def package_import(self, namespace_package, *args, capture=False, **kwargs):
         """Imports a Namespace Package (file or URL) into a given models' directory.
 
         param namespace_package: path to the namespace package file (.zip) or URL
@@ -474,11 +498,16 @@ def package_import(self, namespace_package, *args, **kwargs):
             # Force import
             samm_cli.package_import("MyPackage.zip", "force", models_root="c:\\models")
         """
-        self._call_function(
-            SAMMCLICommands.PACKAGE_IMPORT, namespace_package, *args, command_type=SAMMCLICommandTypes.PACKAGE, **kwargs
+        return self._call_function(
+            SAMMCLICommands.PACKAGE_IMPORT,
+            namespace_package,
+            *args,
+            command_type=SAMMCLICommandTypes.PACKAGE,
+            capture=capture,
+            **kwargs,
         )
 
-    def package_export(self, model_or_urn, *args, **kwargs):
+    def package_export(self, model_or_urn, *args, capture=False, **kwargs):
         """Exports an Aspect Model with its dependencies or a complete namespace to a Namespace Package (.zip).
 
         param model_or_urn: path to aspect model file (*.ttl) or namespace URN
@@ -503,6 +532,11 @@ 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(
-            SAMMCLICommands.PACKAGE_EXPORT, model_or_urn, *args, command_type=SAMMCLICommandTypes.PACKAGE, **kwargs
+        return self._call_function(
+            SAMMCLICommands.PACKAGE_EXPORT,
+            model_or_urn,
+            *args,
+            command_type=SAMMCLICommandTypes.PACKAGE,
+            capture=capture,
+            **kwargs,
         )

…ython/tests/integration/cli_functions.py …/tests/integration/test_cli_functions.pycore/esmf-aspect-meta-model-python/tests/integration/cli_functions.py renamed to core/esmf-aspect-meta-model-python/tests/integration/test_cli_functions.py core/esmf-aspect-meta-model-python/tests/integration/cli_functions.py renamed to core/esmf-aspect-meta-model-python/tests/integration/test_cli_functions.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
@@ -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."""