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.

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

test: Reorganize test/e2e repo to improve navigation part 1 #23398

Merged
merged 3 commits into from
Mar 12, 2024

Conversation

chloeYue
Copy link
Contributor

@chloeYue chloeYue commented Mar 8, 2024

Description

This PR is the beginning of a series aimed at reorganizing the test/e2e repository to create a structure that is both well-organized and easy to navigate. The goal is to enhance the overall efficiency and accessibility of our e2e tests. This reorganization work will be split into multiple PRs, ensures that each PR remains manageable and easy to review, facilitating better feedback and more efficient integration.

In this initial step, I've started by creating multiple folders within the test/e2e/tests repo to group tests by feature. This allows for a more intuitive organization, with each set of feature-related tests contained within its own dedicated folder. The tests that were most evidently associated with a specific feature have been sorted into the appropriate new folders. The remaining test cases, which may require further discussion or clarification to assign correctly, will be addressed in future PRs.

The reason behind organizing test cases by features is to streamline the ownership of tests, with each feature team being responsible for one or multiple folders related to the features they develop and maintain. This fosters a sense of ownership and aligns testing efforts closely with feature development. I did not create a separate repo for each feature team due to potential maintenance challenges, especially if we have team reorganizations in the future.

Additionally, other files such as helpers, modules, and utility files that support these tests are also planned to be reorganized in the following PRs.

Related issues

Fixes: #23296

Manual testing steps

Check if the organization is logical.

Screenshots/Recordings

Before

Screen.Recording.2024-03-08.at.17.08.42.mov

After

Screen.Recording.2024-03-08.at.17.10.51.mov

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 8, 2024 16:12
Copy link
Contributor

github-actions bot commented Mar 8, 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 Reorganize e2e test/e2e repo part1 Reorganize test/e2e repo part1 Mar 8, 2024
@chloeYue chloeYue changed the title Reorganize test/e2e repo part1 Reorganize test/e2e repo to improve navigation part 1 Mar 8, 2024
@chloeYue chloeYue added team-extension-platform e2e-test End to end test for the MetaMask extension labels Mar 8, 2024
@chloeYue chloeYue changed the title Reorganize test/e2e repo to improve navigation part 1 test: Reorganize test/e2e repo to improve navigation part 1 Mar 8, 2024
@chloeYue chloeYue marked this pull request as draft March 8, 2024 16:25
@metamaskbot
Copy link
Collaborator

Builds ready [e65bfbf]
Page Load Metrics (1299 ± 338 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint722131384019
domContentLoaded1177422311
load5818811299703338
domInteractive1177422311
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

Copy link

codecov bot commented Mar 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.67%. Comparing base (318a8ce) to head (e65bfbf).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop   #23398   +/-   ##
========================================
  Coverage    68.67%   68.67%           
========================================
  Files         1106     1106           
  Lines        43356    43356           
  Branches     11591    11591           
========================================
  Hits         29773    29773           
  Misses       13583    13583           

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

@chloeYue chloeYue marked this pull request as ready for review March 8, 2024 17:41
@DDDDDanica
Copy link
Contributor

LGTM !

Copy link
Contributor

@pedronfigueiredo pedronfigueiredo left a comment

Choose a reason for hiding this comment

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

LGTM!

@chloeYue chloeYue merged commit 171b6c7 into develop Mar 12, 2024
67 checks passed
@chloeYue chloeYue deleted the chloe-reorganize-e2e-1 branch March 12, 2024 14:19
@github-actions github-actions bot locked and limited conversation to collaborators Mar 12, 2024
@metamaskbot metamaskbot added the release-11.14.0 Issue or pull request that will be included in release 11.14.0 label Mar 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[E2E] Refacto e2e tests to make navigation easier
4 participants