Skip to content

test(showcase): migrate Thread.sleep calls to Awaitility #13728

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

Open
blakeli0 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

test(showcase): migrate Thread.sleep calls to Awaitility #13728

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
c02a747
chore(showcase): migrate Thread.sleep calls to Awaitility
blakeli0 Jul 10, 2026
d9b0c5c
chore(showcase): remove explicit awaitility version
blakeli0 Jul 10, 2026
2ecd810
chore(ci): exclude java-showcase from bulk unit tests
blakeli0 Jul 10, 2026
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
4 changes: 2 additions & 2 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ jobs:
workflows:
- '.github/workflows/**'
src:
- '!(google-auth-library-java|grpc-gcp-java|java-bigquery|java-bigquery-jdbc|java-bigquerystorage|java-bigtable|java-cloud-bom|java-datastore|java-firestore|java-logging|java-logging-logback|java-pubsub|java-shared-config|java-spanner|java-storage)/**/*.java'
- '!(google-auth-library-java|grpc-gcp-java|java-bigquery|java-bigquery-jdbc|java-bigquerystorage|java-bigtable|java-cloud-bom|java-datastore|java-firestore|java-logging|java-logging-logback|java-pubsub|java-shared-config|java-spanner|java-storage)/**/pom.xml'
- '!(google-auth-library-java|grpc-gcp-java|java-bigquery|java-bigquery-jdbc|java-bigquerystorage|java-bigtable|java-cloud-bom|java-datastore|java-firestore|java-logging|java-logging-logback|java-pubsub|java-shared-config|java-showcase|java-spanner|java-storage)/**/*.java'
- '!(google-auth-library-java|grpc-gcp-java|java-bigquery|java-bigquery-jdbc|java-bigquerystorage|java-bigtable|java-cloud-bom|java-datastore|java-firestore|java-logging|java-logging-logback|java-pubsub|java-shared-config|java-showcase|java-spanner|java-storage)/**/pom.xml'
- 'pom.xml'
ci:
- '.github/workflows/ci.yaml'
Expand Down
6 changes: 6 additions & 0 deletions java-showcase/gapic-showcase/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,12 @@
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.awaitility</groupId>
<artifactId>awaitility</artifactId>
<scope>test</scope>
</dependency>

</dependencies>
<profiles>
<profile>
Expand Down
9 changes: 3 additions & 6 deletions ...howcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITClientShutdown.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,9 @@ private void assertClientTerminated(EchoClient echoClient) throws InterruptedExc
// check that everything is properly terminated after close() is called.
echoClient.close();

// Loop until the client has terminated successfully. For tests that use this,
// try to ensure there is a timeout associated, otherwise this may run forever.
// Future enhancement: Use awaitility instead of busy waiting
while (!echoClient.isTerminated()) {
Thread.sleep(500L);
}
org.awaitility.Awaitility.await()
.atMost(java.time.Duration.ofMillis(DEFAULT_CLIENT_TERMINATION_MS))
.until(echoClient::isTerminated);
// The busy-wait time won't be accurate, so account for a bit of buffer
long end = System.currentTimeMillis();

Expand Down
10 changes: 5 additions & 5 deletions ...owcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITCompositeTracer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,11 @@
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
import java.time.Duration;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -124,13 +126,11 @@ void testCompositeTracer() throws Exception {
.get(AttributeKey.stringKey(ObservabilityAttributes.SERVER_ADDRESS_ATTRIBUTE)))
.isEqualTo(SHOWCASE_SERVER_ADDRESS);

Thread.sleep(100);
// Verify metric name and one basic attribute server.address
Awaitility.await()
.atMost(Duration.ofSeconds(10))
.until(() -> !metricReader.collectAllMetrics().isEmpty());
Collection<MetricData> actualMetrics = metricReader.collectAllMetrics();
Comment thread
blakeli0 marked this conversation as resolved.
for (int i = 0; i < 10 && actualMetrics.isEmpty(); i++) {
Thread.sleep(1000L);
actualMetrics = metricReader.collectAllMetrics();
}

assertThat(actualMetrics).isNotEmpty();
MetricData metricData =
Expand Down
32 changes: 16 additions & 16 deletions ...case/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelGoldenMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
import java.io.InputStream;
import java.time.Duration;
import java.util.Collection;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -106,8 +107,7 @@ void testMetrics_successfulEcho_grpc() throws Exception {
// This is implemented by adding a TraceFinisher to ApiFuture as a callback in
// TracedUnaryCallable,
// which could be executed in a different thread.
Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).isNotEmpty();

MetricData durationMetric =
Expand Down Expand Up @@ -192,8 +192,7 @@ public void sendMessage(ReqT message) {}
UnavailableException.class,
() -> client.echo(EchoRequest.newBuilder().setContent("metrics-test").build()));

Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).isNotEmpty();

MetricData durationMetric =
Expand Down Expand Up @@ -224,8 +223,7 @@ void testMetrics_successfulEcho_httpjson() throws Exception {

client.echo(EchoRequest.newBuilder().setContent("metrics-test").build());

Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).isNotEmpty();

MetricData durationMetric =
Expand Down Expand Up @@ -366,8 +364,7 @@ public String getHeaderValue(int index) {
UnavailableException.class,
() -> client.echo(EchoRequest.newBuilder().setContent("metrics-test").build()));

Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).isNotEmpty();

MetricData durationMetric =
Expand Down Expand Up @@ -415,8 +412,7 @@ void testMetrics_clientTimeout_grpc() throws Exception {
Exception.class,
() -> client.echo(EchoRequest.newBuilder().setContent("metrics-test").build()));

Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).isNotEmpty();

MetricData durationMetric =
Expand Down Expand Up @@ -458,8 +454,7 @@ void testMetrics_clientTimeout_httpjson() throws Exception {
Exception.class,
() -> client.echo(EchoRequest.newBuilder().setContent("metrics-test").build()));

Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).isNotEmpty();

MetricData durationMetric =
Expand Down Expand Up @@ -538,8 +533,7 @@ public void sendMessage(ReqT message) {}

assertThat(attemptCount.get()).isEqualTo(3);

Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).hasSize(1);

MetricData durationMetric =
Expand Down Expand Up @@ -709,8 +703,7 @@ public String getHeaderValue(int index) {

assertThat(requestCount.get()).isEqualTo(3);

Thread.sleep(100);
Collection<MetricData> metrics = metricReader.collectAllMetrics();
Collection<MetricData> metrics = waitAndCollectMetrics();
assertThat(metrics).hasSize(1);

MetricData durationMetric =
Expand All @@ -730,4 +723,11 @@ public String getHeaderValue(int index) {
.isEqualTo("OK");
}
}

private Collection<MetricData> waitAndCollectMetrics() {
Awaitility.await()
.atMost(Duration.ofSeconds(5))
.until(() -> !metricReader.collectAllMetrics().isEmpty());
return metricReader.collectAllMetrics();
Comment thread
blakeli0 marked this conversation as resolved.
}
}
38 changes: 22 additions & 16 deletions java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
import java.util.concurrent.TimeUnit;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
Expand Down Expand Up @@ -290,24 +291,29 @@ private List<MetricData> getMetricDataList() throws InterruptedException {
}

/**
* Attempts to retrieve the metrics from a custom InMemoryMetricsReader. Sleep every second for at
* most 10s to try and retrieve all the metrics available. If it is unable to retrieve all the
* metrics, fail the test.
* Attempts to retrieve the metrics from a custom InMemoryMetricsReader. Polls for at most 10s to
* try and retrieve all the metrics available. If it is unable to retrieve all the metrics, fail
* the test.
*/
private List<MetricData> getMetricDataList(InMemoryMetricReader metricReader)
throws InterruptedException {
for (int i = 0; i < NUM_DEFAULT_FLUSH_ATTEMPTS; i++) {
Thread.sleep(1000L);
List<MetricData> metricData = new ArrayList<>(metricReader.collectAllMetrics());
// Depending on the OpenTelemetry instance (i.e. OpenTelemetry, GrpcOpenTelemetry, etc.)
// there may be additional metrics recorded. Only check to ensure the Gax Metrics
// are recorded properly. Any additional metrics are fine to be passed.
if (metricData.size() >= NUM_GAX_OTEL_METRICS && areAllGaxMetricsRecorded(metricData)) {
return metricData;
}
try {
Awaitility.await()
.atMost(java.time.Duration.ofSeconds(NUM_DEFAULT_FLUSH_ATTEMPTS))
.until(
() -> {
List<MetricData> metricData = new ArrayList<>(metricReader.collectAllMetrics());
// Depending on the OpenTelemetry instance (i.e. OpenTelemetry, GrpcOpenTelemetry,
// etc.)
// there may be additional metrics recorded. Only check to ensure the Gax Metrics
// are recorded properly. Any additional metrics are fine to be passed.
return metricData.size() >= NUM_GAX_OTEL_METRICS
&& areAllGaxMetricsRecorded(metricData);
});
} catch (org.awaitility.core.ConditionTimeoutException e) {
Assertions.fail("Unable to collect all the GAX metrics required for the test");
}
Assertions.fail("Unable to collect all the GAX metrics required for the test");
return new ArrayList<>();
return new ArrayList<>(metricReader.collectAllMetrics());
Comment thread
blakeli0 marked this conversation as resolved.
}

private boolean areAllGaxMetricsRecorded(List<MetricData> metricData) {
Expand Down Expand Up @@ -370,7 +376,7 @@ void testGrpc_operationCancelled_recordsMetrics() throws Exception {
UnaryCallable<BlockRequest, BlockResponse> blockCallable = grpcClient.blockCallable();
ApiFuture<BlockResponse> blockResponseApiFuture = blockCallable.futureCall(blockRequest);
// Sleep 1s before cancelling to let the request go through
Thread.sleep(1000);
Awaitility.await().pollDelay(java.time.Duration.ofSeconds(1)).until(() -> true);
blockResponseApiFuture.cancel(true);

List<MetricData> actualMetricDataList = getMetricDataList();
Expand All @@ -397,7 +403,7 @@ void testHttpJson_operationCancelled_recordsMetrics() throws Exception {
UnaryCallable<BlockRequest, BlockResponse> blockCallable = httpClient.blockCallable();
ApiFuture<BlockResponse> blockResponseApiFuture = blockCallable.futureCall(blockRequest);
// Sleep 1s before cancelling to let the request go through
Thread.sleep(1000);
Awaitility.await().pollDelay(java.time.Duration.ofSeconds(1)).until(() -> true);
blockResponseApiFuture.cancel(true);

List<MetricData> actualMetricDataList = getMetricDataList();
Expand Down
Loading