tests: add integration test for meter cleaning

Author: metacosm

micrometer-support/pom.xml

@@ -26,6 +26,37 @@
       <groupId>io.javaoperatorsdk</groupId>
       <artifactId>operator-framework-core</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+    <groupId>org.awaitility</groupId>
+    <artifactId>awaitility</artifactId>
+    <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>io.javaoperatorsdk</groupId>
+      <artifactId>operator-framework-junit-5</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
 </project>

micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetrics.java

@@ -222,4 +222,8 @@ private void incrementCounter(ResourceID id, String counterName, Map<String, Obj
     metersPerResource.computeIfAbsent(id, resourceID -> new HashSet<>()).add(counter.getId());
     counter.increment();
   }
+
+  protected Set<Meter.Id> recordedMeterIdsFor(ResourceID resourceID) {
+    return metersPerResource.get(resourceID);
+  }
 }

micrometer-support/src/test/java/io/javaoperatorsdk/operator/monitoring/micrometer/MetricsCleaningOnDeleteIT.java

@@ -0,0 +1,88 @@
+package io.javaoperatorsdk.operator.monitoring.micrometer;
+
+import java.util.concurrent.TimeUnit;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.fabric8.kubernetes.api.model.ConfigMap;
+import io.fabric8.kubernetes.api.model.ConfigMapBuilder;
+import io.javaoperatorsdk.operator.api.config.ConfigurationServiceProvider;
+import io.javaoperatorsdk.operator.api.reconciler.*;
+import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.micrometer.core.instrument.MeterRegistry;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+import static org.mockito.Mockito.mock;
+
+public class MetricsCleaningOnDeleteIT {
+  @RegisterExtension
+  static LocallyRunOperatorExtension operator =
+      LocallyRunOperatorExtension.builder().withReconciler(new MetricsCleaningTestReconciler())
+          .build();
+
+  private static final MeterRegistry mockRegistry = mock(MeterRegistry.class);
+  private static final int testDelay = 15;
+  private static final TestMetrics metrics = new TestMetrics(mockRegistry, testDelay);
+  private static final String testResourceName = "cleaning-metrics-cr";
+
+  @BeforeAll
+  static void setup() {
+    ConfigurationServiceProvider.overrideCurrent(
+        overrider -> overrider.withMetrics(new TestMetrics(mockRegistry, testDelay)));
+  }
+
+  @AfterAll
+  static void reset() {
+    ConfigurationServiceProvider.reset();
+  }
+
+  @Test
+  void addsFinalizerAndCallsCleanupIfCleanerImplemented() {
+    var testResource = new ConfigMapBuilder()
+        .withNewMetadata()
+        .withName(testResourceName)
+        .endMetadata()
+        .build();
+    final var created = operator.create(testResource);
+
+    var meters = metrics.recordedMeterIdsFor(ResourceID.fromResource(created));
+    assertThat(meters).isNotNull();
+    assertThat(meters).isNotEmpty();
+
+    await().until(() -> !operator.get(ConfigMap.class, testResourceName)
+        .getMetadata().getFinalizers().isEmpty());
+
+    operator.delete(testResource);
+
+    await().until(() -> operator.get(ConfigMap.class, testResourceName) == null);
+
+    await().atLeast(testDelay + 3, TimeUnit.SECONDS);
+    meters = metrics.recordedMeterIdsFor(ResourceID.fromResource(created));
+    assertThat(meters).isNull();
+  }
+
+  private static class MetricsCleaningTestReconciler
+      implements Reconciler<ConfigMap>, Cleaner<ConfigMap> {
+    @Override
+    public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap> context) {
+      return UpdateControl.noUpdate();
+    }
+
+    @Override
+    public DeleteControl cleanup(ConfigMap resource, Context<ConfigMap> context) {
+      return DeleteControl.defaultDelete();
+    }
+  }
+
+  private static class TestMetrics extends MicrometerMetrics {
+
+    public TestMetrics(MeterRegistry registry, int cleanUpDelayInSeconds) {
+      super(registry, cleanUpDelayInSeconds);
+    }
+  }
+}