MTPPy2.0 0.1.5__py3-none-any.whl

mtppy/part4/automation_services/service_elements/parameter_elements/parameter_element_test.py

@@ -0,0 +1,246 @@
+"""Test suite for ParameterElement."""
+
+import pytest
+
+from mtppy.part4.automation_services.base_functions.service_operation_mode import (
+    ServiceOperationMode,
+)
+from mtppy.part4.automation_services.base_functions.service_source_mode import (
+    ServiceSourceMode,
+)
+from mtppy.part4.automation_services.service_elements.parameter_elements.common_serv_param import (
+    SERVICE_PARAM_BASE_DATA_ITEMS,
+)
+from mtppy.part4.automation_services.service_elements.parameter_elements.parameter_element import (
+    ParameterElement,
+)
+from mtppy.part5.definitions.w3c_xml_data_types import W3cXmlDataTypes
+
+
+class TestParameterElement(ParameterElement):
+    CLASS_DATA_ITEMS = (
+        ParameterElement.CLASS_DATA_ITEMS
+        | SERVICE_PARAM_BASE_DATA_ITEMS(W3cXmlDataTypes.STRING)
+    )
+
+
+def create_parameter():
+    return TestParameterElement("TestParameter", "Test description")
+
+
+def test_initialization():
+    parameter = create_parameter()
+
+    assert parameter.tag_name == "TestParameter"
+    assert parameter.tag_description == "Test description"
+    assert parameter.mtpObjectType.endswith("ParameterElement")
+    assert parameter[ParameterElement.APPLY_EN] is True
+    assert parameter[ParameterElement.APPLY_EXT] is False
+    assert parameter[ParameterElement.APPLY_OP] is False
+    assert parameter[ParameterElement.APPLY_INT] is False
+    assert parameter[ParameterElement.SYNC_] is False
+
+
+def test_set_apply_en_and_sync():
+    parameter = create_parameter()
+
+    parameter.set_apply_en(False)
+    parameter.set_sync(True)
+
+    assert parameter[ParameterElement.APPLY_EN] is False
+    assert parameter[ParameterElement.SYNC_] is True
+
+
+@pytest.mark.parametrize(
+    ("method_name", "operation_mode", "source_mode"),
+    [
+        (
+            "apply_op",
+            ServiceOperationMode.STATE_OP_ACT,
+            None,
+        ),
+        (
+            "apply_int",
+            ServiceOperationMode.STATE_AUT_ACT,
+            ServiceSourceMode.SRC_INT_ACT,
+        ),
+        (
+            "apply_ext",
+            ServiceOperationMode.STATE_AUT_ACT,
+            ServiceSourceMode.SRC_EXT_ACT,
+        ),
+    ],
+)
+def test_apply_callbacks_update_when_mode_matches(
+    monkeypatch, method_name, operation_mode, source_mode
+):
+    parameter = create_parameter()
+    update_calls = []
+    monkeypatch.setattr(parameter, "update_v_out", lambda: update_calls.append(True))
+    parameter.service_op_mode[operation_mode] = True
+    if source_mode is not None:
+        parameter.service_src_mode[source_mode] = True
+
+    getattr(parameter, method_name)(True)
+
+    assert update_calls == [True]
+    apply_item = {
+        "apply_op": ParameterElement.APPLY_OP,
+        "apply_int": ParameterElement.APPLY_INT,
+        "apply_ext": ParameterElement.APPLY_EXT,
+    }[method_name]
+    assert parameter[apply_item] is False
+
+
+@pytest.mark.parametrize(
+    ("method_name", "operation_mode", "source_mode"),
+    [
+        ("apply_op", ServiceOperationMode.STATE_OP_ACT, None),
+        (
+            "apply_int",
+            ServiceOperationMode.STATE_AUT_ACT,
+            ServiceSourceMode.SRC_INT_ACT,
+        ),
+        (
+            "apply_ext",
+            ServiceOperationMode.STATE_AUT_ACT,
+            ServiceSourceMode.SRC_EXT_ACT,
+        ),
+    ],
+)
+def test_apply_callbacks_reset_without_matching_request(
+    monkeypatch, method_name, operation_mode, source_mode
+):
+    parameter = create_parameter()
+    update_calls = []
+    monkeypatch.setattr(parameter, "update_v_out", lambda: update_calls.append(True))
+    parameter.service_op_mode[operation_mode] = False
+    if source_mode is not None:
+        parameter.service_src_mode[source_mode] = False
+
+    getattr(parameter, method_name)(False)
+
+    assert update_calls == []
+    assert (
+        parameter[
+            {
+                "apply_op": ParameterElement.APPLY_OP,
+                "apply_int": ParameterElement.APPLY_INT,
+                "apply_ext": ParameterElement.APPLY_EXT,
+            }[method_name]
+        ]
+        is False
+    )
+
+
+def test_update_v_req_prefers_operator_mode():
+    parameter = create_parameter()
+    parameter["VOp"] = "operator"
+    parameter["VInt"] = "internal"
+    parameter["VExt"] = "external"
+    parameter.service_op_mode[ServiceOperationMode.STATE_OP_ACT] = True
+    parameter.service_op_mode[ServiceOperationMode.STATE_AUT_ACT] = True
+    parameter.service_src_mode[ServiceSourceMode.SRC_INT_ACT] = True
+    parameter.service_src_mode[ServiceSourceMode.SRC_EXT_ACT] = True
+
+    parameter.update_v_req()
+
+    assert parameter["VReq"] == "operator"
+    assert parameter["VFbk"] == "operator"
+
+
+@pytest.mark.parametrize(
+    ("source_mode", "expected"),
+    [
+        (ServiceSourceMode.SRC_INT_ACT, "internal"),
+        (ServiceSourceMode.SRC_EXT_ACT, "external"),
+    ],
+)
+def test_update_v_req_uses_active_automatic_source(source_mode, expected):
+    parameter = create_parameter()
+    parameter["VInt"] = "internal"
+    parameter["VExt"] = "external"
+    parameter.service_op_mode[ServiceOperationMode.STATE_AUT_ACT] = True
+    parameter.service_src_mode[source_mode] = True
+
+    parameter.update_v_req()
+
+    assert parameter["VReq"] == expected
+    assert parameter["VFbk"] == expected
+
+
+def test_update_v_out_and_get_v_out():
+    parameter = create_parameter()
+    parameter["VOp"] = "requested"
+    parameter.service_op_mode[ServiceOperationMode.STATE_OP_ACT] = True
+
+    parameter.update_v_out()
+
+    assert parameter.get_v_out() == "requested"
+
+
+def test_update_v_req_without_active_mode_only_updates_feedback():
+    parameter = create_parameter()
+    parameter["VReq"] = "unchanged"
+
+    parameter.update_v_req()
+
+    assert parameter["VReq"] == "unchanged"
+    assert parameter["VFbk"] == "unchanged"
+
+
+def test_set_v_fbk_updates_feedback_value():
+    parameter = create_parameter()
+
+    parameter.set_v_fbk("feedback")
+
+    assert parameter["VFbk"] == "feedback"
+
+
+@pytest.mark.parametrize(
+    ("method_name", "value", "apply_item"),
+    [
+        ("apply_op", False, ParameterElement.APPLY_OP),
+        ("apply_int", False, ParameterElement.APPLY_INT),
+        ("apply_ext", False, ParameterElement.APPLY_EXT),
+    ],
+)
+def test_apply_callbacks_reset_false_requests(method_name, value, apply_item):
+    parameter = create_parameter()
+
+    getattr(parameter, method_name)(value)
+
+    assert parameter[apply_item] is False
+
+
+@pytest.mark.parametrize("method_name", ["set_v_op", "set_v_int", "set_v_ext"])
+def test_set_values_ignores_invalid_values(monkeypatch, method_name):
+    parameter = create_parameter()
+    monkeypatch.setattr(parameter, "is_valid_value", lambda value: False)
+    value_item = {
+        "set_v_op": "VOp",
+        "set_v_int": "VInt",
+        "set_v_ext": "VExt",
+    }[method_name]
+    initial_values = {
+        "set_v_op": parameter["VOp"],
+        "set_v_int": parameter["VInt"],
+        "set_v_ext": parameter["VExt"],
+    }
+
+    getattr(parameter, method_name)("invalid")
+
+    assert parameter[value_item] == initial_values[method_name]
+
+
+def test_set_values_and_default_validation():
+    parameter = create_parameter()
+
+    parameter.set_v_op("operator")
+    parameter.set_v_int("internal")
+    parameter.set_v_ext("external")
+
+    assert parameter["VOp"] == "operator"
+    assert parameter["VInt"] == "internal"
+    assert parameter["VExt"] == "external"
+    assert parameter.is_valid_value(object()) is True

mtppy/part4/automation_services/service_elements/parameter_elements/string_serv_param.py

@@ -0,0 +1,48 @@
+"""Implementation of the String Service Parameter."""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+
+from typing import ClassVar
+
+from mtppy.part5.definitions.w3c_xml_data_types import W3cXmlDataTypes
+from mtppy.part4.automation_services.service_elements.parameter_elements.common_serv_param import (
+    SERVICE_PARAM_BASE_DATA_ITEMS,
+    CommonServParameter,
+)
+from mtppy.part4.automation_services.service_elements.parameter_elements.parameter_element import ParameterElement
+
+
+class StringServParam(ParameterElement):
+    """String Service Parameter implementation.
+
+    This class implements string service parameters for service elements. It
+    inherits from ParameterElement and provides string-specific functionality
+    for parameter handling with appropriate data types.
+
+    """
+
+    CLASS_DATA_ITEMS: ClassVar = SERVICE_PARAM_BASE_DATA_ITEMS(W3cXmlDataTypes.STRING)
+
+    def __init__(self, tag_name: str, tag_description: str = "") -> None:
+        """Initialize String Service Parameter (StringServParam).
+
+        Args:
+            tag_name: The name identifier for the parameter element
+            tag_description: A descriptive text for the parameter element
+        """
+        super().__init__(tag_name, tag_description)
+        self.mtpObjectType = "MTPDataAssemblySUCLib/DataAssembly/ServiceElement/\
+            ParameterElement/StringServParam"
+
+        self.get_item(CommonServParameter.V_OP).init_value = ""
+        self.get_item(CommonServParameter.V_INT).init_value = ""
+        self.get_item(CommonServParameter.V_EXT).init_value = ""
+        self.get_item(CommonServParameter.V_REQ).init_value = ""
+        self.get_item(CommonServParameter.V_OUT).init_value = ""
+        self.get_item(CommonServParameter.V_FBK).init_value = ""
+
+        self.get_item(CommonServParameter.V_OP).ext_wrt_cb = self.set_v_op
+        self.get_item(CommonServParameter.V_EXT).ext_wrt_cb = self.set_v_ext

mtppy/part4/automation_services/service_elements/parameter_elements/string_serv_param_test.py

@@ -0,0 +1,37 @@
+"""Test suite for StringServParam."""
+
+from mtppy.part4.automation_services.service_elements.parameter_elements.common_serv_param import (
+    CommonServParameter as CSP,
+)
+from mtppy.part4.automation_services.service_elements.parameter_elements.string_serv_param import (
+    StringServParam,
+)
+
+
+def test_initialization_sets_string_values_to_empty():
+    parameter = StringServParam("RecipeName", "Recipe name")
+
+    assert parameter.tag_name == "RecipeName"
+    assert parameter.tag_description == "Recipe name"
+    assert parameter.get_item(CSP.V_OP).init_value == ""
+    assert parameter.get_item(CSP.V_INT).init_value == ""
+    assert parameter.get_item(CSP.V_EXT).init_value == ""
+    assert parameter.get_item(CSP.V_REQ).init_value == ""
+    assert parameter.get_item(CSP.V_OUT).init_value == ""
+    assert parameter.get_item(CSP.V_FBK).init_value == ""
+
+
+def test_set_v_op_accepts_string_value():
+    parameter = StringServParam("RecipeName")
+
+    parameter.set_v_op("Recipe A")
+
+    assert parameter[CSP.V_OP] == "Recipe A"
+
+
+def test_set_v_ext_accepts_string_value():
+    parameter = StringServParam("RecipeName")
+
+    parameter.set_v_ext("Recipe B")
+
+    assert parameter[CSP.V_EXT] == "Recipe B"

mtppy/part4/automation_services/service_elements/procedure_health_view.py

@@ -0,0 +1,36 @@
+"""View on procedure health."""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+
+from mtppy.utils.data_item import DataItem
+from mtppy.part3.definitions.mtp_access import MTPAccess
+from mtppy.part5.definitions.w3c_xml_data_types import W3cXmlDataTypes
+from mtppy.part4.automation_services.service_elements.service_element import ServiceElement
+from typing import ClassVar
+
+
+class ProcedureHealthView(ServiceElement):
+    # DataItem constant definitions
+    COMMAND_INFO = "CommandInfo"
+
+    # Class-level data items dictionary
+    CLASS_DATA_ITEMS: ClassVar = {
+        COMMAND_INFO: DataItem(
+            COMMAND_INFO, W3cXmlDataTypes.UNSIGNED_SHORT, MTPAccess.ReadAccess, 0
+        ),
+    }
+
+    def __init__(self, tag_name: str, tag_description: str):
+        super().__init__(tag_name, tag_description)
+        self.mtpObjectType = (
+            "MTPDataAssemblySUCLib/DataAssembly/ServiceElement/ProcedureHealthView"
+        )
+
+        # Initialize data items with dynamic values (using class-defined data items)
+        self[ProcedureHealthView.COMMAND_INFO] = 0
+
+    def set_command_info(self, value):
+        self[ProcedureHealthView.COMMAND_INFO] = value