feat: add an option to pass a config file

Author: mdelapenya

docs/modules/toxiproxy.md

@@ -65,6 +65,20 @@ you to create a unique proxy for each container. The default port range is `31`.
 func WithPortRange(portRange int) Option
 ```
 
+#### WithConfigFile
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The `WithConfigFile` option allows you to specify a config file for the Toxiproxy container, in the form of an `io.Reader` representing
+the JSON file with the Toxiproxy configuration.
+
+!!! warning
+    The config file is not validated by the Toxiproxy container.
+
+```golang
+func WithConfigFile(r io.Reader) testcontainers.CustomizeRequestOption
+```
+
 ### Container Methods
 
 The Toxiproxy container exposes the following methods:

modules/toxiproxy/options.go

@@ -2,6 +2,7 @@ package toxiproxy
 
 import (
 	"errors"
+	"io"
 
 	"github.com/testcontainers/testcontainers-go"
 )
@@ -40,3 +41,21 @@ func WithPortRange(portRange int) Option {
 		return nil
 	}
 }
+
+// WithConfigFile sets the config file for the Toxiproxy container, copying
+// the file to the "/tmp/tc-toxiproxy.json" path. It also appends the "-host=0.0.0.0"
+// and "-config=/tmp/tc-toxiproxy.json" flags to the command line.
+// The config file is a JSON file that contains the configuration for the Toxiproxy container,
+// and it is not validated by the Toxiproxy container.
+func WithConfigFile(r io.Reader) testcontainers.CustomizeRequestOption {
+	return func(req *testcontainers.GenericContainerRequest) error {
+		req.Files = append(req.Files, testcontainers.ContainerFile{
+			Reader:            r,
+			ContainerFilePath: "/tmp/tc-toxiproxy.json",
+			FileMode:          0o644,
+		})
+
+		req.Cmd = append(req.Cmd, "-host=0.0.0.0", "-config=/tmp/tc-toxiproxy.json")
+		return nil
+	}
+}

modules/toxiproxy/testdata/toxiproxy.json

@@ -0,0 +1,8 @@
+[
+    {
+        "name": "redis",
+        "listen": "0.0.0.0:8666",
+        "upstream": "redis:6379",
+        "enabled": true
+    }
+]

modules/toxiproxy/toxiproxy_test.go

@@ -1,19 +1,28 @@
 package toxiproxy_test
 
 import (
+	"bytes"
 	"context"
+	_ "embed"
+	"fmt"
 	"testing"
+	"time"
 
+	toxiproxy "github.com/Shopify/toxiproxy/v2/client"
+	"github.com/go-redis/redis/v8"
+	"github.com/google/uuid"
 	"github.com/stretchr/testify/require"
 
 	"github.com/testcontainers/testcontainers-go"
-	"github.com/testcontainers/testcontainers-go/modules/toxiproxy"
+	tcredis "github.com/testcontainers/testcontainers-go/modules/redis"
+	tctoxiproxy "github.com/testcontainers/testcontainers-go/modules/toxiproxy"
+	"github.com/testcontainers/testcontainers-go/network"
 )
 
 func TestRun(t *testing.T) {
 	ctx := context.Background()
 
-	ctr, err := toxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0")
+	ctr, err := tctoxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0")
 	testcontainers.CleanupContainer(t, ctr)
 	require.NoError(t, err)
 
@@ -26,7 +35,7 @@ func TestRun_withPortRange(t *testing.T) {
 	t.Run("no-port-range", func(t *testing.T) {
 		portsCount := 31 // default port range is 31 (not exposed)
 
-		ctr, err := toxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0")
+		ctr, err := tctoxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0")
 		testcontainers.CleanupContainer(t, ctr)
 		require.NoError(t, err)
 		jsonInspect, err := ctr.Inspect(ctx)
@@ -37,7 +46,7 @@ func TestRun_withPortRange(t *testing.T) {
 	t.Run("negative-port", func(t *testing.T) {
 		portsCount := -1
 
-		ctr, err := toxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", toxiproxy.WithPortRange(portsCount))
+		ctr, err := tctoxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", tctoxiproxy.WithPortRange(portsCount))
 		testcontainers.CleanupContainer(t, ctr)
 		require.Error(t, err)
 		require.Nil(t, ctr)
@@ -46,7 +55,7 @@ func TestRun_withPortRange(t *testing.T) {
 	t.Run("zero-port", func(t *testing.T) {
 		portsCount := 0
 
-		ctr, err := toxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", toxiproxy.WithPortRange(portsCount))
+		ctr, err := tctoxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", tctoxiproxy.WithPortRange(portsCount))
 		testcontainers.CleanupContainer(t, ctr)
 		require.Error(t, err)
 		require.Nil(t, ctr)
@@ -55,7 +64,7 @@ func TestRun_withPortRange(t *testing.T) {
 	t.Run("one-port", func(t *testing.T) {
 		portsCount := 1
 
-		ctr, err := toxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", toxiproxy.WithPortRange(portsCount))
+		ctr, err := tctoxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", tctoxiproxy.WithPortRange(portsCount))
 		testcontainers.CleanupContainer(t, ctr)
 		require.NoError(t, err)
 
@@ -67,7 +76,7 @@ func TestRun_withPortRange(t *testing.T) {
 	t.Run("more-than-default-port", func(t *testing.T) {
 		portsCount := 75
 
-		ctr, err := toxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", toxiproxy.WithPortRange(portsCount))
+		ctr, err := tctoxiproxy.Run(ctx, "ghcr.io/shopify/toxiproxy:2.12.0", tctoxiproxy.WithPortRange(portsCount))
 		testcontainers.CleanupContainer(t, ctr)
 		require.NoError(t, err)
 
@@ -76,3 +85,99 @@ func TestRun_withPortRange(t *testing.T) {
 		require.Len(t, jsonInspect.HostConfig.PortBindings, portsCount+1)
 	})
 }
+
+//go:embed testdata/toxiproxy.json
+var configFile []byte
+
+func TestRun_withConfigFile(t *testing.T) {
+	ctx := context.Background()
+
+	nw, err := network.New(ctx)
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		require.NoError(t, nw.Remove(ctx))
+	})
+
+	redisContainer, err := tcredis.Run(
+		ctx,
+		"redis:6-alpine",
+		network.WithNetwork([]string{"redis"}, nw),
+	)
+	testcontainers.CleanupContainer(t, redisContainer)
+	require.NoError(t, err)
+
+	toxiproxyContainer, err := tctoxiproxy.Run(
+		ctx,
+		"ghcr.io/shopify/toxiproxy:2.12.0",
+		tctoxiproxy.WithPortRange(31),
+		tctoxiproxy.WithConfigFile(bytes.NewReader(configFile)),
+		network.WithNetwork([]string{"toxiproxy"}, nw),
+	)
+	testcontainers.CleanupContainer(t, toxiproxyContainer)
+	require.NoError(t, err)
+
+	toxiURI, err := toxiproxyContainer.URI(ctx)
+	require.NoError(t, err)
+
+	toxiproxyClient := toxiproxy.NewClient(toxiURI)
+
+	toxiproxyProxyPort, err := toxiproxyContainer.MappedPort(ctx, "8666/tcp")
+	require.NoError(t, err)
+
+	toxiproxyProxyHostIP, err := toxiproxyContainer.Host(ctx)
+	require.NoError(t, err)
+
+	// Create a redis client that connects to the toxiproxy container.
+	// We are defining a read timeout of 2 seconds, because we are adding
+	// a latency toxic of 1 second to the request, +/- 100ms jitter.
+	redisURI := fmt.Sprintf("redis://%s:%s?read_timeout=2s", toxiproxyProxyHostIP, toxiproxyProxyPort.Port())
+
+	options, err := redis.ParseURL(redisURI)
+	require.NoError(t, err)
+
+	redisCli := redis.NewClient(options)
+	t.Cleanup(func() {
+		require.NoError(t, redisCli.FlushAll(ctx).Err())
+	})
+
+	key := fmt.Sprintf("{user.%s}.favoritefood", uuid.NewString())
+	value := "Cabbage Biscuits"
+	ttl, err := time.ParseDuration("2h")
+	require.NoError(t, err)
+
+	err = redisCli.Set(ctx, key, value, ttl).Err()
+	require.NoError(t, err)
+
+	// Add a latency toxic to the proxy
+	toxicOptions := &toxiproxy.ToxicOptions{
+		ProxyName: "redis", // name of the proxy in the config file
+		ToxicName: "latency_down",
+		ToxicType: "latency",
+		Toxicity:  1.0,
+		Stream:    "downstream",
+		Attributes: map[string]interface{}{
+			"latency": 1_000,
+			"jitter":  100,
+		},
+	}
+	_, err = toxiproxyClient.AddToxic(toxicOptions)
+	require.NoError(t, err)
+
+	start := time.Now()
+	// Get data
+	savedValue, err := redisCli.Get(ctx, key).Result()
+	require.NoError(t, err)
+
+	duration := time.Since(start)
+
+	t.Logf("Duration: %s\n", duration)
+
+	// The value is retrieved successfully
+	require.Equal(t, value, savedValue)
+
+	// Check that latency is within expected range (900ms-1100ms)
+	// The latency toxic adds 1000ms (1000ms +/- 100ms jitter)
+	minDuration := 900 * time.Millisecond
+	maxDuration := 1100 * time.Millisecond
+	require.True(t, duration >= minDuration && duration <= maxDuration)
+}