Files
openchamber/packages/web/server/lib/git/service.test.js
T

991 lines
36 KiB
JavaScript

import { execFileSync } from 'node:child_process';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { afterEach, describe, expect, it } from 'vitest';
import simpleGit from 'simple-git';
import {
checkoutCommit,
cherryPick,
createWorktree,
getWorktreeBootstrapStatus,
getStatus,
isGitRepository,
populateWorktreeWithLockRecovery,
removeWorktree,
resolvePrimaryWorktreeRoot,
resolveWorktreeTopLevel,
resetToCommit,
resolveBaseRefForLog,
revertCommit,
setLocalIdentity,
stageFiles,
unstageFiles,
applyHunk,
getDiff,
getFileDiff,
} from './service.js';
// ---------------------------------------------------------------------------
// Shared test infrastructure
// ---------------------------------------------------------------------------
const tempDirs = [];
/** Create a temp dir and register it for afterEach cleanup. */
const createTempDir = () => {
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'openchamber-git-service-'));
tempDirs.push(dir);
return dir;
};
const runGit = (cwd, args) =>
execFileSync('git', args, {
cwd,
encoding: 'utf8',
stdio: ['ignore', 'pipe', 'pipe'],
});
const canRunGit = () => {
try {
execFileSync('git', ['--version'], { stdio: 'ignore' });
return true;
} catch {
return false;
}
};
afterEach(() => {
for (const dir of tempDirs.splice(0)) {
fs.rmSync(dir, { recursive: true, force: true });
}
});
/**
* Create a temp repo using simple-git (for tests that need its assertion API).
* The dir is registered in tempDirs so afterEach handles cleanup automatically.
*/
async function createTempRepo() {
const tmpDir = createTempDir();
const git = simpleGit(tmpDir);
await git.init();
await git.addConfig('user.name', 'Test User', false, 'local');
await git.addConfig('user.email', 'test@example.com', false, 'local');
await git.raw(['symbolic-ref', 'HEAD', 'refs/heads/main']);
return { tmpDir, git };
}
// ---------------------------------------------------------------------------
// resolveBaseRefForLog
// ---------------------------------------------------------------------------
describe('resolveBaseRefForLog', () => {
it('returns the local ref unchanged when it exists, even if origin also exists', async () => {
const checkRef = async (ref) => ref === 'main' || ref === 'refs/remotes/origin/main';
expect(await resolveBaseRefForLog('main', checkRef)).toBe('main');
});
it('falls back to origin/<from> when local ref cannot be resolved but origin can', async () => {
const checkRef = async (ref) => ref === 'refs/remotes/origin/main';
expect(await resolveBaseRefForLog('main', checkRef)).toBe('origin/main');
});
it('returns the original ref when neither local nor origin ref can be resolved', async () => {
const checkRef = async () => false;
expect(await resolveBaseRefForLog('nonexistent-branch', checkRef)).toBe('nonexistent-branch');
});
it('returns undefined when from is undefined', async () => {
const checkRef = async () => true;
expect(await resolveBaseRefForLog(undefined, checkRef)).toBeUndefined();
});
it('returns undefined when from is an empty string', async () => {
const checkRef = async () => true;
expect(await resolveBaseRefForLog('', checkRef)).toBeUndefined();
});
it('returns undefined when from is a whitespace-only string', async () => {
const checkRef = async () => true;
expect(await resolveBaseRefForLog(' ', checkRef)).toBeUndefined();
});
});
// ---------------------------------------------------------------------------
// git index path validation
// ---------------------------------------------------------------------------
describe('git index path validation', () => {
it('rejects stage paths outside the repository before invoking git', async () => {
await expect(stageFiles('/repo', ['../secret.txt'])).rejects.toThrow(
'Path is outside repository: ../secret.txt'
);
});
it('rejects unstage paths outside the repository before invoking git', async () => {
await expect(unstageFiles('/repo', ['../secret.txt'])).rejects.toThrow(
'Path is outside repository: ../secret.txt'
);
});
});
describe.runIf(canRunGit())('setLocalIdentity', () => {
it('configures the local SSH command with the targeted simple-git opt-in', async () => {
const { tmpDir } = await createTempRepo();
await setLocalIdentity(tmpDir, {
userName: 'SSH User',
userEmail: 'ssh@example.com',
authType: 'ssh',
sshKey: '/tmp/test key',
});
expect(runGit(tmpDir, ['config', '--local', '--get', 'core.sshCommand']).trim()).toBe(
"ssh -i '/tmp/test key' -o IdentitiesOnly=yes"
);
});
});
// ---------------------------------------------------------------------------
// applyHunk (per-hunk stage / unstage / discard)
// ---------------------------------------------------------------------------
/** Minimal unified-diff splitter: returns standalone per-hunk patches. */
const splitHunks = (patch) => {
const lines = patch.split(/\r?\n/);
const headerEnd = lines.findIndex((line) => /^@@\s/.test(line));
if (headerEnd === -1) return [];
const header = lines.slice(0, headerEnd);
const hunks = [];
for (let i = headerEnd; i < lines.length; i += 1) {
const line = lines[i];
if (/^@@\s/.test(line)) hunks.push([...header, line]);
else if (hunks.length > 0) hunks[hunks.length - 1].push(line);
}
return hunks.map((hunk) => hunk.join('\n'))
.filter((hunk) => hunk.trim().length > 0)
.map((hunk) => (hunk.endsWith('\n') ? hunk : `${hunk}\n`));
};
const writeFile = (repo, name, contents) =>
fs.promises.writeFile(path.join(repo, name), contents, 'utf8');
// Build a 20-line file so changes on line 1 and line 20 stay in separate hunks
// (default 3-line diff context would merge closer edits into one hunk).
const makeFile = (first, last) =>
[first, ...Array.from({ length: 18 }, (_, i) => `line${i + 2}`), last].join('\n') + '\n';
const ORIGINAL_FILE = makeFile('line1', 'line20');
const EDITED_FILE = makeFile('TOP', 'BOTTOM');
const readWorking = (repo) => fs.promises.readFile(path.join(repo, 'file.txt'), 'utf8').then((c) => c.replace(/\r\n/g, '\n'));
const readStaged = async (git) => (await git.raw(['show', ':file.txt'])).replace(/\r\n/g, '\n');
describe('applyHunk', () => {
it('rejects an invalid action or a patch without a hunk header', async () => {
const { tmpDir } = await createTempRepo();
await expect(applyHunk(tmpDir, 'file.txt', { patch: '@@ -1 +1 @@\n a\n', action: 'bogus' })).rejects.toThrow(
'Invalid hunk action'
);
await expect(applyHunk(tmpDir, 'file.txt', { patch: 'no hunk here', action: 'stage' })).rejects.toThrow(
'hunk header'
);
});
it('stages a single hunk while leaving the rest unstaged', async () => {
if (!canRunGit()) return;
const { tmpDir, git } = await createTempRepo();
await writeFile(tmpDir, 'file.txt', ORIGINAL_FILE);
await git.add('file.txt');
await git.commit('Initial');
await writeFile(tmpDir, 'file.txt', EDITED_FILE);
const diff = await getDiff(tmpDir, { path: 'file.txt' });
const hunks = splitHunks(diff);
expect(hunks.length).toBe(2);
await applyHunk(tmpDir, 'file.txt', { patch: hunks[0], action: 'stage' });
expect(await readStaged(git)).toBe(makeFile('TOP', 'line20'));
expect(await readWorking(tmpDir)).toBe(EDITED_FILE);
});
it('discards a single hunk from the working tree', async () => {
if (!canRunGit()) return;
const { tmpDir, git } = await createTempRepo();
await writeFile(tmpDir, 'file.txt', ORIGINAL_FILE);
await git.add('file.txt');
await git.commit('Initial');
await writeFile(tmpDir, 'file.txt', EDITED_FILE);
const diff = await getDiff(tmpDir, { path: 'file.txt' });
const hunks = splitHunks(diff);
expect(hunks.length).toBe(2);
await applyHunk(tmpDir, 'file.txt', { patch: hunks[1], action: 'discard' });
expect(await readWorking(tmpDir)).toBe(makeFile('TOP', 'line20'));
});
it('unstages a single hunk from the index', async () => {
if (!canRunGit()) return;
const { tmpDir, git } = await createTempRepo();
await writeFile(tmpDir, 'file.txt', ORIGINAL_FILE);
await git.add('file.txt');
await git.commit('Initial');
await writeFile(tmpDir, 'file.txt', EDITED_FILE);
await git.add('file.txt');
const stagedDiff = await getDiff(tmpDir, { path: 'file.txt', staged: true });
const hunks = splitHunks(stagedDiff);
expect(hunks.length).toBe(2);
await applyHunk(tmpDir, 'file.txt', { patch: hunks[0], action: 'unstage' });
// Only the first hunk (line1 -> TOP) was reverted in the index;
// the second hunk (BOTTOM) stays staged.
expect(await readStaged(git)).toBe(makeFile('line1', 'BOTTOM'));
});
it('rejects a patch whose target path does not match the requested file', async () => {
if (!canRunGit()) return;
const { tmpDir, git } = await createTempRepo();
await writeFile(tmpDir, 'file.txt', ORIGINAL_FILE);
await git.add('file.txt');
await git.commit('Initial');
await writeFile(tmpDir, 'file.txt', makeFile('CHANGED', 'line20'));
const diff = await getDiff(tmpDir, { path: 'file.txt' });
const [hunk] = splitHunks(diff);
const retargeted = hunk.replace(/file\.txt/g, 'other.txt');
await expect(applyHunk(tmpDir, 'file.txt', { patch: retargeted, action: 'stage' })).rejects.toThrow(
'patch target path does not match'
);
});
it('accepts hunk patches for files with spaces in their path', async () => {
if (!canRunGit()) return;
const { tmpDir, git } = await createTempRepo();
const filePath = 'file name.txt';
await writeFile(tmpDir, filePath, ORIGINAL_FILE);
await git.add(filePath);
await git.commit('Initial');
await writeFile(tmpDir, filePath, EDITED_FILE);
const diff = await getDiff(tmpDir, { path: filePath });
const hunks = splitHunks(diff);
expect(hunks.length).toBe(2);
await applyHunk(tmpDir, filePath, { patch: hunks[0], action: 'stage' });
const staged = (await git.raw(['show', `:${filePath}`])).replace(/\r\n/g, '\n');
expect(staged).toBe(makeFile('TOP', 'line20'));
});
});
describe('symlink diffs', () => {
it('treats an untracked directory symlink as a link in patch and split diffs', async () => {
if (!canRunGit() || process.platform === 'win32') return;
const { tmpDir } = await createTempRepo();
fs.mkdirSync(path.join(tmpDir, 'source'));
fs.symlinkSync('source', path.join(tmpDir, 'linked-source'));
const patch = await getDiff(tmpDir, { path: 'linked-source' });
const split = await getFileDiff(tmpDir, { path: 'linked-source' });
expect(patch).toContain('new file mode 120000');
expect(patch).toContain('+source');
expect(split).toMatchObject({
original: '',
modified: 'source',
isBinary: false,
});
});
});
// ---------------------------------------------------------------------------
// getStatus
// ---------------------------------------------------------------------------
describe('getStatus', () => {
it('handles repositories without upstream tracking', async () => {
if (!canRunGit()) return;
const repo = createTempDir();
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
await expect(getStatus(repo)).resolves.toMatchObject({ current: 'main' });
});
it('rejects a non-git folder without using process.cwd()', async () => {
if (!canRunGit()) return;
const nonGit = createTempDir();
const previousCwd = process.cwd();
process.chdir(nonGit);
try {
await expect(getStatus(nonGit)).rejects.toThrow(/not a git repository/i);
} finally {
process.chdir(previousCwd);
}
});
it('reads status for a git repo when process.cwd() is elsewhere', async () => {
if (!canRunGit()) return;
const repo = createTempDir();
const neutralCwd = createTempDir();
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
const previousCwd = process.cwd();
process.chdir(neutralCwd);
try {
await expect(getStatus(repo)).resolves.toMatchObject({ current: 'main', isClean: true });
await expect(isGitRepository(repo)).resolves.toBe(true);
await expect(isGitRepository(neutralCwd)).resolves.toBe(false);
} finally {
process.chdir(previousCwd);
}
});
it('supports a folder with nested git repositories from a foreign cwd', async () => {
if (!canRunGit()) return;
const parent = createTempDir();
const nested = path.join(parent, 'nested');
const neutralCwd = createTempDir();
fs.mkdirSync(nested, { recursive: true });
runGit(parent, ['init', '-b', 'main']);
runGit(parent, ['config', 'user.email', 'test@example.com']);
runGit(parent, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(parent, 'README.md'), '# Parent\n');
runGit(parent, ['add', 'README.md']);
runGit(parent, ['commit', '-m', 'Parent commit']);
runGit(nested, ['init', '-b', 'feature']);
runGit(nested, ['config', 'user.email', 'test@example.com']);
runGit(nested, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(nested, 'nested.txt'), 'nested\n');
runGit(nested, ['add', 'nested.txt']);
runGit(nested, ['commit', '-m', 'Nested commit']);
const previousCwd = process.cwd();
process.chdir(neutralCwd);
try {
await expect(getStatus(parent)).resolves.toMatchObject({ current: 'main' });
await expect(getStatus(nested)).resolves.toMatchObject({ current: 'feature' });
// Enumeration must continue when one path is not a repo.
const results = await Promise.allSettled([
getStatus(parent),
getStatus(neutralCwd),
getStatus(nested),
]);
expect(results[0].status).toBe('fulfilled');
expect(results[1].status).toBe('rejected');
expect(results[1].reason?.message || String(results[1].reason)).toMatch(/not a git repository/i);
expect(results[2].status).toBe('fulfilled');
} finally {
process.chdir(previousCwd);
}
});
});
// ---------------------------------------------------------------------------
// worktree root resolution
// ---------------------------------------------------------------------------
describe('worktree root resolution', () => {
it('resolves the git toplevel for a repository subdirectory', async () => {
if (!canRunGit()) return;
const repo = createTempDir();
const subdirectory = path.join(repo, 'packages', 'app');
runGit(repo, ['init', '-b', 'main']);
fs.mkdirSync(subdirectory, { recursive: true });
await expect(resolveWorktreeTopLevel(subdirectory)).resolves.toEqual({ root: fs.realpathSync(repo) });
});
it('resolves the primary worktree root from a linked worktree', async () => {
if (!canRunGit()) return;
const repo = createTempDir();
const worktree = createTempDir();
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
fs.rmSync(worktree, { recursive: true, force: true });
runGit(repo, ['worktree', 'add', '-b', 'feature/test', worktree, 'HEAD']);
await expect(resolvePrimaryWorktreeRoot(worktree)).resolves.toEqual({ root: fs.realpathSync(repo) });
});
});
// ---------------------------------------------------------------------------
// createWorktree
// ---------------------------------------------------------------------------
describe('createWorktree', () => {
it('returns ready/setup-ready when no bootstrap state is recorded', async () => {
const directory = path.join(createTempDir(), 'missing-worktree');
await expect(getWorktreeBootstrapStatus(directory)).resolves.toMatchObject({
status: 'ready',
phase: 'setup-ready',
error: null,
});
});
it('reports directory, Git, and setup bootstrap phases while preserving legacy status', async () => {
if (!canRunGit()) return;
const previousXdgDataHome = process.env.XDG_DATA_HOME;
const dataHome = createTempDir();
const setupMarker = path.join(dataHome, 'setup-started');
const setupScript = path.join(dataHome, 'setup-phase.cjs');
process.env.XDG_DATA_HOME = dataHome;
fs.writeFileSync(
setupScript,
`require('node:fs').writeFileSync(${JSON.stringify(setupMarker)}, 'started'); setTimeout(() => {}, 1000);\n`,
);
try {
const repo = createTempDir();
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
const created = await createWorktree(repo, {
mode: 'new',
branchName: 'feature/bootstrap-phases',
worktreeName: 'bootstrap-phases',
returnAfterDirectoryCreated: true,
startCommand: `${JSON.stringify(process.execPath)} ${JSON.stringify(setupScript)}`,
});
expect(created.bootstrapStatus).toMatchObject({
status: 'pending',
phase: 'directory-created',
error: null,
});
await expect.poll(() => fs.existsSync(setupMarker), { timeout: 5_000 }).toBe(true);
await expect(getWorktreeBootstrapStatus(created.path)).resolves.toMatchObject({
status: 'pending',
phase: 'git-ready',
error: null,
});
await expect.poll(
async () => (await getWorktreeBootstrapStatus(created.path)).phase,
{ timeout: 5_000 },
).toBe('setup-ready');
await expect(getWorktreeBootstrapStatus(created.path)).resolves.toMatchObject({
status: 'ready',
phase: 'setup-ready',
error: null,
});
} finally {
if (previousXdgDataHome === undefined) {
delete process.env.XDG_DATA_HOME;
} else {
process.env.XDG_DATA_HOME = previousXdgDataHome;
}
}
});
it('waits for active bootstrap work before removing a worktree', async () => {
if (!canRunGit()) return;
const previousXdgDataHome = process.env.XDG_DATA_HOME;
const dataHome = createTempDir();
const setupStarted = path.join(dataHome, 'remove-race-started');
const setupCompleted = path.join(dataHome, 'remove-race-completed');
const setupScript = path.join(dataHome, 'remove-race.cjs');
process.env.XDG_DATA_HOME = dataHome;
fs.writeFileSync(
setupScript,
`const fs = require('node:fs'); fs.writeFileSync(${JSON.stringify(setupStarted)}, 'started'); setTimeout(() => fs.writeFileSync(${JSON.stringify(setupCompleted)}, 'completed'), 300);\n`,
);
try {
const repo = createTempDir();
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
const created = await createWorktree(repo, {
mode: 'new',
branchName: 'feature/remove-bootstrap-race',
worktreeName: 'remove-bootstrap-race',
returnAfterDirectoryCreated: true,
startCommand: `${JSON.stringify(process.execPath)} ${JSON.stringify(setupScript)}`,
});
await expect.poll(() => fs.existsSync(setupStarted), { timeout: 5_000 }).toBe(true);
let removalCompleted = false;
const removal = removeWorktree(repo, { directory: created.path }).then(() => {
removalCompleted = true;
});
await new Promise((resolve) => setTimeout(resolve, 25));
expect(removalCompleted).toBe(false);
await removal;
expect(fs.existsSync(setupCompleted)).toBe(true);
expect(fs.existsSync(created.path)).toBe(false);
await expect(getWorktreeBootstrapStatus(created.path)).resolves.toMatchObject({
status: 'ready',
phase: 'setup-ready',
});
} finally {
if (previousXdgDataHome === undefined) {
delete process.env.XDG_DATA_HOME;
} else {
process.env.XDG_DATA_HOME = previousXdgDataHome;
}
}
});
it('recovers from an unchanged stale index lock while populating a worktree', async () => {
if (!canRunGit()) return;
const repo = createTempDir();
const worktree = createTempDir();
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
fs.rmSync(worktree, { recursive: true, force: true });
runGit(repo, ['worktree', 'add', '--no-checkout', '-b', 'feature/stale-lock', worktree, 'HEAD']);
const lockPath = runGit(worktree, ['rev-parse', '--git-path', 'index.lock']).trim();
fs.writeFileSync(lockPath, 'stale');
await expect(populateWorktreeWithLockRecovery(worktree)).resolves.toBeUndefined();
expect(fs.existsSync(lockPath)).toBe(false);
expect(fs.readFileSync(path.join(worktree, 'README.md'), 'utf8')).toBe('# Test\n');
});
it('preflights fast create branch-in-use failures before creating the candidate directory', async () => {
if (!canRunGit()) return;
const previousXdgDataHome = process.env.XDG_DATA_HOME;
const dataHome = createTempDir();
process.env.XDG_DATA_HOME = dataHome;
try {
const repo = createTempDir();
const worktree = createTempDir();
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
const projectID = runGit(repo, ['rev-list', '--max-parents=0', '--all']).trim();
fs.rmSync(worktree, { recursive: true, force: true });
runGit(repo, ['worktree', 'add', '-b', 'feature/in-use', worktree, 'HEAD']);
const canonicalWorktree = fs.realpathSync(worktree);
await expect(createWorktree(repo, {
mode: 'existing',
existingBranch: 'feature/in-use',
branchName: 'feature/in-use',
worktreeName: 'feature-in-use',
returnAfterDirectoryCreated: true,
})).rejects.toThrow(`Branch is already checked out in ${canonicalWorktree}`);
const candidateDirectory = path.join(dataHome, 'opencode', 'worktree', projectID, 'feature-in-use');
expect(fs.existsSync(candidateDirectory)).toBe(false);
} finally {
if (previousXdgDataHome === undefined) {
delete process.env.XDG_DATA_HOME;
} else {
process.env.XDG_DATA_HOME = previousXdgDataHome;
}
}
});
});
// ---------------------------------------------------------------------------
// removeWorktree
// ---------------------------------------------------------------------------
describe('removeWorktree', () => {
it('forgets unmanaged orphan worktree entries without deleting files', async () => {
if (!canRunGit()) return;
const previousXdgDataHome = process.env.XDG_DATA_HOME;
const dataHome = createTempDir();
process.env.XDG_DATA_HOME = dataHome;
try {
const repo = createTempDir();
const sentinel = createTempDir();
const canary = path.join(sentinel, 'canary.txt');
runGit(repo, ['init', '-b', 'main']);
runGit(repo, ['config', 'user.email', 'test@example.com']);
runGit(repo, ['config', 'user.name', 'Test User']);
fs.writeFileSync(path.join(repo, 'README.md'), '# Test\n');
runGit(repo, ['add', 'README.md']);
runGit(repo, ['commit', '-m', 'Initial commit']);
fs.writeFileSync(canary, 'sentinel');
await expect(removeWorktree(repo, {
directory: sentinel,
deleteLocalBranch: false,
})).resolves.toBe(true);
expect(fs.existsSync(canary)).toBe(true);
} finally {
if (previousXdgDataHome === undefined) {
delete process.env.XDG_DATA_HOME;
} else {
process.env.XDG_DATA_HOME = previousXdgDataHome;
}
}
});
});
// ---------------------------------------------------------------------------
// checkoutCommit
// ---------------------------------------------------------------------------
describe('checkoutCommit', () => {
it('checks out a valid commit and puts the repo in detached HEAD state', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'first', 'utf8');
await git.add('file.txt');
const firstCommit = await git.commit('First commit');
await fs.promises.writeFile(filePath, 'second', 'utf8');
await git.add('file.txt');
await git.commit('Second commit');
const result = await checkoutCommit(tmpDir, firstCommit.commit);
expect(result).toEqual({ success: true });
const status = await git.status();
expect(status.detached).toBe(true);
});
it('throws an error for an invalid/nonexistent hash', async () => {
const { tmpDir } = await createTempRepo();
await expect(checkoutCommit(tmpDir, 'invalidhash123')).rejects.toThrow();
});
});
// ---------------------------------------------------------------------------
// cherryPick
// ---------------------------------------------------------------------------
describe('cherryPick', () => {
it('cherry-picks a commit that applies cleanly', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'line1\nline2\n', 'utf8');
await git.add('file.txt');
await git.commit('Initial commit');
await git.checkoutBranch('feature', 'HEAD');
await fs.promises.writeFile(filePath, 'line1\nline2\nline3\n', 'utf8');
await git.add('file.txt');
const featureCommit = await git.commit('Add line3');
await git.checkout('main');
const result = await cherryPick(tmpDir, featureCommit.commit);
expect(result).toEqual({ success: true, conflict: false });
const content = await fs.promises.readFile(filePath, 'utf8');
expect(content).toBe('line1\nline2\nline3\n');
});
it('returns conflict info when cherry-picking a conflicting commit', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'line1\nline2\n', 'utf8');
await git.add('file.txt');
await git.commit('Initial commit');
await git.checkoutBranch('feature', 'HEAD');
await fs.promises.writeFile(filePath, 'line1\nfeature-line2\n', 'utf8');
await git.add('file.txt');
const featureCommit = await git.commit('Change line2 in feature');
await git.checkout('main');
await fs.promises.writeFile(filePath, 'line1\nmain-line2\n', 'utf8');
await git.add('file.txt');
await git.commit('Change line2 in main');
const result = await cherryPick(tmpDir, featureCommit.commit);
expect(result.success).toBe(false);
expect(result.conflict).toBe(true);
expect(Array.isArray(result.conflictFiles)).toBe(true);
expect(result.conflictFiles.length).toBeGreaterThan(0);
});
it('throws for an invalid/nonexistent hash', async () => {
const { tmpDir } = await createTempRepo();
await expect(cherryPick(tmpDir, 'deadbeef00000000')).rejects.toThrow();
});
});
// ---------------------------------------------------------------------------
// revertCommit
// ---------------------------------------------------------------------------
describe('revertCommit', () => {
it('reverts a commit and stages the revert changes', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'line1\nline2\n', 'utf8');
await git.add('file.txt');
await git.commit('Initial commit');
await fs.promises.writeFile(filePath, 'line1\nline2\nline3\n', 'utf8');
await git.add('file.txt');
const changeCommit = await git.commit('Add line3');
const result = await revertCommit(tmpDir, changeCommit.commit);
expect(result).toEqual({ success: true, conflict: false });
const status = await git.status();
expect(status.staged.length).toBeGreaterThan(0);
const content = await fs.promises.readFile(filePath, 'utf8');
expect(content).toBe('line1\nline2\n');
});
it('returns conflict info when reverting causes a conflict', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'line1\nline2\nline3\n', 'utf8');
await git.add('file.txt');
await git.commit('Initial commit');
await fs.promises.writeFile(filePath, 'line1\nchanged-a\nline3\n', 'utf8');
await git.add('file.txt');
const commitA = await git.commit('Change line2 to changed-a');
await fs.promises.writeFile(filePath, 'line1\nchanged-b\nline3\n', 'utf8');
await git.add('file.txt');
await git.commit('Change line2 to changed-b');
const result = await revertCommit(tmpDir, commitA.commit);
expect(result.success).toBe(false);
expect(result.conflict).toBe(true);
expect(Array.isArray(result.conflictFiles)).toBe(true);
expect(result.conflictFiles.length).toBeGreaterThan(0);
});
it('throws for an invalid/nonexistent hash', async () => {
const { tmpDir } = await createTempRepo();
await expect(revertCommit(tmpDir, 'deadbeef00000000')).rejects.toThrow();
});
});
// ---------------------------------------------------------------------------
// resetToCommit
// ---------------------------------------------------------------------------
describe('resetToCommit', () => {
it('soft reset moves HEAD without touching the working tree', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'first\n', 'utf8');
await git.add('file.txt');
const firstCommit = await git.commit('First commit');
await fs.promises.writeFile(filePath, 'second\n', 'utf8');
await git.add('file.txt');
await git.commit('Second commit');
const result = await resetToCommit(tmpDir, firstCommit.commit, 'soft');
expect(result).toEqual({ success: true });
const log = await git.log();
expect(log.latest.hash).toBe(firstCommit.commit);
const content = await fs.promises.readFile(filePath, 'utf8');
expect(content).toBe('second\n');
const status = await git.status();
expect(status.staged.length).toBeGreaterThan(0);
});
it('mixed reset moves HEAD and unstages changes', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'first\n', 'utf8');
await git.add('file.txt');
const firstCommit = await git.commit('First commit');
await fs.promises.writeFile(filePath, 'second\n', 'utf8');
await git.add('file.txt');
await git.commit('Second commit');
const result = await resetToCommit(tmpDir, firstCommit.commit, 'mixed');
expect(result).toEqual({ success: true });
const log = await git.log();
expect(log.latest.hash).toBe(firstCommit.commit);
const content = await fs.promises.readFile(filePath, 'utf8');
expect(content).toBe('second\n');
const status = await git.status();
expect(status.staged.length).toBe(0);
expect(status.modified.length).toBeGreaterThan(0);
});
it('hard reset with clean working tree succeeds', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'first\n', 'utf8');
await git.add('file.txt');
const firstCommit = await git.commit('First commit');
await fs.promises.writeFile(filePath, 'second\n', 'utf8');
await git.add('file.txt');
await git.commit('Second commit');
const result = await resetToCommit(tmpDir, firstCommit.commit, 'hard');
expect(result).toEqual({ success: true });
const log = await git.log();
expect(log.latest.hash).toBe(firstCommit.commit);
const content = await fs.promises.readFile(filePath, 'utf8');
expect(content).toBe('first\n');
const status = await git.status();
expect(status.isClean()).toBe(true);
});
it('hard reset with dirty working tree without force throws', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'first\n', 'utf8');
await git.add('file.txt');
const firstCommit = await git.commit('First commit');
await fs.promises.writeFile(filePath, 'second\n', 'utf8');
await git.add('file.txt');
await git.commit('Second commit');
await fs.promises.writeFile(filePath, 'dirty\n', 'utf8');
await expect(resetToCommit(tmpDir, firstCommit.commit, 'hard')).rejects.toThrow(
'Cannot hard reset: uncommitted changes in working tree'
);
});
it('hard reset with dirty working tree with force succeeds', async () => {
const { tmpDir, git } = await createTempRepo();
const filePath = path.join(tmpDir, 'file.txt');
await fs.promises.writeFile(filePath, 'first\n', 'utf8');
await git.add('file.txt');
const firstCommit = await git.commit('First commit');
await fs.promises.writeFile(filePath, 'second\n', 'utf8');
await git.add('file.txt');
await git.commit('Second commit');
await fs.promises.writeFile(filePath, 'dirty\n', 'utf8');
const result = await resetToCommit(tmpDir, firstCommit.commit, 'hard', true);
expect(result).toEqual({ success: true });
const log = await git.log();
expect(log.latest.hash).toBe(firstCommit.commit);
const content = await fs.promises.readFile(filePath, 'utf8');
expect(content).toBe('first\n');
});
});
// ---------------------------------------------------------------------------
// hash validation
// ---------------------------------------------------------------------------
describe('hash validation', () => {
it('checkoutCommit rejects non-hex hash', async () => {
await expect(checkoutCommit('/tmp', '--hard')).rejects.toThrow('Invalid commit hash');
});
it('checkoutCommit rejects ref name', async () => {
await expect(checkoutCommit('/tmp', 'HEAD')).rejects.toThrow('Invalid commit hash');
});
it('checkoutCommit accepts valid 40-char hex format', async () => {
await expect(
checkoutCommit('/tmp', '1234567890abcdef1234567890abcdef12345678')
).rejects.not.toThrow('Invalid commit hash');
});
it('cherryPick rejects non-hex hash', async () => {
await expect(cherryPick('/tmp', '--hard')).rejects.toThrow('Invalid commit hash');
});
it('cherryPick rejects ref name', async () => {
await expect(cherryPick('/tmp', 'HEAD')).rejects.toThrow('Invalid commit hash');
});
it('cherryPick accepts valid 40-char hex format', async () => {
await expect(
cherryPick('/tmp', '1234567890abcdef1234567890abcdef12345678')
).rejects.not.toThrow('Invalid commit hash');
});
it('revertCommit rejects non-hex hash', async () => {
await expect(revertCommit('/tmp', '--hard')).rejects.toThrow('Invalid commit hash');
});
it('revertCommit rejects ref name', async () => {
await expect(revertCommit('/tmp', 'HEAD')).rejects.toThrow('Invalid commit hash');
});
it('revertCommit accepts valid 40-char hex format', async () => {
await expect(
revertCommit('/tmp', '1234567890abcdef1234567890abcdef12345678')
).rejects.not.toThrow('Invalid commit hash');
});
it('resetToCommit rejects non-hex hash', async () => {
await expect(resetToCommit('/tmp', '--hard', 'soft')).rejects.toThrow('Invalid commit hash');
});
it('resetToCommit rejects ref name', async () => {
await expect(resetToCommit('/tmp', 'HEAD', 'soft')).rejects.toThrow('Invalid commit hash');
});
it('resetToCommit accepts valid 40-char hex format', async () => {
await expect(
resetToCommit('/tmp', '1234567890abcdef1234567890abcdef12345678', 'soft')
).rejects.not.toThrow('Invalid commit hash');
});
});