N-ary Test Chains Support #1572

soareschen · 2021-11-16T22:02:49Z

Description

This is a follow up on #1521 to allow tests to setup N-ary test chains using const generics

Documentation for how to use the N-ary constructs indexed by const generics: https://informalsystems.github.io/ibc-rs-doc/ibc_integration_test/types/nary/index.html

For contributor use:

Added a changelog entry, using unclog.
If applicable: Unit tests written, added test to CI.
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Updated relevant documentation (docs/) and code comments.
Re-reviewed Files changed in the Github PR explorer.

This reverts commit dd0ec98.

* WIP relayer test * Bootstrap chain almost working * Refactor chain bootstrap code * Trying to get create client work. * Test create client is now working * Fix formatting * WIP IBC packet transfer * Got IBC transfer working * Refactor supervisor and denom tracing * More refactoring * More refactoring * Refactor build_and_send_transfer_messages * Round trip IBC token transfer is now working * Refactor channel bootstrap code * Add tagged chain handle wrapper * Rename ChainCommand to ChainDriver * Make bootstrap pair return impl ChainHandle * Add tagged types * Refactor bootstrap pair * Tag ChainDriver * Add mono tag, refactor single chain bootstrap * More refactoring * More refactoring * Fix chain tags * Channel creation ordering is now consistent * Test IBC transfer in both directions * Fix monitor shutdown error * Refactor wait wallet amount * Make init script return test config. Add hang test helper * Draft memo testing working * Add boostrap_chain_and_channel_pair * Add memo test as separate test * Disable health check in tests to suppress version errors from gaiad in Nix * Add CI workflow * Use experimental Nix with flakes * Refactor test cases to use composable traits * Use NoTestConfig wrapper type for test defaults * Reorder code definitions * Try out new way to override test config and implement override defaults * Preemptively shutdown supervisor at the end of chain tests * Rearrange type definitions * Rename framework traits * Rename and move override traits * Rename ChainDeployment to ConnectedChains * Refactor chain bootstrap * Add BinaryNodeTest trait * Add alpha- and beta- prefix to binary chain nodes * Add HANG_ON_FAIL test hooks * Add non-owned BinaryNodeTest * Refactor Supervisor to use shared reference to chain registry * Spawn supervisor in OwnedBinaryChainTest * New test override approach with separate override argument * Clean up overrides design * Fix cargo doc * Save relayer config onto file system * Simplify test overrides * Use absolute path for data directory path * Adding documentation * Add documentation for `framework` module * Adding more documentation * Reorganize test data directory * Add documentation for `bootstrap` module * Reorganize tagged module * Add documentation for MonoTagged * Refactor tagged methods into traits * Add documentation for DualTagged * Finish documenting most constructs * Move example documentation * Rename hang to suspend * Fix example doctest * Add more detailed documentation for DualTagged::contra_map * Remove ChainClientServer and inline the handle and node fields directly * Add documentation for connected chains and channels * Finish documenting everything * Only check for version in health check. Failure in parsing chain version should not result in failure of the entire relayer. * Stop chain handle when it is dropped * Add simulation manual test * Add documentation for new constructs * Move manual tests into the tests::manual module * Add test framework for running tests with self-connected chains * Add NodeConfigOverride for overriding full node config * Draft definition for N-ary connected chains using const generics * Implement N-ary bootstrap chains code * Done initial bootstrap code for N-ary channels. * Refactor to allow dynamic sized n-ary chains * Running binary IBC transfer test as n-ary test successful * Add environment exporter to test * Separate drop handlers from chain and node types * Remove reference version of test traits * Remove "Owned" and "owned_" prefixes * Put N-ary chain features behind "experimental" feature flag * Clean up cargo configuration, address review feedback * Fix build error * Fix doctests * Add custom Default instance for ModeConfig which enables everything by default * Follow default ModeConfig as specified in #1539 * Add test_setup_with_binary_channel command wrapper * Fix clippy * Fix unit test CI * Randomize created client and connection ids * Randomize channel IDs when bootstrapping channels * Move bootstrap connection code to separate module * Add back child process as a shared Arc pointer in FullNode * Move experimental N-ary test chains to separate PR * Fill out missing documentation * Move N-ary chain constructs to #1572 * Minor fix documentation * Add a bit more documentation to tagged identifiers * Slightly clean up bootstrap logs

This reverts commit 20d502d.

mzabaluev · 2022-01-24T13:58:51Z

Conflicts need to be resolved.

soareschen · 2022-02-14T05:12:21Z

tools/integration-test/src/chain/driver.rs

@@ -456,7 +456,7 @@ impl ChainDriver {
    ) -> Result<(), Error> {
        assert_eventually_succeed(
            "wallet reach expected amount",
-            20,
+            40,


It seems like there is some performance regression when the relayer is setup with multiple channels. I have to increase the timeout limit for assert_eventual_wallet_amount to > 20s for the IBC transfer test to not fail.

…ains

soareschen · 2022-03-09T11:01:23Z

This branch is currently crashing in Rust Analyzer caused by rust-lang/rust-analyzer#11659.

soareschen · 2022-03-10T16:49:00Z

This branch is now working with the pre-release version of Rust Analyzer. You'll have to explicitly enable that in the VSCode extension for it to work:

This PR is blocked from merging until new official release of Rust Analyzer.

@adizere it might also be a good idea for you to test this on IntelliJ. If it doesn't work there, we'd have to switch back to always having const generic parameters at the last position.

…ains

romac · 2022-03-14T14:29:05Z

.github/workflows/cargo-doc.yaml

@@ -19,7 +19,7 @@ jobs:
      - run: cargo doc

      - name: Deploy
-        if: ${{ github.ref == 'ref/head/master' }}
+        if: ${{ github.ref == 'refs/heads/soares/nary-test-chains' }}


Let's revert this before merging?

Right, actually I keep having problem finding the correct expression to trigger this step. It is not triggering on master as well.

I have reverted the branch to master. It probably still won't work on master, but we can figure out a fix in a separate PR.

* WIP relayer test * Bootstrap chain almost working * Refactor chain bootstrap code * Trying to get create client work. * Test create client is now working * Fix formatting * WIP IBC packet transfer * Got IBC transfer working * Refactor supervisor and denom tracing * More refactoring * More refactoring * Refactor build_and_send_transfer_messages * Round trip IBC token transfer is now working * Refactor channel bootstrap code * Add tagged chain handle wrapper * Rename ChainCommand to ChainDriver * Make bootstrap pair return impl ChainHandle * Add tagged types * Refactor bootstrap pair * Tag ChainDriver * Add mono tag, refactor single chain bootstrap * More refactoring * More refactoring * Fix chain tags * Channel creation ordering is now consistent * Test IBC transfer in both directions * Fix monitor shutdown error * Refactor wait wallet amount * Make init script return test config. Add hang test helper * Draft memo testing working * Add boostrap_chain_and_channel_pair * Add memo test as separate test * Disable health check in tests to suppress version errors from gaiad in Nix * Add CI workflow * Use experimental Nix with flakes * Refactor test cases to use composable traits * Use NoTestConfig wrapper type for test defaults * Reorder code definitions * Try out new way to override test config and implement override defaults * Preemptively shutdown supervisor at the end of chain tests * Rearrange type definitions * Rename framework traits * Rename and move override traits * Rename ChainDeployment to ConnectedChains * Refactor chain bootstrap * Add BinaryNodeTest trait * Add alpha- and beta- prefix to binary chain nodes * Add HANG_ON_FAIL test hooks * Add non-owned BinaryNodeTest * Refactor Supervisor to use shared reference to chain registry * Spawn supervisor in OwnedBinaryChainTest * New test override approach with separate override argument * Clean up overrides design * Fix cargo doc * Save relayer config onto file system * Simplify test overrides * Use absolute path for data directory path * Adding documentation * Add documentation for `framework` module * Adding more documentation * Reorganize test data directory * Add documentation for `bootstrap` module * Reorganize tagged module * Add documentation for MonoTagged * Refactor tagged methods into traits * Add documentation for DualTagged * Finish documenting most constructs * Move example documentation * Rename hang to suspend * Fix example doctest * Add more detailed documentation for DualTagged::contra_map * Remove ChainClientServer and inline the handle and node fields directly * Add documentation for connected chains and channels * Finish documenting everything * Only check for version in health check. Failure in parsing chain version should not result in failure of the entire relayer. * Stop chain handle when it is dropped * Add simulation manual test * Add documentation for new constructs * Move manual tests into the tests::manual module * Add test framework for running tests with self-connected chains * Add NodeConfigOverride for overriding full node config * Draft definition for N-ary connected chains using const generics * Implement N-ary bootstrap chains code * Done initial bootstrap code for N-ary channels. * Refactor to allow dynamic sized n-ary chains * Running binary IBC transfer test as n-ary test successful * Add environment exporter to test * Separate drop handlers from chain and node types * Remove reference version of test traits * Remove "Owned" and "owned_" prefixes * Put N-ary chain features behind "experimental" feature flag * Clean up cargo configuration, address review feedback * Fix build error * Fix doctests * Add custom Default instance for ModeConfig which enables everything by default * Follow default ModeConfig as specified in informalsystems#1539 * Add test_setup_with_binary_channel command wrapper * Fix clippy * Fix unit test CI * Randomize created client and connection ids * Randomize channel IDs when bootstrapping channels * Move bootstrap connection code to separate module * Add back child process as a shared Arc pointer in FullNode * Move experimental N-ary test chains to separate PR * Fill out missing documentation * Move N-ary chain constructs to informalsystems#1572 * Minor fix documentation * Add a bit more documentation to tagged identifiers * Slightly clean up bootstrap logs

* Implement N-ary chain test support This reverts commit 20d502d. * Add binary connection test traits * Refactor and share code between N-ary and binary constructs * Add bootstrap N-ary connections code * Add N-ary connection test traits * Remove "experimental" feature flag for N-ary modules * Propagate bootstrap_with_random_ids flag * Increase timeout limit for assert_eventual_wallet_amount * Add N-ary self connected chains test * Fix cargo doc * Adding documentation for N-ary constructs * Add more documentation * Add CI workflow to publish cargo doc * Add documentation for array utilities * Publish cargo doc only on master * Remove stale code * Add should_spawn_supervisor() method in TestOverrides * Fix errors from merge * Test deploy cargo doc * WIP Ternary IBC transfer test * Require tests to spawn supervisor explicitly * 2-hop IBC transfer test is now working * Full ternary transfer test is now working * Fix supervisor test * Trying to find the correct syntax for GitHub publish condition * Refactor N-ary foreign client pairs * Introduce ForeignClientPair * Fix publish docs CI * Refactor self connected chain tests to single node test * Refine N-ary constructs naming * Update Rust to 1.59.0 * Place const generics parameters at the front of N-ary constructs * Fix unordered test CI * Fix conflict error * Fix cargo doc * Add some documentation * Introduce ConnectionDelayOverride * Simplify spawning of refresh client tasks * Add some documentation * Revert publish doc step to master even though it is still not working

soareschen requested review from adizere, ancazamfir and romac as code owners November 16, 2021 22:02

soareschen marked this pull request as draft November 16, 2021 22:03

soareschen added a commit that referenced this pull request Nov 18, 2021

Move N-ary chain constructs to #1572

dd0ec98

soareschen added a commit that referenced this pull request Nov 18, 2021

Revert "Move N-ary chain constructs to #1572"

6b804cd

This reverts commit dd0ec98.

soareschen force-pushed the soares/nary-test-chains branch from 79e146d to 6b804cd Compare November 18, 2021 11:18

soareschen mentioned this pull request Nov 18, 2021

IBC Relayer Integration Test Suite #1521

Merged

5 tasks

Base automatically changed from soares/integration-test to master November 18, 2021 14:29

Implement N-ary chain test support

4fa47e2

This reverts commit 20d502d.

soareschen force-pushed the soares/nary-test-chains branch from 6b804cd to 4fa47e2 Compare November 19, 2021 10:22

soareschen added 5 commits November 19, 2021 12:17

Add binary connection test traits

edc6eaf

Refactor and share code between N-ary and binary constructs

bebcc4e

Add bootstrap N-ary connections code

8afb7a5

Add N-ary connection test traits

8027f68

Remove "experimental" feature flag for N-ary modules

e2376a5

adizere linked an issue Nov 25, 2021 that may be closed by this pull request

Support N-ary chains in integration test #1577

Closed

5 tasks

adizere mentioned this pull request Feb 1, 2022

Test scenarios for multi-network IBC #897

Closed

5 tasks

soareschen added 3 commits February 11, 2022 21:23

Merge branch 'master' into soares/nary-test-chains

b6cbac8

Propagate bootstrap_with_random_ids flag

efec63e

Increase timeout limit for assert_eventual_wallet_amount

b8ddb27

soareschen commented Feb 14, 2022

View reviewed changes

soareschen added 6 commits February 14, 2022 16:49

Merge remote-tracking branch 'origin/master' into soares/nary-test-ch…

fa89b10

…ains

Add N-ary self connected chains test

e003706

Fix cargo doc

a8cc330

Adding documentation for N-ary constructs

ed9a154

Add more documentation

106e776

Add CI workflow to publish cargo doc

8de8469

soareschen and others added 14 commits February 21, 2022 13:12

Trying to find the correct syntax for GitHub publish condition

4c5a328

Refactor N-ary foreign client pairs

7fcda10

Introduce ForeignClientPair

85c524e

Fix publish docs CI

ba088dd

Refactor self connected chain tests to single node test

3ebac23

Refine N-ary constructs naming

a12bf23

Update Rust to 1.59.0

bb69bc6

Place const generics parameters at the front of N-ary constructs

54ceaa8

Merge branch 'master' into soares/nary-test-chains

af8e0d6

Fix unordered test CI

a6148a2

Merge remote-tracking branch 'origin/master' into soares/nary-test-ch…

59b3269

…ains

Fix conflict error

b7961ac

Fix cargo doc

af668ff

Merge remote-tracking branch 'origin/master' into soares/nary-test-ch…

3d7ae6f

…ains

Add some documentation

33d260e

soareschen added 3 commits March 11, 2022 11:06

Introduce ConnectionDelayOverride

4ed1427

Simplify spawning of refresh client tasks

1cf90e8

Merge remote-tracking branch 'origin/master' into soares/nary-test-ch…

d5c649a

…ains

soareschen mentioned this pull request Mar 11, 2022

Test IBC transfer with 30 second connection delay #1950

Closed

6 tasks

soareschen added 2 commits March 14, 2022 13:16

Merge remote-tracking branch 'origin/master' into soares/nary-test-ch…

6d50583

…ains

Add some documentation

2d54740

romac approved these changes Mar 14, 2022

View reviewed changes

romac reviewed Mar 14, 2022

View reviewed changes

Revert publish doc step to master even though it is still not working

e67fcb7

soareschen merged commit d1a5043 into master Mar 14, 2022

soareschen deleted the soares/nary-test-chains branch March 14, 2022 17:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

N-ary Test Chains Support #1572

N-ary Test Chains Support #1572

soareschen commented Nov 16, 2021 •

edited

Loading

mzabaluev commented Jan 24, 2022

soareschen Feb 14, 2022

soareschen commented Mar 9, 2022

soareschen commented Mar 10, 2022

romac Mar 14, 2022

soareschen Mar 14, 2022

soareschen Mar 14, 2022

N-ary Test Chains Support #1572

N-ary Test Chains Support #1572

Conversation

soareschen commented Nov 16, 2021 • edited Loading

Description

mzabaluev commented Jan 24, 2022

soareschen Feb 14, 2022

Choose a reason for hiding this comment

soareschen commented Mar 9, 2022

soareschen commented Mar 10, 2022

romac Mar 14, 2022

Choose a reason for hiding this comment

soareschen Mar 14, 2022

Choose a reason for hiding this comment

soareschen Mar 14, 2022

Choose a reason for hiding this comment

soareschen commented Nov 16, 2021 •

edited

Loading