Add status field to jmp admin get exporter

Author: kirkbrauer

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/get_test.py

@@ -301,7 +301,10 @@ def test_get_clients(_load_kube_config_mock, list_clients_mock: AsyncMock):
     kind="Exporter",
     metadata=V1ObjectMeta(name="test", namespace="testing", creation_timestamp="2024-01-01T21:00:00Z"),
     status=V1Alpha1ExporterStatus(
-        endpoint="grpc://example.com:443", credential=V1ObjectReference(name="test-credential"), devices=[]
+        endpoint="grpc://example.com:443",
+        credential=V1ObjectReference(name="test-credential"),
+        devices=[],
+        exporter_status="Available",
     ),
 )
 
@@ -318,7 +321,9 @@ def test_get_clients(_load_kube_config_mock, list_clients_mock: AsyncMock):
             "name": "test-credential"
         },
         "devices": [],
-        "endpoint": "grpc://example.com:443"
+        "endpoint": "grpc://example.com:443",
+        "exporterStatus": "Available",
+        "statusMessage": null
     }
 }
 """
@@ -334,6 +339,8 @@ def test_get_clients(_load_kube_config_mock, list_clients_mock: AsyncMock):
     name: test-credential
   devices: []
   endpoint: grpc://example.com:443
+  exporterStatus: Available
+  statusMessage: null
 
 """
 
@@ -348,6 +355,7 @@ def test_get_exporter(_load_kube_config_mock, get_exporter_mock: AsyncMock):
     result = runner.invoke(get, ["exporter", "test"])
     assert result.exit_code == 0
     assert "test" in result.output
+    assert "Available" in result.output
     assert "grpc://example.com:443" in result.output
     get_exporter_mock.reset_mock()
 
@@ -396,6 +404,7 @@ def test_get_exporter(_load_kube_config_mock, get_exporter_mock: AsyncMock):
             V1Alpha1ExporterDevice(labels={"hardware": "rpi4"}, uuid="82a8ac0d-d7ff-4009-8948-18a3c5c607b1"),
             V1Alpha1ExporterDevice(labels={"hardware": "rpi4"}, uuid="f7cd30ac-64a3-42c6-ba31-b25f033b97c1"),
         ],
+        exporter_status="Available",
     ),
 )
 
@@ -425,7 +434,9 @@ def test_get_exporter(_load_kube_config_mock, get_exporter_mock: AsyncMock):
                 "uuid": "f7cd30ac-64a3-42c6-ba31-b25f033b97c1"
             }
         ],
-        "endpoint": "grpc://example.com:443"
+        "endpoint": "grpc://example.com:443",
+        "exporterStatus": "Available",
+        "statusMessage": null
     }
 }
 """
@@ -447,6 +458,8 @@ def test_get_exporter(_load_kube_config_mock, get_exporter_mock: AsyncMock):
       hardware: rpi4
     uuid: f7cd30ac-64a3-42c6-ba31-b25f033b97c1
   endpoint: grpc://example.com:443
+  exporterStatus: Available
+  statusMessage: null
 
 """
 
@@ -460,6 +473,7 @@ def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: AsyncMo
     result = runner.invoke(get, ["exporter", "test", "--devices"])
     assert result.exit_code == 0
     assert "test" in result.output
+    assert "Available" in result.output
     assert "grpc://example.com:443" in result.output
     assert "hardware:rpi4" in result.output
     assert "82a8ac0d-d7ff-4009-8948-18a3c5c607b1" in result.output
@@ -510,6 +524,7 @@ def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: AsyncMo
                 endpoint="grpc://example.com:443",
                 credential=V1ObjectReference(name="test-credential"),
                 devices=[],
+                exporter_status="Available",
             ),
         ),
         V1Alpha1Exporter(
@@ -520,6 +535,7 @@ def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: AsyncMo
                 endpoint="grpc://example.com:443",
                 credential=V1ObjectReference(name="another-credential"),
                 devices=[],
+                exporter_status="Available",
             ),
         ),
     ]
@@ -541,7 +557,9 @@ def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: AsyncMo
                     "name": "test-credential"
                 },
                 "devices": [],
-                "endpoint": "grpc://example.com:443"
+                "endpoint": "grpc://example.com:443",
+                "exporterStatus": "Available",
+                "statusMessage": null
             }
         },
         {
@@ -557,7 +575,9 @@ def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: AsyncMo
                     "name": "another-credential"
                 },
                 "devices": [],
-                "endpoint": "grpc://example.com:443"
+                "endpoint": "grpc://example.com:443",
+                "exporterStatus": "Available",
+                "statusMessage": null
             }
         }
     ],
@@ -578,6 +598,8 @@ def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: AsyncMo
       name: test-credential
     devices: []
     endpoint: grpc://example.com:443
+    exporterStatus: Available
+    statusMessage: null
 - apiVersion: jumpstarter.dev/v1alpha1
   kind: Exporter
   metadata:
@@ -589,6 +611,8 @@ def test_get_exporter_devices(_load_kube_config_mock, get_exporter_mock: AsyncMo
       name: another-credential
     devices: []
     endpoint: grpc://example.com:443
+    exporterStatus: Available
+    statusMessage: null
 kind: ExporterList
 
 """
@@ -609,6 +633,7 @@ def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncMock):
     assert result.exit_code == 0
     assert "test" in result.output
     assert "another" in result.output
+    assert "Available" in result.output
     list_exporters_mock.reset_mock()
 
     # List exporters JSON output
@@ -655,6 +680,7 @@ def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncMock):
                 devices=[
                     V1Alpha1ExporterDevice(labels={"hardware": "rpi4"}, uuid="82a8ac0d-d7ff-4009-8948-18a3c5c607b1")
                 ],
+                exporter_status="Available",
             ),
         ),
         V1Alpha1Exporter(
@@ -667,6 +693,7 @@ def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncMock):
                 devices=[
                     V1Alpha1ExporterDevice(labels={"hardware": "rpi4"}, uuid="f7cd30ac-64a3-42c6-ba31-b25f033b97c1"),
                 ],
+                exporter_status="Available",
             ),
         ),
     ]
@@ -695,7 +722,9 @@ def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncMock):
                         "uuid": "82a8ac0d-d7ff-4009-8948-18a3c5c607b1"
                     }
                 ],
-                "endpoint": "grpc://example.com:443"
+                "endpoint": "grpc://example.com:443",
+                "exporterStatus": "Available",
+                "statusMessage": null
             }
         },
         {
@@ -718,7 +747,9 @@ def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncMock):
                         "uuid": "f7cd30ac-64a3-42c6-ba31-b25f033b97c1"
                     }
                 ],
-                "endpoint": "grpc://example.com:443"
+                "endpoint": "grpc://example.com:443",
+                "exporterStatus": "Available",
+                "statusMessage": null
             }
         }
     ],
@@ -742,6 +773,8 @@ def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncMock):
         hardware: rpi4
       uuid: 82a8ac0d-d7ff-4009-8948-18a3c5c607b1
     endpoint: grpc://example.com:443
+    exporterStatus: Available
+    statusMessage: null
 - apiVersion: jumpstarter.dev/v1alpha1
   kind: Exporter
   metadata:
@@ -756,6 +789,8 @@ def test_get_exporters(_load_kube_config_mock, list_exporters_mock: AsyncMock):
         hardware: rpi4
       uuid: f7cd30ac-64a3-42c6-ba31-b25f033b97c1
     endpoint: grpc://example.com:443
+    exporterStatus: Available
+    statusMessage: null
 kind: ExporterList
 
 """
@@ -774,6 +809,7 @@ def test_get_exporters_devices(_load_kube_config_mock, list_exporters_mock: Asyn
     assert result.exit_code == 0
     assert "test" in result.output
     assert "another" in result.output
+    assert "Available" in result.output
     assert "hardware:rpi4" in result.output
     assert "82a8ac0d-d7ff-4009-8948-18a3c5c607b1" in result.output
     assert "f7cd30ac-64a3-42c6-ba31-b25f033b97c1" in result.output

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/exporters.py

@@ -26,6 +26,8 @@ class V1Alpha1ExporterStatus(JsonBaseModel):
     credential: SerializeV1ObjectReference
     devices: list[V1Alpha1ExporterDevice]
     endpoint: str
+    exporter_status: str | None = Field(alias="exporterStatus", default=None)
+    status_message: str | None = Field(alias="statusMessage", default=None)
 
 
 class V1Alpha1Exporter(JsonBaseModel):
@@ -55,24 +57,29 @@ def from_dict(dict: dict):
                 devices=[V1Alpha1ExporterDevice(labels=d["labels"], uuid=d["uuid"]) for d in dict["status"]["devices"]]
                 if "devices" in dict["status"]
                 else [],
+                exporter_status=dict["status"].get("exporterStatus"),
+                status_message=dict["status"].get("statusMessage"),
             ),
         )
 
     @classmethod
     def rich_add_columns(cls, table, devices: bool = False):
         if devices:
             table.add_column("NAME", no_wrap=True)
+            table.add_column("STATUS")
             table.add_column("ENDPOINT")
             table.add_column("AGE")
             table.add_column("LABELS")
             table.add_column("UUID")
         else:
             table.add_column("NAME", no_wrap=True)
+            table.add_column("STATUS")
             table.add_column("ENDPOINT")
             table.add_column("DEVICES")
             table.add_column("AGE")
 
     def rich_add_rows(self, table, devices: bool = False):
+        status = self.status.exporter_status if self.status else "Unknown"
         if devices:
             if self.status is not None:
                 for d in self.status.devices:
@@ -82,6 +89,7 @@ def rich_add_rows(self, table, devices: bool = False):
                             labels.append(f"{label}:{str(d.labels[label])}")
                     table.add_row(
                         self.metadata.name,
+                        status or "Unknown",
                         self.status.endpoint,
                         time_since(self.metadata.creation_timestamp),
                         ",".join(labels),
@@ -91,6 +99,7 @@ def rich_add_rows(self, table, devices: bool = False):
         else:
             table.add_row(
                 self.metadata.name,
+                status or "Unknown",
                 self.status.endpoint,
                 str(len(self.status.devices) if self.status and self.status.devices else 0),
                 time_since(self.metadata.creation_timestamp),