Merge branch 'main' into TT-1955-Create-page-for-flaky-e2e-tests-tips-tricks-and-share-with-developers-and-QA

Author: lukaszcl

.github/workflows/docker-test.yaml

@@ -5,7 +5,7 @@ on:
   pull_request:
     types: [labeled]
     paths-ignore:
-      - 'tools/**'    
+      - 'tools/**'
 
 jobs:
   eth_env:
@@ -26,12 +26,11 @@ jobs:
       - name: Checkout the Repo
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
       - name: Install Go
-        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/setup-go@d2f9642bcc24a73400568756f24b72c188ac7a9a # v2.3.31
+        uses: smartcontractkit/.github/actions/setup-golang@01d931b0455a754d12e7143cc54a5a3521a8f6f6 #v 0.3.1
         with:
-          test_download_vendor_packages_command: cd lib && go mod download
-          go_mod_path: ./lib/go.mod
-          cache_key_id: ctf-go
-          cache_restore_only: 'false'
+          # test_download_vendor_packages_command: cd lib && go mod download
+          go-version-file: ./lib/go.mod
+          use-go-cache: "true"
       - name: Install gotestloghelper
         working-directory: lib
         run: make gotestloghelper_build

book/src/SUMMARY.md

@@ -4,9 +4,8 @@
 - [Framework](./framework/overview.md)
   - [Getting Started](./framework/getting_started.md)
   - [Your First Test](./framework/first_test.md)
-  - [Connecting Chainlink Node](./framework/connecting_chainlink_node.md)
-  - [Connecting Chainlink Node (Multiple networks)]()
   - [NodeSet Environment](./framework/nodeset_environment.md)
+  - [NodeSet Environment (Import Keys)](./framework/nodeset_environment_import.md)
   - [NodeSet with Capabilities](./framework/nodeset_capabilities.md)
   - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
   - [NodeSet Compat Environment](./framework/nodeset_compatibility.md)

book/src/framework/nodeset_environment_import.md

@@ -0,0 +1,5 @@
+# NodeSet Environment (Import Keys)
+
+If your tests are designed to run not just within a Docker environment but also with external infrastructure, and you want to reuse the test logic across different environments or securely store private keys, refer to the example below.
+
+[Import Keys Example](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/smoke_import_keys_test.go)

framework/.changeset/v0.5.4.md

@@ -0,0 +1,2 @@
+- Update WASP doc (rate limiting numerator)
+- Expose config validator and translator, so that we can add custom validation functions and error messages

framework/.changeset/v0.5.5.md

@@ -0,0 +1 @@
+- Add CLClient API to import P2P and EVM keys for a node set + example

framework/clclient/client.go

@@ -1,8 +1,13 @@
 package clclient
 
 import (
+	"crypto/ecdsa"
+	"crypto/rand"
 	"crypto/tls"
 	"fmt"
+	"github.com/ethereum/go-ethereum/accounts/keystore"
+	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/pkg/errors"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/clnode"
 	"math/big"
@@ -1233,3 +1238,73 @@ func (c *ChainlinkClient) GetForwarders() (*Forwarders, *http.Response, error) {
 	}
 	return response, resp.RawResponse, err
 }
+
+func NewETHKey(password string) ([]byte, error) {
+	privateKey, err := ecdsa.GenerateKey(crypto.S256(), rand.Reader)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to generate private key")
+	}
+	jsonKey, err := keystore.EncryptKey(&keystore.Key{
+		PrivateKey: privateKey,
+		Address:    crypto.PubkeyToAddress(privateKey.PublicKey),
+	}, password, keystore.StandardScryptN, keystore.StandardScryptP)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to encrypt the keystore")
+	}
+	return jsonKey, nil
+}
+
+// ImportEVMKey imports EVM key to the node (encrypted go-ethereum JSON wallet format)
+func (c *ChainlinkClient) ImportEVMKey(key []byte, chainID string) (*http.Response, error) {
+	framework.L.Info().Str(NodeURL, c.Config.URL).Str("Key", string(key)).Msg("Importing EVM key")
+	// empty response, nothing to marshal
+	resp, err := c.APIClient.R().SetBody(key).Post(fmt.Sprintf("/v2/keys/eth/import?evmChainID=%s", chainID))
+	if err != nil {
+		return nil, err
+	}
+	return resp.RawResponse, err
+}
+
+// ImportEVMKeys imports an array of EVM keys to the nodes
+func ImportEVMKeys(cl []*ChainlinkClient, keys [][]byte, chainID string) error {
+	eg := &errgroup.Group{}
+	for i, c := range cl {
+		eg.Go(func() error {
+			_, err := c.ImportEVMKey(keys[i], chainID)
+			if err != nil {
+				return err
+			}
+			return nil
+		})
+	}
+	return eg.Wait()
+}
+
+// ImportP2PKey import P2P keys to the node (encrypted go-ethereum JSON wallet format, keystore.EncryptDataV3 + prefix)
+func (c *ChainlinkClient) ImportP2PKey(encryptedJSONKey []byte) (*P2PKey, *http.Response, error) {
+	p2pKey := &P2PKey{}
+	framework.L.Info().Str(NodeURL, c.Config.URL).Msg("Importing P2P Key")
+	resp, err := c.APIClient.R().
+		SetBody(encryptedJSONKey).
+		SetResult(p2pKey).
+		Post("/v2/keys/p2p/import")
+	if err != nil {
+		return nil, nil, err
+	}
+	return p2pKey, resp.RawResponse, err
+}
+
+// ImportP2PKeys imports an array of P2P keys to the nodes
+func ImportP2PKeys(cl []*ChainlinkClient, keys [][]byte) error {
+	eg := &errgroup.Group{}
+	for i, c := range cl {
+		eg.Go(func() error {
+			_, _, err := c.ImportP2PKey(keys[i])
+			if err != nil {
+				return err
+			}
+			return nil
+		})
+	}
+	return eg.Wait()
+}

framework/config.go

@@ -6,20 +6,23 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"github.com/davecgh/go-spew/spew"
-	"github.com/go-playground/validator/v10"
-	"github.com/pelletier/go-toml/v2"
-	"github.com/rs/zerolog"
-	"github.com/stretchr/testify/require"
-	"github.com/testcontainers/testcontainers-go"
-	"github.com/testcontainers/testcontainers-go/network"
 	"os"
 	"path/filepath"
 	"strings"
 	"sync"
 	"testing"
 	"text/template"
 	"time"
+
+	"github.com/davecgh/go-spew/spew"
+	"github.com/go-playground/locales/en"
+	ut "github.com/go-playground/universal-translator"
+	"github.com/go-playground/validator/v10"
+	"github.com/pelletier/go-toml/v2"
+	"github.com/rs/zerolog"
+	"github.com/stretchr/testify/require"
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/network"
 )
 
 const (
@@ -48,8 +51,18 @@ var (
 	DefaultNetworkName string
 
 	AllowedEmptyConfigurationFields = []string{OutputFieldName, OverridesFieldName}
+
+	Validator *validator.Validate = validator.New(validator.WithRequiredStructEnabled())
+
+	ValidatorTranslator ut.Translator
 )
 
+func init() {
+	eng := en.New()
+	uni := ut.New(eng, eng)
+	ValidatorTranslator, _ = uni.GetTranslator("en")
+}
+
 type ValidationError struct {
 	Field   string
 	Value   interface{}
@@ -94,14 +107,21 @@ func mergeInputs[T any]() (*T, error) {
 
 func validateWithCustomErr(cfg interface{}) []ValidationError {
 	var validationErrors []ValidationError
-	validate := validator.New(validator.WithRequiredStructEnabled())
-	err := validate.Struct(cfg)
+	err := Validator.Struct(cfg)
 	if err != nil {
 		for _, err := range err.(validator.ValidationErrors) {
+			customMessage := err.Translate(ValidatorTranslator)
+			defaultMessage := fmt.Sprintf("validation failed on '%s' with tag '%s'", err.Field(), err.Tag())
+
+			messageToUse := customMessage
+			if strings.HasPrefix(customMessage, "validation failed") {
+				messageToUse = defaultMessage
+			}
+
 			validationErrors = append(validationErrors, ValidationError{
 				Field:   err.StructNamespace(),
 				Value:   err.Value(),
-				Message: fmt.Sprintf("validation failed on '%s' with tag '%s'", err.Field(), err.Tag()),
+				Message: messageToUse,
 			})
 		}
 	}