WIP: decouple fakes server and add container + README

Author: skudasov

framework/components/fake/container.go

@@ -0,0 +1,78 @@
+package fake
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/go-connections/nat"
+	tc "github.com/testcontainers/testcontainers-go"
+	tcwait "github.com/testcontainers/testcontainers-go/wait"
+)
+
+type Input struct {
+	Image string  `toml:"image"`
+	Port  int     `toml:"port" validate:"required"`
+	Out   *Output `toml:"out"`
+}
+
+type Output struct {
+	UseCache      bool   `toml:"use_cache"`
+	BaseURLHost   string `toml:"base_url_host"`
+	BaseURLDocker string `toml:"base_url_docker"`
+}
+
+func defaults(in *Input) {
+}
+
+// NewFakeDataProvider creates new fake data provider
+func NewFakeDataProvider(in *Input) (*Output, error) {
+	if in.Out != nil && in.Out.UseCache {
+		return in.Out, nil
+	}
+	ctx := context.Background()
+	defaults(in)
+	bindPort := fmt.Sprintf("%d/tcp", in.Port)
+	req := tc.ContainerRequest{
+		Name:  in.Image,
+		Image: in.Image,
+		//Labels:   framework.DefaultTCLabels(),
+		//Networks: []string{framework.DefaultNetworkName},
+		//NetworkAliases: map[string][]string{
+		//	framework.DefaultNetworkName: {containerName},
+		//},
+		ExposedPorts: []string{bindPort},
+		HostConfigModifier: func(h *container.HostConfig) {
+			//h.PortBindings = framework.MapTheSamePort(bindPort)
+		},
+		Env: map[string]string{
+			//"DATABASE_URL": pgOut.JDInternalURL,
+		},
+		WaitingFor: tcwait.ForAll(
+			tcwait.ForListeningPort(nat.Port(fmt.Sprintf("%d/tcp", in.Port))),
+		),
+	}
+	_, err := tc.GenericContainer(ctx, tc.GenericContainerRequest{
+		ContainerRequest: req,
+		Started:          true,
+	})
+	if err != nil {
+		return nil, err
+	}
+	out := &Output{
+		BaseURLHost:   fmt.Sprintf("http://localhost:%d", in.Port),
+		BaseURLDocker: fmt.Sprintf("%s:%d", HostDockerInternal(), in.Port),
+	}
+	in.Out = out
+	//out := &Output{
+	//	UseCache:         true,
+	//	ContainerName:    containerName,
+	//	DBContainerName:  pgOut.ContainerName,
+	//	ExternalGRPCUrl:  fmt.Sprintf("%s:%s", host, in.GRPCPort),
+	//	InternalGRPCUrl:  fmt.Sprintf("%s:%s", containerName, in.GRPCPort),
+	//	ExternalWSRPCUrl: fmt.Sprintf("%s:%s", host, in.WSRPCPort),
+	//	InternalWSRPCUrl: fmt.Sprintf("%s:%s", containerName, in.WSRPCPort),
+	//}
+	//in.Out = out
+	return out, nil
+}

framework/components/fake/fake.go

@@ -2,28 +2,17 @@ package fake
 
 import (
 	"fmt"
+	"os"
 	"regexp"
 
 	"github.com/gin-gonic/gin"
-
-	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 )
 
 var (
 	Service     *gin.Engine
 	validMethod = regexp.MustCompile("GET|POST|PATCH|PUT|DELETE")
 )
 
-type Input struct {
-	Port int     `toml:"port" validate:"required"`
-	Out  *Output `toml:"out"`
-}
-
-type Output struct {
-	BaseURLHost   string `toml:"base_url_host"`
-	BaseURLDocker string `toml:"base_url_docker"`
-}
-
 // validate validates method and path, does not allow to override mock
 func validate(method, path string) error {
 	if Service == nil {
@@ -40,7 +29,7 @@ func validate(method, path string) error {
 }
 
 // Func fakes method and path with a custom func
-func Func(method string, path string, f func(ctx *gin.Context)) error {
+func Func(method, path string, f func(ctx *gin.Context)) error {
 	if err := validate(method, path); err != nil {
 		return err
 	}
@@ -49,7 +38,7 @@ func Func(method string, path string, f func(ctx *gin.Context)) error {
 }
 
 // JSON fakes for method, path, response and status code
-func JSON(method string, path string, response map[string]any, statusCode int) error {
+func JSON(method, path string, response map[string]any, statusCode int) error {
 	if err := validate(method, path); err != nil {
 		return err
 	}
@@ -59,17 +48,10 @@ func JSON(method string, path string, response map[string]any, statusCode int) e
 	return nil
 }
 
-// NewFakeDataProvider creates new fake data provider
-func NewFakeDataProvider(in *Input) (*Output, error) {
-	Service = gin.Default()
-	Service.Use(recordMiddleware())
-	go func() {
-		_ = Service.Run(fmt.Sprintf(":%d", in.Port))
-	}()
-	out := &Output{
-		BaseURLHost:   fmt.Sprintf("http://localhost:%d", in.Port),
-		BaseURLDocker: fmt.Sprintf("%s:%d", framework.HostDockerInternal(), in.Port),
+// HostDockerInternal returns host.docker.internal that works both locally and in GHA
+func HostDockerInternal() string {
+	if os.Getenv("CI") == "true" {
+		return "http://172.17.0.1"
 	}
-	in.Out = out
-	return out, nil
+	return "http://host.docker.internal"
 }

framework/components/fake/go.mod

@@ -0,0 +1,91 @@
+module github.com/smartcontractkit/chainlink-testing-framework/framework/components/fake
+
+go 1.24.4
+
+require (
+	github.com/docker/docker v28.3.1+incompatible
+	github.com/docker/go-connections v0.5.0
+	github.com/gin-gonic/gin v1.10.1
+	github.com/go-resty/resty/v2 v2.16.5
+	github.com/stretchr/testify v1.10.0
+	github.com/testcontainers/testcontainers-go v0.37.0
+)
+
+require (
+	dario.cat/mergo v1.0.1 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/Microsoft/go-winio v0.6.2 // indirect
+	github.com/bytedance/sonic v1.11.6 // indirect
+	github.com/bytedance/sonic/loader v0.1.1 // indirect
+	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/cloudwego/base64x v0.1.4 // indirect
+	github.com/cloudwego/iasm v0.2.0 // indirect
+	github.com/containerd/errdefs v1.0.0 // indirect
+	github.com/containerd/errdefs/pkg v0.3.0 // indirect
+	github.com/containerd/log v0.1.0 // indirect
+	github.com/containerd/platforms v0.2.1 // indirect
+	github.com/cpuguy83/dockercfg v0.3.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/distribution/reference v0.6.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/ebitengine/purego v0.8.2 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
+	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/go-logr/logr v1.4.3 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.20.0 // indirect
+	github.com/goccy/go-json v0.10.2 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.7 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
+	github.com/magiconair/properties v1.8.10 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/moby/docker-image-spec v1.3.1 // indirect
+	github.com/moby/go-archive v0.1.0 // indirect
+	github.com/moby/patternmatcher v0.6.0 // indirect
+	github.com/moby/sys/atomicwriter v0.1.0 // indirect
+	github.com/moby/sys/sequential v0.6.0 // indirect
+	github.com/moby/sys/user v0.4.0 // indirect
+	github.com/moby/sys/userns v0.1.0 // indirect
+	github.com/moby/term v0.5.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.1.1 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
+	github.com/shirou/gopsutil/v4 v4.25.1 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/tklauser/go-sysconf v0.3.12 // indirect
+	github.com/tklauser/numcpus v0.6.1 // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go/codec v1.2.12 // indirect
+	github.com/yusufpapurcu/wmi v1.2.4 // indirect
+	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
+	go.opentelemetry.io/otel v1.37.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.37.0 // indirect
+	go.opentelemetry.io/otel/metric v1.37.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.37.0 // indirect
+	go.opentelemetry.io/otel/trace v1.37.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.7.0 // indirect
+	golang.org/x/arch v0.8.0 // indirect
+	golang.org/x/crypto v0.38.0 // indirect
+	golang.org/x/net v0.40.0 // indirect
+	golang.org/x/sys v0.33.0 // indirect
+	golang.org/x/text v0.25.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250603155806-513f23925822 // indirect
+	google.golang.org/protobuf v1.36.6 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

framework/examples/myproject/fake_test.go

@@ -17,7 +17,7 @@ import (
 type CfgFake struct {
 	BlockchainA *blockchain.Input `toml:"blockchain_a" validate:"required"`
 	Fake        *fake.Input       `toml:"fake" validate:"required"`
-	NodeSet     *ns.Input         `toml:"nodeset" validate:"required"`
+	NodeSets    []*ns.Input       `toml:"nodesets" validate:"required"`
 }
 
 func TestFakes(t *testing.T) {
@@ -28,7 +28,7 @@ func TestFakes(t *testing.T) {
 	require.NoError(t, err)
 	fakeOut, err := fake.NewFakeDataProvider(in.Fake)
 	require.NoError(t, err)
-	_, err = ns.NewSharedDBNodeSet(in.NodeSet, bc)
+	_, err = ns.NewSharedDBNodeSet(in.NodeSets[0], bc)
 	require.NoError(t, err)
 
 	t.Run("test fake on host machine", func(t *testing.T) {

framework/examples/myproject/fakes/Dockerfile

@@ -0,0 +1,30 @@
+FROM golang:1.24 AS builder
+
+# SSH setup, copy the key you've created for this guide
+RUN apt-get update && \
+    apt-get install -y openssh-client git && \
+    mkdir -p ~/.ssh && \
+    chmod 700 ~/.ssh && \
+    touch ~/.ssh/known_hosts && \
+    chmod 600 ~/.ssh/known_hosts
+RUN ssh-keyscan github.com >> ~/.ssh/known_hosts
+RUN --mount=type=secret,id=ssh_key \
+    cp /run/secrets/ssh_key ~/.ssh/id && \
+    chmod 600 ~/.ssh/id && \
+    echo "Host github.com\n  IdentityFile ~/.ssh/id\n  IdentitiesOnly yes" > ~/.ssh/config && \
+    chmod 600 ~/.ssh/config
+RUN git config --global url."[email protected]:".insteadOf "https://github.com/"
+
+ENV GOPRIVATE=github.com/smartcontractkit/*
+
+WORKDIR /app
+COPY go.mod go.sum ./
+RUN --mount=type=secret,id=ssh_key go mod download
+COPY ../.. .
+RUN --mount=type=secret,id=ssh_key CGO_ENABLED=0 GOOS=linux go build -o /fake main.go
+
+FROM alpine:latest
+RUN apk --no-cache add ca-certificates
+COPY --from=builder /fake /fake
+EXPOSE 9111
+CMD ["/fake"]

framework/examples/myproject/fakes/README.md

@@ -0,0 +1,39 @@
+# Example Fakes
+
+This example demonstrate how to write fake services for testing.
+
+Copy this example into your project, write the logic of fake, build and upload it and run.
+
+## Install
+
+To handle some utility command please install `Taskfile`
+```
+brew install go-task
+```
+
+## Private Repositories (Optional)
+
+If your tests are in a private repository please generate a new SSH key and add it on [GitHub](https://github.com/settings/keys). Don't forget to click `Configure SSO` in UI
+```
+task new-ssh
+```
+
+## Usage
+
+Build it and run locally when developing fakes
+```
+task build -- ${product-name}-${tag} # ex. myproduct-1.0
+task run
+```
+
+Test it
+```
+curl "http://localhost:9111/static-fake"
+curl "http://localhost:9111/dynamic-fake"
+```
+Publish it
+```
+task publish -- $tag
+```
+
+Image name is `795953128386.dkr.ecr.us-west-2.amazonaws.com/ccip-fakes:test`

framework/examples/myproject/fakes/Taskfile.yml

@@ -0,0 +1,52 @@
+---
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - task --list-all
+    silent: true
+
+  build:
+    desc: Build the fake server
+    cmds:
+      - docker build --secret id=ssh_key,src=$HOME/.ssh/id-dctl --platform linux/amd64 -t test-fakes:{{.CLI_ARGS}} .
+      - docker tag test-fakes:{{.CLI_ARGS}} localhost:5000/test-fakes:{{.CLI_ARGS}}
+      - docker tag test-fakes:{{.CLI_ARGS}} 795953128386.dkr.ecr.us-west-2.amazonaws.com/test-fakes:{{.CLI_ARGS}}
+    silent: false
+
+  run:
+    desc: Run the fake server
+    cmds:
+      - docker run --rm -it -p 9111:9111 fake
+    silent: false
+  test:
+    desc: Execute test requests
+    cmds:
+      - curl "http://localhost:9111/static-fake"
+      - echo
+      - curl "http://localhost:9111/dynamic-fake"
+    silent: false
+
+  publish:
+    desc: Publish the updated image
+    cmds:
+      - aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin 795953128386.dkr.ecr.us-west-2.amazonaws.com
+      - docker tag test-fakes:{{.CLI_ARGS}} 795953128386.dkr.ecr.us-west-2.amazonaws.com/test-fakes:{{.CLI_ARGS}}
+      - docker push 795953128386.dkr.ecr.us-west-2.amazonaws.com/test-fakes:{{.CLI_ARGS}}
+    silent: false
+
+  aws-sdlc:
+    desc: Login to AWS and update K8s config
+    cmds:
+      - aws --profile=secure.ci sso login
+      - aws eks update-kubeconfig --name main-sdlc-cluster --profile secure.ci --alias secure.ci
+
+  new-ssh:
+    desc: Generate new SSH key to access private repositories from the inside of K8s
+    cmds:
+      - ssh-keygen -t ed25519 -f ~/.ssh/id-dctl -N "" -q
+      - echo "Go to GitHub profile, open Settings -> SSH and GPG keys, click 'New SSH Key'"
+      - echo "Select 'Authentication key' and paste your public key below:"
+      - cat ~/.ssh/id-dctl.pub
+    silent: true