Clarify Rocket-E2E documentation with latest changes and questions

wp-media / wp-rocket-e2e

Playwright E2E testing repo

GNU General Public License v3.0

0 stars 0 forks source link

Clarify Rocket-E2E documentation with latest changes and questions #99

Closed MathieuLamiot closed 4 months ago

MathieuLamiot commented 5 months ago

Update this doc: https://www.notion.so/wpmedia/Rocket-E2E-Test-Automation-using-Cucumber-Playwright-aecad10ae0c14a11aa609881a9d1230b?pvs=4

With details following the questions we had recently:

https://wp-media.slack.com/archives/CUKB44GNN/p1717504446454669 : explain the different configuration/Settings and what is needed/what is not.
https://wp-media.slack.com/archives/CUKB44GNN/p1717505852515299 : Explain what to put in previous/next release. Maybe a link to https://www.notion.so/wpmedia/Generate-a-Branch-Zip-File-29d931ad50e945dab8df5a4302ea948a?pvs=4 ?
https://wp-media.slack.com/archives/CUKB44GNN/p1717516851539499
https://wp-media.slack.com/archives/CUKB44GNN/p1717517467087399 : How to check on a quick test plan that the setup is done properly? Expected results?

Maybe consider moving this documentation to a docs folder in the repo directly, to ease its maintenance?

Khadreal commented 5 months ago

Updated the doc exxcept for the last item on the list. Do we have to list out each test and expected results ?

MathieuLamiot commented 5 months ago

Updated the doc exxcept for the last item on the list. Do we have to list out each test and expected results ?

Listing all that would be overkill I think? What I had in mind was more of a quick test that we would have, to make sure the E2E setup is OK. I'm thinking maybe smoke tests? We could just say "run this command, after 1 minute, you should get this in the console and no errors. It means basic E2E setup is working". WDYT?

Khadreal commented 5 months ago

Okay, that makes sense. I'll update the doc with a smoke test and the expected result

Khadreal commented 5 months ago

We don't currently have anything to confirm if basic setup is fine or not, I created a draft PR https://github.com/wp-media/wp-rocket-e2e/pull/112, let me know if this is okay or we need to check for other features

MathieuLamiot commented 4 months ago

What I would have in mind for a healthcheck:

Check SSH is OK (like you did)
Check that the e2e website is accessible, and that the login is OK to get into wp-admin

MathieuLamiot commented 4 months ago

@Khadreal Hello, I see this is in progress for more than a week. Are there any blockers or on-going discussions? Thanks

jeawhanlee commented 4 months ago

Looks good to me.