ci-workflow.spec.ts 50 KB

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