ci-workflow.spec.ts 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  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('Issue lifecycle workflow', () => {
  27. it('uses review signals instead of rerunning when a draft becomes ready', () => {
  28. const lifecycle = loadWorkflow('.github/workflows/issue-lifecycle.yml')
  29. const lifecyclePullRequest = workflowEvent(lifecycle, 'pull_request')
  30. const lifecycleReview = workflowEvent(lifecycle, 'pull_request_review')
  31. const policy = loadWorkflow('.github/workflows/issue-policy.yml')
  32. const policyPullRequest = workflowEvent(policy, 'pull_request')
  33. expect(lifecyclePullRequest.types).not.toContain('ready_for_review')
  34. expect(lifecyclePullRequest.types).toContain('review_requested')
  35. expect(lifecycleReview.types).toContain('submitted')
  36. expect(policyPullRequest.types).toContain('ready_for_review')
  37. })
  38. })
  39. function loadWorkflow(path: string): Record<string, unknown> {
  40. const workflow: unknown = yaml.load(readFileSync(resolve(root, path), 'utf8'))
  41. if (!isRecord(workflow)) throw new TypeError(`${path} must define a workflow`)
  42. return workflow
  43. }
  44. function workflowEvent(workflow: Record<string, unknown>, event: string): Record<string, unknown> {
  45. if (!isRecord(workflow.on) || !isRecord(workflow.on[event])) {
  46. throw new TypeError(`workflow must define the ${event} event`)
  47. }
  48. return workflow.on[event]
  49. }
  50. function isRecord(value: unknown): value is Record<string, unknown> {
  51. return typeof value === 'object' && value !== null && !Array.isArray(value)
  52. }