aboutsummaryrefslogtreecommitdiffstats
path: root/tests/runner/run.js
diff options
context:
space:
mode:
Diffstat (limited to 'tests/runner/run.js')
-rw-r--r--tests/runner/run.js338
1 files changed, 0 insertions, 338 deletions
diff --git a/tests/runner/run.js b/tests/runner/run.js
deleted file mode 100644
index 9c4f8d479..000000000
--- a/tests/runner/run.js
+++ /dev/null
@@ -1,338 +0,0 @@
-import chalk from "chalk";
-import { asyncExitHook, gracefulExit } from "exit-hook";
-import { getLatestBrowser } from "./browserstack/api.js";
-import { buildBrowserFromString } from "./browserstack/buildBrowserFromString.js";
-import { localTunnel } from "./browserstack/local.js";
-import { reportEnd, reportTest } from "./reporter.js";
-import { createTestServer } from "./createTestServer.js";
-import { buildTestUrl } from "./lib/buildTestUrl.js";
-import { generateHash } from "./lib/generateHash.js";
-import { getBrowserString } from "./lib/getBrowserString.js";
-import { suites as allSuites } from "./flags/suites.js";
-import { cleanupAllBrowsers, touchBrowser } from "./browsers.js";
-import {
- addRun,
- getNextBrowserTest,
- hardRetryTest,
- retryTest,
- runAll
-} from "./queue.js";
-
-const EXIT_HOOK_WAIT_TIMEOUT = 60 * 1000;
-
-/**
- * Run test suites in parallel in different browser instances.
- */
-export async function run( {
- browser: browserNames = [],
- browserstack,
- concurrency,
- debug,
- hardRetries,
- headless,
- jquery: jquerys = [],
- migrate,
- retries = 0,
- runId,
- suite: suites = [],
- verbose
-} ) {
- if ( !browserNames.length ) {
- browserNames = [ "chrome" ];
- }
- if ( !suites.length ) {
- suites = allSuites;
- }
- if ( !jquerys.length ) {
- jquerys = [ "3.7.1" ];
- }
- if ( headless && debug ) {
- throw new Error(
- "Cannot run in headless mode and debug mode at the same time."
- );
- }
-
- if ( verbose ) {
- console.log( browserstack ? "Running in BrowserStack." : "Running locally." );
- }
-
- const errorMessages = [];
- const pendingErrors = {};
-
- // Convert browser names to browser objects
- let browsers = browserNames.map( ( b ) => ( { browser: b } ) );
- const tunnelId = generateHash(
- `${ Date.now() }-${ suites.join( ":" ) }-${ ( browserstack || [] )
- .concat( browserNames )
- .join( ":" ) }`
- );
-
- // A unique identifier for this run
- if ( !runId ) {
- runId = tunnelId;
- }
-
- // Create the test app and
- // hook it up to the reporter
- const reports = Object.create( null );
- const app = await createTestServer( async( message ) => {
- switch ( message.type ) {
- case "testEnd": {
- const reportId = message.id;
- const report = reports[ reportId ];
- touchBrowser( report.browser );
- const errors = reportTest( message.data, reportId, report );
- pendingErrors[ reportId ] ??= Object.create( null );
- if ( errors ) {
- pendingErrors[ reportId ][ message.data.name ] = errors;
- } else {
- const existing = pendingErrors[ reportId ][ message.data.name ];
-
- // Show a message for flakey tests
- if ( existing ) {
- console.log();
- console.warn(
- chalk.italic(
- chalk.gray( existing.replace( "Test failed", "Test flakey" ) )
- )
- );
- console.log();
- delete pendingErrors[ reportId ][ message.data.name ];
- }
- }
- break;
- }
- case "runEnd": {
- const reportId = message.id;
- const report = reports[ reportId ];
- touchBrowser( report.browser );
- const { failed, total } = reportEnd(
- message.data,
- message.id,
- reports[ reportId ]
- );
- report.total = total;
-
- // Handle failure
- if ( failed ) {
- const retry = retryTest( reportId, retries );
-
- // Retry if retryTest returns a test
- if ( retry ) {
- return retry;
- }
-
- // Return early if hardRetryTest returns true
- if ( await hardRetryTest( reportId, hardRetries ) ) {
- return;
- }
- errorMessages.push( ...Object.values( pendingErrors[ reportId ] ) );
- }
-
- // Run the next test
- return getNextBrowserTest( reportId );
- }
- case "ack": {
- const report = reports[ message.id ];
- touchBrowser( report.browser );
- break;
- }
- default:
- console.warn( "Received unknown message type:", message.type );
- }
- } );
-
- // Start up local test server
- let server;
- let port;
- await new Promise( ( resolve ) => {
-
- // Pass 0 to choose a random, unused port
- server = app.listen( 0, () => {
- port = server.address().port;
- resolve();
- } );
- } );
-
- if ( !server || !port ) {
- throw new Error( "Server not started." );
- }
-
- if ( verbose ) {
- console.log( `Server started on port ${ port }.` );
- }
-
- function stopServer() {
- return new Promise( ( resolve ) => {
- server.close( () => {
- if ( verbose ) {
- console.log( "Server stopped." );
- }
- resolve();
- } );
- } );
- }
-
- async function cleanup() {
- console.log( "Cleaning up..." );
-
- await cleanupAllBrowsers( { verbose } );
-
- if ( tunnel ) {
- await tunnel.stop();
- if ( verbose ) {
- console.log( "Stopped BrowserStackLocal." );
- }
- }
- }
-
- asyncExitHook(
- async() => {
- await cleanup();
- await stopServer();
- },
- { wait: EXIT_HOOK_WAIT_TIMEOUT }
- );
-
- // Start up BrowserStackLocal
- let tunnel;
- if ( browserstack ) {
- if ( headless ) {
- console.warn(
- chalk.italic(
- "BrowserStack does not support headless mode. Running in normal mode."
- )
- );
- headless = false;
- }
-
- // Convert browserstack to browser objects.
- // If browserstack is an empty array, fall back
- // to the browsers array.
- if ( browserstack.length ) {
- browsers = browserstack.map( ( b ) => {
- if ( !b ) {
- return browsers[ 0 ];
- }
- return buildBrowserFromString( b );
- } );
- }
-
- // Fill out browser defaults
- browsers = await Promise.all(
- browsers.map( async( browser ) => {
-
- // Avoid undici connect timeout errors
- await new Promise( ( resolve ) => setTimeout( resolve, 100 ) );
-
- const latestMatch = await getLatestBrowser( browser );
- if ( !latestMatch ) {
- console.error(
- chalk.red( `Browser not found: ${ getBrowserString( browser ) }.` )
- );
- gracefulExit( 1 );
- }
- return latestMatch;
- } )
- );
-
- tunnel = await localTunnel( tunnelId );
- if ( verbose ) {
- console.log( "Started BrowserStackLocal." );
- }
- }
-
- function queueRuns( suite, browser ) {
- const fullBrowser = getBrowserString( browser, headless );
-
- for ( const jquery of jquerys ) {
- const reportId = generateHash( `${ suite } ${ jquery } ${ fullBrowser }` );
- reports[ reportId ] = { browser, headless, jquery, migrate, suite };
-
- const url = buildTestUrl( suite, {
- browserstack,
- jquery,
- migrate,
- port,
- reportId
- } );
-
- const options = {
- browserstack,
- concurrency,
- debug,
- headless,
- jquery,
- migrate,
- reportId,
- runId,
- suite,
- tunnelId,
- verbose
- };
-
- addRun( url, browser, options );
- }
- }
-
- for ( const browser of browsers ) {
- for ( const suite of suites ) {
- queueRuns( [ suite ], browser );
- }
- }
-
- try {
- console.log( `Starting Run ${ runId }...` );
- await runAll();
- } catch ( error ) {
- console.error( error );
- if ( !debug ) {
- gracefulExit( 1 );
- }
- } finally {
- console.log();
- if ( errorMessages.length === 0 ) {
- let stop = false;
- for ( const report of Object.values( reports ) ) {
- if ( !report.total ) {
- stop = true;
- console.error(
- chalk.red(
- `No tests were run for ${ report.suite } in ${ getBrowserString(
- report.browser
- ) }`
- )
- );
- }
- }
- if ( stop ) {
- return gracefulExit( 1 );
- }
- console.log( chalk.green( "All tests passed!" ) );
-
- if ( !debug || browserstack ) {
- gracefulExit( 0 );
- }
- } else {
- console.error( chalk.red( `${ errorMessages.length } tests failed.` ) );
- console.log(
- errorMessages.map( ( error, i ) => `\n${ i + 1 }. ${ error }` ).join( "\n" )
- );
-
- if ( debug ) {
- console.log();
- if ( browserstack ) {
- console.log( "Leaving browsers with failures open for debugging." );
- console.log(
- "View running sessions at https://automate.browserstack.com/dashboard/v2/"
- );
- } else {
- console.log( "Leaving browsers open for debugging." );
- }
- console.log( "Press Ctrl+C to exit." );
- } else {
- gracefulExit( 1 );
- }
- }
- }
-}
generated by cgit v1.2.3 (git 2.39.1) at 2025-05-06 16:00:25 +0000