-
-
Notifications
You must be signed in to change notification settings - Fork 511
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into dependabot/go_modules/modules/compose/github…
….com/docker/compose/v2-2.24.3
- Loading branch information
Showing
93 changed files
with
2,450 additions
and
619 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # CockroachDB | ||
|
|
||
| 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 CockroachDB. | ||
|
|
||
| ## Adding this module to your project dependencies | ||
|
|
||
| Please run the following command to add the CockroachDB module to your Go dependencies: | ||
|
|
||
| ``` | ||
| go get github.com/testcontainers/testcontainers-go/modules/cockroachdb | ||
| ``` | ||
|
|
||
| ## Usage example | ||
|
|
||
| <!--codeinclude--> | ||
| [Creating a CockroachDB container](../../modules/cockroachdb/examples_test.go) inside_block:runCockroachDBContainer | ||
| <!--/codeinclude--> | ||
|
|
||
| ## Module reference | ||
|
|
||
| The CockroachDB module exposes one entrypoint function to create the CockroachDB container, and this function receives two parameters: | ||
|
|
||
| ```golang | ||
| func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*CockroachDBContainer, error) | ||
| ``` | ||
|
|
||
| - `context.Context`, the Go context. | ||
| - `testcontainers.ContainerCustomizer`, a variadic argument for passing options. | ||
|
|
||
| !!!warning | ||
| When TLS is enabled there's a very small, unlikely chance that the underlying driver can panic when registering the driver as part of waiting for CockroachDB to be ready to accept connections. If this is repeatedly happening please open an issue. | ||
|
|
||
| ### Container Options | ||
|
|
||
| When starting the CockroachDB container, you can pass options in a variadic way to configure it. | ||
|
|
||
| #### Image | ||
|
|
||
| If you need to set a different CockroachDB Docker image, you can use `testcontainers.WithImage` with a valid Docker image | ||
| for CockroachDB. E.g. `testcontainers.WithImage("cockroachdb/cockroach:latest-v23.1")`. | ||
|
|
||
| {% include "../features/common_functional_options.md" %} | ||
|
|
||
| #### Database | ||
|
|
||
| Set the database that is created & dialled with `cockroachdb.WithDatabase`. | ||
|
|
||
| #### Password authentication | ||
|
|
||
| Disable insecure mode and connect with password authentication by setting `cockroachdb.WithUser` and `cockroachdb.WithPassword`. | ||
|
|
||
| #### Store size | ||
|
|
||
| Control the maximum amount of memory used for storage, by default this is 100% but can be changed by provided a valid option to `WithStoreSize`. Checkout https://www.cockroachlabs.com/docs/stable/cockroach-start#store for the full range of options available. | ||
|
|
||
| #### TLS authentication | ||
|
|
||
| `cockroachdb.WithTLS` lets you provide the CA certificate along with the certicate and key for the node & clients to connect with. | ||
| Internally CockroachDB requires a client certificate for the user to connect with. | ||
|
|
||
| A helper `cockroachdb.NewTLSConfig` exists to generate all of this for you. | ||
|
|
||
| ### Container Methods | ||
|
|
||
| The CockroachDB container exposes the following methods: | ||
|
|
||
| #### ConnectionString | ||
|
|
||
| Dial address to open a new connection. | ||
|
|
||
| #### MustConnectionString | ||
|
|
||
| Same as `ConnectionString` but any error to generate the address will raise a panic | ||
|
|
||
| #### TLSConfig | ||
|
|
||
| Returns `*tls.Config` setup to allow you to dial your client over TLS, if enabled, else this will error with `cockroachdb.ErrTLSNotEnabled`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Inbucket | ||
|
|
||
| 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 Inbucket. | ||
|
|
||
| ## Adding this module to your project dependencies | ||
|
|
||
| Please run the following command to add the Inbucket module to your Go dependencies: | ||
|
|
||
| ``` | ||
| go get github.com/testcontainers/testcontainers-go/modules/inbucket | ||
| ``` | ||
|
|
||
| ## Usage example | ||
|
|
||
| <!--codeinclude--> | ||
| [Creating a Inbucket container](../../modules/inbucket/examples_test.go) inside_block:runInbucketContainer | ||
| <!--/codeinclude--> | ||
|
|
||
| ## Module reference | ||
|
|
||
| The Inbucket module exposes one entrypoint function to create the Inbucket container, and this function receives two parameters: | ||
|
|
||
| ```golang | ||
| func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*InbucketContainer, error) | ||
| ``` | ||
|
|
||
| - `context.Context`, the Go context. | ||
| - `testcontainers.ContainerCustomizer`, a variadic argument for passing options. | ||
|
|
||
| ### Container Options | ||
|
|
||
| When starting the Inbucket container, you can pass options in a variadic way to configure it. | ||
|
|
||
| #### Image | ||
|
|
||
| If you need to set a different Inbucket Docker image, you can use `testcontainers.WithImage` with a valid Docker image | ||
| for Inbucket. E.g. `testcontainers.WithImage("inbucket/inbucket:sha-2d409bb")`. | ||
|
|
||
| {% include "../features/common_functional_options.md" %} | ||
|
|
||
| ### Container Methods | ||
|
|
||
| The Inbucket container exposes the following methods: | ||
|
|
||
| #### SmtpConnection | ||
|
|
||
| This method returns the connection string to connect to the Inbucket container SMTP service, using the `2500` port. | ||
|
|
||
| <!--codeinclude--> | ||
| [Get smtp connection string](../../modules/inbucket/inbucket_test.go) inside_block:smtpConnection | ||
| <!--/codeinclude--> | ||
|
|
||
| #### WebInterface | ||
|
|
||
| This method returns the connection string to connect to the Inbucket container web interface, using the `9000` port. | ||
|
|
||
| <!--codeinclude--> | ||
| [Get web interface connection string](../../modules/inbucket/inbucket_test.go) inside_block:webInterface | ||
| <!--/codeinclude--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # OpenLDAP | ||
|
|
||
| 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 OpenLDAP. | ||
|
|
||
| ## Adding this module to your project dependencies | ||
|
|
||
| Please run the following command to add the OpenLDAP module to your Go dependencies: | ||
|
|
||
| ``` | ||
| go get github.com/testcontainers/testcontainers-go/modules/openldap | ||
| ``` | ||
|
|
||
| ## Usage example | ||
|
|
||
| <!--codeinclude--> | ||
| [Creating a OpenLDAP container](../../modules/openldap/examples_test.go) inside_block:runOpenLDAPContainer | ||
| <!--/codeinclude--> | ||
|
|
||
| ## Module reference | ||
|
|
||
| The OpenLDAP module exposes one entrypoint function to create the OpenLDAP container, and this function receives two parameters: | ||
|
|
||
| ```golang | ||
| func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*OpenLDAPContainer, error) | ||
| ``` | ||
|
|
||
| - `context.Context`, the Go context. | ||
| - `testcontainers.ContainerCustomizer`, a variadic argument for passing options. | ||
|
|
||
| ### Container Options | ||
|
|
||
| When starting the OpenLDAP container, you can pass options in a variadic way to configure it. | ||
|
|
||
| #### Image | ||
|
|
||
| If you need to set a different OpenLDAP Docker image, you can use `testcontainers.WithImage` with a valid Docker image | ||
| for OpenLDAP. E.g. `testcontainers.WithImage("bitnami/openldap:2.6.6")`. | ||
|
|
||
| {% include "../features/common_functional_options.md" %} | ||
|
|
||
| ### Container Methods | ||
|
|
||
| The OpenLDAP container exposes the following methods: | ||
|
|
||
| #### ConnectionString | ||
|
|
||
| This method returns the connection string to connect to the OpenLDAP container, using the `1389` port. | ||
|
|
||
| <!--codeinclude--> | ||
| [Get connection string](../../modules/openldap/openldap_test.go) inside_block:connectionString | ||
| <!--/codeinclude--> | ||
|
|
||
| #### LoadLdif | ||
|
|
||
| This method loads an ldif file in the OpenLDAP server. | ||
| It returns and error if there is any problem with the ldif file loading process. | ||
|
|
||
| <!--codeinclude--> | ||
| [Load ldif](../../modules/openldap/openldap_test.go) inside_block:loadLdif | ||
| <!--/codeinclude--> | ||
|
|
||
| #### Initial Ldif | ||
|
|
||
| If you would like to load an ldif at the initialization of the openldap container, you can use `WithInititialLdif` function. | ||
| The file will be copied after the container is started and loaded in openldap. |
Oops, something went wrong.