-
-
Notifications
You must be signed in to change notification settings - Fork 510
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* added consul module * removed existing examples * added WithConfigFile and examples. swapped panics with fatalf * removed more references * chore: run make lint * chore: reverse assertion * chore: fix lint * docs: use pinned version in docs --------- Co-authored-by: Manuel de la Peña <mdelapenya@gmail.com>
- Loading branch information
1 parent
1f628e2
commit 50fc8e7
Showing
17 changed files
with
333 additions
and
120 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 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,58 @@ | ||
| # Consul | ||
|
|
||
| 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 Consul. | ||
|
|
||
| ## Adding this module to your project dependencies | ||
|
|
||
| Please run the following command to add the Consul module to your Go dependencies: | ||
|
|
||
| ``` | ||
| go get github.com/testcontainers/testcontainers-go/modules/consul | ||
| ``` | ||
|
|
||
| ## Usage example | ||
|
|
||
| <!--codeinclude--> | ||
| [Creating a Consul container](../../modules/consul/examples_test.go) inside_block:runConsulContainer | ||
| <!--/codeinclude--> | ||
|
|
||
| ## Module reference | ||
|
|
||
| The Consul module exposes one entrypoint function to create the Consul container, and this function receives two parameters: | ||
|
|
||
| ```golang | ||
| func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*ConsulContainer, error) | ||
| ``` | ||
|
|
||
| - `context.Context`, the Go context. | ||
| - `testcontainers.ContainerCustomizer`, a variadic argument for passing options. | ||
|
|
||
| ### Container Options | ||
|
|
||
| When starting the Consul container, you can pass options in a variadic way to configure it. | ||
|
|
||
| #### Image | ||
|
|
||
| If you need to set a different Consul Docker image, you can use `testcontainers.WithImage` with a valid Docker image | ||
| for Consul. E.g. `testcontainers.WithImage("docker.io/hashicorp/consul:1.15")`. | ||
|
|
||
| {% include "../features/common_functional_options.md" %} | ||
|
|
||
| #### Configuration File | ||
| If you need to customize the behavior for the deployed node you can use either `WithConfigString(config string)` or `WithConfigFile(configPath string)`. | ||
| The configuration has to be in JSON format and will be loaded at the node startup. | ||
|
|
||
| ### Container Methods | ||
|
|
||
| The Consul container exposes the following method: | ||
|
|
||
| #### ApiEndpoint | ||
| This method returns the connection string to connect to the Consul container API, using the default `8500` port. | ||
|
|
||
| <!--codeinclude--> | ||
| [Using ApiEndpoint with the Consul client](../../modules/consul/examples_test.go) inside_block:connectConsul | ||
| <!--/codeinclude--> |
This file was deleted.
Oops, something went wrong.
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
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 |
|---|---|---|
|
|
@@ -3,3 +3,4 @@ include ../../commons-test.mk | |
| .PHONY: test | ||
| test: | ||
| $(MAKE) test-consul | ||
|
|
||
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,88 @@ | ||
| package consul | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/testcontainers/testcontainers-go" | ||
| "github.com/testcontainers/testcontainers-go/wait" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultHttpApiPort = "8500" | ||
| defaultBrokerPort = "8600" | ||
| ) | ||
|
|
||
| const ( | ||
| DefaultBaseImage = "docker.io/hashicorp/consul:1.15" | ||
| ) | ||
|
|
||
| // ConsulContainer represents the Consul container type used in the module. | ||
| type ConsulContainer struct { | ||
| testcontainers.Container | ||
| } | ||
|
|
||
| // ApiEndpoint returns host:port for the HTTP API endpoint. | ||
| func (c *ConsulContainer) ApiEndpoint(ctx context.Context) (string, error) { | ||
| mappedPort, err := c.MappedPort(ctx, defaultHttpApiPort) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| hostIP, err := c.Host(ctx) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| uri := fmt.Sprintf("%s:%s", hostIP, mappedPort.Port()) | ||
| return uri, nil | ||
| } | ||
|
|
||
| // WithConfigString takes in a JSON string of keys and values to define a configuration to be used by the instance. | ||
| func WithConfigString(config string) testcontainers.CustomizeRequestOption { | ||
| return func(req *testcontainers.GenericContainerRequest) { | ||
| req.Env["CONSUL_LOCAL_CONFIG"] = config | ||
| } | ||
| } | ||
|
|
||
| // WithConfigFile takes in a path to a JSON file to define a configuration to be used by the instance. | ||
| func WithConfigFile(configPath string) testcontainers.CustomizeRequestOption { | ||
| return func(req *testcontainers.GenericContainerRequest) { | ||
| cf := testcontainers.ContainerFile{ | ||
| HostFilePath: configPath, | ||
| ContainerFilePath: "/consul/config/node.json", | ||
| FileMode: 0o755, | ||
| } | ||
| req.Files = append(req.Files, cf) | ||
| } | ||
| } | ||
|
|
||
| // RunContainer creates an instance of the Consul container type | ||
| func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*ConsulContainer, error) { | ||
| containerReq := testcontainers.GenericContainerRequest{ | ||
| ContainerRequest: testcontainers.ContainerRequest{ | ||
| Image: DefaultBaseImage, | ||
| ExposedPorts: []string{ | ||
| defaultHttpApiPort + "/tcp", | ||
| defaultBrokerPort + "/tcp", | ||
| defaultBrokerPort + "/udp", | ||
| }, | ||
| Env: map[string]string{}, | ||
| WaitingFor: wait.ForAll( | ||
| wait.ForLog("Consul agent running!"), | ||
| ), | ||
| }, | ||
| Started: true, | ||
| } | ||
|
|
||
| for _, opt := range opts { | ||
| opt.Customize(&containerReq) | ||
| } | ||
|
|
||
| container, err := testcontainers.GenericContainer(ctx, containerReq) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &ConsulContainer{Container: container}, nil | ||
| } |
Oops, something went wrong.