feat: add the ability to manage sidecar processes

[jtieri]

There are cases where it is necessary to run some sidecar process on a per validator basis and/or on a chain basis. One example of this is the orchestrator needed to run a Sommelier validator. This PR introduces the concept of a SidecarProcess which can be scoped either at the chain level or at the validator level.

SidecarProcesses can optionally be started before the chain or validator node starts or explicitly started after the chain or validator is started.

[agouin]

This a great abstraction and will be extremely useful for chains that have additional processes.

Left a comment about potentially automatically storing new sidecars into the Chain/ChainNode slices.

It would also be great to wire up sidecar config in the ChainConfig so that they can be configured there.

[agouin]

This covers chain-level sidecars, but can you include an additional slice for per-node sidecars?

[jtieri]

I was handling all sidcars from this single slice by using the bool field ValidatorProcess. the way I imagined this would work is people would instantiate the sidcars and add them to the slice, for any sidecar that should be scoped at a validator level ValidatorProcess will be true

Chain level sidecars are handled here

interchaintest/chain/cosmos/cosmos_chain.go

Lines 697 to 725 in 7d8dff5

	func (c *CosmosChain) initializeSidecars(
	ctx context.Context,
	testName string,
	cli *client.Client,
	networkID string,
	) error {
	eg, egCtx := errgroup.WithContext(ctx)
	for i, cfg := range c.cfg.SidecarConfigs {
	i := i
	cfg := cfg
	if cfg.ValidatorProcess {
	continue
	}
	eg.Go(func() error {
	err := c.NewSidecarProcess(egCtx, cfg.PreStart, cfg.ProcessName, testName, cli, networkID, cfg.Image, i, cfg.Ports, cfg.StartCmd)
	if err != nil {
	return err
	}
	return nil
	})
	}
	if err := eg.Wait(); err != nil {
	return err
	}
	return nil
	}

and then the validator sidecars are handled here

interchaintest/chain/cosmos/cosmos_chain.go

Lines 587 to 596 in 7d8dff5

	for _, cfg := range c.cfg.SidecarConfigs {
	if !cfg.ValidatorProcess {
	continue
	}
	err = tn.NewSidecarProcess(ctx, cfg.PreStart, cfg.ProcessName, testName, cli, networkID, cfg.Image, cfg.Ports, cfg.StartCmd)
	if err != nil {
	return nil, err
	}
	}

im indifferent to the path forward here and can definitely see the benefits of making this more explicit so if you think thats a better design i can make those changes

[aljo242]

@jtieri I think you will need to add the following logic to ChainConfig.Clone() in ibc/types.go

func (c ChainConfig) Clone() ChainConfig {
	x := c

	images := make([]DockerImage, len(c.Images))
	copy(images, c.Images)
	x.Images = images

	sidecars := make([]SidecarConfig, len(c.SidecarConfigs))
	copy(sidecars, c.SidecarConfigs)
	x.SidecarConfigs = sidecars

	return x
}

And the following to MergeChainSpecConfig()

...
	if len(other.SidecarConfigs) > 0 {
		c.SidecarConfigs = append([]SidecarConfig(nil), other.SidecarConfigs...)
	}

[jtieri]

grazie! I'm picking this back up so will get this added in there

[aljo242]

@jtieri any updates on this?

[agouin]

🚀

[boojamya]

@Mergifyio backport v6

[mergify]

backport v6

✅ Backports have been created

• #712 feat: add the ability to manage sidecar processes (backport #465) has been created for branch v6 but encountered conflicts