feat(memcached): add memcached module

.github/dependabot.yml

@@ -44,6 +44,7 @@ updates:
         - /modules/localstack
         - /modules/mariadb
         - /modules/meilisearch
+        - /modules/memcached
         - /modules/milvus
         - /modules/minio
         - /modules/mockserver

.vscode/.testcontainers-go.code-workspace

@@ -125,6 +125,10 @@
             "name": "module / meilisearch",
             "path": "../modules/meilisearch"
         },
+        {
+            "name": "module / memcached",
+            "path": "../modules/memcached"
+        },
         {
             "name": "module / milvus",
             "path": "../modules/milvus"

docs/modules/memcached.md

@@ -0,0 +1,62 @@
+# Memcached
+
+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>
+
+## Introduction
+
+The Testcontainers module for Memcached.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the Memcached module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/memcached
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a Memcached container](../../modules/memcached/examples_test.go) inside_block:runMemcachedContainer
+<!--/codeinclude-->
+
+## Module Reference
+
+### Run function
+
+- 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 Memcached module exposes one entrypoint function to create the Memcached container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
+```
+
+- `context.Context`, the Go context.
+- `string`, the Docker image to use.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the Memcached container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+Use the second argument in the `Run` function to set a valid Docker image.
+In example: `Run(context.Background(), "memcached:1.6-alpine")`.
+
+{% include "../features/common_functional_options.md" %}
+
+### Container Methods
+
+The Memcached container exposes the following methods:
+
+#### HostPort
+
+- 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 `HostPort` method returns the host and port of the Memcached container, in the format `host:port`. Use this method to connect to the Memcached container from your application.
+
+<!--codeinclude-->
+[Get host:port](../../modules/memcached/examples_test.go) inside_block:hostPort
+<!--/codeinclude-->

mkdocs.yml

@@ -97,6 +97,7 @@ nav:
         - modules/localstack.md
         - modules/mariadb.md
         - modules/meilisearch.md
+        - modules/memcached.md
         - modules/milvus.md
         - modules/minio.md
         - modules/mockserver.md

modules/memcached/Makefile

@@ -0,0 +1,5 @@
+include ../../commons-test.mk
+
+.PHONY: test
+test:
+	$(MAKE) test-memcached

modules/memcached/examples_test.go

@@ -0,0 +1,82 @@
+package memcached_test
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/bradfitz/gomemcache/memcache"
+
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/memcached"
+)
+
+func ExampleRun() {
+	// runMemcachedContainer {
+	ctx := context.Background()
+
+	memcachedContainer, err := memcached.Run(ctx, "memcached:1.6-alpine")
+	defer func() {
+		if err := testcontainers.TerminateContainer(memcachedContainer); err != nil {
+			log.Printf("failed to terminate container: %s", err)
+		}
+	}()
+	if err != nil {
+		log.Printf("failed to start container: %s", err)
+		return
+	}
+	// }
+
+	state, err := memcachedContainer.State(ctx)
+	if err != nil {
+		log.Printf("failed to get container state: %s", err)
+		return
+	}
+
+	fmt.Println(state.Running)
+
+	// Output:
+	// true
+}
+
+func ExampleRun_connect() {
+	ctx := context.Background()
+
+	memcachedContainer, err := memcached.Run(ctx, "memcached:1.6-alpine")
+	defer func() {
+		if err := testcontainers.TerminateContainer(memcachedContainer); err != nil {
+			log.Printf("failed to terminate container: %s", err)
+		}
+	}()
+	if err != nil {
+		log.Printf("failed to start container: %s", err)
+		return
+	}
+
+	// hostPort {
+	hostPort, err := memcachedContainer.HostPort(ctx)
+	if err != nil {
+		log.Printf("failed to get host and port: %s", err)
+		return
+	}
+	// }
+
+	mc := memcache.New(hostPort)
+
+	err = mc.Set(&memcache.Item{Key: "foo", Value: []byte("my value")})
+	if err != nil {
+		log.Printf("failed to set item: %s", err)
+		return
+	}
+
+	it, err := mc.Get("foo")
+	if err != nil {
+		log.Printf("failed to get item: %s", err)
+		return
+	}
+
+	fmt.Println(string(it.Value))
+
+	// Output:
+	// my value
+}

modules/memcached/go.mod

@@ -0,0 +1,65 @@
+module github.com/testcontainers/testcontainers-go/modules/memcached
+
+go 1.23.0
+
+require (
+	github.com/bradfitz/gomemcache v0.0.0-20250403215159-8d39553ac7cf
+	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/cenkalti/backoff/v4 v4.2.1 // 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/docker v28.0.1+incompatible // indirect
+	github.com/docker/go-connections v0.5.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/go-logr/logr v1.4.2 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/klauspost/compress v1.17.4 // indirect
+	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
+	github.com/magiconair/properties v1.8.10 // indirect
+	github.com/moby/docker-image-spec v1.3.1 // indirect
+	github.com/moby/patternmatcher v0.6.0 // indirect
+	github.com/moby/sys/sequential v0.5.0 // indirect
+	github.com/moby/sys/user v0.1.0 // indirect
+	github.com/moby/sys/userns v0.1.0 // indirect
+	github.com/moby/term v0.5.0 // 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/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/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.35.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.35.0 // indirect
+	go.opentelemetry.io/otel/metric v1.35.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.35.0 // indirect
+	go.opentelemetry.io/otel/trace v1.35.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.6.0 // indirect
+	golang.org/x/crypto v0.37.0 // indirect
+	golang.org/x/sys v0.32.0 // indirect
+	google.golang.org/protobuf v1.36.6 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
+
+replace github.com/testcontainers/testcontainers-go => ../..