docs: adding README.md for how to write e2e tests #1769
Merged
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
chatton
requested review from
colin-axner,
AdityaSripal,
crodriguezvega,
seantking,
charleenfei and
damiannolan
as code owners
chatton
changed the title
…s-how-to-write-e2e-tests
…s-how-to-write-e2e-tests
colin-axner
approved these changes
Jul 27, 2022
damiannolan
approved these changes
Jul 27, 2022
There was a problem hiding this comment.
Agree with all of @colin-axner's comments! Thank you so much for such a detailed guide. All of the work on e2e is extremely valuable and at an extremely high standard! I'm looking forward to working with it! ❤️
I think we have being trying to adhere to the google style guide in many of our docs and READMEs across the repo. The main thing that comes to mind is sentences for titles. E.g. "How To Write Tests" -> "How to write tests". cc. @crodriguezvega
| t.Run("broadcast multi message transaction", func(t *testing.T){ | ||
| payPacketFeeMsg := feetypes.NewMsgPayPacketFee(testFee, channelA.PortID, channelA.ChannelID, chainAWallet.Bech32Address(chainA.Config().Bech32Prefix), nil) | ||
| transferMsg := transfertypes.NewMsgTransfer(channelA.PortID, channelA.ChannelID, transferAmount, chainAWallet.Bech32Address(chainA.Config().Bech32Prefix), chainBWallet.Bech32Address(chainB.Config().Bech32Prefix), clienttypes.NewHeight(1, 1000), 0) | ||
| resp, err := s.BroadcastMessages(ctx, chainA, chainAWallet, payPacketFeeMsg, transferMsg) |
There was a problem hiding this comment.
Love this, super clean API!
e2e/README.md
Outdated
|
|
||
| It is possible to send an IBC transfer in two ways. | ||
|
|
||
| Use the ibctest Chain interface (this ultimately does a docker exec) |
There was a problem hiding this comment.
Suggested change
| Use the ibctest Chain interface (this ultimately does a docker exec) | |
| Use the ibctest `Chain` interface (this ultimately does a docker exec) |
e2e/README.md
Outdated
| ### How tests are run | ||
|
|
||
| The tests use the `matrix` feature of Github Actions. The matrix is | ||
| dynamically generated using [this script](https://github.com/cosmos/ibc-go/blob/main/.github/scripts/build_test_matrix.go). |
There was a problem hiding this comment.
Suggested change
| dynamically generated using [this script](https://github.com/cosmos/ibc-go/blob/main/.github/scripts/build_test_matrix.go). | |
| dynamically generated using [this command](https://github.com/cosmos/ibc-go/blob/main/cmd//build_test_matrix/main.go). |
|
@damiannolan @colin-axner in the rich preview the reference links seem broken, but if you go to |
…s-how-to-write-e2e-tests
chatton
deleted the
cian/issue#1683-add-e2e-readme-which-outlines-how-to-write-e2e-tests
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
closes: #1683
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes