Tests: Move bundler code from npm scripts to Node.js files

mgol · mgol · commit cb875a2fb260 · 2024-03-11T13:22:26.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@
 .sizecache.json
 yarn.lock
 .eslintcache
+tmp
 
 npm-debug.log*
 
@@ -29,7 +30,6 @@ npm-debug.log*
 /external
 /node_modules
 
-/test/bundler_smoke_tests/tmp
 /test/data/core/jquery-iterability-transpiled.js
 /test/data/qunit-fixture.js
 
diff --git a/eslint.config.js b/eslint.config.js
@@ -10,7 +10,7 @@ export default [
 		// See https://github.com/eslint/eslint/discussions/17412
 		ignores: [
 			"external",
-			"test/bundler_smoke_tests/tmp",
+			"**/tmp",
 			"test/data/json_obj.js"
 		]
 	},
diff --git a/package.json b/package.json
@@ -59,9 +59,9 @@
     "pretest": "npm run qunit-fixture && npm run babel:tests && npm run npmcopy",
     "qunit-fixture": "node build/tasks/qunit-fixture.js",
     "start": "node -e \"require('./build/tasks/build.js').buildDefaultFiles({ watch: true })\"",
-    "test:bundlers": "node -e \"require('./test/bundler_smoke_tests/utils.cjs').cleanTmpBundlersDir()\" && npm run build:all && rollup -c test/bundler_smoke_tests/rollup-pure-esm.config.js && rollup -c test/bundler_smoke_tests/rollup-commonjs.config.js && webpack -c test/bundler_smoke_tests/webpack.config.cjs && node test/bundler_smoke_tests/run-jsdom-tests.js",
+    "test:bundlers": "npm run pretest && npm run build:all && test/bundler_smoke_tests/run-jsdom-tests.js",
     "test:browser": "npm run pretest && npm run build:main && npm run test:unit -- -b chrome -b firefox -h",
-    "test:browserless": "npm run pretest && npm run test:bundlers && node build/tasks/node_smoke_tests.js && node build/tasks/promises_aplus_tests.js && npm run test:unit -- -b jsdom -m basic",
+    "test:browserless": "npm run pretest && npm run build:all && test/bundler_smoke_tests/run-jsdom-tests.js && node build/tasks/node_smoke_tests.js && node build/tasks/promises_aplus_tests.js && npm run test:unit -- -b jsdom -m basic",
     "test:jsdom": "npm run pretest && npm run build:main && npm run test:unit -- -b jsdom -m basic",
     "test:node_smoke_tests": "npm run pretest && npm run build:all && node build/tasks/node_smoke_tests.js",
     "test:promises_aplus": "npm run build:main && node build/tasks/promises_aplus_tests.js",
diff --git a/test/bundler_smoke_tests/lib/run-rollup.js b/test/bundler_smoke_tests/lib/run-rollup.js
@@ -0,0 +1,42 @@
+import { rollup } from "rollup";
+
+import { loadConfigFile } from "rollup/loadConfigFile";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const dirname = path.dirname( fileURLToPath( import.meta.url ) );
+const pureEsmConfigPath = path.resolve(
+	dirname, "..", "rollup-pure-esm.config.js" );
+const commonJSConfigPath = path.resolve(
+	dirname, "..", "rollup-commonjs.config.js" );
+
+// See https://rollupjs.org/javascript-api/#programmatically-loading-a-config-file
+async function runRollup( name, configPath ) {
+
+	console.log( `Running Rollup, version: ${ name }` );
+
+	// options is an array of "inputOptions" objects with an additional
+	// "output" property that contains an array of "outputOptions".
+	// We generate a single output so the array only has one element.
+	const {
+		options: [ optionsObj ],
+		warnings
+	} = await loadConfigFile( configPath, {} );
+
+	// "warnings" wraps the default `onwarn` handler passed by the CLI.
+	// This prints all warnings up to this point:
+	warnings.flush();
+
+	const bundle = await rollup( optionsObj );
+	await Promise.all( optionsObj.output.map( bundle.write ) );
+
+	console.log( `Build completed: Rollup, version: ${ name }` );
+}
+
+export async function runRollupPureEsm() {
+	await runRollup( "pure ESM", pureEsmConfigPath );
+}
+
+export async function runRollupEsmAndCommonJs() {
+	await runRollup( "ESM + CommonJS", commonJSConfigPath );
+}
diff --git a/test/bundler_smoke_tests/lib/run-webpack.js b/test/bundler_smoke_tests/lib/run-webpack.js
@@ -0,0 +1,26 @@
+import webpack from "webpack";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const dirname = path.dirname( fileURLToPath( import.meta.url ) );
+const configPath = path.resolve( dirname, "..", "webpack.config.cjs" );
+
+// See https://webpack.js.org/api/node/#webpack
+export async function runWebpack() {
+	return new Promise( async( resolve, reject ) => {
+		console.log( "Running Webpack" );
+
+		const { default: config } = await import( configPath );
+
+		webpack( config, ( err, stats ) => {
+			if ( err || stats.hasErrors() ) {
+				console.error( "Errors detected during Webpack compilation" );
+				reject( err );
+				return;
+			}
+
+			console.log( "Build completed: Webpack" );
+			resolve();
+		} );
+	} );
+}
diff --git a/test/bundler_smoke_tests/lib/utils.js b/test/bundler_smoke_tests/lib/utils.js
@@ -0,0 +1,13 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const dirname = path.dirname( fileURLToPath( import.meta.url ) );
+const TMP_BUNDLERS_DIR = path.resolve( dirname, "..", "tmp" );
+
+export async function cleanTmpBundlersDir() {
+	await fs.rm( TMP_BUNDLERS_DIR, {
+		force: true,
+		recursive: true
+	} );
+}
diff --git a/test/bundler_smoke_tests/run-jsdom-tests.js b/test/bundler_smoke_tests/run-jsdom-tests.js
@@ -1,12 +1,17 @@
+#!/usr/bin/env node
+
 import fs from "node:fs/promises";
 import jsdom, { JSDOM } from "jsdom";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
+import { runRollupEsmAndCommonJs, runRollupPureEsm } from "./lib/run-rollup.js";
+import { runWebpack } from "./lib/run-webpack.js";
+import { cleanTmpBundlersDir } from "./lib/utils.js";
 
 const dirname = path.dirname( fileURLToPath( import.meta.url ) );
 
 async function runJSDOMTest( { title, folder } ) {
-	console.log( "\nRunning bundlers tests:", title );
+	console.log( "Running bundlers tests:", title );
 
 	const template = await fs.readFile( `${ dirname }/test.html`, "utf-8" );
 	const scriptSource = await fs.readFile(
@@ -37,17 +42,34 @@ async function runJSDOMTest( { title, folder } ) {
 	}
 }
 
-await runJSDOMTest( {
-	title: "Rollup with pure ESM setup",
-	folder: "rollup-pure-esm"
-} );
+async function buildAndTest() {
+	await cleanTmpBundlersDir();
+
+	await Promise.all( [
+		runRollupPureEsm(),
+		runRollupEsmAndCommonJs(),
+		runWebpack()
+	] );
+
+	await Promise.all( [
+		runJSDOMTest( {
+			title: "Rollup with pure ESM setup",
+			folder: "rollup-pure-esm"
+		} ),
 
-await runJSDOMTest( {
-	title: "Rollup with ESM + CommonJS",
-	folder: "rollup-commonjs"
-} );
+		runJSDOMTest( {
+			title: "Rollup with ESM + CommonJS",
+			folder: "rollup-commonjs"
+		} ),
+
+		runJSDOMTest( {
+			title: "Webpack",
+			folder: "webpack"
+		} )
+	] );
+
+	// The directory won't be cleaned in case of failures; this may aid debugging.
+	await cleanTmpBundlersDir();
+}
 
-await runJSDOMTest( {
-	title: "Webpack",
-	folder: "webpack"
-} );
+await buildAndTest();
diff --git a/test/bundler_smoke_tests/utils.cjs b/test/bundler_smoke_tests/utils.cjs
diff --git a/test/bundler_smoke_tests/webpack.config.cjs b/test/bundler_smoke_tests/webpack.config.cjs
@@ -1,7 +1,5 @@
 "use strict";
 
-const path = require( "path" );
-
 module.exports = {
 	entry: `${ __dirname }/src-esm-commonjs/main.js`,
 	output: {

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ export default [`
`10`	`10`	`// See https://github.com/eslint/eslint/discussions/17412`
`11`	`11`	`ignores: [`
`12`	`12`	`"external",`
`13`		`- "test/bundler_smoke_tests/tmp",`
	`13`	`+ "**/tmp",`
`14`	`14`	`"test/data/json_obj.js"`
`15`	`15`	`]`
`16`	`16`	`},`