add debugging and improve reporting

Author: russgold

operator/src/main/java/oracle/kubernetes/operator/helpers/AnnotationHelper.java

@@ -12,6 +12,7 @@
 
 /** Annotates pods, services with details about the Domain instance and checks these annotations. */
 public class AnnotationHelper {
+  private static final boolean DEBUG = true;
   static final String SHA256_ANNOTATION = "weblogic.sha256";
   private static Function<V1Pod, String> HASH_FUNCTION =
       pod -> DigestUtils.sha256Hex(Yaml.dump(pod));
@@ -32,7 +33,9 @@ static void annotateForPrometheus(V1ObjectMeta meta, int httpPort) {
   }
 
   static V1Pod withSha256Hash(V1Pod pod) {
+    String dump = Yaml.dump(pod);
     pod.getMetadata().putAnnotationsItem(SHA256_ANNOTATION, HASH_FUNCTION.apply(pod));
+    if (DEBUG) pod.getMetadata().putAnnotationsItem("hashedString", dump);
     return pod;
   }
 

operator/src/main/java/oracle/kubernetes/operator/helpers/PodCompatibility.java

@@ -18,6 +18,8 @@
 import io.kubernetes.client.models.V1PodSpec;
 import io.kubernetes.client.models.V1Probe;
 import io.kubernetes.client.models.V1ResourceRequirements;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -311,7 +313,7 @@ public String getIncompatibility() {
   }
 
   <T> void addSets(String description, List<T> expected, List<T> actual) {
-    add(new CompatibleSets<>(description, expected, actual));
+    add(CheckFactory.create(description, expected, actual));
   }
 
   protected <T> void add(String description, T expected, T actual) {
@@ -349,6 +351,39 @@ public String getIncompatibility() {
   }
 }
 
+class CheckFactory {
+  static <T> CompatibilityCheck create(String description, List<T> expected, List<T> actual) {
+    if (canBeMap(expected) && canBeMap(actual))
+      return new CompatibleMaps<>(description, asMap(expected), asMap(actual));
+    else return new CompatibleSets<>(description, expected, actual);
+  }
+
+  private static <T> boolean canBeMap(List<T> list) {
+    return asMap(list) != null;
+  }
+
+  private static <T> Map<String, T> asMap(List<T> values) {
+    if (values == null) return null;
+    Map<String, T> result = new HashMap<>();
+    for (T value : values) {
+      String key = getKey(value);
+      if (key == null) return null;
+      result.put(key, value);
+    }
+
+    return result;
+  }
+
+  private static <T> String getKey(T value) {
+    try {
+      Method getKey = value.getClass().getDeclaredMethod("getName");
+      return (String) getKey.invoke(value);
+    } catch (NoSuchMethodException | InvocationTargetException | IllegalAccessException e) {
+      return null;
+    }
+  }
+}
+
 class CompatibleSets<T> implements CompatibilityCheck {
   private String description;
   private final Collection<T> expected;
@@ -398,13 +433,13 @@ public String getIncompatibility() {
 
     Set<K> missingKeys = getMissingElements(expected.keySet(), actual.keySet());
     if (!missingKeys.isEmpty())
-      sb.append(String.format("%s has no entry for %s%n", description, missingKeys));
+      sb.append(String.format("actual %s has no entry for '%s'%n", description, missingKeys));
 
     for (K key : expected.keySet())
       if (actual.containsKey(key) && !Objects.equals(expected.get(key), actual.get(key)))
         sb.append(
             String.format(
-                "%s has entry %s with value %s rather than %s%n",
+                "actual %s has entry '%s' with value '%s' rather than '%s'%n",
                 description, key, actual.get(key), expected.get(key)));
 
     return sb.toString();

operator/src/test/java/oracle/kubernetes/operator/helpers/PodCompatibilityTest.java

@@ -17,6 +17,9 @@
 import io.kubernetes.client.models.V1ContainerPort;
 import io.kubernetes.client.models.V1Probe;
 import io.kubernetes.client.models.V1ResourceRequirements;
+import java.util.Arrays;
+import java.util.Objects;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.junit.Test;
 
 public class PodCompatibilityTest {
@@ -102,6 +105,55 @@ public void whenExpectedNotSubsetOfActual_reportMissingElements() {
     assertThat(check.getIncompatibility(), not(containsString("gamma")));
   }
 
+  @Test
+  public void whenCanBeMapsAndExpectedAndActualDifferentValues_reportChangedElements() {
+    CompatibilityCheck check =
+        CheckFactory.create(
+            "letters",
+            Arrays.asList(object("alpha", 1), object("beta", 2), object("gamma", 3)),
+            Arrays.asList(object("beta", 222), object("gamma", 3), object("alpha", 1)));
+
+    assertThat(check.getIncompatibility(), both(containsString("beta")).and(containsString("222")));
+    assertThat(check.getIncompatibility(), not(containsString("alpha")));
+  }
+
+  private Object object(String name, int value) {
+    return new ObjectWithName(name, value);
+  }
+
+  static class ObjectWithName {
+    private String name;
+    private int value;
+
+    ObjectWithName(String name, int value) {
+      this.name = name;
+      this.value = value;
+    }
+
+    public String getName() {
+      return name;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+      return (o instanceof ObjectWithName) && equals((ObjectWithName) o);
+    }
+
+    private boolean equals(ObjectWithName that) {
+      return value == that.value && Objects.equals(name, that.name);
+    }
+
+    @Override
+    public int hashCode() {
+      return new HashCodeBuilder(17, 37).append(name).append(value).toHashCode();
+    }
+
+    @Override
+    public String toString() {
+      return String.format("<%s = %d>", name, value);
+    }
+  }
+
   @Test
   public void whenExpectedSubmapOfActual_reportCompatible() {
     CompatibilityCheck check =