feat: add support for multiple test URLs (for jquery-ui)

Author: timmywil

bin/command.js

@@ -51,6 +51,12 @@ yargs( process.argv.slice( 2 ) )
 					"Expected to always start and end with a slash (/). " +
 					"Defaults to \"/test/\"."
 			} )
+			.option( "test-url", {
+				alias: "t",
+				type: "array",
+				description: "URLs to load the tests from. " +
+					"Can be multiple, but defaults to the base URL."
+			} )
 			.option( "flag", {
 				alias: "f",
 				type: "array",
@@ -152,7 +158,14 @@ yargs( process.argv.slice( 2 ) )
 			];
 			const middleware = await parseMiddleware( config, argv );
 
-			return run( { ...config, ...argv, flag, isolatedFlag, middleware } );
+			return run( {
+				...config,
+				testUrl: config.testUrls,
+				...argv,
+				flag,
+				isolatedFlag,
+				middleware
+			} );
 		}
 	} )
 	.command( {

createTestServer.js

@@ -3,30 +3,13 @@ import { readFile, stat } from "node:fs/promises";
 import { createReadStream } from "node:fs";
 import getRawBody from "raw-body";
 
-
-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
+	quiet,
+	testUrls = []
 } = {} ) {
-	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 = [];
@@ -94,20 +77,24 @@ export async function createTestServer( {
 
 	// Redirect to trailing slash
 	use( ( req, res, next ) => {
-		if ( req.parsedUrl.pathname === urlWithoutSlash ) {
+		if ( req.parsedUrl.pathname === baseUrl.replace( /\/$/, "" ) ) {
 			res.redirect( 308, `${ req.parsedUrl.pathname }/${ req.parsedUrl.search }` );
 		} else {
 			next();
 		}
 	} );
 
 	// Add a script tag to the index.html to load the QUnit listeners
-	use( ( req, res, next ) => {
+	use( async( req, res, next ) => {
+		const pathname = req.parsedUrl.pathname;
 		if (
 			( req.method === "GET" || req.method === "HEAD" ) &&
-			( req.parsedUrl.pathname === baseUrl ||
-				req.parsedUrl.pathname === indexUrl )
+			( pathname === baseUrl || testUrls.includes( pathname.replace( baseUrl, "" ) ) )
 		) {
+			const indexHTML = await readFile(
+				`.${ pathname }${ pathname.endsWith( ".html" ) ? "" : "index.html" }`,
+				"utf8"
+			);
 			res.writeHead( 200, { "Content-Type": "text/html" } );
 			res.end(
 				indexHTML.replace(

lib/buildTestUrl.js

@@ -7,7 +7,8 @@ export function buildTestUrl( {
 	isolatedFlag,
 	jsdom,
 	port,
-	reportId
+	reportId,
+	testUrl = ""
 } ) {
 	if ( !port ) {
 		throw new Error( "No port specified." );
@@ -37,5 +38,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 }${ baseUrl }?${ query }`;
+	return `http://${ host }:${ port }${ baseUrl }${ testUrl }?${ query }`;
 }

listeners.js

@@ -1,5 +1,4 @@
 ( function() {
-
 	"use strict";
 
 	// Get the report ID from the URL.
@@ -82,29 +81,39 @@
 		return request;
 	}
 
-	// Send acknowledgement to the server.
-	send( "ack" );
-
-	QUnit.on( "testEnd", function( data ) {
-		send( "testEnd", data );
-	} );
+	function listen( QUnit ) {
 
-	QUnit.on( "runEnd", function( data ) {
+		// Send acknowledgement to the server.
+		send( "ack" );
 
-		// Reduce the payload size.
-		// childSuites is large and unused.
-		data.childSuites = undefined;
+		QUnit.on( "testEnd", function( data ) {
+			send( "testEnd", data );
+		} );
 
-		var request = send( "runEnd", data );
-		request.onload = function() {
-			if ( request.status === 200 && request.responseText ) {
-				try {
-					var json = JSON.parse( request.responseText );
-					window.location = json.url;
-				} catch ( e ) {
-					console.error( e );
+		QUnit.on( "runEnd", function( data ) {
+
+			// Reduce the payload size.
+			// childSuites is large and unused.
+			data.childSuites = undefined;
+
+			var request = send( "runEnd", data );
+			request.onload = function() {
+				if ( request.status === 200 && request.responseText ) {
+					try {
+						var json = JSON.parse( request.responseText );
+						window.location = json.url;
+					} catch ( e ) {
+						console.error( e );
+					}
 				}
-			}
-		};
-	} );
+			};
+		} );
+	}
+
+	// jquery-ui loads QUnit asynchronously
+	if ( typeof QUnit === "undefined" && typeof require !== "undefined" ) {
+		require( [ "qunit" ], listen );
+	} else {
+		listen( QUnit );
+	}
 } )();

run.js

@@ -33,6 +33,7 @@ export async function run( {
 	middleware = [],
 	retries = 0,
 	runId,
+	testUrl: testUrls = [],
 	verbose
 } ) {
 	if ( !browserNames.length ) {
@@ -76,6 +77,7 @@ export async function run( {
 		baseUrl,
 		middleware,
 		quiet: !verbose,
+		testUrls,
 		report: async( message ) => {
 			switch ( message.type ) {
 				case "testEnd": {
@@ -107,10 +109,7 @@ export async function run( {
 					const reportId = message.id;
 					const report = reports[ reportId ];
 					touchBrowser( report.browser );
-					const { failed, total } = reportEnd(
-						message.data,
-						reports[ reportId ]
-					);
+					const { failed, total } = reportEnd( message.data, reports[ reportId ] );
 					report.total = total;
 
 					// Handle failure
@@ -243,10 +242,19 @@ export async function run( {
 		}
 	}
 
-	function queueRun( browser, isolatedFlag ) {
+	function queueRun( browser, { isolatedFlag, testUrl } = {} ) {
 		const fullBrowser = getBrowserString( browser, headless );
-		const reportId = generateHash( `${ hashValue }-${ isolatedFlag }-${ fullBrowser }` );
-		reports[ reportId ] = { browser, flags, headless, id: reportId, isolatedFlag };
+		const reportId = generateHash(
+			`${ hashValue }-${ isolatedFlag }-${ testUrl }-${ fullBrowser }`
+		);
+		reports[ reportId ] = {
+			browser,
+			flags,
+			headless,
+			id: reportId,
+			isolatedFlag,
+			testUrl
+		};
 
 		const url = buildTestUrl( {
 			baseUrl,
@@ -255,7 +263,8 @@ export async function run( {
 			isolatedFlag,
 			jsdom: browser.browser === "jsdom",
 			port,
-			reportId
+			reportId,
+			testUrl
 		} );
 
 		const options = {
@@ -268,6 +277,7 @@ export async function run( {
 			isolatedFlag,
 			reportId,
 			runId,
+			testUrl,
 			tunnelId,
 			verbose
 		};
@@ -278,7 +288,17 @@ export async function run( {
 	for ( const browser of browsers ) {
 		if ( isolatedFlags.length > 0 ) {
 			isolatedFlags.forEach( ( isolatedFlag ) => {
-				queueRun( browser, isolatedFlag );
+				if ( testUrls.length > 0 ) {
+					testUrls.forEach( ( testUrl ) => {
+						queueRun( browser, { isolatedFlag, testUrl } );
+					} );
+				} else {
+					queueRun( browser, { isolatedFlag } );
+				}
+			} );
+		} else if ( testUrls.length > 0 ) {
+			testUrls.forEach( ( testUrl ) => {
+				queueRun( browser, { testUrl } );
 			} );
 		} else {
 			queueRun( browser );
@@ -306,11 +326,9 @@ export async function run( {
 					];
 					console.error(
 						chalk.red(
-							`No tests were run for page with flags "${
-								reportFlags.join( "&" )
-							}" in ${
-								getBrowserString( report.browser )
-							} (${ report.id })`
+							`No tests were run for page with flags "${ reportFlags.join(
+								"&"
+							) }" in ${ getBrowserString( report.browser ) } (${ report.id })`
 						)
 					);
 				}