feat: add option to set offchain client for test environment (#508)

Adds a new option to the test environment loader:

- `WithOffchainClient` option to set an offchain client into the test
environment

This allows for more flexibility in the test environment setup where the
user may have an existing offchain client they want to provide into the
environment for testing.

Author: jkongie

.changeset/pretty-cities-agree.md

@@ -0,0 +1,7 @@
+---
+"chainlink-deployments-framework": minor
+---
+
+Adds a new option to test engine environment loading for setting an offchain client.
+
+- `WithOffchainClient` option to set an offchain client into the test environment

engine/test/environment/components.go

@@ -8,16 +8,18 @@ import (
 	fchain "github.com/smartcontractkit/chainlink-deployments-framework/chain"
 	fdatastore "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
 	fdeployment "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
+	foffchain "github.com/smartcontractkit/chainlink-deployments-framework/offchain"
 )
 
 // components is a struct that contains the components of the environment.
 type components struct {
 	mu sync.Mutex
 
-	Chains      []fchain.BlockChain
-	AddressBook fdeployment.AddressBook
-	Datastore   fdatastore.DataStore
-	Logger      logger.Logger
+	Chains         []fchain.BlockChain
+	AddressBook    fdeployment.AddressBook
+	Datastore      fdatastore.DataStore
+	OffchainClient foffchain.Client
+	Logger         logger.Logger
 }
 
 // newComponents creates a new components instance.

engine/test/environment/environment.go

@@ -56,6 +56,10 @@ func (l *Loader) Load(ctx context.Context, opts ...LoadOpt) (*fdeployment.Enviro
 		ab = fdeployment.NewMemoryAddressBook()
 	}
 
+	// We do not set any default offchain client as it is not required for all tests.
+	// We may want to set a default memory based offchain client in the future.
+	oc := cmps.OffchainClient
+
 	return &fdeployment.Environment{
 		Name:              environmentName,
 		Logger:            cmps.Logger,
@@ -64,7 +68,7 @@ func (l *Loader) Load(ctx context.Context, opts ...LoadOpt) (*fdeployment.Enviro
 		DataStore:         ds,
 		Catalog:           nil,        // Unimplemented for now
 		NodeIDs:           []string{}, // Unimplemented for now
-		Offchain:          nil,        // Unimplemented for now
+		Offchain:          oc,
 		GetContext:        getCtx,
 		OCRSecrets:        focr.XXXGenerateTestOCRSecrets(),
 		OperationsBundle:  foperations.NewBundle(getCtx, cmps.Logger, foperations.NewMemoryReporter()),

engine/test/environment/environment_test.go

@@ -20,6 +20,7 @@ import (
 	fdatastore "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
 	fdeployment "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
 	"github.com/smartcontractkit/chainlink-deployments-framework/engine/test/onchain"
+	foffchainjd "github.com/smartcontractkit/chainlink-deployments-framework/offchain/jd"
 )
 
 func TestNew(t *testing.T) {
@@ -122,6 +123,18 @@ func TestLoader_Load_DatastoreOption(t *testing.T) {
 	require.Equal(t, ds, env.DataStore)
 }
 
+func TestLoader_Load_OffchainClientOption(t *testing.T) {
+	t.Parallel()
+
+	oc := &foffchainjd.JobDistributor{}
+
+	loader := NewLoader()
+	env, err := loader.Load(t.Context(), WithOffchainClient(oc))
+	require.NoError(t, err)
+	require.NotNil(t, env)
+	require.Equal(t, oc, env.Offchain)
+}
+
 func TestLoader_Load_AddressBookOption(t *testing.T) {
 	t.Parallel()
 

engine/test/environment/options.go

@@ -8,6 +8,7 @@ import (
 	fdatastore "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
 	fdeployment "github.com/smartcontractkit/chainlink-deployments-framework/deployment"
 	"github.com/smartcontractkit/chainlink-deployments-framework/engine/test/onchain"
+	"github.com/smartcontractkit/chainlink-deployments-framework/offchain"
 )
 
 // Assign the chain container loader constructors to local variables to allow for stubbing in tests.
@@ -170,6 +171,14 @@ func WithAddressBook(ab fdeployment.AddressBook) LoadOpt {
 	}
 }
 
+// WithOffchainClient sets a custom offchain client for the environment.
+func WithOffchainClient(oc offchain.Client) LoadOpt {
+	return func(cmps *components) error {
+		cmps.OffchainClient = oc
+		return nil
+	}
+}
+
 // withChainLoader creates a LoadOpt that loads chains using the provided loader and selectors.
 func withChainLoader(t *testing.T, loader *onchain.ChainLoader, selectors []uint64) LoadOpt {
 	t.Helper()