ci-workflow.spec.ts 47 KB

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