Skip to content

Commit

Permalink
Cleaned up TODOs and updated test descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
kirdatatjana committed Sep 4, 2024
1 parent cd346d0 commit e52ae4e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion scripts/test_doc/test_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
| Function | Short Description |
|----------|-------------------|
[TestStopConsumerChain](../../tests/integration/stop_consumer.go#L24) | TestStopConsumerChain tests the functionality of stopping a consumer chain at a higher level than unit tests.<details><summary>Details</summary>It retrieves a validator from the provider chain's validators and then the delegator address.<br>Then the test sets up test operations, populating the provider chain states using the following operations:<br> - Setup CCV channels; establishes the CCV channel and sets channelToChain, chainToChannel, and initHeight mapping for the consumer chain ID.<br> - Delegate the total bond amount to the chosen validator.<br> - Undelegate the shares in four consecutive blocks evenly; create UnbondingOp and UnbondingOpIndex entries for the consumer chain ID.<br> - Set SlashAck state for the consumer chain ID.<br><br>After, the setup operations are executed, and the consumer chain is stopped. Finally, the test checks that the state<br>associated with the consumer chain is properly cleaned up after it is stopped.</details> |
[TestStopConsumerOnChannelClosed](../../tests/integration/stop_consumer.go#L109) | TODO Simon: implement OnChanCloseConfirm in IBC-GO testing to close the consumer chain's channel end |
[TestStopConsumerOnChannelClosed](../../tests/integration/stop_consumer.go#L114) | TestStopConsumerOnChannelClosed tests stopping a consumer chain correctly.<details><summary>Details</summary>This test sets up CCV channel and transfer channel, and sends empty VSC packet.<br>Then it stops the consumer chain and verifies that the provider chain's channel end is closed<br><br>TODO Simon: implement OnChanCloseConfirm in IBC-GO testing to close the consumer chain's channel end</details> |
</details>

# [throttle.go](../../tests/integration/throttle.go)
Expand Down
5 changes: 5 additions & 0 deletions tests/integration/stop_consumer.go
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ func (s *CCVTestSuite) TestStopConsumerChain() {
s.checkConsumerChainIsRemoved(firstBundle.Chain.ChainID, true)
}

// TestStopConsumerOnChannelClosed tests stopping a consumer chain correctly.
// @Long Description@
// This test sets up CCV channel and transfer channel, and sends empty VSC packet.
// Then it stops the consumer chain and verifies that the provider chain's channel end is closed
//
// TODO Simon: implement OnChanCloseConfirm in IBC-GO testing to close the consumer chain's channel end
func (s *CCVTestSuite) TestStopConsumerOnChannelClosed() {
// init the CCV channel states
Expand Down

0 comments on commit e52ae4e

Please sign in to comment.