Merge pull request #2678 from HubSpot/namespace-key-func

fabric8io · Dec 18, 2020 · edc20a5 · edc20a5
2 parents da8e084 + 84f9210
commit edc20a5
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@
 * Fix #2656: Binding operations can be instantiated
 
 #### Improvements
+* Fix: Adds a convenience method for referring to Cache keys by namespace and name rather than item
 * Fix: CustomResourceDefinitionContext.fromCrd support for v1 CustomResourceDefinition
 * Fix #2642: Update kubernetes-examples to use apps/v1 Deployment rather than extensions/v1beta1
 

diff --git a/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/informers/cache/Cache.java b/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/informers/cache/Cache.java
@@ -17,6 +17,7 @@
 
 import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.fabric8.kubernetes.client.utils.ReflectUtils;
+import io.fabric8.kubernetes.client.utils.Utils;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -400,15 +401,25 @@ public static String metaNamespaceKeyFunc(Object obj) {
           throw new RuntimeException("Object is bad :" + obj);
         }
       }
-      if ((metadata.getNamespace() != null) && !metadata.getNamespace().isEmpty()) {
-        return metadata.getNamespace() + "/" + metadata.getName();
-      }
-      return metadata.getName();
+
+      return namespaceKeyFunc(metadata.getNamespace(), metadata.getName());
     } catch (ReflectiveOperationException e) {
       throw new RuntimeException(e);
     }
   }
 
+  /**
+   * Default index function that indexes based on an object's namespace and name.
+   *
+   * @see #metaNamespaceKeyFunc
+   */
+  public static String namespaceKeyFunc(String objectNamespace, String objectName) {
+    if (Utils.isNullOrEmpty(objectNamespace)) {
+      return objectName;
+    }
+    return objectNamespace + "/" + objectName;
+  }
+
   /**
    * It is a default index function that indexes based on an object's namespace
    *

diff --git a/kubernetes-client/src/test/java/io/fabric8/kubernetes/client/informers/cache/CacheTest.java b/kubernetes-client/src/test/java/io/fabric8/kubernetes/client/informers/cache/CacheTest.java
@@ -88,6 +88,13 @@ void testDefaultNamespaceKey() {
 
     cache.add(testPodObj);
     assertEquals("default/test-pod4", Cache.metaNamespaceKeyFunc(testPodObj));
+    assertEquals("default/test-pod4", Cache.namespaceKeyFunc("default", "test-pod4"));
+  }
+
+  @Test
+  void testEmptyNamespaceKey() {
+    assertEquals("test-pod4", Cache.namespaceKeyFunc("", "test-pod4"));
+    assertEquals("test-pod4", Cache.namespaceKeyFunc(null, "test-pod4"));
   }
 
   @Test