Apache Pulsar
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/pulsarUsage example
Create a Pulsar container to use it in your tests:
Creating a Pulsar container
ctx := context.Background()
pulsarContainer, err := pulsar.Run(ctx, "apachepulsar/pulsar:4.0.9")
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:4.0.9").
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:
Set configuration variables
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:
Create a Pulsar container with functions worker
testcontainerspulsar.WithFunctionsWorker(),WithTransactions
- Since v0.19.0
If you need to test Pulsar Transactions you can enable the transactions feature:
Create a Pulsar container with transactions
testcontainerspulsar.WithTransactions(),The following options are exposed by the testcontainers package.
Basic Options
WithExposedPortsSince v0.37.0WithEnvSince v0.29.0WithWaitStrategySince v0.20.0WithAdditionalWaitStrategySince v0.38.0WithWaitStrategyAndDeadlineSince v0.20.0WithAdditionalWaitStrategyAndDeadlineSince v0.38.0WithEntrypointSince v0.37.0WithEntrypointArgsSince v0.37.0WithCmdSince v0.37.0WithCmdArgsSince v0.37.0WithLabelsSince v0.37.0
Lifecycle Options
WithLifecycleHooksSince v0.38.0WithAdditionalLifecycleHooksSince v0.38.0WithStartupCommandSince v0.25.0WithAfterReadyCommandSince v0.28.0
Files & Mounts Options
WithFilesSince v0.37.0WithMountsSince v0.37.0WithTmpfsSince v0.37.0WithImageMountSince v0.37.0
Build Options
WithDockerfileSince v0.37.0
Logging Options
WithLogConsumersSince v0.28.0WithLogConsumerConfigSince v0.38.0WithLoggerSince v0.29.0
Image Options
WithAlwaysPullSince v0.38.0WithImageSubstitutorsSince v0.26.0WithImagePlatformSince v0.38.0
Networking Options
WithNetworkSince v0.27.0WithNetworkByNameSince v0.38.0WithBridgeNetworkSince v0.38.0WithNewNetworkSince v0.27.0
Advanced Options
WithHostPortAccessSince v0.31.0WithConfigModifierSince v0.20.0 · Chainable since mainWithHostConfigModifierSince v0.20.0 · Chainable since mainWithEndpointSettingsModifierSince v0.20.0 · Chainable since mainCustomizeRequestSince v0.20.0WithNameSince v0.38.0WithNoStartSince v0.38.0WithProviderSince v0.39.0
Experimental Options
WithReuseByNameSince 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
Get admin url
serviceURL, err := c.HTTPServiceURL(ctx)Broker URL
- Since v0.19.0
Get broker url
brokerURL, err := c.BrokerURL(ctx)评论
登录后参与评论
KnowForge