Skip to content

fix: windows deadlock while executing docker commands (#4267) #4351

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

Merged
merged 1 commit into from
Mar 10, 2025
Merged

fix: windows deadlock while executing docker commands (#4267) #4351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 22 additions & 9 deletions jib-core/src/main/java/com/google/cloud/tools/jib/docker/CliDockerClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,11 +277,18 @@ public DockerImageDetails inspect(ImageReference imageReference)
throws IOException, InterruptedException {
Process inspectProcess =
docker("inspect", "-f", "{{json .}}", "--type", "image", imageReference.toString());
if (inspectProcess.waitFor() != 0) {
throw new IOException(
"'docker inspect' command failed with error: " + getStderrOutput(inspectProcess));

try (InputStreamReader stdout =
new InputStreamReader(inspectProcess.getInputStream(), StandardCharsets.UTF_8)) {
String output = CharStreams.toString(stdout);

if (inspectProcess.waitFor() != 0) {
throw new IOException(
"'docker inspect' command failed with error: " + getStderrOutput(inspectProcess));
}

return JsonTemplateMapper.readJson(output, DockerImageDetails.class);
}
return JsonTemplateMapper.readJson(inspectProcess.getInputStream(), DockerImageDetails.class);
}

/** Runs a {@code docker} command. */
Expand All @@ -291,11 +298,17 @@ private Process docker(String... subCommand) throws IOException {

private DockerInfoDetails fetchInfoDetails() throws IOException, InterruptedException {
Process infoProcess = docker("info", "-f", "{{json .}}");
InputStream inputStream = infoProcess.getInputStream();
if (infoProcess.waitFor() != 0) {
throw new IOException(
"'docker info' command failed with error: " + getStderrOutput(infoProcess));

try (InputStreamReader stdout =
new InputStreamReader(infoProcess.getInputStream(), StandardCharsets.UTF_8)) {
String output = CharStreams.toString(stdout);

if (infoProcess.waitFor() != 0) {
throw new IOException(
"'docker info' command failed with error: " + getStderrOutput(infoProcess));
}

return JsonTemplateMapper.readJson(output, DockerInfoDetails.class);
}
return JsonTemplateMapper.readJson(inputStream, DockerInfoDetails.class);
}
}
51 changes: 51 additions & 0 deletions jib-core/src/test/java/com/google/cloud/tools/jib/docker/CliDockerClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ public void testInfo_fail() throws InterruptedException {
assertThat(subcommand).containsExactly("info", "-f", "{{json .}}");
return mockProcessBuilder;
});
Mockito.when(mockProcess.getInputStream())
.thenReturn(new ByteArrayInputStream("".getBytes(StandardCharsets.UTF_8)));
Mockito.when(mockProcess.waitFor()).thenReturn(1);
Mockito.when(mockProcess.getErrorStream())
.thenReturn(new ByteArrayInputStream("error".getBytes(StandardCharsets.UTF_8)));
Expand All @@ -123,6 +125,29 @@ public void testInfo_fail() throws InterruptedException {
.contains("'docker info' command failed with error: error");
}

@Test
public void testInfo_stdinFail() throws InterruptedException {
DockerClient testDockerClient =
new CliDockerClient(
subcommand -> {
assertThat(subcommand).containsExactly("info", "-f", "{{json .}}");
return mockProcessBuilder;
});
Mockito.when(mockProcess.getInputStream())
.thenReturn(
new InputStream() {

@Override
public int read() throws IOException {
throw new IOException();
}
});

assertThrows(IOException.class, testDockerClient::info);

Mockito.verify(mockProcess, Mockito.never()).waitFor();
}

@Test
public void testInfo_returnsUnknownKeys() throws InterruptedException, IOException {
String dockerInfoJson = "{ \"unknownOS\": \"windows\"," + "\"unknownArchitecture\": \"arm64\"}";
Expand Down Expand Up @@ -311,6 +336,8 @@ public void testSize_fail() throws InterruptedException {
Assert.assertEquals("inspect", subcommand.get(0));
return mockProcessBuilder;
});
Mockito.when(mockProcess.getInputStream())
.thenReturn(new ByteArrayInputStream("".getBytes(StandardCharsets.UTF_8)));
Mockito.when(mockProcess.waitFor()).thenReturn(1);

Mockito.when(mockProcess.getErrorStream())
Expand All @@ -325,6 +352,30 @@ public void testSize_fail() throws InterruptedException {
}
}

@Test
public void testSize_stdinFail() throws InterruptedException {
DockerClient testDockerClient =
new CliDockerClient(
subcommand -> {
Assert.assertEquals("inspect", subcommand.get(0));
return mockProcessBuilder;
});
Mockito.when(mockProcess.getInputStream())
.thenReturn(
new InputStream() {

@Override
public int read() throws IOException {
throw new IOException();
}
});

assertThrows(
IOException.class, () -> testDockerClient.inspect(ImageReference.of(null, "image", null)));

Mockito.verify(mockProcess, Mockito.never()).waitFor();
}

@Test
public void testDockerImageDetails() throws DigestException, IOException {
String json =
Expand Down
Loading