docs: Add guidelines for e2e tests #1466
Conversation
github-actions
bot
added
C:Testing
p-offtermatt
force-pushed
the
ph/e2e-tutorial
branch
from
d1ab5e3
to
154d56d
Compare
github-actions
bot
removed
C:Build
p-offtermatt
changed the title
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
Co-authored-by: Marius Poke <[email protected]>
| @@ -1,4 +1,188 @@ | |||
| ## Updating the trace format and tests when adjusting the framework | |||
| # End-to-end testing | |||
|
|
|||
There was a problem hiding this comment.
Would be nice to have a tl;dr or cheat sheet here, about running different kinds of tests & traces with different config.
There was a problem hiding this comment.
Do you think go run ./tests/e2e/... --help explains it properly?
I added a note to run that. If you think it's not helpful and there should be more here,
please lmk, otherwise just resolve this :)
| // potentially check something in the output, or log something, ... | ||
| ``` | ||
|
|
||
| Don't forget to wire your action into [main.go](main.go):runStep, where |
There was a problem hiding this comment.
nit: Why not point direclty to the line inside main.go that containsrunStep?
There was a problem hiding this comment.
I dislike it because it will not point to the right place anymore extremely quickly, i.e. as soon as the file is touched and this is not adjusted.
I'd be happy about suggestions on how to overcome this! I know anchors exist, but I think they make the source file a bit verbose.
Co-authored-by: Simon Noetzlin <[email protected]>
|
Thanks everyone for the reviews! 🙌 I think everyone had a chance to review, so I will merge this :) |
Description
Closes: #1334
This adds guidelines on how to write e2e tests to tests/e2e/README.md
TODO: add this README to the .md link checker, potentially?
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
docs:prefix in the PR titleReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
docs:prefix in the PR titlemake build-docs)