From 67443e5ceb3369b3a4d081877437f7cbd5e155ab Mon Sep 17 00:00:00 2001 From: Reece Williams Date: Mon, 6 Nov 2023 11:06:11 -0600 Subject: [PATCH] `v8` -> `v7` backport --- docs/conformance-tests-lib.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/conformance-tests-lib.md b/docs/conformance-tests-lib.md index b6a66ad45..1c64f604b 100644 --- a/docs/conformance-tests-lib.md +++ b/docs/conformance-tests-lib.md @@ -9,7 +9,7 @@ You can view all the specific conformance test by reviewing them in the [conform ## Importing Conformance Tests In Your Project -`interchaintest` can be imported into your own packages to be used as a library as well as being used from the +`interchaintest` can be imported into your own packages to be used as a library as well as being used from the binary itself, see [here](conformance-tests-bin.md). A common pattern when importing `interchaintest` into your own repositories is to use a Go submodule. The reason being @@ -21,16 +21,16 @@ to use specific versions of dependencies. To avoid this issue one will typically The main entrypoint exposed by the `conformance` package is a function named `Test`. -Here is the function signature of `Test`: +Here is the function signature of `Test`: ```go func Test(t *testing.T, ctx context.Context, cfs []interchaintest.ChainFactory, rfs []interchaintest.RelayerFactory, rep *testreporter.Reporter) ``` -It accepts a normal `testing.T` and `context.Context` from the Go standard library as well as a few types defined in `interchaintest`. +It accepts a normal `testing.T` and `context.Context` from the Go standard library as well as a few types defined in `interchaintest`. - `testreporter.Reporter` is used for collecting detailed test reports, you can read more about it [here](../testreporter/doc.go). - `interchaintest.ChainFactory` is used to define which chain pairs should be used in conformance testing. -- `interchaintest.RelayerFactory` is used to define which relayer implementations should be used to test IBC functionality between your chain pairs. +- `interchaintest.RelayerFactory` is used to define which relayer implementations should be used to test IBC functionality between your chain pairs. It is important to note that the `Test` function accepts a slice of `ChainFactory`, currently the `conformance` tests only work against a pair of two chains at a time. This means that each `ChainFactory` should only contain definitions for two chains, @@ -47,10 +47,10 @@ import ( "context" "testing" - "github.com/strangelove-ventures/interchaintest/v8" - "github.com/strangelove-ventures/interchaintest/v8/conformance" - "github.com/strangelove-ventures/interchaintest/v8/ibc" - "github.com/strangelove-ventures/interchaintest/v8/testreporter" + "github.com/strangelove-ventures/interchaintest/v7" + "github.com/strangelove-ventures/interchaintest/v7/conformance" + "github.com/strangelove-ventures/interchaintest/v7/ibc" + "github.com/strangelove-ventures/interchaintest/v7/testreporter" "go.uber.org/zap/zaptest" ) @@ -99,8 +99,4 @@ func TestConformance(t *testing.T) { // IBC capabilities properly implemented and work with both the Go relayer and Hermes. conformance.Test(t, ctx, []interchaintest.ChainFactory{cf}, []interchaintest.RelayerFactory{rlyFactory, hermesFactory}, rep) } - - ``` - -