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

Improve e2e testing docs and add cli args. #14717

Merged
merged 5 commits into from
Apr 1, 2019
Merged

Improve e2e testing docs and add cli args. #14717

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00e5cc6
Updated readme and added local arg.
nicolad Mar 29, 2019
72be60e
Lint fixes.
nicolad Mar 31, 2019
3155ed2
Replaced dumb namings with a more reasonable ones.
nicolad Apr 1, 2019
3264678
Added --wordpress- to cleanUpPrefixes.
nicolad Apr 1, 2019
6784492
Align argument name with env key.
nicolad Apr 1, 2019
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
3 changes: 3 additions & 0 deletions packages/scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,9 @@ This is how you execute those scripts using the presented setup:

* `npm run test:e2e` - runs all unit tests.
* `npm run test:e2e:help` - prints all available options to configure unit tests runner.
* `npm run test-e2e -- --puppeteer-interactive` - runs all unit tests interactively.
* `npm run test-e2e FILE_NAME -- --puppeteer-interactive ` - runs one test file interactively.
* `npm run test-e2e:watch -- --puppeteer-interactive` - runs all tests interactively and watch for changes.

This script automatically detects the best config to start Puppeteer but sometimes you may need to specify custom options:
- You can add a `jest-puppeteer.config.js` at the root of the project or define a custom path using `JEST_PUPPETEER_CONFIG` environment variable. Check [jest-puppeteer](https://github.com/smooth-code/jest-puppeteer#jest-puppeteerconfigjs) for more details.
Expand Down
12 changes: 12 additions & 0 deletions packages/scripts/scripts/test-e2e.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,16 @@ if ( hasCliArg( '--puppeteer-interactive' ) ) {
process.env.PUPPETEER_SLOWMO = getCliArg( '--puppeteer-slowmo' ) || 80;
}

const configsMapping = {
WP_BASE_URL: '--wordpress-host',
Copy link
Member

Choose a reason for hiding this comment

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

Do you think we should align with the env variable name? --wordpress-base-url maybe. I forgot that WordPress can be also installed in subfolder and seeing the actual implementation made me think :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, that's better, since there is no need to think twice why the argument name is describing a different thing than expected from env key.

WP_USERNAME: '--wordpress-username',
WP_PASSWORD: '--wordpress-password',
};

Object.entries( configsMapping ).forEach( ( [ key, value ] ) => {
if ( hasCliArg( value ) ) {
process.env[ key ] = getCliArg( value );
}
} );

jest.run( [ ...config, ...runInBand, ...getCliArgs( cleanUpPrefixes ) ] );
Copy link
Member

Choose a reason for hiding this comment

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

const cleanUpPrefixes = [ '--puppeteer-' ];

At the moment cleanUpPrefixes doesn't filter out --wordpress-. It should be a good practice to ensure they are never passed to Jest as we discovered some issues with --interactive in the past.

Screen Shot 2019-04-01 at 10 23 38

That's why @draganescu added logic which allows to filter out CLI args starting with a given pattern.

Copy link
Member Author

@nicolad nicolad Apr 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Didn't knew that, had adjusted, thx.