Add hasAnObservationWithAKeyValue() variant with KeyValue (#4040)

See gh-4038
micrometer-metrics · Aug 21, 2023 · a56b968 · a56b968
1 parent a2ad7e1
commit a56b968
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/...ation-test/src/main/java/io/micrometer/observation/tck/TestObservationRegistryAssert.java b/...ation-test/src/main/java/io/micrometer/observation/tck/TestObservationRegistryAssert.java
@@ -15,6 +15,7 @@
  */
 package io.micrometer.observation.tck;
 
+import io.micrometer.common.KeyValue;
 import io.micrometer.common.docs.KeyName;
 import io.micrometer.observation.Observation;
 import org.assertj.core.api.ThrowingConsumer;
@@ -345,6 +346,25 @@ public TestObservationRegistryAssert hasAnObservationWithAKeyValue(String key, S
         return this;
     }
 
+    /**
+     * Verifies that there is an Observation with a key value.
+     * <p>
+     * Examples: <pre><code class='java'>
+     * // assertions succeed
+     * assertThat(testObservationRegistry).hasAnObservationWithAKeyValue(KeyValue.of("foo", "bar"));
+     *
+     * // assertions fail - assuming that there is no such a key value in any observation
+     * assertThat(testObservationRegistry).hasAnObservationWithAKeyValue(KeyValue.of("foo", "bar"));</code></pre>
+     * @param keyValue expected key value
+     * @return {@code this} assertion object.
+     * @throws AssertionError if the actual value is {@code null}.
+     * @throws AssertionError if there is no Observation with given key name and value
+     * @since 1.12.0
+     */
+    public TestObservationRegistryAssert hasAnObservationWithAKeyValue(KeyValue keyValue) {
+        return hasAnObservationWithAKeyValue(keyValue.getKey(), keyValue.getValue());
+    }
+
     /**
      * Verifies that there is an Observation with a key name.
      * <p>

diff --git a/...-test/src/test/java/io/micrometer/observation/tck/TestObservationRegistryAssertTests.java b/...-test/src/test/java/io/micrometer/observation/tck/TestObservationRegistryAssertTests.java
@@ -15,6 +15,7 @@
  */
 package io.micrometer.observation.tck;
 
+import io.micrometer.common.KeyValue;
 import io.micrometer.common.docs.KeyName;
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationRegistry;
@@ -306,6 +307,9 @@ void should_fail_when_key_value_not_matched() {
         thenThrownBy(
                 () -> TestObservationRegistryAssert.assertThat(registry).hasAnObservationWithAKeyValue("key", "value"))
             .isInstanceOf(AssertionError.class);
+
+        thenThrownBy(() -> TestObservationRegistryAssert.assertThat(registry)
+            .hasAnObservationWithAKeyValue(KeyValue.of("key", "value"))).isInstanceOf(AssertionError.class);
     }
 
     @Test
@@ -314,6 +318,9 @@ void should_not_fail_when_key_value_matched() {
 
         thenNoException().isThrownBy(
                 () -> TestObservationRegistryAssert.assertThat(registry).hasAnObservationWithAKeyValue("foo", "bar"));
+
+        thenNoException().isThrownBy(() -> TestObservationRegistryAssert.assertThat(registry)
+            .hasAnObservationWithAKeyValue(KeyValue.of("foo", "bar")));
     }
 
     @Test