FoXiMao/a-share-analysis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(GOV-012): 升级 Schema 基线 format v3

Browse Source
This commit is contained in:
FoXiMao
2026-08-18 02:24:54 +08:00
parent dc8ad7d4b6
commit c11de09fa7
4 changed files with 396 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/database/schema-baseline.test.mjs
+138 -37
View File
@@ -1,6 +1,6 @@
import assert from 'node:assert/strict';
import { createHash } from 'node:crypto';
import { mkdirSync, mkdtempSync, readFileSync, writeFileSync } from 'node:fs';
import { mkdirSync, mkdtempSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
import { tmpdir } from 'node:os';
import path from 'node:path';
import test from 'node:test';
@@ -45,6 +45,20 @@ const validMetadata = Object.freeze({
generatedAt: '2026-08-13T03:00:00.000Z',
});
const validNodeMetadata = Object.freeze({
formatVersion: 3,
applicationVersion: 'v0.0.9',
gitCommit: '88e2fdffc8c71dd682405c148a81953a8dcee9d6',
exporterName: 'mysql2-show-create',
exporterVersion: '1.0.0',
driverName: 'mysql2',
driverVersion: '3.23.3',
serverVersion: '5.7.42-log',
databaseCharset: 'utf8mb4',
databaseCollation: 'utf8mb4_general_ci',
generatedAt: '2026-08-18T00:00:00.000Z',
});
function makeTemporaryDirectory() {
return mkdtempSync(path.join(tmpdir(), 'a-share-schema-baseline-'));
}
@@ -300,6 +314,29 @@ test('拒绝静默覆盖已存在且内容不同的版本基线', () => {
);
});
test('写入第三个文件失败时清理目标目录和临时目录', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
const artifacts = buildCapturedArtifacts(
validMetadata,
'CREATE TABLE `sample` (`id` int);\n',
);
let writeCount = 0;
assert.throws(
() =>
persistBaselineArtifacts(target, artifacts, {
writeFileSync(...args) {
writeCount += 1;
if (writeCount === 3) throw new Error('injected write failure');
return writeFileSync(...args);
},
}),
/injected write failure/,
);
assert.equal(readdirSync(root).includes('v0.0.5'), false);
assert.equal(readdirSync(root).some((entry) => entry.includes('.tmp-')), false);
});
test('MySQL 未启用时只生成可验证不适用清单', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');
@@ -314,7 +351,7 @@ test('MySQL 未启用时只生成可验证不适用清单', () => {
assert.throws(() => readFileSync(path.join(target, 'checksum.sha256')), /ENOENT/);
});
test('未启用入口不调用数据库且拒绝额外命令参数', () => {
test('未启用入口不调用数据库且拒绝额外命令参数', async () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
@@ -323,7 +360,7 @@ test('未启用入口不调用数据库且拒绝额外命令参数', () => {
);
let executionCount = 0;
const result = runBaselineGeneration({
const result = await runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.5',
@@ -337,13 +374,13 @@ test('未启用入口不调用数据库且拒绝额外命令参数', () => {
assert.equal(result.status, 'not_applicable');
assert.equal(executionCount, 0);
assert.throws(
await assert.rejects(
() => runBaselineGeneration({ ...result, commandArguments: ['--env', 'production.env'] }),
/不接受命令参数/,
);
});
test('启用入口分别校验 mysql 与 mysqldump 客户端版本', () => {
test('启用入口使用异步 Node exporter', async () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
@@ -353,31 +390,27 @@ test('启用入口分别校验 mysql 与 mysqldump 客户端版本', () => {
.join('\n'),
);
assert.throws(
() =>
runBaselineGeneration({
const result = await runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.5',
gitCommit: validMetadata.gitCommit,
generatedAt: validMetadata.generatedAt,
executeFile(command, args) {
if (args[0] === '--version') {
return command === 'mysql'
? 'mysql Ver 8.0.39 for macos'
: 'mysqldump Ver 10.13 Distrib 5.7.44, for macos';
}
if (command === 'mysql') {
return '5.7.42-log\tutf8mb4\tutf8mb4_general_ci\n';
}
return 'CREATE TABLE `sample` (`id` int);\n';
},
}),
/mysql 客户端必须为 5\.7/,
);
exportSchema: async () => ({
metadata: {
...validNodeMetadata,
applicationVersion: undefined,
gitCommit: undefined,
generatedAt: undefined,
},
rawSql: '',
objectCounts: { tables: 0, views: 0, triggers: 0, routines: 0, events: 0 },
}),
});
assert.equal(result.status, 'captured_empty');
});
test('幂等重跑仍核对清单提交与发布标签提交', () => {
test('幂等重跑仍核对清单提交与发布标签提交', async () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
@@ -387,9 +420,8 @@ test('幂等重跑仍核对清单提交与发布标签提交', () => {
const target = path.join(root, 'database', 'schema-baselines', 'v0.0.5');
persistBaselineArtifacts(target, buildNotApplicableArtifacts(validMetadata));
assert.throws(
() =>
runBaselineGeneration({
await assert.rejects(
() => runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.5',
@@ -451,7 +483,7 @@ test('仅含 mysqldump 会话设置的真实空库仍生成 captured_empty', ()
assert.deepEqual(Object.keys(artifacts.files), ['manifest.yaml']);
});
test('启用入口把 mysqldump 空结构持久化为 captured_empty', () => {
test('启用入口把 Node exporter 空结构持久化为 captured_empty', async () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
@@ -461,21 +493,17 @@ test('启用入口把 mysqldump 空结构持久化为 captured_empty', () => {
.join('\n'),
);
const result = runBaselineGeneration({
const result = await runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.8',
gitCommit: validMetadata.gitCommit,
generatedAt: validMetadata.generatedAt,
executeFile(command, args) {
if (args[0] === '--version') {
return `${command} Ver 14.14 Distrib 5.7.44, for Linux`;
}
if (command === 'mysql') {
return '5.7.42-log\tutf8mb4\tutf8mb4_general_ci\n';
}
return '';
},
exportSchema: async () => ({
metadata: { ...validNodeMetadata, applicationVersion: 'v0.0.8' },
rawSql: '',
objectCounts: { tables: 0, views: 0, triggers: 0, routines: 0, events: 0 },
}),
});
assert.equal(result.status, 'captured_empty');
@@ -488,6 +516,79 @@ test('启用入口把 mysqldump 空结构持久化为 captured_empty', () => {
);
});
test('format v3 清单使用 Node exporter/driver 字段且不复用 CLI 字段', () => {
const artifacts = buildCapturedArtifacts(
validNodeMetadata,
'CREATE TABLE `sample` (`id` int);\n',
{ tables: 1, views: 0, triggers: 0, routines: 0, events: 0 },
);
const manifest = JSON.parse(artifacts.files['manifest.yaml']);
assert.equal(manifest.format_version, 3);
assert.equal(manifest.generator, 'schema-baseline/3.0.0');
assert.equal(manifest.exporter_name, 'mysql2-show-create');
assert.equal(manifest.exporter_version, '1.0.0');
assert.equal(manifest.database_driver, 'mysql2');
assert.equal(manifest.database_driver_version, '3.23.3');
assert.equal('mysql_client_version' in manifest, false);
assert.equal('mysqldump_client_version' in manifest, false);
});
test('format v3 空库和不适用清单保留可验证状态', () => {
const emptyManifest = JSON.parse(
buildCapturedEmptyArtifacts(validNodeMetadata).files['manifest.yaml'],
);
assert.equal(emptyManifest.format_version, 3);
assert.equal(emptyManifest.status, 'captured_empty');
assert.equal(emptyManifest.object_counts.tables, 0);
const disabledManifest = JSON.parse(
buildNotApplicableArtifacts(validNodeMetadata).files['manifest.yaml'],
);
assert.equal(disabledManifest.format_version, 3);
assert.equal(disabledManifest.status, 'not_applicable');
assert.equal(disabledManifest.database_driver, 'mysql2');
assert.equal(disabledManifest.mysql_server_version, 'not_enabled');
});
test('异步 Node exporter 注入路径生成 format v3 captured_empty', async () => {
const root = makeTemporaryDirectory();
const envFile = path.join(root, 'development.env');
writeFileSync(
envFile,
Object.entries(validConfig)
.map(([key, value]) => `${key}=${value}`)
.join('\n'),
);
let exportCalls = 0;
const result = await runBaselineGeneration({
repositoryRoot: root,
envFile,
applicationVersion: 'v0.0.9',
gitCommit: validNodeMetadata.gitCommit,
generatedAt: validNodeMetadata.generatedAt,
exportSchema: async () => {
exportCalls += 1;
return {
metadata: validNodeMetadata,
rawSql: '',
objectCounts: { tables: 0, views: 0, triggers: 0, routines: 0, events: 0 },
};
},
});
assert.equal(result.status, 'captured_empty');
assert.equal(exportCalls, 1);
assert.equal(
JSON.parse(
readFileSync(
path.join(root, 'database', 'schema-baselines', 'v0.0.9', 'manifest.yaml'),
'utf8',
),
).format_version,
3,
);
});
test('基线清单中的提交必须等于发布标签指向的提交', () => {
const root = makeTemporaryDirectory();
const target = path.join(root, 'v0.0.5');