ci-workflow.spec.ts 47 KB

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