diff options
author | Timmy Willison <timmywil@users.noreply.github.com> | 2024-02-26 09:42:10 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-02-26 09:42:10 -0500 |
commit | dfc693ea25fe85e5f29da23752b0c7c8d285fbf0 (patch) | |
tree | 4ff805bcfa3eb07c77db318bca85aadcf0113589 /test/data/testinit.js | |
parent | bf11739f6c6926bc9bc1b5a1460505d3b7ef8b01 (diff) | |
download | jquery-dfc693ea25fe85e5f29da23752b0c7c8d285fbf0.tar.gz jquery-dfc693ea25fe85e5f29da23752b0c7c8d285fbf0.zip |
Tests: migrate testing infrastructure to minimal dependencies
This is a complete rework of our testing infrastructure. The main goal is to modernize and drop deprecated or undermaintained dependencies (specifically, grunt, karma, and testswarm). We've achieved that by limiting our dependency list to ones that are unlikely to drop support any time soon. The new dependency list includes:
- `qunit` (our trusty unit testing library)
- `selenium-webdriver` (for spinning up local browsers)
- `express` (for starting a test server and adding middleware)
- express middleware includes uses of `body-parser` and `raw-body`
- `yargs` (for constructing a CLI with pretty help text)
- BrowserStack (for running each of our QUnit modules separately in all of our supported browsers)
- `browserstack-local` (for opening a local tunnel. This is the same package still currently used in the new Browserstack SDK)
- We are not using any other BrowserStack library. The newest BrowserStack SDK does not fit our needs (and isn't open source). Existing libraries, such as `node-browserstack` or `browserstack-runner`, either do not quite fit our needs, are under-maintained and out-of-date, or are not robust enough to meet all of our requirements. We instead call the [BrowserStack REST API](https://github.com/browserstack/api) directly.
## BrowserStack Runner
- automatically retries individual modules in case of test failure(s)
- automatically attempts to re-establish broken tunnels
- automatically refreshes the page in case a test run has stalled
- runs all browsers concurrently and uses as many sessions as are available under the BrowserStack plan. It will wait for available sessions if there are none.
- supports filtering the available list of browsers by browser name, browser version, device, OS, and OS version (see `npm run test:unit -- --list-browsers` for more info). It will retrieve the latest matching browser available if any of those parameters are not specified.
- cleans up after itself (closes the local tunnel, stops the test server, etc.)
- Requires `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` environment variables.
## Selenium Runner
- supports running any local browser as long as the driver is installed, including support for headless mode in Chrome, FF, and Edge
- supports running `basic` tests on the latest [jsdom](https://github.com/jsdom/jsdom#readme), which can be seen in action in this PR (see `test:browserless`)
- Node tests will run as before in PRs and all non-dependabot branches, but now includes tests on real Safari in a GH actions macos image instead of playwright-webkit.
- can run multiple browsers and multiple modules concurrently
Other notes:
- Stale dependencies have been removed and all remaining dependencies have been upgraded with a few exceptions:
- `sinon`: stopped supporting IE in version 10. But, `sinon` has been updated to 9.x.
- `husky`: latest does not support Node 10 and runs on `npm install`. Needed for now until git builds are migrated to GitHub Actions.
- `rollup`: latest does not support Node 10. Needed for now until git builds are migrated to GitHub Actions.
- BrowserStack tests are set to run on each `main` branch commit
- `debug` mode leaves Selenium browsers open whether they pass or fail and leaves browsers with test failures open on BrowserStack. The latter is to avoid leaving open too many sessions.
- This PR includes a workflow to dispatch BrowserStack runs on-demand
- The Node version used for most workflow tests has been upgraded to 20.x
- updated supportjQuery to 3.7.1
Run `npm run test:unit -- --help` for CLI documentation
Close gh-5418
Diffstat (limited to 'test/data/testinit.js')
-rw-r--r-- | test/data/testinit.js | 52 |
1 files changed, 18 insertions, 34 deletions
diff --git a/test/data/testinit.js b/test/data/testinit.js index 23cea8a40..a04bc49c7 100644 --- a/test/data/testinit.js +++ b/test/data/testinit.js @@ -1,21 +1,15 @@ /* eslint no-multi-str: "off" */ "use strict"; -var FILEPATH = "/test/data/testinit.js", - activeScript = [].slice.call( document.getElementsByTagName( "script" ), -1 )[ 0 ], - parentUrl = activeScript && activeScript.src ? - activeScript.src.replace( /[?#].*/, "" ) + FILEPATH.replace( /[^/]+/g, ".." ) + "/" : - "../", +var parentUrl = window.location.protocol + "//" + window.location.host, // baseURL is intentionally set to "data/" instead of "". // This is not just for convenience (since most files are in data/) // but also to ensure that urls without prefix fail. - // Otherwise it's easy to write tests that pass on test/index.html - // but fail in Karma runner (where the baseURL is different). - baseURL = parentUrl + "test/data/", + baseURL = parentUrl + "/test/data/", supportjQuery = this.jQuery, - // NOTE: keep it in sync with build/tasks/lib/slim-build-flags.js + // NOTE: keep it in sync with build/tasks/lib/slim-exclude.js excludedFromSlim = [ "ajax", "callbacks", @@ -293,14 +287,9 @@ this.testIframe = function( title, fileName, func, wrapper, iframeStyles ) { }; this.iframeCallback = undefined; -// Tests are always loaded async -// except when running tests in Karma (See Gruntfile) -if ( !window.__karma__ ) { - QUnit.config.autostart = false; -} +QUnit.config.autostart = false; -// Leverage QUnit URL parsing to detect testSwarm environment and "basic" testing mode -QUnit.isSwarm = ( QUnit.urlParams.swarmURL + "" ).indexOf( "http" ) === 0; +// Leverage QUnit URL parsing to detect "basic" testing mode QUnit.basicTests = ( QUnit.urlParams.module + "" ) === "basic"; // Support: IE 11+ @@ -366,10 +355,17 @@ this.loadTests = function() { // QUnit.config is populated from QUnit.urlParams but only at the beginning // of the test run. We need to read both. var esmodules = QUnit.config.esmodules || QUnit.urlParams.esmodules; + var jsdom = QUnit.config.jsdom || QUnit.urlParams.jsdom; + + if ( jsdom ) { + + // JSDOM doesn't implement scrollTo + QUnit.config.scrolltop = false; + } // Directly load tests that need evaluation before DOMContentLoaded. - if ( !esmodules || document.readyState === "loading" ) { - document.write( "<script src='" + parentUrl + "test/unit/ready.js'><\x2Fscript>" ); + if ( !jsdom && ( !esmodules || document.readyState === "loading" ) ) { + document.write( "<script src='" + parentUrl + "/test/unit/ready.js'><\x2Fscript>" ); } else { QUnit.module( "ready", function() { QUnit.skip( "jQuery ready tests skipped in async mode", function() {} ); @@ -377,7 +373,7 @@ this.loadTests = function() { } // Get testSubproject from testrunner first - require( [ parentUrl + "test/data/testrunner.js" ], function() { + require( [ parentUrl + "/test/data/testrunner.js" ], function() { // Says whether jQuery positional selector extensions are supported. // A full selector engine is required to support them as they need to @@ -427,7 +423,7 @@ this.loadTests = function() { if ( dep ) { if ( !QUnit.basicTests || i === 1 ) { - require( [ parentUrl + "test/" + dep ], loadDep ); + require( [ parentUrl + "/test/" + dep ], loadDep ); // When running basic tests, replace other modules with dummies to avoid overloading // impaired clients. @@ -437,26 +433,14 @@ this.loadTests = function() { } } else { - if ( window.__karma__ && window.__karma__.start ) { - window.__karma__.start(); - } else { - QUnit.load(); - } + QUnit.load(); /** * Run in noConflict mode */ jQuery.noConflict(); - // Load the TestSwarm listener if swarmURL is in the address. - if ( QUnit.isSwarm ) { - require( [ "https://swarm.jquery.org/js/inject.js?" + ( new Date() ).getTime() ], - function() { - QUnit.start(); - } ); - } else { - QUnit.start(); - } + QUnit.start(); } } )(); } ); |