|
| 1 | +import fs from 'node:fs'; |
| 2 | +import path from 'node:path'; |
| 3 | +import { execSync } from 'node:child_process'; |
| 4 | +import * as vitest from 'vitest'; |
| 5 | +import { installAddon, type AddonMap, type OptionMap } from 'sv'; |
| 6 | +import { createProject, startPreview, type CreateProject, type ProjectVariant } from 'sv/testing'; |
| 7 | +import { chromium, type Browser, type Page } from '@playwright/test'; |
| 8 | +import { fileURLToPath } from 'node:url'; |
| 9 | + |
| 10 | +const cwd = vitest.inject('testDir'); |
| 11 | +const templatesDir = vitest.inject('templatesDir'); |
| 12 | +const variants = vitest.inject('variants'); |
| 13 | + |
| 14 | +const SETUP_DIR = fileURLToPath(new URL('.', import.meta.url)); |
| 15 | + |
| 16 | +type Fixtures<Addons extends AddonMap> = { |
| 17 | + page: Page; |
| 18 | + run(variant: ProjectVariant, options: OptionMap<Addons>): Promise<string>; |
| 19 | +}; |
| 20 | + |
| 21 | +export function setupTest<Addons extends AddonMap>(addons: Addons) { |
| 22 | + let create: CreateProject; |
| 23 | + let browser: Browser; |
| 24 | + |
| 25 | + const test = vitest.test.extend<Fixtures<Addons>>({} as any); |
| 26 | + |
| 27 | + vitest.beforeAll(async () => { |
| 28 | + browser = await chromium.launch(); |
| 29 | + return async () => { |
| 30 | + await browser.close(); |
| 31 | + }; |
| 32 | + }); |
| 33 | + |
| 34 | + vitest.beforeAll(({ name }) => { |
| 35 | + const testName = path.parse(name).name.replace('.test', ''); |
| 36 | + |
| 37 | + // constructs a builder for create test projects |
| 38 | + create = createProject({ cwd, templatesDir, testName }); |
| 39 | + |
| 40 | + // creates a pnpm workspace in each addon dir |
| 41 | + fs.writeFileSync( |
| 42 | + path.resolve(cwd, testName, 'pnpm-workspace.yaml'), |
| 43 | + `packages:\n - '**/*'`, |
| 44 | + 'utf8' |
| 45 | + ); |
| 46 | + }); |
| 47 | + |
| 48 | + // runs before each test case |
| 49 | + vitest.beforeEach<Fixtures<Addons>>(async (ctx) => { |
| 50 | + const browserCtx = await browser.newContext(); |
| 51 | + ctx.page = await browserCtx.newPage(); |
| 52 | + ctx.run = async (variant, options) => { |
| 53 | + const cwd = create({ testId: ctx.task.id, variant }); |
| 54 | + |
| 55 | + // test metadata |
| 56 | + const metaPath = path.resolve(cwd, 'meta.json'); |
| 57 | + fs.writeFileSync(metaPath, JSON.stringify({ variant, options }, null, '\t'), 'utf8'); |
| 58 | + |
| 59 | + // run addon |
| 60 | + await installAddon({ cwd, addons, options, packageManager: 'pnpm' }); |
| 61 | + |
| 62 | + return cwd; |
| 63 | + }; |
| 64 | + |
| 65 | + return async () => { |
| 66 | + await browserCtx.close(); |
| 67 | + // ...other tear downs |
| 68 | + }; |
| 69 | + }); |
| 70 | + |
| 71 | + return { |
| 72 | + test, |
| 73 | + variants, |
| 74 | + prepareServer |
| 75 | + }; |
| 76 | +} |
| 77 | + |
| 78 | +/** |
| 79 | + * Installs dependencies, builds the project, and spins up the preview server |
| 80 | + */ |
| 81 | +async function prepareServer({ cwd, page }: { cwd: string; page: Page }) { |
| 82 | + // install deps |
| 83 | + execSync('pnpm install --no-frozen-lockfile', { cwd, stdio: 'pipe' }); |
| 84 | + |
| 85 | + // ...do commands and any other extra stuff |
| 86 | + |
| 87 | + // build project |
| 88 | + execSync('npm run build', { cwd, stdio: 'pipe' }); |
| 89 | + |
| 90 | + // start preview server `vite preview` |
| 91 | + const { url, close } = await startPreview({ cwd }); |
| 92 | + |
| 93 | + // navigate to the page |
| 94 | + await page.goto(url); |
| 95 | + |
| 96 | + return { url, close }; |
| 97 | +} |
| 98 | + |
| 99 | +/** |
| 100 | + * Applies a fixture to the target path |
| 101 | + */ |
| 102 | +export function fixture({ name, target }: { name: string; target: string }) { |
| 103 | + const fixturePath = path.resolve(SETUP_DIR, '..', 'fixtures', name); |
| 104 | + if (!fs.existsSync(fixturePath)) { |
| 105 | + throw new Error(`Fixture does not exist at: ${fixturePath}`); |
| 106 | + } |
| 107 | + fs.copyFileSync(fixturePath, target); |
| 108 | +} |
0 commit comments