Merge branch 'main' into tt-1806-labelling-readme

Author: Tofel

book/src/SUMMARY.md

@@ -23,6 +23,7 @@
     - [Mocking Services](framework/components/mocking.md)
     - [Copying Files](framework/copying_files.md)
     - [External Environment](framework/components/external.md)
+    - [Troubleshooting](framework/components/troubleshooting.md)
     - [Secrets]()
     - [Observability Stack](framework/observability/observability_stack.md)
       - [Metrics](framework/observability/metrics.md)

book/src/framework/components/troubleshooting.md

@@ -0,0 +1,12 @@
+# Troubleshooting
+
+## Can't run `anvil`, issue with `Rosetta`
+```
+2024/11/27 15:20:27 ⏳ Waiting for container id 79f8a68c07cc image: f4hrenh9it/foundry:latest. Waiting for: &{Port:8546 timeout:0x14000901278 PollInterval:100ms skipInternalCheck:false}
+2024/11/27 15:20:27 container logs (all exposed ports, [8546/tcp], were not mapped in 5s: port 8546/tcp is not mapped yet
+wait until ready: check target: retries: 1, port: "", last err: container exited with code 133):
+rosetta error: Rosetta is only intended to run on Apple Silicon with a macOS host using Virtualization.framework with Rosetta mode enabled
+```
+#### Solution
+
+Update your docker to `Docker version 27.3.1, build ce12230`

book/src/framework/getting_started.md

@@ -4,6 +4,12 @@
 - `Docker` [OrbStack](https://orbstack.dev/) or [Docker Desktop](https://www.docker.com/products/docker-desktop/), we recommend OrbStack (faster, smaller memory footprint)
 - [Golang](https://go.dev/doc/install)
 
+Tested with
+```
+Docker version 27.3.1
+OrbStack Version: 1.8.2 (1080200)
+```
+
 ## Test setup
 
 To start writing tests create a directory for your project with `go.mod` and add a package

book/src/framework/observability/blockscout.md

@@ -12,6 +12,14 @@ To remove it, we also clean up all Blockscout databases to prevent stale data wh
 ctf bs down
 ```
 
+## Selecting Blockchain Node
+
+By default, we connect to the first `anvil` node, but you can select the node explicitly
+```
+ctf bs -r http://host.docker.internal:8545 d
+ctf bs -r http://host.docker.internal:8555 d
+```
+
 <div class="warning">
 
 Blockscout isn’t ideal for local, ephemeral environments, as it won’t re-index blocks and transactions on test reruns. The easiest approach is to set up Blockscout first, initialize the test environment, switch to the [cache](../components/caching.md) config, and run tests without restarting RPC nodes. 

framework/.changeset/v0.2.12.md

@@ -0,0 +1,2 @@
+- Omit all local tooling container logs
+- Allow to connect Blockscout to any node

framework/.changeset/v0.2.13.md

@@ -0,0 +1,3 @@
+- Simplify local Chainlink build
+- Remove dependency on "local-registry"
+- Skip Promtail to accelerate CI 🚀

framework/cmd/blockscout.go

@@ -3,14 +3,16 @@ package main
 import (
 	"fmt"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
+	"os"
 	"path/filepath"
 )
 
-func blockscoutUp() error {
+func blockscoutUp(url string) error {
 	framework.L.Info().Msg("Creating local Blockscout stack")
 	if err := extractAllFiles("observability"); err != nil {
 		return err
 	}
+	os.Setenv("BLOCKSCOUT_RPC_URL", url)
 	err := runCommand("bash", "-c", fmt.Sprintf(`
 		cd %s && \
 		docker compose up -d
@@ -23,8 +25,9 @@ func blockscoutUp() error {
 	return nil
 }
 
-func blockscoutDown() error {
+func blockscoutDown(url string) error {
 	framework.L.Info().Msg("Removing local Blockscout stack")
+	os.Setenv("BLOCKSCOUT_RPC_URL", url)
 	err := runCommand("bash", "-c", fmt.Sprintf(`
 		cd %s && \
 		docker compose down -v

framework/cmd/docker.go

@@ -6,10 +6,9 @@ import (
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 	"os"
 	"os/exec"
-	"strings"
 )
 
-func rmTestContainers() error {
+func removeTestContainers() error {
 	framework.L.Info().Str("label", "framework=ctf").Msg("Cleaning up docker containers")
 	// Bash command for removing Docker containers and networks with "framework=ctf" label
 	cmd := exec.Command("bash", "-c", `
@@ -45,48 +44,6 @@ func cleanUpDockerResources() error {
 	return nil
 }
 
-// BuildDocker runs Docker commands to set up a local registry, build an image, and push it.
-func BuildDocker(dockerfile string, buildContext string, imageName string) error {
-	registryRunning := isContainerRunning("local-registry")
-	if registryRunning {
-		fmt.Println("Local registry container is already running.")
-	} else {
-		framework.L.Info().Msg("Starting local registry container...")
-		err := runCommand("docker", "run", "-d", "-p", "5050:5000", "--name", "local-registry", "registry:2")
-		if err != nil {
-			return fmt.Errorf("failed to start local registry: %w", err)
-		}
-		framework.L.Info().Msg("Local registry started")
-	}
-
-	img := fmt.Sprintf("localhost:5050/%s:latest", imageName)
-	framework.L.Info().Str("DockerFile", dockerfile).Str("Context", buildContext).Msg("Building Docker image")
-	err := runCommand("docker", "build", "-t", fmt.Sprintf("localhost:5050/%s:latest", imageName), "-f", dockerfile, buildContext)
-	if err != nil {
-		return fmt.Errorf("failed to build Docker image: %w", err)
-	}
-	framework.L.Info().Msg("Docker image built successfully")
-
-	framework.L.Info().Str("Image", img).Msg("Pushing Docker image to local registry")
-	fmt.Println("Pushing Docker image to local registry...")
-	err = runCommand("docker", "push", img)
-	if err != nil {
-		return fmt.Errorf("failed to push Docker image: %w", err)
-	}
-	framework.L.Info().Msg("Docker image pushed successfully")
-	return nil
-}
-
-// isContainerRunning checks if a Docker container with the given name is running.
-func isContainerRunning(containerName string) bool {
-	cmd := exec.Command("docker", "ps", "--filter", fmt.Sprintf("name=%s", containerName), "--format", "{{.Names}}")
-	output, err := cmd.Output()
-	if err != nil {
-		return false
-	}
-	return strings.Contains(string(output), containerName)
-}
-
 // runCommand executes a command and prints the output.
 func runCommand(name string, args ...string) error {
 	cmd := exec.Command(name, args...)

framework/cmd/interactive.go

@@ -16,11 +16,12 @@ import (
 )
 
 type nodeSetForm struct {
-	Network       string
-	CLVersion     string
-	Nodes         int
-	Observability bool
-	Blockscout    bool
+	Network          string
+	CLVersion        string
+	Nodes            int
+	Observability    bool
+	Blockscout       bool
+	BlockscoutRPCURL string
 }
 
 func createComponentsFromForm(form *nodeSetForm) error {
@@ -83,7 +84,7 @@ func createComponentsFromForm(form *nodeSetForm) error {
 	}
 	switch form.Blockscout {
 	case true:
-		if err := blockscoutUp(); err != nil {
+		if err := blockscoutUp(form.BlockscoutRPCURL); err != nil {
 			return err
 		}
 	}
@@ -93,7 +94,7 @@ func createComponentsFromForm(form *nodeSetForm) error {
 func cleanup(form *nodeSetForm) error {
 	var err error
 	f := func() {
-		err = rmTestContainers()
+		err = removeTestContainers()
 	}
 	err = spinner.New().
 		Title("Removing docker resources..").
@@ -107,7 +108,7 @@ func cleanup(form *nodeSetForm) error {
 	}
 	switch form.Blockscout {
 	case true:
-		if err := blockscoutDown(); err != nil {
+		if err := blockscoutDown(form.BlockscoutRPCURL); err != nil {
 			return err
 		}
 	}
@@ -156,6 +157,13 @@ Docker Desktop (https://www.docker.com/products/docker-desktop/)
 			huh.NewConfirm().
 				Title("Do you need to spin up a Blockscout stack?").
 				Value(&f.Blockscout),
+			huh.NewSelect[string]().
+				Title("To which blockchain node you want Blockscout to connect?").
+				Options(
+					huh.NewOption("Network 1", "http://host.docker.internal:8545"),
+					huh.NewOption("Network 2", "http://host.docker.internal:8550"),
+				).
+				Value(&f.BlockscoutRPCURL),
 		),
 	)
 

framework/cmd/main.go

@@ -80,7 +80,7 @@ func main() {
 						Aliases: []string{"rm"},
 						Usage:   "Remove Docker containers and networks with 'framework=ctf' label",
 						Action: func(c *cli.Context) error {
-							err := rmTestContainers()
+							err := removeTestContainers()
 							if err != nil {
 								return fmt.Errorf("failed to clean Docker resources: %w", err)
 							}
@@ -114,31 +114,44 @@ func main() {
 				Name:    "blockscout",
 				Aliases: []string{"bs"},
 				Usage:   "Controls local Blockscout stack",
+				Flags: []cli.Flag{
+					&cli.StringFlag{
+						Name:    "rpc",
+						Aliases: []string{"r"},
+						Usage:   "RPC URL for blockchain node to index",
+						Value:   "http://host.docker.internal:8545",
+					},
+				},
 				Subcommands: []*cli.Command{
 					{
 						Name:        "up",
 						Usage:       "ctf bs up",
 						Aliases:     []string{"u"},
 						Description: "Spins up Blockscout stack",
-						Action:      func(c *cli.Context) error { return blockscoutUp() },
+						Action: func(c *cli.Context) error {
+							return blockscoutUp(c.String("rpc"))
+						},
 					},
 					{
 						Name:        "down",
 						Usage:       "ctf bs down",
 						Aliases:     []string{"d"},
 						Description: "Removes Blockscout stack, wipes all Blockscout databases data",
-						Action:      func(c *cli.Context) error { return blockscoutDown() },
+						Action: func(c *cli.Context) error {
+							return blockscoutDown(c.String("rpc"))
+						},
 					},
 					{
 						Name:        "reboot",
 						Usage:       "ctf bs reboot or ctf bs r",
 						Aliases:     []string{"r"},
 						Description: "Reboots Blockscout stack",
 						Action: func(c *cli.Context) error {
-							if err := blockscoutDown(); err != nil {
+							rpc := c.String("rpc")
+							if err := blockscoutDown(rpc); err != nil {
 								return err
 							}
-							return blockscoutUp()
+							return blockscoutUp(rpc)
 						},
 					},
 				},