Consul¶
Since v0.28.0
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¶
ctx := context.Background()
consulContainer, err := consul.Run(ctx, "hashicorp/consul:1.15")
defer func() {
if err := testcontainers.TerminateContainer(consulContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}
Module Reference¶
Run function¶
- Since v0.32.0
Info
The RunContainer(ctx, opts...)
function is deprecated and will be removed in the next major release of Testcontainers for Go.
The Consul module exposes one entrypoint function to create the Consul container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*ConsulContainer, error)
context.Context
, the Go context.string
, the Docker image to use.testcontainers.ContainerCustomizer
, a variadic argument for passing options.
Image¶
Use the second argument in the Run
function to set a valid Docker image.
In example: Run(context.Background(), "hashicorp/consul:1.15")
.
Container Options¶
When starting the Consul container, you can pass options in a variadic way to configure it.
Configuration File¶
- Since v0.28.0
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.
The following options are exposed by the testcontainers
package.
Basic Options¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Not available until the next release mainWithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Not available until the next release mainWithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Not available until the next release mainWithAdditionalLifecycleHooks
Not available until the next release mainWithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Not available until the next release mainWithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Not available until the next release mainWithImageSubstitutors
Since v0.26.0WithImagePlatform
Not available until the next release main
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Not available until the next release mainWithBridgeNetwork
Not available until the next release mainWithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Not available until the next release mainWithNoStart
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
The Consul container exposes the following method:
ApiEndpoint¶
- Since v0.28.0
This method returns the connection string to connect to the Consul container API, using the default 8500
port.
ctx := context.Background()
consulContainer, err := consul.Run(ctx, "hashicorp/consul:1.15")
defer func() {
if err := testcontainers.TerminateContainer(consulContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}
endpoint, err := consulContainer.ApiEndpoint(ctx)
if err != nil {
log.Printf("failed to get endpoint: %s", err)
return
}
config := capi.DefaultConfig()
config.Address = endpoint
client, err := capi.NewClient(config)
if err != nil {
log.Printf("failed to connect to Consul: %s", err)
return
}