Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Migrate testing infrastructure to minimal dependencies#5418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
timmywil merged 33 commits intojquery:mainfromtimmywil:migrate-test
Feb 26, 2024

Conversation

timmywil
Copy link
Member

@timmywiltimmywil commentedFeb 16, 2024
edited
Loading

Summary

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 ofbody-parser andraw-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 asnode-browserstack orbrowserstack-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 theBrowserStack REST 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 (seenpm 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.)
  • RequiresBROWSERSTACK_USERNAME andBROWSERSTACK_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 runningbasic tests on the latestjsdom, which can be seen in action in this PR (seetest: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 onnpm 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 eachmain 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

Runnpm run test:unit -- --help for CLI documentation or view thecommand.js file directly.

Checklist

mgol reacted with hooray emojimgol reacted with heart emoji
New npm scripts include:- test:unit => run tests using a yargs command.  See `npm run test:unit -- --help`.- test:unit:all => bypass yargs and run all tests in chrome headless  without isolation.- test:server => start up a local test server to run tests manuallyNotes:- add helpers for the browserstack REST api (node-browserstack  is out-of-date and not maintained)- add browserstack-compatible report API with progress updates- allow different browsers to run in parallel- add retries for workers with broken tunnels and refreshes  for acknowledged workers that haven't responded in a while- continually checks maximum allowed browserstack sessions  by default when adding new workers to a test run- bs-local.com used for the testing URLs, which is required  for iOS (and for some reason desktop Safari), but works  in all browsers.- IE11 required an old-fashioned handler for circular references  before JSON.stringify on objects containing elements
- update supportjQuery to 3.7.1- add debug option for browserstack- upgrade QUnit- upgrade sinon to version 9.x, which required  changes to animation tests to account for  0 being falsey in the second argument.- browserstack can take around 3min to spin up safari on iOS 15
- replaced JSDOM grunt task with jsdom browser support  in the task runner- ensured support for Firefox ESR in its own task- added task for running in Safari on macos, separated  to allow other tasks to continue running on ubuntu,  which is significantly faster.- improved job names- always log selenium driver's browser name and version
- improved gzipped size from 5-47 bytes depending on the file
@timmywiltimmywil requested a review frommgolFebruary 16, 2024 03:21
@timmywiltimmywil added this to the4.0.0 milestoneFeb 16, 2024
Copy link
Member

@mgolmgol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I managed to only review the first commit so far but I'm posting it for review so that you don't need to wait for me to finish with the rest.

Copy link
Member

@mgolmgol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

OK, I managed to review the whole thing in the end; the first commit contained the majority of the work. Nice job! 🎉

For now I looked at the code, I haven't played with it locally yet.

@timmywil
Copy link
MemberAuthor

timmywil commentedFeb 24, 2024
edited
Loading

That manipulation test in firefox might be flakey. Nvm, I think it might have to do with my changes toparentUrl.Not sure why it only affects FF using selenium if so yet (does not affect FF on browserstack). browserstack uses the special domainbs-local.com, so it skips this test due to it not being on localhost. I tried a browserstack run with the manip test enabled. It passed the first time, but not the second, so I think it's still flakey. I went back to skipping unless local.

Added backparentUrl. I usedhost andprotocol instead oforigin, just in case.

@timmywil
Copy link
MemberAuthor

timmywil commentedFeb 24, 2024
edited
Loading

Passing BrowserStack run after all the changes:https://github.com/timmywil/jquery/actions/runs/8033218053

I'd like to get this in and iterate more afterwards as needed, unless there's anything else glaring that needs changing. Then I can start on a 3.x PR and add a workflow for updating the git versions. Then, we can finally decommission old Jenkins & Testswarm servers.

@timmywiltimmywil requested a review frommgolFebruary 24, 2024 21:27
Copy link
Member

@mgolmgol left a comment
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

One last comment in#5418 (comment). Otherwise, LGTM. Great work!

@timmywiltimmywil merged commitdfc693e intojquery:mainFeb 26, 2024
@timmywiltimmywil deleted the migrate-test branchFebruary 26, 2024 14:42
timmywil added a commit to timmywil/jquery that referenced this pull requestFeb 29, 2024
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.- 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.- 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 concurrentlyOther 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.1Run `npm run test:unit -- --help` for CLI documentationClosejquerygh-5418
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@mgolmgolmgol approved these changes

Assignees
No one assigned
Labels
Milestone
4.0.0
Development

Successfully merging this pull request may close these issues.

2 participants
@timmywil@mgol

[8]ページ先頭

©2009-2025 Movatter.jp