expose debugger if flag

Author: skudasov

book/src/framework/components/debug.md

@@ -10,35 +10,7 @@ Use `RESTY_DEBUG=true` to debug any API calls.
 
 Use `SETH_LOG_LEVEL=trace|debug|info|warn` to debug [Seth](../../libs/seth.md).
 
-## Using Delve (TBD)
-
-You can use [Delve]() inside your containers to debug aplications.
-
-Build them with `go build -gcflags="all=-N -l" -o myapp` and use an example `Dockerfile`:
-```
-FROM golang:1.20
-
-# Install Delve
-RUN go install github.com/go-delve/delve/cmd/dlv@latest
-
-# Set working directory
-WORKDIR /app
-
-# Copy the application binary and source code (if needed for debugging)
-COPY myapp /app/myapp
-COPY . /app
-
-# Expose the port for Delve
-EXPOSE 40000
-
-# Start Delve in headless mode for remote debugging
-ENTRYPOINT ["dlv", "exec", "./myapp", "--headless", "--listen=:40000", "--api-version=2", "--accept-multiclient"]
-
-```
-
-Adding `Delve` to all our components is WIP right now.
-
-To expose `Delve` port follow this [guide](state.md).
-
+## Using Delve
 
+All `dlv` debuggers are exposed on ports `40000, 40001, 40002 ...`
 

framework/components/clnode/clnode.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"sync"
 	"text/template"
@@ -23,6 +24,7 @@ import (
 const (
 	DefaultHTTPPort     = "6688"
 	DefaultP2PPort      = "6690"
+	DefaultDebuggerPort = 40000
 	TmpImageName        = "chainlink-tmp:latest"
 	CustomPortSeparator = ":"
 )
@@ -54,6 +56,7 @@ type NodeInput struct {
 	HTTPPort                int      `toml:"port"`
 	P2PPort                 int      `toml:"p2p_port"`
 	CustomPorts             []string `toml:"custom_ports"`
+	DebuggerPort            int      `toml:"debugger_port"`
 }
 
 // Output represents Chainlink node output, nodes and databases connection URLs
@@ -114,18 +117,38 @@ func NewNode(in *Input, pgOut *postgres.Output) (*Output, error) {
 	return out, nil
 }
 
+func generateEntryPoint() []string {
+	entrypoint := []string{
+		"/bin/sh", "-c",
+	}
+	if os.Getenv("CTF_CLNODE_DLV") == "true" {
+		entrypoint = append(entrypoint, "dlv  exec /usr/local/bin/chainlink --continue --listen=0.0.0.0:40000 --headless=true --api-version=2 --accept-multiclient -- -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")
+	} else {
+		entrypoint = append(entrypoint, "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")
+	}
+	return entrypoint
+}
+
 // generatePortBindings generates exposed ports and port bindings
 // exposes default CL node port
 // exposes custom_ports in format "host:docker" or map 1-to-1 if only "host" port is provided
 func generatePortBindings(in *Input) ([]string, nat.PortMap, error) {
 	httpPort := fmt.Sprintf("%s/tcp", DefaultHTTPPort)
+	innerDebuggerPort := fmt.Sprintf("%d/tcp", DefaultDebuggerPort)
+	debuggerPort := fmt.Sprintf("%d/tcp", in.Node.DebuggerPort)
 	portBindings := nat.PortMap{
 		nat.Port(httpPort): []nat.PortBinding{
 			{
 				HostIP:   "0.0.0.0",
 				HostPort: fmt.Sprintf("%d/tcp", in.Node.HTTPPort),
 			},
 		},
+		nat.Port(innerDebuggerPort): []nat.PortBinding{
+			{
+				HostIP:   "0.0.0.0",
+				HostPort: debuggerPort,
+			},
+		},
 	}
 	customPorts := make([]string, 0)
 	for _, p := range in.Node.CustomPorts {
@@ -157,7 +180,7 @@ func generatePortBindings(in *Input) ([]string, nat.PortMap, error) {
 			}
 		}
 	}
-	exposedPorts := []string{httpPort}
+	exposedPorts := []string{httpPort, strconv.Itoa(DefaultDebuggerPort)}
 	exposedPorts = append(exposedPorts, customPorts...)
 	return exposedPorts, portBindings, nil
 }
@@ -219,11 +242,8 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 			framework.DefaultNetworkName: {containerName},
 		},
 		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",
-		},
-		WaitingFor: wait.ForHTTP("/").WithPort(DefaultHTTPPort).WithStartupTimeout(1 * time.Minute).WithPollInterval(200 * time.Millisecond),
+		Entrypoint:   generateEntryPoint(),
+		WaitingFor:   wait.ForHTTP("/").WithPort(DefaultHTTPPort).WithStartupTimeout(1 * time.Minute).WithPollInterval(200 * time.Millisecond),
 	}
 	if in.Node.HTTPPort != 0 && in.Node.P2PPort != 0 {
 		req.HostConfigModifier = func(h *container.HostConfig) {

framework/components/simple_node_set/node_set.go

@@ -129,6 +129,7 @@ func sharedDBSetup(in *Input, bcOut *blockchain.Output) (*Output, error) {
 				Node: &clnode.NodeInput{
 					HTTPPort:                httpPortRangeStart + i,
 					P2PPort:                 p2pPortRangeStart + i,
+					DebuggerPort:            clnode.DefaultDebuggerPort + i,
 					CustomPorts:             in.NodeSpecs[overrideIdx].Node.CustomPorts,
 					Image:                   in.NodeSpecs[overrideIdx].Node.Image,
 					Name:                    nodeName,

framework/examples/myproject/smoke.toml

@@ -1,9 +1,9 @@
 
 [blockchain_a]
   # choose "anvil", "geth" or "besu"
-  # uncomment the second line for "anvil"
-  type = "besu"
-#  docker_cmd_params = ["-b", "1"]
+  # use   docker_cmd_params = ["-b", "1"] for "anvil"
+  type = "anvil"
+  docker_cmd_params = ["-b", "1"]
 
 [data_provider]
   port = 9111
@@ -18,4 +18,6 @@
   [[nodeset.node_specs]]
 
     [nodeset.node_specs.node]
-      image = "public.ecr.aws/chainlink/chainlink:v2.17.0"
+      docker_file = "plugins/chainlink.Dockerfile"
+      docker_ctx = "/Users/fahrenheit/GolandProjects/chainlink"
+#      image = "public.ecr.aws/chainlink/chainlink:v2.17.0"