Files
ECC/tests/scripts/install-sh.test.js
T
042924e1f4 fix(install): support invocation through POSIX sh (#3014)
* fix(install): make install.sh robust to sh/dash invocation

Two related portability fixes so `sh install.sh` behaves correctly
even though the script is written for bash:

- The cygpath detection used the bash-only `&>/dev/null` redirection.
  dash misparses `&>`, so `command -v cygpath &>/dev/null` always took
  the true branch and tried to run the nonexistent `cygpath` binary,
  failing with "cygpath: not found". Switched to the POSIX-portable
  `>/dev/null 2>&1` form.

- Some dash builds don't support `set -o pipefail`, so `sh install.sh`
  can fail immediately at that line before even reaching the cygpath
  check (or the `[[ ... ]]` symlink-resolution logic further down).
  Added a guard that re-execs the script under bash when the current
  shell lacks bash capabilities, so the rest of the bash-only syntax
  always runs under a real bash regardless of the invoking shell. The
  guard probes for the `[[` compound command directly (via
  `eval '[[ 1 == 1 ]]'`) rather than trusting the $BASH_VERSION
  environment variable, since that variable could be inherited or
  spoofed under a non-bash shell and cause the guard to be skipped.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019XBaBRjaZgwhrZtYoqcQfp

* test(install): cover the sh install.sh re-exec path

Greptile flagged that the bash re-exec guard added in install.sh has
no automated coverage, since the existing test helper only invoked
the wrapper via `bash`. Adds two regression tests:

- "delegates to the Node installer when invoked via a POSIX sh
  wrapper" — runs the script via `sh` and asserts the args/cwd still
  reach the Node installer correctly.
- "re-execs into bash under sh even when BASH_VERSION is spoofed in
  the environment" — exercises the eval '[[ 1 == 1 ]]' capability
  probe directly, guarding against a regression back to trusting the
  (spoofable) $BASH_VERSION variable.

CodeRabbit then pointed out that the second test used generic `sh`,
which could trivially pass without exercising the re-exec branch at
all if `sh` ever resolves to bash on some system. Added a
findPosixOnlyShell() helper that prefers `dash` (falling back to
checking `sh`, and skipping with an explicit message if neither
genuinely lacks bash's `[[`), so the test reliably exercises the
branch it claims to cover instead of passing vacuously.

CodeRabbit then flagged that the skip path itself was miscounted as
a pass (the callback returned normally, so `test()` reported success
and `passed` was incremented even though nothing executed). Moved
the findPosixOnlyShell() check outside the test() registration, so
the test is only registered — and only counted — when a genuinely
POSIX-only shell is actually available; otherwise it's excluded from
both the passed and failed counts with an explicit skip line.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019XBaBRjaZgwhrZtYoqcQfp

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-27 19:04:10 -05:00

235 lines
8.0 KiB
JavaScript

/**
* Tests for install.sh wrapper delegation
*/
const assert = require('assert');
const fs = require('fs');
const os = require('os');
const path = require('path');
const { execFileSync } = require('child_process');
const SCRIPT = path.join(__dirname, '..', '..', 'install.sh');
function createTempDir(prefix) {
return fs.mkdtempSync(path.join(os.tmpdir(), prefix));
}
function cleanup(dirPath) {
fs.rmSync(dirPath, { recursive: true, force: true });
}
// Finds a shell that genuinely lacks bash's `[[` compound command, so tests
// that exercise install.sh's capability-probe re-exec guard actually take
// the "not bash" branch instead of trivially passing on a system where
// `sh` happens to resolve to bash.
function findPosixOnlyShell() {
for (const candidate of ['dash', 'sh']) {
try {
execFileSync(candidate, ['-c', "eval '[[ 1 == 1 ]]'"], { stdio: 'ignore' });
// Probe succeeded: this shell supports `[[`, so it can't stand in for
// a POSIX-only shell.
} catch (error) {
if (error.code === 'ENOENT') {
continue; // candidate not installed, try the next one
}
return candidate; // probe failed: genuinely lacks `[[` support
}
}
return null;
}
function run(args = [], options = {}) {
const env = {
...process.env,
HOME: options.homeDir || process.env.HOME,
...(options.env || {}),
};
try {
const stdout = execFileSync(options.shell || 'bash', [options.scriptPath || SCRIPT, ...args], {
cwd: options.cwd,
env,
encoding: 'utf8',
stdio: ['pipe', 'pipe', 'pipe'],
timeout: 10000,
});
return { code: 0, stdout, stderr: '' };
} catch (error) {
return {
code: error.status || 1,
stdout: error.stdout || '',
stderr: error.stderr || '',
};
}
}
function test(name, fn) {
try {
fn();
console.log(` \u2713 ${name}`);
return true;
} catch (error) {
console.log(` \u2717 ${name}`);
console.log(` Error: ${error.message}`);
return false;
}
}
function runTests() {
console.log('\n=== Testing install.sh ===\n');
let passed = 0;
let failed = 0;
if (process.platform === 'win32') {
console.log(' - skipped on Windows; install.ps1 covers the native wrapper path');
console.log(`\nResults: Passed: ${passed}, Failed: ${failed}`);
process.exit(0);
}
if (test('delegates to the Node installer and preserves dry-run output', () => {
const homeDir = createTempDir('install-sh-home-');
const projectDir = createTempDir('install-sh-project-');
try {
const result = run(['--target', 'cursor', '--dry-run', 'typescript'], {
cwd: projectDir,
homeDir,
});
assert.strictEqual(result.code, 0, result.stderr);
assert.ok(result.stdout.includes('Dry-run install plan'));
assert.ok(!fs.existsSync(path.join(projectDir, '.cursor', 'hooks.json')));
} finally {
cleanup(homeDir);
cleanup(projectDir);
}
})) passed++; else failed++;
if (test('absolute wrapper bootstraps a fresh source while preserving the target project cwd', () => {
const sourceDir = createTempDir('install-sh-source-');
const projectDir = createTempDir('install-sh-target-');
const binDir = path.join(sourceDir, 'test-bin');
const scriptsDir = path.join(sourceDir, 'scripts');
const npmCwdPath = path.join(sourceDir, 'npm-cwd.txt');
const fixtureScript = path.join(sourceDir, 'install.sh');
try {
fs.mkdirSync(binDir, { recursive: true });
fs.mkdirSync(scriptsDir, { recursive: true });
fs.copyFileSync(SCRIPT, fixtureScript);
fs.writeFileSync(
path.join(binDir, 'npm'),
`#!/usr/bin/env bash\nset -euo pipefail\nmkdir -p "$PWD/node_modules"\nprintf '%s\\n' "$PWD" > "$ECC_TEST_NPM_CWD"\n`,
{ mode: 0o755 }
);
fs.writeFileSync(
path.join(scriptsDir, 'install-apply.js'),
'console.log(JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n'
);
const result = run(['--target', 'antigravity', '--dry-run', 'typescript'], {
cwd: projectDir,
scriptPath: fixtureScript,
env: {
ECC_TEST_NPM_CWD: npmCwdPath,
PATH: `${binDir}${path.delimiter}${process.env.PATH}`,
},
});
assert.strictEqual(result.code, 0, result.stderr);
const payload = JSON.parse(result.stdout.trim().split('\n').at(-1));
assert.strictEqual(payload.cwd, fs.realpathSync(projectDir));
assert.deepStrictEqual(payload.args, ['--target', 'antigravity', '--dry-run', 'typescript']);
assert.strictEqual(fs.readFileSync(npmCwdPath, 'utf8').trim(), sourceDir);
assert.ok(fs.existsSync(path.join(sourceDir, 'node_modules')));
} finally {
cleanup(sourceDir);
cleanup(projectDir);
}
})) passed++; else failed++;
if (test('delegates to the Node installer when invoked via a POSIX sh wrapper', () => {
const sourceDir = createTempDir('install-sh-posix-source-');
const projectDir = createTempDir('install-sh-posix-target-');
const scriptsDir = path.join(sourceDir, 'scripts');
const fixtureScript = path.join(sourceDir, 'install.sh');
try {
fs.mkdirSync(scriptsDir, { recursive: true });
fs.mkdirSync(path.join(sourceDir, 'node_modules'), { recursive: true });
fs.copyFileSync(SCRIPT, fixtureScript);
fs.writeFileSync(
path.join(scriptsDir, 'install-apply.js'),
'console.log(JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n'
);
const result = run(['--target', 'antigravity', '--dry-run', 'typescript'], {
cwd: projectDir,
scriptPath: fixtureScript,
shell: 'sh',
});
assert.strictEqual(result.code, 0, result.stderr);
const payload = JSON.parse(result.stdout.trim().split('\n').at(-1));
assert.strictEqual(payload.cwd, fs.realpathSync(projectDir));
assert.deepStrictEqual(payload.args, ['--target', 'antigravity', '--dry-run', 'typescript']);
} finally {
cleanup(sourceDir);
cleanup(projectDir);
}
})) passed++; else failed++;
const posixOnlyShell = findPosixOnlyShell();
if (!posixOnlyShell) {
console.log(
' - skipped: re-execs into bash under sh even when BASH_VERSION is spoofed in the environment ' +
'(no shell without `[[` support was found on this system)'
);
} else if (test('re-execs into bash under sh even when BASH_VERSION is spoofed in the environment', () => {
const sourceDir = createTempDir('install-sh-spoof-source-');
const projectDir = createTempDir('install-sh-spoof-target-');
const scriptsDir = path.join(sourceDir, 'scripts');
const fixtureScript = path.join(sourceDir, 'install.sh');
try {
fs.mkdirSync(scriptsDir, { recursive: true });
fs.mkdirSync(path.join(sourceDir, 'node_modules'), { recursive: true });
fs.copyFileSync(SCRIPT, fixtureScript);
fs.writeFileSync(
path.join(scriptsDir, 'install-apply.js'),
'console.log(JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n'
);
const result = run(['--target', 'antigravity', '--dry-run', 'typescript'], {
cwd: projectDir,
scriptPath: fixtureScript,
shell: posixOnlyShell,
env: { BASH_VERSION: '9.9.9(1)-spoofed' },
});
assert.strictEqual(result.code, 0, result.stderr);
const payload = JSON.parse(result.stdout.trim().split('\n').at(-1));
assert.deepStrictEqual(payload.args, ['--target', 'antigravity', '--dry-run', 'typescript']);
} finally {
cleanup(sourceDir);
cleanup(projectDir);
}
})) passed++; else failed++;
if (test('exposes the corrected Claude target help text', () => {
const result = run(['--help']);
assert.strictEqual(result.code, 0, result.stderr);
assert.ok(
result.stdout.includes('claude (default) - Install ECC into ~/.claude/'),
'help text should describe the Claude target as a full ~/.claude install surface'
);
})) passed++; else failed++;
console.log(`\nResults: Passed: ${passed}, Failed: ${failed}`);
process.exit(failed > 0 ? 1 : 0);
}
runTests();