ci-workflow.spec.ts 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
  1. import { readFileSync } from 'node:fs'
  2. import { resolve } from 'node:path'
  3. import * as yaml from 'js-yaml'
  4. import { describe, expect, it } from 'vitest'
  5. const root = resolve(import.meta.dirname, '..')
  6. const runnerPrivatePnpmDestination = '${{ runner.temp }}/setup-pnpm'
  7. const nativeWindowsPnpmDestination = '${{ runner.temp }}/setup-pnpm-js'
  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. expect(step, `${jobName} must not share pnpm/action-setup's default destination`).toMatchObject({
  26. with: {
  27. dest: jobName === 'windows-native'
  28. ? nativeWindowsPnpmDestination
  29. : runnerPrivatePnpmDestination,
  30. },
  31. })
  32. if (jobName === 'windows-native') expect(step).not.toMatchObject({ with: { standalone: true } })
  33. }
  34. })
  35. it('keeps a required Wine Windows job, a non-blocking native Windows job with failover, and a master-only standby', () => {
  36. const workflow = loadWorkflow('.github/workflows/ci.yml')
  37. const masterWorkflow = loadWorkflow('.github/workflows/ci-master.yml')
  38. if (!isRecord(workflow.jobs)
  39. || !isRecord(workflow.jobs.windows)
  40. || !isRecord(workflow.jobs['windows-native'])
  41. || !isRecord(workflow.jobs['node-24'])
  42. || !isRecord(workflow.jobs['node-24-coverage'])
  43. || !isRecord(workflow.jobs['node-24-consumers'])
  44. || !isRecord(workflow.jobs['all-checks-passed'])
  45. || !isRecord(masterWorkflow.jobs)
  46. || !isRecord(masterWorkflow.jobs['wine-apt-cache'])
  47. || !isRecord(masterWorkflow.jobs['serial-windows'])) {
  48. throw new TypeError('CI workflow must define windows, windows-native, node-24, node-24-coverage, node-24-consumers, and all-checks-passed; ci-master must define wine-apt-cache and serial-windows')
  49. }
  50. const windows = workflow.jobs.windows
  51. const windowsNative = workflow.jobs['windows-native']
  52. const wineAptCache = masterWorkflow.jobs['wine-apt-cache']
  53. const serialWindows = masterWorkflow.jobs['serial-windows']
  54. const node24 = workflow.jobs['node-24']
  55. const node24Coverage = workflow.jobs['node-24-coverage']
  56. const node24Consumers = workflow.jobs['node-24-consumers']
  57. const aggregate = workflow.jobs['all-checks-passed']
  58. if (!Array.isArray(windows.steps) || !Array.isArray(aggregate.needs)) {
  59. throw new TypeError('Windows job must define steps and the aggregate must define needs')
  60. }
  61. const commandSteps = windows.steps.filter((step): step is Record<string, unknown> & { run: string } => (
  62. isRecord(step) && typeof step.run === 'string'
  63. ))
  64. // Required PR job: Wine on ubuntu-latest, runs wine-windows-gates.sh.
  65. expect(windows['runs-on']).toBe('ubuntu-latest')
  66. expect(windows.name).toBe('windows node 24 / wine blocking')
  67. expect(windows.if).toBe("github.event_name == 'pull_request'")
  68. expect(commandSteps.some(step => step.run.includes('wine-windows-gates.sh'))).toBe(true)
  69. // windows-native: non-blocking native job with failover, runs windows-complete.
  70. // Its pool is resolved by the Windows-specific switch.
  71. expect(typeof windowsNative['runs-on']).toBe('string')
  72. expect(windowsNative['runs-on']).toContain('DSH_CI_FAILOVER_WINDOWS')
  73. expect(windowsNative['runs-on']).not.toContain('DSH_CI_FAILOVER_LINUX')
  74. expect(windowsNative['runs-on']).toContain('self-hosted')
  75. expect(windowsNative['runs-on']).toContain('dsh-win-ci')
  76. expect(windowsNative['runs-on']).toContain('dsh-windows-2025-16core')
  77. expect(windowsNative.name).toBe('windows node 24 / native complete')
  78. expect(windowsNative.if).toBe("github.event_name == 'pull_request'")
  79. expect(windowsNative.env).toMatchObject({
  80. DSH_COVERAGE_TEST_TIMEOUT_MS: '30000',
  81. })
  82. const nativeSteps = windowsNative.steps as unknown[]
  83. const nativeCommandSteps = nativeSteps.filter((step): step is Record<string, unknown> & { run: string } => (
  84. isRecord(step) && typeof step.run === 'string'
  85. ))
  86. expect(nativeCommandSteps.map(step => step.run)).toContain('pnpm run check:ci:windows-complete')
  87. // wine-apt-cache: master-only, seeds the Wine apt cache, lives in ci-master.
  88. expect(wineAptCache.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  89. expect(wineAptCache['runs-on']).toBe('ubuntu-latest')
  90. // serial-windows: master-only standby, self-hosted, non-blocking, lives in ci-master.
  91. expect(serialWindows.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  92. expect(serialWindows['runs-on']).toEqual(['self-hosted', 'dsh-win-ci', 'windows'])
  93. expect(serialWindows.name).toBe('serial / windows (self-hosted standby)')
  94. // Aggregate: Wine `windows` required, native `windows-native` excluded.
  95. expect(aggregate.needs).toContain('windows')
  96. expect(aggregate.needs).not.toContain('windows-native')
  97. expect(aggregate.needs).not.toContain('serial-windows')
  98. // Linux failover is a separate switch: the three required Linux workers
  99. // and the verdict job resolve their pool through DSH_CI_FAILOVER_LINUX,
  100. // never the Windows switch.
  101. for (const [jobName, job] of [['node-24', node24], ['node-24-coverage', node24Coverage], ['node-24-consumers', node24Consumers]] as const) {
  102. expect(typeof job['runs-on']).toBe('string')
  103. expect(job['runs-on'], `${jobName} runs-on must use the Linux failover switch`).toContain('DSH_CI_FAILOVER_LINUX')
  104. expect(job['runs-on'], `${jobName} runs-on must not use the Windows failover switch`).not.toContain('DSH_CI_FAILOVER_WINDOWS')
  105. expect(job['runs-on']).toContain('vm-backup')
  106. }
  107. expect(aggregate['runs-on']).toContain('DSH_CI_FAILOVER_LINUX')
  108. expect(aggregate['runs-on']).not.toContain('DSH_CI_FAILOVER_WINDOWS')
  109. expect(aggregate['runs-on']).toContain('vm-backup')
  110. })
  111. it('exempts push from cancellation in ci-master, so one master merge does not cancel the running drill', () => {
  112. const workflow = loadWorkflow('.github/workflows/ci-master.yml')
  113. const prWorkflow = loadWorkflow('.github/workflows/ci.yml')
  114. if (!isRecord(workflow.jobs) || !isRecord(workflow.concurrency)) {
  115. throw new TypeError('ci-master workflow must define jobs and a workflow-level concurrency block')
  116. }
  117. if (!isRecord(prWorkflow.jobs)) {
  118. throw new TypeError('ci workflow must define jobs')
  119. }
  120. // Cancellation applies to the whole superseded RUN, so this has to be
  121. // decided at workflow level and gated on the event: a job-level group
  122. // cannot exempt its job from its run being cancelled. Only push is exempt —
  123. // a drill takes longer than the interval between master merges. The negated
  124. // form is load-bearing: `== 'pull_request'` would also stop cancelling
  125. // workflow_dispatch, and a re-dispatched runner benchmark holds up to 12
  126. // larger runners for 15 minutes in this same group on master.
  127. expect(workflow.concurrency['cancel-in-progress']).toBe("${{ github.event_name != 'push' }}")
  128. // The PR-only ci.yml still cancels a superseded run on a new push, so a
  129. // fresh head does not stack a second full 9-job run behind a stale one.
  130. // Unlike ci-master it has no push carve-out: every PR event supersedes.
  131. expect(prWorkflow.concurrency).toMatchObject({
  132. 'cancel-in-progress': true,
  133. })
  134. // The exact event sets are what keep master-only jobs out of the PR check
  135. // panel: ci-master triggers only on push(master) + workflow_dispatch and
  136. // never on pull_request; ci.yml is exactly pull_request-only. Assert the
  137. // full sets so losing the wrong event, or gaining an extra one, fails.
  138. if (!isRecord(workflow.on) || !isRecord(prWorkflow.on)) {
  139. throw new TypeError('both CI workflows must define on')
  140. }
  141. expect(Object.keys(workflow.on).sort()).toEqual(['push', 'workflow_dispatch'])
  142. expect(Object.keys(prWorkflow.on)).toEqual(['pull_request'])
  143. // Neither drill may carry a job-level group: it would not exempt the job
  144. // from run-scoped cancellation.
  145. for (const name of ['serial-linux-selfhosted', 'serial-windows']) {
  146. const job = workflow.jobs[name]
  147. if (!isRecord(job)) throw new TypeError(`${name} must be defined`)
  148. expect(job.concurrency).toBeUndefined()
  149. // Both stay master-push-only; that is what makes the push carve-out safe.
  150. expect(job.if).toBe("github.event_name == 'push' && github.ref == 'refs/heads/master'")
  151. }
  152. // What bounds the cost of exempting push: a master push may only carry the
  153. // cache seeder and the two drills. Any job reachable on push would start
  154. // accumulating uncancelled runs, so the set is pinned here.
  155. const NOT_PUSH_REACHABLE = new Set([
  156. "github.event_name == 'workflow_dispatch' && inputs.suite == 'larger-runner-benchmark'",
  157. "github.event_name == 'workflow_dispatch' && inputs.suite == 'consolidated-runner-benchmark'",
  158. ])
  159. const pushReachable = Object.entries(workflow.jobs)
  160. .filter(([, job]) => {
  161. if (!isRecord(job)) return false
  162. if (job.if === undefined) return true // unconditional: runs on every event
  163. if (job.if === false) return false // `if: false` parses as a boolean
  164. if (typeof job.if !== 'string') return true // unrecognized shape: surface it
  165. return !NOT_PUSH_REACHABLE.has(job.if.trim())
  166. })
  167. .map(([name]) => name)
  168. .sort()
  169. expect(pushReachable).toEqual(['serial-linux-selfhosted', 'serial-windows', 'wine-apt-cache'])
  170. // Why workflow_dispatch must keep cancelling: each benchmark fans out to a
  171. // dozen larger runners at once, in this same group on master. If it stopped
  172. // cancelling, a re-dispatch would queue ahead of a drill instead of
  173. // replacing the stale measurement.
  174. for (const name of ['larger-runner-benchmark', 'consolidated-runner-benchmark']) {
  175. const job = workflow.jobs[name]
  176. if (!isRecord(job) || !isRecord(job.strategy)) {
  177. throw new TypeError(`${name} must define a matrix strategy`)
  178. }
  179. expect(job.strategy['max-parallel']).toBe(12)
  180. expect(job['timeout-minutes']).toBe(15)
  181. }
  182. })
  183. it('keeps supported LSP source under native Windows coverage', () => {
  184. const config = readFileSync(resolve(root, 'vitest.config.ts'), 'utf8')
  185. expect(config).not.toContain('packages/lsp/lsp-stdio/src/connection.ts')
  186. expect(config).not.toContain('packages/lsp/lsp-stdio/src/index.ts')
  187. expect(config).not.toContain('packages/lsp/lsp-stdio/src/instance.ts')
  188. })
  189. it('requires one release-shaped Python runtime target on every pull request', () => {
  190. const workflow = loadWorkflow('.github/workflows/ci.yml')
  191. const pythonRuntime = workflowJob(workflow, 'python-runtime')
  192. const aggregate = workflowJob(workflow, 'all-checks-passed')
  193. if (!Array.isArray(aggregate.needs)) {
  194. throw new TypeError('CI aggregate must define required job dependencies')
  195. }
  196. expect(pythonRuntime).toMatchObject({
  197. if: "github.event_name == 'pull_request'",
  198. name: 'python runtime / release-shaped Linux x64',
  199. uses: './.github/workflows/build-exe-for-python-sdk.yml',
  200. with: {
  201. targets: 'node24-linux-x64',
  202. ci: true,
  203. },
  204. })
  205. expect(aggregate.needs).toContain('python-runtime')
  206. })
  207. it('keeps every Vitest project process-isolated on native Windows', () => {
  208. const config = readFileSync(resolve(root, 'vitest.config.ts'), 'utf8')
  209. expect(config).not.toContain("pool: process.platform === 'win32' ? 'threads' : 'forks'")
  210. expect(config.match(/pool: 'forks'/g)).toHaveLength(2)
  211. })
  212. })
  213. describe('DeepSeek e2e workflow', () => {
  214. it('prepares bubblewrap from the pinned payload without a package transaction', () => {
  215. const workflow = loadWorkflow('.github/workflows/e2e.yml')
  216. const e2e = workflowJob(workflow, 'e2e')
  217. if (!Array.isArray(e2e.steps)) throw new TypeError('DeepSeek e2e workflow must define steps')
  218. const steps = e2e.steps.filter(isRecord)
  219. expect(steps.find(step => step.name === 'Prepare bubblewrap (unrestrict userns)')).toMatchObject({
  220. run: 'bash scripts/prepare-ci-bubblewrap.sh',
  221. })
  222. expect(JSON.stringify(steps)).not.toContain('apt-get')
  223. })
  224. })
  225. describe('E2B e2e workflow', () => {
  226. it('is manual-only and fails loud before running the focused live suite', () => {
  227. const workflow = loadWorkflow('.github/workflows/e2b-e2e.yml')
  228. expect(workflow.on).toEqual({ workflow_dispatch: null })
  229. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs.e2b) || !Array.isArray(workflow.jobs.e2b.steps)) {
  230. throw new TypeError('E2B e2e workflow must define the e2b job steps')
  231. }
  232. const steps = workflow.jobs.e2b.steps.filter(isRecord)
  233. const preflight = steps.find(step => step.name === 'Preflight (require E2B API key)')
  234. const e2b = steps.find(step => step.name === 'E2B tests (live sandbox)')
  235. expect(preflight).toMatchObject({
  236. env: { E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}' },
  237. })
  238. expect(preflight?.run).toContain('E2B_API_KEY_EXTERNAL repository secret')
  239. expect(e2b).toMatchObject({
  240. env: {
  241. E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}',
  242. DSH_E2E_MAX_WORKERS: '1',
  243. DSH_EXAMPLE_MODE: 'lib',
  244. },
  245. })
  246. expect(e2b?.run).toContain('packages/e2b/e2b/tests/composition.e2e.ts')
  247. })
  248. })
  249. describe('Python release workflows', () => {
  250. it('keeps complete wheel validation separate from protected public publication', () => {
  251. const workflow = loadWorkflow('.github/workflows/python-release.yml')
  252. const dispatch = workflowEvent(workflow, 'workflow_dispatch')
  253. const pullRequest = workflowEvent(workflow, 'pull_request')
  254. const build = workflowJob(workflow, 'build')
  255. const pythonCompat = workflowJob(workflow, 'python-compat')
  256. const validate = workflowJob(workflow, 'validate')
  257. const publishRuntime = workflowJob(workflow, 'publish-runtime')
  258. const publishSdk = workflowJob(workflow, 'publish-sdk')
  259. if (!isRecord(dispatch.inputs)
  260. || !isRecord(dispatch.inputs.publish)
  261. || !Array.isArray(pythonCompat.steps)
  262. || !Array.isArray(validate.steps)
  263. || !Array.isArray(publishRuntime.steps)
  264. || !Array.isArray(publishSdk.steps)) {
  265. throw new TypeError('Python release workflow must define publish input and release steps')
  266. }
  267. expect(dispatch.inputs.publish).toMatchObject({ type: 'boolean', default: false })
  268. expect(pullRequest).toEqual({ types: ['labeled'] })
  269. expect(build).toMatchObject({
  270. if: "github.event_name == 'workflow_dispatch' || github.event.label.name == 'python-release-dry-run'",
  271. uses: './.github/workflows/build-exe-for-python-sdk.yml',
  272. with: {
  273. targets: 'node24-linux-x64,node24-linux-arm64,node24-macos-arm64',
  274. release: true,
  275. },
  276. })
  277. expect(pythonCompat.strategy).toMatchObject({ matrix: { python: ['3.10', '3.14'] } })
  278. const pythonCompatSteps = JSON.stringify(pythonCompat.steps)
  279. expect(pythonCompatSteps).toContain('dist/deepseek_harness_sdk-$VERSION-py3-none-any.whl')
  280. expect(pythonCompatSteps).toContain('dist/deepseek_harness_runtime_bin-$VERSION-py3-none-manylinux_2_28_x86_64.whl')
  281. expect(pythonCompatSteps).not.toContain('--find-links')
  282. const validateSteps = JSON.stringify(validate.steps)
  283. const authorize = validate.steps.filter(isRecord).find(step => step.name === 'Authorize publication request')
  284. if (!isRecord(authorize) || typeof authorize.run !== 'string') {
  285. throw new TypeError('Python release validation must authorize publication requests')
  286. }
  287. expect(validateSteps).toContain('PUBLIC_PYPI_RELEASE_ENABLED')
  288. expect(authorize).toMatchObject({
  289. env: {
  290. PYPI_PUBLISHER_REPOSITORY: '${{ vars.PYPI_PUBLISHER_REPOSITORY }}',
  291. REPOSITORY: '${{ github.repository }}',
  292. },
  293. })
  294. expect(authorize.run).toContain('[ "$REPOSITORY" = "$PYPI_PUBLISHER_REPOSITORY" ]')
  295. expect(validateSteps).toContain('100000000')
  296. expect(publishRuntime).toMatchObject({
  297. if: "github.event_name == 'workflow_dispatch' && inputs.publish",
  298. needs: 'validate',
  299. environment: 'pypi-runtime',
  300. permissions: { contents: 'read', 'id-token': 'write' },
  301. })
  302. expect(publishSdk).toMatchObject({
  303. if: "github.event_name == 'workflow_dispatch' && inputs.publish",
  304. needs: ['validate', 'publish-runtime'],
  305. environment: 'pypi',
  306. permissions: { contents: 'read', 'id-token': 'write' },
  307. })
  308. const runtimeSteps = publishRuntime.steps.filter(isRecord)
  309. const sdkSteps = publishSdk.steps.filter(isRecord)
  310. const runtimePublish = runtimeSteps.find(step => step.name === 'Publish runtime wheels')
  311. const sdkPublish = sdkSteps.find(step => step.name === 'Publish SDK wheel')
  312. const runtimeHashes = runtimeSteps.find(step => step.name === 'Verify release artifact hashes')
  313. const sdkHashes = sdkSteps.find(step => step.name === 'Verify release artifact hashes')
  314. expect([...runtimeSteps, ...sdkSteps].some(
  315. step => typeof step.uses === 'string' && step.uses.startsWith('actions/checkout@'),
  316. )).toBe(false)
  317. expect([...runtimeSteps, ...sdkSteps].filter(
  318. step => step.uses === 'pypa/gh-action-pypi-publish@release/v1',
  319. )).toHaveLength(2)
  320. expect(runtimePublish).toMatchObject({
  321. with: { 'packages-dir': 'dist/runtime/', attestations: false },
  322. })
  323. expect(sdkPublish).toMatchObject({
  324. with: { 'packages-dir': 'dist/sdk/', attestations: false },
  325. })
  326. expect(runtimeHashes).toMatchObject({ run: 'cd dist && sha256sum -c SHA256SUMS' })
  327. expect(sdkHashes).toMatchObject({ run: 'cd dist && sha256sum -c SHA256SUMS' })
  328. })
  329. it('exposes the native wheel builder to the release caller with normalized versions', () => {
  330. const workflow = loadWorkflow('.github/workflows/build-exe-for-python-sdk.yml')
  331. const call = workflowEvent(workflow, 'workflow_call')
  332. const plan = workflowJob(workflow, 'plan')
  333. const build = workflowJob(workflow, 'build')
  334. if (!isRecord(call.inputs) || !Array.isArray(plan.steps) || !Array.isArray(build.steps)) {
  335. throw new TypeError('Python wheel builder must define workflow_call inputs and plan steps')
  336. }
  337. const buildSteps: unknown[] = build.steps
  338. const manylinuxAddon = buildSteps.find(step => isRecord(step) && step.name === 'Rebuild Linux node-pty against manylinux 2.28')
  339. const macosCheck = buildSteps.find(step => isRecord(step) && step.name === 'Check macOS deployment target')
  340. const manylinuxSmoke = buildSteps.find(step => isRecord(step) && step.name === 'Run wheel in a manylinux 2.28 container')
  341. expect(call.inputs).toHaveProperty('targets')
  342. expect(call.inputs).toMatchObject({
  343. ci: { type: 'boolean', default: false },
  344. release: { type: 'boolean', default: false },
  345. })
  346. expect(workflow.concurrency).toMatchObject({
  347. group: 'build-single-exe-${{ github.workflow }}-${{ github.ref }}',
  348. })
  349. expect(plan.if).toContain('inputs.ci')
  350. expect(plan.if).toContain('inputs.release')
  351. expect(JSON.stringify(plan.steps)).toContain('pep440_version')
  352. const workflowJson = JSON.stringify(workflow)
  353. expect(workflowJson).toContain('macosx_14_0_arm64')
  354. expect(workflowJson).toContain('dist-python/$SDK_WHEEL')
  355. expect(workflowJson).toContain('dist-python/$RUNTIME_WHEEL')
  356. expect(workflowJson).toContain('/work/dist-python/$SDK_WHEEL')
  357. expect(workflowJson).toContain('/work/dist-python/$RUNTIME_WHEEL')
  358. expect(workflowJson).not.toContain('--find-links dist-python')
  359. expect(workflowJson).not.toContain('--find-links /work/dist-python')
  360. expect(manylinuxAddon).toMatchObject({ if: "runner.os == 'Linux'" })
  361. expect(JSON.stringify(manylinuxAddon)).toContain('manylinux_2_28_x86_64')
  362. expect(JSON.stringify(manylinuxAddon)).toContain('manylinux_2_28_aarch64')
  363. expect(JSON.stringify(manylinuxAddon)).toContain('npm_config_build_from_source=true pnpm run install')
  364. expect(JSON.stringify(manylinuxAddon)).toContain('$HOME/setup-pnpm:$HOME/setup-pnpm:ro')
  365. expect(JSON.stringify(manylinuxAddon)).toContain('node-pty-glibc-versions.txt')
  366. expect(JSON.stringify(manylinuxAddon)).toContain('le 2.28')
  367. expect(macosCheck).toMatchObject({ if: "runner.os == 'macOS'" })
  368. expect(JSON.stringify(macosCheck)).toContain('scripts/check-macos-deployment-target.py')
  369. expect(JSON.stringify(macosCheck)).toContain('$EXE-spawn-helper')
  370. expect(manylinuxSmoke).toMatchObject({ if: "runner.os == 'Linux'" })
  371. expect(JSON.stringify(manylinuxSmoke)).toContain('-e DSH_TELEMETRY_DISABLED')
  372. })
  373. it('uses the shared macOS deployment-target check in GitLab', () => {
  374. const workflow = loadWorkflow('.gitlab-ci.yml')
  375. const runtimeWheel = workflow['.runtime-wheel']
  376. if (!isRecord(runtimeWheel) || !Array.isArray(runtimeWheel.script)) {
  377. throw new TypeError('GitLab CI must define the runtime wheel script')
  378. }
  379. const runtimeScript: unknown[] = runtimeWheel.script
  380. const macosCheck = runtimeScript.find(
  381. step => typeof step === 'string' && step.includes('PLATFORM" = macos-arm64'),
  382. )
  383. if (typeof macosCheck !== 'string') {
  384. throw new TypeError('GitLab CI must check the macOS deployment target')
  385. }
  386. expect(macosCheck).toContain('scripts/check-macos-deployment-target.py')
  387. expect(macosCheck).toContain('"$EXE" "$EXE-spawn-helper"')
  388. })
  389. })
  390. describe('Issue lifecycle workflow', () => {
  391. it('runs the lifecycle job on every PR/review event but gates token and board steps', () => {
  392. const lifecycle = loadWorkflow('.github/workflows/issue-lifecycle.yml')
  393. const policy = loadWorkflow('.github/workflows/issue-policy.yml')
  394. const lifecycleJob = workflowJob(lifecycle, 'lifecycle')
  395. if (!Array.isArray(lifecycleJob.steps)) throw new TypeError('Issue lifecycle job must define steps')
  396. // The job has no job-level `if`, so it is listed on every pull_request /
  397. // pull_request_review event and reports success instead of a gray skip. The
  398. // write-capable steps are gated at step level so approved/commented reviews
  399. // never mint a Project/Issue App token nor touch the board.
  400. expect(lifecycle.on).toHaveProperty('pull_request')
  401. expect(lifecycle.on).toHaveProperty('pull_request_review')
  402. expect(lifecycleJob.if).toBeUndefined()
  403. // Keep the subscription-type gates: issue-lifecycle does not re-subscribe
  404. // ready_for_review (issue-policy owns that) and only reacts to submitted
  405. // review events.
  406. const lifecyclePullRequest = workflowEvent(lifecycle, 'pull_request')
  407. const lifecycleReview = workflowEvent(lifecycle, 'pull_request_review')
  408. expect(lifecyclePullRequest.types).not.toContain('ready_for_review')
  409. expect(lifecyclePullRequest.types).toContain('review_requested')
  410. expect(lifecycleReview.types).toEqual(['submitted'])
  411. const gated = "${{ github.event_name != 'pull_request_review' || github.event.review.state == 'changes_requested' }}"
  412. const steps = lifecycleJob.steps.filter(isRecord)
  413. const tokenStep = steps.find(s => s.name === 'Create project token')
  414. const handleStep = steps.find(s => s.name === 'Handle repository event')
  415. expect(tokenStep).toMatchObject({ if: gated })
  416. expect(handleStep).toMatchObject({ if: gated })
  417. // issue-policy owns PR validation; it is read-only and a real gate.
  418. const policyPullRequest = workflowEvent(policy, 'pull_request')
  419. expect(policyPullRequest.types).toContain('ready_for_review')
  420. })
  421. })
  422. describe('npm release workflows', () => {
  423. it('keeps publication dispatch-only and pack in the PR workflow', () => {
  424. // pack stays in the PR/master release workflows so a PR proves the set packs.
  425. for (const file of ['release.yml', 'release-vendor.yml']) {
  426. const workflow = loadWorkflow(`.github/workflows/${file}`)
  427. if (!isRecord(workflow.jobs)) throw new TypeError(`${file} must define jobs`)
  428. expect(Object.keys(workflow.jobs).sort()).toEqual(['pack'])
  429. }
  430. // publication is workflow_dispatch-only (never a PR check) and keeps the
  431. // npm-publish environment plus the shared dist-tag group.
  432. for (const file of ['release-publish.yml', 'release-vendor-publish.yml']) {
  433. const workflow = loadWorkflow(`.github/workflows/${file}`)
  434. if (!isRecord(workflow.on) || !isRecord(workflow.jobs)) throw new TypeError(`${file} must define on and jobs`)
  435. expect(Object.keys(workflow.on)).toEqual(['workflow_dispatch'])
  436. const publish = workflow.jobs.publish
  437. if (!isRecord(publish)) throw new TypeError(`${file} must define a publish job`)
  438. expect(publish.environment).toBe('npm-publish')
  439. expect(publish.concurrency).toMatchObject({ group: 'Release-publish' })
  440. }
  441. })
  442. })
  443. describe('Documentation site publication', () => {
  444. it('keeps Pages deployment dispatch-only from a dsh-v* tag', () => {
  445. const workflow = loadWorkflow('.github/workflows/docs-pages.yml')
  446. const build = workflowJob(workflow, 'build')
  447. const deploy = workflowJob(workflow, 'deploy')
  448. if (!isRecord(workflow.on) || !isRecord(workflow.env) || !Array.isArray(build.steps)) {
  449. throw new TypeError('Documentation deployment must define on, env, and build steps')
  450. }
  451. // The site presents a released snapshot: a merge must never publish it, and
  452. // publication must never appear as a PR check.
  453. expect(Object.keys(workflow.on)).toEqual(['workflow_dispatch'])
  454. // RELEASE_PUBLISH makes release:verify reject every ref that is not a dsh-v*
  455. // tag naming this tree's version, so the site and the npm sequence share one
  456. // definition of a released version.
  457. const steps = build.steps.filter(isRecord)
  458. const verify = steps.find(step => step.name === 'Verify release version')
  459. const checkout = steps.find(
  460. step => typeof step.uses === 'string' && step.uses.startsWith('actions/checkout@'),
  461. )
  462. expect(verify).toMatchObject({
  463. env: { RELEASE_PUBLISH: 'true' },
  464. run: 'pnpm run release:verify --family dsh',
  465. })
  466. // Complete history: the release scripts read tags.
  467. expect(checkout).toMatchObject({ with: { 'fetch-depth': 0 } })
  468. // Projected source links stay on the public repository's master. That
  469. // repository advances only to each release commit, so its master never
  470. // carries unreleased work, while it retains only the most recent tags:
  471. // following the dispatched tag would leave every source link on a deploy
  472. // from an older tag unresolvable.
  473. expect(workflow.env.DOCS_REPOSITORY_REF).toBe('master')
  474. // The environment owns the deployment tag policy and the required reviewers.
  475. expect(deploy.environment).toMatchObject({ name: 'github-pages' })
  476. })
  477. })
  478. describe('Git hooks', () => {
  479. it('leaves frozen Agent Note sidecars to the archive verifier', () => {
  480. const lefthook = loadWorkflow('lefthook.yml')
  481. for (const hookName of ['pre-commit', 'pre-merge-commit']) {
  482. const hook = lefthook[hookName]
  483. if (!isRecord(hook) || !Array.isArray(hook.jobs)) {
  484. throw new TypeError(`lefthook must define ${hookName} jobs`)
  485. }
  486. const pairing: unknown = hook.jobs.find(
  487. (job: unknown) => isRecord(job) && job.name === 'translation pairing (staged records)',
  488. )
  489. expect(pairing).toMatchObject({ exclude: ['.agents/notes/archived/**'] })
  490. }
  491. })
  492. })
  493. function loadWorkflow(path: string): Record<string, unknown> {
  494. const workflow: unknown = yaml.load(readFileSync(resolve(root, path), 'utf8'))
  495. if (!isRecord(workflow)) throw new TypeError(`${path} must define a workflow`)
  496. return workflow
  497. }
  498. function workflowEvent(workflow: Record<string, unknown>, event: string): Record<string, unknown> {
  499. if (!isRecord(workflow.on) || !isRecord(workflow.on[event])) {
  500. throw new TypeError(`workflow must define the ${event} event`)
  501. }
  502. return workflow.on[event]
  503. }
  504. function workflowJob(workflow: Record<string, unknown>, job: string): Record<string, unknown> {
  505. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs[job])) {
  506. throw new TypeError(`workflow must define the ${job} job`)
  507. }
  508. return workflow.jobs[job]
  509. }
  510. function isRecord(value: unknown): value is Record<string, unknown> {
  511. return typeof value === 'object' && value !== null && !Array.isArray(value)
  512. }