search

osmosis-labs / test-tube

Test tube for cosmos-sdk chains integration test, written in Rust!
Apache License 2.0
54 stars 33 forks source link
cosmos osmosis

readme

test-tube

test

test-tube is a generic library for building testing environments for CosmWasm smart contracts. It allows you to test your smart contract logic against the actual Cosmos SDK chain's logic, which is written in Go, using Rust. This eliminates the need to write Go code or learn Go in order to test your smart contracts against the Cosmos SDK.

test-tube is currently used to build osmosis-test-tube, but it can be used to build testing environments for any Cosmos SDK-based chain. To do this, you will need to build a shared library that exports the functions described here. You can use the Go code and build script from osmosis-test-tube as a reference.

Features

Why don't just use cw-multi-test?

You might want to just use cw-multi-test if your contract does not interact with chain's custom module. cw-multi-test is faster since it does not need to run the chain code or build and upload .wasm file, but it does not test your contract against the actual chain's logic and rely on simulation which only some basic modules are implemented.

So if your contract just interact with common modules like Bank, Staking, and Distribution, cw-multi-test is enough. But if it's interacting with custom modules, you should use test-tube.

Known Issues

linking with cc failed on Mac M1/M2 (arm64) https://github.com/osmosis-labs/test-tube/issues/28

Check your go version if it's darwin/arm64, it might be darwin/amd64 and your local build has been working but it confuses the linker.

If you don't want to reinstall, go you opt for cross-compile.

cargo clean
export GOOS="darwin"
export GOARCH="arm64"
export CGO_ENABLED=1

But we would installing go version that match your architecture makes more sense.

Contributing

We welcome contributions to test-tube! If you find a bug or have an idea for a new feature, please open an issue or submit a pull request.

License

The crates in this repository are licensed under either of the following licenses, at your discretion.

Apache License Version 2.0 (LICENSE-APACHE or apache.org license link)
MIT license (LICENSE-MIT or opensource.org license link)

Unless you explicitly state otherwise, any contribution submitted for inclusion in this library by you shall be dual licensed as above (as defined in the Apache v2 License), without any additional terms or conditions.