fix anvil miner and add docs

Author: skudasov

.github/workflows/framework-golden-tests.yml

@@ -38,6 +38,10 @@ jobs:
             config: scalability.toml
             count: 1
             timeout: 10m
+          - name: TestFakes
+            config: fake.toml
+            count: 1
+            timeout: 10m
     name: ${{ matrix.test.name }}
     steps:
       - name: Checkout repo

book/src/SUMMARY.md

@@ -11,6 +11,7 @@
     - [NodeSet (Local Docker builds)](./framework/nodeset_docker_rebuild.md)
     - [NodeSet Compat Environment](./framework/nodeset_compatibility.md)
     - [Fork Testing](./framework/fork.md)
+    - [Quick Contracts Deployment](./framework/quick_deployment.md)
     - [NodeSet with External Blockchain]()
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)

book/src/framework/components/mocking.md

@@ -12,3 +12,10 @@ The framework aims to equip you with all the necessary tools to write end-to-end
 ## Usage
 
 See [full](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/fake_test.go) example.
+
+<div class="warning">
+
+`host.docker.internal` is docker platform dependent!
+
+Use `framework.HostDockerInternal()` to reference `host.docker.internal` in your tests, so they can work in GHA CI
+</div>

book/src/framework/quick_deployment.md

@@ -0,0 +1,19 @@
+# Quick Contracts Deployment
+
+You can control the mining pace to accelerate contract deployment. Start anvil with the following configuration:
+
+```toml
+[blockchain_a]
+  chain_id = "31337"
+  image = "f4hrenh9it/foundry:latest"
+  port = "8545"
+  type = "anvil"
+```
+Set the `miner` speed,
+```golang
+	// start periodic mining so nodes can receive heads (async)
+	miner := rpc.NewRemoteAnvilMiner(bcSrc.Nodes[0].HostHTTPUrl, nil)
+	miner.MinePeriodically(5 * time.Second)
+```
+
+Then use this [template](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/quick_deploy_test.go)

framework/.changeset/v0.2.10.md

@@ -0,0 +1,3 @@
+- Switch to "anvil_mine" instead of "evm_mine"
+- Test that CL nodes can see block heads after we switch the mining pace
+- Quick deployments example (docs)

framework/ci.go

@@ -0,0 +1,14 @@
+package framework
+
+import (
+	"os"
+)
+
+// HostDockerInternal returns host.docker.internal that works both locally and in GHA
+func HostDockerInternal() string {
+	if os.Getenv(EnvVarCI) == "true" {
+		return "http://172.17.0.1"
+	} else {
+		return "http://host.docker.internal"
+	}
+}

framework/components/fake/fake.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"github.com/gin-gonic/gin"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
-	"os"
 	"regexp"
 )
 
@@ -67,12 +66,8 @@ func NewFakeDataProvider(in *Input) (*Output, error) {
 		_ = Service.Run(fmt.Sprintf(":%d", in.Port))
 	}()
 	out := &Output{
-		BaseURLHost: fmt.Sprintf("http://localhost:%d", in.Port),
-	}
-	if os.Getenv(framework.EnvVarCI) == "true" {
-		out.BaseURLDocker = fmt.Sprintf("http://172.17.0.1:%d", in.Port)
-	} else {
-		out.BaseURLDocker = fmt.Sprintf("http://host.docker.internal:%d", in.Port)
+		BaseURLHost:   fmt.Sprintf("http://localhost:%d", in.Port),
+		BaseURLDocker: fmt.Sprintf("%s:%d", framework.HostDockerInternal(), in.Port),
 	}
 	in.Out = out
 	return out, nil

framework/docker.go

@@ -123,6 +123,7 @@ func runCommand(name string, args ...string) error {
 	return cmd.Run()
 }
 
+// TODO: use tc.NewDockerProvider().BuildImage() to skip managing the registry container
 // RebuildDockerImage rebuilds docker image if necessary
 func RebuildDockerImage(once *sync.Once, dockerfile string, buildContext string, imageName string) (string, error) {
 	if dockerfile == "" {

framework/examples/myproject/example_components/mock-tester.go

@@ -0,0 +1,43 @@
+package components
+
+import (
+	"bufio"
+	"context"
+	"fmt"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework"
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/wait"
+)
+
+// NewDockerFakeTester is a small utility to test how docker host resolves in different CI environments
+// it just prints logs of curl in CI when calling some URL
+// it is temporary and will be removed in the future
+func NewDockerFakeTester(url string) error {
+	ctx := context.Background()
+	req := testcontainers.ContainerRequest{
+		Image:      "curlimages/curl:latest",
+		Cmd:        []string{"curl", "-v", url},
+		Labels:     framework.DefaultTCLabels(),
+		WaitingFor: wait.ForExit(),
+	}
+	curlContainer, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
+		ContainerRequest: req,
+		Started:          true,
+	})
+	if err != nil {
+		return err
+	}
+	logs, err := curlContainer.Logs(ctx)
+	if err != nil {
+		return err
+	}
+	scanner := bufio.NewScanner(logs)
+	fmt.Println("Container logs:")
+	for scanner.Scan() {
+		fmt.Println(scanner.Text())
+	}
+	if err := scanner.Err(); err != nil {
+		return fmt.Errorf("error reading container logs: %w", err)
+	}
+	return nil
+}

framework/examples/myproject/fake_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/fake"
 	ns "github.com/smartcontractkit/chainlink-testing-framework/framework/components/simple_node_set"
+	components "github.com/smartcontractkit/chainlink-testing-framework/framework/examples/example_components"
 	"github.com/stretchr/testify/require"
 	"testing"
 )
@@ -68,4 +69,19 @@ func TestFakes(t *testing.T) {
 		// use docker URL and path of your fake
 		_ = fmt.Sprintf("%s%s", fakeOut.BaseURLDocker, myFakeAPI)
 	})
+
+	t.Run("verify that containers can access internally both locally and in CI", func(t *testing.T) {
+		myFakeAPI := "/fake/api/internal"
+		// use fake.Func if you need full control over response
+		err = fake.JSON(
+			"GET",
+			myFakeAPI,
+			map[string]any{
+				"data": "some_data",
+			}, 200,
+		)
+		require.NoError(t, err)
+		err := components.NewDockerFakeTester(fmt.Sprintf("%s%s", fakeOut.BaseURLDocker, myFakeAPI))
+		require.NoError(t, err)
+	})
 }