Skip to content

Commit dfc693e

Browse files
timmywiltimmywil
authored
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
1 parent bf11739 commit dfc693e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+15023
-14848
lines changed

‎.github/workflows/browserstack-dispatch.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Browserstack (Manual Dispatch)
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
module:
7+
description: 'Module to test'
8+
required: true
9+
type: choice
10+
options:
11+
- 'basic'
12+
- 'ajax'
13+
- 'animation'
14+
- 'attributes'
15+
- 'callbacks'
16+
- 'core'
17+
- 'css'
18+
- 'data'
19+
- 'deferred'
20+
- 'deprecated'
21+
- 'dimensions'
22+
- 'effects'
23+
- 'event'
24+
- 'manipulation'
25+
- 'offset'
26+
- 'queue'
27+
- 'selector'
28+
- 'serialize'
29+
- 'support'
30+
- 'traversing'
31+
- 'tween'
32+
browser:
33+
description: 'Browser to test, in form of \"browser_[browserVersion | :device]_os_osVersion\"'
34+
required: false
35+
type: string
36+
default: 'chrome__windows_11'
37+
38+
jobs:
39+
test:
40+
runs-on: ubuntu-latest
41+
environment: browserstack
42+
env:
43+
BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
44+
BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
45+
steps:
46+
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
47+
48+
- uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
49+
with:
50+
node-version: 20
51+
52+
- name: Install dependencies
53+
run: npm ci
54+
55+
- name: Build jQuery
56+
run: npm run build:all
57+
58+
- name: Pretest script
59+
run: npm run pretest
60+
61+
- name: Run tests
62+
run: npm run test:unit -- -v --browserstack ${{ inputs.browser }} -m ${{ inputs.module }}

‎.github/workflows/browserstack.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Browserstack
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
test:
10+
runs-on: ubuntu-latest
11+
environment: browserstack
12+
env:
13+
BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
14+
BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
15+
NODE_VERSION: 20.x
16+
name: ${{ matrix.BROWSER }}
17+
concurrency:
18+
group: ${{ github.workflow }} ${{ matrix.BROWSER }}
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
BROWSER:
23+
- 'IE_11'
24+
- 'Safari_17'
25+
- 'Safari_16'
26+
- 'Chrome_120'
27+
- 'Chrome_119'
28+
- 'Edge_120'
29+
- 'Edge_119'
30+
- 'Firefox_121'
31+
- 'Firefox_120'
32+
- 'Firefox_115'
33+
- '__iOS_17'
34+
- '__iOS_16'
35+
- '__iOS_15'
36+
- 'Opera_106'
37+
steps:
38+
- name: Checkout
39+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
40+
41+
- name: Use Node.js ${{ env.NODE_VERSION }}
42+
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
43+
with:
44+
node-version: ${{ env.NODE_VERSION }}
45+
46+
- name: Cache
47+
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
48+
with:
49+
path: ~/.npm
50+
key: ${{ runner.os }}-node-${{ env.NODE_VERSION }}-npm-lock-${{ hashFiles('**/package-lock.json') }}
51+
restore-keys: |
52+
${{ runner.os }}-node-${{ env.NODE_VERSION }}-npm-lock-
53+
54+
- name: Install dependencies
55+
run: npm install
56+
57+
- name: Build jQuery
58+
run: npm run build:all
59+
60+
- name: Pretest script
61+
run: npm run pretest
62+
63+
- name: Run tests
64+
run: npm run test:unit -- -v --browserstack "${{ matrix.BROWSER }}" --retries 3

‎.github/workflows/node.js.yml

+63-40
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: CI
1+
name: Node
22

33
on:
44
pull_request:
@@ -9,44 +9,49 @@ permissions:
99
contents: read # to fetch code (actions/checkout)
1010

1111
jobs:
12-
build:
12+
build-and-test:
1313
runs-on: ubuntu-latest
14+
name: ${{ matrix.NPM_SCRIPT }} - ${{ matrix.NAME }} (${{ matrix.NODE_VERSION }})
1415
strategy:
1516
fail-fast: false
1617
matrix:
17-
# Node.js 10 is required by jQuery infra
18-
# Do not remove 16.x until jsdom tests are re-enabled on newer Node.js versions.
19-
NODE_VERSION: [10.x, 16.x, 18.x, 20.x]
18+
NAME: ["Node"]
19+
NODE_VERSION: [18.x, 20.x]
2020
NPM_SCRIPT: ["test:browserless"]
2121
include:
22-
- NAME: "Browser tests: full build, Chrome, Firefox & WebKit"
23-
NODE_VERSION: "18.x"
22+
- NAME: "Node"
23+
NODE_VERSION: "20.x"
24+
NPM_SCRIPT: "lint"
25+
- NAME: "Chrome/Firefox"
26+
NODE_VERSION: "20.x"
2427
NPM_SCRIPT: "test:browser"
25-
BROWSERS: "ChromeHeadless,FirefoxHeadless,WebkitHeadless"
26-
- NAME: "Browser tests: slim build, Chrome"
27-
NODE_VERSION: "18.x"
28+
- NAME: "Chrome"
29+
NODE_VERSION: "20.x"
2830
NPM_SCRIPT: "test:slim"
29-
BROWSERS: "ChromeHeadless"
30-
- NAME: "Browser tests: no-deprecated build, Chrome"
31-
NODE_VERSION: "18.x"
31+
- NAME: "Chrome"
32+
NODE_VERSION: "20.x"
3233
NPM_SCRIPT: "test:no-deprecated"
33-
BROWSERS: "ChromeHeadless"
34-
- NAME: "Browser tests: selector-native build, Chrome"
35-
NODE_VERSION: "18.x"
34+
- NAME: "Chrome"
35+
NODE_VERSION: "20.x"
3636
NPM_SCRIPT: "test:selector-native"
37-
BROWSERS: "ChromeHeadless"
38-
- NAME: "Browser tests: ES modules build, Chrome"
39-
NODE_VERSION: "18.x"
40-
NPM_SCRIPT: "test:esmodules"
41-
BROWSERS: "ChromeHeadless"
42-
- NAME: "Browser tests: full build, Firefox ESR"
43-
NODE_VERSION: "18.x"
44-
NPM_SCRIPT: "test:browser"
45-
BROWSERS: "FirefoxHeadless"
37+
- NAME: "Chrome"
38+
NODE_VERSION: "20.x"
39+
NPM_SCRIPT: "test:esm"
40+
- NAME: "Firefox ESR"
41+
NODE_VERSION: "20.x"
42+
NPM_SCRIPT: "test:firefox"
43+
- NAME: "Node 10 Build"
44+
NODE_VERSION: "10.x"
45+
NPM_SCRIPT: "build:main"
4646
steps:
4747
- name: Checkout
4848
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
4949

50+
- name: Use Node.js ${{ matrix.NODE_VERSION }}
51+
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
52+
with:
53+
node-version: ${{ matrix.NODE_VERSION }}
54+
5055
- name: Cache
5156
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
5257
with:
@@ -55,31 +60,49 @@ jobs:
5560
restore-keys: |
5661
${{ runner.os }}-node-${{ matrix.NODE_VERSION }}-npm-lock-
5762
58-
- name: Use Node.js ${{ matrix.NODE_VERSION }}
59-
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
60-
with:
61-
node-version: ${{ matrix.NODE_VERSION }}
62-
6363
- name: Install firefox ESR
6464
run: |
65-
export FIREFOX_SOURCE_URL='https://download.mozilla.org/?product=firefox-esr-latest&lang=en-US&os=linux64'
65+
export FIREFOX_SOURCE_URL='https://download.mozilla.org/?product=firefox-esr-latest-ssl&lang=en-US&os=linux64'
6666
wget --no-verbose $FIREFOX_SOURCE_URL -O - | tar -jx -C ${HOME}
6767
if: contains(matrix.NAME, 'Firefox ESR')
6868

6969
- name: Install dependencies
7070
run: npm install
7171

72-
- name: Install Playwright dependencies
73-
run: npx playwright-webkit install-deps
74-
if: matrix.NPM_SCRIPT == 'test:browser' && contains(matrix.BROWSERS, 'WebkitHeadless')
75-
76-
- name: Lint code
77-
run: npm run build:all && npm run lint
78-
if: matrix.NODE_VERSION == '18.x'
72+
- name: Build All for Linting
73+
run: npm run build:all
74+
if: contains(matrix.NPM_SCRIPT, 'lint')
7975

8076
- name: Run tests
81-
env:
82-
BROWSERS: ${{ matrix.BROWSERS }}
8377
run: |
8478
export PATH=${HOME}/firefox:$PATH
79+
export FIREFOX_BIN=${HOME}/firefox/firefox
8580
npm run ${{ matrix.NPM_SCRIPT }}
81+
82+
safari:
83+
runs-on: macos-latest
84+
env:
85+
NODE_VERSION: 20.x
86+
name: test:safari - Safari
87+
steps:
88+
- name: Checkout
89+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
90+
91+
- name: Use Node.js ${{ env.NODE_VERSION }}
92+
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
93+
with:
94+
node-version: ${{ env.NODE_VERSION }}
95+
96+
- name: Cache
97+
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
98+
with:
99+
path: ~/.npm
100+
key: ${{ runner.os }}-node-${{ env.NODE_VERSION }}-npm-lock-${{ hashFiles('**/package-lock.json') }}
101+
restore-keys: |
102+
${{ runner.os }}-node-${{ env.NODE_VERSION }}-npm-lock-
103+
104+
- name: Install dependencies
105+
run: npm install
106+
107+
- name: Run tests
108+
run: npm run test:safari

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,7 @@ npm-debug.log*
2929

3030
/test/data/core/jquery-iterability-transpiled.js
3131
/test/data/qunit-fixture.js
32+
33+
# Ignore BrowserStack files
34+
local.log
35+
browserstack.err

‎CONTRIBUTING.md

+46-11
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,6 @@ We *love* when people contribute back to the project by patching the bugs they f
7070

7171
Create a fork of the jQuery repo on github at https://github.com/jquery/jquery
7272

73-
Change directory to your web root directory, whatever that might be:
74-
75-
```bash
76-
$ cd /path/to/your/www/root/
77-
```
78-
7973
Clone your jQuery fork to work locally
8074

8175
```bash
@@ -100,29 +94,47 @@ Get in the habit of pulling in the "upstream" main to stay up to date as jQuery
10094
$ git pull upstream main
10195
```
10296

103-
Run the build script
97+
Install the necessary dependencies
10498

10599
```bash
106-
$ npm run build
100+
$ npm install
107101
```
108102

109-
Now open the jQuery test suite in a browser at http://localhost/test. If there is a port, be sure to include it.
103+
Build all jQuery files
110104

111-
Success! You just built and tested jQuery!
105+
```bash
106+
$ npm run build:all
107+
```
108+
109+
Start a test server
112110

111+
```bash
112+
$ npm run test:server
113+
```
114+
115+
Now open the jQuery test suite in a browser at http://localhost:3000/test/.
116+
117+
Success! You just built and tested jQuery!
113118

114119
### Test Suite Tips...
115120

116121
During the process of writing your patch, you will run the test suite MANY times. You can speed up the process by narrowing the running test suite down to the module you are testing by either double clicking the title of the test or appending it to the url. The following examples assume you're working on a local repo, hosted on your localhost server.
117122

118123
Example:
119124

120-
http://localhost/test/?module=css
125+
http://localhost:3000/test/?module=css
121126

122127
This will only run the "css" module tests. This will significantly speed up your development and debugging.
123128

124129
**ALWAYS RUN THE FULL SUITE BEFORE COMMITTING AND PUSHING A PATCH!**
125130

131+
#### Change the test server port
132+
133+
The default port for the test server is 3000. You can change the port by setting the `PORT` environment variable.
134+
135+
```bash
136+
$ PORT=3001 npm run test:server
137+
```
126138

127139
#### Loading changes on the test page
128140

@@ -136,6 +148,29 @@ Alternatively, you can **load tests as ECMAScript modules** to avoid the need fo
136148

137149
Click "Load as modules" after loading the test page.
138150

151+
#### Running the test suite from the command line
152+
153+
You can also run the test suite from the command line.
154+
155+
First, prepare the tests:
156+
157+
```bash
158+
$ npm run pretest
159+
```
160+
161+
Make sure jQuery is built (`npm run build:all`) and run the tests:
162+
163+
```bash
164+
$ npm run test:unit
165+
```
166+
167+
This will run each module in its own browser instance and report the results in the terminal.
168+
169+
View the full help for the test suite for more info on running the tests from the command line:
170+
171+
```bash
172+
$ npm run test:unit -- --help
173+
```
139174

140175
### Repo organization
141176

0 commit comments

Comments
 (0)