Fixed get_diagnostics (error handling, fixed endpoint construction). Added new unit tests.

Author: BregaladTaran

tests/test_client_library.py

@@ -33,6 +33,7 @@
 from virl2_client.virl2_client import (
     ClientConfig,
     ClientLibrary,
+    DiagnosticCategory,
     InitializationError,
     Version,
 )
@@ -739,3 +740,41 @@ def test_convergence_parametrization(client_library_server_current, mocked_sessi
         with pytest.raises(RuntimeError) as err:
             lab.wait_until_lab_converged(max_iterations=1)
         assert ("has not converged, maximum tries %s exceeded" % 1) in err.value.args[0]
+
+
+@pytest.mark.parametrize(
+    "categories, expected_paths",
+    [
+        (None, [diag.value for diag in DiagnosticCategory]),
+        ([DiagnosticCategory.COMPUTES], [DiagnosticCategory.COMPUTES.value]),
+        (
+            [DiagnosticCategory.LABS, DiagnosticCategory.SERVICES],
+            [DiagnosticCategory.LABS.value, DiagnosticCategory.SERVICES.value],
+        ),
+    ],
+)
+def test_get_diagnostics_paths(client_library, categories, expected_paths):
+    with respx.mock(base_url="https://0.0.0.0/api/v0/") as respx_mock:
+        for path in expected_paths:
+            respx_mock.get(f"diagnostics/{path}").mock(
+                return_value=httpx.Response(200, json={"data": "sample"})
+            )
+        diagnostics_data = client_library.get_diagnostics(categories=categories)
+    for path in expected_paths:
+        assert path in diagnostics_data
+        assert diagnostics_data[path] == {"data": "sample"}
+
+
+def test_get_diagnostics_error_handling(client_library):
+    with respx.mock(base_url="https://0.0.0.0/api/v0/") as respx_mock:
+        for diag_type in DiagnosticCategory:
+            respx_mock.get(f"diagnostics/{diag_type.value}").mock(
+                return_value=httpx.Response(404)
+            )
+
+        diagnostics_data = client_library.get_diagnostics()
+
+    for diag_type in DiagnosticCategory:
+        assert diagnostics_data[diag_type.value] == {
+            "error": f"Failed to fetch {diag_type.value} diagnostics"
+        }

virl2_client/virl2_client.py

@@ -163,7 +163,7 @@ def make_client(self) -> ClientLibrary:
         return client
 
 
-class Diagnostics(Enum):
+class DiagnosticCategory(Enum):
     COMPUTES = "computes"
     LABS = "labs"
     LAB_EVENTS = "lab_events"
@@ -207,7 +207,7 @@ class ClientLibrary:
         "labs": "labs",
         "lab": "labs/{lab_id}",
         "lab_topology": "labs/{lab_id}/topology",
-        "diagnostics": "diagnostics",
+        "diagnostics": "diagnostics/{category}",
         "system_health": "system_health",
         "system_stats": "system_stats",
         "populate_lab_tiles": "populate_lab_tiles",
@@ -639,16 +639,11 @@ def all_labs(self, show_all: bool = False) -> list[Lab]:
         :param show_all: Whether to get only labs owned by the admin or all user labs.
         :returns: A list of Lab objects.
         """
-        url = {"url": self._url_for("labs")}
-        if show_all:
-            url["params"] = {"show_all": True}
-        lab_ids = self._session.get(**url).json()
-
+        lab_ids = self.get_lab_list(show_all=show_all)
         result = []
         for lab_id in lab_ids:
             lab = self.join_existing_lab(lab_id)
             result.append(lab)
-
         return result
 
     @locked
@@ -823,30 +818,30 @@ def join_existing_lab(self, lab_id: str, sync_lab: bool = True) -> Lab:
         self._labs[lab_id] = lab
         return lab
 
-    def get_diagnostics(self, types: list[Diagnostics] | None = None) -> dict:
+    def get_diagnostics(
+        self, categories: list[DiagnosticCategory] | None = None
+    ) -> dict:
         """
         Return selected diagnostic data as a JSON object.
 
-        :param types: List of diagnostic types to fetch. If None, fetch all.
+        :param categories: List of diagnostic categories to fetch. If None, fetch all.
         :returns: The diagnostic data.
         """
-        if types is None:
-            types = list(Diagnostics)
+        if categories is None:
+            categories = list(DiagnosticCategory)
 
         diagnostics_data = {}
-        for diag_type in types:
-            # Construct the endpoint path using given diagnostics value
-            endpoint = f"diagnostics/{diag_type.value}"
-            url = self._url_for(endpoint)
-            response = self._session.get(url)
-
-            if response.status_code == 200:
-                diagnostics_data[diag_type.value] = response.json()
-            else:
-                diagnostics_data[diag_type.value] = {
-                    "error": f"Failed to fetch {diag_type.value} diagnostics"
+        for category in categories:
+            value = category.value
+            url = self._url_for("diagnostics", category=value)
+            try:
+                response = self._session.get(url)
+                response.raise_for_status()
+                diagnostics_data[value] = response.json()
+            except httpx.HTTPStatusError:
+                diagnostics_data[value] = {
+                    "error": f"Failed to fetch {value} diagnostics"
                 }
-
         return diagnostics_data
 
     def get_system_health(self) -> dict: