remote/coordinator: add GetPlace RPC

Add a unary GetPlace RPC for fetching a single place by name instead of
requiring callers to fetch and scan the full GetPlaces response.

Return INVALID_ARGUMENT when no name is provided or when the requested
place does not exist.

Signed-off-by: Asher Pemberton <asher.pemberton@arm.com>
Reviewed-by: Asher Pemberton <asher.pemberton@arm.com> # gatekeeper
Co-authored-by: Luke Beardsmore <luke.beardsmore2@arm.com>

Author: asher-pem-arm

labgrid/remote/coordinator.py

@@ -981,6 +981,21 @@ async def AllowPlace(self, request, context):
     def _get_places(self):
         return {k: v.asdict() for k, v in self.places.items()}
 
+    @locked
+    async def GetPlace(self, request, context):
+        name = request.name
+        logging.debug("GetPlace name=%s", name)
+        if not name or not isinstance(name, str):
+            await context.abort(grpc.StatusCode.INVALID_ARGUMENT, "name was not a string")
+        try:
+            place = self.places[name]
+            return labgrid_coordinator_pb2.GetPlaceResponse(place=place.as_pb2())
+        except KeyError:
+            await context.abort(grpc.StatusCode.INVALID_ARGUMENT, f"Place {name} does not exist")
+        except Exception:
+            logging.exception("error during get place")
+            await context.abort(grpc.StatusCode.INTERNAL, "internal error")
+
     @locked
     async def GetPlaces(self, unused_request, unused_context):
         logging.debug("GetPlaces")

labgrid/remote/generated/labgrid_coordinator_pb2.py

@@ -1,7 +1,8 @@
 from google.protobuf.internal import containers as _containers
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import message as _message
-from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+from collections.abc import Iterable as _Iterable, Mapping as _Mapping
+from typing import ClassVar as _ClassVar, Optional as _Optional, Union as _Union
 
 DESCRIPTOR: _descriptor.FileDescriptor
 
@@ -174,6 +175,18 @@ class DeletePlaceResponse(_message.Message):
     __slots__ = ()
     def __init__(self) -> None: ...
 
+class GetPlaceRequest(_message.Message):
+    __slots__ = ("name",)
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    name: str
+    def __init__(self, name: _Optional[str] = ...) -> None: ...
+
+class GetPlaceResponse(_message.Message):
+    __slots__ = ("place",)
+    PLACE_FIELD_NUMBER: _ClassVar[int]
+    place: Place
+    def __init__(self, place: _Optional[_Union[Place, _Mapping]] = ...) -> None: ...
+
 class GetPlacesRequest(_message.Message):
     __slots__ = ()
     def __init__(self) -> None: ...