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.

Sign up for GitHub

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

Jump to bottom

Create guidelines on how to use the e2e testing framework #1334

Closed
3 tasks done
Tracked by #1331
p-offtermatt opened this issue Sep 28, 2023 · 2 comments · Fixed by #1466
Closed
3 tasks done
Tracked by #1331

Create guidelines on how to use the e2e testing framework #1334

p-offtermatt opened this issue Sep 28, 2023 · 2 comments · Fixed by #1466
Assignees
@p-offtermatt
Labels
scope: docs Improvements or additions to documentation scope: testing Code review, testing, making sure the code is following the specification.

Comments

@p-offtermatt
Copy link
Contributor

p-offtermatt commented Sep 28, 2023 •
edited
Loading

Here is a list of things that we should mention or document better. These might also be candidates for refactors, but I am mostly looking to put things here that are solved simply by having some guidance on how to do them.

  • StartRelayer vs relayPackets: when to use what?
  • ChainState null means we check nothing, not that we think it should be null
  • How can the e2e tests be used to produce a local testnet you can try things on (related: feature: add a way to start a local testnet #896)
@p-offtermatt p-offtermatt mentioned this issue Sep 28, 2023
Closed
@p-offtermatt p-offtermatt changed the title guidelines on how to use the testing framework Create guidelines on how to use the e2e testing framework Sep 28, 2023
@p-offtermatt
Copy link
Contributor Author

p-offtermatt commented Sep 28, 2023 •
edited
Loading

Anyone is free to add things they would like clarified or documented better in this issue.
We will take any feedback into account when we tackle this, so it is very useful if you run across things that should be documented better!

@p-offtermatt p-offtermatt added scope: docs Improvements or additions to documentation scope: testing Code review, testing, making sure the code is following the specification. labels Sep 28, 2023
@p-offtermatt p-offtermatt self-assigned this Sep 28, 2023
@shaspitz
Copy link
Contributor

shaspitz commented Oct 4, 2023

Some random non-trivial things to document w.r.t e2e tests:

  • When/why we should specify --gas flag for certain actions
  • How one should debug e2e tests that fail -> shelling into the docker container, navigating file structure, logs, etc.
  • How one should specify "genesis changes" like setting a non-default param

@p-offtermatt p-offtermatt mentioned this issue Nov 17, 2023
Closed
@p-offtermatt p-offtermatt mentioned this issue Dec 4, 2023
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@p-offtermatt p-offtermatt

Labels
scope: docs Improvements or additions to documentation scope: testing Code review, testing, making sure the code is following the specification.
Projects
Cosmos Hub
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Add guidelines for e2e tests cosmos/interchain-security
2 participants
@shaspitz @p-offtermatt