If looking up a resource type fails bypass the cache (#669)

Author: jacobtomlinson

kr8s/_api.py

@@ -341,11 +341,16 @@ async def lookup_kind(self, kind) -> tuple[str, str, bool]:
         """
         return await self.async_lookup_kind(kind)
 
-    async def async_lookup_kind(self, kind) -> tuple[str, str, bool]:
+    async def async_lookup_kind(
+        self, kind, skip_cache: bool = False
+    ) -> tuple[str, str, bool]:
         """Lookup a Kubernetes resource kind."""
         from ._objects import parse_kind
 
-        resources = await self.async_api_resources()
+        if skip_cache:
+            resources = await self.async_api_resources_uncached()
+        else:
+            resources = await self.async_api_resources()
         kind, group, version = parse_kind(kind)
         if group:
             version = f"{group}/{version}"
@@ -367,6 +372,10 @@ async def async_lookup_kind(self, kind) -> tuple[str, str, bool]:
                     resource["name"],
                     resource["namespaced"],
                 )
+
+        if not skip_cache:
+            return await self.async_lookup_kind(kind, skip_cache=True)
+
         raise ValueError(f"Kind {kind} not found.")
 
     @contextlib.asynccontextmanager
@@ -635,6 +644,9 @@ async def api_resources(self) -> list[dict]:
     # https://github.com/kubernetes/cli-runtime/blob/980bedf450ab21617b33d68331786942227fe93a/pkg/genericclioptions/config_flags.go#L297
     @cached(TTLCache(1, 60 * 60 * 6))
     async def async_api_resources(self) -> list[dict]:
+        return await self.async_api_resources_uncached()
+
+    async def async_api_resources_uncached(self) -> list[dict]:
         """Get the Kubernetes API resources."""
         resources = []
         async with self.call_api(method="GET", version="", base="/api") as response:

kr8s/tests/test_api.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: BSD 3-Clause License
 import queue
 import threading
+from contextlib import asynccontextmanager
 from unittest.mock import AsyncMock
 
 import anyio
@@ -18,14 +19,36 @@
 
 @pytest.fixture
 async def example_crd(example_crd_spec):
-    example = await kr8s.asyncio.objects.CustomResourceDefinition(example_crd_spec)
+    async with create_delete_crd(example_crd_spec) as example:
+        yield example
+
+
+@asynccontextmanager
+async def create_delete_crd(spec):
+    example = await kr8s.asyncio.objects.CustomResourceDefinition(spec)
+
+    # Clean up any existing CRD if it exists from a previous failed test run
+    if await example.exists():
+        await example.delete()
+    while await example.exists():
+        await anyio.sleep(0.1)
+
+    # Create the CRD
     if not await example.exists():
         await example.create()
+    while not await example.exists():
+        await anyio.sleep(0.1)
+
+    # Check that the CRD gets returned
     assert example in [
         crd async for crd in kr8s.asyncio.get("customresourcedefinitions")
     ]
     yield example
+
+    # Clean up the CRD
     await example.delete()
+    while await example.exists():
+        await anyio.sleep(0.1)
 
 
 async def test_factory_bypass() -> None:
@@ -497,3 +520,15 @@ async def test_bad_kubernetes_version():
     with pytest.warns(UserWarning):
         await api._check_version()
     api.async_version = keep
+
+
+async def test_crd_caching(example_crd_spec):
+    api = await kr8s.asyncio.api()
+
+    # Populate the cache
+    [r async for r in api.get("pods")]
+
+    # Register a new CRD
+    async with create_delete_crd(example_crd_spec) as example_crd:
+        # Try to get the new CRD (which isn't in the cache, so the cache should be bypassed)
+        [r async for r in api.get(example_crd.name)]