Merge branch 'main' into dev-tools

* main:
  chore: replace 'assert' with 'require' (#2827)
  chore: replace 'assert' with 'require' for critical checks (#2824)
  chore: bump ryuk to latest release (#2818)
  feat: add require for critical checks (#2812)
  chore(deps): bump release-drafter/release-drafter from 5.25.0 to 6.0.0 (#2805)
  feat: add etcd module (#2788)
  feat: add dynamodb-local module (#2799)
  fix(redpanda): wait for (#2794)
  fix(elasticsearch): wait for (#2724)
  chore: update dockercfg module (#2801)

Author: mdelapenya

.github/workflows/ci.yml

@@ -94,7 +94,7 @@ jobs:
       matrix:
         go-version: [1.22.x, 1.x]
         platform: [ubuntu-latest]
-        module: [artemis, azurite, cassandra, chroma, clickhouse, cockroachdb, compose, consul, couchbase, databend, dolt, elasticsearch, gcloud, grafana-lgtm, inbucket, influxdb, k3s, k6, kafka, localstack, mariadb, milvus, minio, mockserver, mongodb, mssql, mysql, nats, neo4j, ollama, openfga, openldap, opensearch, postgres, pulsar, qdrant, rabbitmq, redis, redpanda, registry, surrealdb, valkey, vault, vearch, weaviate]
+        module: [artemis, azurite, cassandra, chroma, clickhouse, cockroachdb, compose, consul, couchbase, databend, dolt, dynamodb, elasticsearch, etcd, gcloud, grafana-lgtm, inbucket, influxdb, k3s, k6, kafka, localstack, mariadb, milvus, minio, mockserver, mongodb, mssql, mysql, nats, neo4j, ollama, openfga, openldap, opensearch, postgres, pulsar, qdrant, rabbitmq, redis, redpanda, registry, surrealdb, valkey, vault, vearch, weaviate]
     uses: ./.github/workflows/ci-test-go.yml
     with:
       go-version: ${{ matrix.go-version }}

.github/workflows/release-drafter.yml

@@ -16,6 +16,6 @@ jobs:
       pull-requests: write  # for release-drafter/release-drafter to add label to PR
     runs-on: ubuntu-latest
     steps:
-      - uses: release-drafter/release-drafter@09c613e259eb8d4e7c81c2cb00618eb5fc4575a7 # v5.19.0
+      - uses: release-drafter/release-drafter@3f0f87098bd6b5c5b9a36d49c41d998ea58f9348 # v5.19.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.vscode/.testcontainers-go.code-workspace

@@ -61,10 +61,18 @@
             "name": "module / dolt",
             "path": "../modules/dolt"
         },
+        {
+            "name": "module / dynamodb",
+            "path": "../modules/dynamodb"
+        },
         {
             "name": "module / elasticsearch",
             "path": "../modules/elasticsearch"
         },
+        {
+            "name": "module / etcd",
+            "path": "../modules/etcd"
+        },
         {
             "name": "module / gcloud",
             "path": "../modules/gcloud"

cmd/devtools/main_test.go

@@ -148,7 +148,11 @@ func TestModule_Validate(outer *testing.T) {
 
 	for _, test := range tests {
 		outer.Run(test.name, func(t *testing.T) {
-			assert.Equal(t, test.expectedErr, test.module.Validate())
+			if test.expectedErr != nil {
+				require.EqualError(t, test.module.Validate(), test.expectedErr.Error())
+			} else {
+				require.NoError(t, test.module.Validate())
+			}
 		})
 	}
 }
@@ -277,7 +281,7 @@ func TestGenerate(t *testing.T) {
 
 	moduleDirFileInfo, err := os.Stat(moduleDirPath)
 	require.NoError(t, err) // error nil implies the file exist
-	assert.True(t, moduleDirFileInfo.IsDir())
+	require.True(t, moduleDirFileInfo.IsDir())
 
 	moduleDocFile := filepath.Join(examplesDocTmp, moduleNameLower+".md")
 	_, err = os.Stat(moduleDocFile)
@@ -333,7 +337,7 @@ func TestGenerateModule(t *testing.T) {
 
 	moduleDirFileInfo, err := os.Stat(moduleDirPath)
 	require.NoError(t, err) // error nil implies the file exist
-	assert.True(t, moduleDirFileInfo.IsDir())
+	require.True(t, moduleDirFileInfo.IsDir())
 
 	moduleDocFile := filepath.Join(modulesDocTmp, moduleNameLower+".md")
 	_, err = os.Stat(moduleDocFile)

cmd/devtools/mkdocs_test.go

@@ -40,9 +40,9 @@ func TestReadMkDocsConfig(t *testing.T) {
 	require.NoError(t, err)
 	require.NotNil(t, config)
 
-	assert.Equal(t, "Testcontainers for Go", config.SiteName)
-	assert.Equal(t, "https://github.com/testcontainers/testcontainers-go", config.RepoURL)
-	assert.Equal(t, "edit/main/docs/", config.EditURI)
+	require.Equal(t, "Testcontainers for Go", config.SiteName)
+	require.Equal(t, "https://github.com/testcontainers/testcontainers-go", config.RepoURL)
+	require.Equal(t, "edit/main/docs/", config.EditURI)
 
 	// theme
 	theme := config.Theme
@@ -51,9 +51,9 @@ func TestReadMkDocsConfig(t *testing.T) {
 	// nav bar
 	nav := config.Nav
 	assert.Equal(t, "index.md", nav[0].Home)
-	assert.NotEmpty(t, nav[2].Features)
-	assert.NotEmpty(t, nav[3].Modules)
-	assert.NotEmpty(t, nav[4].Examples)
+	require.NotEmpty(t, nav[2].Features)
+	require.NotEmpty(t, nav[3].Modules)
+	require.NotEmpty(t, nav[4].Examples)
 }
 
 func TestNavItems(t *testing.T) {

container_ignore_test.go

@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestParseDockerIgnore(t *testing.T) {
@@ -37,7 +38,7 @@ func TestParseDockerIgnore(t *testing.T) {
 	for _, testCase := range testCases {
 		exists, excluded, err := parseDockerIgnore(testCase.filePath)
 		assert.Equal(t, testCase.exists, exists)
-		assert.Equal(t, testCase.expectedErr, err)
+		require.ErrorIs(t, testCase.expectedErr, err)
 		assert.Equal(t, testCase.expectedExcluded, excluded)
 	}
 }

container_test.go

@@ -320,7 +320,7 @@ func TestCustomLabelsImage(t *testing.T) {
 	ctr, err := testcontainers.GenericContainer(ctx, req)
 
 	require.NoError(t, err)
-	t.Cleanup(func() { assert.NoError(t, ctr.Terminate(ctx)) })
+	t.Cleanup(func() { require.NoError(t, ctr.Terminate(ctx)) })
 
 	ctrJSON, err := ctr.Inspect(ctx)
 	require.NoError(t, err)

docker_test.go

@@ -307,7 +307,7 @@ func TestContainerStateAfterTermination(t *testing.T) {
 		state, err := nginx.State(ctx)
 		require.Error(t, err, "expected error from container inspect.")
 
-		assert.Nil(t, state, "expected nil container inspect.")
+		require.Nil(t, state, "expected nil container inspect.")
 	})
 
 	t.Run("Nil State after termination if raw as already set", func(t *testing.T) {
@@ -1339,7 +1339,7 @@ func TestContainerInspect_RawInspectIsCleanedOnStop(t *testing.T) {
 	inspect, err := ctr.Inspect(context.Background())
 	require.NoError(t, err)
 
-	assert.NotEmpty(t, inspect.ID)
+	require.NotEmpty(t, inspect.ID)
 
 	require.NoError(t, ctr.Stop(context.Background(), nil))
 }
@@ -1698,7 +1698,7 @@ func TestDockerContainerCopyEmptyFileFromContainer(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	assert.Empty(t, fileContentFromContainer)
+	require.Empty(t, fileContentFromContainer)
 }
 
 func TestDockerContainerResources(t *testing.T) {

docs/modules/dynamodb.md

@@ -0,0 +1,77 @@
+# DynamoDB
+
+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 DynamoDB.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the DynamoDB module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/dynamodb
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a DynamoDB container](../../modules/dynamodb/examples_test.go) inside_block:runDynamoDBContainer
+<!--/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 DynamoDB module exposes one entrypoint function to create the DynamoDB container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DynamoDBContainer, 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 DynamoDB container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different DynamoDB Docker image, you can set a valid Docker image as the second argument in the `Run` function.
+E.g. `Run(context.Background(), "amazon/dynamodb-local:2.2.1")`.
+
+{% include "../features/common_functional_options.md" %}
+
+#### WithSharedDB
+
+- 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 `WithSharedDB` option tells the DynamoDB container to use a single database file. At the same time, it marks the container as reusable, which causes that successive calls to the `Run` function will return the same container instance, and therefore, the same database file.
+
+#### WithDisableTelemetry
+
+- 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>
+
+You can turn off telemetry when starting the DynamoDB container, using the option `WithDisableTelemetry`.
+
+### Container Methods
+
+The DynamoDB container exposes the following methods:
+
+#### ConnectionString
+
+- 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 `ConnectionString` method returns the connection string to the DynamoDB container. This connection string can be used to connect to the DynamoDB container from your application,
+using the AWS SDK or any other DynamoDB client of your choice.
+
+<!--codeinclude-->
+[Creating a client](../../modules/dynamodb/dynamodb_test.go) inside_block:createClient
+<!--/codeinclude-->
+
+The above example uses `github.com/aws/aws-sdk-go-v2/service/dynamodb` to create a client and connect to the DynamoDB container.

docs/modules/etcd.md

@@ -0,0 +1,95 @@
+# etcd
+
+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 etcd.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the etcd module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/etcd
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a etcd container](../../modules/etcd/examples_test.go) inside_block:runetcdContainer
+<!--/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 etcd module exposes one entrypoint function to create the etcd container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*etcdContainer, 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 etcd container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different etcd Docker image, you can set a valid Docker image as the second argument in the `Run` function.
+E.g. `Run(context.Background(), "bitnami/etcd:latest")`.
+
+{% include "../features/common_functional_options.md" %}
+
+#### WithAdditionalArgs
+
+- 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>
+
+You can pass additional arguments to the etcd container by using the `WithAdditionalArgs` option. The arguments are passed to the CMD of the etcd container.
+
+#### WithDataDir
+
+- 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>
+
+You can set the data directory for the etcd container by using the `WithDataDir` boolean option. The data directory where the etcd data is stored is `/data.etcd`.
+
+#### WithNodes
+
+- 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>
+
+You can set the number of nodes for the etcd cluster by using the `WithNodes` option, passing the node names for each of the nodes. Single-node clusters are not allowed,
+for that reason the functional option receives three string arguments: the first node, the second node, and a variadic argument for the rest of the nodes.
+The module starts a container for each node, having the first node a reference to the other nodes. E.g. `WithNodes("etcd-1", "etcd-2")`, `WithNodes("etcd-1", "etcd-2", "etcd-3")` and so on.
+
+The module creates a Docker network for the etcd cluster, and the nodes are connected to this network, so that they can communicate with each other through the network.
+
+#### WithClusterToken
+
+- 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>
+
+Sets the cluster token for the etcd cluster. The cluster token is used to identify the etcd cluster. The default value is `mys3cr3ttok3n`.
+The etcd container holds a reference to the cluster token, so you can use it with e.g. `ctr.ClusterToken`.
+
+### Container Methods
+
+- 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 etcd container exposes the following methods:
+
+#### ClientEndpoint
+
+- 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>
+
+Returns the client endpoint for the etcd container and an error, if any. In the case of a cluster, it returns the client endpoint for the first node.
+
+#### PeerEndpoint
+
+- 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>
+
+Returns the peer endpoint for the etcd container and an error, if any. In the case of a cluster, it returns the peer endpoint for the first node.