Custom port exposure, API credentials override in outputs (#1339)

custom ports, api creds in outputs, maturity model update

Author: skudasov

book/src/SUMMARY.md

@@ -14,7 +14,7 @@
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)
     - [Test Configuration](./framework/test_configuration_overrides.md)
-    - [Components Persistence](framework/components/state.md)
+    - [Exposing Components](framework/components/state.md)
     - [Components Cleanup](framework/components/cleanup.md)
     - [Components Caching](framework/components/caching.md)
     - [External Environment](framework/components/external.md)

book/src/framework/components/chainlink/node.md

@@ -21,6 +21,8 @@ Here we provide full configuration reference, if you want to copy and run it, pl
     pull_image = true
 
   [cl_node.node]
+    # custom ports that plugins may need to expose and map to the host machine
+    custom_ports = [14000, 14001]
     # A list of paths to capability binaries
     capabilities = ["./capability_1", "./capability_2"]
     # Default capabilities directory inside container
@@ -54,6 +56,10 @@ Here we provide full configuration reference, if you want to copy and run it, pl
     use_cache = true
     # Describes deployed or external Chainlink node
     [cl_node.out.node]
+      # API user name
+      api_auth_user = '[email protected]'
+      # API password
+      api_auth_password = 'fj293fbBnlQ!f9vNs'
       # Host Docker URLs the test uses
       # in case of using external component you can replace these URLs with another deployment
       p2p_url = "http://127.0.0.1:32812"

book/src/framework/components/chainlink/nodeset.md

@@ -68,6 +68,8 @@ Then configure NodeSet
       volume_name = ""
 
     [nodeset.node_specs.node]
+      # custom ports that plugins may need to expose and map to the host machine
+      custom_ports = [14000, 14001]
       # A list of paths to capability binaries
       capabilities = ["./capability_1", "./capability_2"]
       # Default capabilities directory inside container
@@ -106,6 +108,10 @@ Then configure NodeSet
 
       # Describes deployed or external Chainlink node
       [nodeset.out.cl_nodes.node]
+        # API user name
+        api_auth_user = '[email protected]'
+        # API password
+        api_auth_password = 'fj293fbBnlQ!f9vNs'
         # Host Docker URLs the test uses
         # in case of using external component you can replace these URLs with another deployment
         p2p_url = "http://127.0.0.1:32996"

book/src/framework/components/external.md

@@ -45,6 +45,9 @@ For example, to integrate with remote `k8s` environment you can use `CTF_CONFIGS
       use_cache = true
 
       [nodeset.out.cl_nodes.node]
+        # set up your user/password for API authorization
+        api_auth_user = '[email protected]'
+        api_auth_password = 'fj293fbBnlQ!f9vNs'
         # set up each node URLs
         p2p_url = "http://127.0.0.1:12000"
         url = "http://127.0.0.1:10000"

book/src/framework/components/state.md

@@ -1,4 +1,4 @@
-# Components Persistence
+# Exposing Components (Data and ports)
 
 We use static port ranges and volumes for all components to simplify Docker port management for developers.
 
@@ -27,6 +27,7 @@ Defaults are:
 
 When you run `ctf d rm` database volume will be **removed**.
 
+
 <div class="warning">
 
 One node set is enough for any kind of testing, if you need more nodes consider extending your existing node set:
@@ -35,3 +36,24 @@ One node set is enough for any kind of testing, if you need more nodes consider
   nodes = 10
 ```
 </div>
+
+## Custom ports
+
+You can also define a custom set of ports for any node
+```toml
+[nodeset]
+  nodes = 5
+  override_mode = "each"
+
+  [[nodeset.node_specs]]
+
+    [nodeset.node_specs.db]
+      image = "postgres:15.6"
+      pull_image = true
+
+    [nodeset.node_specs.node]
+      # here we defined 2 new ports to listen and mapped them to our host machine
+      custom_ports = [14000, 14001]
+      image = "public.ecr.aws/chainlink/chainlink:v2.16.0"
+      pull_image = false
+```

book/src/framework/test_configuration_overrides.md

@@ -68,3 +68,14 @@ This helps reduce duplication in the configuration.
 
 > [!WARNING]  
 > When override slices remember that you should replace the full slice, it won't be extended by default!
+
+## Overriding Components Configuration
+
+The same override logic applies across components, files, and configuration fields in code, configs are applied in order:
+
+1. Implicit component defaults that are defined inside application
+2. Component defaults defined in the framework or external component, ex.: [CLNode](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/components/clnode/default.go)
+3. `Test.*Override`
+4. `user_.*_overrides`
+
+Use `Test.*Override` in test `code` to override component configurations, and `user_.*_overrides` in `TOML` for the same purpose.

framework/.changeset/v0.2.4.md

@@ -0,0 +1,3 @@
+- Add custom ports exposure in TOML
+- Return default user/password credentials in outputs, so we can connect to any node by overriding TOML params
+- Change `clclient.New` signature

framework/clclient/client.go

@@ -14,7 +14,6 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/go-resty/resty/v2"
-	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"golang.org/x/sync/errgroup"
 )
@@ -57,14 +56,13 @@ func NewChainlinkClient(c *Config) (*ChainlinkClient, error) {
 	}, nil
 }
 
-// NewCLDefaultClients connects all the clients using clnode.Output and default login/password
-func NewCLDefaultClients(outs []*clnode.Output, l zerolog.Logger) ([]*ChainlinkClient, error) {
+func New(outs []*clnode.Output) ([]*ChainlinkClient, error) {
 	clients := make([]*ChainlinkClient, 0)
 	for _, out := range outs {
 		c, err := NewChainlinkClient(&Config{
 			URL:      out.Node.HostURL,
-			Email:    clnode.DefaultAPIUser,
-			Password: clnode.DefaultAPIPassword,
+			Email:    out.Node.APIAuthUser,
+			Password: out.Node.APIAuthPassword,
 		})
 		if err != nil {
 			return nil, err

framework/components/clnode/clnode.go

@@ -51,6 +51,7 @@ type NodeInput struct {
 	UserSecretsOverrides    string   `toml:"user_secrets_overrides"`
 	HTTPPort                int      `toml:"port"`
 	P2PPort                 int      `toml:"p2p_port"`
+	CustomPorts             []int    `toml:"custom_ports"`
 }
 
 // Output represents Chainlink node output, nodes and databases connection URLs
@@ -62,10 +63,12 @@ type Output struct {
 
 // NodeOut is CL node container output, URLs to connect
 type NodeOut struct {
-	HostURL      string `toml:"url"`
-	HostP2PURL   string `toml:"p2p_url"`
-	DockerURL    string `toml:"docker_internal_url"`
-	DockerP2PUrl string `toml:"p2p_docker_internal_url"`
+	APIAuthUser     string `toml:"api_auth_user"`
+	APIAuthPassword string `toml:"api_auth_password"`
+	HostURL         string `toml:"url"`
+	HostP2PURL      string `toml:"p2p_url"`
+	DockerURL       string `toml:"docker_internal_url"`
+	DockerP2PUrl    string `toml:"p2p_docker_internal_url"`
 }
 
 // NewNodeWithDB create a new Chainlink node with some image:tag and one or several configs
@@ -152,6 +155,35 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 	} else {
 		containerName = framework.DefaultTCName("node")
 	}
+	customPorts := make([]string, 0)
+	for _, p := range in.Node.CustomPorts {
+		customPorts = append(customPorts, fmt.Sprintf("%d/tcp", p))
+	}
+	exposedPorts := []string{httpPort, p2pPort}
+	exposedPorts = append(exposedPorts, customPorts...)
+
+	portBindings := nat.PortMap{
+		nat.Port(httpPort): []nat.PortBinding{
+			{
+				HostIP:   "0.0.0.0",
+				HostPort: fmt.Sprintf("%d/tcp", in.Node.HTTPPort),
+			},
+		},
+		nat.Port(p2pPort): []nat.PortBinding{
+			{
+				HostIP:   "0.0.0.0",
+				HostPort: fmt.Sprintf("%d/udp", in.Node.P2PPort),
+			},
+		},
+	}
+	for _, p := range customPorts {
+		portBindings[nat.Port(p)] = []nat.PortBinding{
+			{
+				HostIP:   "0.0.0.0",
+				HostPort: p,
+			},
+		}
+	}
 
 	req := tc.ContainerRequest{
 		AlwaysPullImage: in.Node.PullImage,
@@ -162,7 +194,7 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 		NetworkAliases: map[string][]string{
 			framework.DefaultNetworkName: {containerName},
 		},
-		ExposedPorts: []string{httpPort, p2pPort},
+		ExposedPorts: exposedPorts,
 		Entrypoint: []string{
 			"/bin/sh", "-c",
 			"chainlink -c /config/config -c /config/overrides -c /config/user-overrides -s /config/secrets -s /config/secrets-overrides -s /config/user-secrets-overrides node start -d -p /config/node_password -a /config/apicredentials",
@@ -171,20 +203,7 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 	}
 	if in.Node.HTTPPort != 0 && in.Node.P2PPort != 0 {
 		req.HostConfigModifier = func(h *container.HostConfig) {
-			h.PortBindings = nat.PortMap{
-				nat.Port(httpPort): []nat.PortBinding{
-					{
-						HostIP:   "0.0.0.0",
-						HostPort: fmt.Sprintf("%d/tcp", in.Node.HTTPPort),
-					},
-				},
-				nat.Port(p2pPort): []nat.PortBinding{
-					{
-						HostIP:   "0.0.0.0",
-						HostPort: fmt.Sprintf("%d/udp", in.Node.P2PPort),
-					},
-				},
-			}
+			h.PortBindings = portBindings
 		}
 	}
 	files := []tc.ContainerFile{
@@ -268,10 +287,12 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 	mpP2P := nat.Port(fmt.Sprintf("%d/udp", in.Node.P2PPort))
 
 	return &NodeOut{
-		HostURL:      fmt.Sprintf("http://%s:%s", host, mp.Port()),
-		HostP2PURL:   fmt.Sprintf("http://%s:%s", host, mpP2P.Port()),
-		DockerURL:    fmt.Sprintf("http://%s:%s", containerName, DefaultHTTPPort),
-		DockerP2PUrl: fmt.Sprintf("http://%s:%s", containerName, DefaultP2PPort),
+		APIAuthUser:     DefaultAPIUser,
+		APIAuthPassword: DefaultAPIPassword,
+		HostURL:         fmt.Sprintf("http://%s:%s", host, mp.Port()),
+		HostP2PURL:      fmt.Sprintf("http://%s:%s", host, mpP2P.Port()),
+		DockerURL:       fmt.Sprintf("http://%s:%s", containerName, DefaultHTTPPort),
+		DockerP2PUrl:    fmt.Sprintf("http://%s:%s", containerName, DefaultP2PPort),
 	}, nil
 }
 

framework/components/simple_node_set/node_set.go

@@ -50,17 +50,9 @@ func NewSharedDBNodeSet(in *Input, bcOut *blockchain.Output, fakeUrl string) (*O
 	if len(in.NodeSpecs) != in.Nodes && in.OverrideMode == "each" {
 		return nil, fmt.Errorf("amount of 'nodes' must be equal to specs provided in override_mode='each'")
 	}
-	switch in.OverrideMode {
-	case "all":
-		out, err = sharedDBSetup(in, bcOut, fakeUrl, false)
-		if err != nil {
-			return nil, err
-		}
-	case "each":
-		out, err = sharedDBSetup(in, bcOut, fakeUrl, true)
-		if err != nil {
-			return nil, err
-		}
+	out, err = sharedDBSetup(in, bcOut, fakeUrl)
+	if err != nil {
+		return nil, err
 	}
 	return out, nil
 }
@@ -80,7 +72,7 @@ func printURLs(out *Output) {
 	framework.L.Debug().Any("DB", pgURLs).Send()
 }
 
-func sharedDBSetup(in *Input, bcOut *blockchain.Output, fakeUrl string, overrideEach bool) (*Output, error) {
+func sharedDBSetup(in *Input, bcOut *blockchain.Output, fakeUrl string) (*Output, error) {
 	in.NodeSpecs[0].DbInput.Databases = in.Nodes
 	dbOut, err := postgres.NewPostgreSQL(in.NodeSpecs[0].DbInput)
 	if err != nil {
@@ -107,16 +99,21 @@ func sharedDBSetup(in *Input, bcOut *blockchain.Output, fakeUrl string, override
 		i := i
 		var overrideIdx int
 		var nodeName string
-		if overrideEach {
+		switch in.OverrideMode {
+		case "each":
 			overrideIdx = i
-		} else {
+		case "all":
 			overrideIdx = 0
+			if len(in.NodeSpecs[overrideIdx].Node.CustomPorts) > 0 {
+				return nil, fmt.Errorf("custom_ports can be used only with override_mode = 'each'")
+			}
 		}
 		if in.NodeSpecs[overrideIdx].Node.Name == "" {
 			nodeName = fmt.Sprintf("node%d", i)
 		}
 		eg.Go(func() error {
-			net, err := clnode.NewNetworkCfgOneNetworkAllNodes(bcOut)
+			var net string
+			net, err = clnode.NewNetworkCfgOneNetworkAllNodes(bcOut)
 			if err != nil {
 				return err
 			}
@@ -127,6 +124,7 @@ func sharedDBSetup(in *Input, bcOut *blockchain.Output, fakeUrl string, override
 				Node: &clnode.NodeInput{
 					HTTPPort:                httpPortRangeStart + i,
 					P2PPort:                 p2pPortRangeStart + i,
+					CustomPorts:             in.NodeSpecs[overrideIdx].Node.CustomPorts,
 					Image:                   in.NodeSpecs[overrideIdx].Node.Image,
 					Name:                    nodeName,
 					PullImage:               in.NodeSpecs[overrideIdx].Node.PullImage,