917f9a0da2
All checks were successful
Build pull request / Build pull request (pull_request) Successful in 3m54s
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
70 lines
2.6 KiB
JavaScript
70 lines
2.6 KiB
JavaScript
import { execFileSync } from 'child_process';
|
|
import { mkdtempSync, mkdirSync, rmSync, writeFileSync } from 'fs';
|
|
import { tmpdir } from 'os';
|
|
import { join } from 'path';
|
|
import { afterEach, describe, expect, it } from 'vitest';
|
|
import { buildShaPlugin, gitIn, readBuildSha } from './buildSha';
|
|
|
|
const SHA = 'b6b1d522f1c0a9d3e2b4c5d6e7f8091a2b3c4d5e';
|
|
const gitAt =
|
|
(head, status = '') =>
|
|
(cmd) =>
|
|
cmd === 'rev-parse' ? `${head}\n` : status;
|
|
|
|
describe('readBuildSha', () => {
|
|
it('reads the checkout it is built from', () => {
|
|
expect(readBuildSha({}, gitAt(SHA))).toBe(SHA);
|
|
});
|
|
it('marks a tree with uncommitted changes, so a stamp never vouches for code it does not hold', () => {
|
|
expect(readBuildSha({}, gitAt(SHA, ' M src/x.ts\n'))).toBe(`${SHA}-dirty`);
|
|
});
|
|
it('lets BUILD_SHA stand in where there is no git, and ignores a value that is not a full sha', () => {
|
|
const noGit = () => {
|
|
throw new Error('not a git repository');
|
|
};
|
|
expect(readBuildSha({ BUILD_SHA: SHA }, noGit)).toBe(SHA);
|
|
expect(readBuildSha({ BUILD_SHA: 'main' }, noGit)).toBe('unknown');
|
|
});
|
|
it("says 'unknown' rather than failing the build when git is absent", () => {
|
|
expect(
|
|
readBuildSha({}, () => {
|
|
throw new Error('spawn git ENOENT');
|
|
})
|
|
).toBe('unknown');
|
|
});
|
|
});
|
|
|
|
describe('readBuildSha against a real repository', () => {
|
|
const made = [];
|
|
afterEach(() => {
|
|
made.splice(0).forEach((d) => rmSync(d, { recursive: true, force: true }));
|
|
});
|
|
const repo = () => {
|
|
const dir = mkdtempSync(join(tmpdir(), 'buildsha-'));
|
|
made.push(dir);
|
|
const g = (...a) => execFileSync('git', a, { cwd: dir, stdio: 'ignore' });
|
|
g('init', '-q');
|
|
mkdirSync(join(dir, 'src'));
|
|
writeFileSync(join(dir, 'src', 'a.ts'), 'export {};\n');
|
|
g('add', '.');
|
|
g('-c', 'user.name=t', '-c', 'user.email=t@t', 'commit', '-qm', 'x');
|
|
return dir;
|
|
};
|
|
it("stays clean with vite's temp config file present, and is dirty with a stray source file", () => {
|
|
const dir = repo();
|
|
const run = gitIn(dir);
|
|
writeFileSync(join(dir, 'vite.config.js.timestamp-1700000000-abc123.mjs'), '');
|
|
expect(readBuildSha({}, run)).toMatch(/^[0-9a-f]{40}$/);
|
|
writeFileSync(join(dir, 'src', 'zz-stray.ts'), '');
|
|
expect(readBuildSha({}, run)).toMatch(/^[0-9a-f]{40}-dirty$/);
|
|
});
|
|
});
|
|
|
|
describe('buildShaPlugin', () => {
|
|
it("hands vite a meta tag for the page's head carrying the sha", () => {
|
|
const plugin = buildShaPlugin(SHA);
|
|
expect(plugin.transformIndexHtml()).toEqual([
|
|
{ tag: 'meta', attrs: { name: 'build-sha', content: SHA }, injectTo: 'head-prepend' },
|
|
]);
|
|
});
|
|
});
|