Harmonize client config format with exporter config

Author: NickCao

examples/soc-pytest/jumpstarter_example_soc_pytest/test_on_rpi4.py

@@ -14,8 +14,9 @@
 
 log = logging.getLogger(__file__)
 
+
 class TestResource(JumpstarterTest):
-    filter_labels = {"board":"rpi4"}
+    filter_labels = {"board": "rpi4"}
 
     @classmethod
     def teardown_class(cls):
@@ -52,8 +53,9 @@ def test_setup_device(self, client, console):
         try:
             client.dutlink.storage.write_local_file("image/images/latest.raw")
         except opendal.exceptions.NotFound:
-            pytest.exit("No image found, please enter the image directory and run `make`, "
-                        "more details in the README.md")
+            pytest.exit(
+                "No image found, please enter the image directory and run `make`, " "more details in the README.md"
+            )
             return
         client.dutlink.storage.dut()
         client.dutlink.power.on()
@@ -66,13 +68,15 @@ def test_setup_device(self, client, console):
     def test_tpm2_device(self, shell):
         shell.logfile_read = sys.stdout.buffer
 
-        lines = ["apt-get install -y tpm2-tools",
-                 "tpm2_createprimary -C e -c primary.ctx",
-                 "tpm2_create -G rsa -u key.pub -r key.priv -C primary.ctx",
-                 "tpm2_load -C primary.ctx -u key.pub -r key.priv -c key.ctx",
-                 "echo my message > message.dat",
-                 "tpm2_sign -c key.ctx -g sha256 -o sig.rssa message.dat",
-                 "tpm2_verifysignature -c key.ctx -g sha256 -s sig.rssa -m message.dat"]
+        lines = [
+            "apt-get install -y tpm2-tools",
+            "tpm2_createprimary -C e -c primary.ctx",
+            "tpm2_create -G rsa -u key.pub -r key.priv -C primary.ctx",
+            "tpm2_load -C primary.ctx -u key.pub -r key.priv -c key.ctx",
+            "echo my message > message.dat",
+            "tpm2_sign -c key.ctx -g sha256 -o sig.rssa message.dat",
+            "tpm2_verifysignature -c key.ctx -g sha256 -s sig.rssa -m message.dat",
+        ]
 
         for line in lines:
             log.info(f"Running command: {line}")

jumpstarter/cli/client.py

@@ -6,7 +6,6 @@
 from jumpstarter.common.utils import launch_shell
 from jumpstarter.config import (
     ClientConfigV1Alpha1,
-    ClientConfigV1Alpha1Client,
     ClientConfigV1Alpha1Drivers,
     UserConfigV1Alpha1,
 )
@@ -105,9 +104,9 @@ def client_create(
 
     config = ClientConfigV1Alpha1(
         name=name,
-        client=ClientConfigV1Alpha1Client(
-            endpoint=endpoint, token=token, drivers=ClientConfigV1Alpha1Drivers(allow=allow.split(","), unsafe=unsafe)
-        ),
+        endpoint=endpoint,
+        token=token,
+        drivers=ClientConfigV1Alpha1Drivers(allow=allow.split(","), unsafe=unsafe),
     )
     ClientConfigV1Alpha1.save(config, out)
 
@@ -158,7 +157,7 @@ def make_row(c: ClientConfigV1Alpha1):
         return {
             "CURRENT": "*" if current_name == c.name else "",
             "NAME": c.name,
-            "ENDPOINT": c.client.endpoint,
+            "ENDPOINT": c.endpoint,
             "PATH": str(c.path),
         }
 

jumpstarter/config/__init__.py

@@ -1,6 +1,5 @@
 from .client import (
     ClientConfigV1Alpha1,
-    ClientConfigV1Alpha1Client,
     ClientConfigV1Alpha1Drivers,
 )
 from .common import CONFIG_API_VERSION, CONFIG_PATH
@@ -18,6 +17,5 @@
     "UserConfigV1Alpha1",
     "UserConfigV1Alpha1Config",
     "ClientConfigV1Alpha1",
-    "ClientConfigV1Alpha1Client",
     "ClientConfigV1Alpha1Drivers",
 ]

jumpstarter/config/client.py

@@ -33,12 +33,6 @@ class ClientConfigV1Alpha1Drivers(BaseModel):
     unsafe: bool = Field(default=False)
 
 
-class ClientConfigV1Alpha1Client(BaseModel):
-    endpoint: str
-    token: str
-    drivers: ClientConfigV1Alpha1Drivers
-
-
 class ClientConfigV1Alpha1(BaseModel):
     CLIENT_CONFIGS_PATH: ClassVar[Path] = CONFIG_PATH / "clients"
 
@@ -47,15 +41,19 @@ class ClientConfigV1Alpha1(BaseModel):
 
     apiVersion: Literal["jumpstarter.dev/v1alpha1"] = Field(default="jumpstarter.dev/v1alpha1")
     kind: Literal["ClientConfig"] = Field(default="ClientConfig")
-    client: ClientConfigV1Alpha1Client = Field(default_factory=ClientConfigV1Alpha1Client)
+
+    endpoint: str
+    token: str
+
+    drivers: ClientConfigV1Alpha1Drivers
 
     async def channel(self):
         credentials = grpc.composite_channel_credentials(
-            ssl_channel_credentials(self.client.endpoint),
-            grpc.access_token_call_credentials(self.client.token),
+            ssl_channel_credentials(self.endpoint),
+            grpc.access_token_call_credentials(self.token),
         )
 
-        return grpc.aio.secure_channel(self.client.endpoint, credentials)
+        return grpc.aio.secure_channel(self.endpoint, credentials)
 
     @contextmanager
     def lease(self, metadata_filter: MetadataFilter):
@@ -111,14 +109,12 @@ def try_from_env(cls):
     @classmethod
     def from_env(cls):
         return cls(
-            client=ClientConfigV1Alpha1Client(
-                endpoint=os.environ.get(JMP_ENDPOINT),
-                token=os.environ.get(JMP_TOKEN),
-                drivers=ClientConfigV1Alpha1Drivers(
-                    allow=_allow_from_env(),
-                    unsafe=os.environ.get(JMP_DRIVERS_ALLOW) == "UNSAFE",
-                ),
-            )
+            endpoint=os.environ.get(JMP_ENDPOINT),
+            token=os.environ.get(JMP_TOKEN),
+            drivers=ClientConfigV1Alpha1Drivers(
+                allow=_allow_from_env(),
+                unsafe=os.environ.get(JMP_DRIVERS_ALLOW) == "UNSAFE",
+            ),
         )
 
     @classmethod

jumpstarter/config/exporter_test.py

@@ -4,7 +4,7 @@
 
 from jumpstarter.common import MetadataFilter
 
-from .client import ClientConfigV1Alpha1, ClientConfigV1Alpha1Client, ClientConfigV1Alpha1Drivers
+from .client import ClientConfigV1Alpha1, ClientConfigV1Alpha1Drivers
 from .exporter import ExporterConfigV1Alpha1, ExporterConfigV1Alpha1DriverInstance
 
 pytestmark = pytest.mark.anyio
@@ -36,11 +36,9 @@ async def test_exporter_serve(mock_controller):
 
     client = ClientConfigV1Alpha1(
         name="testclient",
-        client=ClientConfigV1Alpha1Client(
-            endpoint=mock_controller,
-            token="dummy-client-token",
-            drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),
-        ),
+        endpoint=mock_controller,
+        token="dummy-client-token",
+        drivers=ClientConfigV1Alpha1Drivers(allow=[], unsafe=True),
     )
 
     async with create_task_group() as tg:

jumpstarter/testing/pytest.py

@@ -35,6 +35,7 @@ def test_setup_device(self, client, console):
             client.dutlink.power.on()
     ```
     """
+
     @classmethod
     def setup_class(cls):
         try:
@@ -58,4 +59,3 @@ def teardown_class(cls):
     @pytest.fixture()
     def client(self):
         return self._client
-

jumpstarter/testing/utils.py

@@ -2,6 +2,7 @@
 
 log = logging.getLogger(__name__)
 
+
 def wait_and_login(pexpect_console, username, password, prompt, timeout=240):
     """
     Wait for login prompt and login