Merge branch 'main' into dependabot/go_modules/github.com/magiconair/properties-1.8.10

* main:
  feat(postgres): add WithOrderedInitScripts for Postgres testcontainers (#3121)
  feat(redis): add TLS support (#3115)
  feat: add Docker Model Runner module (#3106)

Author: mdelapenya

.github/dependabot.yml

@@ -29,6 +29,7 @@ updates:
         - /modules/couchbase
         - /modules/databend
         - /modules/dind
+        - /modules/dockermodelrunner
         - /modules/dolt
         - /modules/dynamodb
         - /modules/elasticsearch

.vscode/.testcontainers-go.code-workspace

@@ -9,6 +9,10 @@
             "name": "example / nginx",
             "path": "../examples/nginx"
         },
+        {
+            "name": "module / aerospike",
+            "path": "../modules/aerospike"
+        },
         {
             "name": "module / arangodb",
             "path": "../modules/arangodb"
@@ -61,6 +65,10 @@
             "name": "module / dind",
             "path": "../modules/dind"
         },
+        {
+            "name": "module / dockermodelrunner",
+            "path": "../modules/dockermodelrunner"
+        },
         {
             "name": "module / dolt",
             "path": "../modules/dolt"

docs/modules/dockermodelrunner.md

@@ -0,0 +1,110 @@
+# Docker Model Runner
+
+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 DockerModelRunner.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the DockerModelRunner module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/dockermodelrunner
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a DockerModelRunner container](../../modules/dockermodelrunner/examples_test.go) inside_block:runWithModel
+<!--/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 Docker Model Runner module exposes two entrypoint functions to create the Docker Model Runner container:
+
+#### Run
+
+This function receives two parameters:
+
+```golang
+func Run(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*Container, error)
+```
+
+- `context.Context`, the Go context.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+!!! info
+    This function will use the default `socat` image under the hood. Please refer to the [socat module](../socat.md) for more information.
+
+### Container Options
+
+When starting the Docker Model Runner 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(), "alpine/socat:1.8.0.1")`.
+
+{% include "../features/common_functional_options.md" %}
+
+#### WithModel
+
+- 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>
+
+Use the `WithModel` option to set the model to pull when the container is started. Please be aware, that only Models as OCI Artifacts are compatible with Docker Model Runner.
+
+```golang
+dockermodelrunner.WithModel("ai/llama3.2:latest")
+```
+
+!!! warning
+    Multiple calls to this function overrides the previous value.
+
+ You can find a curated collection of cutting-edge AI models as OCI Artifacts, from lightweight on-device models to high-performance LLMs on [Docker Hub](https://hub.docker.com/u/ai).
+
+### Container Methods
+
+The Docker Model Runner container exposes the following methods:
+
+#### PullModel
+
+- 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>
+
+Use the `PullModel` method to pull a model from the Docker Model Runner.
+
+<!--codeinclude-->
+[Pulling a model at runtime](../../modules/dockermodelrunner/examples_test.go) inside_block:runPullModel
+<!--/codeinclude-->
+
+!!! info
+     You can find a curated collection of cutting-edge AI models as OCI Artifacts, from lightweight on-device models to high-performance LLMs on [Docker Hub](https://hub.docker.com/u/ai).
+
+#### InspectModel
+
+- 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>
+
+Use the `InspectModel` method to inspect a model from the Docker Model Runner, by providing the model namespace and name.
+
+<!--codeinclude-->
+[Getting a model at runtime](../../modules/dockermodelrunner/examples_test.go) inside_block:runInspectModel
+<!--/codeinclude-->
+
+The namespace and name of the model is in the format of `<name>:<tag>`, which defines Models as OCI Artifacts in Docker Hub, therefore the namespace is the organization and the name is the repository.
+
+E.g. `ai/smollm2:360M-Q4_K_M`. See [Models as OCI Artifacts](https://hub.docker.com/u/ai) for more information.
+
+#### ListModels
+
+- 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>
+
+Use the `ListModels` method to list all models that are already pulled locally, using the Docker Model Runner format.
+
+<!--codeinclude-->
+[Listing all models](../../modules/dockermodelrunner/examples_test.go) inside_block:runListModels
+<!--/codeinclude-->

docs/modules/postgres.md

@@ -70,6 +70,14 @@ An example of a `*.sh` script that creates a user and database is shown below:
 [Init script content](../../modules/postgres/testdata/init-user-db.sh)
 <!--/codeinclude-->
 
+#### Ordered Init Scripts
+
+If you would like to run the init scripts in a specific order, you can use the `WithOrderedInitScripts` function, which copies the given scripts in the order they are provided to the container, prefixed with the order number so that Postgres executes them in the correct order.
+
+<!--codeinclude-->
+[Ordered init scripts](../../modules/postgres/postgres_test.go) inside_block:orderedInitScripts
+<!--/codeinclude-->
+
 #### Database configuration
 
 In the case you have a custom config file for Postgres, it's possible to copy that file into the container before it's started, using the `WithConfigFile(cfgPath string)` function.

docs/modules/redis.md

@@ -62,7 +62,7 @@ By default Redis saves snapshots of the dataset on disk, in a binary file called
 
 #### Log Level
 
-By default Redis saves snapshots of the dataset on disk, in a binary file called dump.rdb. You can configure Redis to have it save the dataset every N seconds if there are at least M changes in the dataset. E.g. `WithLogLevel(LogLevelDebug)`.
+By default Redis produces a log message to the standard Redis log, the format accepts printf-alike specifiers, while level is a string describing the log level to use when emitting the log, and must be one of the following: `LogLevelDebug`, `LogLevelVerbose`, `LogLevelNotice`, `LogLevelWarning`. E.g. `WithLogLevel(LogLevelDebug)`. If the specified log level is invalid, verbose is used by default.
 
 !!!tip
     Please check [Redis docs on logging](https://redis.io/docs/reference/modules/modules-api-ref/#redismodule_log) for more information.
@@ -71,24 +71,33 @@ By default Redis saves snapshots of the dataset on disk, in a binary file called
 
 In the case you have a custom config file for Redis, it's possible to copy that file into the container before it's started. E.g. `WithConfigFile(filepath.Join("testdata", "redis7.conf"))`.
 
+#### WithTLS
+
+In the case you want to enable TLS for the Redis container, you can use the `WithTLS()` option. This options enables TLS on the `6379/tcp` port and uses a secure URL (e.g. `rediss://host:port`).
+
+!!!info
+    In case you want to use Non-mutual TLS (i.e. client authentication is not required), you can customize the CMD arguments by using the `WithCmdArgs` option. E.g. `WithCmdArgs("--tls-auth-clients no")`.
+
+The module automatically generates three certificates, a CA certificate, a client certificate and a Redis certificate. Please use the `TLSConfig()` container method to get the TLS configuration and use it to configure the Redis client. See more details in the [TLSConfig](#tlsconfig) section.
+
 ### Container Methods
 
 #### ConnectionString
 
-This method returns the connection string to connect to the Redis container, using the default `6379` port.
+This method returns the connection string to connect to the Redis container, using the default `6379` port, and `redis` schema.
 
 <!--codeinclude-->
 [Get connection string](../../modules/redis/redis_test.go) inside_block:connectionString
 <!--/codeinclude-->
 
-### Redis variants
+If the container is started with TLS enabled, the connection string is `rediss://host:port`, using the `rediss` schema.
 
-It's possible to use the Redis container with Redis-Stack. You simply need to update the image name.
+#### TLSConfig
 
-<!--codeinclude-->
-[Image for Redis-Stack](../../modules/redis/redis_test.go) inside_block:redisStackImage
-<!--/codeinclude-->
+This method returns the TLS configuration for the Redis container, nil if TLS is not enabled.
 
 <!--codeinclude-->
-[Image for Redis-Stack Server](../../modules/redis/redis_test.go) inside_block:redisStackServerImage
+[Get TLS config](../../modules/redis/redis_test.go) inside_block:tlsConfig
 <!--/codeinclude-->
+
+In the above example, the options are used to configure a Redis client with TLS enabled.

docs/modules/socat.md

@@ -47,8 +47,14 @@ When starting the Socat container, you can pass options in a variadic way to con
 
 #### Image
 
+The module exposes a default image:
+
+<!--codeinclude-->
+[Default Image](../../modules/socat/socat.go) inside_block:defaultImage
+<!--/codeinclude-->
+
 Use the second argument in the `Run` function to set a valid Docker image.
-In example: `Run(context.Background(), "alpine/socat:1.8.0.1")`.
+In example: `Run(context.Background(), DefaultImage)`.
 
 {% include "../features/common_functional_options.md" %}
 

mkdocs.yml

@@ -81,10 +81,12 @@ nav:
         - modules/couchbase.md
         - modules/databend.md
         - modules/dind.md
+        - modules/dockermodelrunner.md
         - modules/dolt.md
         - modules/dynamodb.md
         - modules/elasticsearch.md
         - modules/etcd.md
+        - modules/firebase.md
         - modules/gcloud.md
         - modules/grafana-lgtm.md
         - modules/inbucket.md

modules/dockermodelrunner/Makefile

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

modules/dockermodelrunner/docker_desktop_test.go

@@ -0,0 +1,44 @@
+package dockermodelrunner_test
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/log"
+)
+
+// skipIfDockerDesktopNotRunning skips the test if Docker Desktop is not running,
+// using the testing library and the log.TestLogger of Testcontainers
+func skipIfDockerDesktopNotRunning(t *testing.T) {
+	t.Helper()
+	isDDRunning, err := isDockerDesktopRunning(log.TestLogger(t))
+	require.NoError(t, err)
+
+	if !isDDRunning {
+		t.Skipf("Skipping because Docker Desktop is not running")
+	}
+}
+
+// isDockerDesktopRunning checks if Docker Desktop is running.
+func isDockerDesktopRunning(l log.Logger) (bool, error) {
+	cli, err := testcontainers.NewDockerClientWithOpts(context.Background())
+	if err != nil {
+		return false, fmt.Errorf("failed to create docker client: %w", err)
+	}
+
+	info, err := cli.Info(context.Background())
+	if err != nil {
+		return false, fmt.Errorf("failed to get docker info: %w", err)
+	}
+
+	if info.OperatingSystem == "Docker Desktop" {
+		return true, nil
+	}
+
+	l.Printf("Skipping because Docker Desktop is not running")
+	return false, nil
+}

modules/dockermodelrunner/dockermodelrunner.go

@@ -0,0 +1,71 @@
+package dockermodelrunner
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/dockermodelrunner/internal/sdk/client"
+	"github.com/testcontainers/testcontainers-go/modules/socat"
+	"github.com/testcontainers/testcontainers-go/wait"
+)
+
+const (
+	modelRunnerEntrypoint = "model-runner.docker.internal"
+	modelRunnerPort       = 80
+)
+
+// Container represents the DockerModelRunner container type used in the module
+type Container struct {
+	*socat.Container
+	*client.Client
+	model   string
+	baseURL string
+}
+
+// Run creates an instance of the DockerModelRunner container type.
+func Run(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*Container, error) {
+	settings := defaultOptions()
+
+	// Process model runner options.
+	for _, opt := range opts {
+		if apply, ok := opt.(Option); ok {
+			if err := apply(&settings); err != nil {
+				return nil, err
+			}
+		}
+	}
+
+	// Add socat options, which are applied to the socat container.
+	opts = append(opts, testcontainers.WithWaitStrategy(
+		wait.ForListeningPort("80/tcp"),
+		wait.ForHTTP("/").WithPort("80/tcp").WithStatusCodeMatcher(func(status int) bool {
+			return status == http.StatusOK
+		}),
+	))
+	opts = append(opts, socat.WithTarget(socat.NewTarget(modelRunnerPort, modelRunnerEntrypoint)))
+
+	socatCtr, err := socat.Run(ctx, socat.DefaultImage, opts...)
+	var c *Container
+	if socatCtr != nil {
+		c = &Container{Container: socatCtr, model: settings.model}
+	}
+
+	if err != nil {
+		return c, fmt.Errorf("socat run: %w", err)
+	}
+
+	c.baseURL = socatCtr.TargetURL(modelRunnerPort).String()
+
+	c.Client = client.NewClient(c.baseURL)
+
+	if settings.model != "" {
+		err := c.PullModel(ctx, settings.model)
+		if err != nil {
+			return c, fmt.Errorf("pull model: %w", err)
+		}
+	}
+
+	return c, nil
+}