ci-workflow.spec.ts 28 KB

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