feat: Add Apache Pulsar module

Directory.Packages.props

@@ -35,6 +35,7 @@
         <PackageVersion Include="Confluent.Kafka" Version="2.0.2"/>
         <PackageVersion Include="Consul" Version="1.6.10.9"/>
         <PackageVersion Include="CouchbaseNetClient" Version="3.4.3"/>
+        <PackageVersion Include="DotPulsar" Version="3.1.2"/>
         <PackageVersion Include="Elastic.Clients.Elasticsearch" Version="8.0.5"/>
         <PackageVersion Include="EventStore.Client.Grpc.Streams" Version="22.0.0"/>
         <PackageVersion Include="FirebirdSql.Data.FirebirdClient" Version="10.0.0"/>

Testcontainers.sln

@@ -85,6 +85,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.PostgreSql",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.PubSub", "src\Testcontainers.PubSub\Testcontainers.PubSub.csproj", "{E6642255-667D-476B-B584-089AA5E6C0B1}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Pulsar", "src\Testcontainers.Pulsar\Testcontainers.Pulsar.csproj", "{27D46863-65B9-4934-B3C8-2383B217A477}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.RabbitMq", "src\Testcontainers.RabbitMq\Testcontainers.RabbitMq.csproj", "{A6D480BC-FDE8-4B92-A2A6-FF16BEE486AE}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.RavenDb", "src\Testcontainers.RavenDb\Testcontainers.RavenDb.csproj", "{F6394475-D6F1-46E2-81BF-4BA78A40B878}"
@@ -179,6 +181,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.PostgreSql.T
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.PubSub.Tests", "tests\Testcontainers.PubSub.Tests\Testcontainers.PubSub.Tests.csproj", "{0F86BCE8-62E1-4BFC-AA84-63C7514C90AC}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Pulsar.Tests", "tests\Testcontainers.Pulsar.Tests\Testcontainers.Pulsar.Tests.csproj", "{D05FCB31-793E-43E0-BD6C-077013AE9113}"
+EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.RabbitMq.Tests", "tests\Testcontainers.RabbitMq.Tests\Testcontainers.RabbitMq.Tests.csproj", "{19564567-1736-4626-B406-17E4E02F18B2}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.RavenDb.Tests", "tests\Testcontainers.RavenDb.Tests\Testcontainers.RavenDb.Tests.csproj", "{D53726B6-5447-47E6-B881-A44EFF6E5534}"
@@ -348,6 +352,10 @@ Global
 		{E6642255-667D-476B-B584-089AA5E6C0B1}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E6642255-667D-476B-B584-089AA5E6C0B1}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E6642255-667D-476B-B584-089AA5E6C0B1}.Release|Any CPU.Build.0 = Release|Any CPU
+		{27D46863-65B9-4934-B3C8-2383B217A477}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{27D46863-65B9-4934-B3C8-2383B217A477}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{27D46863-65B9-4934-B3C8-2383B217A477}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{27D46863-65B9-4934-B3C8-2383B217A477}.Release|Any CPU.Build.0 = Release|Any CPU
 		{A6D480BC-FDE8-4B92-A2A6-FF16BEE486AE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{A6D480BC-FDE8-4B92-A2A6-FF16BEE486AE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A6D480BC-FDE8-4B92-A2A6-FF16BEE486AE}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -536,6 +544,10 @@ Global
 		{0F86BCE8-62E1-4BFC-AA84-63C7514C90AC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{0F86BCE8-62E1-4BFC-AA84-63C7514C90AC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{0F86BCE8-62E1-4BFC-AA84-63C7514C90AC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D05FCB31-793E-43E0-BD6C-077013AE9113}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D05FCB31-793E-43E0-BD6C-077013AE9113}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D05FCB31-793E-43E0-BD6C-077013AE9113}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D05FCB31-793E-43E0-BD6C-077013AE9113}.Release|Any CPU.Build.0 = Release|Any CPU
 		{19564567-1736-4626-B406-17E4E02F18B2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{19564567-1736-4626-B406-17E4E02F18B2}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{19564567-1736-4626-B406-17E4E02F18B2}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -606,6 +618,7 @@ Global
 		{464F1120-A0DA-462B-B9E8-45176D883625} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{8AB91636-9055-4900-A72A-7CFFACDFDBF0} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{E6642255-667D-476B-B584-089AA5E6C0B1} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
+		{27D46863-65B9-4934-B3C8-2383B217A477} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{A6D480BC-FDE8-4B92-A2A6-FF16BEE486AE} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{F6394475-D6F1-46E2-81BF-4BA78A40B878} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
 		{BFDA179A-40EB-4CEB-B8E9-0DF32C65E2C5} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
@@ -653,6 +666,7 @@ Global
 		{3E55CBE8-AFE8-426D-9470-49D63CD1051C} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{56D0DCA5-567F-4B3B-8B79-CB108F8EB8A6} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{0F86BCE8-62E1-4BFC-AA84-63C7514C90AC} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
+		{D05FCB31-793E-43E0-BD6C-077013AE9113} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{19564567-1736-4626-B406-17E4E02F18B2} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{D53726B6-5447-47E6-B881-A44EFF6E5534} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{31EE94A0-E721-4073-B6F1-DD912D004DEF} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}

docs/modules/elasticsearch.md

@@ -51,5 +51,3 @@ To execute the tests, use the command `dotnet test` from a terminal.
 ## A Note To Developers
 
 The Testcontainers module creates a container that listens to requests over **HTTPS**. To communicate with the Elasticsearch instance, developers must create a `ElasticsearchClientSettings` instance and set the `ServerCertificateValidationCallback` delegate to `CertificateValidations.AllowAll`. Failing to do so will result in a communication failure as the .NET will reject the certificate coming from the container.
-
-[xunit]: https://xunit.net/

docs/modules/index.md

@@ -56,6 +56,7 @@ await moduleNameContainer.StartAsync();
 | Papercut         | `jijiechen/papercut:latest`                                         | [NuGet](https://www.nuget.org/packages/Testcontainers.Papercut)      | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Papercut)      |
 | PostgreSQL       | `postgres:15.1`                                                     | [NuGet](https://www.nuget.org/packages/Testcontainers.PostgreSql)    | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.PostgreSql)    |
 | PubSub           | `gcr.io/google.com/cloudsdktool/google-cloud-cli:446.0.1-emulators` | [NuGet](https://www.nuget.org/packages/Testcontainers.PubSub)        | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.PubSub)        |
+| Pulsar           | `apachepulsar/pulsar:3.2.3`                                         | [NuGet](https://www.nuget.org/packages/Testcontainers.Pulsar)        | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Pulsar)        |
 | RabbitMQ         | `rabbitmq:3.11`                                                     | [NuGet](https://www.nuget.org/packages/Testcontainers.RabbitMq)      | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.RabbitMq)      |
 | RavenDB          | `ravendb/ravendb:5.4-ubuntu-latest`                                 | [NuGet](https://www.nuget.org/packages/Testcontainers.RavenDb)       | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.RavenDb)       |
 | Redis            | `redis:7.0`                                                         | [NuGet](https://www.nuget.org/packages/Testcontainers.Redis)         | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Redis)         |

docs/modules/mongodb.md

@@ -45,5 +45,3 @@ public sealed class MongoDbContainerTest : IAsyncLifetime
 ```
 
 To execute the tests, use the command `dotnet test` from a terminal.
-
-[xunit]: https://xunit.net/

docs/modules/neo4j.md

@@ -47,5 +47,3 @@ public sealed class Neo4jContainerTest : IAsyncLifetime
 ```
 
 To execute the tests, use the command `dotnet test` from a terminal.
-
-[xunit]: https://xunit.net/

docs/modules/pulsar.md

@@ -0,0 +1,108 @@
+# Apache Pulsar
+
+Testcontainers can be used to automatically create [Apache Pulsar](https://pulsar.apache.org) containers without the need for external services. Based on the official Apache Pulsar Docker image, it is recommended to read the official [getting started](https://pulsar.apache.org/docs/next/getting-started-docker/) guide.
+
+The following example uses the following NuGet packages:
+
+```console title="Install the NuGet dependencies"
+dotnet add package Testcontainers.Pulsar
+dotnet add package DotPulsar
+dotnet add package xunit
+```
+
+IDEs and editors may also require the following packages to run tests: `xunit.runner.visualstudio` and `Microsoft.NET.Test.Sdk`.
+
+Copy and paste the following code into a new `.cs` test file within an existing test project.
+
+```csharp
+using System;
+using System.Text;
+using System.Threading.Tasks;
+using DotPulsar;
+using DotPulsar.Extensions;
+using Xunit;
+
+namespace Testcontainers.Pulsar;
+
+public sealed class PulsarContainerTest : IAsyncLifetime
+{
+    private readonly PulsarContainer _pulsarContainer =
+        new PulsarBuilder().Build();
+
+    [Fact]
+    public async Task ConsumerReceivesSendMessage()
+    {
+        const string helloPulsar = "Hello, Pulsar!";
+
+        var topic = $"persistent://public/default/{Guid.NewGuid():D}";
+
+        var name = Guid.NewGuid().ToString("D");
+
+        await using var client = PulsarClient.Builder()
+            .ServiceUrl(new Uri(_pulsarContainer.GetBrokerAddress()))
+            .Build();
+
+        await using var producer = client.NewProducer(Schema.String)
+            .Topic(topic)
+            .Create();
+
+        await using var consumer = client.NewConsumer(Schema.String)
+            .Topic(topic)
+            .SubscriptionName(name)
+            .InitialPosition(SubscriptionInitialPosition.Earliest)
+            .Create();
+
+        _ = await producer.Send(helloPulsar)
+            .ConfigureAwait(true);
+
+        var message = await consumer.Receive()
+            .ConfigureAwait(true);
+
+        Assert.Equal(helloPulsar, Encoding.Default.GetString(message.Data));
+    }
+
+    public Task InitializeAsync()
+        => _pulsarContainer.StartAsync();
+
+    public Task DisposeAsync()
+        => _pulsarContainer.DisposeAsync().AsTask();
+}
+```
+
+To execute the tests, use the command `dotnet test` from a terminal.
+
+## Access Pulsar
+
+To get the Pulsar broker URL use:
+
+```csharp
+string pulsarBrokerUrl = _pulsarContainer.GetPulsarBrokerUrl();
+```
+
+To get the Pulsar service URL use:
+```csharp
+string pulsarServiceUrl = _pulsarContainer.GetHttpServiceUrl();
+```
+
+## Enable token authentication
+
+If you need to use token authentication, use the following builder configuration to enable authentication:
+
+```csharp
+PulsarContainer _pulsarContainer = PulsarBuilder().WithTokenAuthentication().Build();
+```
+
+Start the container and get the token from the running instance by using:
+
+```csharp
+var authToken = await container.CreateAuthenticationTokenAsync(TimeSpan.FromHours(1))
+    .ConfigureAwait(false);
+```
+
+## Enable Pulsar Functions
+
+If you need to use Pulsar Functions, use the following builder configuration to enable it:
+
+```csharp
+PulsarContainer _pulsarContainer = PulsarBuilder().WithFunctions().Build();
+```

mkdocs.yml

@@ -45,4 +45,5 @@ nav:
     - modules/mssql.md
     - modules/neo4j.md
     - modules/postgres.md
+    - modules/pulsar.md
     - modules/rabbitmq.md

src/Testcontainers.Pulsar/.editorconfig

@@ -0,0 +1 @@
+root = true