ci-workflow.spec.ts 3.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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. describe('CI workflow', () => {
  8. it('isolates every pnpm action setup destination per runner', () => {
  9. const workflow: unknown = yaml.load(readFileSync(resolve(root, '.github/workflows/ci.yml'), 'utf8'))
  10. if (!isRecord(workflow) || !isRecord(workflow.jobs)) throw new TypeError('CI workflow must define jobs')
  11. const setups = Object.entries(workflow.jobs).flatMap(([jobName, job]) => {
  12. if (!isRecord(job) || !Array.isArray(job.steps)) return []
  13. return job.steps.flatMap((step) => {
  14. if (!isRecord(step) || typeof step.uses !== 'string' || !step.uses.startsWith('pnpm/action-setup@')) return []
  15. return [{ jobName, step }]
  16. })
  17. })
  18. expect(setups.length).toBeGreaterThan(0)
  19. for (const { jobName, step } of setups) {
  20. expect(step, `${jobName} must not share pnpm/action-setup's default destination`).toMatchObject({
  21. with: { dest: runnerPrivatePnpmDestination },
  22. })
  23. }
  24. })
  25. })
  26. describe('E2B e2e workflow', () => {
  27. it('is manual-only and fails loud before running the focused live suite', () => {
  28. const workflow = loadWorkflow('.github/workflows/e2b-e2e.yml')
  29. expect(workflow.on).toEqual({ workflow_dispatch: null })
  30. if (!isRecord(workflow.jobs) || !isRecord(workflow.jobs.e2b) || !Array.isArray(workflow.jobs.e2b.steps)) {
  31. throw new TypeError('E2B e2e workflow must define the e2b job steps')
  32. }
  33. const steps = workflow.jobs.e2b.steps.filter(isRecord)
  34. const preflight = steps.find(step => step.name === 'Preflight (require E2B API key)')
  35. const e2b = steps.find(step => step.name === 'E2B tests (live sandbox)')
  36. expect(preflight).toMatchObject({
  37. env: { E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}' },
  38. })
  39. expect(preflight?.run).toContain('E2B_API_KEY_EXTERNAL repository secret')
  40. expect(e2b).toMatchObject({
  41. env: {
  42. E2B_API_KEY: '${{ secrets.E2B_API_KEY_EXTERNAL }}',
  43. DSH_E2E_MAX_WORKERS: '1',
  44. DSH_EXAMPLE_MODE: 'lib',
  45. },
  46. })
  47. expect(e2b?.run).toContain('packages/e2b/e2b/tests/composition.e2e.ts')
  48. })
  49. })
  50. describe('Issue lifecycle workflow', () => {
  51. it('uses review signals instead of rerunning when a draft becomes ready', () => {
  52. const lifecycle = loadWorkflow('.github/workflows/issue-lifecycle.yml')
  53. const lifecyclePullRequest = workflowEvent(lifecycle, 'pull_request')
  54. const lifecycleReview = workflowEvent(lifecycle, 'pull_request_review')
  55. const policy = loadWorkflow('.github/workflows/issue-policy.yml')
  56. const policyPullRequest = workflowEvent(policy, 'pull_request')
  57. expect(lifecyclePullRequest.types).not.toContain('ready_for_review')
  58. expect(lifecyclePullRequest.types).toContain('review_requested')
  59. expect(lifecycleReview.types).toContain('submitted')
  60. expect(policyPullRequest.types).toContain('ready_for_review')
  61. })
  62. })
  63. function loadWorkflow(path: string): Record<string, unknown> {
  64. const workflow: unknown = yaml.load(readFileSync(resolve(root, path), 'utf8'))
  65. if (!isRecord(workflow)) throw new TypeError(`${path} must define a workflow`)
  66. return workflow
  67. }
  68. function workflowEvent(workflow: Record<string, unknown>, event: string): Record<string, unknown> {
  69. if (!isRecord(workflow.on) || !isRecord(workflow.on[event])) {
  70. throw new TypeError(`workflow must define the ${event} event`)
  71. }
  72. return workflow.on[event]
  73. }
  74. function isRecord(value: unknown): value is Record<string, unknown> {
  75. return typeof value === 'object' && value !== null && !Array.isArray(value)
  76. }