Skip to content

feat(wslc): add WSL Containers (wslc://) transport, lifecycle integra… #2659

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
DavidTavoularis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(wslc): add WSL Containers (wslc://) transport, lifecycle integra… #2659

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
62 changes: 61 additions & 1 deletion docker-java-core/src/main/java/com/github/dockerjava/core/DefaultDockerClientConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import java.util.Objects;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.TimeUnit;

import static org.apache.commons.lang3.BooleanUtils.isTrue;

Expand Down Expand Up @@ -68,6 +69,11 @@ public class DefaultDockerClientConfig implements Serializable, DockerClientConf

static final String WINDOWS_DEFAULT_DOCKER_HOST = "npipe:////./pipe/docker_engine";

static final String WSLC_DEFAULT_DOCKER_HOST = "wslc://localhost";

// wslc availability is constant per machine; probe at most once per JVM.
private static volatile Boolean wslcAvailable;

static {
CONFIG_KEYS.add(DOCKER_HOST);
CONFIG_KEYS.add(DOCKER_TLS_VERIFY);
Expand Down Expand Up @@ -115,6 +121,60 @@ private URI checkDockerHostScheme(URI dockerHost) {
return dockerHost;
}

/**
* Default DOCKER_HOST when none is configured. On Windows a real Docker/Podman named pipe is
* preferred; only when that pipe is absent and the WSL Containers (wslc) CLI is available does it
* fall back to {@code wslc://localhost}, so existing Docker Desktop / Podman setups keep winning.
*/
private static String defaultDockerHost() {
if (!SystemUtils.IS_OS_WINDOWS) {
return DEFAULT_DOCKER_HOST;
}
if (!new File("//./pipe/docker_engine").exists() && isWslcAvailable()) {
return WSLC_DEFAULT_DOCKER_HOST;
}
return WINDOWS_DEFAULT_DOCKER_HOST;
}

private static boolean isWslcAvailable() {
Boolean cached = wslcAvailable;
if (cached == null) {
cached = probeWslc();
wslcAvailable = cached;
}
return cached;
}

// 'wslc version' is a cheap metadata call that does not start the container VM. The executable
// can be overridden with the WSLC_EXECUTABLE environment variable.
private static boolean probeWslc() {
String executable = System.getenv("WSLC_EXECUTABLE");
if (executable == null || executable.trim().isEmpty()) {
executable = "wslc.exe";
}
Process process = null;
try {
process = new ProcessBuilder(executable, "version")
.redirectErrorStream(true)
.redirectOutput(ProcessBuilder.Redirect.to(new File("NUL")))
.start();
if (!process.waitFor(10, TimeUnit.SECONDS)) {
process.destroyForcibly();
return false;
}
return process.exitValue() == 0;
} catch (IOException | InterruptedException | RuntimeException e) {
if (e instanceof InterruptedException) {
Thread.currentThread().interrupt();
}
return false;
} finally {
if (process != null && process.isAlive()) {
process.destroyForcibly();
}
}
}

private static Properties loadIncludedDockerProperties(Properties systemProperties) {
Properties p = new Properties();
p.putAll(DEFAULT_PROPERTIES);
Expand Down Expand Up @@ -485,7 +545,7 @@ public DefaultDockerClientConfig build() {

URI dockerHostUri = dockerHost != null
? dockerHost
: URI.create(SystemUtils.IS_OS_WINDOWS ? WINDOWS_DEFAULT_DOCKER_HOST : DEFAULT_DOCKER_HOST);
: URI.create(defaultDockerHost());

return new DefaultDockerClientConfig(dockerHostUri, dockerConfigFile, dockerConfig, apiVersion, registryUrl, registryUsername,
registryPassword, registryEmail, sslConfig);
Expand Down
13 changes: 12 additions & 1 deletion docker-java-core/src/main/java/com/github/dockerjava/core/DockerClientImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,19 @@ public static DockerClientImpl getInstance(DockerClientConfig dockerClientConfig
}

public static DockerClient getInstance(DockerClientConfig dockerClientConfig, DockerHttpClient dockerHttpClient) {
DockerHttpClient httpClient = dockerHttpClient;
// WSL Containers (wslc): the Docker Engine API reaches the daemon over the dial-stdio bridge,
// but the Windows port relay and host bind mounts are only wired when a container is created
// and started through the `wslc` CLI. Transparently route just those lifecycle calls through
// wslc so that published ports are reachable from Windows and host directories can be
// bind-mounted. Doing it here means every docker-java consumer (including Testcontainers, which
// shades this class) gets the behaviour without any extra dependency or client-side wiring.
if (dockerClientConfig.getDockerHost() != null
&& "wslc".equals(dockerClientConfig.getDockerHost().getScheme())) {
httpClient = new WslcLifecycleDockerHttpClient(httpClient, null);
}
return new DockerClientImpl(dockerClientConfig)
.withHttpClient(dockerHttpClient);
.withHttpClient(httpClient);
}

/**
Expand Down
Loading