chore: add an example of using localstack alongside AWS lambdas

generic.go

@@ -11,6 +11,8 @@ import (
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/network"
 
+	"github.com/testcontainers/testcontainers-go/internal/testcontainersdocker"
+	"github.com/testcontainers/testcontainers-go/internal/testcontainerssession"
 	"github.com/testcontainers/testcontainers-go/wait"
 )
 
@@ -204,3 +206,8 @@ type GenericProvider interface {
 	NetworkProvider
 	ImageProvider
 }
+
+// GenericLabels returns a map of labels that can be used to identify containers created by this library
+func GenericLabels() map[string]string {
+	return testcontainersdocker.DefaultLabels(testcontainerssession.SessionID())
+}

modules/localstack/examples_test.go

@@ -3,9 +3,12 @@ package localstack_test
 import (
 	"context"
 	"fmt"
+	"io"
+	"path/filepath"
 	"time"
 
 	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/exec"
 	"github.com/testcontainers/testcontainers-go/modules/localstack"
 	"github.com/testcontainers/testcontainers-go/wait"
 )
@@ -113,3 +116,86 @@ func ExampleRunContainer_legacyMode() {
 	// Output:
 	// version=localstack/localstack:0.10.0. Testcontainers for Go does not support running LocalStack in legacy mode. Please use a version >= 0.11.0
 }
+
+func ExampleRunContainer_usingLambdas() {
+	ctx := context.Background()
+
+	flagsFn := func() string {
+		labels := testcontainers.GenericLabels()
+
+		flags := ""
+		for k, v := range labels {
+			flags = fmt.Sprintf("%s -l %s=%s", flags, k, v)
+		}
+
+		return flags
+	}
+
+	lambdaName := "localstack-lambda-url-example"
+
+	container, err := localstack.RunContainer(ctx,
+		testcontainers.WithImage("localstack/localstack:2.3.0"),
+		testcontainers.CustomizeRequest(testcontainers.GenericContainerRequest{
+			ContainerRequest: testcontainers.ContainerRequest{
+				Env: map[string]string{
+					"SERVICES":            "lambda",
+					"LAMBDA_DOCKER_FLAGS": flagsFn(),
+				},
+				Files: []testcontainers.ContainerFile{
+					{
+						HostFilePath:      filepath.Join("testdata", "function.zip"),
+						ContainerFilePath: "/tmp/function.zip",
+					},
+				},
+			},
+		}),
+	)
+	if err != nil {
+		panic(err)
+	}
+	defer func() {
+		err := container.Terminate(ctx)
+		if err != nil {
+			panic(err)
+		}
+	}()
+
+	// the three commands below are doing the following:
+	// 1. create a lambda function
+	// 2. wait for the lambda function to be active
+	// 3. invoke the lambda function with a payload, writing the result to the output.txt file
+	lambdaCommands := [][]string{
+		{
+			"awslocal", "lambda",
+			"create-function", "--function-name", lambdaName,
+			"--runtime", "nodejs18.x",
+			"--zip-file",
+			"fileb:///tmp/function.zip",
+			"--handler", "index.handler",
+			"--role", "arn:aws:iam::000000000000:role/lambda-role",
+		},
+		{"awslocal", "lambda", "wait", "function-active-v2", "--function-name", lambdaName},
+		{"awslocal", "lambda", "invoke", "--function-name", lambdaName, "--payload", `{"body": "{\"num1\": \"10\", \"num2\": \"10\"}" }`, "output.txt"},
+	}
+	for _, cmd := range lambdaCommands {
+		_, _, err = container.Exec(ctx, cmd)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	// the output.txt file lives in the WORKDIR of the localstack container
+	_, reader, err := container.Exec(ctx, []string{"cat", "output.txt"}, exec.Multiplexed())
+	if err != nil {
+		panic(err)
+	}
+
+	content, err := io.ReadAll(reader)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(string(content))
+
+	// Output:
+	// {"statusCode":200,"body":"The product of 10 and 10 is 100"}
+}

modules/localstack/go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/config v1.18.44
 	github.com/aws/aws-sdk-go-v2/credentials v1.13.42
 	github.com/aws/aws-sdk-go-v2/service/s3 v1.40.1
+	github.com/docker/docker v24.0.6+incompatible
 	github.com/docker/go-connections v0.4.0
 	github.com/stretchr/testify v1.8.4
 	github.com/testcontainers/testcontainers-go v0.25.0
@@ -38,7 +39,6 @@ require (
 	github.com/cpuguy83/dockercfg v0.3.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/docker/distribution v2.8.2+incompatible // indirect
-	github.com/docker/docker v24.0.6+incompatible // indirect
 	github.com/docker/go-units v0.5.0 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect

modules/localstack/localstack.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/docker/docker/api/types/container"
 	"golang.org/x/mod/semver"
 
 	"github.com/testcontainers/testcontainers-go"
@@ -92,10 +93,12 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize
 
 	req := testcontainers.ContainerRequest{
 		Image:        fmt.Sprintf("localstack/localstack:%s", defaultVersion),
-		Binds:        []string{fmt.Sprintf("%s:/var/run/docker.sock", dockerHost)},
 		WaitingFor:   wait.ForHTTP("/_localstack/health").WithPort("4566/tcp").WithStartupTimeout(120 * time.Second),
 		ExposedPorts: []string{fmt.Sprintf("%d/tcp", defaultPort)},
 		Env:          map[string]string{},
+		HostConfigModifier: func(hostConfig *container.HostConfig) {
+			hostConfig.Binds = []string{fmt.Sprintf("%s:/var/run/docker.sock", dockerHost)}
+		},
 	}
 
 	localStackReq := LocalStackContainerRequest{

modules/localstack/testdata/index.js

@@ -0,0 +1,9 @@
+exports.handler = async (event) => {
+    let body = JSON.parse(event.body)
+    const product = body.num1 * body.num2;
+    const response = {
+        statusCode: 200,
+        body: "The product of " + body.num1 + " and " + body.num2 + " is " + product,
+    };
+    return response;
+};