Add Service Annotation Support

ni_measurementlink_service/_internal/discovery_client.py

@@ -106,6 +106,7 @@ def register_measurement_service(
             service_descriptor.service_class = service_info.service_class
             service_descriptor.description_url = service_info.description_url
             service_descriptor.provided_interfaces.extend(service_info.provided_interfaces)
+            service_descriptor.annotations.update(service_info.annotations)
 
             # Registration Request Creation
             request = discovery_service_pb2.RegisterServiceRequest(

ni_measurementlink_service/_internal/stubs/ni/measurementlink/discovery/v1/discovery_service_pb2.pyi

@@ -26,10 +26,27 @@ class ServiceDescriptor(google.protobuf.message.Message):
 
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
+    @typing_extensions.final
+    class AnnotationsEntry(google.protobuf.message.Message):
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+        KEY_FIELD_NUMBER: builtins.int
+        VALUE_FIELD_NUMBER: builtins.int
+        key: builtins.str
+        value: builtins.str
+        def __init__(
+            self,
+            *,
+            key: builtins.str = ...,
+            value: builtins.str = ...,
+        ) -> None: ...
+        def ClearField(self, field_name: typing_extensions.Literal["key", b"key", "value", b"value"]) -> None: ...
+
     DISPLAY_NAME_FIELD_NUMBER: builtins.int
     DESCRIPTION_URL_FIELD_NUMBER: builtins.int
     PROVIDED_INTERFACES_FIELD_NUMBER: builtins.int
     SERVICE_CLASS_FIELD_NUMBER: builtins.int
+    ANNOTATIONS_FIELD_NUMBER: builtins.int
     display_name: builtins.str
     """Required. The user visible name of the service."""
     description_url: builtins.str
@@ -43,15 +60,33 @@ class ServiceDescriptor(google.protobuf.message.Message):
     """Required. The "class" of a service. The value of this field should be unique for a given interface in provided_interfaces.
     In effect, the .proto service declaration defines the interface, and this field defines a class or concrete type of the interface.
     """
+    @property
+    def annotations(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]:
+        """Optional. Represents a set of annotations on the service.
+        Well-known annotations:
+        - Description
+          - Key: "ni/service.description"
+          - Expected format: string
+          - Example: "Measure inrush current with a shorted load and validate results against configured limits."
+        - Collection
+          - Key: "ni/service.collection"
+          - Expected format: "." delimited namespace/hierarchy case-insensitive string
+          - Example: "CurrentTests.Inrush"
+        - Tags
+          - Key: "ni/service.tags"
+          - Expected format: serialized JSON string of an array of strings
+          - Example: "[\\"powerup\\", \\"current\\"]"
+        """
     def __init__(
         self,
         *,
         display_name: builtins.str = ...,
         description_url: builtins.str = ...,
         provided_interfaces: collections.abc.Iterable[builtins.str] | None = ...,
         service_class: builtins.str = ...,
+        annotations: collections.abc.Mapping[builtins.str, builtins.str] | None = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["description_url", b"description_url", "display_name", b"display_name", "provided_interfaces", b"provided_interfaces", "service_class", b"service_class"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["annotations", b"annotations", "description_url", b"description_url", "display_name", b"display_name", "provided_interfaces", b"provided_interfaces", "service_class", b"service_class"]) -> None: ...
 
 global___ServiceDescriptor = ServiceDescriptor
 

ni_measurementlink_service/_internal/stubs/proto/ni/measurementlink/discovery/v1/discovery_service.proto

@@ -67,6 +67,22 @@ message ServiceDescriptor {
   // Required. The "class" of a service. The value of this field should be unique for a given interface in provided_interfaces.
   // In effect, the .proto service declaration defines the interface, and this field defines a class or concrete type of the interface.
   string service_class = 4;
+
+  // Optional. Represents a set of annotations on the service.
+  // Well-known annotations:
+  // - Description
+  //   - Key: "ni/service.description"
+  //   - Expected format: string
+  //   - Example: "Measure inrush current with a shorted load and validate results against configured limits."
+  // - Collection
+  //   - Key: "ni/service.collection"
+  //   - Expected format: "." delimited namespace/hierarchy case-insensitive string
+  //   - Example: "CurrentTests.Inrush"
+  // - Tags
+  //   - Key: "ni/service.tags"
+  //   - Expected format: serialized JSON string of an array of strings
+  //   - Example: "[\"powerup\", \"current\"]"
+  map<string, string> annotations = 5;
 }
 
 // Represents the location of a service. The location generally includes the IP address and port number for the service

ni_measurementlink_service/measurement/info.py

@@ -2,9 +2,8 @@
 from __future__ import annotations
 
 import enum
-import typing
 from pathlib import Path
-from typing import NamedTuple
+from typing import Dict, List, NamedTuple
 
 from google.protobuf import type_pb2
 
@@ -25,7 +24,7 @@ class MeasurementInfo(NamedTuple):
 
     display_name: str
     version: str
-    ui_file_paths: typing.List[Path]
+    ui_file_paths: List[Path]
 
 
 class ServiceInfo(NamedTuple):
@@ -44,11 +43,16 @@ class ServiceInfo(NamedTuple):
         For e.g., ni.measurementlink.measurement.v2.MeasurementService.
         Defaults to ["ni.measurementlink.measurement.v1.MeasurementService"].
 
+        annotations (Dict[str,str]): Dict that contains extra information of the measurement.
+        As default we added a (str) description, (str) collection and a (List[str]) list of tags.
+        Feel free to add your own Annotations as needed.
+
     """
 
     service_class: str
     description_url: str
-    provided_interfaces: typing.List[str] = ["ni.measurementlink.measurement.v1.MeasurementService"]
+    provided_interfaces: List[str] = ["ni.measurementlink.measurement.v1.MeasurementService"]
+    annotations: Dict[str, str] = {}
 
 
 class TypeSpecialization(enum.Enum):

ni_measurementlink_service/measurement/service.py

@@ -181,10 +181,16 @@ def __init__(
             ui_file_paths=ui_file_paths,
         )
 
+        service_annotations_string = {
+            key: json.dumps(value, separators=(",", ":"))
+            for key, value in service.get("annotations", {}).items()
+        }
+
         self.service_info = ServiceInfo(
             service_class=service["serviceClass"],
             description_url=service["descriptionUrl"],
             provided_interfaces=service["providedInterfaces"],
+            annotations=service_annotations_string,
         )
 
         self.configuration_parameter_list: list = []

pyproject.toml

@@ -1,13 +1,9 @@
 [tool.black]
-extend-exclude ='((.+_pb2_grpc)|(.+_pb2))+(.py)$' # Regex to files with _pb2_grpc.py and _pb2.py Auto Generated Code are excluded
+extend_exclude = '_pb2(_grpc)?\.(py|pyi)$|ni_measurementlink_generator/'
 line-length = 100
-exclude = '''
-(
-\.git # root of the project
-| \.venv
-| venv
-)
-'''
+
+[tool.ni-python-styleguide]
+extend_exclude = '*_pb2_grpc.py,*_pb2_grpc.pyi,*_pb2.py,*_pb2.pyi,ni_measurementlink_generator/'
 
 [tool.poetry]
 name = "ni_measurementlink_service"
@@ -69,9 +65,6 @@ sphinx-click = "^4.1.0"
 requires = ["poetry-core>=1.2.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.ni-python-styleguide]
-extend_exclude = "*_pb2_grpc.py,*_pb2.py,venv,ni_measurementlink_generator/*"
-
 [tool.pytest.ini_options]
 addopts = "--doctest-modules --strict-markers"
 filterwarnings = ["always::ImportWarning", "always::ResourceWarning"]

tests/assets/example.AllAnnotations.serviceconfig

@@ -0,0 +1,22 @@
+{
+  "services": [
+    {
+      "displayName": "SampleMeasurement",
+      "serviceClass": "SampleMeasurement_Python",
+      "descriptionUrl": "https://www.example.com/SampleMeasurement.html",
+      "providedInterfaces": [
+        "ni.measurementlink.measurement.v2.MeasurementService"
+      ],
+      "path": "start.bat",
+      "annotations": {
+        "ni/service.description": "Testing extra Client info",
+        "client/extra.NumberID" : 500,
+        "client/extra.Parts" : [ "A25898", "A25412" ],
+        "client/extra.GroupName" : {
+            "SpeakerType": "true",
+            "PhoneType": "false"
+        }
+      }
+    }
+  ]
+}

tests/assets/example.CustomAnnotations.serviceconfig

@@ -0,0 +1,30 @@
+{
+  "services": [
+    {
+      "displayName": "SampleMeasurement",
+      "serviceClass": "SampleMeasurement_Python",
+      "descriptionUrl": "https://www.example.com/SampleMeasurement.html",
+      "providedInterfaces": [
+         "ni.measurementlink.measurement.v1.MeasurementService"
+      ],
+      "path": "NoFile.exe",
+      "annotations": {
+        "description": "An annotated test measurement service.",
+        "collection": "Tests.Measurements",
+        "tags": [
+          "test",
+          "measurement"
+        ],
+        "custom": {
+          "foo": "bar",
+          "baz": [ "qux", "quux", "quuux" ],
+          "snork": {
+            "blarg": "flarp",
+            "oogle": [ "foogle", "boogle" ],
+            "ork": [ "zork", "gork", "bork" ]
+          }
+        }
+      }
+    }
+  ]
+}

tests/assets/example.OnlyCollection.serviceconfig

@@ -0,0 +1,17 @@
+{
+  "services": [
+    {
+      "displayName": "SampleMeasurement",
+      "serviceClass": "SampleMeasurement_Python",
+      "descriptionUrl": "https://www.example.com/SampleMeasurement.html",
+      "providedInterfaces": [
+        "ni.measurementlink.measurement.v1.MeasurementService",
+        "ni.measurementlink.measurement.v2.MeasurementService"
+      ],
+      "path": "start.bat",
+      "annotations": {
+        "ni/service.collection": "CurrentTests.Inrush"
+      }
+    }
+  ]
+}

tests/assets/example.OnlyTags.serviceconfig

@@ -0,0 +1,16 @@
+{
+  "services": [
+    {
+      "displayName": "SampleMeasurement",
+      "serviceClass": "SampleMeasurement_Python",
+      "descriptionUrl": "https://www.example.com/SampleMeasurement.html",
+      "providedInterfaces": [
+        "ni.measurementlink.measurement.v2.MeasurementService"
+      ],
+      "path": "start.bat",
+      "annotations": {
+        "ni/service.tags": [ "powerup", "current", "voltage" ]
+      }
+    }
+  ]
+}

tests/assets/example.serviceconfig

@@ -8,7 +8,12 @@
         "ni.measurementlink.measurement.v1.MeasurementService",
         "ni.measurementlink.measurement.v2.MeasurementService"
       ],
-      "path": "start.bat"
+      "path": "start.bat",
+      "annotations": {
+        "ni/service.description": "Measure inrush current with a shorted load and validate results against configured limits.",
+        "ni/service.collection": "CurrentTests.Inrush",
+        "ni/service.tags": [ "powerup", "current" ]
+      }
     }
   ]
 }

tests/assets/test_pb2.pyi

@@ -24,7 +24,10 @@ class _DifferentColor:
     ValueType = typing.NewType("ValueType", builtins.int)
     V: typing_extensions.TypeAlias = ValueType
 
-class _DifferentColorEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_DifferentColor.ValueType], builtins.type):
+class _DifferentColorEnumTypeWrapper(
+    google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_DifferentColor.ValueType],
+    builtins.type,
+):
     DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
     PURPLE: _DifferentColor.ValueType  # 0
     ORANGE: _DifferentColor.ValueType  # 1
@@ -72,6 +75,8 @@ class MeasurementParameter(google.protobuf.message.Message):
     uint64_data: builtins.int
     bool_data: builtins.bool
     string_data: builtins.str
+    enum_data: builtins.str
+    enum_array_data: builtins.list
     @property
     def double_array_data(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.float]: ...
     @property
@@ -88,9 +93,7 @@ class MeasurementParameter(google.protobuf.message.Message):
     def bool_array_data(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.bool]: ...
     @property
     def string_array_data(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]: ...
-    enum_data: global___DifferentColor.ValueType
     @property
-    def enum_array_data(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___DifferentColor.ValueType]: ...
     def __init__(
         self,
         *,