Skip to content

test(storage): bind FakeServer and TestBench to 127.0.0.1 to avoid localhost hangs #13386

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
Dhriti07 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

test(storage): bind FakeServer and TestBench to 127.0.0.1 to avoid localhost hangs #13386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1482328
test(storage): bind FakeServer and TestBench to 127.0.0.1 to avoid lo…
Jun 8, 2026
c5ef4c5
test(storage): support daemonized testbench container with keep-alive…
Jun 8, 2026
abfe7b8
refactor(testbench): clean up temporary logs/directory in finally blo…
Jun 8, 2026
3ff63b8
test(storage): bind FakeHttpServer to 127.0.0.1 to avoid localhost IP…
Jun 8, 2026
e679b7d
test(storage): deliver mock errors asynchronously to prevent thread s…
Jun 8, 2026
81d12c5
Merge branch 'main' into fix-testbench-localhost-hang
Dhriti07 Jun 8, 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
9 changes: 9 additions & 0 deletions java-storage/google-cloud-storage/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,6 +460,15 @@
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<systemPropertyVariables>
<testbench.keepAlive>true</testbench.keepAlive>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
</build>

Expand Down
4 changes: 2 additions & 2 deletions java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/FakeHttpServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ static FakeHttpServer of(HttpRequestHandler server) {
static FakeHttpServer of(HttpRequestHandler server, boolean trailingSlash) {
// based on
// https://github.com/netty/netty/blob/59aa6e635b9996cf21cd946e64353270679adc73/example/src/main/java/io/netty/example/http/helloworld/HttpHelloWorldServer.java
InetSocketAddress address = new InetSocketAddress("localhost", 0);
InetSocketAddress address = new InetSocketAddress("127.0.0.1", 0);
// Configure the server.
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
EventLoopGroup workerGroup = new NioEventLoopGroup();
Expand Down Expand Up @@ -129,7 +129,7 @@ protected void initChannel(SocketChannel ch) {

InetSocketAddress socketAddress = (InetSocketAddress) channel.localAddress();
String suffix = trailingSlash ? "/" : "";
URI endpoint = URI.create("http://localhost:" + socketAddress.getPort() + suffix);
URI endpoint = URI.create("http://127.0.0.1:" + socketAddress.getPort() + suffix);
HttpStorageOptions httpStorageOptions =
HttpStorageOptions.http()
.setHost(endpoint.toString())
Expand Down
2 changes: 1 addition & 1 deletion java-storage/google-cloud-storage/src/test/java/com/google/cloud/storage/FakeServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public void close() throws InterruptedException {
}

static FakeServer of(StorageGrpc.StorageImplBase service) throws IOException {
InetSocketAddress address = new InetSocketAddress("localhost", 0);
InetSocketAddress address = new InetSocketAddress("127.0.0.1", 0);
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Jun 8, 2026

Choose a reason for hiding this comment

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

medium

Instead of hardcoding the IPv4 loopback address "127.0.0.1", consider using InetAddress.getLoopbackAddress(). This is more robust as it dynamically resolves to the correct loopback address (IPv4 or IPv6) for the environment without performing a DNS lookup, which avoids the localhost resolution hangs while maintaining compatibility with IPv6-only loopback environments.

Suggested change
InetSocketAddress address = new InetSocketAddress("127.0.0.1", 0);
InetSocketAddress address = new InetSocketAddress(InetAddress.getLoopbackAddress(), 0);

Server server = NettyServerBuilder.forAddress(address).addService(service).build();
server.start();
String endpoint = String.format(Locale.US, "%s:%d", address.getHostString(), server.getPort());
Expand Down
14 changes: 12 additions & 2 deletions ...rage/src/test/java/com/google/cloud/storage/ITGapicUnbufferedReadableByteChannelTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,12 @@ public void readObject(
if (request.equals(req1)) {
responseObserver.onNext(resp1);
responseObserver.onNext(resp2);
responseObserver.onError(apiException(Code.DATA_LOSS));
new Thread(() -> {
try {
Thread.sleep(200);
} catch (InterruptedException ignored) {}
responseObserver.onError(apiException(Code.DATA_LOSS));
}).start();
} else if (request.equals(req2)) {
responseObserver.onNext(resp3);
responseObserver.onNext(resp4);
Expand Down Expand Up @@ -194,7 +199,12 @@ public void readObject(
if (count == 0) {
responseObserver.onNext(resp1);
responseObserver.onNext(resp2);
responseObserver.onError(apiException(Code.DATA_LOSS));
new Thread(() -> {
try {
Thread.sleep(200);
} catch (InterruptedException ignored) {}
responseObserver.onError(apiException(Code.DATA_LOSS));
}).start();
}
} else if (request.equals(req2)) {
ReadObjectResponse.Builder builder = resp3.toBuilder();
Expand Down
88 changes: 38 additions & 50 deletions ...le-cloud-storage/src/test/java/com/google/cloud/storage/it/runner/registry/TestBench.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ public void start() {
ImmutableList.of(
"docker",
"run",
"-i",
"-d",
"--rm",
"--publish",
port + ":9000",
Expand Down Expand Up @@ -323,62 +323,50 @@ public void stop() {
return;
}
try {
process.destroy();
process.waitFor(2, TimeUnit.SECONDS);
boolean attemptForceStopContainer = false;
try {
int processExitValue = process.exitValue();
if (processExitValue != 0) {
attemptForceStopContainer = true;
}
LOGGER.warn("Container exit value = {}", processExitValue);
} catch (IllegalThreadStateException e) {
attemptForceStopContainer = true;
}

if (attemptForceStopContainer) {
LOGGER.warn("Container did not gracefully exit, attempting to explicitly stop it.");
if (!Boolean.getBoolean("testbench.keepAlive")) {
LOGGER.warn("Attempting to explicitly stop container: {}", containerName);
ImmutableList<String> command = ImmutableList.of("docker", "kill", containerName);
LOGGER.warn(command.toString());
Process shutdownProcess = new ProcessBuilder(command).start();
shutdownProcess.waitFor(5, TimeUnit.SECONDS);
int shutdownProcessExitValue = shutdownProcess.exitValue();
LOGGER.warn("Container exit value = {}", shutdownProcessExitValue);
LOGGER.warn("Container stop exit value = {}", shutdownProcessExitValue);

// wait for the server to shutdown
runWithRetries(
() -> {
try {
listRetryTests();
} catch (SocketException e) {
// desired result
return null;
}
throw new NotShutdownException();
},
RetrySettings.newBuilder()
.setTotalTimeoutDuration(Duration.ofSeconds(30))
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofSeconds(5))
.build(),
new BasicResultRetryAlgorithm<List<?>>() {
@Override
public boolean shouldRetry(Throwable previousThrowable, List<?> previousResponse) {
return previousThrowable instanceof NotShutdownException;
}
},
NanoClock.getDefaultClock());
}

// wait for the server to shutdown
runWithRetries(
() -> {
try {
listRetryTests();
} catch (SocketException e) {
// desired result
return null;
}
throw new NotShutdownException();
},
RetrySettings.newBuilder()
.setTotalTimeoutDuration(Duration.ofSeconds(30))
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofSeconds(5))
.build(),
new BasicResultRetryAlgorithm<List<?>>() {
@Override
public boolean shouldRetry(Throwable previousThrowable, List<?> previousResponse) {
return previousThrowable instanceof NotShutdownException;
}
},
NanoClock.getDefaultClock());
} catch (InterruptedException | IOException e) {
throw new RuntimeException(e);
} finally {
try {
Files.delete(errPath);
Files.delete(outPath);
Files.delete(tempDirectory);
Files.deleteIfExists(errPath);
Files.deleteIfExists(outPath);
Files.deleteIfExists(tempDirectory);
} catch (IOException e) {
throw new RuntimeException(e);
LOGGER.warn("Failed to delete temporary files", e);
}
} catch (InterruptedException | IOException e) {
throw new RuntimeException(e);
}
}

Expand Down Expand Up @@ -442,8 +430,8 @@ public String toString() {
}

static final class Builder {
private static final String DEFAULT_BASE_URI = "http://localhost:9000";
private static final String DEFAULT_GRPC_BASE_URI = "http://localhost:9005";
private static final String DEFAULT_BASE_URI = "http://127.0.0.1:9000";
private static final String DEFAULT_GRPC_BASE_URI = "http://127.0.0.1:9005";
private static final String DEFAULT_IMAGE_NAME;
private static final String DEFAULT_IMAGE_TAG;

Expand Down
Loading