allow passing context to all components' constructors

Tofel · Tofel · commit 08ed5b6778ba · 2025-10-28T17:59:47.000+01:00
diff --git a/framework/components/blockchain/anvil.go b/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)
 }
diff --git a/framework/components/blockchain/anvil_zksync.go b/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
 	}
diff --git a/framework/components/blockchain/aptos.go b/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)
diff --git a/framework/components/blockchain/besu.go b/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)
 }
diff --git a/framework/components/blockchain/blockchain.go b/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'")
 	}
diff --git a/framework/components/blockchain/containers.go b/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,
diff --git a/framework/components/blockchain/geth.go b/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)
 }
diff --git a/framework/components/blockchain/solana.go b/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
diff --git a/framework/components/blockchain/sui.go b/framework/components/blockchain/sui.go
@@ -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)
diff --git a/framework/components/blockchain/ton.go b/framework/components/blockchain/ton.go
@@ -40,7 +40,7 @@ func defaultTon(in *Input) {
 	}
 }
 
-func newTon(in *Input) (*Output, error) {
+func newTon(ctx context.Context, in *Input) (*Output, error) {
 	defaultTon(in)
 
 	base, err := strconv.Atoi(in.Port)
@@ -53,8 +53,6 @@ func newTon(in *Input) (*Output, error) {
 		LiteServer: strconv.Itoa(base + liteServerPortOffset),
 	}
 
-	ctx := context.Background()
-
 	network, err := network.New(ctx,
 		network.WithAttachable(),
 		network.WithLabels(framework.DefaultTCLabels()),
diff --git a/framework/components/blockchain/tron.go b/framework/components/blockchain/tron.go
@@ -55,12 +55,11 @@ func defaultTron(in *Input) {
 	}
 }
 
-func newTron(in *Input) (*Output, error) {
+func newTron(ctx context.Context, in *Input) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
 	defaultTron(in)
-	ctx := context.Background()
 
 	containerName := framework.DefaultTCName("blockchain-node")
 	// Tron container always listens on port 9090 internally
diff --git a/framework/components/clnode/clnode.go b/framework/components/clnode/clnode.go
@@ -88,14 +88,20 @@ type NodeOut struct {
 // NewNodeWithDB create a new Chainlink node with some image:tag and one or several configs
 // see config params: TestConfigOverrides, UserConfigOverrides, etc
 func NewNodeWithDB(in *Input) (*Output, error) {
+	return NewNodeWithDBAndContext(context.Background(), in)
+}
+
+// NewNodeWithDBAndContext create a new Chainlink node with some image:tag and one or several configs
+// see config params: TestConfigOverrides, UserConfigOverrides, etc
+func NewNodeWithDBAndContext(ctx context.Context, in *Input) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
 	pgOut, err := postgres.NewPostgreSQL(in.DbInput)
 	if err != nil {
 		return nil, err
 	}
-	nodeOut, err := newNode(in, pgOut)
+	nodeOut, err := newNode(ctx, in, pgOut)
 	if err != nil {
 		return nil, err
 	}
@@ -109,10 +115,14 @@ func NewNodeWithDB(in *Input) (*Output, error) {
 }
 
 func NewNode(in *Input, pgOut *postgres.Output) (*Output, error) {
+	return NewNodeWithContext(context.Background(), in, pgOut)
+}
+
+func NewNodeWithContext(ctx context.Context, in *Input, pgOut *postgres.Output) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
-	nodeOut, err := newNode(in, pgOut)
+	nodeOut, err := newNode(ctx, in, pgOut)
 	if err != nil {
 		return nil, err
 	}
@@ -193,9 +203,7 @@ func generatePortBindings(in *Input) ([]string, nat.PortMap, error) {
 	return exposedPorts, portBindings, nil
 }
 
-func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
-	ctx := context.Background()
-
+func newNode(ctx context.Context, in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 	passwordPath, err := WriteTmpFile(DefaultPasswordTxt, "password.txt")
 	if err != nil {
 		return nil, err
diff --git a/framework/components/dockercompose/billing_platform_service/billing_platform_service.go b/framework/components/dockercompose/billing_platform_service/billing_platform_service.go
@@ -77,6 +77,18 @@ const (
 //   - STREAMS_API_KEY = API key if using a staging or prod Streams API
 //   - STREAMS_API_SECRET = API secret if using a staging or prod Streams API
 func New(in *Input) (*Output, error) {
+	return NewWithContext(context.Background(), in)
+}
+
+// NewWithContext starts a Billing Platform Service stack using docker-compose. Various env vars are set to sensible defaults and
+// input values, but can be overridden by the host process env vars if needed.
+//
+// Import env vars that can be set to override defaults:
+//   - TEST_OWNERS = comma separated list of workflow owners
+//   - STREAMS_API_URL = URL for the Streams API; can use a mock server if needed
+//   - STREAMS_API_KEY = API key if using a staging or prod Streams API
+//   - STREAMS_API_SECRET = API secret if using a staging or prod Streams API
+func NewWithContext(ctx context.Context, in *Input) (*Output, error) {
 	if in == nil {
 		return nil, errors.New("input is nil")
 	}
@@ -104,7 +116,7 @@ func New(in *Input) (*Output, error) {
 		return nil, errors.Wrap(stackErr, "failed to create compose stack for Billing Platform Service")
 	}
 
-	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
+	ctx, cancel := context.WithTimeout(ctx, 2*time.Minute)
 	defer cancel()
 
 	// Start the stackwith all environment variables from the host process
diff --git a/framework/components/dockercompose/chip_ingress_set/chip_ingress.go b/framework/components/dockercompose/chip_ingress_set/chip_ingress.go
@@ -66,6 +66,10 @@ const (
 )
 
 func New(in *Input) (*Output, error) {
+	return NewWithContext(context.Background(), in)
+}
+
+func NewWithContext(ctx context.Context, in *Input) (*Output, error) {
 	if in == nil {
 		return nil, errors.New("input is nil")
 	}
@@ -93,7 +97,7 @@ func New(in *Input) (*Output, error) {
 		return nil, errors.Wrap(stackErr, "failed to create compose stack for Chip Ingress")
 	}
 
-	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
+	ctx, cancel := context.WithTimeout(ctx, 2*time.Minute)
 	defer cancel()
 
 	// Start the stackwith all environment variables from the host process
@@ -220,7 +224,7 @@ func New(in *Input) (*Output, error) {
 	in.UseCache = true
 	framework.L.Info().Msg("Chip Ingress stack started")
 
-	return output, checkSchemaRegistryReadiness(2*time.Minute, 300*time.Millisecond, output.RedPanda.SchemaRegistryExternalURL, 3)
+	return output, checkSchemaRegistryReadiness(ctx, 2*time.Minute, 300*time.Millisecond, output.RedPanda.SchemaRegistryExternalURL, 3)
 }
 
 func composeFilePath(rawFilePath string) (string, error) {
@@ -284,7 +288,7 @@ func connectNetwork(connCtx context.Context, timeout time.Duration, dockerClient
 
 // checkSchemaRegistryReadiness verifies that the Schema Registry answers 2xx on GET /subjects
 // for minSuccessCount *consecutive* attempts, polling every `interval`, with an overall `timeout`.
-func checkSchemaRegistryReadiness(timeout, interval time.Duration, registryURL string, minSuccessCount int) error {
+func checkSchemaRegistryReadiness(ctx context.Context, timeout, interval time.Duration, registryURL string, minSuccessCount int) error {
 	if minSuccessCount < 1 {
 		minSuccessCount = 1
 	}
@@ -312,7 +316,7 @@ func checkSchemaRegistryReadiness(timeout, interval time.Duration, registryURL s
 		Timeout:   10 * time.Second, // per-request timeout
 	}
 
-	ctx, cancel := context.WithTimeout(context.Background(), timeout)
+	ctx, cancel := context.WithTimeout(ctx, timeout)
 	defer cancel()
 
 	t := time.NewTicker(interval)
diff --git a/framework/components/fake/container.go b/framework/components/fake/container.go
@@ -14,10 +14,14 @@ import (
 
 // NewDockerFakeDataProvider creates new fake data provider in Docker using testcontainers-go
 func NewDockerFakeDataProvider(in *Input) (*Output, error) {
+	return NewWithContext(context.Background(), in)
+}
+
+// NewWithContext creates new fake data provider in Docker using testcontainers-go
+func NewWithContext(ctx context.Context, in *Input) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
-	ctx := context.Background()
 	bindPort := fmt.Sprintf("%d/tcp", in.Port)
 	containerName := framework.DefaultTCName("fake")
 	req := tc.ContainerRequest{
diff --git a/framework/components/jd/jd.go b/framework/components/jd/jd.go
@@ -66,10 +66,13 @@ func defaultJDDB() *postgres.Input {
 }
 
 func NewJD(in *Input) (*Output, error) {
+	return NewWithContext(context.Background(), in)
+}
+
+func NewWithContext(ctx context.Context, in *Input) (*Output, error) {
 	if in.Out != nil && in.Out.UseCache {
 		return in.Out, nil
 	}
-	ctx := context.Background()
 	defaults(in)
 	jdImg := os.Getenv("CTF_JD_IMAGE")
 	if jdImg != "" {
diff --git a/framework/components/networktest/nettest.go b/framework/components/networktest/nettest.go
diff --git a/framework/components/postgres/postgres.go b/framework/components/postgres/postgres.go
diff --git a/framework/components/s3provider/interfaces.go b/framework/components/s3provider/interfaces.go
diff --git a/framework/components/s3provider/minio.go b/framework/components/s3provider/minio.go
diff --git a/framework/components/simple_node_set/fund.go b/framework/components/simple_node_set/fund.go
diff --git a/framework/components/simple_node_set/node_set.go b/framework/components/simple_node_set/node_set.go

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package blockchain`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
`4`	`5`	`"strings"`
`5`	`6`
`6`	`7`	`"github.com/smartcontractkit/chainlink-testing-framework/framework"`
`@@ -31,8 +32,7 @@ func defaultAnvil(in *Input) {`
`31`	`32`	`}`
`32`	`33`	`}`
`33`	`34`
`34`		`-// newAnvil deploy foundry anvil node`
`35`		`-func newAnvil(in Input) (Output, error) {`
	`35`	`+func newAnvil(ctx context.Context, in Input) (Output, error) {`
`36`	`36`	`if in.Out != nil && in.Out.UseCache {`
`37`	`37`	`return in.Out, nil`
`38`	`38`	`}`
`@@ -50,5 +50,5 @@ func newAnvil(in Input) (Output, error) {`
`50`	`50`
`51`	`51`	`framework.L.Info().Any("Cmd", strings.Join(entryPoint, " ")).Msg("Creating anvil with command")`
`52`	`52`
`53`		`- return createGenericEvmContainer(in, req, false)`
	`53`	`+ return createGenericEvmContainer(ctx, in, req, false)`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,9 +50,8 @@ func defaultAptos(in *Input) {`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`
`53`		`-func newAptos(in Input) (Output, error) {`
	`53`	`+func newAptos(ctx context.Context, in Input) (Output, error) {`
`54`	`54`	`defaultAptos(in)`
`55`		`- ctx := context.Background()`
`56`	`55`	`containerName := framework.DefaultTCName("blockchain-node")`
`57`	`56`
`58`	`57`	`absPath, err := filepath.Abs(in.ContractsDir)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package blockchain`
`2`	`2`
	`3`	`+import "context"`
	`4`	`+`
`3`	`5`	`const (`
`4`	`6`	`DefaultBesuPrivateKey1 = "8f2a55949038a9610f50fb23b5883af3b4ecb3c3bb792cbcefbd1542c692be63"`
`5`	`7`	`DefaultBesuPrivateKey2 = "c87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3"`
`@@ -24,7 +26,7 @@ func defaultBesu(in *Input) {`
`24`	`26`	`}`
`25`	`27`	`}`
`26`	`28`
`27`		`-func newBesu(in Input) (Output, error) {`
	`29`	`+func newBesu(ctx context.Context, in Input) (Output, error) {`
`28`	`30`	`defaultBesu(in)`
`29`	`31`	`req := baseRequest(in, WithWsEndpoint)`
`30`	`32`
`@@ -48,5 +50,5 @@ func newBesu(in Input) (Output, error) {`
`48`	`50`	`entryPoint := append(defaultCmd, in.DockerCmdParamsOverrides...)`
`49`	`51`	`req.Cmd = entryPoint`
`50`	`52`
`51`		`- return createGenericEvmContainer(in, req, true)`
	`53`	`+ return createGenericEvmContainer(ctx, in, req, true)`
`52`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,7 @@ func baseRequest(in *Input, useWS ExposeWs) testcontainers.ContainerRequest {`
`65`	`65`	`return req`
`66`	`66`	`}`
`67`	`67`
`68`		`-func createGenericEvmContainer(in Input, req testcontainers.ContainerRequest, useWS bool) (Output, error) {`
`69`		`- ctx := context.Background()`
	`68`	`+func createGenericEvmContainer(ctx context.Context, in Input, req testcontainers.ContainerRequest, useWS bool) (Output, error) {`
`70`	`69`	`c, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{`
`71`	`70`	`ContainerRequest: req,`
`72`	`71`	`Started: true,`
Original file line number	Diff line number	Diff line change
`@@ -43,12 +43,11 @@ func defaultSolana(in *Input) {`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`46`		`-func newSolana(in Input) (Output, error) {`
	`46`	`+func newSolana(ctx context.Context, in Input) (Output, error) {`
`47`	`47`	`if in.Out != nil && in.Out.UseCache {`
`48`	`48`	`return in.Out, nil`
`49`	`49`	`}`
`50`	`50`	`defaultSolana(in)`
`51`		`- ctx := context.Background()`
`52`	`51`
`53`	`52`	`containerName := framework.DefaultTCName("blockchain-node")`
`54`	`53`	`// Solana do not allow to set ws port, it just uses --rpc-port=N and sets WS as N+1 automatically`
Original file line number	Diff line number	Diff line change
`@@ -90,9 +90,8 @@ func defaultSui(in *Input) {`
`90`	`90`	`}`
`91`	`91`	`}`
`92`	`92`
`93`		`-func newSui(in Input) (Output, error) {`
	`93`	`+func newSui(ctx context.Context, in Input) (Output, error) {`
`94`	`94`	`defaultSui(in)`
`95`		`- ctx := context.Background()`
`96`	`95`	`containerName := framework.DefaultTCName("blockchain-node")`
`97`	`96`
`98`	`97`	`absPath, err := filepath.Abs(in.ContractsDir)`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ func defaultTon(in *Input) {`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`
`43`		`-func newTon(in Input) (Output, error) {`
	`43`	`+func newTon(ctx context.Context, in Input) (Output, error) {`
`44`	`44`	`defaultTon(in)`
`45`	`45`
`46`	`46`	`base, err := strconv.Atoi(in.Port)`
`@@ -53,8 +53,6 @@ func newTon(in Input) (Output, error) {`
`53`	`53`	`LiteServer: strconv.Itoa(base + liteServerPortOffset),`
`54`	`54`	`}`
`55`	`55`
`56`		`- ctx := context.Background()`
`57`		`-`
`58`	`56`	`network, err := network.New(ctx,`
`59`	`57`	`network.WithAttachable(),`
`60`	`58`	`network.WithLabels(framework.DefaultTCLabels()),`