Skip to content

feat: add Linux and Podman socket detection to platform.js #269

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

Closed
brianwtaylor wants to merge 1 commit into from
Closed

feat: add Linux and Podman socket detection to platform.js #269

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
11 changes: 10 additions & 1 deletion bin/lib/platform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ function findColimaDockerSocket(opts = {}) {
function getDockerSocketCandidates(opts = {}) {
const home = opts.home ?? process.env.HOME ?? "/tmp";
const platform = opts.platform ?? process.platform;
const uid = opts.uid ?? (process.getuid ? process.getuid() : 1000);

if (platform === "darwin") {
return [
Expand All @@ -63,7 +64,15 @@ function getDockerSocketCandidates(opts = {}) {
];
}

return [];
// Linux (native Docker, WSL2, Podman)
return [
path.join(home, ".docker/run/docker.sock"),
"/run/docker.sock",
"/var/run/docker.sock",
path.join(home, ".local/share/containers/podman/machine/podman.sock"),
`/run/user/${uid}/podman/podman.sock`,
path.join(home, ".local/share/containers/podman/machine/qemu/podman.sock"),
];
}

function detectDockerHost(opts = {}) {
Expand Down
127 changes: 125 additions & 2 deletions test/platform.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,22 @@ describe("platform helpers", () => {
]);
});

it("does not auto-detect sockets on Linux", () => {
assert.deepEqual(getDockerSocketCandidates({ platform: "linux", home: "/tmp/test-home" }), []);
it("returns Linux candidates in priority order", () => {
const home = "/home/test";
const candidates = getDockerSocketCandidates({ platform: "linux", home, uid: 1000 });
assert.deepEqual(candidates, [
path.join(home, ".docker/run/docker.sock"),
"/run/docker.sock",
"/var/run/docker.sock",
path.join(home, ".local/share/containers/podman/machine/podman.sock"),
"/run/user/1000/podman/podman.sock",
path.join(home, ".local/share/containers/podman/machine/qemu/podman.sock"),
]);
});

it("uses correct uid for rootless Podman path", () => {
const candidates = getDockerSocketCandidates({ platform: "linux", home: "/home/test", uid: 5000 });
assert.ok(candidates.includes("/run/user/5000/podman/podman.sock"));
});
});

Expand Down Expand Up @@ -124,11 +138,120 @@ describe("platform helpers", () => {
env: {},
platform: "linux",
home: "/tmp/test-home",
uid: 1000,
existsSync: () => false,
}),
null,
);
});

it("detects native Docker socket on Linux", () => {
assert.deepEqual(
detectDockerHost({
env: {},
platform: "linux",
home: "/home/test",
uid: 1000,
existsSync: (p) => p === "/run/docker.sock",
}),
{
dockerHost: "unix:///run/docker.sock",
source: "socket",
socketPath: "/run/docker.sock",
},
);
});

it("detects /var/run/docker.sock fallback on Linux", () => {
assert.deepEqual(
detectDockerHost({
env: {},
platform: "linux",
home: "/home/test",
uid: 1000,
existsSync: (p) => p === "/var/run/docker.sock",
}),
{
dockerHost: "unix:///var/run/docker.sock",
source: "socket",
socketPath: "/var/run/docker.sock",
},
);
});

it("prefers Docker Desktop over native Linux socket", () => {
const home = "/home/test";
const ddPath = path.join(home, ".docker/run/docker.sock");
assert.deepEqual(
detectDockerHost({
env: {},
platform: "linux",
home,
uid: 1000,
existsSync: (p) => p === ddPath || p === "/run/docker.sock",
}),
{
dockerHost: `unix://${ddPath}`,
source: "socket",
socketPath: ddPath,
},
);
});

it("prefers native Docker over Podman on Linux", () => {
const home = "/home/test";
const podmanPath = path.join(home, ".local/share/containers/podman/machine/podman.sock");
assert.deepEqual(
detectDockerHost({
env: {},
platform: "linux",
home,
uid: 1000,
existsSync: (p) => p === "/run/docker.sock" || p === podmanPath,
}),
{
dockerHost: "unix:///run/docker.sock",
source: "socket",
socketPath: "/run/docker.sock",
},
);
});

it("falls back to Podman on Linux when Docker absent", () => {
const home = "/home/test";
const podmanPath = path.join(home, ".local/share/containers/podman/machine/podman.sock");
assert.deepEqual(
detectDockerHost({
env: {},
platform: "linux",
home,
uid: 1000,
existsSync: (p) => p === podmanPath,
}),
{
dockerHost: `unix://${podmanPath}`,
source: "socket",
socketPath: podmanPath,
},
);
});

it("detects rootless Podman on Linux", () => {
assert.deepEqual(
detectDockerHost({
env: {},
platform: "linux",
home: "/home/test",
uid: 1001,
existsSync: (p) => p === "/run/user/1001/podman/podman.sock",
}),
{
dockerHost: "unix:///run/user/1001/podman/podman.sock",
source: "socket",
socketPath: "/run/user/1001/podman/podman.sock",
},
);
});
});

describe("inferContainerRuntime", () => {
Expand Down