Skip to content

Commit

Permalink
Use failWithActualExpectedAndMessage() where possible
Browse files Browse the repository at this point in the history 
See micrometer-metricsgh-5550
  • Loading branch information
@izeye
izeye committed Nov 21, 2024
1 parent be70882 commit 850012b
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 31 deletions.
6 changes: 4 additions & 2 deletions ...bservation-test/src/main/java/io/micrometer/observation/tck/ObservationContextAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,8 @@ public SELF hasKeyValuesCount(int size) {
isNotNull();
long actualSize = this.actual.getAllKeyValues().stream().count();
if (actualSize != size) {
failWithMessage("Observation expected to have <%s> keys but has <%s>.", size, actualSize);
failWithActualExpectedAndMessage(actualSize, size, "Observation expected to have <%s> keys but has <%s>.",
size, actualSize);
}
return (SELF) this;
}
Expand Down Expand Up @@ -388,7 +389,8 @@ public SELF hasMapEntry(Object key, Object value) {
isNotNull();
Object mapValue = this.actual.get(key);
if (!Objects.equals(mapValue, value)) {
failWithMessage("Observation should have an entry for key <%s> with value <%s>. Value was <%s>", key, value,
failWithActualExpectedAndMessage(mapValue, value,
"Observation should have an entry for key <%s> with value <%s>. Value was <%s>", key, value,
mapValue);
}
return (SELF) this;
Expand Down
17 changes: 12 additions & 5 deletions ...servation-test/src/main/java/io/micrometer/observation/tck/ObservationRegistryAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,14 @@ public SELF doesNotHaveRemainingCurrentObservationSameAs(Observation observation
public SELF hasRemainingCurrentObservationSameAs(Observation observation) {
isNotNull();
Observation current = actual.getCurrentObservation();
if (current == null) {
failWithMessage(
"Expected current observation in the registry to be same as <%s> but there was no current observation",
observation);
}
if (current != observation) {
failWithMessage("Expected current observation in the registry to be same as <%s> but was <%s>", observation,
failWithActualExpectedAndMessage(current, observation,
"Expected current observation in the registry to be same as <%s> but was <%s>", observation,
current);
}
return (SELF) this;
Expand Down Expand Up @@ -183,16 +189,17 @@ public SELF doesNotHaveRemainingCurrentScopeSameAs(Observation.Scope scope) {
public SELF hasRemainingCurrentScopeSameAs(Observation.Scope scope) {
isNotNull();
Observation.Scope current = actual.getCurrentObservationScope();
String expectedContextName = scope.getCurrentObservation().getContext().getName();
if (current == null) {
failWithMessage(
"Expected current Scope in the registry to be same as a provided Scope tied to observation named <%s> but there was no current scope",
scope.getCurrentObservation().getContext().getName());
expectedContextName);
}
if (current != scope) {
failWithMessage(
String actualContextName = current.getCurrentObservation().getContext().getName();
failWithActualExpectedAndMessage(actualContextName, expectedContextName,
"Expected current Scope in the registry to be same as a provided Scope tied to observation named <%s> but was a different one (tied to observation named <%s>)",
scope.getCurrentObservation().getContext().getName(),
current.getCurrentObservation().getContext().getName());
expectedContextName, actualContextName);
}
return (SELF) this;
}
Expand Down
24 changes: 13 additions & 11 deletions ...ation-test/src/main/java/io/micrometer/observation/tck/TestObservationRegistryAssert.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,11 @@ public TestObservationRegistryAssert forAllObservationsWithNameEqualToIgnoreCase
*/
public TestObservationRegistryAssert hasNumberOfObservationsEqualTo(int expectedNumberOfObservations) {
isNotNull();
if (this.actual.getContexts().size() != expectedNumberOfObservations) {
failWithMessage("There should be <%s> Observations but there were <%s>. Found following Observations:\n%s",
expectedNumberOfObservations, this.actual.getContexts().size(),
int actualNumberOfObservations = this.actual.getContexts().size();
if (actualNumberOfObservations != expectedNumberOfObservations) {
failWithActualExpectedAndMessage(actualNumberOfObservations, expectedNumberOfObservations,
"There should be <%s> Observations but there were <%s>. Found following Observations:\n%s",
expectedNumberOfObservations, actualNumberOfObservations,
observationNames(this.actual.getContexts()));
}
return this;
Expand All @@ -268,14 +270,14 @@ public TestObservationRegistryAssert hasNumberOfObservationsEqualTo(int expected
public TestObservationRegistryAssert hasNumberOfObservationsWithNameEqualTo(String observationName,
int expectedNumberOfObservations) {
isNotNull();
long observationsWithNameSize = this.actual.getContexts()
long actualNumberOfObservations = this.actual.getContexts()
.stream()
.filter(f -> observationName.equals(f.getContext().getName()))
.count();
if (observationsWithNameSize != expectedNumberOfObservations) {
failWithMessage(
if (actualNumberOfObservations != expectedNumberOfObservations) {
failWithActualExpectedAndMessage(actualNumberOfObservations, expectedNumberOfObservations,
"There should be <%s> Observations with name <%s> but there were <%s>. Found following Observations:\n%s",
expectedNumberOfObservations, observationName, observationsWithNameSize,
expectedNumberOfObservations, observationName, actualNumberOfObservations,
observationNames(this.actual.getContexts()));
}
return this;
Expand All @@ -302,14 +304,14 @@ public TestObservationRegistryAssert hasNumberOfObservationsWithNameEqualTo(Stri
public TestObservationRegistryAssert hasNumberOfObservationsWithNameEqualToIgnoreCase(String observationName,
int expectedNumberOfObservations) {
isNotNull();
long observationsWithNameSize = this.actual.getContexts()
long actualNumberOfObservations = this.actual.getContexts()
.stream()
.filter(f -> observationName.equalsIgnoreCase(f.getContext().getName()))
.count();
if (observationsWithNameSize != expectedNumberOfObservations) {
failWithMessage(
if (actualNumberOfObservations != expectedNumberOfObservations) {
failWithActualExpectedAndMessage(actualNumberOfObservations, expectedNumberOfObservations,
"There should be <%s> Observations with name (ignoring case) <%s> but there were <%s>. Found following Observations:\n%s",
expectedNumberOfObservations, observationName, observationsWithNameSize,
expectedNumberOfObservations, observationName, actualNumberOfObservations,
observationNames(this.actual.getContexts()));
}
return this;
Expand Down
18 changes: 15 additions & 3 deletions ...ation-test/src/test/java/io/micrometer/observation/tck/ObservationContextAssertTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,18 @@ void should_throw_exception_when_key_count_differs() {
observation.highCardinalityKeyValue("high", "bar");

thenThrownBy(() -> assertThat(context).hasKeyValuesCount(1)).isInstanceOf(AssertionError.class)
.hasMessage("Observation expected to have <1> keys but has <2>.");
.hasMessage("Observation expected to have <1> keys but has <2>.")
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("2");
then(error.getExpected().getStringRepresentation()).isEqualTo("1");
});

thenThrownBy(() -> assertThat(context).hasKeyValuesCount(3)).isInstanceOf(AssertionError.class)
.hasMessage("Observation expected to have <3> keys but has <2>.");
.hasMessage("Observation expected to have <3> keys but has <2>.")
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("2");
then(error.getExpected().getStringRepresentation()).isEqualTo("3");
});
}

@Test
Expand Down Expand Up @@ -414,7 +422,11 @@ void should_throw_exception_when_tags_present() {
void should_throw_exception_when_map_entry_missing() {
context.put("foo", "bar");

thenThrownBy(() -> assertThat(context).hasMapEntry("foo", "baz")).isInstanceOf(AssertionError.class);
thenThrownBy(() -> assertThat(context).hasMapEntry("foo", "baz"))
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("bar");
then(error.getExpected().getStringRepresentation()).isEqualTo("baz");
});
}

@Test
Expand Down
23 changes: 20 additions & 3 deletions ...tion-test/src/test/java/io/micrometer/observation/tck/ObservationRegistryAssertTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@
import io.micrometer.observation.ObservationRegistry;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.opentest4j.AssertionFailedError;

import static org.assertj.core.api.Assertions.*;
import static org.assertj.core.api.BDDAssertions.then;

@SuppressWarnings("rawtypes")
class ObservationRegistryAssertTests {
Expand Down Expand Up @@ -76,7 +78,17 @@ void assertionErrorThrownWhenRemainingObservationNotSameAs() {

assertThatThrownBy(() -> this.registryAssert.hasRemainingCurrentObservationSameAs(observation))
.isInstanceOf(AssertionError.class)
.hasMessageContaining("Expected current observation in the registry to be same as <{name=foo");
.hasMessageContaining("but there was no current observation");

Observation anotherObservation = Observation.start("bar", this.registry);
try (Observation.Scope scope = anotherObservation.openScope()) {
assertThatThrownBy(() -> this.registryAssert.hasRemainingCurrentObservationSameAs(observation))
.hasMessageContaining("Expected current observation in the registry to be same as <{name=foo")
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).contains("bar");
then(error.getExpected().getStringRepresentation()).contains("foo");
});
}
}

@Test
Expand Down Expand Up @@ -148,11 +160,16 @@ void failsHasRemainingCurrentScopeSameAs() {
Observation.Scope scope1 = o1.openScope();
scope1.close();
try (Observation.Scope scope2 = o2.openScope()) {
assertThatExceptionOfType(AssertionError.class)
assertThatExceptionOfType(AssertionFailedError.class)
.isThrownBy(() -> this.registryAssert.hasRemainingCurrentScopeSameAs(scope1))
.withMessage(
"Expected current Scope in the registry to be same as a provided Scope tied to observation named <old>"
+ " but was a different one (tied to observation named <new>)");
+ " but was a different one (tied to observation named <new>)")
.satisfies(error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("new");
then(error.getExpected().getStringRepresentation()).isEqualTo("old");
});
;
}
}

Expand Down
32 changes: 25 additions & 7 deletions ...-test/src/test/java/io/micrometer/observation/tck/TestObservationRegistryAssertTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@
import org.assertj.core.api.BDDAssertions;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.Test;
import org.opentest4j.AssertionFailedError;

import java.time.Duration;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.BDDAssertions.thenNoException;
import static org.assertj.core.api.BDDAssertions.thenThrownBy;
import static org.assertj.core.api.BDDAssertions.*;
import static org.assertj.core.api.BDDAssertions.then;

class TestObservationRegistryAssertTests {

Expand Down Expand Up @@ -228,7 +229,12 @@ void should_not_fail_when_all_observations_match_the_assertion_ignore_case() {
void should_fail_when_number_of_observations_does_not_match() {
Observation.createNotStarted("FOO", registry).start().stop();

thenThrownBy(() -> assertThat(registry).hasNumberOfObservationsEqualTo(0)).isInstanceOf(AssertionError.class);
thenThrownBy(() -> assertThat(registry).hasNumberOfObservationsEqualTo(0))
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("1");
then(error.getExpected().getStringRepresentation()).isEqualTo("0");
});
;
}

@Test
Expand All @@ -243,15 +249,21 @@ void should_fail_when_names_match_but_number_is_incorrect() {
Observation.createNotStarted("foo", registry).start().stop();

thenThrownBy(() -> assertThat(registry).hasNumberOfObservationsWithNameEqualTo("foo", 0))
.isInstanceOf(AssertionError.class);
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("1");
then(error.getExpected().getStringRepresentation()).isEqualTo("0");
});
}

@Test
void should_fail_when_number_is_correct_but_names_do_not_match() {
Observation.createNotStarted("foo", registry).start().stop();

thenThrownBy(() -> assertThat(registry).hasNumberOfObservationsWithNameEqualTo("bar", 1))
.isInstanceOf(AssertionError.class);
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("0");
then(error.getExpected().getStringRepresentation()).isEqualTo("1");
});
}

@Test
Expand All @@ -266,15 +278,21 @@ void should_fail_when_names_match_but_number_is_incorrect_ignore_case() {
Observation.createNotStarted("FOO", registry).start().stop();

thenThrownBy(() -> assertThat(registry).hasNumberOfObservationsWithNameEqualToIgnoreCase("foo", 0))
.isInstanceOf(AssertionError.class);
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("1");
then(error.getExpected().getStringRepresentation()).isEqualTo("0");
});
}

@Test
void should_fail_when_number_is_correct_but_names_do_not_match_ignore_case() {
Observation.createNotStarted("FOO", registry).start().stop();

thenThrownBy(() -> assertThat(registry).hasNumberOfObservationsWithNameEqualToIgnoreCase("bar", 1))
.isInstanceOf(AssertionError.class);
.isInstanceOfSatisfying(AssertionFailedError.class, error -> {
then(error.getActual().getStringRepresentation()).isEqualTo("0");
then(error.getExpected().getStringRepresentation()).isEqualTo("1");
});
}

@Test
Expand Down

0 comments on commit 850012b

Please sign in to comment.