Ghost/ghost/core/test/e2e-browser
Steve Larson 02edc5ad4f
Updated browser tests to be less flaky (#19701)
no refs

- Offers browser tests were subject to a race condition. I'm guessing
this dates back to when we moved to Settings X (and React), as it seems
the url for the offer is not present on the first render of the page -
despite being returned in the `POST` request of the offer creation, the
component does a `GET` on render to get the link. This is now awaited.
- The Publishing timezone test also seemed to suffer from a race
condition. This is less sure of a fix as it's a much less frequent
failure. The date time picker input is now validated in the test before
continuing.
- Offers browser tests often timed out so the timeout has been moved to
90s for these tests.
- All tests were bumped to 75s timeout as we generally would
occasionally hit the timeout.
2024-02-21 17:47:44 +00:00
..
admin Updated browser tests to be less flaky (#19701) 2024-02-21 17:47:44 +00:00
fixtures Switched to a shared page for each playwright worker 2023-10-16 15:32:13 +00:00
portal Updated browser tests to be less flaky (#19701) 2024-02-21 17:47:44 +00:00
utils Updated browser tests to be less flaky (#19701) 2024-02-21 17:47:44 +00:00
README.md Added browser-based testing framework 2022-11-22 14:12:34 +00:00

Browser testing

Install

As per the docs, run the following to install the supported browsers for Playwright:

npx playwright install

Running tests

Run the browser test suite with yarn test:browser.

Record test instructions

After installing PlayWright, start to record tests using yarn test:browser:record.

Available flags:

  • --admin - Runs a test starting in Ghost Admin
  • --no-setup - When testing Ghost Admin, prevents the automated setup from running (for testing the setup wizard)
  • --fixtures="posts,users" - Install a set of fixtures, given as a comma-delimited list

When the window loads, hit the record button and click around. All of the link click steps will need to be tidied up to use better selectors, and any page.goto calls should be dropped (as they are likely a result of clicking links). The test generator is a useful assistant, but be wary of taking anything it generates as correct.

Writing tests

Recording tests will allow you to execute the steps in a browser that a user would follow. It's important to add assertions to ensure that we're not just testing that the site doesn't crash, but that we see the expected values on the page.

The test suite uses beforeAll and afterAll to setup Ghost and install fixtures. Each set of fixtures should have a new describe block to start a new instance of Ghost to be tested against.