Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: convert pulsar example into a Go module (#872)
* chore: move pulsar example to modules * chore: export Pulsar container type * chore: export Start container func * chore: support changing the pulsar image * chore: support defining custom image for pulsar * chore: support overriding the default waiting strategy * chore: support overriding the default env * chore: support overriding the default command * docs: document StartContainer function * chore: leverate modifiers * chore: create PulsarContainerRequest abstraction * chore: make a more advanced setup for the test * chore: support for setting function workers * chore: support for setting transactions * chore: support passing log consumers * chore: simplify initialisation of env * fix: use right module path * chore: migrate tests to its own package * chore: remove Pulsar from exported fields * chore: support retrieving broker and http admin URLs from the container * chore: support passing pulsar envs to the container request * docs: copy Java docs * docs: document modifiers * docs: fix heading * chore: improve tests to check that subscriptions are there * chore: simplify asserts * fix: update paths in GH workflow * fix: update dependabot for pulsar module * fix: typos
- Loading branch information
1 parent
ac06087
commit eb63c40
Showing
13 changed files
with
521 additions
and
160 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 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,96 @@ | ||
| # Apache Pulsar | ||
|
|
||
| Testcontainers can be used to automatically create [Apache Pulsar](https://pulsar.apache.org) containers without external services. | ||
|
|
||
| It's based on the official Apache Pulsar docker image, so it is recommended to read the [official guide](https://pulsar.apache.org/docs/next/getting-started-docker/). | ||
|
|
||
| ## 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: | ||
|
|
||
| <!--codeinclude--> | ||
| [Creating a Pulsar container](../../modules/pulsar/pulsar_test.go) inside_block:startPulsarContainer | ||
| <!--/codeinclude--> | ||
|
|
||
| where the `tt.opts` are the options to configure the container. See the [Container Options](#container-options) section for more details. | ||
|
|
||
| Then you can retrieve the broker and the admin url: | ||
|
|
||
| <!--codeinclude--> | ||
| [Get broker and admin urls](../../modules/pulsar/pulsar_test.go) inside_block:getPulsarURLs | ||
| <!--/codeinclude--> | ||
|
|
||
| ## Container Options | ||
|
|
||
| When starting the Pulsar container, you can pass options in a variadic way to configure it. | ||
|
|
||
| ### Pulsar Image | ||
| If you need to set a different Pulsar image you can use the `WithPulsarImage`. | ||
|
|
||
| <!--codeinclude--> | ||
| [Set Pulsar image](../../modules/pulsar/pulsar_test.go) inside_block:setPulsarImage | ||
| <!--/codeinclude--> | ||
|
|
||
| ### Pulsar Configuration | ||
| 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`: | ||
|
|
||
| <!--codeinclude--> | ||
| [Set configuration variables](../../modules/pulsar/pulsar_test.go) inside_block:addPulsarEnv | ||
| <!--/codeinclude--> | ||
|
|
||
| It will result in the `PULSAR_PREFIX_brokerDeduplicationEnabled=true` environment variable being set in the container request. | ||
|
|
||
| ### Pulsar IO | ||
|
|
||
| If you need to test Pulsar IO framework you can enable the Pulsar Functions Worker with the `WithFunctionsWorker` option: | ||
|
|
||
| <!--codeinclude--> | ||
| [Create a Pulsar container with functions worker](../../modules/pulsar/pulsar_test.go) inside_block:withFunctionsWorker | ||
| <!--/codeinclude--> | ||
|
|
||
| ### Pulsar Transactions | ||
|
|
||
| If you need to test Pulsar Transactions you can enable the transactions feature: | ||
|
|
||
| <!--codeinclude--> | ||
| [Create a Pulsar container with transactions](../../modules/pulsar/pulsar_test.go) inside_block:withTransactions | ||
| <!--/codeinclude--> | ||
|
|
||
| ### Log consumers | ||
| If you need to collect the logs from the Pulsar container, you can add your own LogConsumer with the `WithLogConsumers` function, which accepts a variadic argument of LogConsumers. | ||
|
|
||
| <!--codeinclude--> | ||
| [Adding LogConsumers](../../modules/pulsar/pulsar_test.go) inside_block:withLogConsumers | ||
| <!--/codeinclude--> | ||
|
|
||
| An example of a LogConsumer could be the following: | ||
|
|
||
| <!--codeinclude--> | ||
| [Example LogConsumer](../../modules/pulsar/pulsar_test.go) inside_block:logConsumerForTesting | ||
| <!--/codeinclude--> | ||
|
|
||
| !!!warning | ||
| You will need to explicitly stop the producer in your tests. | ||
|
|
||
| If you want to know more about LogConsumers, please check the [Following Container Logs](../features/follow_logs.md) documentation. | ||
|
|
||
| ## Advanced configuration | ||
|
|
||
| In the case you need a more advanced configuration regarding the config, host config and endpoint settings Docker types, you can leverage the modifier functions that are available in | ||
| the ContainerRequest. The Pulsar container exposes a way to interact with those modifiers in a simple manner, using the aforementioned options in the `StartContainer` function: | ||
|
|
||
| <!--codeinclude--> | ||
| [Advanced Docker settings](../../modules/pulsar/pulsar_test.go) inside_block:advancedDockerSettings | ||
| <!--/codeinclude--> | ||
|
|
||
| Please check out the [Advanced Settings](../features/creating_container.md#advanced-settings) for creating containers documentation. |
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
File renamed without changes.
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
Oops, something went wrong.