ci-workflow.spec.ts 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766
  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-\$\{\{ github\.run_id \}\}-\$\{\{ github\.run_attempt \}\}$/
  7. const nativeWindowsPnpmDestination = '${{ runner.temp }}/setup-pnpm-js-${{ github.run_id }}-${{ github.run_attempt }}-${{ github.job }}'
  8. describe('CI workflow', () => {
  9. it('isolates every pnpm action setup destination per runner', () => {
  10. const files = ['.github/workflows/ci.yml', '.github/workflows/ci-master.yml']
  11. const setups: Array<{ jobName: string; step: unknown }> = []
  12. for (const file of files) {
  13. const workflow: unknown = yaml.load(readFileSync(resolve(root, file), 'utf8'))
  14. if (!isRecord(workflow) || !isRecord(workflow.jobs)) throw new TypeError(`${file} must define jobs`)
  15. for (const [jobName, job] of Object.entries(workflow.jobs)) {
  16. if (!isRecord(job) || !Array.isArray(job.steps)) continue
  17. for (const step of job.steps) {
  18. if (!isRecord(step) || typeof step.uses !== 'string' || !step.uses.startsWith('pnpm/action-setup@')) continue
  19. setups.push({ jobName, step })
  20. }
  21. }
  22. }
  23. expect(setups.length).toBeGreaterThan(0)
  24. for (const { jobName, step } of setups) {
  25. const stepDest = (step as { with?: { dest?: unknown } }).with?.dest
  26. if (jobName.startsWith('windows-')) {
  27. expect(stepDest, `${jobName} must use the native Windows pnpm destination`).toBe(nativeWindowsPnpmDestination)
  28. expect(step).not.toMatchObject({ with: { standalone: true } })
  29. } else {
  30. expect(typeof stepDest, `${jobName} must use a runner-and-run-private pnpm destination`).toBe('string')
  31. expect(stepDest as string).toMatch(runnerPrivatePnpmDestination)
  32. }
  33. }
  34. })
  35. it('isolates the python SDK exe pnpm setup destination per job', () => {
  36. const workflow: unknown = yaml.load(readFileSync(resolve(root, '.github/workflows/build-exe-for-python-sdk.yml'), 'utf8'))
  37. if (!isRecord(workflow) || !isRecord(workflow.jobs)) throw new TypeError('build-exe-for-python-sdk.yml must define jobs')
  38. const setups: Array<{ step: unknown }> = []
  39. for (const job of Object.values(workflow.jobs)) {
  40. if (!isRecord(job) || !Array.isArray(job.steps)) continue
  41. for (const step of job.steps) {
  42. if (!isRecord(step) || typeof step.uses !== 'string' || !step.uses.startsWith('pnpm/action-setup@')) continue
  43. setups.push({ step })
  44. }
  45. }
  46. expect(setups.length).toBeGreaterThan(0)
  47. for (const { step } of setups) {
  48. expect(step).toMatchObject({
  49. with: { dest: nativeWindowsPnpmDestination },
  50. })
  51. }
  52. })
  53. it('keeps required Wine and split native Windows jobs with failover, plus a master-only standby', () => {
  54. const workflow = loadWorkflow('.github/workflows/ci.yml')
  55. const masterWorkflow = loadWorkflow('.github/workflows/ci-master.yml')
  56. if (!isRecord(workflow.jobs)
  57. || !isRecord(workflow.jobs.windows)
  58. || !isRecord(workflow.jobs['windows-build'])
  59. || !isRecord(workflow.jobs['windows-coverage'])
  60. || !isRecord(workflow.jobs['windows-native-tests'])
  61. || !isRecord(workflow.jobs['windows-observational'])
  62. || !isRecord(workflow.jobs['node-24'])
  63. || !isRecord(workflow.jobs['node-24-coverage'])
  64. || !isRecord(workflow.jobs['node-24-consumers'])
  65. || !isRecord(workflow.jobs['all-checks-passed'])
  66. || !isRecord(masterWorkflow.jobs)
  67. || !isRecord(masterWorkflow.jobs['wine-apt-cache'])
  68. || !isRecord(masterWorkflow.jobs['serial-windows'])) {
  69. throw new TypeError('CI workflow must define windows, windows-build, windows-coverage, windows-native-tests, windows-observational, node-24, node-24-coverage, node-24-consumers, and all-checks-passed; ci-master must define wine-apt-cache and serial-windows')
  70. }
  71. const windows = workflow.jobs.windows
  72. const windowsBuild = workflow.jobs['windows-build']
  73. const windowsCoverage = workflow.jobs['windows-coverage']
  74. const windowsNativeTests = workflow.jobs['windows-native-tests']
  75. const windowsObservational = workflow.jobs['windows-observational']
  76. const wineAptCache = masterWorkflow.jobs['wine-apt-cache']
  77. const serialWindows = masterWorkflow.jobs['serial-windows']
  78. const node24 = workflow.jobs['node-24']
  79. const node24Coverage = workflow.jobs['node-24-coverage']
  80. const node24Consumers = workflow.jobs['node-24-consumers']
  81. const aggregate = workflow.jobs['all-checks-passed']
  82. if (!Array.isArray(windows.steps) || !Array.isArray(aggregate.needs)) {
  83. throw new TypeError('Windows job must define steps and the aggregate must define needs')
  84. }
  85. const commandSteps = windows.steps.filter((step): step is Record<string, unknown> & { run: string } => (
  86. isRecord(step) && typeof step.run === 'string'
  87. ))
  88. // Required PR job: Wine on ubuntu-latest, runs wine-windows-gates.sh.
  89. expect(windows['runs-on']).toBe('ubuntu-latest')
  90. expect(windows.name).toBe('windows node 24 / wine blocking')
  91. expect(windows.if).toBe("github.event_name == 'pull_request'")
  92. expect(commandSteps.some(step => step.run.includes('wine-windows-gates.sh'))).toBe(true)
  93. // The split native jobs all resolve their pool through the Windows switch.
  94. for (const [jobName, job] of [['windows-build', windowsBuild], ['windows-coverage', windowsCoverage], ['windows-native-tests', windowsNativeTests], ['windows-observational', windowsObservational]] as const) {
  95. expect(typeof job['runs-on']).toBe('string')
  96. expect(job['runs-on'], `${jobName} runs-on must use the Windows failover switch`).toContain('DSH_CI_FAILOVER_WINDOWS')
  97. expect(job['runs-on'], `${jobName} runs-on must not use the Linux failover switch`).not.toContain('DSH_CI_FAILOVER_LINUX')
  98. expect(job['runs-on']).toContain('self-hosted')
  99. expect(job['runs-on']).toContain('dsh-win-ci')
  100. expect(job['runs-on']).toContain('dsh-windows-2025-16core')
  101. expect(job.if).toBe("github.event_name == 'pull_request'")
  102. }
  103. // windows-build runs the blocking build/site pair.
  104. expect(windowsBuild.name).toBe('windows node 24 / build')
  105. const buildSteps = windowsBuild.steps as unknown[]
  106. const buildCommands = buildSteps.filter((step): step is Record<string, unknown> & { run: string } => (
  107. isRecord(step) && typeof step.run === 'string'
  108. ))
  109. expect(buildCommands.map(step => step.run)).toContain('pnpm run check:ci:windows-blocking')
  110. // The four native Windows installs branch on the workspace filesystem:
  111. // clone (ReFS block clone) only on ReFS, plain install elsewhere. This
  112. // keeps the TS6231 store-path leak (see the Windows ReFS store note) out
  113. // of the self-hosted pool without forcing clone onto hosted NTFS, which
  114. // rejects copy-on-write. The branch must stay, or a hosted fallback would
  115. // fail installs with ERR_PNPM_LINKING_FAILED.
  116. for (const [jobName, job] of [['windows-build', windowsBuild], ['windows-coverage', windowsCoverage], ['windows-native-tests', windowsNativeTests], ['windows-observational', windowsObservational]] as const) {
  117. const steps = job.steps as unknown[]
  118. const install = steps.find((step): step is Record<string, unknown> & { run: string } => (
  119. isRecord(step) && step.name === 'Install (immutable)' && typeof step.run === 'string'
  120. ))
  121. expect(install, `${jobName} must define the filesystem-branched install`).toBeDefined()
  122. expect(install!.run).toContain("$fs -eq 'ReFS'")
  123. expect(install!.run).toContain('--package-import-method=clone')
  124. expect(install!.run).toContain('corepack pnpm install')
  125. // The else branch must keep the plain hosted install as a distinct line
  126. // (not the corepack clone line, which contains the same substring);
  127. // dropping it or making both branches clone would force clone onto
  128. // NTFS, which rejects copy-on-write (ERR_PNPM_LINKING_FAILED). The
  129. // YAML folded block keeps the first statement on line 1 and folds the
  130. // rest with leading two-space indents.
  131. const installLines = install!.run.split('\n').map(line => line.trim())
  132. expect(installLines).toContain('} else {')
  133. expect(installLines.some(line => line === 'pnpm install --frozen-lockfile'), `${jobName} else branch must keep the plain hosted install`).toBe(true)
  134. // The ReFS branch must not use the interpolated empty-flag form, which
  135. // passes a stray "" positional argument to pnpm.
  136. expect(install!.run).not.toContain('$cloneFlag')
  137. }
  138. // windows-coverage uses the lower 4-partition profile.
  139. expect(windowsCoverage.name).toBe('windows node 24 / coverage')
  140. expect(windowsCoverage.env).toMatchObject({ DSH_COVERAGE_PARTITIONS: '4' })
  141. const coverageSteps = windowsCoverage.steps as unknown[]
  142. const coverageCommands = coverageSteps.filter((step): step is Record<string, unknown> & { run: string } => (
  143. isRecord(step) && typeof step.run === 'string'
  144. ))
  145. expect(coverageCommands.map(step => step.run)).toContain('pnpm run check:ci:coverage')
  146. // windows-native-tests runs the Windows-specific specs.
  147. expect(windowsNativeTests.name).toBe('windows node 24 / native tests')
  148. const nativeTestSteps = windowsNativeTests.steps as unknown[]
  149. const nativeTestCommands = nativeTestSteps.filter((step): step is Record<string, unknown> & { run: string } => (
  150. isRecord(step) && typeof step.run === 'string'
  151. ))
  152. const nativeTestCommand = nativeTestCommands.map(step => step.run).join('\n')
  153. expect(nativeTestCommand).toContain('--no-file-parallelism')
  154. expect(nativeTestCommand).toContain('--testTimeout 90000')
  155. expect(nativeTestCommand).toContain('tool-pwsh/tests/loader.spec.ts')
  156. expect(nativeTestCommand).toContain('workflow-worker-thread.spec.ts')
  157. // windows-observational is non-blocking.
  158. expect(windowsObservational.name).toBe('windows node 24 / observational')
  159. expect(windowsObservational['continue-on-error']).toBe(true)
  160. // wine-apt-cache: master-only, seeds the Wine apt cache, lives in ci-master.
  161. expect(wineAptCache.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  162. expect(wineAptCache['runs-on']).toBe('ubuntu-latest')
  163. // serial-windows: master-only standby, self-hosted, non-blocking, lives in ci-master.
  164. expect(serialWindows.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  165. expect(serialWindows['runs-on']).toEqual(['self-hosted', 'dsh-win-ci', 'windows'])
  166. expect(serialWindows.name).toBe('serial / windows (self-hosted standby)')
  167. // Its store must share the ReFS workspace volume for clone; the install
  168. // must carry the same filesystem branch as the PR jobs.
  169. const serialSteps = serialWindows.steps as unknown[]
  170. const serialStore = serialSteps.find((step): step is Record<string, unknown> & { run: string } => (
  171. isRecord(step) && step.name === 'Configure persistent pnpm store' && typeof step.run === 'string'
  172. ))
  173. expect(serialStore).toBeDefined()
  174. expect(serialStore!.run).toContain('F:\\.pnpm-store')
  175. const serialInstall = serialSteps.find((step): step is Record<string, unknown> & { run: string } => (
  176. isRecord(step) && step.name === 'Install (immutable)' && typeof step.run === 'string'
  177. ))
  178. expect(serialInstall).toBeDefined()
  179. expect(serialInstall!.run).toContain("$fs -eq 'ReFS'")
  180. expect(serialInstall!.run).toContain('--package-import-method=clone')
  181. expect(serialInstall!.run).toContain('corepack pnpm install')
  182. // Distinct else-branch line, as for the PR jobs: the corepack clone line
  183. // contains the plain-install substring too.
  184. expect(serialInstall!.run.split('\n').map(line => line.trim())).toContain('} else {')
  185. expect(serialInstall!.run.split('\n').map(line => line.trim())).toContain('pnpm install --frozen-lockfile')
  186. expect(serialInstall!.run).not.toContain('$cloneFlag')
  187. // Aggregate: Wine and the required split native jobs are needed;
  188. // windows-coverage is temporarily non-blocking while Windows ACP
  189. // half-close tests are stabilized; observational stays out too.
  190. expect(aggregate.needs).toContain('windows')
  191. expect(aggregate.needs).toContain('windows-build')
  192. expect(aggregate.needs).not.toContain('windows-coverage')
  193. expect(aggregate.needs).toContain('windows-native-tests')
  194. expect(aggregate.needs).not.toContain('windows-observational')
  195. expect(aggregate.needs).not.toContain('serial-windows')
  196. // Linux failover is a separate switch: the three required Linux workers
  197. // and the verdict job resolve their pool through DSH_CI_FAILOVER_LINUX,
  198. // never the Windows switch.
  199. for (const [jobName, job] of [['node-24', node24], ['node-24-coverage', node24Coverage], ['node-24-consumers', node24Consumers]] as const) {
  200. expect(typeof job['runs-on']).toBe('string')
  201. expect(job['runs-on'], `${jobName} runs-on must use the Linux failover switch`).toContain('DSH_CI_FAILOVER_LINUX')
  202. expect(job['runs-on'], `${jobName} runs-on must not use the Windows failover switch`).not.toContain('DSH_CI_FAILOVER_WINDOWS')
  203. expect(job['runs-on']).toContain('vm-backup')
  204. }
  205. expect(aggregate['runs-on']).toContain('DSH_CI_FAILOVER_LINUX')
  206. expect(aggregate['runs-on']).not.toContain('DSH_CI_FAILOVER_WINDOWS')
  207. expect(aggregate['runs-on']).toContain('vm-backup')
  208. })
  209. it('gives the Wine Host TypeScript compile the repository heap budget', () => {
  210. const wineGates = readFileSync(resolve(root, 'scripts/wine-windows-gates.sh'), 'utf8')
  211. expect(wineGates).toContain(
  212. 'wine_node "$scratch/logs/host-tsc.log" --max-old-space-size=4096 "$tsc_js" -b tsconfig.host.json --pretty false',
  213. )
  214. })
  215. it('exempts push from cancellation in ci-master, so one master merge does not cancel the running drill', () => {
  216. const workflow = loadWorkflow('.github/workflows/ci-master.yml')
  217. const prWorkflow = loadWorkflow('.github/workflows/ci.yml')
  218. if (!isRecord(workflow.jobs) || !isRecord(workflow.concurrency)) {
  219. throw new TypeError('ci-master workflow must define jobs and a workflow-level concurrency block')
  220. }
  221. if (!isRecord(prWorkflow.jobs)) {
  222. throw new TypeError('ci workflow must define jobs')
  223. }
  224. // Cancellation applies to the whole superseded RUN, so this has to be
  225. // decided at workflow level and gated on the event: a job-level group
  226. // cannot exempt its job from its run being cancelled. Only push is exempt —
  227. // a drill takes longer than the interval between master merges. The negated
  228. // form is load-bearing: `== 'pull_request'` would also stop cancelling
  229. // workflow_dispatch, and a re-dispatched runner benchmark holds up to 12
  230. // larger runners for 15 minutes in this same group on master.
  231. expect(workflow.concurrency['cancel-in-progress']).toBe("${{ github.event_name != 'push' }}")
  232. // The PR-only ci.yml still cancels a superseded run on a new push, so a
  233. // fresh head does not stack a second full 9-job run behind a stale one.
  234. // Unlike ci-master it has no push carve-out: every PR event supersedes.
  235. expect(prWorkflow.concurrency).toMatchObject({
  236. 'cancel-in-progress': true,
  237. })
  238. // The exact event sets are what keep master-only jobs out of the PR check
  239. // panel: ci-master triggers only on push(master) + workflow_dispatch and
  240. // never on pull_request; ci.yml is exactly pull_request-only. Assert the
  241. // full sets so losing the wrong event, or gaining an extra one, fails.
  242. if (!isRecord(workflow.on) || !isRecord(prWorkflow.on)) {
  243. throw new TypeError('both CI workflows must define on')
  244. }
  245. expect(Object.keys(workflow.on).sort()).toEqual(['push', 'workflow_dispatch'])
  246. expect(Object.keys(prWorkflow.on)).toEqual(['pull_request'])
  247. // Neither drill may carry a job-level group: it would not exempt the job
  248. // from run-scoped cancellation.
  249. for (const name of ['serial-linux-selfhosted', 'serial-windows']) {
  250. const job = workflow.jobs[name]
  251. if (!isRecord(job)) throw new TypeError(`${name} must be defined`)
  252. expect(job.concurrency).toBeUndefined()
  253. // Both stay master-push-only; that is what makes the push carve-out safe.
  254. expect(job.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  255. }
  256. // What bounds the cost of exempting push: a master push may only carry the
  257. // cache seeder and the two drills. Any job reachable on push would start
  258. // accumulating uncancelled runs, so the set is pinned here.
  259. const NOT_PUSH_REACHABLE = new Set([
  260. "github.event_name == 'workflow_dispatch' && inputs.suite == 'larger-runner-benchmark'",
  261. "github.event_name == 'workflow_dispatch' && inputs.suite == 'consolidated-runner-benchmark'",
  262. ])
  263. const pushReachable = Object.entries(workflow.jobs)
  264. .filter(([, job]) => {
  265. if (!isRecord(job)) return false
  266. if (job.if === undefined) return true // unconditional: runs on every event
  267. if (job.if === false) return false // `if: false` parses as a boolean
  268. if (typeof job.if !== 'string') return true // unrecognized shape: surface it
  269. return !NOT_PUSH_REACHABLE.has(job.if.trim())
  270. })
  271. .map(([name]) => name)
  272. .sort()
  273. expect(pushReachable).toEqual(['serial-linux-selfhosted', 'serial-windows', 'wine-apt-cache'])
  274. // Why workflow_dispatch must keep cancelling: each benchmark fans out to a
  275. // dozen larger runners at once, in this same group on master. If it stopped
  276. // cancelling, a re-dispatch would queue ahead of a drill instead of
  277. // replacing the stale measurement.
  278. for (const name of ['larger-runner-benchmark', 'consolidated-runner-benchmark']) {
  279. const job = workflow.jobs[name]
  280. if (!isRecord(job) || !isRecord(job.strategy)) {
  281. throw new TypeError(`${name} must define a matrix strategy`)
  282. }
  283. expect(job.strategy['max-parallel']).toBe(12)
  284. expect(job['timeout-minutes']).toBe(15)
  285. }
  286. })
  287. it('keeps supported LSP source under native Windows coverage', () => {
  288. const config = readFileSync(resolve(root, 'vitest.config.ts'), 'utf8')
  289. expect(config).not.toContain('packages/lsp/lsp-stdio/src/connection.ts')
  290. expect(config).not.toContain('packages/lsp/lsp-stdio/src/index.ts')
  291. expect(config).not.toContain('packages/lsp/lsp-stdio/src/instance.ts')
  292. })
  293. it('requires release-shaped Python runtime validation on every published target', () => {
  294. const workflow = loadWorkflow('.github/workflows/ci.yml')
  295. const pythonRuntime = workflowJob(workflow, 'python-runtime')
  296. const aggregate = workflowJob(workflow, 'all-checks-passed')
  297. if (!Array.isArray(aggregate.needs)) {
  298. throw new TypeError('CI aggregate must define required job dependencies')
  299. }
  300. expect(pythonRuntime).toMatchObject({
  301. if: "github.event_name == 'pull_request'",
  302. name: 'python runtime / release-shaped matrix',
  303. uses: './.github/workflows/build-exe-for-python-sdk.yml',
  304. with: {
  305. targets: 'node24-linux-x64,node24-linux-arm64,node24-macos-arm64,node24-win-x64',
  306. ci: true,
  307. },
  308. secrets: {
  309. DEEPSEEK_API_KEY_EXTERNAL: '${{ secrets.DEEPSEEK_API_KEY_EXTERNAL }}',
  310. },
  311. })
  312. expect(aggregate.needs).toContain('python-runtime')
  313. })
  314. it('keeps every Vitest project process-isolated on native Windows', () => {
  315. const config = readFileSync(resolve(root, 'vitest.config.ts'), 'utf8')
  316. expect(config).not.toContain("pool: process.platform === 'win32' ? 'threads' : 'forks'")
  317. expect(config.match(/pool: 'forks'/g)).toHaveLength(2)
  318. })
  319. })
  320. describe('DeepSeek e2e workflow', () => {
  321. it('prepares bubblewrap from the pinned payload without a package transaction', () => {
  322. const workflow = loadWorkflow('.github/workflows/e2e.yml')
  323. const e2e = workflowJob(workflow, 'e2e')
  324. if (!Array.isArray(e2e.steps)) throw new TypeError('DeepSeek e2e workflow must define steps')
  325. const steps = e2e.steps.filter(isRecord)
  326. expect(steps.find(step => step.name === 'Prepare bubblewrap (unrestrict userns)')).toMatchObject({
  327. run: 'bash scripts/prepare-ci-bubblewrap.sh',
  328. })
  329. expect(JSON.stringify(steps)).not.toContain('apt-get')
  330. })
  331. it('bounds profile subprocess fan-out to the tested e2e default', () => {
  332. const workflow = loadWorkflow('.github/workflows/e2e.yml')
  333. const e2e = workflowJob(workflow, 'e2e')
  334. if (!Array.isArray(e2e.steps)) throw new TypeError('DeepSeek e2e workflow must define steps')
  335. const step = e2e.steps.filter(isRecord).find(candidate => candidate.name === 'E2E tests (real DeepSeek API)')
  336. expect(step).toMatchObject({ env: { DSH_E2E_MAX_WORKERS: 4 } })
  337. })
  338. })
  339. describe('E2B e2e workflow', () => {
  340. it('is manual-only and fails loud before running the focused live suite', () => {
  341. const workflow = loadWorkflow('.github/workflows/e2b-e2e.yml')
  342. expect(workflow.on).toEqual({ workflow_dispatch: null })
  343. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs.e2b) || !Array.isArray(workflow.jobs.e2b.steps)) {
  344. throw new TypeError('E2B e2e workflow must define the e2b job steps')
  345. }
  346. const steps = workflow.jobs.e2b.steps.filter(isRecord)
  347. const preflight = steps.find(step => step.name === 'Preflight (require E2B API key)')
  348. const e2b = steps.find(step => step.name === 'E2B tests (live sandbox)')
  349. expect(preflight).toMatchObject({
  350. env: { E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}' },
  351. })
  352. expect(preflight?.run).toContain('E2B_API_KEY_EXTERNAL repository secret')
  353. expect(e2b).toMatchObject({
  354. env: {
  355. E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}',
  356. DSH_E2E_MAX_WORKERS: '1',
  357. DSH_EXAMPLE_MODE: 'lib',
  358. },
  359. })
  360. expect(e2b?.run).toContain('packages/e2b/e2b/tests/composition.e2e.ts')
  361. })
  362. })
  363. describe('Python release workflows', () => {
  364. it('keeps complete wheel validation separate from protected public publication', () => {
  365. const workflow = loadWorkflow('.github/workflows/python-release.yml')
  366. const dispatch = workflowEvent(workflow, 'workflow_dispatch')
  367. const build = workflowJob(workflow, 'build')
  368. const pythonCompat = workflowJob(workflow, 'python-compat')
  369. const validate = workflowJob(workflow, 'validate')
  370. const publishRuntime = workflowJob(workflow, 'publish-runtime')
  371. const publishSdk = workflowJob(workflow, 'publish-sdk')
  372. if (!isRecord(dispatch.inputs)
  373. || !isRecord(dispatch.inputs.publish)
  374. || !Array.isArray(pythonCompat.steps)
  375. || !Array.isArray(validate.steps)
  376. || !Array.isArray(publishRuntime.steps)
  377. || !Array.isArray(publishSdk.steps)) {
  378. throw new TypeError('Python release workflow must define publish input and release steps')
  379. }
  380. expect(dispatch.inputs.publish).toMatchObject({ type: 'boolean', default: false })
  381. if (!isRecord(workflow.on)) throw new TypeError('python-release workflow must define on')
  382. expect(Object.keys(workflow.on)).toEqual(['workflow_dispatch'])
  383. expect(build).toMatchObject({
  384. uses: './.github/workflows/build-exe-for-python-sdk.yml',
  385. with: {
  386. targets: 'node24-linux-x64,node24-linux-arm64,node24-macos-arm64,node24-win-x64',
  387. release: true,
  388. },
  389. })
  390. expect(pythonCompat.strategy).toMatchObject({ matrix: { python: ['3.10', '3.14'] } })
  391. const pythonCompatSteps = JSON.stringify(pythonCompat.steps)
  392. expect(pythonCompatSteps).toContain('dist/deepseek_harness_sdk-$VERSION-py3-none-any.whl')
  393. expect(pythonCompatSteps).toContain('dist/deepseek_harness_runtime_bin-$VERSION-py3-none-manylinux_2_28_x86_64.whl')
  394. expect(pythonCompatSteps).not.toContain('--find-links')
  395. const validateSteps = JSON.stringify(validate.steps)
  396. const authorize = validate.steps.filter(isRecord).find(step => step.name === 'Authorize publication request')
  397. if (!isRecord(authorize) || typeof authorize.run !== 'string') {
  398. throw new TypeError('Python release validation must authorize publication requests')
  399. }
  400. expect(validateSteps).toContain('PUBLIC_PYPI_RELEASE_ENABLED')
  401. expect(authorize).toMatchObject({
  402. env: {
  403. PYPI_PUBLISHER_REPOSITORY: '${{ vars.PYPI_PUBLISHER_REPOSITORY }}',
  404. REPOSITORY: '${{ github.repository }}',
  405. },
  406. })
  407. expect(authorize.run).toContain('[ "$REPOSITORY" = "$PYPI_PUBLISHER_REPOSITORY" ]')
  408. expect(validateSteps).toContain('100000000')
  409. expect(publishRuntime).toMatchObject({
  410. if: "github.event_name == 'workflow_dispatch' && inputs.publish",
  411. needs: 'validate',
  412. environment: 'pypi-runtime',
  413. permissions: { contents: 'read', 'id-token': 'write' },
  414. })
  415. expect(publishSdk).toMatchObject({
  416. if: "github.event_name == 'workflow_dispatch' && inputs.publish",
  417. needs: ['validate', 'publish-runtime'],
  418. environment: 'pypi',
  419. permissions: { contents: 'read', 'id-token': 'write' },
  420. })
  421. const runtimeSteps = publishRuntime.steps.filter(isRecord)
  422. const sdkSteps = publishSdk.steps.filter(isRecord)
  423. const runtimePublish = runtimeSteps.find(step => step.name === 'Publish runtime wheels')
  424. const sdkPublish = sdkSteps.find(step => step.name === 'Publish SDK wheel')
  425. const runtimeHashes = runtimeSteps.find(step => step.name === 'Verify release artifact hashes')
  426. const sdkHashes = sdkSteps.find(step => step.name === 'Verify release artifact hashes')
  427. expect([...runtimeSteps, ...sdkSteps].some(
  428. step => typeof step.uses === 'string' && step.uses.startsWith('actions/checkout@'),
  429. )).toBe(false)
  430. expect([...runtimeSteps, ...sdkSteps].filter(
  431. step => step.uses === 'pypa/gh-action-pypi-publish@release/v1',
  432. )).toHaveLength(2)
  433. expect(runtimePublish).toMatchObject({
  434. with: { 'packages-dir': 'dist/runtime/', attestations: false },
  435. })
  436. expect(sdkPublish).toMatchObject({
  437. with: { 'packages-dir': 'dist/sdk/', attestations: false },
  438. })
  439. expect(runtimeHashes).toMatchObject({ run: 'cd dist && sha256sum -c SHA256SUMS' })
  440. expect(sdkHashes).toMatchObject({ run: 'cd dist && sha256sum -c SHA256SUMS' })
  441. })
  442. it('exposes the native wheel builder to the release caller with normalized versions', () => {
  443. const workflow = loadWorkflow('.github/workflows/build-exe-for-python-sdk.yml')
  444. expect(Object.keys(workflow.on as Record<string, unknown>).sort()).toEqual(['workflow_call', 'workflow_dispatch'])
  445. const call = workflowEvent(workflow, 'workflow_call')
  446. const plan = workflowJob(workflow, 'plan')
  447. const build = workflowJob(workflow, 'build')
  448. if (!isRecord(call.inputs) || !isRecord(call.secrets) || !Array.isArray(plan.steps) || !Array.isArray(build.steps)) {
  449. throw new TypeError('Python wheel builder must define workflow_call inputs and plan steps')
  450. }
  451. const buildSteps: unknown[] = build.steps
  452. const manylinuxAddon = buildSteps.find(step => isRecord(step) && step.name === 'Rebuild Linux node-pty against manylinux 2.28')
  453. const macosCheck = buildSteps.find(step => isRecord(step) && step.name === 'Check macOS deployment target')
  454. const manylinuxSmoke = buildSteps.find(step => isRecord(step) && step.name === 'Run wheel in a manylinux 2.28 container')
  455. const cleanVenvPosix = buildSteps.find(step => isRecord(step) && step.name === 'Install local SDK and runtime wheels into a clean venv (POSIX)')
  456. const cleanVenvWindows = buildSteps.find(step => isRecord(step) && step.name === 'Install local SDK and runtime wheels into a clean venv (Windows)')
  457. const installedKeylessPosix = buildSteps.find(step => isRecord(step) && step.name === 'Run installed-wheel keyless black-box tests (POSIX)')
  458. const installedKeylessWindows = buildSteps.find(step => isRecord(step) && step.name === 'Run installed-wheel keyless black-box tests (Windows)')
  459. const realApiPreflightPosix = buildSteps.find(step => isRecord(step) && step.name === 'Preflight installed-wheel real API test (POSIX)')
  460. const realApiPreflightWindows = buildSteps.find(step => isRecord(step) && step.name === 'Preflight installed-wheel real API test (Windows)')
  461. const installedRealApiPosix = buildSteps.find(step => isRecord(step) && step.name === 'Run installed-wheel real API black-box test (POSIX)')
  462. const installedRealApiWindows = buildSteps.find(step => isRecord(step) && step.name === 'Run installed-wheel real API black-box test (Windows)')
  463. if (!isRecord(cleanVenvPosix) || !isRecord(cleanVenvWindows)
  464. || !isRecord(installedKeylessPosix) || !isRecord(installedKeylessWindows)
  465. || !isRecord(realApiPreflightPosix) || !isRecord(realApiPreflightWindows)
  466. || !isRecord(installedRealApiPosix) || !isRecord(installedRealApiWindows)) {
  467. throw new TypeError('Python wheel builder must define native POSIX and Windows installed-wheel steps')
  468. }
  469. expect(call.inputs).toHaveProperty('targets')
  470. expect(call.inputs).toMatchObject({
  471. ci: { type: 'boolean', default: false },
  472. release: { type: 'boolean', default: false },
  473. })
  474. expect(call.secrets).toMatchObject({
  475. DEEPSEEK_API_KEY_EXTERNAL: { required: false },
  476. })
  477. expect(workflow.concurrency).toMatchObject({
  478. group: 'build-single-exe-${{ github.workflow }}-${{ github.ref }}',
  479. })
  480. expect(build.defaults).toBeUndefined()
  481. expect(plan.if).toContain('inputs.ci')
  482. expect(plan.if).toContain('inputs.release')
  483. expect(JSON.stringify(plan.steps)).toContain('pep440_version')
  484. const workflowJson = JSON.stringify(workflow)
  485. expect(workflowJson).toContain('macosx_14_0_arm64')
  486. expect(workflowJson).toContain('win_amd64')
  487. expect(workflowJson).toContain('node24-win-x64')
  488. expect(workflowJson).toContain('windows-2025')
  489. expect(workflowJson).toContain('dist-python/$SDK_WHEEL')
  490. expect(workflowJson).toContain('dist-python/$RUNTIME_WHEEL')
  491. expect(workflowJson).toContain('/work/dist-python/$SDK_WHEEL')
  492. expect(workflowJson).toContain('/work/dist-python/$RUNTIME_WHEEL')
  493. expect(workflowJson).not.toContain('--find-links dist-python')
  494. expect(workflowJson).not.toContain('--find-links /work/dist-python')
  495. expect(workflowJson).not.toContain('cygpath')
  496. expect(manylinuxAddon).toMatchObject({ if: "runner.os == 'Linux'" })
  497. expect(JSON.stringify(manylinuxAddon)).toContain('manylinux_2_28_x86_64')
  498. expect(JSON.stringify(manylinuxAddon)).toContain('manylinux_2_28_aarch64')
  499. expect(JSON.stringify(manylinuxAddon)).toContain('npm_config_build_from_source=true pnpm run install')
  500. expect(JSON.stringify(manylinuxAddon)).toContain('pnpm_setup_root')
  501. expect(JSON.stringify(manylinuxAddon)).toContain('$pnpm_setup_root:$pnpm_setup_root:ro')
  502. expect(JSON.stringify(manylinuxAddon)).toContain('node-pty-glibc-versions.txt')
  503. expect(JSON.stringify(manylinuxAddon)).toContain('le 2.28')
  504. expect(macosCheck).toMatchObject({ if: "runner.os == 'macOS'" })
  505. expect(JSON.stringify(macosCheck)).toContain('scripts/check-macos-deployment-target.py')
  506. expect(JSON.stringify(macosCheck)).toContain('$EXE-spawn-helper')
  507. expect(JSON.stringify(installedKeylessPosix)).toContain('--scenario all')
  508. expect(JSON.stringify(installedKeylessPosix)).toContain('env -u PYTHONPATH')
  509. expect(JSON.stringify(installedKeylessWindows)).toContain('--scenario all --installed-wheel')
  510. expect(installedKeylessWindows).toMatchObject({ if: "runner.os == 'Windows'", shell: 'pwsh' })
  511. expect(cleanVenvWindows).toMatchObject({ if: "runner.os == 'Windows'", shell: 'pwsh' })
  512. expect(JSON.stringify(cleanVenvWindows)).toContain('Scripts\\\\python.exe')
  513. expect(realApiPreflightPosix).toMatchObject({
  514. env: { DEEPSEEK_API_KEY: '${{ secrets.DEEPSEEK_API_KEY_EXTERNAL }}' },
  515. })
  516. expect(String(realApiPreflightPosix.if)).toContain('inputs.ci')
  517. expect(String(realApiPreflightPosix.if)).toContain('head.repo.fork')
  518. expect(String(realApiPreflightPosix.if)).toContain('dependabot[bot]')
  519. expect(realApiPreflightWindows).toMatchObject({ shell: 'pwsh' })
  520. expect(installedRealApiPosix).toMatchObject({
  521. env: {
  522. DEEPSEEK_API_KEY: '${{ secrets.DEEPSEEK_API_KEY_EXTERNAL }}',
  523. DEEPSEEK_BASE_URL: 'https://api.deepseek.com',
  524. },
  525. })
  526. expect(JSON.stringify(installedRealApiPosix)).toContain('--scenario sdk-live')
  527. expect(JSON.stringify(installedRealApiPosix)).toContain('-u DSH_RUNTIME_MODE')
  528. expect(installedRealApiWindows).toMatchObject({ shell: 'pwsh' })
  529. expect(JSON.stringify(installedRealApiWindows)).toContain('--scenario sdk-live --installed-wheel')
  530. expect(manylinuxSmoke).toMatchObject({ if: "runner.os == 'Linux'" })
  531. expect(JSON.stringify(manylinuxSmoke)).toContain('-e DSH_TELEMETRY_DISABLED')
  532. })
  533. it('uses the shared macOS deployment-target check in GitLab', () => {
  534. const workflow = loadWorkflow('.gitlab-ci.yml')
  535. const runtimeWheel = workflow['.runtime-wheel']
  536. if (!isRecord(runtimeWheel) || !Array.isArray(runtimeWheel.script)) {
  537. throw new TypeError('GitLab CI must define the runtime wheel script')
  538. }
  539. const runtimeScript: unknown[] = runtimeWheel.script
  540. const macosCheck = runtimeScript.find(
  541. step => typeof step === 'string' && step.includes('PLATFORM" = macos-arm64'),
  542. )
  543. if (typeof macosCheck !== 'string') {
  544. throw new TypeError('GitLab CI must check the macOS deployment target')
  545. }
  546. expect(macosCheck).toContain('scripts/check-macos-deployment-target.py')
  547. expect(macosCheck).toContain('"$EXE" "$EXE-spawn-helper"')
  548. })
  549. it('builds and black-box tests the Windows x64 wheel in GitLab', () => {
  550. const workflow = loadWorkflow('.gitlab-ci.yml')
  551. const windows = workflow['runtime-windows-x64']
  552. const publish = workflow['publish-python']
  553. if (!isRecord(windows) || !Array.isArray(windows.before_script) || !Array.isArray(windows.script)
  554. || !isRecord(publish) || !Array.isArray(publish.needs)) {
  555. throw new TypeError('GitLab CI must define the Windows runtime and aggregate publication jobs')
  556. }
  557. expect(windows.tags).toEqual(['windows-x64'])
  558. expect(windows.variables).toMatchObject({ PKG_TARGET: 'node24-win-x64', PLATFORM: 'win-x64' })
  559. expect(JSON.stringify(windows.before_script)).toContain('.ci-python\\\\Scripts')
  560. expect(JSON.stringify(windows.before_script)).toContain('[IO.Path]::PathSeparator')
  561. expect(JSON.stringify(windows.script)).toContain('win_amd64.whl')
  562. expect(JSON.stringify(windows.script)).toContain('--scenario all --installed-wheel')
  563. expect(publish.needs).toContainEqual({ job: 'runtime-windows-x64', artifacts: true })
  564. })
  565. })
  566. describe('Issue lifecycle workflow', () => {
  567. it('runs the lifecycle job on every PR/review event but gates token and board steps', () => {
  568. const lifecycle = loadWorkflow('.github/workflows/issue-lifecycle.yml')
  569. const policy = loadWorkflow('.github/workflows/issue-policy.yml')
  570. const lifecycleJob = workflowJob(lifecycle, 'lifecycle')
  571. if (!Array.isArray(lifecycleJob.steps)) throw new TypeError('Issue lifecycle job must define steps')
  572. // The job has no job-level `if`, so it is listed on every pull_request /
  573. // pull_request_review event and reports success instead of a gray skip. The
  574. // write-capable steps are gated at step level so approved/commented reviews
  575. // never mint a Project/Issue App token nor touch the board.
  576. expect(lifecycle.on).toHaveProperty('pull_request')
  577. expect(lifecycle.on).toHaveProperty('pull_request_review')
  578. expect(lifecycleJob.if).toBeUndefined()
  579. // Keep the subscription-type gates: issue-lifecycle does not re-subscribe
  580. // ready_for_review (issue-policy owns that) and only reacts to submitted
  581. // review events.
  582. const lifecyclePullRequest = workflowEvent(lifecycle, 'pull_request')
  583. const lifecycleReview = workflowEvent(lifecycle, 'pull_request_review')
  584. expect(lifecyclePullRequest.types).not.toContain('ready_for_review')
  585. expect(lifecyclePullRequest.types).toContain('review_requested')
  586. expect(lifecycleReview.types).toEqual(['submitted'])
  587. const gated = "${{ github.event_name != 'pull_request_review' || github.event.review.state == 'changes_requested' }}"
  588. const steps = lifecycleJob.steps.filter(isRecord)
  589. const tokenStep = steps.find(s => s.name === 'Create project token')
  590. const handleStep = steps.find(s => s.name === 'Handle repository event')
  591. expect(tokenStep).toMatchObject({ if: gated })
  592. expect(handleStep).toMatchObject({ if: gated })
  593. // issue-policy owns PR validation; it is read-only and a real gate.
  594. const policyPullRequest = workflowEvent(policy, 'pull_request')
  595. expect(policyPullRequest.types).toContain('ready_for_review')
  596. })
  597. })
  598. describe('npm release workflows', () => {
  599. it('keeps publication dispatch-only and pack in the PR workflow', () => {
  600. // pack stays in the PR/master release workflows so a PR proves the set packs.
  601. for (const file of ['release.yml', 'release-vendor.yml']) {
  602. const workflow = loadWorkflow(`.github/workflows/${file}`)
  603. if (!isRecord(workflow.jobs)) throw new TypeError(`${file} must define jobs`)
  604. expect(Object.keys(workflow.jobs).sort()).toEqual(file === 'release.yml' ? ['dependencies', 'pack'] : ['pack'])
  605. }
  606. // publication is workflow_dispatch-only (never a PR check) and keeps the
  607. // npm-publish environment plus the shared dist-tag group.
  608. for (const file of ['release-publish.yml', 'release-vendor-publish.yml']) {
  609. const workflow = loadWorkflow(`.github/workflows/${file}`)
  610. if (!isRecord(workflow.on) || !isRecord(workflow.jobs)) throw new TypeError(`${file} must define on and jobs`)
  611. expect(Object.keys(workflow.on)).toEqual(['workflow_dispatch'])
  612. const publish = workflow.jobs.publish
  613. if (!isRecord(publish)) throw new TypeError(`${file} must define a publish job`)
  614. expect(publish.environment).toBe('npm-publish')
  615. expect(publish.concurrency).toMatchObject({ group: 'Release-publish' })
  616. }
  617. })
  618. it('runs dependency policy and npm layout checks in the DSH release workflow', () => {
  619. const workflow = loadWorkflow('.github/workflows/release.yml')
  620. const dependencies = workflowJob(workflow, 'dependencies')
  621. if (!isRecord(workflow.on) || !Array.isArray(dependencies.steps)) {
  622. throw new TypeError('DSH release workflow must define triggers and dependency steps')
  623. }
  624. const commands = dependencies.steps.flatMap(step =>
  625. isRecord(step) && typeof step.run === 'string' ? [step.run] : [])
  626. expect(Object.keys(workflow.on).sort()).toEqual(['pull_request', 'push', 'workflow_dispatch'])
  627. expect(commands).toContain('pnpm run verify-package-dependencies')
  628. expect(commands).toContain('pnpm run verify-npm-install-layout')
  629. })
  630. })
  631. describe('Documentation site publication', () => {
  632. it('keeps Pages deployment dispatch-only from a dsh-v* tag', () => {
  633. const workflow = loadWorkflow('.github/workflows/docs-pages.yml')
  634. const build = workflowJob(workflow, 'build')
  635. const deploy = workflowJob(workflow, 'deploy')
  636. if (!isRecord(workflow.on) || !isRecord(workflow.env) || !Array.isArray(build.steps)) {
  637. throw new TypeError('Documentation deployment must define on, env, and build steps')
  638. }
  639. // The site presents a released snapshot: a merge must never publish it, and
  640. // publication must never appear as a PR check.
  641. expect(Object.keys(workflow.on)).toEqual(['workflow_dispatch'])
  642. // RELEASE_PUBLISH makes release:verify reject every ref that is not a dsh-v*
  643. // tag naming this tree's version, so the site and the npm sequence share one
  644. // definition of a released version.
  645. const steps = build.steps.filter(isRecord)
  646. const verify = steps.find(step => step.name === 'Verify release version')
  647. const checkout = steps.find(
  648. step => typeof step.uses === 'string' && step.uses.startsWith('actions/checkout@'),
  649. )
  650. expect(verify).toMatchObject({
  651. env: { RELEASE_PUBLISH: 'true' },
  652. run: 'pnpm run release:verify --family dsh',
  653. })
  654. // Complete history: the release scripts read tags.
  655. expect(checkout).toMatchObject({ with: { 'fetch-depth': 0 } })
  656. // Projected source links stay on the public repository's master. That
  657. // repository advances only to each release commit, so its master never
  658. // carries unreleased work, while it retains only the most recent tags:
  659. // following the dispatched tag would leave every source link on a deploy
  660. // from an older tag unresolvable.
  661. expect(workflow.env.DOCS_REPOSITORY_REF).toBe('master')
  662. // The environment owns the deployment tag policy and the required reviewers.
  663. expect(deploy.environment).toMatchObject({ name: 'github-pages' })
  664. })
  665. })
  666. describe('Git hooks', () => {
  667. it('leaves frozen Agent Note sidecars to the archive verifier', () => {
  668. const lefthook = loadWorkflow('lefthook.yml')
  669. for (const hookName of ['pre-commit', 'pre-merge-commit']) {
  670. const hook = lefthook[hookName]
  671. if (!isRecord(hook) || !Array.isArray(hook.jobs)) {
  672. throw new TypeError(`lefthook must define ${hookName} jobs`)
  673. }
  674. const pairing: unknown = hook.jobs.find(
  675. (job: unknown) => isRecord(job) && job.name === 'translation pairing (staged records)',
  676. )
  677. expect(pairing).toMatchObject({ exclude: ['.agents/notes/archived/**'] })
  678. }
  679. })
  680. })
  681. function loadWorkflow(path: string): Record<string, unknown> {
  682. const workflow: unknown = yaml.load(readFileSync(resolve(root, path), 'utf8'))
  683. if (!isRecord(workflow)) throw new TypeError(`${path} must define a workflow`)
  684. return workflow
  685. }
  686. function workflowEvent(workflow: Record<string, unknown>, event: string): Record<string, unknown> {
  687. if (!isRecord(workflow.on) || !isRecord(workflow.on[event])) {
  688. throw new TypeError(`workflow must define the ${event} event`)
  689. }
  690. return workflow.on[event]
  691. }
  692. function workflowJob(workflow: Record<string, unknown>, job: string): Record<string, unknown> {
  693. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs[job])) {
  694. throw new TypeError(`workflow must define the ${job} job`)
  695. }
  696. return workflow.jobs[job]
  697. }
  698. function isRecord(value: unknown): value is Record<string, unknown> {
  699. return typeof value === 'object' && value !== null && !Array.isArray(value)
  700. }