Configure relayers to watch only channels associated with an individual test #6685
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,16 @@ | ||
| package relayer | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| dockerclient "github.com/docker/docker/client" | ||
| "github.com/pelletier/go-toml" | ||
| "github.com/strangelove-ventures/interchaintest/v8" | ||
| "github.com/strangelove-ventures/interchaintest/v8/ibc" | ||
| "github.com/strangelove-ventures/interchaintest/v8/relayer" | ||
| "github.com/strangelove-ventures/interchaintest/v8/relayer/hermes" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
|
|
@@ -24,6 +27,9 @@ const ( | |
| // TODO: https://github.com/cosmos/ibc-go/issues/4965 | ||
| HyperspaceRelayerRepository = "ghcr.io/misko9/hyperspace" | ||
| hyperspaceRelayerUser = "1000:1000" | ||
|
|
||
| // relativeHermesConfigFilePath is the path to the hermes config file relative to the home directory within the container. | ||
| relativeHermesConfigFilePath = ".hermes/config.toml" | ||
| ) | ||
|
|
||
| // Config holds configuration values for the relayer used in the tests. | ||
|
|
@@ -51,6 +57,87 @@ func New(t *testing.T, cfg Config, logger *zap.Logger, dockerClient *dockerclien | |
| } | ||
| } | ||
|
|
||
| // ApplyPacketFilter applies a packet filter to the hermes config file, which specifies a complete set of channels | ||
| // to watch for packets. | ||
| func ApplyPacketFilter(ctx context.Context, t *testing.T, r ibc.Relayer, chainID string, channels []ibc.ChannelOutput) error { | ||
| t.Helper() | ||
|
|
||
| h, ok := r.(*hermes.Relayer) | ||
| if !ok { | ||
| t.Logf("relayer %T does not support packet filtering, or it has not been implemented yet.", r) | ||
| return nil | ||
| } | ||
|
|
||
| return modifyHermesConfigFile(ctx, h, func(config map[string]interface{}) error { | ||
| chains, ok := config["chains"].([]map[string]interface{}) | ||
| if !ok { | ||
| return fmt.Errorf("failed to get chains from hermes config") | ||
| } | ||
| var chain map[string]interface{} | ||
| for _, c := range chains { | ||
| if c["id"] == chainID { | ||
| chain = c | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if chain == nil { | ||
| return fmt.Errorf("failed to find chain with id %s", chainID) | ||
| } | ||
|
|
||
| var channelIDs [][]string | ||
| for _, c := range channels { | ||
| channelIDs = append(channelIDs, []string{c.PortID, c.ChannelID}) | ||
| } | ||
|
|
||
| // [chains.packet_filter] | ||
| // # policy = 'allow' | ||
| // # list = [ | ||
| // # ['ica*', '*'], | ||
| // # ['transfer', 'channel-0'], | ||
| // # ] | ||
|
|
||
| // TODO(chatton): explicitly enable watching of ICA channels | ||
| // this will ensure the ICA tests pass, but this will need to be modified to make sure | ||
| // ICA tests will succeed in parallel. | ||
|
Comment on lines
+100
to
+102
There was a problem hiding this comment. I won't create another issue for this since it will be implicitly required to fix before our tests will pass in parallel |
||
| channelIDs = append(channelIDs, []string{"ica*", "*"}) | ||
|
|
||
| // we explicitly override the full list, this allows this function to provide a complete set of channels to watch. | ||
| chain["packet_filter"] = map[string]interface{}{ | ||
| "policy": "allow", | ||
| "list": channelIDs, | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
| } | ||
|
|
||
| // modifyHermesConfigFile reads the hermes config file, applies a modification function and returns an error if any. | ||
| func modifyHermesConfigFile(ctx context.Context, h *hermes.Relayer, modificationFn func(map[string]interface{}) error) error { | ||
|
There was a problem hiding this comment. Not sure if it would be any better or not, but interchaintest has some utility functions for modifying Toml files: There was a problem hiding this comment. good call, I think I reinvented the wheel here! There was a problem hiding this comment. |
||
| bz, err := h.ReadFileFromHomeDir(ctx, relativeHermesConfigFilePath) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to read hermes config file: %w", err) | ||
| } | ||
|
|
||
| var config map[string]interface{} | ||
| if err := toml.Unmarshal(bz, &config); err != nil { | ||
| return fmt.Errorf("failed to unmarshal hermes config bytes") | ||
| } | ||
|
|
||
| if modificationFn != nil { | ||
| if err := modificationFn(config); err != nil { | ||
| return fmt.Errorf("failed to modify hermes config: %w", err) | ||
| } | ||
| } | ||
|
|
||
| bz, err = toml.Marshal(config) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to marshal hermes config bytes") | ||
| } | ||
|
|
||
| return h.WriteFileToHomeDir(ctx, relativeHermesConfigFilePath, bz) | ||
| } | ||
|
|
||
| // newCosmosRelayer returns an instance of the go relayer. | ||
| // Options are used to allow for relayer version selection and specifying the default processing option. | ||
| func newCosmosRelayer(t *testing.T, tag string, logger *zap.Logger, dockerClient *dockerclient.Client, network, relayerImage string) ibc.Relayer { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
caught me off guard a bit with the 2d slice. Each
[]stringcontained within is a portID/channelID tuple?little nit, but could name this
channelEndpointsor something similarThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah good call, it's not actually the ids :D