run-gates.spec.ts 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  1. import { describe, expect, it, vi } from 'vitest'
  2. import {
  3. defaultConcurrency,
  4. formatGateResultReason,
  5. gatesForMode,
  6. runGate,
  7. runGates,
  8. type Gate,
  9. type GateResult,
  10. } from './run-gates.ts'
  11. function gate(id: string, options: Partial<Gate> = {}): Gate {
  12. return {
  13. id,
  14. label: id,
  15. displayCommand: `run ${id}`,
  16. command: process.execPath,
  17. args: ['-e', ''],
  18. ...options,
  19. }
  20. }
  21. function resultFor(subject: Gate, status: GateResult['status'] = 'passed'): GateResult {
  22. return {
  23. gate: subject,
  24. status,
  25. durationMs: 10,
  26. output: [],
  27. exitCode: status === 'passed' ? 0 : 1,
  28. signalCode: null,
  29. }
  30. }
  31. function withPnpmEntrypoint<T>(action: () => T, entrypoint = '/private/pnpm.cjs'): T {
  32. const previous = process.env.npm_execpath
  33. process.env.npm_execpath = entrypoint
  34. try {
  35. return action()
  36. } finally {
  37. if (previous === undefined) Reflect.deleteProperty(process.env, 'npm_execpath')
  38. else process.env.npm_execpath = previous
  39. }
  40. }
  41. function withEnv<T>(name: string, value: string | undefined, action: () => T): T {
  42. const previous = process.env[name]
  43. if (value === undefined) Reflect.deleteProperty(process.env, name)
  44. else process.env[name] = value
  45. try {
  46. return action()
  47. } finally {
  48. if (previous === undefined) Reflect.deleteProperty(process.env, name)
  49. else process.env[name] = previous
  50. }
  51. }
  52. describe('gate graph validation', () => {
  53. it.each([
  54. 'ci-primary',
  55. 'ci-linux-primary',
  56. 'ci-static',
  57. 'ci-lint-contracts-ready',
  58. 'ci-coverage',
  59. 'ci-snapshot',
  60. 'ci-artifacts',
  61. 'ci-consumers',
  62. 'ci-windows-blocking',
  63. 'ci-windows-complete',
  64. 'ci-windows-observational',
  65. 'node-compat',
  66. 'check-all',
  67. 'hygiene',
  68. 'doc-sync',
  69. ] as const)('constructs and executes preflight for a valid non-empty %s graph', async (mode) => {
  70. const subject = withPnpmEntrypoint(() => gatesForMode(mode))
  71. const execute = vi.fn(async (item: Gate) => resultFor(item))
  72. await expect(runGates(subject, subject.length, execute)).resolves.toHaveLength(subject.length)
  73. })
  74. it('keeps the public repository link policy in the documentation gate', () => {
  75. const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
  76. expect(ids).toContain('public-repository-links')
  77. })
  78. it('keeps package-group subsystem ownership in the documentation gate', () => {
  79. const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
  80. expect(ids).toContain('subsystem-pages')
  81. })
  82. it('keeps the hygiene aggregate aligned with the package script checks', () => {
  83. const ids = withPnpmEntrypoint(() => gatesForMode('hygiene').map(subject => subject.id))
  84. expect(ids).toEqual([
  85. 'rescope-vendor', 'knip', 'publint', 'constraints', 'application-entrypoints',
  86. 'dsh-package-licenses', 'package-invariants', 'built-package-invariants', 'node-next-types',
  87. 'optional-dependency-imports', 'client-packages', 'client-ui-i18n', 'cordis-config',
  88. 'runtime-closure', 'vendored-links',
  89. ])
  90. expect(defaultConcurrency('hygiene', ids.length, 8)).toEqual({
  91. workers: 4,
  92. source: '8 available CPU(s), hygiene cap 4',
  93. })
  94. })
  95. it('schedules the longest documentation leaves before short checks', () => {
  96. const ids = withPnpmEntrypoint(() => gatesForMode('doc-sync').map(subject => subject.id))
  97. expect(ids.slice(0, 10)).toEqual([
  98. 'doc-typecheck', 'docs-site-build', 'doc-graphs', 'markdown-links', 'type-equivalence',
  99. 'cordis-catalog', 'cordis-inspect-catalog', 'mermaid', 'scoped-events', 'translation-pairing',
  100. ])
  101. })
  102. it('launches a native pnpm entrypoint directly', () => {
  103. const entrypoint = String.raw`C:\Program Files\pnpm\pnpm.exe`
  104. const subject = withPnpmEntrypoint(() => gatesForMode('ci-windows-blocking')[0], entrypoint)
  105. expect(subject).toMatchObject({
  106. command: entrypoint,
  107. args: ['run', 'build'],
  108. })
  109. })
  110. it.each(['ci-primary', 'ci-static', 'check-all'] as const)(
  111. 'keeps the DSH package license policy in %s',
  112. (mode) => {
  113. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  114. expect(ids).toContain('dsh-package-licenses')
  115. },
  116. )
  117. it.each(['ci-primary', 'ci-static', 'check-all'] as const)(
  118. 'keeps the client dependency policy in %s',
  119. (mode) => {
  120. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  121. expect(ids).toContain('client-packages')
  122. },
  123. )
  124. it.each(['ci-primary', 'ci-static', 'check-all', 'hygiene'] as const)(
  125. 'keeps hard-coded Client UI copy enforcement in %s',
  126. (mode) => {
  127. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  128. expect(ids).toContain('client-ui-i18n')
  129. },
  130. )
  131. it.each(['ci-primary', 'ci-static', 'check-all', 'hygiene'] as const)(
  132. 'keeps application entrypoint enforcement in %s',
  133. (mode) => {
  134. const ids = withPnpmEntrypoint(() => gatesForMode(mode).map(subject => subject.id))
  135. expect(ids).toContain('application-entrypoints')
  136. },
  137. )
  138. it('keeps native Windows coverage blocking while retaining the observational inventory', () => {
  139. const complete = withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))
  140. const observational = withPnpmEntrypoint(() => gatesForMode('ci-windows-observational'))
  141. .filter(gate => gate.id !== 'build' && gate.id !== 'docs-site-build')
  142. const byId = new Map(complete.map(subject => [subject.id, subject]))
  143. expect(byId.get('coverage')?.allowFailure).not.toBe(true)
  144. expect(byId.get('coverage-exempt-heavy')?.allowFailure).not.toBe(true)
  145. expect(byId.get('coverage-exempt-heavy')?.needs).toContain('build')
  146. expect(observational).not.toHaveLength(0)
  147. for (const gate of observational) {
  148. const completeGate = byId.get(gate.id)
  149. expect(completeGate?.allowFailure).toBe(true)
  150. expect(completeGate?.after).toEqual(expect.arrayContaining([
  151. 'coverage',
  152. 'coverage-exempt-heavy',
  153. ]))
  154. expect(completeGate?.needs).toEqual(gate.needs)
  155. }
  156. })
  157. it('applies one configured test and polling timeout to both coverage gates', () => {
  158. const gates = withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', '15000', () =>
  159. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete')))
  160. for (const id of ['coverage', 'coverage-exempt-heavy']) {
  161. expect(gates.find(subject => subject.id === id)?.args).toEqual(expect.arrayContaining([
  162. '--testTimeout=15000',
  163. '--expect.poll.timeout=15000',
  164. ]))
  165. }
  166. })
  167. it('keeps Vitest timeout defaults when the coverage override is absent', () => {
  168. const gates = withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', undefined, () =>
  169. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete')))
  170. for (const id of ['coverage', 'coverage-exempt-heavy']) {
  171. expect(gates.find(subject => subject.id === id)?.args).not.toEqual(expect.arrayContaining([
  172. expect.stringMatching(/^--(?:testTimeout|expect\.poll\.timeout)=/),
  173. ]))
  174. }
  175. })
  176. it('rejects an invalid coverage timeout before starting a gate', () => {
  177. expect(() => withEnv('DSH_COVERAGE_TEST_TIMEOUT_MS', '0', () =>
  178. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))))
  179. .toThrow('DSH_COVERAGE_TEST_TIMEOUT_MS must be a positive integer')
  180. })
  181. it('selects partitioned coverage only when explicitly configured', () => {
  182. const coverage = withEnv('DSH_COVERAGE_PARTITIONS', '3', () =>
  183. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete').find(subject => subject.id === 'coverage')))
  184. expect(coverage).toMatchObject({
  185. displayCommand: 'DSH_COVERAGE_PARTITIONS=3 pnpm run test:coverage:partitioned',
  186. args: ['/private/pnpm.cjs', 'run', 'test:coverage:partitioned'],
  187. streamOutput: true,
  188. })
  189. })
  190. it('rejects an invalid coverage partition count before starting a gate', () => {
  191. expect(() => withEnv('DSH_COVERAGE_PARTITIONS', '1', () =>
  192. withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))))
  193. .toThrow('DSH_COVERAGE_PARTITIONS must be an integer greater than 1')
  194. })
  195. it.each([
  196. ['empty', [], /gate graph has no gates/],
  197. ['duplicate ids', [gate('same'), gate('same')], /duplicate gate id "same"/],
  198. ['unknown dependencies', [gate('subject', { needs: ['missing'] })], /depends on unknown gate "missing"/],
  199. ['unknown ordering predecessors', [gate('subject', { after: ['missing'] })], /waits for unknown gate "missing"/],
  200. ['cycles', [gate('first', { needs: ['second'] }), gate('second', { needs: ['first'] })], /dependency cycle: first -> second -> first/],
  201. ['mixed cycles', [gate('first', { after: ['second'] }), gate('second', { needs: ['first'] })], /dependency cycle: first -> second -> first/],
  202. ] as const)('rejects %s before starting a child', async (_label, invalid, message) => {
  203. const execute = vi.fn(async (subject: Gate) => resultFor(subject))
  204. await expect(runGates([...invalid], 1, execute)).rejects.toThrow(message)
  205. expect(execute).not.toHaveBeenCalled()
  206. })
  207. it('rejects an invalid worker count before starting a child', async () => {
  208. const execute = vi.fn(async (subject: Gate) => resultFor(subject))
  209. await expect(runGates([gate('subject')], 0, execute)).rejects.toThrow('max concurrency must be a positive integer')
  210. expect(execute).not.toHaveBeenCalled()
  211. })
  212. it('skips dependents after their prerequisite fails', async () => {
  213. const dependent = gate('dependent', { needs: ['root'] })
  214. const root = gate('root')
  215. const execute = vi.fn(async (subject: Gate) => resultFor(subject, 'failed'))
  216. const results = await runGates([dependent, root], 1, execute)
  217. expect(execute).toHaveBeenCalledOnce()
  218. expect(execute).toHaveBeenCalledWith(root)
  219. expect(results[0]).toMatchObject({ gate: dependent, status: 'skipped', error: 'dependency failed or skipped: root' })
  220. })
  221. it('runs an ordered follower after its predecessor fails', async () => {
  222. const follower = gate('follower', { after: ['root'] })
  223. const root = gate('root')
  224. const execute = vi.fn(async (subject: Gate) => resultFor(subject, subject === root ? 'failed' : 'passed'))
  225. const results = await runGates([follower, root], 2, execute)
  226. expect(execute.mock.calls.map(([subject]) => subject.id)).toEqual(['root', 'follower'])
  227. expect(results.map(result => result.status)).toEqual(['passed', 'failed'])
  228. })
  229. it('runs an ordered follower after its predecessor is skipped', async () => {
  230. const follower = gate('follower', { after: ['dependent'] })
  231. const dependent = gate('dependent', { needs: ['root'] })
  232. const root = gate('root')
  233. const execute = vi.fn(async (subject: Gate) => resultFor(subject, subject === root ? 'failed' : 'passed'))
  234. const results = await runGates([follower, dependent, root], 2, execute)
  235. expect(execute.mock.calls.map(([subject]) => subject.id)).toEqual(['root', 'follower'])
  236. expect(results.map(result => result.status)).toEqual(['passed', 'skipped', 'failed'])
  237. })
  238. })
  239. describe('Oxlint gate', () => {
  240. it('uses the package script when no worker bound is configured', () => {
  241. const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
  242. withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
  243. expect(subject).toMatchObject({
  244. id: 'lint',
  245. displayCommand: 'pnpm run lint:contracts-ready',
  246. command: process.execPath,
  247. args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
  248. })
  249. })
  250. it('surfaces the configured worker bound on the shared package script', () => {
  251. const subject = withEnv('DSH_OXLINT_THREADS', '4', () =>
  252. withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
  253. expect(subject).toMatchObject({
  254. id: 'lint',
  255. displayCommand: 'DSH_OXLINT_THREADS=4 pnpm run lint:contracts-ready',
  256. command: process.execPath,
  257. args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
  258. })
  259. })
  260. })
  261. describe('Typert contract preparation', () => {
  262. it('prepares primary source consumers once before they run', () => {
  263. const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
  264. withPnpmEntrypoint(() => gatesForMode('ci-primary')))
  265. expect(subject.find(item => item.id === 'typert-contracts')).toMatchObject({
  266. displayCommand: 'pnpm run build:lib:host',
  267. args: ['/private/pnpm.cjs', 'run', 'build:lib:host'],
  268. })
  269. for (const [id, script] of [
  270. ['typecheck', 'typecheck:contracts-ready'],
  271. ['lint', 'lint:contracts-ready'],
  272. ['doc-typecheck', 'doc-typecheck:contracts-ready'],
  273. ] as const) {
  274. expect(subject.find(item => item.id === id)).toMatchObject({
  275. displayCommand: `pnpm run ${script}`,
  276. args: ['/private/pnpm.cjs', 'run', script],
  277. needs: ['typert-contracts'],
  278. })
  279. }
  280. expect(subject.find(item => item.id === 'build')?.needs).toEqual([
  281. 'typecheck',
  282. 'lint',
  283. 'doc-typecheck',
  284. ])
  285. })
  286. it('reuses contracts from the validated consumer build', () => {
  287. const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
  288. expect(subject.find(item => item.id === 'lint-and-duplication')).toMatchObject({
  289. displayCommand: 'pnpm run check:ci:lint:contracts-ready',
  290. args: ['/private/pnpm.cjs', 'run', 'check:ci:lint:contracts-ready'],
  291. })
  292. expect(subject.find(item => item.id === 'doc-typecheck')).toMatchObject({
  293. displayCommand: 'pnpm run doc-typecheck:contracts-ready',
  294. args: ['/private/pnpm.cjs', 'run', 'doc-typecheck:contracts-ready'],
  295. })
  296. })
  297. it('keeps standalone doc sync responsible for preparation', () => {
  298. const docTypecheck = withPnpmEntrypoint(() =>
  299. gatesForMode('doc-sync').find(item => item.id === 'doc-typecheck'))
  300. expect(docTypecheck?.displayCommand).toBe('pnpm run doc-typecheck')
  301. })
  302. })
  303. describe('Node compatibility graph', () => {
  304. it('runs the jsdom environment smoke on every advertised Node line', () => {
  305. const subject = withPnpmEntrypoint(() => gatesForMode('node-compat'))
  306. expect(subject.find(item => item.id === 'vitest-jsdom-smoke')).toMatchObject({
  307. label: 'Vitest jsdom smoke',
  308. args: [
  309. '/private/pnpm.cjs',
  310. 'exec',
  311. 'vitest',
  312. 'run',
  313. 'scripts/vitest-environment.compat.spec.ts',
  314. ],
  315. })
  316. })
  317. })
  318. describe('Node 24 lane ownership', () => {
  319. it('keeps the static lane source-only', () => {
  320. const subject = withPnpmEntrypoint(() => gatesForMode('ci-static'))
  321. expect(subject.map(item => item.id)).not.toContain('build')
  322. expect(subject.map(item => item.id)).not.toContain('doc-typecheck')
  323. })
  324. it('owns the build and orders its artifact consumers', () => {
  325. const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
  326. expect(defaultConcurrency('ci-consumers', subject.length, 4)).toEqual({
  327. workers: 10,
  328. source: 'ci-consumers gate count',
  329. })
  330. expect(subject.map(item => item.id)).toEqual([
  331. 'build',
  332. 'node-compat',
  333. 'publint',
  334. 'built-package-invariants',
  335. 'lint-and-duplication',
  336. 'snapshot',
  337. 'web-snapshot',
  338. 'doc-typecheck',
  339. 'node-next-types',
  340. 'built-bin-smoke',
  341. ])
  342. expect(subject.find(item => item.id === 'publint')?.needs).toEqual(['build'])
  343. expect(subject.find(item => item.id === 'build')?.env).toEqual({
  344. DSH_BUILD_CLIENT_PROFILE: 'official',
  345. })
  346. expect(subject.find(item => item.id === 'node-compat')?.env).toEqual({
  347. DSH_BUILD_CLIENT_PROFILE: 'official',
  348. })
  349. expect(subject.find(item => item.id === 'built-package-invariants')?.needs).toEqual(['build'])
  350. expect(subject.find(item => item.id === 'lint-and-duplication')?.needs).toEqual(['built-package-invariants'])
  351. for (const id of [
  352. 'snapshot',
  353. 'web-snapshot',
  354. 'doc-typecheck',
  355. 'node-next-types',
  356. 'built-bin-smoke',
  357. ]) {
  358. expect(subject.find(item => item.id === id)?.needs).toEqual(['built-package-invariants'])
  359. }
  360. expect(subject.find(item => item.id === 'snapshot')?.env).toEqual({ DSH_EXAMPLE_MODE: 'lib' })
  361. expect(subject.find(item => item.id === 'doc-typecheck')?.env).toEqual({
  362. DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1',
  363. })
  364. expect(subject.find(item => item.id === 'built-bin-smoke')?.args).toEqual(
  365. expect.arrayContaining([
  366. 'packages/subagent/subagent-codex/tests/loader-composition.e2e.ts',
  367. 'packages/subagent/subagent-claude-code/tests/loader-composition.e2e.ts',
  368. ]),
  369. )
  370. expect(subject.find(item => item.id === 'web-snapshot')).toMatchObject({
  371. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  372. env: { DSH_SNAPSHOT: 'replay' },
  373. })
  374. })
  375. })
  376. describe('Linux primary graph', () => {
  377. it('adds the same compare-only web gate after built client artifacts', () => {
  378. const subject = withPnpmEntrypoint(() => gatesForMode('ci-linux-primary'))
  379. const web = subject.find(item => item.id === 'web-snapshot')
  380. expect(web).toMatchObject({
  381. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  382. env: { DSH_SNAPSHOT: 'replay' },
  383. needs: ['built-package-invariants'],
  384. })
  385. })
  386. })
  387. describe('gate process outcomes', () => {
  388. it('streams selected gate output without retaining it', async () => {
  389. const write = vi.spyOn(process.stdout, 'write').mockReturnValue(true)
  390. try {
  391. const result = await runGate(gate('streamed', {
  392. args: ['-e', "process.stdout.write('live output')"],
  393. streamOutput: true,
  394. }))
  395. expect(result.status).toBe('passed')
  396. expect(result.output).toEqual([])
  397. expect(write).toHaveBeenCalledWith('live output')
  398. } finally {
  399. write.mockRestore()
  400. }
  401. })
  402. it.skipIf(process.platform === 'win32')('reports signal termination independently from exit status', async () => {
  403. const result = await runGate(gate('terminated', {
  404. args: ['-e', "process.kill(process.pid, 'SIGTERM')"],
  405. }))
  406. expect(result.status).toBe('failed')
  407. expect(result.exitCode).toBeNull()
  408. expect(result.signalCode).toBe('SIGTERM')
  409. expect(formatGateResultReason(result)).toBe('signal SIGTERM')
  410. })
  411. })