Enhancement/update critical flows with e2e test coverage #87
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allow settings.test.js (and other test files) to be run independently of connect.test.js. This fixes an error where test cases would fail due to the user not being logged into their Mailchimp account.
Move block and short code urls into fixtures
1 task
4 tasks
Highlights - Add a FE Mailchimp client to Cypress tests to verify Mailchimp account interactions. Ensures successful form submission and full integration testing. - Use .env.test for env variables - Add health check for tests if Mailchimp client is unable to make requests - Modularize Cypress commands‼️ Environment changes needed‼️ - Need to generate an API key for the test Mailchimp user in the CI/CD pipeline. - Need to attach that API key to CYPRESS_MAILCHIMP_API_KEY as a Github secret - Need to attach the server prefix to CYPRESS_MAILCHIMP_API_SERVER_PREFIX as a Github secret Commits * Add Mailchimp API package * Add cypress-dotenv * Add Mailchimp API client to Cypress Necessary to interact with the test user account to verify contacts, make deletions, etc. * Update documentation for env setup * Remove outdated E2E notes * Remove log to fix bug. Skip unfinished tests. * Remove outdated readme note * Add test to verify lists in WP admin match lists in Mailchimp account * Add assertion that contacts in Mailchimp account match email submitted * Simplify mailchimp commands * Add mailchimp commands to command folder * Organize commands into modular files * Rename mailchimpApiConfig to more clearly state purpose * Fix grammar mistake * Add scaffolding for gmail api * Switch to gabi-script for FE requests * Update .env.test.sample with example of google creds * Remove gmail api client Too complicated to set up for our purposes. We're better off with Mailhog * Remove gapi-script
Add return for more verifications
Add support for fetching more contacts Add support for fetching contacts by status Add utility function to set boolean settings
Refactor code to simplify
Skip tests that currently test bugged functionality
This test was decided to be a 'doing it wrong' site owner scenario. Any use of the plugin would require saving a list and therfore this is not a test we will be including
Status@jeffpaul and @dkotter E2E tests passing with headless Cypress 🙂 - 
Critical flows checklistI duplicated the critical flows checklist and added ✅, Known problems
Next Steps
After we add the environment variables for the API key I can fix any errors that come up in the CI/CD pipeline. |
Caused an error that caused session data to malfunction and fail every other test next in the cycle
dkotter
reviewed
Jan 22, 2025
dkotter
reviewed
Jan 22, 2025
dkotter
reviewed
Jan 22, 2025
dkotter
reviewed
Jan 22, 2025
| .scrollIntoView({ offset: { top: -100, left: 0 } }) | ||
| .should('be.visible') // Check if the button is visible | ||
| .and('not.be.disabled'); // Ensure the button is not disabled | ||
| // .click(); // Perform the click action |
There was a problem hiding this comment.
Should this be removed if we're not using it?
There was a problem hiding this comment.
Originally, there was a blocker where we couldn't submit the same email repeatedly because we had no way of deleting the contact in Mailchimp after submission. However, now that we have the command cy.deleteContactFromList we could easily clean up after running .click().
So we could either:
- Remove the submission step
- Enable
.click(), add a successful form submission assertion, and then delete the contact in the Mailchimp account
What do you think? I could see the argument for both approaches being valid.
There was a problem hiding this comment.
I think it's probably fine to just remove that submission step for now
dkotter
reviewed
Jan 22, 2025
Co-authored-by: Darin Kotter <[email protected]>
Co-authored-by: Darin Kotter <[email protected]>
Co-authored-by: Darin Kotter <[email protected]>
Co-authored-by: Darin Kotter <[email protected]>
github-actions
bot
added
the
needs:refresh
|
@MaxwellGarceau thanks for the PR! Could you please rebase your PR on top of the latest changes in the base branch? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
Update E2E Cypress tests to cover all critical testing flows.
Enhancement/add mailchimp api client - #99
.env.testfor env variablesCloses #61
Closes #86
How to test the Change
Follow the E2E testing instructions in the readme to run the Cypress tests. In addition, these tests should run automatically as part of the projects CI/CD flow.
Changelog Entry
Credits
Props @MaxwellGarceau
Checklist: