ci-workflow.spec.ts 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. import { readFileSync } from 'node:fs'
  2. import { resolve } from 'node:path'
  3. import * as yaml from 'js-yaml'
  4. import { describe, expect, it } from 'vitest'
  5. const root = resolve(import.meta.dirname, '..')
  6. const runnerPrivatePnpmDestination = '${{ runner.temp }}/setup-pnpm'
  7. describe('CI workflow', () => {
  8. it('isolates every pnpm action setup destination per runner', () => {
  9. const workflow: unknown = yaml.load(readFileSync(resolve(root, '.github/workflows/ci.yml'), 'utf8'))
  10. if (!isRecord(workflow) || !isRecord(workflow.jobs)) throw new TypeError('CI workflow must define jobs')
  11. const setups = Object.entries(workflow.jobs).flatMap(([jobName, job]) => {
  12. if (!isRecord(job) || !Array.isArray(job.steps)) return []
  13. return job.steps.flatMap((step) => {
  14. if (!isRecord(step) || typeof step.uses !== 'string' || !step.uses.startsWith('pnpm/action-setup@')) return []
  15. return [{ jobName, step }]
  16. })
  17. })
  18. expect(setups.length).toBeGreaterThan(0)
  19. for (const { jobName, step } of setups) {
  20. expect(step, `${jobName} must not share pnpm/action-setup's default destination`).toMatchObject({
  21. with: { dest: runnerPrivatePnpmDestination },
  22. })
  23. }
  24. })
  25. it('keeps a required Wine Windows job, a non-blocking native Windows job with failover, and a master-only standby', () => {
  26. const workflow = loadWorkflow('.github/workflows/ci.yml')
  27. if (!isRecord(workflow.jobs)
  28. || !isRecord(workflow.jobs.windows)
  29. || !isRecord(workflow.jobs['windows-native'])
  30. || !isRecord(workflow.jobs['wine-apt-cache'])
  31. || !isRecord(workflow.jobs['serial-windows'])
  32. || !isRecord(workflow.jobs['all-checks-passed'])) {
  33. throw new TypeError('CI workflow must define windows, windows-native, wine-apt-cache, serial-windows, and all-checks-passed jobs')
  34. }
  35. const windows = workflow.jobs.windows
  36. const windowsNative = workflow.jobs['windows-native']
  37. const wineAptCache = workflow.jobs['wine-apt-cache']
  38. const serialWindows = workflow.jobs['serial-windows']
  39. const aggregate = workflow.jobs['all-checks-passed']
  40. if (!Array.isArray(windows.steps) || !Array.isArray(aggregate.needs)) {
  41. throw new TypeError('Windows job must define steps and the aggregate must define needs')
  42. }
  43. const commandSteps = windows.steps.filter((step): step is Record<string, unknown> & { run: string } => (
  44. isRecord(step) && typeof step.run === 'string'
  45. ))
  46. // Required PR job: Wine on ubuntu-latest, runs wine-windows-gates.sh.
  47. expect(windows['runs-on']).toBe('ubuntu-latest')
  48. expect(windows.name).toBe('windows node 24 / wine blocking')
  49. expect(windows.if).toBe("github.event_name == 'pull_request'")
  50. expect(commandSteps.some(step => step.run.includes('wine-windows-gates.sh'))).toBe(true)
  51. // windows-native: non-blocking native job with failover, runs windows-complete.
  52. expect(typeof windowsNative['runs-on']).toBe('string')
  53. expect(windowsNative['runs-on']).toContain('DSH_CI_FAILOVER')
  54. expect(windowsNative['runs-on']).toContain('self-hosted')
  55. expect(windowsNative['runs-on']).toContain('dsh-win-ci')
  56. expect(windowsNative['runs-on']).toContain('dsh-windows-2025-16core')
  57. expect(windowsNative.name).toBe('windows node 24 / native complete')
  58. expect(windowsNative.if).toBe("github.event_name == 'pull_request'")
  59. const nativeCommandSteps = (windowsNative.steps as unknown[]).filter((step): step is Record<string, unknown> & { run: string } => (
  60. isRecord(step) && typeof step.run === 'string'
  61. ))
  62. expect(nativeCommandSteps.map(step => step.run)).toContain('pnpm run check:ci:windows-complete')
  63. // wine-apt-cache: master-only, seeds the Wine apt cache.
  64. expect(wineAptCache.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  65. expect(wineAptCache['runs-on']).toBe('ubuntu-latest')
  66. // serial-windows: master-only standby, self-hosted, non-blocking.
  67. expect(serialWindows.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  68. expect(serialWindows['runs-on']).toEqual(['self-hosted', 'dsh-win-ci', 'windows'])
  69. expect(serialWindows.name).toBe('serial / windows (self-hosted standby)')
  70. // Aggregate: Wine `windows` required, native `windows-native` excluded.
  71. expect(aggregate.needs).toContain('windows')
  72. expect(aggregate.needs).not.toContain('windows-native')
  73. expect(aggregate.needs).not.toContain('serial-windows')
  74. })
  75. it('keeps supported LSP source under native Windows coverage', () => {
  76. const config = readFileSync(resolve(root, 'vitest.config.ts'), 'utf8')
  77. expect(config).not.toContain('packages/lsp/lsp-local/src/connection.ts')
  78. expect(config).not.toContain('packages/lsp/lsp-local/src/index.ts')
  79. expect(config).not.toContain('packages/lsp/lsp-local/src/instance.ts')
  80. })
  81. it('keeps every Vitest project process-isolated on native Windows', () => {
  82. const config = readFileSync(resolve(root, 'vitest.config.ts'), 'utf8')
  83. expect(config).not.toContain("pool: process.platform === 'win32' ? 'threads' : 'forks'")
  84. expect(config.match(/pool: 'forks'/g)).toHaveLength(2)
  85. })
  86. })
  87. describe('E2B e2e workflow', () => {
  88. it('is manual-only and fails loud before running the focused live suite', () => {
  89. const workflow = loadWorkflow('.github/workflows/e2b-e2e.yml')
  90. expect(workflow.on).toEqual({ workflow_dispatch: null })
  91. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs.e2b) || !Array.isArray(workflow.jobs.e2b.steps)) {
  92. throw new TypeError('E2B e2e workflow must define the e2b job steps')
  93. }
  94. const steps = workflow.jobs.e2b.steps.filter(isRecord)
  95. const preflight = steps.find(step => step.name === 'Preflight (require E2B API key)')
  96. const e2b = steps.find(step => step.name === 'E2B tests (live sandbox)')
  97. expect(preflight).toMatchObject({
  98. env: { E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}' },
  99. })
  100. expect(preflight?.run).toContain('E2B_API_KEY_EXTERNAL repository secret')
  101. expect(e2b).toMatchObject({
  102. env: {
  103. E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}',
  104. DSH_E2E_MAX_WORKERS: '1',
  105. DSH_EXAMPLE_MODE: 'lib',
  106. },
  107. })
  108. expect(e2b?.run).toContain('packages/e2b/e2b/tests/composition.e2e.ts')
  109. })
  110. })
  111. describe('Issue lifecycle workflow', () => {
  112. it('uses explicit review handoff events without rerunning when a draft becomes ready', () => {
  113. const lifecycle = loadWorkflow('.github/workflows/issue-lifecycle.yml')
  114. const lifecyclePullRequest = workflowEvent(lifecycle, 'pull_request')
  115. const lifecycleReview = workflowEvent(lifecycle, 'pull_request_review')
  116. const lifecycleJob = workflowJob(lifecycle, 'lifecycle')
  117. const policy = loadWorkflow('.github/workflows/issue-policy.yml')
  118. const policyPullRequest = workflowEvent(policy, 'pull_request')
  119. expect(lifecyclePullRequest.types).not.toContain('ready_for_review')
  120. expect(lifecyclePullRequest.types).toContain('review_requested')
  121. expect(lifecycleReview.types).toEqual(['submitted'])
  122. expect(lifecycleJob.if).toBe(
  123. "${{ github.event_name != 'pull_request_review' || (github.event.action == 'submitted' && github.event.review.state == 'changes_requested') }}",
  124. )
  125. expect(policyPullRequest.types).toContain('ready_for_review')
  126. })
  127. })
  128. describe('Git hooks', () => {
  129. it('leaves frozen Agent Note sidecars to the archive verifier', () => {
  130. const lefthook = loadWorkflow('lefthook.yml')
  131. for (const hookName of ['pre-commit', 'pre-merge-commit']) {
  132. const hook = lefthook[hookName]
  133. if (!isRecord(hook) || !Array.isArray(hook.jobs)) {
  134. throw new TypeError(`lefthook must define ${hookName} jobs`)
  135. }
  136. const pairing: unknown = hook.jobs.find(
  137. (job: unknown) => isRecord(job) && job.name === 'translation pairing (staged records)',
  138. )
  139. expect(pairing).toMatchObject({ exclude: ['.agents/notes/archived/**'] })
  140. }
  141. })
  142. })
  143. function loadWorkflow(path: string): Record<string, unknown> {
  144. const workflow: unknown = yaml.load(readFileSync(resolve(root, path), 'utf8'))
  145. if (!isRecord(workflow)) throw new TypeError(`${path} must define a workflow`)
  146. return workflow
  147. }
  148. function workflowEvent(workflow: Record<string, unknown>, event: string): Record<string, unknown> {
  149. if (!isRecord(workflow.on) || !isRecord(workflow.on[event])) {
  150. throw new TypeError(`workflow must define the ${event} event`)
  151. }
  152. return workflow.on[event]
  153. }
  154. function workflowJob(workflow: Record<string, unknown>, job: string): Record<string, unknown> {
  155. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs[job])) {
  156. throw new TypeError(`workflow must define the ${job} job`)
  157. }
  158. return workflow.jobs[job]
  159. }
  160. function isRecord(value: unknown): value is Record<string, unknown> {
  161. return typeof value === 'object' && value !== null && !Array.isArray(value)
  162. }