Improve e2e testing docs and add cli args. #14717
Conversation
nicolad
requested review from
aduth,
ajitbohra,
gziolo,
mkaz,
nerrad,
oandregal,
ntwb and
youknowriad
as code owners
packages/scripts/scripts/test-e2e.js
Outdated
| WP_PASSWORD: "--wordpress-password" | ||
| }; | ||
|
|
||
| Object.entries(configsMapping).forEach(([key, value]) => { |
There was a problem hiding this comment.
Is this readable enough on first glance?
There was a problem hiding this comment.
Yes, it looks good. You can use more specific names instead key and name, e.g. envKey and argName or something like that.
|
There are 24 warnings reported by ESLint: It reports also that most of them can be fixed by running npm run lint-js — --fix |
| process.env[ key ] = getCliArg( value ); | ||
| } | ||
| } ); | ||
|
|
||
| jest.run( [ ...config, ...runInBand, ...getCliArgs( cleanUpPrefixes ) ] ); |
There was a problem hiding this comment.
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.
That's why @draganescu added logic which allows to filter out CLI args starting with a given pattern.
There was a problem hiding this comment.
Didn't knew that, had adjusted, thx.
gziolo
added
[Type] Automated Testing
packages/scripts/scripts/test-e2e.js
Outdated
| @@ -50,4 +50,16 @@ if ( hasCliArg( '--puppeteer-interactive' ) ) { | |||
| process.env.PUPPETEER_SLOWMO = getCliArg( '--puppeteer-slowmo' ) || 80; | |||
| } | |||
|
|
|||
| const configsMapping = { | |||
| WP_BASE_URL: '--wordpress-host', | |||
There was a problem hiding this comment.
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 :)
There was a problem hiding this comment.
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.
nicolad
changed the title
Description
Fixes to: #14494
I added
localarg tonpm run test-e2ecommand.How has this been tested?
It was tested locally.
Checklist: