https://github.com/osmosis-labs/test-tube
Test tube for cosmos-sdk chains integration test, written in Rust!
https://github.com/osmosis-labs/test-tube
cosmos osmosis
Last synced: 6 months ago
JSON representation
Test tube for cosmos-sdk chains integration test, written in Rust!
- Host: GitHub
- URL: https://github.com/osmosis-labs/test-tube
- Owner: osmosis-labs
- License: apache-2.0
- Created: 2022-12-21T11:28:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T01:30:29.000Z (6 months ago)
- Last Synced: 2025-05-01T02:36:01.349Z (6 months ago)
- Topics: cosmos, osmosis
- Language: Rust
- Homepage:
- Size: 62.4 MB
- Stars: 57
- Watchers: 5
- Forks: 35
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE-Apache
Awesome Lists containing this project
README
# test-tube
`test-tube` is a generic library for building testing environments for [CosmWasm](https://cosmwasm.com/) 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`](https://github.com/osmosis-labs/test-tube/tree/main/packages/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](https://github.com/osmosis-labs/test-tube/blob/ddae11d003b5d900bdee2026034b9b1d4c33bdb3/packages/test-tube/src/bindings.rs#L211-L241). You can use the [Go code](https://github.com/osmosis-labs/test-tube/tree/main/packages/osmosis-test-tube/libosmosistesttube) and [build script](https://github.com/osmosis-labs/test-tube/blob/main/packages/osmosis-test-tube/build.rs) from `osmosis-test-tube` as a reference.
## Features
- Test your CosmWasm smart contracts using Rust without the need to write Go code or learn Go
- Test against the actual Cosmos SDK chain's logic
- Build testing environments for any Cosmos SDK-based chain
## 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.
```sh
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.