Skip to content

docs: [E2E] Update readme for e2e tests#23309

Merged
chloeYue merged 5 commits intodevelopfrom
chloe-update-e2e-readme
Mar 8, 2024
Merged

docs: [E2E] Update readme for e2e tests#23309
chloeYue merged 5 commits intodevelopfrom
chloe-update-e2e-readme

Conversation

@chloeYue
Copy link
Copy Markdown
Contributor

@chloeYue chloeYue commented Mar 5, 2024 •
edited
Loading

Description

This PR updates the E2E testing instructions in our README to enhance clarity and usability. The updates focus on:

  • Simplified Test Build Preparation: Instructions have been added for easier and quicker preparation of test builds: use yarn download-builds:test to download pre-built test builds.
  • Guidance on specific types of test builds: Clear instructions are now provided for running tests on different build types, ensuring contributors can accurately test against their desired build types.
  • Add instructions to run e2e tests against specific feature flag
  • Remove the manual Chrome driver update process from readme, as our E2E tests now automatically download the latest Chrome driver.
  • Updated the test path for an example.

Related issues

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/2187

Manual testing steps

Try to follow readme to run e2e tests to see if it's clear.

Screenshots/Recordings

Before

After

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained what problem this PR is solving and how it is solved.
  • I've linked related issues
  • I've included manual testing steps
  • I've included screenshots/recordings if applicable
  • I’ve included tests if applicable
  • I’ve documented my code using JSDoc format if applicable
  • I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.
  • I’ve properly set the pull request status:
    • In case it's not yet "ready for review", I've set it to "draft".
    • In case it's "ready for review", I've changed it from "draft" to "non-draft".

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@chloeYue chloeYue requested a review from a team as a code owner March 5, 2024 09:46
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 5, 2024

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@chloeYue chloeYue changed the title [E2E] Update readme for e2e tests [E2E docs] Update readme for e2e tests Mar 5, 2024
@chloeYue chloeYue changed the title [E2E docs] Update readme for e2e tests docs: [E2E] Update readme for e2e tests Mar 5, 2024
@chloeYue chloeYue added area-documentation Issues relating to documentation, in the codebase and off. team-extension-platform Extension Platform team e2e-test End to end test for the MetaMask extension labels Mar 5, 2024
@metamaskbot
Copy link
Copy Markdown
Collaborator

metamaskbot commented Mar 5, 2024

Builds ready [ec8ed70]
Page Load Metrics (808 ± 463 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint892621404522
domContentLoaded137635199
load752390808964463
domInteractive137635199
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 5, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.59%. Comparing base (4c6bba1) to head (3f6d197).
Report is 18 commits behind head on develop.

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop   #23309   +/-   ##
========================================
  Coverage    68.59%   68.59%           
========================================
  Files         1101     1101           
  Lines        43176    43176           
  Branches     11552    11552           
========================================
  Hits         29615    29615           
  Misses       13561    13561

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@metamaskbot
Copy link
Copy Markdown
Collaborator

metamaskbot commented Mar 5, 2024

Builds ready [7f367a3]
Page Load Metrics (1066 ± 435 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint742101243718
domContentLoaded117233199
load6125091066905435
domInteractive117233199
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

DDDDDanica
DDDDDanica reviewed Mar 5, 2024
View reviewed changes
@chloeYue chloeYue requested a review from DDDDDanica March 6, 2024 10:37
@metamaskbot
Copy link
Copy Markdown
Collaborator

metamaskbot commented Mar 6, 2024

Builds ready [6ec8bc8]
Page Load Metrics (888 ± 426 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint762501374823
domContentLoaded9137443416
load572119888887426
domInteractive9137443416
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

@metamaskbot metamaskbot added the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Mar 6, 2024
seaona
seaona reviewed Mar 6, 2024
View reviewed changes
@seaona
Copy link
Copy Markdown
Member

seaona commented Mar 6, 2024

Overall looks good 😻 Left a small suggestion

@chloeYue chloeYue requested a review from seaona March 6, 2024 17:11
@metamaskbot
Copy link
Copy Markdown
Collaborator

metamaskbot commented Mar 6, 2024

Builds ready [3f6d197]
Page Load Metrics (1151 ± 376 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint762341324120
domContentLoaded982362010
load6419871151784376
domInteractive982362010
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

darkwing
darkwing approved these changes Mar 7, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@darkwing darkwing left a comment

Choose a reason for hiding this comment

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

Looks good! Thank you for improving documentation!

@chloeYue chloeYue merged commit 318a8ce into develop Mar 8, 2024
@chloeYue chloeYue deleted the chloe-update-e2e-readme branch March 8, 2024 08:06
@github-actions github-actions bot locked and limited conversation to collaborators Mar 8, 2024
@github-actions github-actions bot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Mar 8, 2024
@metamaskbot metamaskbot added the release-11.14.0 Issue or pull request that will be included in release 11.14.0 label Mar 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@DDDDDanica DDDDDanica DDDDDanica approved these changes

@seaona seaona Awaiting requested review from seaona

+1 more reviewer

@darkwing darkwing darkwing approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area-documentation Issues relating to documentation, in the codebase and off. e2e-test End to end test for the MetaMask extension release-11.14.0 Issue or pull request that will be included in release 11.14.0 team-extension-platform Extension Platform team

Projects

PR review queue
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@chloeYue @metamaskbot @seaona @darkwing @DDDDDanica