Skip to content
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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Allow customization of the ARTIFACTS_PATH via WP_ARTIFACTS_PATH env var #35371

Merged
merged 8 commits into from
Oct 9, 2021
Merged

Allow customization of the ARTIFACTS_PATH via WP_ARTIFACTS_PATH env var #35371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0c315ac
Allow customization of the ARTIFACTS_PATH via WP_ARTIFACTS_PATH env var
thomasplevy Oct 5, 2021
b826882
Prettier
thomasplevy Oct 5, 2021
a4b19c3
Add changelog
thomasplevy Oct 7, 2021
d4cb606
Add documentation about the failed test artifacts
thomasplevy Oct 7, 2021
e39f9c4
Move artifcats docs under the proper header
thomasplevy Oct 8, 2021
69eb806
Use path.resolve in favor of path.join and ensure WP_ARTIFACTS_PATH u…
thomasplevy Oct 8, 2021
44d3cd7
prettier
thomasplevy Oct 8, 2021
64f734c
Add example and note a relative path must be used
thomasplevy Oct 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/scripts/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
### Enhancements

- The bundled `jest-dev-server` dependency has been updated to the next major version `^5.0.3` ([#34560](https://github.com/WordPress/gutenberg/pull/34560)).
- Allow customization of the `ARTIFACTS_PATH` in the `jest-environment-puppeteer` failed test reporter via the `WP_ARTIFACTS_PATH` environment variable ([#35371](https://github.com/WordPress/gutenberg/pull/35371)).

## 18.0.1 (2021-09-09)

Expand Down
6 changes: 6 additions & 0 deletions packages/scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,12 @@ This script automatically detects the best config to start Puppeteer but sometim

We enforce that all tests run serially in the current process using [--runInBand](https://jestjs.io/docs/en/cli#runinband) Jest CLI option to avoid conflicts between tests caused by the fact that they share the same WordPress instance.

#### Failed Test Artifacts

When tests fail, both a screenshot and an HTML snapshot will be taken of the page and stored in the `artifacts/` directory at the root of your project. These snapshots may help debug failed tests during development or when running tests in a CI environment.

The `artifacts/` directory can be customized by setting the `WP_ARTIFACTS_PATH` environment variable to the relative path of the desired directory within your project's root. For example: to change the default directory from `artifacts/` to `my/custom/artifacts`, you could use `WP_ARTIFACTS_PATH=my/custom/artifacts npm run test:e2e`.

#### Advanced information

It uses [Jest](https://jestjs.io/) behind the scenes and you are able to use all of its [CLI options](https://jestjs.io/docs/en/cli.html). You can also run `./node_modules/.bin/wp-scripts test:e2e --help` or `npm run test:e2e:help` (as mentioned above) to view all of the available options. Learn more in the [Advanced Usage](#advanced-usage) section.
Expand Down
7 changes: 5 additions & 2 deletions packages/scripts/config/jest-environment-puppeteer/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@ const KEYS = {
};

const root = process.env.GITHUB_WORKSPACE || process.cwd();
const ARTIFACTS_PATH = path.join( root, 'artifacts' );
const ARTIFACTS_PATH = path.resolve(
root,
process.env.WP_ARTIFACTS_PATH || 'artifacts'
);

class PuppeteerEnvironment extends NodeEnvironment {
// Jest is not available here, so we have to reverse engineer
Expand Down Expand Up @@ -171,7 +174,7 @@ class PuppeteerEnvironment extends NodeEnvironment {
await this.global.jestPuppeteer.resetBrowser();

try {
await mkdir( ARTIFACTS_PATH );
await mkdir( ARTIFACTS_PATH, { recursive: true } );
} catch ( err ) {
if ( err.code !== 'EEXIST' ) {
throw err;
Expand Down