Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve assertions by showing the last result on a timeout #13119

Merged
merged 3 commits into from
Feb 4, 2025
Merged

improve assertions by showing the last result on a timeout #13119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c0c06e
improve assertions by showing the last result on a timeout
zeitlinger Jan 28, 2025
d8708df
cleanup
zeitlinger Jan 29, 2025
b19f64b
cleanup
zeitlinger Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 59 additions & 39 deletions ...mon/src/main/java/io/opentelemetry/instrumentation/testing/InstrumentationTestRunner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import io.opentelemetry.sdk.testing.assertj.TraceAssert;
import io.opentelemetry.sdk.testing.assertj.TracesAssert;
import io.opentelemetry.sdk.trace.data.SpanData;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
Expand All @@ -29,6 +30,7 @@
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.assertj.core.api.ListAssert;
import org.awaitility.core.ConditionFactory;
import org.awaitility.core.ConditionTimeoutException;

/**
Expand Down Expand Up @@ -118,25 +120,7 @@ private <T extends Consumer<TraceAssert>> void waitAndAssertTraces(
List<T> assertionsList = new ArrayList<>();
assertions.forEach(assertionsList::add);

try {
await()
.untilAsserted(() -> doAssertTraces(traceComparator, assertionsList, verifyScopeVersion));
} catch (Throwable t) {
// awaitility is doing a jmx call that is not implemented in GraalVM:
// call:
// https://github.com/awaitility/awaitility/blob/fbe16add874b4260dd240108304d5c0be84eabc8/awaitility/src/main/java/org/awaitility/core/ConditionAwaiter.java#L157
// see https://github.com/oracle/graal/issues/6101 (spring boot graal native image)
if (t.getClass().getName().equals("com.oracle.svm.core.jdk.UnsupportedFeatureError")
|| t instanceof ConditionTimeoutException) {
// Don't throw this failure since the stack is the awaitility thread, causing confusion.
// Instead, just assert one more time on the test thread, which will fail with a better
// stack trace.
// TODO: There is probably a better way to do this.
doAssertTraces(traceComparator, assertionsList, verifyScopeVersion);
} else {
throw t;
}
}
awaitUntilAsserted(() -> doAssertTraces(traceComparator, assertionsList, verifyScopeVersion));
}

private <T extends Consumer<TraceAssert>> void doAssertTraces(
Expand All @@ -159,31 +143,42 @@ private <T extends Consumer<TraceAssert>> void doAssertTraces(
*/
public final void waitAndAssertMetrics(
String instrumentationName, String metricName, Consumer<ListAssert<MetricData>> assertion) {
await()
.untilAsserted(
() ->
assertion.accept(
assertThat(getExportedMetrics())
.filteredOn(
data ->
data.getInstrumentationScopeInfo()
.getName()
.equals(instrumentationName)
&& data.getName().equals(metricName))));

awaitUntilAsserted(
() ->
assertion.accept(
assertThat(getExportedMetrics())
.describedAs(
"Metrics for instrumentation %s and metric name %s",
instrumentationName, metricName)
.filteredOn(
data ->
data.getInstrumentationScopeInfo().getName().equals(instrumentationName)
&& data.getName().equals(metricName))));
}

@SafeVarargs
public final void waitAndAssertMetrics(
String instrumentationName, Consumer<MetricAssert>... assertions) {
await()
.untilAsserted(
() -> {
Collection<MetricData> metrics = instrumentationMetrics(instrumentationName);
assertThat(metrics).isNotEmpty();
for (Consumer<MetricAssert> assertion : assertions) {
assertThat(metrics).anySatisfy(metric -> assertion.accept(assertThat(metric)));
}
});
awaitUntilAsserted(
() -> {
Collection<MetricData> metrics = instrumentationMetrics(instrumentationName);
assertThat(metrics).isNotEmpty();
for (int i = 0; i < assertions.length; i++) {
int index = i;
assertThat(metrics)
.describedAs(
"Metrics for instrumentation %s and assertion %d", instrumentationName, index)
.anySatisfy(metric -> assertions[index].accept(assertThat(metric)));
}
});
}

public final List<LogRecordData> waitForLogRecords(int numberOfLogRecords) {
awaitUntilAsserted(
() -> assertThat(getExportedLogRecords().size()).isEqualTo(numberOfLogRecords),
await().timeout(Duration.ofSeconds(20)));
return getExportedLogRecords();
}

private List<MetricData> instrumentationMetrics(String instrumentationName) {
Expand Down Expand Up @@ -265,4 +260,29 @@ public final <T, E extends Throwable> T runWithNonRecordingSpan(ThrowingSupplier
throws E {
return testInstrumenters.runWithNonRecordingSpan(callback);
}

private static void awaitUntilAsserted(Runnable runnable) {
awaitUntilAsserted(runnable, await());
}

private static void awaitUntilAsserted(Runnable runnable, ConditionFactory conditionFactory) {
try {
conditionFactory.untilAsserted(runnable::run);
} catch (Throwable t) {
// awaitility is doing a jmx call that is not implemented in GraalVM:
// call:
// https://github.com/awaitility/awaitility/blob/fbe16add874b4260dd240108304d5c0be84eabc8/awaitility/src/main/java/org/awaitility/core/ConditionAwaiter.java#L157
// see https://github.com/oracle/graal/issues/6101 (spring boot graal native image)
if (t.getClass().getName().equals("com.oracle.svm.core.jdk.UnsupportedFeatureError")
|| t instanceof ConditionTimeoutException) {
// Don't throw this failure since the stack is the awaitility thread, causing confusion.
// Instead, just assert one more time on the test thread, which will fail with a better
// stack trace - that is on the same thread as the test.
// TODO: There is probably a better way to do this.
runnable.run();
} else {
throw t;
}
}
}
}
10 changes: 1 addition & 9 deletions ...rc/main/java/io/opentelemetry/instrumentation/testing/junit/InstrumentationExtension.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package io.opentelemetry.instrumentation.testing.junit;

import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
import static org.awaitility.Awaitility.await;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.context.ContextStorage;
Expand All @@ -22,7 +21,6 @@
import io.opentelemetry.sdk.testing.assertj.MetricAssert;
import io.opentelemetry.sdk.testing.assertj.TraceAssert;
import io.opentelemetry.sdk.trace.data.SpanData;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
Expand Down Expand Up @@ -125,13 +123,7 @@ public List<List<SpanData>> waitForTraces(int numberOfTraces) {
* This waits up to 20 seconds, then times out.
*/
public List<LogRecordData> waitForLogRecords(int numberOfLogRecords) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Firstly I think you should update the PR title or description to make it easier to understand what you are doing. As far as I can tell the improvement is that you are making metric and log assertion similar to trace assertion.
WDYT about moving the log assertion logic to InstrumentationTestRunner as it is for traces/metrics. Then you would not need the AwaitUtil class and could have the helper method in InstrumentationTestRunner.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point @laurit - fixed

await()
.timeout(Duration.ofSeconds(20))
.untilAsserted(
() ->
assertThat(testRunner.getExportedLogRecords().size())
.isEqualTo(numberOfLogRecords));
return testRunner.getExportedLogRecords();
return testRunner.waitForLogRecords(numberOfLogRecords);
}

@SafeVarargs
Expand Down