feat: Add Azure Event Hubs module

.github/workflows/cicd.yml

@@ -51,6 +51,7 @@ jobs:
           { name: "Testcontainers.DynamoDb", runs-on: "ubuntu-22.04" },
           { name: "Testcontainers.Elasticsearch", runs-on: "ubuntu-22.04" },
           { name: "Testcontainers.EventStoreDb", runs-on: "ubuntu-22.04" },
+          { name: "Testcontainers.EventHubs", runs-on: "ubuntu-22.04" },
           { name: "Testcontainers.FakeGcsServer", runs-on: "ubuntu-22.04" },
           { name: "Testcontainers.FirebirdSql", runs-on: "ubuntu-22.04" },
           { name: "Testcontainers.Firestore", runs-on: "ubuntu-22.04" },

Directory.Packages.props

@@ -33,6 +33,7 @@
         <PackageVersion Include="AWSSDK.SQS" Version="3.7.100.71"/>
         <PackageVersion Include="Azure.Data.Tables" Version="12.8.0"/>
         <PackageVersion Include="Azure.Messaging.ServiceBus" Version="7.18.2"/>
+        <PackageVersion Include="Azure.Messaging.EventHubs" Version="5.11.3" />
         <PackageVersion Include="Azure.Storage.Blobs" Version="12.17.0"/>
         <PackageVersion Include="Azure.Storage.Queues" Version="12.15.0"/>
         <PackageVersion Include="ClickHouse.Client" Version="7.9.1"/>

Testcontainers.sln

@@ -205,6 +205,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.WebDriver.Te
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Xunit.Tests", "tests\Testcontainers.Xunit.Tests\Testcontainers.Xunit.Tests.csproj", "{E901DF14-6F05-4FC2-825A-3055FAD33561}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.EventHubs", "src\Testcontainers.EventHubs\Testcontainers.EventHubs.csproj", "{0EF885E9-E973-47DC-AA9C-3A5E9175B0F3}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.EventHubs.Tests", "tests\Testcontainers.EventHubs.Tests\Testcontainers.EventHubs.Tests.csproj", "{4A0C5523-CEB2-49C9-AE62-9187A01B016B}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -598,6 +602,14 @@ Global
 		{E901DF14-6F05-4FC2-825A-3055FAD33561}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E901DF14-6F05-4FC2-825A-3055FAD33561}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E901DF14-6F05-4FC2-825A-3055FAD33561}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0EF885E9-E973-47DC-AA9C-3A5E9175B0F3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0EF885E9-E973-47DC-AA9C-3A5E9175B0F3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0EF885E9-E973-47DC-AA9C-3A5E9175B0F3}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0EF885E9-E973-47DC-AA9C-3A5E9175B0F3}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4A0C5523-CEB2-49C9-AE62-9187A01B016B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4A0C5523-CEB2-49C9-AE62-9187A01B016B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4A0C5523-CEB2-49C9-AE62-9187A01B016B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4A0C5523-CEB2-49C9-AE62-9187A01B016B}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{5365F780-0E6C-41F0-B1B9-7DC34368F80C} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
@@ -696,5 +708,7 @@ Global
 		{27CDB869-A150-4593-958F-6F26E5391E7C} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{E901DF14-6F05-4FC2-825A-3055FAD33561} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
+		{0EF885E9-E973-47DC-AA9C-3A5E9175B0F3} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
+		{4A0C5523-CEB2-49C9-AE62-9187A01B016B} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 	EndGlobalSection
 EndGlobal

src/Testcontainers.EventHubs/.editorconfig

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

src/Testcontainers.EventHubs/Configuration/ConfigurationBuilder.cs

@@ -0,0 +1,63 @@
+namespace Testcontainers.EventHubs.Configuration;
+
+public class ConfigurationBuilder
+{
+    private const string DefaultNamespace = "emulatorNs1";
+    private const string DefaultLoggingType = "file";
+
+    private readonly RootConfiguration _rootConfiguration = new RootConfiguration();
+
+    private ConfigurationBuilder()
+    {
+        _rootConfiguration.UserConfig = new UserConfig
+        {
+            NamespaceConfig =
+            [
+                new NamespaceConfig
+                {
+                    Type = "EventHub",
+                    Name = DefaultNamespace
+                },
+            ],
+            LoggingConfig = new LoggingConfig() { Type = DefaultLoggingType },
+        };
+    }
+
+    public static ConfigurationBuilder Create()
+    {
+        return new ConfigurationBuilder();
+    }
+
+    public ConfigurationBuilder WithEventHub(string entityName, int partitionCount, IEnumerable<string> consumerGroups)
+    {
+        var namespaceConfig = _rootConfiguration.UserConfig.NamespaceConfig.FirstOrDefault(x => x.Name == DefaultNamespace);
+        if (namespaceConfig == null)
+        {
+            throw new InvalidOperationException($"Default Namespace '{DefaultNamespace}' not found.");
+        }
+
+        namespaceConfig.Entities.Add(new Entity
+        {
+            Name = entityName,
+            PartitionCount = partitionCount,
+            ConsumerGroups = consumerGroups.Select(consumerGroupName => new ConsumerGroup { Name = consumerGroupName }).ToList(),
+        });
+
+        return this;
+    }
+
+    public bool Validate()
+    {
+        return _rootConfiguration.UserConfig.NamespaceConfig.Count == 1 &&
+               _rootConfiguration.UserConfig.NamespaceConfig.First().Entities.Count > 0 &&
+               _rootConfiguration.UserConfig.NamespaceConfig.First().Entities.Count <= 10 &&
+               _rootConfiguration.UserConfig.NamespaceConfig.First().Entities.All(entity =>
+                   entity.PartitionCount is > 0 and <= 32 &&
+                   entity.ConsumerGroups.Count is > 0 and <= 20);
+    }
+
+    public string Build()
+    {
+        return JsonSerializer.Serialize(_rootConfiguration);
+    }
+}

src/Testcontainers.EventHubs/Configuration/ConsumerGroup.cs

@@ -0,0 +1,6 @@
+namespace Testcontainers.EventHubs.Configuration;
+
+public record ConsumerGroup
+{
+    public string Name { get; set; }
+}

src/Testcontainers.EventHubs/Configuration/Entity.cs

@@ -0,0 +1,8 @@
+namespace Testcontainers.EventHubs.Configuration;
+
+public record Entity
+{
+    public string Name { get; set; }
+    public int PartitionCount { get; set; }
+    public List<ConsumerGroup> ConsumerGroups { get; set; } = [];
+}

src/Testcontainers.EventHubs/Configuration/LoggingConfig.cs

@@ -0,0 +1,6 @@
+namespace Testcontainers.EventHubs.Configuration;
+
+public record LoggingConfig
+{
+    public string Type { get; set; }
+}

src/Testcontainers.EventHubs/Configuration/NamespaceConfig.cs

@@ -0,0 +1,9 @@
+namespace Testcontainers.EventHubs.Configuration;
+
+public record NamespaceConfig
+{
+    public string Type { get; set; }
+    public string Name { get; set; }
+
+    public List<Entity> Entities { get; set; } = [];
+}

src/Testcontainers.EventHubs/Configuration/RootConfiguration.cs

@@ -0,0 +1,10 @@
+namespace Testcontainers.EventHubs.Configuration;
+
+/// <summary>
+/// Azure Event Hubs emulator JSON configuration.
+/// <seealso href="https://raw.githubusercontent.com/Azure/azure-event-hubs-emulator-installer/refs/heads/main/EventHub-Emulator/Schema/Config-schema.json"/>
+/// </summary>
+public record RootConfiguration
+{
+    public UserConfig UserConfig { get; set; }
+}

src/Testcontainers.EventHubs/Configuration/UserConfig.cs

@@ -0,0 +1,7 @@
+namespace Testcontainers.EventHubs.Configuration;
+
+public record UserConfig
+{
+    public List<NamespaceConfig> NamespaceConfig { get; set; } = [];
+    public LoggingConfig LoggingConfig { get; set; }
+}

src/Testcontainers.EventHubs/EventHubsBuilder.cs

@@ -0,0 +1,180 @@
+namespace Testcontainers.EventHubs;
+
+/// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
+[PublicAPI]
+public sealed class EventHubsBuilder : ContainerBuilder<EventHubsBuilder, EventHubsContainer, EventHubsConfiguration>
+{
+    public const string EventHubsImage = "mcr.microsoft.com/azure-messaging/eventhubs-emulator:latest";
+
+    public const ushort EventHubsPort = 5672;
+
+    public const string AzuriteNetworkAlias = "azurite";
+
+    private const string AcceptLicenseAgreementEnvVar = "ACCEPT_EULA";
+
+    private const string AcceptLicenseAgreement = "Y";
+
+    private const string DeclineLicenseAgreement = "N";
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="EventHubsBuilder" /> class.
+    /// </summary>
+    public EventHubsBuilder()
+        : this(new EventHubsConfiguration())
+    {
+        DockerResourceConfiguration = Init().DockerResourceConfiguration;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="EventHubsBuilder" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    private EventHubsBuilder(EventHubsConfiguration resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        DockerResourceConfiguration = resourceConfiguration;
+    }
+
+    /// <inheritdoc />
+    protected override EventHubsConfiguration DockerResourceConfiguration { get; }
+
+    /// <summary>
+    /// Sets the event hub configuration
+    /// </summary>
+    /// <param name="configurationBuilder"></param>
+    /// <returns></returns>
+    public EventHubsBuilder WithConfigurationBuilder(ConfigurationBuilder configurationBuilder)
+    {
+        var configBytes = Encoding.UTF8.GetBytes(configurationBuilder.Build());
+
+        return Merge(DockerResourceConfiguration,
+                new EventHubsConfiguration(configurationBuilder: configurationBuilder))
+            .WithResourceMapping(configBytes, "Eventhubs_Emulator/ConfigFiles/Config.json");
+    }
+
+    /// <summary>
+    /// Accepts the license agreement.
+    /// </summary>
+    /// <remarks>
+    /// When <paramref name="acceptLicenseAgreement" /> is set to <c>true</c>, the Azure Event Hubs Emulator <see href="https://github.com/Azure/azure-event-hubs-emulator-installer/blob/main/EMULATOR_EULA.md">license</see> is accepted.
+    /// </remarks>
+    /// <param name="acceptLicenseAgreement">A boolean value indicating whether the Azure Event Hubs Emulator license agreement is accepted.</param>
+    /// <returns>A configured instance of <see cref="EventHubsBuilder" />.</returns>
+    public EventHubsBuilder WithAcceptLicenseAgreement(bool acceptLicenseAgreement)
+    {
+        var licenseAgreement = acceptLicenseAgreement ? AcceptLicenseAgreement : DeclineLicenseAgreement;
+        return WithEnvironment(AcceptLicenseAgreementEnvVar, licenseAgreement);
+    }
+
+    /// <summary>
+    ///  Sets the Azurite container for the Event Hubs Emulator.
+    /// </summary>
+    /// <param name="azuriteContainer">docker container</param>
+    /// <param name="alias">network alias name that is used for connection to blob and table endpoints</param>
+    /// <returns></returns>
+    public EventHubsBuilder WithAzurite(AzuriteContainer azuriteContainer,
+        string alias) =>
+        WithAzurite(azuriteContainer, false, alias);
+
+    private EventHubsBuilder WithAzurite(AzuriteContainer azuriteContainer,
+        bool isInternal,
+        string alias = AzuriteNetworkAlias)
+    {
+        var builder = Merge(DockerResourceConfiguration,
+            new EventHubsConfiguration(azuriteContainer: azuriteContainer));
+
+        if (!isInternal)
+        {
+            builder = builder.DependsOn(azuriteContainer);
+        }
+
+        return builder
+            .WithEnvironment("BLOB_SERVER", alias)
+            .WithEnvironment("METADATA_SERVER", alias);
+    }
+
+    private EventHubsBuilder WithAzurite()
+    {
+        var azuriteContainer = new AzuriteBuilder()
+            .WithNetwork(DockerResourceConfiguration.Networks.Single())
+            .WithNetworkAliases(AzuriteNetworkAlias)
+            .Build();
+
+        return WithAzurite(azuriteContainer, true);
+    }
+
+    /// <inheritdoc />
+    public override EventHubsContainer Build()
+    {
+        Validate();
+        return new EventHubsContainer(DockerResourceConfiguration);
+    }
+
+    /// <inheritdoc />
+    protected override void Validate()
+    {
+        base.Validate();
+
+        _ = Guard.Argument(DockerResourceConfiguration, nameof(DockerResourceConfiguration.Image))
+            .ThrowIf(argument => LicenseAgreementNotAccepted(argument.Value),
+                argument => throw new ArgumentException(
+                    $"The image '{DockerResourceConfiguration.Image.FullName}' requires you to accept a license agreement.",
+                    argument.Name));
+
+        _ = Guard.Argument(DockerResourceConfiguration.ConfigurationBuilder,
+                nameof(DockerResourceConfiguration.ConfigurationBuilder))
+            .NotNull()
+            .ThrowIf(x => !x.Value.Validate(), _ => throw new ArgumentException("ConfigurationBuilder is invalid."));
+
+        return;
+
+        bool LicenseAgreementNotAccepted(EventHubsConfiguration value) =>
+            !value.Environments.TryGetValue(AcceptLicenseAgreementEnvVar, out var licenseAgreementValue) ||
+            !AcceptLicenseAgreement.Equals(licenseAgreementValue, StringComparison.Ordinal);
+    }
+
+    /// <inheritdoc />
+    protected override EventHubsBuilder Init()
+    {
+        return base.Init()
+            .WithImage(EventHubsImage)
+            .WithNetwork(new NetworkBuilder().Build())
+            .WithPortBinding(EventHubsPort, true)
+            .WithAzurite()
+            .WithWaitStrategy(Wait.ForUnixContainer()
+                .UntilMessageIsLogged("Emulator Service is Successfully Up!")
+                .AddCustomWaitStrategy(new WaitTwoSeconds()));
+        ;
+    }
+
+    /// <inheritdoc />
+    protected override EventHubsBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new EventHubsConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override EventHubsBuilder Clone(IContainerConfiguration resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new EventHubsConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override EventHubsBuilder Merge(EventHubsConfiguration oldValue,
+        EventHubsConfiguration newValue)
+    {
+        return new EventHubsBuilder(new EventHubsConfiguration(oldValue, newValue));
+    }
+
+    private sealed class WaitTwoSeconds : IWaitUntil
+    {
+        /// <inheritdoc />
+        public async Task<bool> UntilAsync(IContainer container)
+        {
+            await Task.Delay(TimeSpan.FromSeconds(2))
+                .ConfigureAwait(false);
+
+            return true;
+        }
+    }
+}