run-gates.spec.ts 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  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('keeps native Windows coverage blocking while portability inventory remains observational', () => {
  78. const gates = withPnpmEntrypoint(() => gatesForMode('ci-windows-complete'))
  79. const byId = new Map(gates.map(subject => [subject.id, subject]))
  80. expect(byId.get('coverage')?.allowFailure).not.toBe(true)
  81. expect(byId.get('coverage-exempt-heavy')?.allowFailure).not.toBe(true)
  82. expect(byId.get('duplication')?.allowFailure).toBe(true)
  83. })
  84. it.each([
  85. ['empty', [], /gate graph has no gates/],
  86. ['duplicate ids', [gate('same'), gate('same')], /duplicate gate id "same"/],
  87. ['unknown dependencies', [gate('subject', { needs: ['missing'] })], /depends on unknown gate "missing"/],
  88. ['cycles', [gate('first', { needs: ['second'] }), gate('second', { needs: ['first'] })], /dependency cycle: first -> second -> first/],
  89. ] as const)('rejects %s before starting a child', async (_label, invalid, message) => {
  90. const execute = vi.fn(async (subject: Gate) => resultFor(subject))
  91. await expect(runGates([...invalid], 1, execute)).rejects.toThrow(message)
  92. expect(execute).not.toHaveBeenCalled()
  93. })
  94. it('rejects an invalid worker count before starting a child', async () => {
  95. const execute = vi.fn(async (subject: Gate) => resultFor(subject))
  96. await expect(runGates([gate('subject')], 0, execute)).rejects.toThrow('max concurrency must be a positive integer')
  97. expect(execute).not.toHaveBeenCalled()
  98. })
  99. it('skips dependents after their prerequisite fails', async () => {
  100. const dependent = gate('dependent', { needs: ['root'] })
  101. const root = gate('root')
  102. const execute = vi.fn(async (subject: Gate) => resultFor(subject, 'failed'))
  103. const results = await runGates([dependent, root], 1, execute)
  104. expect(execute).toHaveBeenCalledOnce()
  105. expect(execute).toHaveBeenCalledWith(root)
  106. expect(results[0]).toMatchObject({ gate: dependent, status: 'skipped', error: 'dependency failed or skipped: root' })
  107. })
  108. })
  109. describe('Oxlint gate', () => {
  110. it('uses the package script when no worker bound is configured', () => {
  111. const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
  112. withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
  113. expect(subject).toMatchObject({
  114. id: 'lint',
  115. displayCommand: 'pnpm run lint:contracts-ready',
  116. command: process.execPath,
  117. args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
  118. })
  119. })
  120. it('surfaces the configured worker bound on the shared package script', () => {
  121. const subject = withEnv('DSH_OXLINT_THREADS', '4', () =>
  122. withPnpmEntrypoint(() => gatesForMode('ci-lint-contracts-ready')[0]))
  123. expect(subject).toMatchObject({
  124. id: 'lint',
  125. displayCommand: 'DSH_OXLINT_THREADS=4 pnpm run lint:contracts-ready',
  126. command: process.execPath,
  127. args: ['/private/pnpm.cjs', 'run', 'lint:contracts-ready'],
  128. })
  129. })
  130. })
  131. describe('TypeRT contract preparation', () => {
  132. it('prepares primary source consumers once before they run', () => {
  133. const subject = withEnv('DSH_OXLINT_THREADS', undefined, () =>
  134. withPnpmEntrypoint(() => gatesForMode('ci-primary')))
  135. expect(subject.find(item => item.id === 'typert-contracts')).toMatchObject({
  136. displayCommand: 'pnpm run build:lib:host',
  137. args: ['/private/pnpm.cjs', 'run', 'build:lib:host'],
  138. })
  139. for (const [id, script] of [
  140. ['typecheck', 'typecheck:contracts-ready'],
  141. ['lint', 'lint:contracts-ready'],
  142. ['doc-typecheck', 'doc-typecheck:contracts-ready'],
  143. ] as const) {
  144. expect(subject.find(item => item.id === id)).toMatchObject({
  145. displayCommand: `pnpm run ${script}`,
  146. args: ['/private/pnpm.cjs', 'run', script],
  147. needs: ['typert-contracts'],
  148. })
  149. }
  150. expect(subject.find(item => item.id === 'build')?.needs).toEqual([
  151. 'typecheck',
  152. 'lint',
  153. 'doc-typecheck',
  154. ])
  155. })
  156. it('reuses contracts from the validated consumer build', () => {
  157. const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
  158. expect(subject.find(item => item.id === 'lint-and-duplication')).toMatchObject({
  159. displayCommand: 'pnpm run check:ci:lint:contracts-ready',
  160. args: ['/private/pnpm.cjs', 'run', 'check:ci:lint:contracts-ready'],
  161. })
  162. expect(subject.find(item => item.id === 'doc-typecheck')).toMatchObject({
  163. displayCommand: 'pnpm run doc-typecheck:contracts-ready',
  164. args: ['/private/pnpm.cjs', 'run', 'doc-typecheck:contracts-ready'],
  165. })
  166. })
  167. it('keeps standalone doc sync responsible for preparation', () => {
  168. const docTypecheck = withPnpmEntrypoint(() =>
  169. gatesForMode('doc-sync').find(item => item.id === 'doc-typecheck'))
  170. expect(docTypecheck?.displayCommand).toBe('pnpm run doc-typecheck')
  171. })
  172. })
  173. describe('Node compatibility graph', () => {
  174. it('runs the jsdom environment smoke on every advertised Node line', () => {
  175. const subject = withPnpmEntrypoint(() => gatesForMode('node-compat'))
  176. expect(subject.find(item => item.id === 'vitest-jsdom-smoke')).toMatchObject({
  177. label: 'Vitest jsdom smoke',
  178. args: [
  179. '/private/pnpm.cjs',
  180. 'exec',
  181. 'vitest',
  182. 'run',
  183. 'scripts/vitest-environment.compat.spec.ts',
  184. ],
  185. })
  186. })
  187. })
  188. describe('Node 24 lane ownership', () => {
  189. it('keeps the static lane source-only', () => {
  190. const subject = withPnpmEntrypoint(() => gatesForMode('ci-static'))
  191. expect(subject.map(item => item.id)).not.toContain('build')
  192. expect(subject.map(item => item.id)).not.toContain('doc-typecheck')
  193. })
  194. it('owns the build and orders its artifact consumers', () => {
  195. const subject = withPnpmEntrypoint(() => gatesForMode('ci-consumers'))
  196. expect(defaultConcurrency('ci-consumers', subject.length, 4)).toEqual({
  197. workers: 10,
  198. source: 'ci-consumers gate count',
  199. })
  200. expect(subject.map(item => item.id)).toEqual([
  201. 'build',
  202. 'node-compat',
  203. 'publint',
  204. 'built-package-invariants',
  205. 'lint-and-duplication',
  206. 'snapshot',
  207. 'web-snapshot',
  208. 'doc-typecheck',
  209. 'node-next-types',
  210. 'built-bin-smoke',
  211. ])
  212. expect(subject.find(item => item.id === 'publint')?.needs).toEqual(['build'])
  213. expect(subject.find(item => item.id === 'built-package-invariants')?.needs).toEqual(['publint'])
  214. expect(subject.find(item => item.id === 'lint-and-duplication')?.needs).toEqual(['built-package-invariants'])
  215. for (const id of [
  216. 'snapshot',
  217. 'web-snapshot',
  218. 'doc-typecheck',
  219. 'node-next-types',
  220. 'built-bin-smoke',
  221. ]) {
  222. expect(subject.find(item => item.id === id)?.needs).toEqual(['built-package-invariants'])
  223. }
  224. expect(subject.find(item => item.id === 'snapshot')?.env).toEqual({ DSH_EXAMPLE_MODE: 'lib' })
  225. expect(subject.find(item => item.id === 'doc-typecheck')?.env).toEqual({
  226. DSH_DOC_TYPECHECK_USE_BUILD_OUTPUT: '1',
  227. })
  228. expect(subject.find(item => item.id === 'built-bin-smoke')?.args).toEqual(
  229. expect.arrayContaining([
  230. 'packages/subagent/subagent-codex/tests/loader-composition.e2e.ts',
  231. 'packages/subagent/subagent-claude-code/tests/loader-composition.e2e.ts',
  232. ]),
  233. )
  234. expect(subject.find(item => item.id === 'web-snapshot')).toMatchObject({
  235. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  236. env: { DSH_SNAPSHOT: 'replay' },
  237. })
  238. })
  239. })
  240. describe('Linux primary graph', () => {
  241. it('adds the same compare-only web gate after built client artifacts', () => {
  242. const subject = withPnpmEntrypoint(() => gatesForMode('ci-linux-primary'))
  243. const web = subject.find(item => item.id === 'web-snapshot')
  244. expect(web).toMatchObject({
  245. displayCommand: 'DSH_SNAPSHOT=replay pnpm run test:web:built',
  246. env: { DSH_SNAPSHOT: 'replay' },
  247. needs: ['built-package-invariants'],
  248. })
  249. })
  250. })
  251. describe('gate process outcomes', () => {
  252. it.skipIf(process.platform === 'win32')('reports signal termination independently from exit status', async () => {
  253. const result = await runGate(gate('terminated', {
  254. args: ['-e', "process.kill(process.pid, 'SIGTERM')"],
  255. }))
  256. expect(result.status).toBe('failed')
  257. expect(result.exitCode).toBeNull()
  258. expect(result.signalCode).toBe('SIGTERM')
  259. expect(formatGateResultReason(result)).toBe('signal SIGTERM')
  260. })
  261. })