feat: add option to set NodeIDs for test environment (#512)

Adds a new option to the test environment loader:

- `WithNodeIDs` option to set NodeIDs into the test environment

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

Author: jkongie

.changeset/solid-apples-carry.md

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

engine/test/environment/components.go

@@ -19,6 +19,7 @@ type components struct {
 	AddressBook    fdeployment.AddressBook
 	Datastore      fdatastore.DataStore
 	OffchainClient foffchain.Client
+	NodeIDs        []string
 	Logger         logger.Logger
 }
 

engine/test/environment/environment.go

@@ -56,6 +56,11 @@ func (l *Loader) Load(ctx context.Context, opts ...LoadOpt) (*fdeployment.Enviro
 		ab = fdeployment.NewMemoryAddressBook()
 	}
 
+	nodeIDs := cmps.NodeIDs
+	if len(nodeIDs) == 0 {
+		nodeIDs = []string{}
+	}
+
 	// 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
@@ -66,8 +71,8 @@ func (l *Loader) Load(ctx context.Context, opts ...LoadOpt) (*fdeployment.Enviro
 		BlockChains:       fchain.NewBlockChainsFromSlice(cmps.Chains),
 		ExistingAddresses: ab,
 		DataStore:         ds,
-		Catalog:           nil,        // Unimplemented for now
-		NodeIDs:           []string{}, // Unimplemented for now
+		Catalog:           nil, // Unimplemented for now
+		NodeIDs:           nodeIDs,
 		Offchain:          oc,
 		GetContext:        getCtx,
 		OCRSecrets:        focr.XXXGenerateTestOCRSecrets(),

engine/test/environment/environment_test.go

@@ -135,6 +135,18 @@ func TestLoader_Load_OffchainClientOption(t *testing.T) {
 	require.Equal(t, oc, env.Offchain)
 }
 
+func TestLoader_Load_NodeIDsOption(t *testing.T) {
+	t.Parallel()
+
+	nodeIDs := []string{"1", "2", "3"}
+
+	loader := NewLoader()
+	env, err := loader.Load(t.Context(), WithNodeIDs(nodeIDs))
+	require.NoError(t, err)
+	require.NotNil(t, env)
+	require.Equal(t, nodeIDs, env.NodeIDs)
+}
+
 func TestLoader_Load_AddressBookOption(t *testing.T) {
 	t.Parallel()
 

engine/test/environment/options.go

@@ -179,6 +179,14 @@ func WithOffchainClient(oc offchain.Client) LoadOpt {
 	}
 }
 
+// WithNodeIDs sets a custom node IDs for the environment.
+func WithNodeIDs(nodeIDs []string) LoadOpt {
+	return func(cmps *components) error {
+		cmps.NodeIDs = nodeIDs
+		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()