feat(codex): auto-install git bash via winget on windows
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { mkdtemp, readFile, stat, writeFile } from "node:fs/promises";
|
||||
import { mkdir, mkdtemp, readFile, stat, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import test from "node:test";
|
||||
@@ -7,8 +7,21 @@ import test from "node:test";
|
||||
import { installMarketplaceLocally } from "./install-local.mjs";
|
||||
|
||||
const windowsGitBashPath = "C:\\Program Files\\Git\\bin\\bash.exe";
|
||||
const lspCliPath = join(process.cwd(), "packages", "lsp-tools-mcp", "dist", "cli.js");
|
||||
|
||||
test("#given Windows without Git Bash #when installing local marketplace #then rejects before marketplace or config mutation", async () => {
|
||||
async function withBundledLspRuntimeForTest(run) {
|
||||
try {
|
||||
await stat(lspCliPath);
|
||||
} catch (error) {
|
||||
if (!(error instanceof Error)) throw error;
|
||||
await mkdir(join(process.cwd(), "packages", "lsp-tools-mcp", "dist"), { recursive: true });
|
||||
await writeFile(lspCliPath, "#!/usr/bin/env node\n");
|
||||
}
|
||||
|
||||
return run();
|
||||
}
|
||||
|
||||
test("#given Windows without Git Bash and auto install skip env #when installing local marketplace #then rejects before marketplace or config mutation", async () => {
|
||||
const repoRoot = await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-missing-repo-"));
|
||||
const codexHome = await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-missing-home-"));
|
||||
const commands = [];
|
||||
@@ -18,6 +31,7 @@ test("#given Windows without Git Bash #when installing local marketplace #then r
|
||||
repoRoot,
|
||||
codexHome,
|
||||
platform: "win32",
|
||||
env: { OMO_CODEX_SKIP_GIT_BASH_AUTO_INSTALL: "1" },
|
||||
gitBashResolver: () => ({
|
||||
found: false,
|
||||
checkedPaths: [windowsGitBashPath],
|
||||
@@ -39,8 +53,50 @@ test("#given Windows without Git Bash #when installing local marketplace #then r
|
||||
await assert.rejects(stat(join(codexHome, "config.toml")), /ENOENT/);
|
||||
});
|
||||
|
||||
test("#given Windows without Git Bash #when winget succeeds and resolver recovers #then install continues", async () => {
|
||||
const runCalls = [];
|
||||
const resolutions = [
|
||||
{ found: false, checkedPaths: [windowsGitBashPath], installHint: "install hint before winget" },
|
||||
{ found: true, path: windowsGitBashPath, source: "program-files" },
|
||||
];
|
||||
let resolveCallCount = 0;
|
||||
|
||||
const result = await withBundledLspRuntimeForTest(async () => installMarketplaceLocally({
|
||||
repoRoot: process.cwd(),
|
||||
codexHome: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-auto-home-")),
|
||||
binDir: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-auto-bin-")),
|
||||
platform: "win32",
|
||||
gitBashResolver: () => resolutions[resolveCallCount++] ?? resolutions[resolutions.length - 1],
|
||||
runCommand: async (command, args, options) => {
|
||||
runCalls.push([command, ...args, options.cwd].join(" "));
|
||||
},
|
||||
log: () => {},
|
||||
}));
|
||||
|
||||
assert.equal(resolveCallCount, 2);
|
||||
assert.match(runCalls.join("\n"), /^winget install --id Git\.Git -e --source winget /m);
|
||||
assert.equal(result.gitBashPath, windowsGitBashPath);
|
||||
});
|
||||
|
||||
test("#given non-Windows install #when running installer #then winget is never called", async () => {
|
||||
const runCalls = [];
|
||||
const result = await withBundledLspRuntimeForTest(async () => installMarketplaceLocally({
|
||||
repoRoot: process.cwd(),
|
||||
codexHome: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-no-winget-home-")),
|
||||
binDir: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-no-winget-bin-")),
|
||||
platform: "linux",
|
||||
runCommand: async (command, args, options) => {
|
||||
runCalls.push([command, ...args, options.cwd].join(" "));
|
||||
},
|
||||
log: () => {},
|
||||
}));
|
||||
|
||||
assert.equal(result.gitBashPath, null);
|
||||
assert.equal(runCalls.some((command) => command.startsWith("winget ")), false);
|
||||
});
|
||||
|
||||
test("#given Windows env override resolves Git Bash #when installing local marketplace #then install continues", async () => {
|
||||
const result = await installMarketplaceLocally({
|
||||
const result = await withBundledLspRuntimeForTest(async () => installMarketplaceLocally({
|
||||
repoRoot: process.cwd(),
|
||||
codexHome: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-home-")),
|
||||
binDir: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-bin-")),
|
||||
@@ -48,7 +104,7 @@ test("#given Windows env override resolves Git Bash #when installing local marke
|
||||
gitBashResolver: () => ({ found: true, path: windowsGitBashPath, source: "env" }),
|
||||
runCommand: async () => {},
|
||||
log: () => {},
|
||||
});
|
||||
}));
|
||||
|
||||
assert.equal(result.gitBashPath, windowsGitBashPath);
|
||||
assert.equal(result.installed.length, 1);
|
||||
@@ -59,7 +115,7 @@ test("#given Windows env override in installer options #when no custom resolver
|
||||
const gitBashPath = join(await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-env-")), "bash.exe");
|
||||
await writeFile(gitBashPath, "");
|
||||
|
||||
const result = await installMarketplaceLocally({
|
||||
const result = await withBundledLspRuntimeForTest(async () => installMarketplaceLocally({
|
||||
repoRoot: process.cwd(),
|
||||
codexHome,
|
||||
binDir: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-env-bin-")),
|
||||
@@ -67,14 +123,14 @@ test("#given Windows env override in installer options #when no custom resolver
|
||||
env: { OMO_CODEX_GIT_BASH_PATH: gitBashPath },
|
||||
runCommand: async () => {},
|
||||
log: () => {},
|
||||
});
|
||||
}));
|
||||
|
||||
assert.equal(result.gitBashPath, gitBashPath);
|
||||
});
|
||||
|
||||
test("#given non-Windows local install #when resolver would fail #then installer keeps existing behavior", async () => {
|
||||
const codexHome = await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-linux-home-"));
|
||||
const result = await installMarketplaceLocally({
|
||||
const result = await withBundledLspRuntimeForTest(async () => installMarketplaceLocally({
|
||||
repoRoot: process.cwd(),
|
||||
codexHome,
|
||||
binDir: await mkdtemp(join(tmpdir(), "omo-codex-script-git-bash-linux-bin-")),
|
||||
@@ -82,7 +138,7 @@ test("#given non-Windows local install #when resolver would fail #then installer
|
||||
gitBashResolver: () => ({ found: false, checkedPaths: [windowsGitBashPath], installHint: "should not be used" }),
|
||||
runCommand: async () => {},
|
||||
log: () => {},
|
||||
});
|
||||
}));
|
||||
|
||||
assert.equal(result.gitBashPath, null);
|
||||
assert.match(await readFile(join(codexHome, "config.toml"), "utf8"), /\[marketplaces\.sisyphuslabs\]/);
|
||||
|
||||
@@ -21,7 +21,7 @@ import {
|
||||
resolvePluginSource,
|
||||
validatePathSegment,
|
||||
} from "./install/marketplace.mjs";
|
||||
import { resolveGitBashForCurrentProcess } from "./install/git-bash.mjs";
|
||||
import { prepareGitBashForInstall, resolveGitBashForCurrentProcess } from "./install/git-bash.mjs";
|
||||
|
||||
const LEGACY_CODEX_PLUGIN_MARKETPLACE = ["code", "yeongyu", "codex", "plugins"].join("-");
|
||||
const SISYPHUS_LEGACY_CACHE_MARKETPLACES = ["lazycodex", LEGACY_CODEX_PLUGIN_MARKETPLACE];
|
||||
@@ -46,9 +46,15 @@ export async function installMarketplaceLocally(options = {}) {
|
||||
const platform = options.platform ?? process.platform;
|
||||
const runCommand = options.runCommand ?? defaultRunCommand;
|
||||
const log = options.log ?? console.log;
|
||||
const gitBashResolution = platform === "win32"
|
||||
? (options.gitBashResolver ?? (() => resolveGitBashForCurrentProcess({ platform, env })))()
|
||||
: { found: true, path: null, source: "not-required" };
|
||||
const gitBashResolution = await prepareGitBashForInstall({
|
||||
platform,
|
||||
env,
|
||||
cwd: repoRoot,
|
||||
runCommand,
|
||||
resolveGitBash: platform === "win32"
|
||||
? (options.gitBashResolver ?? (() => resolveGitBashForCurrentProcess({ platform, env })))
|
||||
: undefined,
|
||||
});
|
||||
if (!gitBashResolution.found) {
|
||||
throw new Error(gitBashResolution.installHint);
|
||||
}
|
||||
|
||||
@@ -2,8 +2,10 @@ import { execFileSync } from "node:child_process";
|
||||
import { existsSync } from "node:fs";
|
||||
|
||||
const GIT_BASH_ENV_KEY = "OMO_CODEX_GIT_BASH_PATH";
|
||||
const SKIP_GIT_BASH_AUTO_INSTALL_ENV_KEY = "OMO_CODEX_SKIP_GIT_BASH_AUTO_INSTALL";
|
||||
const PROGRAM_FILES_GIT_BASH = "C:\\Program Files\\Git\\bin\\bash.exe";
|
||||
const PROGRAM_FILES_X86_GIT_BASH = "C:\\Program Files (x86)\\Git\\bin\\bash.exe";
|
||||
const WINGET_INSTALL_ARGS = ["install", "--id", "Git.Git", "-e", "--source", "winget"];
|
||||
|
||||
export function resolveGitBash({ platform, env, exists, where }) {
|
||||
if (platform !== "win32") return { found: true, path: null, source: "not-required" };
|
||||
@@ -43,6 +45,23 @@ export function resolveGitBashForCurrentProcess(options = {}) {
|
||||
});
|
||||
}
|
||||
|
||||
export async function prepareGitBashForInstall(options) {
|
||||
const resolveGitBashWithDefaults = options.resolveGitBash
|
||||
?? (() => resolveGitBashForCurrentProcess({ platform: options.platform, env: options.env }));
|
||||
const initialResolution = resolveGitBashWithDefaults();
|
||||
if (options.platform !== "win32" || initialResolution.found) return initialResolution;
|
||||
if (options.env[SKIP_GIT_BASH_AUTO_INSTALL_ENV_KEY] === "1") return initialResolution;
|
||||
|
||||
try {
|
||||
await options.runCommand("winget", WINGET_INSTALL_ARGS, { cwd: options.cwd });
|
||||
} catch (error) {
|
||||
if (!(error instanceof Error)) throw error;
|
||||
return initialResolution;
|
||||
}
|
||||
|
||||
return resolveGitBashWithDefaults();
|
||||
}
|
||||
|
||||
function missingGitBash(checkedPaths) {
|
||||
return {
|
||||
found: false,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
|
||||
import { resolveGitBash } from "./git-bash.mjs";
|
||||
import { prepareGitBashForInstall, resolveGitBash } from "./git-bash.mjs";
|
||||
|
||||
const programFilesGitBash = "C:\\Program Files\\Git\\bin\\bash.exe";
|
||||
const programFilesX86GitBash = "C:\\Program Files (x86)\\Git\\bin\\bash.exe";
|
||||
@@ -68,3 +68,63 @@ test("#given Windows without Git Bash #when resolving #then returns install guid
|
||||
assert.match(result.installHint, /winget install --id Git\.Git -e --source winget/);
|
||||
assert.match(result.installHint, /rerun `bunx omo install --platform=codex`/);
|
||||
});
|
||||
|
||||
test("#given Windows without Git Bash and winget is allowed #when preparing #then winget runs and resolver retries", async () => {
|
||||
const runCalls = [];
|
||||
const resolutions = [
|
||||
{ found: false, checkedPaths: [programFilesGitBash], installHint: "install hint" },
|
||||
{ found: true, path: programFilesGitBash, source: "program-files" },
|
||||
];
|
||||
let resolveCallCount = 0;
|
||||
|
||||
const result = await prepareGitBashForInstall({
|
||||
platform: "win32",
|
||||
env: {},
|
||||
cwd: "C:\\repo",
|
||||
resolveGitBash: () => resolutions[resolveCallCount++] ?? resolutions[resolutions.length - 1],
|
||||
runCommand: async (command, args, options) => {
|
||||
runCalls.push([command, ...args, options.cwd].join(" "));
|
||||
},
|
||||
});
|
||||
|
||||
assert.deepEqual(runCalls, ["winget install --id Git.Git -e --source winget C:\\repo"]);
|
||||
assert.equal(resolveCallCount, 2);
|
||||
assert.deepEqual(result, { found: true, path: programFilesGitBash, source: "program-files" });
|
||||
});
|
||||
|
||||
test("#given Windows without Git Bash and skip env is set #when preparing #then winget is not run and install hint remains", async () => {
|
||||
const runCalls = [];
|
||||
const missingResolution = {
|
||||
found: false,
|
||||
checkedPaths: [programFilesGitBash, programFilesX86GitBash],
|
||||
installHint: "install hint",
|
||||
};
|
||||
|
||||
const result = await prepareGitBashForInstall({
|
||||
platform: "win32",
|
||||
env: { OMO_CODEX_SKIP_GIT_BASH_AUTO_INSTALL: "1" },
|
||||
cwd: "C:\\repo",
|
||||
resolveGitBash: () => missingResolution,
|
||||
runCommand: async (command, args, options) => {
|
||||
runCalls.push([command, ...args, options.cwd].join(" "));
|
||||
},
|
||||
});
|
||||
|
||||
assert.deepEqual(runCalls, []);
|
||||
assert.deepEqual(result, missingResolution);
|
||||
});
|
||||
|
||||
test("#given non-Windows platform #when preparing #then winget is never called", async () => {
|
||||
const runCalls = [];
|
||||
const result = await prepareGitBashForInstall({
|
||||
platform: "linux",
|
||||
env: {},
|
||||
cwd: "/repo",
|
||||
runCommand: async (command, args, options) => {
|
||||
runCalls.push([command, ...args, options.cwd].join(" "));
|
||||
},
|
||||
});
|
||||
|
||||
assert.deepEqual(runCalls, []);
|
||||
assert.deepEqual(result, { found: true, path: null, source: "not-required" });
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user