Updating MeasurementService __init__ to parse .serviceconfig. (#219)

DelpireNI · web-flow · commit 3a5d00202913 · 2023-02-01T14:11:54.000-06:00
* Updating MeasurementService __init__ to parse .serviceconfig.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing some issues raised by build.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing more style issues.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Adding service_class optional parameter and other small fixes.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing issue and using loopless approach.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Running styleguide fix.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Replacing List[str] with List[Path]

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Importing Path from pathlib. Trying to fix build errors.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Using filter.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Removing filter.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Updating the rest of the examples.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Updating testassets example.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Updating mako template.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing build issues.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing variable name.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Renaming variable from parent_directory to service_directory

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Change serviceconfig path paramter from str to Path.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing tests.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing style issues and warnings.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Making assets variable name make sense.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Fixing example render to match expected result from test.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

* Adding back extra newline to template.

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;

---------

Signed-off-by: Chris Delpire &lt;chris.delpire@ni.com&gt;
diff --git a/examples/nidaqmx_analog_input/measurement.py b/examples/nidaqmx_analog_input/measurement.py
@@ -9,19 +9,13 @@
 
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="NI-DAQmx Analog Input (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "NIDAQmxAnalogInput.serviceconfig",
     version="0.1.0.0",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "NIDAQmxAnalogInput.measui"],
+    ui_file_paths=[service_directory / "NIDAQmxAnalogInput.measui"],
 )
 
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.NIDAQmxAnalogInput_Python",
-    description_url="",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
-
 
 @measurement_service.register_measurement
 @measurement_service.configuration("physical_channel", nims.DataType.String, "Dev1/ai0")
diff --git a/examples/nidcpower_source_dc_voltage/measurement.py b/examples/nidcpower_source_dc_voltage/measurement.py
@@ -19,21 +19,15 @@
 NIDCPOWER_WAIT_FOR_EVENT_TIMEOUT_ERROR_CODE = -1074116059
 NIDCPOWER_TIMEOUT_EXCEEDED_ERROR_CODE = -1074097933
 
-measurement_info = nims.MeasurementInfo(
-    display_name="NI-DCPower Source DC Voltage (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "NIDCPowerSourceDCVoltage.serviceconfig",
     version="0.1.0.0",
     ui_file_paths=[
-        pathlib.Path(__file__).resolve().parent / "NIDCPowerSourceDCVoltage.measui",
-        pathlib.Path(__file__).resolve().parent / "NIDCPowerSourceDCVoltageUI.vi",
+        service_directory / "NIDCPowerSourceDCVoltage.measui",
+        service_directory / "NIDCPowerSourceDCVoltageUI.vi",
     ],
 )
-
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.NIDCPowerSourceDCVoltage_Python",
-    description_url="",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
 service_options = ServiceOptions()
 
 
diff --git a/examples/nidmm_measurement/measurement.py b/examples/nidmm_measurement/measurement.py
@@ -14,18 +14,12 @@
 
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="NI-DMM Measurement (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "NIDmmMeasurement.serviceconfig",
     version="0.1.0.0",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "NIDmmMeasurement.measui"],
+    ui_file_paths=[service_directory / "NIDmmMeasurement.measui"],
 )
-
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.NIDmmMeasurement_Python",
-    description_url="",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
 service_options = ServiceOptions()
 
 FUNCTION_TO_ENUM = {
diff --git a/examples/nifgen_standard_function/measurement.py b/examples/nifgen_standard_function/measurement.py
@@ -18,18 +18,12 @@
 NIFGEN_OPERATION_TIMED_OUT_ERROR_CODE = -1074098044
 NIFGEN_MAX_TIME_EXCEEDED_ERROR_CODE = -1074118637
 
-measurement_info = nims.MeasurementInfo(
-    display_name="NI-FGEN Standard Function (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "NIFgenStandardFunction.serviceconfig",
     version="0.1.0.0",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "NIFgenStandardFunction.measui"],
+    ui_file_paths=[service_directory / "NIFgenStandardFunction.measui"],
 )
-
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.NIFgenStandardFunction_Python",
-    description_url="",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
 service_options = ServiceOptions()
 
 WAVEFORM_TYPE_TO_ENUM = {
diff --git a/examples/niscope_acquire_waveform/measurement.py b/examples/niscope_acquire_waveform/measurement.py
@@ -14,18 +14,12 @@
 
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="NI-SCOPE Acquire Waveform (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "NIScopeAcquireWaveform.serviceconfig",
     version="0.1.0.0",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "NIScopeAcquireWaveform.measui"],
+    ui_file_paths=[service_directory / "NIScopeAcquireWaveform.measui"],
 )
-
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.NIScopeAcquireWaveform_Python",
-    description_url="",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
 service_options = ServiceOptions()
 
 VERTICAL_COUPLING_TO_ENUM = {
diff --git a/examples/niswitch_control_relays/measurement.py b/examples/niswitch_control_relays/measurement.py
@@ -12,18 +12,12 @@
 
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="NI-SWITCH Control Relays (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "NISwitchControlRelays.serviceconfig",
     version="0.1.0.0",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "NISwitchControlRelays.measui"],
+    ui_file_paths=[service_directory / "NISwitchControlRelays.measui"],
 )
-
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.NISwitchControlRelays_Python",
-    description_url="",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
 service_options = ServiceOptions()
 
 
diff --git a/examples/nivisa_dmm_measurement/measurement.py b/examples/nivisa_dmm_measurement/measurement.py
@@ -20,18 +20,12 @@
 
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="NI-VISA DMM Measurement (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "NIVisaDmmMeasurement.serviceconfig",
     version="0.1.0.0",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "NIVisaDmmMeasurement.measui"],
+    ui_file_paths=[service_directory / "NIVisaDmmMeasurement.measui"],
 )
-
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.NIVisaDmmMeasurement_Python",
-    description_url="",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
 service_options = ServiceOptions()
 
 
diff --git a/examples/sample_measurement/measurement.py b/examples/sample_measurement/measurement.py
@@ -7,23 +7,17 @@
 
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="Sample Measurement (Py)",
+service_directory = pathlib.Path(__file__).resolve().parent
+sample_measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "SampleMeasurement.serviceconfig",
     version="0.1.0.0",
     ui_file_paths=[
-        pathlib.Path(__file__).resolve().parent / "SampleMeasurement.measui",
-        pathlib.Path(__file__).resolve().parent / "SampleAllParameters.measui",
-        pathlib.Path(__file__).resolve().parent / "SampleMeasurement.vi",
+        service_directory / "SampleMeasurement.measui",
+        service_directory / "SampleAllParameters.measui",
+        service_directory / "SampleMeasurement.vi",
     ],
 )
 
-service_info = nims.ServiceInfo(
-    service_class="ni.examples.SampleMeasurement_Python",
-    description_url="",
-)
-
-sample_measurement_service = nims.MeasurementService(measurement_info, service_info)
-
 
 @sample_measurement_service.register_measurement
 @sample_measurement_service.configuration("Float In", nims.DataType.Float, 0.06)
diff --git a/ni_measurementlink_generator/ni_measurementlink_generator/templates/measurement.py.mako b/ni_measurementlink_generator/ni_measurementlink_generator/templates/measurement.py.mako
@@ -8,19 +8,13 @@ import sys
 import click
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="${display_name}",
-    version="${version}",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "${ui_file}"],
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "${display_name}.serviceconfig",
+    version="0.1.0.0",
+    ui_file_paths=[service_directory / "${ui_file}"],
 )
 
-service_info = nims.ServiceInfo(
-    service_class="${service_class}",
-    description_url="${description_url}",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
-
 
 @measurement_service.register_measurement
 @measurement_service.configuration("Array in", nims.DataType.DoubleArray1D, [0.0])
diff --git a/ni_measurementlink_generator/tests/test_assets/example_renders/example.py b/ni_measurementlink_generator/tests/test_assets/example_renders/example.py
@@ -6,19 +6,13 @@
 import click
 import ni_measurementlink_service as nims
 
-measurement_info = nims.MeasurementInfo(
-    display_name="SampleMeasurement",
-    version="1.0.0.0",
-    ui_file_paths=[pathlib.Path(__file__).resolve().parent / "MeasurementUI.measui"],
+service_directory = pathlib.Path(__file__).resolve().parent
+measurement_service = nims.MeasurementService(
+    service_config_path=service_directory / "SampleMeasurement.serviceconfig",
+    version="0.1.0.0",
+    ui_file_paths=[service_directory / "MeasurementUI.measui"],
 )
 
-service_info = nims.ServiceInfo(
-    service_class="SampleMeasurement_Python",
-    description_url="https://www.example.com/SampleMeasurement.html",
-)
-
-measurement_service = nims.MeasurementService(measurement_info, service_info)
-
 
 @measurement_service.register_measurement
 @measurement_service.configuration("Array in", nims.DataType.DoubleArray1D, [0.0])
diff --git a/ni_measurementlink_service/measurement/service.py b/ni_measurementlink_service/measurement/service.py
@@ -2,8 +2,11 @@
 
 from __future__ import annotations
 
+import json
+from os import path
+from pathlib import Path
 from threading import Lock
-from typing import Any, Callable, Dict, TypeVar
+from typing import Any, Callable, Dict, TypeVar, List
 
 import grpc
 
@@ -128,18 +131,59 @@ class MeasurementService:
 
     """
 
-    def __init__(self, measurement_info: MeasurementInfo, service_info: ServiceInfo) -> None:
-        """Initialize the Measurement Service object with measurement info and service info.
+    def __init__(
+        self,
+        service_config_path: Path,
+        version: str,
+        ui_file_paths: List[Path],
+        service_class: str = None,
+    ) -> None:
+        """Initialize the Measurement Service object.
+
+        Uses the specified .serviceconfig file, version, and UI file paths
+        to initialize a Measurement Service object.
 
         Args:
         ----
-            measurement_info (MeasurementInfo): Measurement Info
+            service_config_path (Path): Path to the .serviceconfig file.
+
+            version (str): Version of the measurement service.
 
-            service_info (ServiceInfo): Service Info
+            ui_file_paths (List[Path]): List of paths to supported UIs.
+
+            service_class (str): The service class from the .serviceconfig to use.
+            Default value is None, which will use the first service in the
+            .serviceconfig file.
 
         """
-        self.measurement_info: MeasurementInfo = measurement_info
-        self.service_info: ServiceInfo = service_info
+        if not path.exists(service_config_path):
+            raise RuntimeError(f"File does not exist. {service_config_path}")
+
+        with open(service_config_path) as service_config_file:
+            service_config = json.load(service_config_file)
+
+        if service_class is None:
+            service = next(iter(service_config["services"]), None)
+        else:
+            service = next(
+                (s for s in service_config["services"] if s["serviceClass"] == service_class), None
+            )
+        if not service:
+            raise RuntimeError(
+                f"Service class '{service_class}' not found in '{service_config_file}'"
+            )
+
+        self.measurement_info = MeasurementInfo(
+            display_name=service["displayName"],
+            version=version,
+            ui_file_paths=ui_file_paths,
+        )
+
+        self.service_info = ServiceInfo(
+            service_class=service["serviceClass"],
+            description_url=service["descriptionUrl"],
+        )
+
         self.configuration_parameter_list: list = []
         self.output_parameter_list: list = []
         self.grpc_service = GrpcService()
diff --git a/tests/assets/example.serviceconfig b/tests/assets/example.serviceconfig
@@ -0,0 +1,11 @@
+{
+  "services": [
+    {
+      "displayName": "SampleMeasurement",
+      "serviceClass": "SampleMeasurement_Python",
+      "descriptionUrl": "https://www.example.com/SampleMeasurement.html",
+      "providedInterfaces": [ "ni.measurementlink.measurement.v1.MeasurementService" ],
+      "path": "start.bat"
+    }
+  ]
+}
diff --git a/tests/integration/test_service_manager.py b/tests/integration/test_service_manager.py
@@ -20,8 +20,8 @@
 def test___grpc_service___start_service___service_hosted(grpc_service: GrpcService):
     """Test to validate if measurement service is started."""
     port_number = grpc_service.start(
-        measurement.measurement_info,
-        measurement.service_info,
+        measurement.sample_measurement_service.measurement_info,
+        measurement.sample_measurement_service.service_info,
         measurement.sample_measurement_service.configuration_parameter_list,
         measurement.sample_measurement_service.output_parameter_list,
         measurement.sample_measurement_service.measure_function,
@@ -35,8 +35,8 @@ def test___grpc_service_without_discovery_service___start_service___service_host
 ):
     """Test to validate if measurement service start when the discovery service not available."""
     port_number = grpc_service.start(
-        measurement.measurement_info,
-        measurement.service_info,
+        measurement.sample_measurement_service.measurement_info,
+        measurement.sample_measurement_service.service_info,
         measurement.sample_measurement_service.configuration_parameter_list,
         measurement.sample_measurement_service.output_parameter_list,
         measurement.sample_measurement_service.measure_function,
@@ -48,8 +48,8 @@ def test___grpc_service_without_discovery_service___start_service___service_host
 def test___grpc_service_started___stop_service___service_stopped(grpc_service: GrpcService):
     """Test to validate if measurement service is stopped."""
     port_number = grpc_service.start(
-        measurement.measurement_info,
-        measurement.service_info,
+        measurement.sample_measurement_service.measurement_info,
+        measurement.sample_measurement_service.service_info,
         measurement.sample_measurement_service.configuration_parameter_list,
         measurement.sample_measurement_service.output_parameter_list,
         measurement.sample_measurement_service.measure_function,
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
