run-gates.spec.ts 15 KB

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