End-to-End Testing of Passport App

[nutrina]

User Story:

As a developer, I want to ensure that the Passport application functions correctly after any updates, so that I can confidently push fixes or features knowing that they will not negatively impact the application's performance or reliability.

Acceptance Criteria

GIVEN I make changes to the source code, WHEN I push these changes to the main branch or make a release with the CI, AND a regression occurs (e.g., the dashboard does not load, a user cannot log in), THEN I want the end-to-end tests to fail and halt the CI pipeline to prevent deployment of faulty software.

Product & Design Links:

Tech Details:

• Tools for End-to-End Testing:
  • Synpress: Preferred for its support of MetaMask, making it ideal for testing blockchain-related functionalities. More details can be found on Synpress GitHub.
  • Cypress: A powerful, easy-to-use tool for modern web applications testing.
  • see the existing implementation of e2e tests with Cypress for the scorer UI (this however circumvents the login step with the wallet by programatically logging in and setting the expected tokens): https://github.com/gitcoinco/passport-scorer/tree/main/test
  • Selenium: A traditional tool for automating web browsers, useful if broader browser compatibility tests are required.
• Integration:
  • Integrate the chosen tool into the Continuous Integration (CI) pipeline.
  • Configure the testing framework to run automatically on push to the main branch or when a release is initiated.
  • Set up notifications to alert developers of failed tests and halt further CI processes until issues are resolved.

Open Questions:

• [ ] Which specific scenarios should be included in the end-to-end tests to cover all critical functionalities?
• [ ] Are there additional configurations or setups needed to integrate Synpress effectively with our existing CI tools?

Notes/Assumptions:

• Assume that the current CI infrastructure is capable of integrating with the selected end-to-end testing tools without significant modifications.
• The choice of Synpress assumes that blockchain interactions are a significant part of the application and require specific testing considerations.

[nutrina]

Have put this in blocked, as it is difficult to get an example to work.

[larisa17]

Update: Synpress looks like it should work out of the box & could be what we need. There is active development on Synpress, a big update is planned: The new release is a full rewrite of Synpress and will feature major breaking changes, and multitude of new features and improvements across the board . The new version is developed on https://github.com/Synthetixio/synpress/tree/new-dawn