Files
qipai/scripts/tests/check-commit-message.test.mjs
T

97 lines
3.6 KiB
JavaScript

import assert from 'node:assert/strict';
import { mkdtemp, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join, resolve } from 'node:path';
import { spawnSync } from 'node:child_process';
import test from 'node:test';
import {
CommitMessageError,
checkCommitMessage,
parseAllowedTypes,
} from '../check-commit-message.mjs';
const checkerPath = resolve('scripts/check-commit-message.mjs');
test('接受符合格式的中文摘要', () => {
const result = checkCommitMessage('feat(M09-D1): 建立商品与库存流水底座');
assert.equal(result.type, 'feat');
assert.equal(result.scope, 'M09-D1');
});
test('接受技术英文与中文混合摘要', () => {
checkCommitMessage('fix(M09-D2): 修复 MySQL CAS 并发扣减竞态');
});
test('只校验首行并允许多行正文', () => {
checkCommitMessage('docs(spec): 固化 V5.7 中文提交规则\n\n补充风险、验证结果与回滚说明。');
});
test('拒绝全英文摘要', () => {
assert.throws(
() => checkCommitMessage('feat(M09-D1): add product inventory foundation'),
(error) => error instanceof CommitMessageError && /CJK/u.test(error.message),
);
});
test('拒绝空摘要', () => {
assert.throws(() => checkCommitMessage('feat(M09-D1): '), /摘要不能为空/u);
});
test('拒绝 Git 默认 Merge 与 Revert 标题', () => {
assert.throws(() => checkCommitMessage("Merge branch 'main'"), /Merge\/Revert/u);
assert.throws(() => checkCommitMessage('Revert "feat: add inventory"'), /Merge\/Revert/u);
});
test('接受改写为规范格式的中文回退标题', () => {
checkCommitMessage('revert(M09-D1): 回退库存流水迁移');
});
test('拒绝缺少 scope 或不允许的类型', () => {
assert.throws(() => checkCommitMessage('chore: 更新文档'), /格式错误/u);
assert.throws(() => checkCommitMessage('release(M09-D1): 发布库存底座'), /不允许的提交类型/u);
});
test('可以覆盖允许的 Conventional Commits 类型', () => {
const allowedTypes = parseAllowedTypes('feat,release');
checkCommitMessage('release(M09-D1): 发布库存底座', { allowedTypes });
assert.throws(() => checkCommitMessage('fix(M09-D1): 修复库存', { allowedTypes }), /不允许的提交类型/u);
});
test('命令行支持提交消息文件与传入字符串', async () => {
const temporaryDirectory = await mkdtemp(join(tmpdir(), 'qipai-commit-message-'));
const messageFile = join(temporaryDirectory, 'COMMIT_EDITMSG');
try {
await writeFile(messageFile, 'test(M09-D1): 补充库存并发测试\n\n验证锁定与释放。\n', 'utf8');
const fileResult = spawnSync(process.execPath, [checkerPath, '--file', messageFile], { encoding: 'utf8' });
assert.equal(fileResult.status, 0, fileResult.stderr);
assert.match(fileResult.stdout, /PASS/u);
const stringResult = spawnSync(
process.execPath,
[checkerPath, '--message', 'build(V5.7): 接入 Git 中文提交门禁'],
{ encoding: 'utf8' },
);
assert.equal(stringResult.status, 0, stringResult.stderr);
const rejectedResult = spawnSync(
process.execPath,
[checkerPath, '--message', 'build(V5.7): wire commit gate'],
{ encoding: 'utf8' },
);
assert.equal(rejectedResult.status, 1);
assert.match(rejectedResult.stderr, /FAIL/u);
const missingFileResult = spawnSync(
process.execPath,
[checkerPath, '--file', join(temporaryDirectory, 'missing-message')],
{ encoding: 'utf8' },
);
assert.equal(missingFileResult.status, 1);
assert.match(missingFileResult.stderr, /无法读取提交消息文件/u);
} finally {
await rm(temporaryDirectory, { recursive: true, force: true });
}
});