feat: add baseUrl option

Author: timmywil

bin/command.js

@@ -10,6 +10,7 @@ import { run } from "../run.js";
 import readYAML from "../lib/readYAML.js";
 import { createTestServer } from "../createTestServer.js";
 
+const DEFAULT_PORT = 3000;
 const pkg = JSON.parse( await readFile( new URL( "../package.json", import.meta.url ) ) );
 
 function parseFlags( flags ) {
@@ -43,6 +44,13 @@ yargs( process.argv.slice( 2 ) )
 				description: "Path to a YAML configuration file. " +
 					"Use this to avoid passing options via the command line."
 			} )
+			.option( "base-url", {
+				alias: "u",
+				type: "string",
+				description: "Base URL for the test server. " +
+					"Expected to always start and end with a slash (/). " +
+					"Defaults to \"/test/\"."
+			} )
 			.option( "flag", {
 				alias: "f",
 				type: "array",
@@ -60,10 +68,10 @@ yargs( process.argv.slice( 2 ) )
 				type: "array",
 				choices: browsers,
 				description:
-					"Run tests in a specific browser." +
-					"Pass multiple browsers by repeating the option." +
-					"If using BrowserStack, specify browsers using --browserstack.",
-				default: [ "chrome" ]
+					"Run tests in a specific browser. " +
+					"Pass multiple browsers by repeating the option. " +
+					"If using BrowserStack, specify browsers using --browserstack. " +
+					"Defaults to Chrome."
 			} )
 			.option( "middleware", {
 				alias: "mw",
@@ -108,7 +116,7 @@ yargs( process.argv.slice( 2 ) )
 			.option( "verbose", {
 				alias: "v",
 				type: "boolean",
-				description: "Log additional information."
+				description: "Log additional information, including all test server requests."
 			} )
 			.option( "browserstack", {
 				type: "array",
@@ -143,6 +151,7 @@ yargs( process.argv.slice( 2 ) )
 				...( argv.isolatedFlag ?? [] )
 			];
 			const middleware = await parseMiddleware( config, argv );
+
 			return run( { ...config, ...argv, flag, isolatedFlag, middleware } );
 		}
 	} )
@@ -156,17 +165,22 @@ yargs( process.argv.slice( 2 ) )
 				description: "Path to a YAML configuration file. " +
 					"Use this to avoid passing options via the command line."
 			} )
+			.option( "base-url", {
+				alias: "u",
+				type: "string",
+				description: "Base URL for the test server. " +
+					"Expected to always start and end with a slash (/). " +
+					"Defaults to \"/test/\"."
+			} )
 			.option( "port", {
 				alias: "p",
 				type: "number",
-				description: "Port to listen on.",
-				default: 3000
+				description: "Port to listen on. Defaults to 3000."
 			} )
 			.option( "quiet", {
 				alias: "q",
 				type: "boolean",
-				description: "Whether to log requests to the console.",
-				default: true
+				description: "Whether to log requests to the console. Default: false."
 			} )
 			.option( "middleware", {
 				alias: "mw",
@@ -176,7 +190,7 @@ yargs( process.argv.slice( 2 ) )
 					"Pass multiple by repeating the option."
 			} );
 		},
-		handler: async( { configFile, quiet, ...argv } ) => {
+		handler: async( { baseUrl, configFile, quiet, ...argv } ) => {
 			console.log( "Starting server..." );
 			const config = await readYAML( configFile );
 			const middleware = await parseMiddleware( config, argv );
@@ -186,10 +200,11 @@ yargs( process.argv.slice( 2 ) )
 			 * Note: this server does not support middleware.
 			 * To add middleware, use createTestServer directly.
 			 */
-			const app = await createTestServer( { middleware, quiet } );
+			const app = await createTestServer( { baseUrl, middleware, quiet } );
 
-			return app.listen( { ...config, ...argv, host: "0.0.0.0" }, function() {
-				console.log( `Open tests at http://localhost:${ argv.port }/` );
+			const port = argv.port ?? config.port ?? DEFAULT_PORT;
+			return app.listen( { port, host: "0.0.0.0" }, function() {
+				console.log( `Open tests at http://localhost:${ port }/` );
 			} );
 		}
 	} )

createTestServer.js

@@ -3,8 +3,30 @@ import { readFile, stat } from "node:fs/promises";
 import { createReadStream } from "node:fs";
 import getRawBody from "raw-body";
 
-export async function createTestServer( { report, middleware: userMiddleware = [], quiet } = {} ) {
-	const indexHTML = await readFile( "./test/index.html", "utf8" );
+
+function urlWithIndex( baseUrl ) {
+	let url = baseUrl;
+	if ( !url.startsWith( "/" ) ) {
+		url = `/${ url }`;
+	}
+	if ( !url.endsWith( "/index.html" ) ) {
+		url = `${ url }/index.html`;
+	}
+	return url;
+}
+
+export async function createTestServer( {
+	baseUrl, // Expected to always end in /
+	report,
+	middleware: userMiddleware = [],
+	quiet
+} = {} ) {
+	const urlWithoutSlash = baseUrl.slice( 0, -1 );
+	const indexUrl = urlWithIndex( urlWithoutSlash );
+
+	// Get the index HTML ahead-of-time,
+	// to which we will add the QUnit listener script.
+	const indexHTML = await readFile( `.${ indexUrl }`, "utf8" );
 
 	// Support connect-style middleware
 	const middlewares = [];
@@ -60,17 +82,19 @@ export async function createTestServer( { report, middleware: userMiddleware = [
 	}
 
 	// Redirect home to test page
-	use( ( req, res, next ) => {
-		if ( req.parsedUrl.pathname === "/" ) {
-			res.redirect( "/test/" );
-		} else {
-			next();
-		}
-	} );
+	if ( baseUrl !== "/" ) {
+		use( ( req, res, next ) => {
+			if ( req.parsedUrl.pathname === "/" ) {
+				res.redirect( baseUrl );
+			} else {
+				next();
+			}
+		} );
+	}
 
 	// Redirect to trailing slash
 	use( ( req, res, next ) => {
-		if ( req.parsedUrl.pathname === "/test" ) {
+		if ( req.parsedUrl.pathname === urlWithoutSlash ) {
 			res.redirect( 308, `${ req.parsedUrl.pathname }/${ req.parsedUrl.search }` );
 		} else {
 			next();
@@ -81,8 +105,8 @@ export async function createTestServer( { report, middleware: userMiddleware = [
 	use( ( req, res, next ) => {
 		if (
 			( req.method === "GET" || req.method === "HEAD" ) &&
-			( req.parsedUrl.pathname === "/test/" ||
-				req.parsedUrl.pathname === "/test/index.html" )
+			( req.parsedUrl.pathname === baseUrl ||
+				req.parsedUrl.pathname === indexUrl )
 		) {
 			res.writeHead( 200, { "Content-Type": "text/html" } );
 			res.end(

lib/buildTestUrl.js

@@ -1,6 +1,7 @@
 import { generateModuleId } from "./generateHash.js";
 
 export function buildTestUrl( {
+	baseUrl,
 	browserstack,
 	flags,
 	isolatedFlag,
@@ -36,5 +37,5 @@ export function buildTestUrl( {
 	// BrowserStack supplies a custom domain for local testing,
 	// which is especially necessary for iOS testing.
 	const host = browserstack ? "bs-local.com" : "localhost";
-	return `http://${ host }:${ port }/test/?${ query }`;
+	return `http://${ host }:${ port }${ baseUrl }?${ query }`;
 }

run.js

@@ -18,8 +18,10 @@ import {
 } from "./queue.js";
 
 const EXIT_HOOK_WAIT_TIMEOUT = 60 * 1000;
+const rendsWithSlash = /\/$/;
 
 export async function run( {
+	baseUrl = "/test/",
 	browser: browserNames = [],
 	browserstack,
 	concurrency,
@@ -33,7 +35,14 @@ export async function run( {
 	runId,
 	verbose
 } ) {
-	console.log( isolatedFlags );
+	if ( !baseUrl ) {
+		throw new Error( "No baseUrl specified." );
+	}
+
+	// Ensure baseUrl ends with a slash
+	if ( !rendsWithSlash.test( baseUrl ) ) {
+		baseUrl += "/";
+	}
 	if ( !browserNames.length ) {
 		browserNames = [ "chrome" ];
 	}
@@ -67,10 +76,9 @@ export async function run( {
 	// hook it up to the reporter
 	const reports = Object.create( null );
 	const app = await createTestServer( {
+		baseUrl,
 		middleware,
-
-		// Hide test server request logs in CLI output
-		quiet: true,
+		quiet: !verbose,
 		report: async( message ) => {
 			switch ( message.type ) {
 				case "testEnd": {
@@ -244,6 +252,7 @@ export async function run( {
 		reports[ reportId ] = { browser, flags, headless, id: reportId, isolatedFlag };
 
 		const url = buildTestUrl( {
+			baseUrl,
 			browserstack,
 			flags,
 			isolatedFlag,
@@ -253,6 +262,7 @@ export async function run( {
 		} );
 
 		const options = {
+			baseUrl,
 			browserstack,
 			concurrency,
 			debug,
@@ -293,14 +303,14 @@ export async function run( {
 			for ( const report of Object.values( reports ) ) {
 				if ( !report.total ) {
 					stop = true;
-					const allFlags = [
+					const reportFlags = [
 						...report.flags,
 						...( report.isolatedFlag ? [ report.isolatedFlag ] : [] )
 					];
 					console.error(
 						chalk.red(
 							`No tests were run for page with flags "${
-								allFlags.join( "&" )
+								reportFlags.join( "&" )
 							}" in ${
 								getBrowserString( report.browser )
 							} (${ report.id })`