[UPDATE] Extend the readme documentation to cover E2E testing in more detail.

[cortisiko]

Development & PR Process

1. Follow MetaMask Mobile Coding Standards
2. Add release-xx label to identify the PR slated for a upcoming release (will be used in release discussion)
3. Add needs-dev-review label when work is completed
4. Add needs-qa label when dev review is completed
5. Add QA Passed label when QA has signed off

Description

For our engineers to contribute to our E2E tests effectively, it's vital that they know how to run them. The goal of this task is to ensure that the readme provides a clear explanation on how to build and execute our automation tests.

Screenshots/Recordings

If applicable, add screenshots and/or recordings to visualize the before and after of your change

Issue

Progresses https://github.com/MetaMask/mobile-planning/issues/895

Checklist

• There is a related GitHub issue
• Tests are included if applicable
• Any added code is fully documented

[tommasini]

LGTM!

[Gudahtt]

LGTM! I had one minor concern about the release build instructions, but everything else looks great. Thanks for documenting this, this is super helpful

[NicholasEllul]

Left a comment related to issues starting up with android, currently going through the iOS steps and will leave another review shortly

[NicholasEllul]

One last note:

When running android tests I fail the wallet creation process in the wdio runner.

This is due to the fact that we require an env variable to be set in order for the login to work successfully:

metamask-mobile/wdio/helpers/Accounts.js

Lines 10 to 19 in 895791d

	static getValidAccount() {
	return {
	// A correct BIP39 SRP that can be used for testing. Requires the var to be set in the environment.
	seedPhrase: process.env.MM_TEST_ACCOUNT_SRP || 'undefined SRP env var',
	// Ethereum address for 1st account of derived on the seed that can be used for testing. Requires the var to be set in the environment.
	address:
	process.env.MM_TEST_ACCOUNT_ADDRESS || 'undefined address env var',
	password: CORRECT_PASSWORD,
	};
	}

Onboarding steps should indicate that these variables need to be set

Update: I now see that this field is included in a more recent version of the .js.env.example file

[Gudahtt]

Currently the SRP environment variable is challenging to work with because the test process doesn't source the .js.env file. It won't work unless you source it yourself. It also gets cached by Jest, so it can fail unless you clear your Jest cache.

As a temporary workaround, I'd recommend running this in your terminal before running the e2e tests, and again each time you update that SRP:

yarn jest --clearCache && source .js.env

I would suggest that this be documented in the README as well, except for the fact that this won't be needed anymore once this PR is merged: #6190

[cortisiko]

Thanks for flagging #6190 @Gudahtt, I will wait until the pull request is merged instead of including a workaround in the documentation.

[NicholasEllul]

Looks great!