| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484 |
- import { describe, expect, it, vi } from 'vitest'
- import {
- defaultConcurrency,
- formatGateResultReason,
- gatesForMode,
- runGate,
- runGates,
- type Gate,
- type GateResult,
- } from './run-gates.ts'
- function gate(id: string, options: Partial<Gate> = {}): Gate {
- return {
- id,
- label: id,
- displayCommand: `run ${id}`,
- command: process.execPath,
- args: ['-e', ''],
- ...options,
- }
- }
- function resultFor(subject: Gate, status: GateResult['status'] = 'passed'): GateResult {
- return {
- gate: subject,
- status,
- durationMs: 10,
- output: [],
- exitCode: status === 'passed' ? 0 : 1,
- signalCode: null,
- }
- }
- function withPnpmEntrypoint<T>(action: () => T, entrypoint = '/private/pnpm.cjs'): T {
- const previous = process.env.npm_execpath
- process.env.npm_execpath = entrypoint
- try {
- return action()
- } finally {
- if (previous === undefined) Reflect.deleteProperty(process.env, 'npm_execpath')
- else process.env.npm_execpath = previous
- }
- }
- function withEnv<T>(name: string, value: string | undefined, action: () => T): T {
- const previous = process.env[name]
- if (value === undefined) Reflect.deleteProperty(process.env, name)
- else process.env[name] = value
- try {
- return action()
- } finally {
- if (previous === undefined) Reflect.deleteProperty(process.env, name)
- else process.env[name] = previous
- }
- }
- describe('gate graph validation', () => {
- it.each([
- 'ci-primary',
- 'ci-linux-primary',
- 'ci-static',
- 'ci-lint-contracts-ready',
- 'ci-coverage',
- 'ci-snapshot',
- 'ci-artifacts',
- 'ci-consumers',
- 'ci-windows-blocking',
- 'ci-windows-complete',
- 'ci-windows-observational',
- 'node-compat',
- 'check-all',
- 'hygiene',
- 'doc-sync',
- ] as const)('constructs and executes preflight for a valid non-empty %s graph', async (mode) => {
- const subject = withPnpmEntrypoint(() => gatesForMode(mode))
- const execute = vi.fn(async (item: Gate) => resultFor(item))
- await expect(runGates(subject, subject.length, execute)).resolves.toHaveLength(subject.length)
- })
- it('keeps the public repository link policy in the documentation gate', () => {
- const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
- expect(ids).toContain('public-repository-links')
- })
- it('keeps package-group subsystem ownership in the documentation gate', () => {
- const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
- expect(ids).toContain('subsystem-pages')
- })
- it('keeps the hygiene aggregate aligned with the package script checks', () => {
- const ids = withPnpmEntrypoint(() => gatesForMode('hygiene').map(subject => subject.id))
- expect(ids).toEqual([
- 'rescope-vendor', 'knip', 'publint', 'constraints', 'application-entrypoints',
- 'dsh-package-licenses', 'package-invariants', 'built-package-invariants', 'node-next-types',
- 'optional-dependency-imports', 'client-packages', 'client-ui-i18n', 'cordis-config',
- 'runtime-closure', 'vendored-links',
- ])
- expect(defaultConcurrency('hygiene', ids.length, 8)).toEqual({
- workers: 4,
- source: '8 available CPU(s), hygiene cap 4',
- })
- })
- it('schedules the longest documentation leaves before short checks', () => {
- const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
- expect(ids.slice(0, 10)).toEqual([
- 'doc-typecheck', 'docs-site-build', 'doc-graphs', 'markdown-links', 'type-equivalence',
- 'cordis-catalog', 'cordis-inspect-catalog', 'mermaid', 'scoped-events', 'translation-pairing',
- ])
- })
- it('launches a native pnpm entrypoint directly', () => {
- const entrypoint = String.raw`C:\Program Files\pnpm\pnpm.exe`
- const subject = withPnpmEntrypoint(() => gatesForMode('ci-windows-blocking')[0], entrypoint)
- expect(subject).toMatchObject({
- command: entrypoint,
- args: ['run', 'build'],
- })
- })
- it.each(['ci-primary', 'ci-static', 'check-all'] as const)(
- 'keeps the DSH package license policy in %s',
- (mode) => {
- const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
- expect(ids).toContain('dsh-package-licenses')
- },
- )
- it.each(['ci-primary', 'ci-static', 'check-all'] as const)(
- 'keeps the client dependency policy in %s',
- (mode) => {
- const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
- expect(ids).toContain('client-packages')
- },
- )
- it.each(['ci-primary', 'ci-static', 'check-all', 'hygiene'] as const)(
- 'keeps hard-coded Client UI copy enforcement in %s',
- (mode) => {
- const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
- expect(ids).toContain('client-ui-i18n')
- },
- )
- it.each(['ci-primary', 'ci-static', 'check-all', 'hygiene'] as const)(
- 'keeps application entrypoint enforcement in %s',
- (mode) => {
- const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
- expect(ids).toContain('application-entrypoints')
- },
- )
- it('keeps native Windows coverage blocking and behind the complete build', () => {
- const complete = withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))
- const observational = withPnpmEntrypoint(() => gatesForMode('ci-windows-observational'))
- .filter(gate => gate.id !== 'build' && gate.id !== 'docs-site-build')
- const byId = new Map(complete.map(subject => [subject.id, subject]))
- expect(byId.get('coverage')?.allowFailure).not.toBe(true)
- expect(byId.get('coverage-exempt-heavy')?.allowFailure).not.toBe(true)
- expect(byId.get('coverage')?.needs).toContain('build')
- expect(byId.get('coverage-exempt-heavy')?.needs).toContain('build')
- expect(observational).not.toHaveLength(0)
- for (const gate of observational) {
- const completeGate = byId.get(gate.id)
- expect(completeGate?.allowFailure).toBe(true)
- expect(completeGate?.after).toEqual(expect.arrayContaining([
- 'coverage',
- 'coverage-exempt-heavy',
- ]))
- expect(completeGate?.needs).toEqual(gate.needs)
- }
- })
- it('applies one configured test and polling timeout to both coverage gates', () => {
- const gates = withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', '15000', () =>
- withPnpmEntrypoint(() => gatesForMode('ci-windows-complete')))
- for (const id of ['coverage', 'coverage-exempt-heavy']) {
- expect(gates.find(subject => subject.id === id)?.args).toEqual(expect.arrayContaining([
- '--testTimeout=15000',
- '--expect.poll.timeout=15000',
- ]))
- }
- })
- it('keeps Vitest timeout defaults when the coverage override is absent', () => {
- const gates = withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', undefined, () =>
- withPnpmEntrypoint(() => gatesForMode('ci-windows-complete')))
- for (const id of ['coverage', 'coverage-exempt-heavy']) {
- expect(gates.find(subject => subject.id === id)?.args).not.toEqual(expect.arrayContaining([
- expect.stringMatching(/^--(?:testTimeout|expect\.poll\.timeout)=/),
- ]))
- }
- })
- it('rejects an invalid coverage timeout before starting a gate', () => {
- expect(() => withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', '0', () =>
- withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))))
- .toThrow('DSH_COVERAGE_TEST_TIMEOUT_MS must be a positive integer')
- })
- it('selects partitioned coverage only when explicitly configured', () => {
- const coverage = withEnv('DSH_COVERAGE_PARTITIONS', '3', () =>
- withPnpmEntrypoint(() => gatesForMode('ci-windows-complete').find(subject => subject.id === 'coverage')))
- expect(coverage).toMatchObject({
- displayCommand: 'DSH_COVERAGE_PARTITIONS=3 pnpm run test:coverage:partitioned',
- args: ['/private/pnpm.cjs', 'run', 'test:coverage:partitioned'],
- streamOutput: true,
- })
- })
- it('rejects an invalid coverage partition count before starting a gate', () => {
- expect(() => withEnv('DSH_COVERAGE_PARTITIONS', '1', () =>
- withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))))
- .toThrow('DSH_COVERAGE_PARTITIONS must be an integer greater than 1')
- })
- it.each([
- ['empty', [], /gate graph has no gates/],
- ['duplicate ids', [gate('same'), gate('same')], /duplicate gate id "same"/],
- ['unknown dependencies', [gate('subject', { needs: ['missing'] })], /depends on unknown gate "missing"/],
- ['unknown ordering predecessors', [gate('subject', { after: ['missing'] })], /waits for unknown gate "missing"/],
- ['cycles', [gate('first', { needs: ['second'] }), gate('second', { needs: ['first'] })], /dependency cycle: first -> second -> first/],
- ['mixed cycles', [gate('first', { after: ['second'] }), gate('second', { needs: ['first'] })], /dependency cycle: first -> second -> first/],
- ] as const)('rejects %s before starting a child', async (_label, invalid, message) => {
- const execute = vi.fn(async (subject: Gate) => resultFor(subject))
- await expect(runGates([...invalid], 1, execute)).rejects.toThrow(message)
- expect(execute).not.toHaveBeenCalled()
- })
- it('rejects an invalid worker count before starting a child', async () => {
- const execute = vi.fn(async (subject: Gate) => resultFor(subject))
- await expect(runGates([gate('subject')], 0, execute)).rejects.toThrow('max concurrency must be a positive integer')
- expect(execute).not.toHaveBeenCalled()
- })
- it('skips dependents after their prerequisite fails', async () => {
- const dependent = gate('dependent', { needs: ['root'] })
- const root = gate('root')
- const execute = vi.fn(async (subject: Gate) => resultFor(subject, 'failed'))
- const results = await runGates([dependent, root], 1, execute)
- expect(execute).toHaveBeenCalledOnce()
- expect(execute).toHaveBeenCalledWith(root)
- expect(results[0]).toMatchObject({ gate: dependent, status: 'skipped', error: 'dependency failed or skipped: root' })
- })
- it('runs an ordered follower after its predecessor fails', async () => {
- const follower = gate('follower', { after: ['root'] })
- const root = gate('root')
- const execute = vi.fn(async (subject: Gate) => resultFor(subject, subject === root ? 'failed' : 'passed'))
- const results = await runGates([follower, root], 2, execute)
- expect(execute.mock.calls.map(([subject]) => subject.id)).toEqual(['root', 'follower'])
- expect(results.map(result => result.status)).toEqual(['passed', 'failed'])
- })
- it('runs an ordered follower after its predecessor is skipped', async () => {
- const follower = gate('follower', { after: ['dependent'] })
- const dependent = gate('dependent', { needs: ['root'] })
- const root = gate('root')
- const execute = vi.fn(async (subject: Gate) => resultFor(subject, subject === root ? 'failed' : 'passed'))
- const results = await runGates([follower, dependent, root], 2, execute)
- expect(execute.mock.calls.map(([subject]) => subject.id)).toEqual(['root', 'follower'])
- expect(results.map(result => result.status)).toEqual(['passed', 'skipped', 'failed'])
- })
- })
- describe('Oxlint gate', () => {
- it('uses the package script when no worker bound is configured', () => {
- const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
- withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
- expect(subject).toMatchObject({
- id: 'lint',
- displayCommand: 'pnpm run lint:contracts-ready',
- command: process.execPath,
- args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
- })
- })
- it('surfaces the configured worker bound on the shared package script', () => {
- const subject = withEnv('DSH_OXLINT_THREADS', '4', () =>
- withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
- expect(subject).toMatchObject({
- id: 'lint',
- displayCommand: 'DSH_OXLINT_THREADS=4 pnpm run lint:contracts-ready',
- command: process.execPath,
- args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
- })
- })
- })
- describe('Typert contract preparation', () => {
- it('prepares primary source consumers once before they run', () => {
- const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
- withPnpmEntrypoint(() => gatesForMode('ci-primary')))
- expect(subject.find(item => item.id === 'typert-contracts')).toMatchObject({
- displayCommand: 'pnpm run build:lib:host',
- args: ['/private/pnpm.cjs', 'run', 'build:lib:host'],
- })
- for (const [id, script] of [
- ['typecheck', 'typecheck:contracts-ready'],
- ['lint', 'lint:contracts-ready'],
- ['doc-typecheck', 'doc-typecheck:contracts-ready'],
- ] as const) {
- expect(subject.find(item => item.id === id)).toMatchObject({
- displayCommand: `pnpm run ${script}`,
- args: ['/private/pnpm.cjs', 'run', script],
- needs: ['typert-contracts'],
- })
- }
- expect(subject.find(item => item.id === 'build')?.needs).toEqual([
- 'typecheck',
- 'lint',
- 'doc-typecheck',
- ])
- })
- it('reuses contracts from the validated consumer build', () => {
- const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
- expect(subject.find(item => item.id === 'lint-and-duplication')).toMatchObject({
- displayCommand: 'pnpm run check:ci:lint:contracts-ready',
- args: ['/private/pnpm.cjs', 'run', 'check:ci:lint:contracts-ready'],
- })
- expect(subject.find(item => item.id === 'doc-typecheck')).toMatchObject({
- displayCommand: 'pnpm run doc-typecheck:contracts-ready',
- args: ['/private/pnpm.cjs', 'run', 'doc-typecheck:contracts-ready'],
- })
- })
- it('keeps standalone doc sync responsible for preparation', () => {
- const docTypecheck = withPnpmEntrypoint(() =>
- gatesForMode('doc-sync').find(item => item.id === 'doc-typecheck'))
- expect(docTypecheck?.displayCommand).toBe('pnpm run doc-typecheck')
- })
- })
- describe('Node compatibility graph', () => {
- it('runs the jsdom environment smoke on every advertised Node line', () => {
- const subject = withPnpmEntrypoint(() => gatesForMode('node-compat'))
- expect(subject.find(item => item.id === 'vitest-jsdom-smoke')).toMatchObject({
- label: 'Vitest jsdom smoke',
- args: [
- '/private/pnpm.cjs',
- 'exec',
- 'vitest',
- 'run',
- 'scripts/vitest-environment.compat.spec.ts',
- ],
- })
- })
- })
- describe('Node 24 lane ownership', () => {
- it('keeps the static lane source-only', () => {
- const subject = withPnpmEntrypoint(() => gatesForMode('ci-static'))
- expect(subject.map(item => item.id)).not.toContain('build')
- expect(subject.map(item => item.id)).not.toContain('doc-typecheck')
- })
- it('owns the build and orders its artifact consumers', () => {
- const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
- expect(defaultConcurrency('ci-consumers', subject.length, 4)).toEqual({
- workers: 11,
- source: 'ci-consumers gate count',
- })
- expect(subject.map(item => item.id)).toEqual([
- 'build',
- 'node-compat',
- 'publint',
- 'built-package-invariants',
- 'lint-and-duplication',
- 'snapshot',
- 'expected-output',
- 'web-snapshot',
- 'doc-typecheck',
- 'node-next-types',
- 'built-bin-smoke',
- ])
- expect(subject.find(item => item.id === 'publint')?.needs).toEqual(['build'])
- expect(subject.find(item => item.id === 'build')?.env).toEqual({
- DSH_BUILD_CLIENT_PROFILE: 'official',
- })
- expect(subject.find(item => item.id === 'node-compat')?.env).toEqual({
- DSH_BUILD_CLIENT_PROFILE: 'official',
- })
- expect(subject.find(item => item.id === 'built-package-invariants')?.needs).toEqual(['build'])
- expect(subject.find(item => item.id === 'lint-and-duplication')?.needs).toEqual(['built-package-invariants'])
- for (const id of [
- 'snapshot',
- 'expected-output',
- 'web-snapshot',
- 'doc-typecheck',
- 'node-next-types',
- 'built-bin-smoke',
- ]) {
- expect(subject.find(item => item.id === id)?.needs).toEqual(['built-package-invariants'])
- }
- expect(subject.find(item => item.id === 'snapshot')?.env).toEqual({ DSH_EXAMPLE_MODE: 'lib' })
- expect(subject.find(item => item.id === 'expected-output')?.env).toEqual({ DSH_EXAMPLE_MODE: 'lib' })
- expect(subject.find(item => item.id === 'doc-typecheck')?.env).toEqual({
- DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1',
- })
- expect(subject.find(item => item.id === 'built-bin-smoke')?.args).toEqual(
- expect.arrayContaining([
- 'packages/subagent/subagent-codex/tests/loader-composition.e2e.ts',
- 'packages/subagent/subagent-claude-code/tests/loader-composition.e2e.ts',
- ]),
- )
- expect(subject.find(item => item.id === 'web-snapshot')).toMatchObject({
- displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
- env: { DSH_SNAPSHOT: 'replay' },
- })
- })
- })
- describe('Linux primary graph', () => {
- it('adds the same compare-only web gate after built client artifacts', () => {
- const subject = withPnpmEntrypoint(() => gatesForMode('ci-linux-primary'))
- const web = subject.find(item => item.id === 'web-snapshot')
- expect(web).toMatchObject({
- displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
- env: { DSH_SNAPSHOT: 'replay' },
- needs: ['built-package-invariants'],
- })
- })
- })
- describe('gate process outcomes', () => {
- it('streams selected gate output without retaining it', async () => {
- const write = vi.spyOn(process.stdout, 'write').mockReturnValue(true)
- try {
- const result = await runGate(gate('streamed', {
- args: ['-e', "process.stdout.write('live output')"],
- streamOutput: true,
- }))
- expect(result.status).toBe('passed')
- expect(result.output).toEqual([])
- expect(write).toHaveBeenCalledWith('live output')
- } finally {
- write.mockRestore()
- }
- })
- it.skipIf(process.platform === 'win32')('reports signal termination independently from exit status', async () => {
- const result = await runGate(gate('terminated', {
- args: ['-e', "process.kill(process.pid, 'SIGTERM')"],
- }))
- expect(result.status).toBe('failed')
- expect(result.exitCode).toBeNull()
- expect(result.signalCode).toBe('SIGTERM')
- expect(formatGateResultReason(result)).toBe('signal SIGTERM')
- })
- })
|