feat: make it possible to also check annotations/labels when matching

Fixes #1392

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java

@@ -1,5 +1,7 @@
 package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
 
+import java.util.Objects;
+
 import io.fabric8.kubernetes.api.model.ConfigMap;
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.api.model.Secret;
@@ -41,8 +43,25 @@ static <R extends HasMetadata, P extends HasMetadata> Matcher<R, P> matcherFor(
 
   @Override
   public Result<R> match(R actualResource, P primary, Context<P> context) {
-    final var objectMapper = ConfigurationServiceProvider.instance().getObjectMapper();
+    return match(dependentResource, actualResource, primary, context, false);
+  }
+
+  public static <R extends HasMetadata, P extends HasMetadata> Result<R> match(
+      KubernetesDependentResource<R, P> dependentResource, R actualResource, P primary,
+      Context<P> context, boolean considerMetadata) {
     final var desired = dependentResource.desired(primary, context);
+    if (considerMetadata) {
+      final var desiredMetadata = desired.getMetadata();
+      final var actualMetadata = actualResource.getMetadata();
+      final var matched =
+          Objects.equals(desiredMetadata.getAnnotations(), actualMetadata.getAnnotations()) &&
+              Objects.equals(desiredMetadata.getLabels(), actualMetadata.getLabels());
+      if (!matched) {
+        return Result.computed(false, desired);
+      }
+    }
+
+    final var objectMapper = ConfigurationServiceProvider.instance().getObjectMapper();
 
     // reflection will be replaced by this:
     // https://github.com/fabric8io/kubernetes-client/issues/3816

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcherTest.java

@@ -31,21 +31,9 @@ static void setUp() {
   void checksIfDesiredValuesAreTheSame() {
     var actual = createDeployment();
     final var desired = createDeployment();
-    final var matcher = GenericKubernetesResourceMatcher.matcherFor(Deployment.class,
-        new KubernetesDependentResource<>(Deployment.class) {
-          @Override
-          protected Deployment desired(HasMetadata primary, Context context) {
-            final var currentCase = Optional.ofNullable(primary)
-                .map(p -> p.getMetadata().getLabels().get("case"))
-                .orElse(null);
-            var d = desired;
-            if ("removed".equals(currentCase)) {
-              d = createDeployment();
-              d.getSpec().getTemplate().getMetadata().getLabels().put("new-key", "val");
-            }
-            return d;
-          }
-        });
+    final var dependentResource = new TestDependentResource(desired);
+    final var matcher =
+        GenericKubernetesResourceMatcher.matcherFor(Deployment.class, dependentResource);
     assertThat(matcher.match(actual, null, context).matched()).isTrue();
     assertThat(matcher.match(actual, null, context).computedDesired().isPresent()).isTrue();
     assertThat(matcher.match(actual, null, context).computedDesired().get()).isEqualTo(desired);
@@ -65,6 +53,21 @@ protected Deployment desired(HasMetadata primary, Context context) {
     assertThat(matcher.match(actual, null, context).matched())
         .withFailMessage("Changed values are not ok")
         .isFalse();
+
+    actual = new DeploymentBuilder(createDeployment())
+        .editOrNewMetadata()
+        .addToAnnotations("test", "value")
+        .endMetadata()
+        .build();
+    assertThat(GenericKubernetesResourceMatcher
+        .match(dependentResource, actual, null, context, false).matched())
+            .withFailMessage("Annotations shouldn't matter when metadata is not considered")
+            .isTrue();
+
+    assertThat(GenericKubernetesResourceMatcher
+        .match(dependentResource, actual, null, context, true).matched())
+            .withFailMessage("Annotations should matter when metadata is not considered")
+            .isFalse();
   }
 
   Deployment createDeployment() {
@@ -79,4 +82,27 @@ HasMetadata createPrimary(String caseName) {
         .endMetadata()
         .build();
   }
+
+  private class TestDependentResource extends KubernetesDependentResource<Deployment, HasMetadata> {
+
+    private final Deployment desired;
+
+    public TestDependentResource(Deployment desired) {
+      super(Deployment.class);
+      this.desired = desired;
+    }
+
+    @Override
+    protected Deployment desired(HasMetadata primary, Context context) {
+      final var currentCase = Optional.ofNullable(primary)
+          .map(p -> p.getMetadata().getLabels().get("case"))
+          .orElse(null);
+      var d = desired;
+      if ("removed".equals(currentCase)) {
+        d = createDeployment();
+        d.getSpec().getTemplate().getMetadata().getLabels().put("new-key", "val");
+      }
+      return d;
+    }
+  }
 }