test with devtools-json

Author: jycouet

packages/addons/_tests/_setup/suite.ts

@@ -18,19 +18,41 @@ const variants = vitest.inject('variants');
 
 type Fixtures<Addons extends AddonMap> = {
 	page: Page;
-	run(variant: ProjectVariant, options: OptionMap<Addons>): Promise<string>;
+	run(variant: ProjectVariant, options: OptionMap<Addons>): Promise<void>;
+	cwdVariant: (variant: ProjectVariant) => string;
+};
+
+const installAddonHelper = async <Addons extends AddonMap>(
+	cwdToUse: string,
+	addons: Addons,
+	variant: ProjectVariant,
+	options: OptionMap<Addons>
+) => {
+	const metaPath = path.resolve(cwdToUse, 'meta.json');
+	fs.writeFileSync(metaPath, JSON.stringify({ variant, options }, null, '\t'), 'utf8');
+
+	// run addon
+	const { pnpmBuildDependencies } = await installAddon({
+		cwd: cwdToUse,
+		addons,
+		options,
+		packageManager: 'pnpm'
+	});
+
+	addPnpmBuildDependencies(cwdToUse, 'pnpm', ['esbuild', ...pnpmBuildDependencies]);
 };
 
 export function setupTest<Addons extends AddonMap>(
 	addons: Addons,
-	options?: { skipBrowser?: boolean }
+	options?: { skipBrowser?: boolean; runPrepareAndInstallWithOption?: OptionMap<Addons> }
 ) {
 	const test = vitest.test.extend<Fixtures<Addons>>({} as any);
 
 	const withBrowser = !options?.skipBrowser;
 
 	let create: CreateProject;
 	let browser: Browser;
+	let cwdTestName: string;
 
 	if (withBrowser) {
 		vitest.beforeAll(async () => {
@@ -41,8 +63,11 @@ export function setupTest<Addons extends AddonMap>(
 		});
 	}
 
-	vitest.beforeAll(({ name }) => {
+	vitest.beforeAll(async ({ name }) => {
 		const testName = path.dirname(name).split('/').at(-1)!;
+		cwdTestName = path.resolve(cwd, testName);
+
+		fs.rmSync(cwdTestName, { force: true, recursive: true });
 
 		// constructs a builder for create test projects
 		create = createProject({ cwd, templatesDir, testName });
@@ -62,6 +87,18 @@ export function setupTest<Addons extends AddonMap>(
 				private: true
 			})
 		);
+
+		// run prepare and install steps if requested
+		if (options?.runPrepareAndInstallWithOption) {
+			// prepare: run addon for all variants
+			for (const variant of variants) {
+				const cwd = create({ testId: variant, variant });
+				await installAddonHelper(cwd, addons, variant, options.runPrepareAndInstallWithOption);
+			}
+
+			// install: run pnpm install
+			execSync('pnpm install --no-frozen-lockfile', { cwd: cwdTestName, stdio: 'pipe' });
+		}
 	});
 
 	// runs before each test case
@@ -71,23 +108,12 @@ export function setupTest<Addons extends AddonMap>(
 			browserCtx = await browser.newContext();
 			ctx.page = await browserCtx.newPage();
 		}
-		ctx.run = async (variant, options) => {
-			const cwd = create({ testId: ctx.task.id, variant });
-
-			// test metadata
-			const metaPath = path.resolve(cwd, 'meta.json');
-			fs.writeFileSync(metaPath, JSON.stringify({ variant, options }, null, '\t'), 'utf8');
-
-			// run addon
-			const { pnpmBuildDependencies } = await installAddon({
-				cwd,
-				addons,
-				options,
-				packageManager: 'pnpm'
-			});
-			addPnpmBuildDependencies(cwd, 'pnpm', ['esbuild', ...pnpmBuildDependencies]);
-
-			return cwd;
+		ctx.cwdVariant = (variant) => {
+			return path.resolve(cwdTestName, variant);
+		};
+		ctx.run = async (variant, runOptions) => {
+			const cwd = create({ testId: variant, variant });
+			await installAddonHelper(cwd, addons, variant, runOptions);
 		};
 
 		return async () => {

packages/addons/_tests/devtools-json/test.ts

@@ -4,12 +4,18 @@ import devtoolsJson from '../../devtools-json/index.ts';
 import fs from 'node:fs';
 import path from 'node:path';
 
-const { test, variants, prepareServer } = setupTest({ devtoolsJson }, { skipBrowser: true });
+const { test, variants, prepareServer } = setupTest(
+	{ devtoolsJson },
+	{
+		skipBrowser: true,
+		runPrepareAndInstallWithOption: { devtoolsJson: {} }
+	}
+);
 
 test.concurrent.for(variants)('default - %s', async (variant, { page, ...ctx }) => {
-	const cwd = await ctx.run(variant, { devtoolsJson: {} });
+	const cwd = ctx.cwdVariant(variant);
 
-	const { close } = await prepareServer({ cwd, page });
+	const { close } = await prepareServer({ cwd, page, installCommand: null! });
 	// kill server process when we're done
 	ctx.onTestFinished(async () => await close());
 

packages/cli/lib/testing.ts

@@ -70,8 +70,8 @@ export function createProject({ cwd, testName, templatesDir }: CreateOptions): C
 	// create the reference dir
 	const testDir = path.resolve(cwd, testName);
 	fs.mkdirSync(testDir, { recursive: true });
-	return ({ testId, variant, clean = true }) => {
-		const targetDir = path.resolve(testDir, testId);
+	return ({ variant, clean = true }) => {
+		const targetDir = path.resolve(testDir, variant);
 		if (clean && fs.existsSync(targetDir)) {
 			fs.rmSync(targetDir, { force: true, recursive: true });
 		}