Skip to content

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

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

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

If you need to test Pulsar IO framework you can enable the Pulsar Functions Worker with the WithFunctionsWorker option:

testcontainerspulsar.WithFunctionsWorker(),

WithTransactions

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

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container methods

Once you have a Pulsar container, then you can retrieve the broker and the admin url:

Admin URL

serviceURL, err := c.HTTPServiceURL(ctx)

Broker URL

brokerURL, err := c.BrokerURL(ctx)