Apache Pulsar¶
Since v0.19.0
Introduction¶
The Testcontainers module for Apache Pulsar.
Testcontainers can be used to automatically create Apache Pulsar containers without external services.
It's based on the official Apache Pulsar docker image, so it is recommended to read the official guide.
Adding this module to your project dependencies¶
Please run the following command to add the Apache Pulsar module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/pulsar
Usage example¶
Create a Pulsar
container to use it in your tests:
ctx := context.Background()
pulsarContainer, err := pulsar.Run(ctx, "apachepulsar/pulsar:2.10.2")
defer func() {
if err := testcontainers.TerminateContainer(pulsarContainer); 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 Pulsar module exposes one entrypoint function to create the container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, 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(), "apachepulsar/pulsar:2.10.2")
.
Container Options¶
When starting the Pulsar container, you can pass options in a variadic way to configure it.
WithPulsarEnv¶
- Since v0.19.0
If you need to set Pulsar configuration variables you can use the WithPulsarEnv
to set Pulsar environment variables: the PULSAR_PREFIX_
prefix will be automatically added for you.
For example, if you want to enable brokerDeduplicationEnabled
:
testcontainerspulsar.WithPulsarEnv("brokerDeduplicationEnabled", "true"),
It will result in the PULSAR_PREFIX_brokerDeduplicationEnabled=true
environment variable being set in the container request.
WithFunctionsWorker¶
- Since v0.19.0
If you need to test Pulsar IO framework you can enable the Pulsar Functions Worker with the WithFunctionsWorker
option:
testcontainerspulsar.WithFunctionsWorker(),
WithTransactions¶
- Since v0.19.0
If you need to test Pulsar Transactions you can enable the transactions feature:
testcontainerspulsar.WithTransactions(),
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¶
Once you have a Pulsar container, then you can retrieve the broker and the admin url:
Admin URL¶
- Since v0.19.0
serviceURL, err := c.HTTPServiceURL(ctx)
Broker URL¶
- Since v0.19.0
brokerURL, err := c.BrokerURL(ctx)