Merge branch 'main' into gui/move-container-test-to-test-package

testcontainers · Mar 6, 2024 · 28dd258 · 28dd258
2 parents d1e51a6 + c2c7d52
commit 28dd258
Show file tree

Hide file tree

Showing 112 changed files with 2,370 additions and 780 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -212,6 +212,13 @@ updates:
         day: sunday
       open-pull-requests-limit: 3
       rebase-strategy: disabled
+    - package-ecosystem: gomod
+      directory: /modules/ollama
+      schedule:
+        interval: monthly
+        day: sunday
+      open-pull-requests-limit: 3
+      rebase-strategy: disabled
     - package-ecosystem: gomod
       directory: /modules/openldap
       schedule:
@@ -268,6 +275,13 @@ updates:
         day: sunday
       open-pull-requests-limit: 3
       rebase-strategy: disabled
+    - package-ecosystem: gomod
+      directory: /modules/surrealdb
+      schedule:
+        interval: monthly
+        day: sunday
+      open-pull-requests-limit: 3
+      rebase-strategy: disabled
     - package-ecosystem: gomod
       directory: /modules/vault
       schedule:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -104,7 +104,7 @@ jobs:
       matrix:
         go-version: [1.21.x, 1.x]
         platform: [ubuntu-latest]
-        module: [artemis, cassandra, chroma, clickhouse, cockroachdb, compose, consul, couchbase, elasticsearch, gcloud, inbucket, k3s, k6, kafka, localstack, mariadb, milvus, minio, mockserver, mongodb, mssql, mysql, nats, neo4j, openldap, opensearch, postgres, pulsar, qdrant, rabbitmq, redis, redpanda, vault, weaviate]
+        module: [artemis, cassandra, chroma, clickhouse, cockroachdb, compose, consul, couchbase, elasticsearch, gcloud, inbucket, k3s, k6, kafka, localstack, mariadb, milvus, minio, mockserver, mongodb, mssql, mysql, nats, neo4j, ollama, openldap, opensearch, postgres, pulsar, qdrant, rabbitmq, redis, redpanda, surrealdb, vault, weaviate]
     uses: ./.github/workflows/ci-test-go.yml
     with:
       go-version: ${{ matrix.go-version }}

diff --git a/.vscode/.testcontainers-go.code-workspace b/.vscode/.testcontainers-go.code-workspace
@@ -109,6 +109,10 @@
             "name": "module / neo4j",
             "path": "../modules/neo4j"
         },
+        {
+            "name": "module / ollama",
+            "path": "../modules/ollama"
+        },
         {
             "name": "module / openldap",
             "path": "../modules/openldap"
@@ -141,6 +145,10 @@
             "name": "module / redpanda",
             "path": "../modules/redpanda"
         },
+        {
+            "name": "module / surrealdb",
+            "path": "../modules/surrealdb"
+        },
         {
             "name": "module / vault",
             "path": "../modules/vault"

diff --git a/container_test.go b/container_test.go
@@ -321,7 +321,7 @@ func Test_GetLogsFromFailedContainer(t *testing.T) {
 		Started:          true,
 	})
 
-	if err != nil && err.Error() != "container exited with code 0: failed to start container" {
+	if err != nil && err.Error() != "failed to start container: container exited with code 0" {
 		t.Fatal(err)
 	} else if err == nil {
 		terminateContainerOnEnd(t, ctx, c)

diff --git a/docs/features/common_functional_options.md b/docs/features/common_functional_options.md
@@ -17,7 +17,7 @@ Using the `WithImageSubstitutors` options, you could define your own substitutio
 
 #### WithEnv
 
-- 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>
+- Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
 
 If you need to either pass additional environment variables to a container or override them, you can use `testcontainers.WithEnv` for example:
 
@@ -43,7 +43,7 @@ func (g *TestLogConsumer) Accept(l Log) {
 
 #### WithLogger
 
-- 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>
+- Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
 
 If you need to either pass logger to a container, you can use `testcontainers.WithLogger`.
 

diff --git a/docs/modules/chroma.md b/docs/modules/chroma.md
@@ -1,6 +1,6 @@
 # Chroma
 
-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>
+Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
 
 ## Introduction
 

diff --git a/docs/modules/k3s.md b/docs/modules/k3s.md
@@ -49,6 +49,20 @@ for K3s. E.g. `testcontainers.WithImage("docker.io/rancher/k3s:v1.27.1-k3s1")`.
 
 {% include "../features/common_functional_options.md" %}
 
+## WithManifest
+
+The `WithManifest` option loads a manifest obtained from a local file into the cluster. K3s applies it automatically during the startup process
+
+```golang
+func WithManifest(manifestPath string) testcontainers.CustomizeRequestOption
+```
+
+Example:
+
+```golang
+        WithManifest("nginx-manifest.yaml")
+```
+
 ### Container Methods
 
 The K3s container exposes the following methods:

diff --git a/docs/modules/milvus.md b/docs/modules/milvus.md
@@ -1,6 +1,6 @@
 # Milvus
 
-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>
+Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
 
 ## Introduction
 

diff --git a/docs/modules/mongodb.md b/docs/modules/mongodb.md
@@ -17,7 +17,7 @@ go get github.com/testcontainers/testcontainers-go/modules/mongodb
 ## Usage example
 
 <!--codeinclude-->
-[Creating a MongoDB container](../../modules/mongodb/mongodb_test.go) inside_block:runMongoDBContainer
+[Creating a MongoDB container](../../modules/mongodb/examples_test.go) inside_block:runMongoDBContainer
 <!--/codeinclude-->
 
 ## Module reference
@@ -72,5 +72,5 @@ It returns a string with the format `mongodb://<host>:<port>`.
 It can be use to configure a MongoDB client (`go.mongodb.org/mongo-driver/mongo`), e.g.:
 
 <!--codeinclude-->
-[Using ConnectionString with the MongoDB client](../../modules/mongodb/mongodb_test.go) inside_block:connectToMongo
+[Using ConnectionString with the MongoDB client](../../modules/mongodb/examples_test.go) inside_block:connectToMongo
 <!--/codeinclude-->
diff --git a/docs/modules/ollama.md b/docs/modules/ollama.md
@@ -0,0 +1,81 @@
+# Ollama
+
+Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
+
+## Introduction
+
+The Testcontainers module for Ollama.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the Ollama module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/ollama
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a Ollama container](../../modules/ollama/examples_test.go) inside_block:runOllamaContainer
+<!--/codeinclude-->
+
+## Module reference
+
+The Ollama module exposes one entrypoint function to create the Ollama container, and this function receives two parameters:
+
+```golang
+func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*OllamaContainer, error)
+```
+
+- `context.Context`, the Go context.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the Ollama container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different Ollama Docker image, you can use `testcontainers.WithImage` with a valid Docker image
+for Ollama. E.g. `testcontainers.WithImage("ollama/ollama:0.1.25")`.
+
+{% include "../features/common_functional_options.md" %}
+
+### Container Methods
+
+The Ollama container exposes the following methods:
+
+#### ConnectionString
+
+This method returns the connection string to connect to the Ollama container, using the default `11434` port.
+
+<!--codeinclude-->
+[Get connection string](../../modules/ollama/ollama_test.go) inside_block:connectionString
+<!--/codeinclude-->
+
+#### Commit
+
+This method commits the container to a new image, returning the new image ID.
+It should be used after a model has been pulled and loaded into the container in order to create a new image with the model,
+and eventually use it as the base image for a new container. That will speed up the execution of the following containers.
+
+<!--codeinclude-->
+[Commit Ollama image](../../modules/ollama/ollama_test.go) inside_block:commitOllamaContainer
+<!--/codeinclude-->
+
+## Examples
+
+### Loading Models
+
+It's possible to initialise the Ollama container with a specific model passed as parameter. The supported models are described in the Ollama project: [https://github.com/ollama/ollama?tab=readme-ov-file](https://github.com/ollama/ollama?tab=readme-ov-file) and [https://ollama.com/library](https://ollama.com/library).
+
+!!!warning
+    At the moment you use one of those models, the Ollama image will load the model and could take longer to start because of that.
+
+The following examples use the `llama2` model to connect to the Ollama container using HTTP and Langchain.
+
+<!--codeinclude-->
+[Using HTTP](../../modules/ollama/examples_test.go) inside_block:withHTTPModelLlama2
+[Using Langchaingo](../../modules/ollama/examples_test.go) inside_block:withLangchainModelLlama2
+<!--/codeinclude-->
diff --git a/docs/modules/opensearch.md b/docs/modules/opensearch.md
@@ -1,6 +1,6 @@
 # OpenSearch
 
-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>
+Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
 
 ## Introduction
 

diff --git a/docs/modules/qdrant.md b/docs/modules/qdrant.md
@@ -1,6 +1,6 @@
 # Qdrant
 
-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>
+Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
 
 ## Introduction
 

diff --git a/docs/modules/surrealdb.md b/docs/modules/surrealdb.md
@@ -0,0 +1,74 @@
+# SurrealDB
+
+Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
+
+## Introduction
+
+The Testcontainers module for SurrealDB.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the SurrealDB module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/surrealdb
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a SurrealDB container](../../modules/surrealdb/examples_test.go) inside_block:runSurrealDBContainer
+<!--/codeinclude-->
+
+## Module reference
+
+The SurrealDB module exposes one entrypoint function to create the SurrealDB container, and this function receives two parameters:
+
+```golang
+func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*SurrealDBContainer, error)
+```
+
+- `context.Context`, the Go context.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the SurrealDB container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different SurrealDB Docker image, you can use `testcontainers.WithImage` with a valid Docker image
+for SurrealDB. E.g. `testcontainers.WithImage("surrealdb/surrealdb:v1.1.1")`.
+
+{% include "../features/common_functional_options.md" %}
+
+#### Set username and password
+
+If you need to set different credentials, you can use `WithUsername` and `WithPassword` options.
+
+!!!info
+    The default values for the username and the password is `root`.
+
+#### WithAuthentication
+
+If you need to enable authentication, you can use `WithAuthentication` option. By default, it is disabled.
+
+#### WithStrictMode
+
+If you need to enable the strict mode for SurrealDB, you can use `WithStrictMode` option. By default, it is disabled.
+
+### WithAllowAllCaps
+
+If you need to enable the all caps mode for SurrealDB, you can use `WithAllowAllCaps` option. By default, it is disabled.
+
+### Container Methods
+
+The SurrealDB container exposes the following methods:
+
+#### URL
+
+This method returns the websocket URL string to connect to the SurrealDB API, using the `8000` port.
+
+<!--codeinclude-->
+[Get websocket URL string](../../modules/surrealdb/surrealdb_test.go) inside_block:websocketURL
+<!--/codeinclude-->
diff --git a/docs/modules/weaviate.md b/docs/modules/weaviate.md
@@ -1,6 +1,6 @@
 # Weaviate
 
-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>
+Since testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
 
 ## Introduction
 

diff --git a/examples/nginx/go.mod b/examples/nginx/go.mod
@@ -2,7 +2,7 @@ module github.com/testcontainers/testcontainers-go/examples/nginx
 
 go 1.21
 
-require github.com/testcontainers/testcontainers-go v0.28.0
+require github.com/testcontainers/testcontainers-go v0.29.1
 
 replace github.com/testcontainers/testcontainers-go => ../..
 
@@ -16,7 +16,7 @@ require (
 	github.com/containerd/log v0.1.0 // indirect
 	github.com/cpuguy83/dockercfg v0.3.1 // indirect
 	github.com/distribution/reference v0.5.0 // indirect
-	github.com/docker/docker v25.0.2+incompatible // indirect
+	github.com/docker/docker v25.0.3+incompatible // indirect
 	github.com/docker/go-connections v0.5.0 // indirect
 	github.com/docker/go-units v0.5.0 // indirect
 	github.com/felixge/httpsnoop v1.0.3 // indirect
@@ -49,9 +49,9 @@ require (
 	go.opentelemetry.io/otel/metric v1.19.0 // indirect
 	go.opentelemetry.io/otel/trace v1.19.0 // indirect
 	golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea // indirect
-	golang.org/x/mod v0.11.0 // indirect
+	golang.org/x/mod v0.16.0 // indirect
 	golang.org/x/sys v0.16.0 // indirect
-	golang.org/x/tools v0.10.0 // indirect
+	golang.org/x/tools v0.13.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20230711160842-782d3b101e98 // indirect
 	google.golang.org/grpc v1.58.3 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect

diff --git a/examples/nginx/go.sum b/examples/nginx/go.sum
@@ -23,8 +23,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/distribution/reference v0.5.0 h1:/FUIFXtfc/x2gpa5/VGfiGLuOIdYa1t65IKK2OFGvA0=
 github.com/distribution/reference v0.5.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E=
-github.com/docker/docker v25.0.2+incompatible h1:/OaKeauroa10K4Nqavw4zlhcDq/WBcPMc5DbjOGgozY=
-github.com/docker/docker v25.0.2+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
+github.com/docker/docker v25.0.3+incompatible h1:D5fy/lYmY7bvZa0XTZ5/UJPljor41F+vdyJG5luQLfQ=
+github.com/docker/docker v25.0.3+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/go-connections v0.5.0 h1:USnMq7hx7gwdVZq1L49hLXaFtUdTADjXGp+uj1Br63c=
 github.com/docker/go-connections v0.5.0/go.mod h1:ov60Kzw0kKElRwhNs9UlUHAE/F9Fe6GLaXnqyDdmEXc=
 github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4=
@@ -128,8 +128,8 @@ golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea h1:vLCWI/yYrdEHyN2JzIzPO3aaQ
 golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea/go.mod h1:V1LtkGg67GoY2N1AnLN78QLrzxkLyJw7RJb1gzOOz9w=
 golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
-golang.org/x/mod v0.11.0 h1:bUO06HqtnRcc/7l71XBe4WcqTZ+3AH1J59zWDDwLKgU=
-golang.org/x/mod v0.11.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
+golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic=
+golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
@@ -163,8 +163,8 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
 golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
 golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
-golang.org/x/tools v0.10.0 h1:tvDr/iQoUqNdohiYm0LmmKcBk+q86lb9EprIUFhHHGg=
-golang.org/x/tools v0.10.0/go.mod h1:UJwyiVBsOA2uwvK/e5OY3GTpDUJriEd+/YlqAwLPmyM=
+golang.org/x/tools v0.13.0 h1:Iey4qkscZuv0VvIt8E0neZjtPVQFSc870HQ448QgEmQ=
+golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=