Merge pull request #45 from thec0dewriter/#43-state-initiator-implementation

#43 state initiator implementation

Author: atextor

core/esmf-aspect-meta-model-python/esmf_aspect_meta_model_python/loader/instantiator/state_instantiator.py

@@ -0,0 +1,86 @@
+#  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
+
+from typing import Any, Dict, Optional
+
+import rdflib  # type: ignore
+
+from rdflib.term import Node
+
+from esmf_aspect_meta_model_python.base.characteristics.state import State
+from esmf_aspect_meta_model_python.impl.characteristics.default_state import DefaultState
+from esmf_aspect_meta_model_python.loader.instantiator.constants import DATA_TYPE_ERROR_MSG
+from esmf_aspect_meta_model_python.loader.instantiator.enumeration_instantiator import EnumerationInstantiator
+from esmf_aspect_meta_model_python.loader.rdf_helper import RdfHelper
+from esmf_aspect_meta_model_python.vocabulary.SAMM import SAMM
+from esmf_aspect_meta_model_python.vocabulary.SAMMC import SAMMC
+
+
+class StateInstantiator(EnumerationInstantiator):
+    def _create_instance(self, element_node: Node) -> State:
+        data_type = self._get_data_type(element_node)
+        if data_type is None:
+            raise TypeError(DATA_TYPE_ERROR_MSG)
+
+        meta_model_base_attributes = self._get_base_attributes(element_node)
+        value_collection_node = self._aspect_graph.value(
+            subject=element_node,
+            predicate=self._sammc.get_urn(SAMMC.values),
+        )
+        value_nodes = RdfHelper.get_rdf_list_values(value_collection_node, self._aspect_graph)
+        values = [self.__to_state_node_value(value_node) for value_node in value_nodes]
+
+        defaultValue = self._aspect_graph.value(
+            subject=element_node,
+            predicate=self._sammc.get_urn(SAMMC.default_value),
+        )
+        default = self.__to_state_node_value(defaultValue)
+
+        return DefaultState(meta_model_base_attributes, data_type, values, default)
+
+    def __to_state_node_value(self, value_node: Optional[Node]) -> Dict:
+        """
+        This method instantiates one possible value of a state.
+        :param value_node:  Node of the Graph that represents one state value.
+        The Argument can either be a Literal or a URIRef.
+        - If value_node is a Literal it will represent e.g. a string or an integer value
+        - If value_node is a URIRef it will represent a value of a ComplexType
+        :return: the one generated value of the state
+        """
+        if isinstance(value_node, rdflib.Literal):
+            # value represents a simple data type
+            return value_node.toPython()
+
+        elif isinstance(value_node, rdflib.URIRef):
+            # value represents a complex data type
+            value = {}
+            value_node_properties = self._aspect_graph.predicate_objects(value_node)
+            for property_urn, property_value in value_node_properties:
+                if property_urn != rdflib.RDF.type and isinstance(property_urn, str):
+                    property_name = property_urn.split("#")[1]
+                    actual_value: Optional[Any]
+                    if self.__is_collection_value(property_urn):
+                        actual_value = self.__instantiate_enum_collection(property_value)
+                    else:
+                        actual_value = self.__to_state_node_value(property_value)
+                    value[property_name] = actual_value
+
+            value_node_name = value_node.split("#")[1]
+            value_key = self._samm.get_urn(SAMM.name).toPython()
+            value[value_key] = value_node_name  # type: ignore
+            return value
+
+        else:
+            # illegal node type for state value (e.g., Blank Node)
+            raise TypeError(
+                f"Every value of an state must either be a Literal (string, int, etc.) or "
+                f"a URI reference to a ComplexType. Values of type {type(value_node).__name__} are not allowed"
+            )

core/esmf-aspect-meta-model-python/tests/integration/resources/org.eclipse.esmf.test.characteristics/2.0.0/AspectWithState.ttl

@@ -0,0 +1,34 @@
+# 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
+
+@prefix : <urn:samm:org.eclipse.esmf.test.characteristics:2.0.0#> .
+@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.0.0#> .
+@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.0.0#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.0.0#> .
+
+:TestAspect a samm:Aspect ;
+   samm:preferredName "Test Aspect"@en ;
+   samm:preferredName "Test Aspekt"@de ;
+   samm:description "This is a test description"@en ;
+   samm:see <https://eclipse-esmf.github.io> ;
+   samm:properties ( :testPropertyOne ) ;
+   samm:operations ( ) .
+
+:testPropertyOne a samm:Property ;
+   samm:characteristic [
+      a samm-c:State ;
+      samm:preferredName "Test State"@en ;
+      samm:description "This is a test state."@en ;
+      samm:dataType xsd:string ;
+      samm-c:values ( "default" "good" "bad" ) ;
+      samm-c:defaultValue "default"
+   ] .

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

@@ -21,7 +21,8 @@
     Enumeration,
     Measurement,
     Quantifiable,
-    StructuredValue,
+    State,
+    StructuredValue
 )
 
 RESOURCE_PATH = getcwd() / Path("tests/integration/resources/org.eclipse.esmf.test.characteristics/2.0.0")
@@ -116,6 +117,27 @@ def test_loading_aspect_with_simple_enum():
     assert "baz" in values
 
 
+def test_loading_aspect_with_simple_state():
+    print(RESOURCE_PATH)
+    file_path = RESOURCE_PATH / "AspectWithState.ttl"
+    aspect_loader = AspectLoader()
+    model_elements = aspect_loader.load_aspect_model(file_path)
+    aspect = model_elements[0]
+
+    first_property = aspect.properties[0]
+    state_characteristic = first_property.characteristic
+    assert isinstance(state_characteristic, State)
+    assert state_characteristic.name == "testPropertyOne_characteristic"
+
+    values = state_characteristic.values
+    assert len(values) == 3
+    assert "default" in values
+    assert "good" in values
+    assert "bad" in values
+    default = state_characteristic.default_value
+    assert default == "default"
+
+
 def test_loading_aspect_with_quantifiable():
     file_path = RESOURCE_PATH / "AspectWithQuantifiableAndUnit.ttl"
     aspect_loader = AspectLoader()