[DX-2252] Allow to pass context to all components' constructors (#2216)

Author: Tofel

framework/.changeset/v0.11.6.md

@@ -0,0 +1 @@
+- Allow to pass context to all components' constructors

framework/components/blockchain/anvil.go

@@ -1,6 +1,7 @@
 package blockchain
 
 import (
+	"context"
 	"strings"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
@@ -31,8 +32,7 @@ func defaultAnvil(in *Input) {
 	}
 }
 
-// newAnvil deploy foundry anvil node
-func newAnvil(in *Input) (*Output, error) {
+func newAnvil(ctx context.Context, in *Input) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
@@ -50,5 +50,5 @@ func newAnvil(in *Input) (*Output, error) {
 
 	framework.L.Info().Any("Cmd", strings.Join(entryPoint, " ")).Msg("Creating anvil with command")
 
-	return createGenericEvmContainer(in, req, false)
+	return createGenericEvmContainer(ctx, in, req, false)
 }

framework/components/blockchain/anvil_zksync.go

@@ -1,6 +1,7 @@
 package blockchain
 
 import (
+	"context"
 	"os"
 	"path/filepath"
 	"strings"
@@ -41,7 +42,7 @@ RUN curl -L https://raw.githubusercontent.com/matter-labs/foundry-zksync/main/in
 // creating a dockerfile in a temporary directory with the necessary commands to install
 // foundry-zksync.
 // see: https://foundry-book.zksync.io/getting-started/installation#using-foundry-with-docker
-func newAnvilZksync(in *Input) (*Output, error) {
+func newAnvilZksync(ctx context.Context, in *Input) (*Output, error) {
 	defaultAnvilZksync(in)
 	req := baseRequest(in, WithoutWsEndpoint)
 
@@ -77,7 +78,7 @@ func newAnvilZksync(in *Input) (*Output, error) {
 
 	framework.L.Info().Any("Cmd", strings.Join(req.Entrypoint, " ")).Msg("Creating anvil zkSync with command")
 
-	output, err := createGenericEvmContainer(in, req, false)
+	output, err := createGenericEvmContainer(ctx, in, req, false)
 	if err != nil {
 		return nil, err
 	}

framework/components/blockchain/aptos.go

@@ -50,9 +50,8 @@ func defaultAptos(in *Input) {
 	}
 }
 
-func newAptos(in *Input) (*Output, error) {
+func newAptos(ctx context.Context, in *Input) (*Output, error) {
 	defaultAptos(in)
-	ctx := context.Background()
 	containerName := framework.DefaultTCName("blockchain-node")
 
 	absPath, err := filepath.Abs(in.ContractsDir)
@@ -129,12 +128,12 @@ func newAptos(in *Input) (*Output, error) {
 		return nil, err
 	}
 	cmdStr := []string{"aptos", "init", "--network=local", "--assume-yes", fmt.Sprintf("--private-key=%s", DefaultAptosPrivateKey)}
-	_, err = dc.ExecContainer(containerName, cmdStr)
+	_, err = dc.ExecContainerWithContext(ctx, containerName, cmdStr)
 	if err != nil {
 		return nil, err
 	}
 	fundCmd := []string{"aptos", "account", "fund-with-faucet", "--account", DefaultAptosAccount, "--amount", "1000000000000"}
-	_, err = dc.ExecContainer(containerName, fundCmd)
+	_, err = dc.ExecContainerWithContext(ctx, containerName, fundCmd)
 	if err != nil {
 		return nil, err
 	}

framework/components/blockchain/besu.go

@@ -1,5 +1,7 @@
 package blockchain
 
+import "context"
+
 const (
 	DefaultBesuPrivateKey1 = "8f2a55949038a9610f50fb23b5883af3b4ecb3c3bb792cbcefbd1542c692be63"
 	DefaultBesuPrivateKey2 = "c87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3"
@@ -24,7 +26,7 @@ func defaultBesu(in *Input) {
 	}
 }
 
-func newBesu(in *Input) (*Output, error) {
+func newBesu(ctx context.Context, in *Input) (*Output, error) {
 	defaultBesu(in)
 	req := baseRequest(in, WithWsEndpoint)
 
@@ -48,5 +50,5 @@ func newBesu(in *Input) (*Output, error) {
 	entryPoint := append(defaultCmd, in.DockerCmdParamsOverrides...)
 	req.Cmd = entryPoint
 
-	return createGenericEvmContainer(in, req, true)
+	return createGenericEvmContainer(ctx, in, req, true)
 }

framework/components/blockchain/blockchain.go

@@ -1,6 +1,7 @@
 package blockchain
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/testcontainers/testcontainers-go"
@@ -93,29 +94,34 @@ type Node struct {
 	InternalHTTPUrl string `toml:"internal_http_url"`
 }
 
-// NewBlockchainNetwork this is an abstraction that can spin up various blockchain network simulators
 func NewBlockchainNetwork(in *Input) (*Output, error) {
+	// pass context to input if needed in the future
+	return NewWithContext(context.Background(), in)
+}
+
+// NewBlockchainNetwork this is an abstraction that can spin up various blockchain network simulators
+func NewWithContext(ctx context.Context, in *Input) (*Output, error) {
 	var out *Output
 	var err error
 	switch in.Type {
 	case TypeAnvil:
-		out, err = newAnvil(in)
+		out, err = newAnvil(ctx, in)
 	case TypeGeth:
-		out, err = newGeth(in)
+		out, err = newGeth(ctx, in)
 	case TypeBesu:
-		out, err = newBesu(in)
+		out, err = newBesu(ctx, in)
 	case TypeSolana:
-		out, err = newSolana(in)
+		out, err = newSolana(ctx, in)
 	case TypeAptos:
-		out, err = newAptos(in)
+		out, err = newAptos(ctx, in)
 	case TypeSui:
-		out, err = newSui(in)
+		out, err = newSui(ctx, in)
 	case TypeTron:
-		out, err = newTron(in)
+		out, err = newTron(ctx, in)
 	case TypeAnvilZKSync:
-		out, err = newAnvilZksync(in)
+		out, err = newAnvilZksync(ctx, in)
 	case TypeTon:
-		out, err = newTon(in)
+		out, err = newTon(ctx, in)
 	default:
 		return nil, fmt.Errorf("blockchain type is not supported or empty, must be 'anvil' or 'geth'")
 	}

framework/components/blockchain/containers.go

@@ -65,8 +65,7 @@ func baseRequest(in *Input, useWS ExposeWs) testcontainers.ContainerRequest {
 	return req
 }
 
-func createGenericEvmContainer(in *Input, req testcontainers.ContainerRequest, useWS bool) (*Output, error) {
-	ctx := context.Background()
+func createGenericEvmContainer(ctx context.Context, in *Input, req testcontainers.ContainerRequest, useWS bool) (*Output, error) {
 	c, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
 		ContainerRequest: req,
 		Started:          true,
@@ -75,7 +74,7 @@ func createGenericEvmContainer(in *Input, req testcontainers.ContainerRequest, u
 		return nil, err
 	}
 
-	host, err := framework.GetHost(c)
+	host, err := framework.GetHostWithContext(ctx, c)
 	if err != nil {
 		return nil, err
 	}

framework/components/blockchain/geth.go

@@ -1,6 +1,7 @@
 package blockchain
 
 import (
+	"context"
 	"fmt"
 	"os"
 
@@ -77,7 +78,7 @@ func defaultGeth(in *Input) {
 	}
 }
 
-func newGeth(in *Input) (*Output, error) {
+func newGeth(ctx context.Context, in *Input) (*Output, error) {
 	defaultGeth(in)
 	req := baseRequest(in, WithoutWsEndpoint)
 	defaultCmd := []string{
@@ -184,5 +185,5 @@ func newGeth(in *Input) (*Output, error) {
 	}
 	req.Cmd = entryPoint
 
-	return createGenericEvmContainer(in, req, false)
+	return createGenericEvmContainer(ctx, in, req, false)
 }

framework/components/blockchain/solana.go

@@ -43,12 +43,11 @@ func defaultSolana(in *Input) {
 	}
 }
 
-func newSolana(in *Input) (*Output, error) {
+func newSolana(ctx context.Context, in *Input) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
 	defaultSolana(in)
-	ctx := context.Background()
 
 	containerName := framework.DefaultTCName("blockchain-node")
 	// Solana do not allow to set ws port, it just uses --rpc-port=N and sets WS as N+1 automatically
@@ -140,7 +139,7 @@ func newSolana(in *Input) (*Output, error) {
 	if err != nil {
 		return nil, err
 	}
-	host, err := framework.GetHost(c)
+	host, err := framework.GetHostWithContext(ctx, c)
 	if err != nil {
 		return nil, err
 	}

framework/components/blockchain/sui.go

@@ -54,13 +54,13 @@ func fundAccount(url string, address string) error {
 }
 
 // generateKeyData generates a wallet and returns all the data
-func generateKeyData(containerName string, keyCipherType string) (*SuiWalletInfo, error) {
+func generateKeyData(ctx context.Context, containerName string, keyCipherType string) (*SuiWalletInfo, error) {
 	cmdStr := []string{"sui", "keytool", "generate", keyCipherType, "--json"}
 	dc, err := framework.NewDockerClient()
 	if err != nil {
 		return nil, err
 	}
-	keyOut, err := dc.ExecContainer(containerName, cmdStr)
+	keyOut, err := dc.ExecContainerWithContext(ctx, containerName, cmdStr)
 	if err != nil {
 		return nil, err
 	}
@@ -90,9 +90,8 @@ func defaultSui(in *Input) {
 	}
 }
 
-func newSui(in *Input) (*Output, error) {
+func newSui(ctx context.Context, in *Input) (*Output, error) {
 	defaultSui(in)
-	ctx := context.Background()
 	containerName := framework.DefaultTCName("blockchain-node")
 
 	absPath, err := filepath.Abs(in.ContractsDir)
@@ -167,7 +166,7 @@ func newSui(in *Input) (*Output, error) {
 	if err != nil {
 		return nil, err
 	}
-	suiAccount, err := generateKeyData(containerName, "ed25519")
+	suiAccount, err := generateKeyData(ctx, containerName, "ed25519")
 	if err != nil {
 		return nil, err
 	}