Merge pull request #336 from jumpstarter-dev/client-svc

Implement jmp client list-exporters command

Author: mangelajo

buf.gen.yaml

@@ -2,7 +2,7 @@ version: v2
 managed:
   enabled: true
 plugins:
-  - remote: buf.build/protocolbuffers/python
+  - remote: buf.build/protocolbuffers/python:v29.3
     out: ./packages/jumpstarter-protocol/jumpstarter_protocol
   - remote: buf.build/grpc/python
     out: ./packages/jumpstarter-protocol/jumpstarter_protocol

packages/jumpstarter-cli-client/jumpstarter_cli_client/__init__.py

@@ -5,6 +5,7 @@
 from jumpstarter_cli_common import AliasedGroup, opt_log_level, version
 
 from .client_config import create_client_config, delete_client_config, list_client_configs, use_client_config
+from .client_exporter import list_client_exporters
 from .client_lease import client_lease
 from .client_login import client_login
 from .client_shell import client_shell
@@ -29,6 +30,7 @@ def j():
 client.add_command(create_client_config)
 client.add_command(delete_client_config)
 client.add_command(list_client_configs)
+client.add_command(list_client_exporters)
 client.add_command(use_client_config)
 client.add_command(client_lease)
 client.add_command(client_login)

packages/jumpstarter-cli-client/jumpstarter_cli_client/client_exporter.py

@@ -0,0 +1,46 @@
+import asyncclick as click
+from jumpstarter_cli_common import OutputMode, OutputType, make_table, opt_labels, opt_output_all
+from jumpstarter_cli_common.exceptions import handle_exceptions
+
+from jumpstarter.config import (
+    ClientConfigV1Alpha1,
+    UserConfigV1Alpha1,
+)
+
+
+@click.command("list-exporters", short_help="List available exporters.")
+@click.argument("name", type=str, default="")
+@opt_labels
+@opt_output_all
+@handle_exceptions
+def list_client_exporters(name: str | None, labels: list[(str, str)], output: OutputType):
+    if name:
+        config = ClientConfigV1Alpha1.load(name)
+    else:
+        config = UserConfigV1Alpha1.load_or_create().config.current_client
+    if not config:
+        raise click.BadParameter(
+            "no client specified, and no default client set: specify a client name, or use jmp client use-config ",
+            param_hint="name",
+        )
+
+    exporters = config.list_exporters(filter=",".join("{}={}".format(i[0], i[1]) for i in labels))
+
+    if output == OutputMode.JSON:
+        click.echo(exporters.dump_json())
+    elif output == OutputMode.YAML:
+        click.echo(exporters.dump_yaml())
+    elif output == OutputMode.NAME:
+        for exporter in exporters.exporters:
+            click.echo(exporter.name)
+    else:
+        columns = ["NAME", "LABELS"]
+
+        def make_row(exporter):
+            return {
+                "NAME": exporter.name,
+                "LABELS": ",".join(("{}={}".format(i[0], i[1]) for i in exporter.labels.items())),
+            }
+
+        rows = list(map(make_row, exporters.exporters))
+        click.echo(make_table(columns, rows))

packages/jumpstarter-protocol/jumpstarter_protocol/__init__.py

@@ -1,4 +1,6 @@
 from .jumpstarter.v1 import (
+        client_pb2,
+        client_pb2_grpc,
     jumpstarter_pb2,
     jumpstarter_pb2_grpc,
     kubernetes_pb2,
@@ -8,6 +10,8 @@
 )
 
 __all__ = [
+    "client_pb2",
+    "client_pb2_grpc",
     "jumpstarter_pb2",
     "jumpstarter_pb2_grpc",
     "kubernetes_pb2",

packages/jumpstarter-protocol/jumpstarter_protocol/jumpstarter/v1/client_pb2.py

@@ -0,0 +1,120 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from . import client_pb2 as jumpstarter_dot_v1_dot_client__pb2
+
+
+class ClientServiceStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.GetExporter = channel.unary_unary(
+                '/jumpstarter.v1.ClientService/GetExporter',
+                request_serializer=jumpstarter_dot_v1_dot_client__pb2.GetExporterRequest.SerializeToString,
+                response_deserializer=jumpstarter_dot_v1_dot_client__pb2.Exporter.FromString,
+                _registered_method=True)
+        self.ListExporters = channel.unary_unary(
+                '/jumpstarter.v1.ClientService/ListExporters',
+                request_serializer=jumpstarter_dot_v1_dot_client__pb2.ListExportersRequest.SerializeToString,
+                response_deserializer=jumpstarter_dot_v1_dot_client__pb2.ListExportersResponse.FromString,
+                _registered_method=True)
+
+
+class ClientServiceServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def GetExporter(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def ListExporters(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_ClientServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'GetExporter': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetExporter,
+                    request_deserializer=jumpstarter_dot_v1_dot_client__pb2.GetExporterRequest.FromString,
+                    response_serializer=jumpstarter_dot_v1_dot_client__pb2.Exporter.SerializeToString,
+            ),
+            'ListExporters': grpc.unary_unary_rpc_method_handler(
+                    servicer.ListExporters,
+                    request_deserializer=jumpstarter_dot_v1_dot_client__pb2.ListExportersRequest.FromString,
+                    response_serializer=jumpstarter_dot_v1_dot_client__pb2.ListExportersResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'jumpstarter.v1.ClientService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('jumpstarter.v1.ClientService', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class ClientService(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def GetExporter(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/jumpstarter.v1.ClientService/GetExporter',
+            jumpstarter_dot_v1_dot_client__pb2.GetExporterRequest.SerializeToString,
+            jumpstarter_dot_v1_dot_client__pb2.Exporter.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def ListExporters(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/jumpstarter.v1.ClientService/ListExporters',
+            jumpstarter_dot_v1_dot_client__pb2.ListExportersRequest.SerializeToString,
+            jumpstarter_dot_v1_dot_client__pb2.ListExportersResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)