Add Contracts to the Test Suite

It's time to add the contracts to the test suite. It might be helpful to give a brief overview of the contracts before adding them to the test suite.

Overview of cw-ica-controller

CosmWasm Interchain Account Controller is a pure CosmWasm implementation of the ICS-27 controller specifications. It can therefore directly create and control accounts in the counterparty icahost module.

This contract was designed to be instantiated by other contracts that wish to control accounts in a counterparty chain. Learn more about the contract in its repository: srdtrk/cw-ica-controller.

Note

There are a couple important things to note about this contract:

• Since this contract was designed to be instantiated by other contracts, it does have the capability to make callbacks to an external contract on channel and packet lifecycle events. This is what the callback-counter test contract is for.

src/types/callbacks.rs

loading...

View on GitHub

• This contract automatically initiates the channel opening handshake when it is instantiated and doesn't allow any relayers to initiate the handshake.

src/types/msg.rs

loading...

View on GitHub

Add the Contracts

In this test, we will only add the cw-ica-controller and callback-counter contracts to the test suite. To add the cw-ica-controller contract to the test suite, run the following command from the root of the workshop repository:

go-codegen interchaintest add-contract schema/cw-ica-controller.json --suite-dir e2e/interchaintestv8

View Source

This command will generate the following files:

e2e/interchaintestv8/
├── contract_test.go
└── types
    └── cwicacontroller
        ├── contract.go
        ├── msgs.go
        └── query.go

contract_test.go contains an example test case for instantiating the generated contract. This file is only generated if it doesn't already exist in the test suite when the add-contract command is run.

You can also add the callback-counter contract to the test suite by running the following command:

go-codegen interchaintest add-contract testing/contracts/callback-counter/schema/callback-counter.json --suite-dir e2e/interchaintestv8

View Source

This command will generate the following files:

e2e/interchaintestv8/types/callbackcounter
├── contract.go
├── msgs.go
└── query.go

This will not modify the contract_test.go and the

Exploration

Explore the generated files to understand how the contracts are added to the test suite.

Run the generated test and understand why it fails.

cd e2e/interchaintestv8
go test -v . -run=TestWithContractTestSuite/TestContract

Github Actions

Github Actions will not run the test in the generated contract_test.go file. To do this, you need to add the test to the .github/workflows/e2e.yml file. Moreover, when running the generated test in Github Actions, you will need to build all the contracts before running the test.

# ...
  build:
    strategy:
      fail-fast: false
      matrix:
        test:
          # List your tests here
          - TestWithBasicTestSuite/TestBasic
+         - TestWithContractTestSuite/TestContract
    name: ${{ matrix.test }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v3
-     # You can build your contract here, you can either use docker or a custom cargo script:
-     # We've provided examples for both below:
-     # 
-     # - name: Build Contracts with Docker
-     #   run: |
-     #     docker run --rm -v "$(pwd)":/code -     #     --mount type=volume,source="$(basename "$(pwd)")_cache",target=/code/target -     #     --mount type=volume,source=registry_cache,target=/usr/local/cargo/registry -     #     cosmwasm/optimizer:0.15.1
-     # - name: Install cargo-run-script
-     #   uses: actions-rs/cargo@v1
-     #   with:
-     #     command: install
-     #     args: cargo-run-script
-     # - name: Build Optimized Contract
-     #   uses: actions-rs/cargo@v1
-     #   with:
-     #     command: run-script
-     #     args: optimize
+     - name: Install just
+       uses: extractions/setup-just@v2
+     - name: Build Test Contracts with Docker
+       run: just build-test-contracts
+     - name: Build Optimized Contract
+       run: just build-optimize
      - name: Setup Go
        uses: actions/setup-go@v4
# ...

View Source