generator: Use correct serviceconfig filename, display name, and version number (#233)

* generator tests: Rename example renders to match expected outputs

Signed-off-by: Brad Keryan <brad.keryan@ni.com>

* generator: Fix whitespace handling for serviceconfig file name

Signed-off-by: Brad Keryan <brad.keryan@ni.com>

* generator: Use correct version number

---------

Signed-off-by: Brad Keryan <brad.keryan@ni.com>

Author: bkeryan

ni_measurementlink_generator/ni_measurementlink_generator/template.py

@@ -113,6 +113,7 @@ def create_measurement(
     display_name_for_filenames = re.sub(r"\s+", "", display_name)
     ui_file = _resolve_ui_file(ui_file, display_name_for_filenames)
     ui_file_type = _get_ui_type(ui_file)
+    serviceconfig_file = f"{display_name_for_filenames}.serviceconfig"
     if directory_out is None:
         directory_out = pathlib.Path.cwd() / display_name_for_filenames
     else:
@@ -130,10 +131,11 @@ def create_measurement(
         ui_file_type=ui_file_type,
         service_class=service_class,
         description_url=description_url,
+        serviceconfig_file=serviceconfig_file,
     )
     _create_file(
         "measurement.serviceconfig.mako",
-        f"{display_name_for_filenames}.serviceconfig",
+        serviceconfig_file,
         directory_out,
         display_name=display_name,
         service_class=service_class,
@@ -143,7 +145,7 @@ def create_measurement(
     if ui_file_type == "MeasurementUI":
         _create_file(
             "measurement.measui.mako",
-            f"{ui_file}",
+            ui_file,
             directory_out,
             display_name=display_name,
             service_class=service_class,

ni_measurementlink_generator/ni_measurementlink_generator/templates/measurement.py.mako

@@ -1,4 +1,4 @@
-<%page args="display_name, version, ui_file, ui_file_type, service_class, description_url"/>\
+<%page args="display_name, version, ui_file, ui_file_type, service_class, description_url, serviceconfig_file"/>\
 \
 """A default measurement with an array in and out."""
 import logging
@@ -10,8 +10,8 @@ import ni_measurementlink_service as nims
 
 service_directory = pathlib.Path(__file__).resolve().parent
 measurement_service = nims.MeasurementService(
-    service_config_path=service_directory / "${display_name}.serviceconfig",
-    version="0.1.0.0",
+    service_config_path=service_directory / "${serviceconfig_file}",
+    version="${version}",
     ui_file_paths=[service_directory / "${ui_file}"],
 )
 
@@ -33,7 +33,7 @@ def measure(array_input):
     help="Enable verbose logging. Repeat to increase verbosity.",
 )
 def main(verbose: int):
-    """Host the Sample Measurement service."""
+    """Host the ${display_name} service."""
     if verbose > 1:
         level = logging.DEBUG
     elif verbose == 1:

…ts/example_renders/example.serviceconfig …_renders/SampleMeasurement.serviceconfigni_measurementlink_generator/tests/test_assets/example_renders/example.serviceconfig renamed to ni_measurementlink_generator/tests/test_assets/example_renders/SampleMeasurement.serviceconfig ni_measurementlink_generator/tests/test_assets/example_renders/example.serviceconfig renamed to ni_measurementlink_generator/tests/test_assets/example_renders/SampleMeasurement.serviceconfig

@@ -1,7 +1,7 @@
 {
   "services": [
     {
-      "displayName": "SampleMeasurement",
+      "displayName": "Sample Measurement",
       "serviceClass": "SampleMeasurement_Python",
       "descriptionUrl": "https://www.example.com/SampleMeasurement.html",
       "providedInterfaces": [ "ni.measurementlink.measurement.v1.MeasurementService" ],

…s/test_assets/example_renders/example.py …st_assets/example_renders/measurement.pyni_measurementlink_generator/tests/test_assets/example_renders/example.py renamed to ni_measurementlink_generator/tests/test_assets/example_renders/measurement.py ni_measurementlink_generator/tests/test_assets/example_renders/example.py renamed to ni_measurementlink_generator/tests/test_assets/example_renders/measurement.py

@@ -9,7 +9,7 @@
 service_directory = pathlib.Path(__file__).resolve().parent
 measurement_service = nims.MeasurementService(
     service_config_path=service_directory / "SampleMeasurement.serviceconfig",
-    version="0.1.0.0",
+    version="1.2.3.4",
     ui_file_paths=[service_directory / "MeasurementUI.measui"],
 )
 

…/test_assets/example_renders/example.bat …ts/test_assets/example_renders/start.batni_measurementlink_generator/tests/test_assets/example_renders/example.bat renamed to ni_measurementlink_generator/tests/test_assets/example_renders/start.bat ni_measurementlink_generator/tests/test_assets/example_renders/example.bat renamed to ni_measurementlink_generator/tests/test_assets/example_renders/start.bat

@@ -15,9 +15,9 @@ def test___command_line_args___create_measurement___render_without_exception(tmp
     with pytest.raises(SystemExit):
         template.create_measurement(
             [
-                "SampleMeasurement",
+                "Sample Measurement",
                 "--measurement-version",
-                "1.0.0.0",
+                "1.2.3.4",
                 "--ui-file",
                 "MeasurementUI.measui",
                 "--service-class",
@@ -31,18 +31,12 @@ def test___command_line_args___create_measurement___render_without_exception(tmp
 
     golden_path = test_assets_path / "example_renders"
 
-    _assert_equal(
-        golden_path / "example.py",
-        temp_directory / "measurement.py",
-    )
-    _assert_equal(
-        golden_path / "example.serviceconfig",
-        temp_directory / "SampleMeasurement.serviceconfig",
-    )
-    _assert_equal(
-        golden_path / "example.bat",
-        temp_directory / "start.bat",
-    )
+    filenames = ["measurement.py", "SampleMeasurement.serviceconfig", "start.bat"]
+    for filename in filenames:
+        _assert_equal(
+            golden_path / filename,
+            temp_directory / filename,
+        )
 
 
 def _assert_equal(expected_path: pathlib.Path, result_path: pathlib.Path):