run-gates.spec.ts 17 KB

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