wip

Author: skudasov

book/src/SUMMARY.md

@@ -18,6 +18,7 @@
     - [Components Cleanup](framework/components/cleanup.md)
     - [Components Caching](framework/components/caching.md)
     - [Mocking Services](framework/components/mocking.md)
+    - [Copying Files](framework/copying_files.md)
     - [External Environment](framework/components/external.md)
     - [Secrets]()
     - [Observability Stack](framework/observability/observability_stack.md)

book/src/framework/components/state.md

@@ -9,6 +9,7 @@ When deploying a component, you can explicitly configure port ranges if the defa
 Defaults are:
 - [NodeSet](../components/chainlink/nodeset.md) (Node HTTP API): `10000..100XX`
 - [NodeSet](../components/chainlink/nodeset.md) (Node P2P API): `12000..120XX`
+- Shared `PostgreSQL` volume is called `postgresql_data`
 ```
 [nodeset]
   # HTTP API port range start, each new node get port incremented (host machine)

book/src/framework/copying_files.md

@@ -0,0 +1,15 @@
+# Copying Files
+
+You can copy files to containers by using the `ContainerName` from the output and specifying the source `src` and destination `dst` paths.
+
+However, using this API is discouraged and will be **deprecated** in the future, as it violates the principles of "black-box" testing. If your service relies on this functionality, consider designing a configuration or API to address the requirement instead.
+
+```go
+	bc, err := blockchain.NewBlockchainNetwork(&blockchain.Input{
+	    ...
+	})
+	require.NoError(t, err)
+
+	err = dockerClient.CopyFile(bc.ContainerName, "local_file.txt", "/home")
+	require.NoError(t, err)
+```

framework/components/blockchain/anvil.go

@@ -55,8 +55,9 @@ func deployAnvil(in *Input) (*Output, error) {
 		return nil, err
 	}
 	return &Output{
-		UseCache: true,
-		ChainID:  in.ChainID,
+		UseCache:      true,
+		ChainID:       in.ChainID,
+		ContainerName: containerName,
 		Nodes: []*Node{
 			{
 				HostWSUrl:             fmt.Sprintf("ws://%s:%s", host, mp.Port()),

framework/components/blockchain/blockchain.go

@@ -17,9 +17,10 @@ type Input struct {
 
 // Output is a blockchain network output, ChainID and one or more nodes that forms the network
 type Output struct {
-	UseCache bool    `toml:"use_cache"`
-	ChainID  string  `toml:"chain_id"`
-	Nodes    []*Node `toml:"nodes"`
+	UseCache      bool    `toml:"use_cache"`
+	ContainerName string  `toml:"container_name"`
+	ChainID       string  `toml:"chain_id"`
+	Nodes         []*Node `toml:"nodes"`
 }
 
 // Node represents blockchain node output, URLs required for connection locally and inside docker network

framework/components/clnode/clnode.go

@@ -64,6 +64,7 @@ type Output struct {
 type NodeOut struct {
 	APIAuthUser     string `toml:"api_auth_user"`
 	APIAuthPassword string `toml:"api_auth_password"`
+	ContainerName   string `toml:"container_name"`
 	HostURL         string `toml:"url"`
 	HostP2PURL      string `toml:"p2p_url"`
 	DockerURL       string `toml:"docker_internal_url"`
@@ -288,6 +289,7 @@ func newNode(in *Input, pgOut *postgres.Output) (*NodeOut, error) {
 	return &NodeOut{
 		APIAuthUser:     DefaultAPIUser,
 		APIAuthPassword: DefaultAPIPassword,
+		ContainerName:   containerName,
 		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),

framework/components/postgres/postgres.go

@@ -33,14 +33,15 @@ type Input struct {
 
 type Output struct {
 	Url               string `toml:"url"`
+	ContainerName     string `toml:"container_name"`
 	DockerInternalURL string `toml:"docker_internal_url"`
 }
 
 func NewPostgreSQL(in *Input) (*Output, error) {
 	ctx := context.Background()
 
 	bindPort := fmt.Sprintf("%s/tcp", Port)
-	containerName := framework.DefaultTCName("postgresql")
+	containerName := "ns-postgresql"
 
 	var sqlCommands []string
 	for i := 0; i <= in.Databases; i++ {
@@ -126,6 +127,7 @@ func NewPostgreSQL(in *Input) (*Output, error) {
 		return nil, err
 	}
 	return &Output{
+		ContainerName: containerName,
 		DockerInternalURL: fmt.Sprintf(
 			"postgresql://%s:%s@%s:%s/%s?sslmode=disable",
 			User,

framework/components/simple_node_set/reload.go

@@ -9,7 +9,7 @@ import (
 // UpgradeNodeSet updates nodes configuration TOML files
 // this API is discouraged, however, you can use it if nodes require restart or configuration updates, temporarily!
 func UpgradeNodeSet(in *Input, bc *blockchain.Output, wait time.Duration) (*Output, error) {
-	_, err := chaos.ExecPumba("rm --volumes=false re2:node.*|postgresql.*", wait)
+	_, err := chaos.ExecPumba("rm --volumes=false re2:node.*|ns-postgresql.*", wait)
 	if err != nil {
 		return nil, err
 	}

framework/docker.go

@@ -1,13 +1,17 @@
 package framework
 
 import (
+	"archive/tar"
+	"bytes"
 	"context"
 	"errors"
 	"fmt"
+	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/client"
 	"github.com/docker/go-connections/nat"
 	"github.com/google/uuid"
 	tc "github.com/testcontainers/testcontainers-go"
+	"io"
 	"os"
 	"os/exec"
 	"strings"
@@ -132,3 +136,86 @@ func RebuildDockerImage(once *sync.Once, dockerfile string, buildContext string,
 	}
 	return fmt.Sprintf("localhost:5050/%s:latest", imageName), nil
 }
+
+// DockerClient wraps a Docker API client and provides convenience methods
+type DockerClient struct {
+	cli *client.Client
+}
+
+// NewDockerClient creates a new instance of DockerClient
+func NewDockerClient() (*DockerClient, error) {
+	cli, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
+	if err != nil {
+		return nil, fmt.Errorf("failed to create Docker client: %w", err)
+	}
+	return &DockerClient{cli: cli}, nil
+}
+
+// CopyFile copies a file into a container by name
+func (dc *DockerClient) CopyFile(containerName, sourceFile, targetPath string) error {
+	ctx := context.Background()
+	containerID, err := dc.findContainerIDByName(ctx, containerName)
+	if err != nil {
+		return fmt.Errorf("failed to find container ID by name: %s", containerName)
+	}
+	return dc.copyToContainer(containerID, sourceFile, targetPath)
+}
+
+// findContainerIDByName finds a container ID by its name
+func (dc *DockerClient) findContainerIDByName(ctx context.Context, containerName string) (string, error) {
+	containers, err := dc.cli.ContainerList(ctx, container.ListOptions{
+		All: true,
+	})
+	if err != nil {
+		return "", fmt.Errorf("failed to list containers: %w", err)
+	}
+	for _, c := range containers {
+		for _, name := range c.Names {
+			if name == "/"+containerName {
+				return c.ID, nil
+			}
+		}
+	}
+	return "", fmt.Errorf("container with name %s not found", containerName)
+}
+
+// copyToContainer copies a file into a container
+func (dc *DockerClient) copyToContainer(containerID, sourceFile, targetPath string) error {
+	ctx := context.Background()
+	src, err := os.Open(sourceFile)
+	if err != nil {
+		return fmt.Errorf("could not open source file: %w", err)
+	}
+	defer src.Close()
+
+	// Create a tar archive containing the file
+	var buf bytes.Buffer
+	tw := tar.NewWriter(&buf)
+	info, err := src.Stat()
+	if err != nil {
+		return fmt.Errorf("could not stat source file: %w", err)
+	}
+
+	// Add file to tar
+	header := &tar.Header{
+		Name: info.Name(),
+		Size: info.Size(),
+		Mode: int64(info.Mode()),
+	}
+	if err := tw.WriteHeader(header); err != nil {
+		return fmt.Errorf("could not write tar header: %w", err)
+	}
+	if _, err := io.Copy(tw, src); err != nil {
+		return fmt.Errorf("could not write file to tar archive: %w", err)
+	}
+	tw.Close()
+
+	// Copy the tar archive to the container
+	err = dc.cli.CopyToContainer(ctx, containerID, targetPath, &buf, container.CopyToContainerOptions{
+		AllowOverwriteDirWithFile: true,
+	})
+	if err != nil {
+		return fmt.Errorf("could not copy file to container: %w", err)
+	}
+	return nil
+}

framework/examples/myproject/.envrc

@@ -1,3 +1,4 @@
 export LOKI_TENANT_ID=promtail
 export LOKI_URL=http://localhost:3030/loki/api/v1/push
 export TESTCONTAINERS_RYUK_DISABLED=true
+export CTF_LOG_LEVEL=info