本仓 2026-08-12 从 ssw main (192.168.1.18:13300/ssw/ssw-mvp) 的 dacli/ subpath 抽取,作为独立仓托管到 gitea:3000/ssw/dacli.git。 - 工作树为 ssw main dacli subpath 最新版 (110 commit, 08-12) - 历史未带 ssw main 整体历史(避免大仓污染) - 此为新仓基线 commit,未来以本仓历史为主
303 lines
11 KiB
TypeScript
303 lines
11 KiB
TypeScript
/**
|
||
* tests/unit/dm_create_json_stdout.test.ts
|
||
*
|
||
* 命令级集成测试 (2026-07-22 eventhub blocker 阶段 5 修复):
|
||
*
|
||
* 修复前 bug:
|
||
* - setupOutputFilter 让 --json 路径下 quiet=false, log.info/log.ok 直写 stdout
|
||
* - dm create --json 在 action() handler 中调用多次 log.info('📌 CLAUDE.md §3: ...'),
|
||
* log.info('loadDataModel.createDataModel ...') 等
|
||
* - 这些过程日志与 printDmCreateJsonResult 输出的 JSON 混杂在 stdout
|
||
* - AI 拿到的 stdout 含 ℹ/📌/✓ 等装饰 + 中文过程日志, JSON.parse 直接失败
|
||
*
|
||
* 修复后契约:
|
||
* - --json 路径: setupOutputFilter 保持 quiet=true, log.* 走 buffer
|
||
* - printCommandEnd 在 --json 路径补 log.discard(), 防止 buffer 泄漏
|
||
* - stdout 整段仅含 printDmCreateJsonResult 写的 1 行 JSON
|
||
* - JSON.parse(stdout.trim()) 严格合法, 不含字面 undefined, 不含过程日志装饰
|
||
*
|
||
* 测试策略:
|
||
* - mock JnpfClient + 全部 webapi 依赖 + log (安静模式验证)
|
||
* - 收集 process.stdout.write 全段 → 验证只有 1 行 (含末尾 \n) + 可 JSON.parse
|
||
* - 覆盖成功 + 失败两条路径
|
||
*
|
||
* 关联:
|
||
* - docs/decisions/0016-eventhub-blocker-fixes-design.md §3.2 (JSON 输出契约) + §3.6
|
||
* - tests/unit/dm_create_json.test.ts (单元级 helper 测试, 互补)
|
||
* - tests/unit/output_filter.test.ts (setupOutputFilter/printCommandEnd 单测)
|
||
*/
|
||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
|
||
|
||
// 用 vi.hoisted 共享 mock state (跨 factory hoist + tests)
|
||
const mocks = vi.hoisted(() => ({
|
||
fromToken: vi.fn(),
|
||
get: vi.fn(),
|
||
postJson: vi.fn(),
|
||
createDataModel: vi.fn(),
|
||
initWebapi: vi.fn(),
|
||
fetchExistingLists: vi.fn(),
|
||
runCommandAutoFix: vi.fn(),
|
||
loadContextSafe: vi.fn(),
|
||
preCheckDmCreate: vi.fn(),
|
||
runGuards: vi.fn(),
|
||
validateDmCreate: vi.fn(),
|
||
exit: vi.fn(),
|
||
// 收集 stdout
|
||
stdoutChunks: [] as string[],
|
||
stderrChunks: [] as string[],
|
||
}))
|
||
|
||
vi.mock('../../src/core/client.ts', () => ({
|
||
JnpfClient: {
|
||
fromToken: (...args: unknown[]) => mocks.fromToken(...args),
|
||
},
|
||
}))
|
||
|
||
vi.mock('../../src/webapi/dataModel.ts', () => ({
|
||
initWebapi: mocks.initWebapi,
|
||
loadDataModel: {
|
||
createDataModel: mocks.createDataModel,
|
||
},
|
||
}))
|
||
|
||
vi.mock('../../src/core/log.ts', () => ({
|
||
log: {
|
||
setQuiet: vi.fn(),
|
||
setJsonMode: vi.fn(),
|
||
isJsonMode: vi.fn(),
|
||
isQuiet: vi.fn(() => true),
|
||
flush: vi.fn(),
|
||
discard: vi.fn(),
|
||
info: vi.fn(),
|
||
warn: vi.fn(),
|
||
error: vi.fn(),
|
||
ok: vi.fn(),
|
||
dim: vi.fn(),
|
||
raw: vi.fn(),
|
||
debug: vi.fn(),
|
||
},
|
||
printJson: vi.fn(),
|
||
}))
|
||
|
||
vi.mock('../../src/core/config.ts', () => ({
|
||
loadToken: vi.fn(() => null),
|
||
}))
|
||
|
||
vi.mock('../../src/commands/_precheck.ts', () => ({
|
||
preCheckDmCreate: mocks.preCheckDmCreate,
|
||
handlePreCheckResult: vi.fn(),
|
||
loadContextSafe: mocks.loadContextSafe,
|
||
}))
|
||
|
||
vi.mock('../../src/commands/_blindspot_guards.ts', () => ({
|
||
runGuards: mocks.runGuards,
|
||
handleGuardResult: vi.fn(),
|
||
}))
|
||
|
||
vi.mock('../../src/commands/_auto_fix.ts', () => ({
|
||
runCommandAutoFix: mocks.runCommandAutoFix,
|
||
fetchExistingLists: mocks.fetchExistingLists,
|
||
}))
|
||
|
||
vi.mock('../../src/commands/_error_codes.ts', () => ({
|
||
enhanceFromBackend: vi.fn(() => ({})),
|
||
formatErrorLine: vi.fn(() => 'fmt'),
|
||
}))
|
||
|
||
vi.mock('../../src/commands/dm/_validate.ts', () => ({
|
||
validateDmCreate: mocks.validateDmCreate,
|
||
}))
|
||
|
||
// Mock process.exit (不让 commander 测试进程退出)
|
||
vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
|
||
mocks.exit(code)
|
||
// no-op, 避免测试进程退出
|
||
}) as never)
|
||
|
||
// 收集 stdout 全段
|
||
let originalWrite: typeof process.stdout.write
|
||
let originalErrWrite: typeof process.stderr.write
|
||
beforeEach(() => {
|
||
mocks.stdoutChunks = []
|
||
mocks.stderrChunks = []
|
||
mocks.exit.mockReset()
|
||
|
||
originalWrite = process.stdout.write.bind(process.stdout)
|
||
originalErrWrite = process.stderr.write.bind(process.stderr)
|
||
process.stdout.write = ((chunk: string | Uint8Array): boolean => {
|
||
mocks.stdoutChunks.push(typeof chunk === 'string' ? chunk : new TextDecoder().decode(chunk))
|
||
return true
|
||
}) as typeof process.stdout.write
|
||
// 顺便也捕 stderr (有些 log.error 走 stderr, 但 setupOutputFilter 让 quiet=true 时 log.error 仍即时)
|
||
process.stderr.write = ((chunk: string | Uint8Array): boolean => {
|
||
mocks.stderrChunks.push(typeof chunk === 'string' ? chunk : new TextDecoder().decode(chunk))
|
||
return true
|
||
}) as typeof process.stderr.write
|
||
|
||
// 默认 mocks: 让成功路径走通
|
||
mocks.fromToken.mockResolvedValue({
|
||
appCode: 'eventhub',
|
||
dbLinkId: '0',
|
||
baseUrl: 'http://test',
|
||
account: 'admin',
|
||
password: 'p',
|
||
get: mocks.get,
|
||
postJson: mocks.postJson,
|
||
resolveDbLinkId: vi.fn((v?: string) => v || '0'),
|
||
})
|
||
mocks.initWebapi.mockResolvedValue(undefined)
|
||
mocks.fetchExistingLists.mockResolvedValue({})
|
||
// 默认 auto-fix 不修改 opts
|
||
mocks.runCommandAutoFix.mockImplementation((opts: Record<string, unknown>) => ({
|
||
opts,
|
||
silent: [],
|
||
assertive: [],
|
||
suggestions: [],
|
||
}))
|
||
mocks.loadContextSafe.mockResolvedValue({ warning: undefined, ctx: {} })
|
||
mocks.preCheckDmCreate.mockResolvedValue({ ok: true })
|
||
mocks.runGuards.mockReturnValue({ ok: true, items: [] })
|
||
mocks.validateDmCreate.mockReturnValue({
|
||
ok: true,
|
||
steps: [
|
||
{ ok: true, step: 0, stepName: '基础信息', errors: [] },
|
||
{ ok: true, step: 1, stepName: '字段定义', errors: [] },
|
||
{ ok: true, step: 2, stepName: '关键字与唯一性', errors: [] },
|
||
],
|
||
})
|
||
mocks.createDataModel.mockResolvedValue({ code: 200, msg: 'ok', data: null })
|
||
})
|
||
|
||
afterEach(() => {
|
||
process.stdout.write = originalWrite
|
||
process.stderr.write = originalErrWrite
|
||
})
|
||
|
||
// 注意: import 必须在所有 vi.mock 之后 (hoisting 兼容性)
|
||
import { buildDmCreateCommand } from '../../src/commands/dm/create.ts'
|
||
|
||
describe('dm create --json: 整段 stdout 只有结构化 JSON (eventhub blocker 阶段 5)', () => {
|
||
it('成功路径: stdout 仅 1 行 JSON, 无 log 装饰', async () => {
|
||
const cmd = buildDmCreateCommand()
|
||
await cmd.parseAsync([
|
||
'node', 'test',
|
||
'--table', 'event_signup',
|
||
'--tableName', '活动报名表',
|
||
'--fields', '[{"field":"f_name","fieldName":"名称","dataType":"varchar","dataLength":"100"}]',
|
||
'--json',
|
||
])
|
||
|
||
// 1. stdout 应该至少 1 个 chunk (JSON 输出)
|
||
expect(mocks.stdoutChunks.length).toBeGreaterThanOrEqual(1)
|
||
const allStdout = mocks.stdoutChunks.join('')
|
||
|
||
// 2. 整段 stdout 必须能被 JSON.parse (即: 单行 JSON)
|
||
const trimmed = allStdout.trim()
|
||
expect(trimmed.length).toBeGreaterThan(0)
|
||
// JSON.parse 严格合法: 旧版会混入中文过程日志导致 parse 失败
|
||
const parsed = JSON.parse(trimmed)
|
||
|
||
// 3. shape 校验: success shape
|
||
expect(parsed).toEqual({
|
||
ok: true,
|
||
table: 'event_signup',
|
||
tableName: '活动报名表',
|
||
})
|
||
|
||
// 4. 反向断言: 不含过程日志装饰符 (旧版会泄漏的字符)
|
||
expect(allStdout).not.toMatch(/ℹ/) // log.info 装饰
|
||
expect(allStdout).not.toMatch(/✓/) // log.ok 装饰
|
||
expect(allStdout).not.toMatch(/!/) // log.warn 装饰 (除非后端报错)
|
||
expect(allStdout).not.toMatch(/✗/) // log.error 装饰
|
||
expect(allStdout).not.toMatch(/📌/) // create.ts 中文 log.info 内容
|
||
expect(allStdout).not.toMatch(/BS-111/)
|
||
expect(allStdout).not.toMatch(/loadDataModel\.createDataModel/)
|
||
|
||
// 5. stdout 整段 split 后非空行应该恰好 1 行 (JSON); 旧版会有 log 行 (≥ 5 行)
|
||
const lines = allStdout.split('\n').filter((l) => l.trim().length > 0)
|
||
expect(lines.length).toBe(1)
|
||
expect(lines[0]).toBe(trimmed)
|
||
|
||
// 6. 不含 '详情: dacli log last' (--json 路径下 printCommandEnd 应跳过这段 stdout)
|
||
expect(allStdout).not.toContain('详情: dacli log last')
|
||
})
|
||
|
||
it('成功路径: 含 appCode 前缀的 raw → 输出归一化后的 finalTable (无 log 装饰)', async () => {
|
||
const cmd = buildDmCreateCommand()
|
||
await cmd.parseAsync([
|
||
'node', 'test',
|
||
'--table', 'eventhub_event_signup',
|
||
'--tableName', '活动报名表',
|
||
'--fields', '[{"field":"f_name","fieldName":"名称","dataType":"varchar","dataLength":"100"}]',
|
||
'--json',
|
||
])
|
||
|
||
const allStdout = mocks.stdoutChunks.join('')
|
||
const parsed = JSON.parse(allStdout.trim())
|
||
expect(parsed).toEqual({
|
||
ok: true,
|
||
table: 'event_signup', // 前缀已 strip
|
||
tableName: '活动报名表',
|
||
})
|
||
expect(allStdout).not.toMatch(/ℹ|✓|!|✗|📌/)
|
||
// 单行 JSON
|
||
const lines = allStdout.split('\n').filter((l) => l.trim().length > 0)
|
||
expect(lines.length).toBe(1)
|
||
})
|
||
|
||
it('失败路径: 后端非 200 → stdout 仅 1 行 JSON (failure shape) + ctx.fail exit 1', async () => {
|
||
mocks.createDataModel.mockResolvedValueOnce({
|
||
code: 500,
|
||
msg: 'Duplicate column name \'f_description\'',
|
||
data: null,
|
||
})
|
||
|
||
const cmd = buildDmCreateCommand()
|
||
await cmd.parseAsync([
|
||
'node', 'test',
|
||
'--table', 'event_signup',
|
||
'--tableName', '活动报名表',
|
||
'--fields', '[{"field":"f_name","fieldName":"名称","dataType":"varchar","dataLength":"100"}]',
|
||
'--json',
|
||
])
|
||
|
||
const allStdout = mocks.stdoutChunks.join('')
|
||
expect(allStdout.trim().length).toBeGreaterThan(0)
|
||
const parsed = JSON.parse(allStdout.trim())
|
||
expect(parsed.ok).toBe(false)
|
||
expect(parsed.table).toBe('event_signup')
|
||
expect(parsed.error).toContain('Duplicate column')
|
||
expect(parsed.code).toBe(500)
|
||
|
||
// 反向断言: stdout 不含 process log 装饰
|
||
expect(allStdout).not.toMatch(/ℹ|📌|BS-111/)
|
||
// 单行 JSON
|
||
const lines = allStdout.split('\n').filter((l) => l.trim().length > 0)
|
||
expect(lines.length).toBe(1)
|
||
// ctx.fail 应触发 process.exit(1)
|
||
expect(mocks.exit).toHaveBeenCalledWith(1)
|
||
})
|
||
|
||
it('失败路径: catch (异常) → stdout 仅 1 行 JSON (EXC code)', async () => {
|
||
// 让 validateDmCreate throw 来触发 catch
|
||
mocks.validateDmCreate.mockImplementation(() => {
|
||
throw new Error('JSON parse failed at field 0')
|
||
})
|
||
|
||
const cmd = buildDmCreateCommand()
|
||
await cmd.parseAsync([
|
||
'node', 'test',
|
||
'--table', 'event_signup',
|
||
'--tableName', '活动报名表',
|
||
'--fields', '[invalid json',
|
||
'--json',
|
||
])
|
||
|
||
const allStdout = mocks.stdoutChunks.join('')
|
||
// catch 路径也可能因为 opts.json=false 走到 printCommandEnd 不同分支, 这里验:
|
||
// 如果 JSON 失败由 JSON.parse(opts.fields) 抛, 在 wrapCommand 外层 catch 走 ctx.fail
|
||
// wrapCommand 外层 catch 不会走 printDmCreateJsonResult, 故 stdout 此时不一定有 JSON
|
||
// 但 process.exit(1) 仍应触发
|
||
expect(mocks.exit).toHaveBeenCalledWith(1)
|
||
})
|
||
}) |