ci-workflow.spec.ts 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  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('requires one release-shaped Python runtime target on every pull request', () => {
  82. const workflow = loadWorkflow('.github/workflows/ci.yml')
  83. const pythonRuntime = workflowJob(workflow, 'python-runtime')
  84. const aggregate = workflowJob(workflow, 'all-checks-passed')
  85. if (!Array.isArray(aggregate.needs)) {
  86. throw new TypeError('CI aggregate must define required job dependencies')
  87. }
  88. expect(pythonRuntime).toMatchObject({
  89. if: "github.event_name == 'pull_request'",
  90. name: 'python runtime / release-shaped Linux x64',
  91. uses: './.github/workflows/build-exe-for-python-sdk.yml',
  92. with: {
  93. targets: 'node24-linux-x64',
  94. ci: true,
  95. },
  96. })
  97. expect(aggregate.needs).toContain('python-runtime')
  98. })
  99. it('keeps every Vitest project process-isolated on native Windows', () => {
  100. const config = readFileSync(resolve(root, 'vitest.config.ts'), 'utf8')
  101. expect(config).not.toContain("pool: process.platform === 'win32' ? 'threads' : 'forks'")
  102. expect(config.match(/pool: 'forks'/g)).toHaveLength(2)
  103. })
  104. })
  105. describe('E2B e2e workflow', () => {
  106. it('is manual-only and fails loud before running the focused live suite', () => {
  107. const workflow = loadWorkflow('.github/workflows/e2b-e2e.yml')
  108. expect(workflow.on).toEqual({ workflow_dispatch: null })
  109. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs.e2b) || !Array.isArray(workflow.jobs.e2b.steps)) {
  110. throw new TypeError('E2B e2e workflow must define the e2b job steps')
  111. }
  112. const steps = workflow.jobs.e2b.steps.filter(isRecord)
  113. const preflight = steps.find(step => step.name === 'Preflight (require E2B API key)')
  114. const e2b = steps.find(step => step.name === 'E2B tests (live sandbox)')
  115. expect(preflight).toMatchObject({
  116. env: { E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}' },
  117. })
  118. expect(preflight?.run).toContain('E2B_API_KEY_EXTERNAL repository secret')
  119. expect(e2b).toMatchObject({
  120. env: {
  121. E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}',
  122. DSH_E2E_MAX_WORKERS: '1',
  123. DSH_EXAMPLE_MODE: 'lib',
  124. },
  125. })
  126. expect(e2b?.run).toContain('packages/e2b/e2b/tests/composition.e2e.ts')
  127. })
  128. })
  129. describe('Python release workflows', () => {
  130. it('keeps complete wheel validation separate from protected public publication', () => {
  131. const workflow = loadWorkflow('.github/workflows/python-release.yml')
  132. const dispatch = workflowEvent(workflow, 'workflow_dispatch')
  133. const pullRequest = workflowEvent(workflow, 'pull_request')
  134. const build = workflowJob(workflow, 'build')
  135. const pythonCompat = workflowJob(workflow, 'python-compat')
  136. const validate = workflowJob(workflow, 'validate')
  137. const publishRuntime = workflowJob(workflow, 'publish-runtime')
  138. const publishSdk = workflowJob(workflow, 'publish-sdk')
  139. if (!isRecord(dispatch.inputs)
  140. || !isRecord(dispatch.inputs.publish)
  141. || !Array.isArray(pythonCompat.steps)
  142. || !Array.isArray(validate.steps)
  143. || !Array.isArray(publishRuntime.steps)
  144. || !Array.isArray(publishSdk.steps)) {
  145. throw new TypeError('Python release workflow must define publish input and release steps')
  146. }
  147. expect(dispatch.inputs.publish).toMatchObject({ type: 'boolean', default: false })
  148. expect(pullRequest).toEqual({ types: ['labeled'] })
  149. expect(build).toMatchObject({
  150. if: "github.event_name == 'workflow_dispatch' || github.event.label.name == 'python-release-dry-run'",
  151. uses: './.github/workflows/build-exe-for-python-sdk.yml',
  152. with: {
  153. targets: 'node24-linux-x64,node24-linux-arm64,node24-macos-arm64',
  154. release: true,
  155. },
  156. })
  157. expect(pythonCompat.strategy).toMatchObject({ matrix: { python: ['3.10', '3.14'] } })
  158. expect(JSON.stringify(pythonCompat.steps)).toContain('deepseek-harness-sdk==${{ steps.compatibility-version.outputs.version }}')
  159. const validateSteps = JSON.stringify(validate.steps)
  160. const authorize = validate.steps.filter(isRecord).find(step => step.name === 'Authorize publication request')
  161. if (!isRecord(authorize) || typeof authorize.run !== 'string') {
  162. throw new TypeError('Python release validation must authorize publication requests')
  163. }
  164. expect(validateSteps).toContain('PUBLIC_PYPI_RELEASE_ENABLED')
  165. expect(authorize).toMatchObject({
  166. env: {
  167. PYPI_PUBLISHER_REPOSITORY: '${{ vars.PYPI_PUBLISHER_REPOSITORY }}',
  168. REPOSITORY: '${{ github.repository }}',
  169. },
  170. })
  171. expect(authorize.run).toContain('[ "$REPOSITORY" = "$PYPI_PUBLISHER_REPOSITORY" ]')
  172. expect(validateSteps).toContain('100000000')
  173. expect(publishRuntime).toMatchObject({
  174. if: "github.event_name == 'workflow_dispatch' && inputs.publish",
  175. needs: 'validate',
  176. environment: 'pypi-runtime',
  177. permissions: { contents: 'read', 'id-token': 'write' },
  178. })
  179. expect(publishSdk).toMatchObject({
  180. if: "github.event_name == 'workflow_dispatch' && inputs.publish",
  181. needs: ['validate', 'publish-runtime'],
  182. environment: 'pypi',
  183. permissions: { contents: 'read', 'id-token': 'write' },
  184. })
  185. const runtimeSteps = publishRuntime.steps.filter(isRecord)
  186. const sdkSteps = publishSdk.steps.filter(isRecord)
  187. const runtimePublish = runtimeSteps.find(step => step.name === 'Publish runtime wheels')
  188. const sdkPublish = sdkSteps.find(step => step.name === 'Publish SDK wheel')
  189. const runtimeHashes = runtimeSteps.find(step => step.name === 'Verify release artifact hashes')
  190. const sdkHashes = sdkSteps.find(step => step.name === 'Verify release artifact hashes')
  191. expect([...runtimeSteps, ...sdkSteps].some(
  192. step => typeof step.uses === 'string' && step.uses.startsWith('actions/checkout@'),
  193. )).toBe(false)
  194. expect([...runtimeSteps, ...sdkSteps].filter(
  195. step => step.uses === 'pypa/gh-action-pypi-publish@release/v1',
  196. )).toHaveLength(2)
  197. expect(runtimePublish).toMatchObject({
  198. with: { 'packages-dir': 'dist/runtime/', attestations: false },
  199. })
  200. expect(sdkPublish).toMatchObject({
  201. with: { 'packages-dir': 'dist/sdk/', attestations: false },
  202. })
  203. expect(runtimeHashes).toMatchObject({ run: 'cd dist && sha256sum -c SHA256SUMS' })
  204. expect(sdkHashes).toMatchObject({ run: 'cd dist && sha256sum -c SHA256SUMS' })
  205. })
  206. it('exposes the native wheel builder to the release caller with normalized versions', () => {
  207. const workflow = loadWorkflow('.github/workflows/build-exe-for-python-sdk.yml')
  208. const call = workflowEvent(workflow, 'workflow_call')
  209. const plan = workflowJob(workflow, 'plan')
  210. const build = workflowJob(workflow, 'build')
  211. if (!isRecord(call.inputs) || !Array.isArray(plan.steps) || !Array.isArray(build.steps)) {
  212. throw new TypeError('Python wheel builder must define workflow_call inputs and plan steps')
  213. }
  214. const buildSteps: unknown[] = build.steps
  215. const manylinuxAddon = buildSteps.find(step => isRecord(step) && step.name === 'Rebuild Linux node-pty against manylinux 2.28')
  216. const macosCheck = buildSteps.find(step => isRecord(step) && step.name === 'Check macOS deployment target')
  217. const manylinuxSmoke = buildSteps.find(step => isRecord(step) && step.name === 'Run wheel in a manylinux 2.28 container')
  218. expect(call.inputs).toHaveProperty('targets')
  219. expect(call.inputs).toMatchObject({
  220. ci: { type: 'boolean', default: false },
  221. release: { type: 'boolean', default: false },
  222. })
  223. expect(workflow.concurrency).toMatchObject({
  224. group: 'build-single-exe-${{ github.workflow }}-${{ github.ref }}',
  225. })
  226. expect(plan.if).toContain('inputs.ci')
  227. expect(plan.if).toContain('inputs.release')
  228. expect(JSON.stringify(plan.steps)).toContain('pep440_version')
  229. expect(JSON.stringify(workflow)).toContain('macosx_14_0_arm64')
  230. expect(manylinuxAddon).toMatchObject({ if: "runner.os == 'Linux'" })
  231. expect(JSON.stringify(manylinuxAddon)).toContain('manylinux_2_28_x86_64')
  232. expect(JSON.stringify(manylinuxAddon)).toContain('manylinux_2_28_aarch64')
  233. expect(JSON.stringify(manylinuxAddon)).toContain('$HOME/setup-pnpm:$HOME/setup-pnpm:ro')
  234. expect(JSON.stringify(manylinuxAddon)).toContain('node-pty-glibc-versions.txt')
  235. expect(JSON.stringify(manylinuxAddon)).toContain('le 2.28')
  236. expect(macosCheck).toMatchObject({ if: "runner.os == 'macOS'" })
  237. expect(JSON.stringify(macosCheck)).toContain('scripts/check-macos-deployment-target.py')
  238. expect(JSON.stringify(macosCheck)).toContain('$EXE-spawn-helper')
  239. expect(manylinuxSmoke).toMatchObject({ if: "runner.os == 'Linux'" })
  240. expect(JSON.stringify(manylinuxSmoke)).toContain('-e DSH_TELEMETRY_DISABLED')
  241. })
  242. it('uses the shared macOS deployment-target check in GitLab', () => {
  243. const workflow = loadWorkflow('.gitlab-ci.yml')
  244. const runtimeWheel = workflow['.runtime-wheel']
  245. if (!isRecord(runtimeWheel) || !Array.isArray(runtimeWheel.script)) {
  246. throw new TypeError('GitLab CI must define the runtime wheel script')
  247. }
  248. const runtimeScript: unknown[] = runtimeWheel.script
  249. const macosCheck = runtimeScript.find(
  250. step => typeof step === 'string' && step.includes('PLATFORM" = macos-arm64'),
  251. )
  252. if (typeof macosCheck !== 'string') {
  253. throw new TypeError('GitLab CI must check the macOS deployment target')
  254. }
  255. expect(macosCheck).toContain('scripts/check-macos-deployment-target.py')
  256. expect(macosCheck).toContain('"$EXE" "$EXE-spawn-helper"')
  257. })
  258. })
  259. describe('Issue lifecycle workflow', () => {
  260. it('uses explicit review handoff events without rerunning when a draft becomes ready', () => {
  261. const lifecycle = loadWorkflow('.github/workflows/issue-lifecycle.yml')
  262. const lifecyclePullRequest = workflowEvent(lifecycle, 'pull_request')
  263. const lifecycleReview = workflowEvent(lifecycle, 'pull_request_review')
  264. const lifecycleJob = workflowJob(lifecycle, 'lifecycle')
  265. const policy = loadWorkflow('.github/workflows/issue-policy.yml')
  266. const policyPullRequest = workflowEvent(policy, 'pull_request')
  267. expect(lifecyclePullRequest.types).not.toContain('ready_for_review')
  268. expect(lifecyclePullRequest.types).toContain('review_requested')
  269. expect(lifecycleReview.types).toEqual(['submitted'])
  270. expect(lifecycleJob.if).toBe(
  271. "${{ github.event_name != 'pull_request_review' || (github.event.action == 'submitted' && github.event.review.state == 'changes_requested') }}",
  272. )
  273. expect(policyPullRequest.types).toContain('ready_for_review')
  274. })
  275. })
  276. describe('Git hooks', () => {
  277. it('leaves frozen Agent Note sidecars to the archive verifier', () => {
  278. const lefthook = loadWorkflow('lefthook.yml')
  279. for (const hookName of ['pre-commit', 'pre-merge-commit']) {
  280. const hook = lefthook[hookName]
  281. if (!isRecord(hook) || !Array.isArray(hook.jobs)) {
  282. throw new TypeError(`lefthook must define ${hookName} jobs`)
  283. }
  284. const pairing: unknown = hook.jobs.find(
  285. (job: unknown) => isRecord(job) && job.name === 'translation pairing (staged records)',
  286. )
  287. expect(pairing).toMatchObject({ exclude: ['.agents/notes/archived/**'] })
  288. }
  289. })
  290. })
  291. function loadWorkflow(path: string): Record<string, unknown> {
  292. const workflow: unknown = yaml.load(readFileSync(resolve(root, path), 'utf8'))
  293. if (!isRecord(workflow)) throw new TypeError(`${path} must define a workflow`)
  294. return workflow
  295. }
  296. function workflowEvent(workflow: Record<string, unknown>, event: string): Record<string, unknown> {
  297. if (!isRecord(workflow.on) || !isRecord(workflow.on[event])) {
  298. throw new TypeError(`workflow must define the ${event} event`)
  299. }
  300. return workflow.on[event]
  301. }
  302. function workflowJob(workflow: Record<string, unknown>, job: string): Record<string, unknown> {
  303. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs[job])) {
  304. throw new TypeError(`workflow must define the ${job} job`)
  305. }
  306. return workflow.jobs[job]
  307. }
  308. function isRecord(value: unknown): value is Record<string, unknown> {
  309. return typeof value === 'object' && value !== null && !Array.isArray(value)
  310. }