Reintroducing Papercut container modual

Testcontainers.sln

@@ -191,6 +191,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Tests", "tes
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.WebDriver.Tests", "tests\Testcontainers.WebDriver.Tests\Testcontainers.WebDriver.Tests.csproj", "{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Papercut", "src\Testcontainers.Papercut\Testcontainers.Papercut.csproj", "{B2608563-8EE4-49AA-A9A0-B1614486AEEF}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Papercut.Tests", "tests\Testcontainers.Papercut.Tests\Testcontainers.Papercut.Tests.csproj", "{F03FA970-BE2B-4AE2-96FE-7E1F805CEA20}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -556,6 +560,14 @@ Global
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B2608563-8EE4-49AA-A9A0-B1614486AEEF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B2608563-8EE4-49AA-A9A0-B1614486AEEF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B2608563-8EE4-49AA-A9A0-B1614486AEEF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B2608563-8EE4-49AA-A9A0-B1614486AEEF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F03FA970-BE2B-4AE2-96FE-7E1F805CEA20}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F03FA970-BE2B-4AE2-96FE-7E1F805CEA20}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F03FA970-BE2B-4AE2-96FE-7E1F805CEA20}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F03FA970-BE2B-4AE2-96FE-7E1F805CEA20}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{5365F780-0E6C-41F0-B1B9-7DC34368F80C} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
@@ -647,5 +659,7 @@ Global
 		{9E8E6AA5-65D1-498F-BEAB-BA34723A0050} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{27CDB869-A150-4593-958F-6F26E5391E7C} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
+		{B2608563-8EE4-49AA-A9A0-B1614486AEEF} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
+		{F03FA970-BE2B-4AE2-96FE-7E1F805CEA20} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 	EndGlobalSection
 EndGlobal

docs/modules/index.md

@@ -53,6 +53,7 @@ await moduleNameContainer.StartAsync();
 | NATS             | `nats:2.9`                                                          | [NuGet](https://www.nuget.org/packages/Testcontainers.Nats)          | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Nats)          |
 | Neo4j            | `neo4j:5.4`                                                         | [NuGet](https://www.nuget.org/packages/Testcontainers.Neo4j)         | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Neo4j)         |
 | Oracle           | `gvenzl/oracle-xe:21.3.0-slim-faststart`                            | [NuGet](https://www.nuget.org/packages/Testcontainers.Oracle)        | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Oracle)        |
+| 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.0.6`                                         | [NuGet](https://www.nuget.org/packages/Testcontainers.Pulsar)        | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Pulsar)        |

src/Testcontainers.Papercut/.editorconfig

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

src/Testcontainers.Papercut/PapercutBuilder.cs

@@ -0,0 +1,79 @@
+using System.Net;
+
+namespace Testcontainers.Papercut;
+
+/// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
+[PublicAPI]
+public sealed class PapercutBuilder : ContainerBuilder<PapercutBuilder, PapercutContainer, PapercutConfiguration>
+{
+    public const string PapercutImage = "jijiechen/papercut:latest";
+
+    public const ushort HttpPort = 37408;
+
+    public const ushort SmtpPort = 25;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutBuilder" /> class.
+    /// </summary>
+    public PapercutBuilder()
+        : this(new PapercutConfiguration())
+    {
+        DockerResourceConfiguration = Init().DockerResourceConfiguration;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutBuilder" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    private PapercutBuilder(PapercutConfiguration resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        DockerResourceConfiguration = resourceConfiguration;
+    }
+
+    /// <inheritdoc />
+    protected override PapercutConfiguration DockerResourceConfiguration { get; }
+
+    /// <inheritdoc />
+    public override PapercutContainer Build()
+    {
+        Validate();
+        return new PapercutContainer(DockerResourceConfiguration);
+    }
+
+    /// <inheritdoc />
+    protected override PapercutBuilder Init()
+    {
+        return base.Init()
+            .WithImage(PapercutImage)
+            .WithPortBinding(HttpPort, true)
+            .WithPortBinding(SmtpPort, true)
+            .WithWaitStrategy(Wait.ForUnixContainer().UntilMessageIsLogged("Now listening on"))
+            .WithWaitStrategy(Wait.ForUnixContainer()
+                .UntilHttpRequestIsSucceeded(strategy => 
+                    strategy.ForPath("/health")
+                        .ForPort(HttpPort)
+                        .ForStatusCode(HttpStatusCode.OK)
+                        .ForResponseMessageMatching(async message => await message.Content.ReadAsStringAsync() == "Papercut WebUI server started successfully.")
+                )
+            );
+    }
+
+    /// <inheritdoc />
+    protected override PapercutBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new PapercutConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override PapercutBuilder Clone(IContainerConfiguration resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new PapercutConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override PapercutBuilder Merge(PapercutConfiguration oldValue, PapercutConfiguration newValue)
+    {
+        return new PapercutBuilder(new PapercutConfiguration(oldValue, newValue));
+    }
+}

src/Testcontainers.Papercut/PapercutConfiguration.cs

@@ -0,0 +1,53 @@
+namespace Testcontainers.Papercut;
+
+/// <inheritdoc cref="ContainerConfiguration" />
+[PublicAPI]
+public sealed class PapercutConfiguration : ContainerConfiguration
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutConfiguration" /> class.
+    /// </summary>
+    public PapercutConfiguration()
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public PapercutConfiguration(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public PapercutConfiguration(IContainerConfiguration resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public PapercutConfiguration(PapercutConfiguration resourceConfiguration)
+        : this(new PapercutConfiguration(), resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutConfiguration" /> class.
+    /// </summary>
+    /// <param name="oldValue">The old Docker resource configuration.</param>
+    /// <param name="newValue">The new Docker resource configuration.</param>
+    public PapercutConfiguration(PapercutConfiguration oldValue, PapercutConfiguration newValue)
+        : base(oldValue, newValue)
+    {
+    }
+}

src/Testcontainers.Papercut/PapercutContainer.cs

@@ -0,0 +1,29 @@
+namespace Testcontainers.Papercut;
+
+/// <inheritdoc cref="DockerContainer" />
+[PublicAPI]
+public sealed class PapercutContainer : DockerContainer
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PapercutContainer" /> class.
+    /// </summary>
+    /// <param name="configuration">The container configuration.</param>
+    public PapercutContainer(PapercutConfiguration configuration)
+        : base(configuration)
+    {
+    }
+
+    /// <summary>
+    /// Gets the SMTP port.
+    /// </summary>
+    public ushort SmtpPort => GetMappedPublicPort(PapercutBuilder.SmtpPort);
+
+    /// <summary>
+    /// Gets the Papercut base address.
+    /// </summary>
+    /// <returns>The Papercut base address.</returns>
+    public string GetBaseAddress()
+    {
+        return new UriBuilder(Uri.UriSchemeHttp, Hostname, GetMappedPublicPort(PapercutBuilder.HttpPort)).ToString();
+    }
+}

src/Testcontainers.Papercut/Testcontainers.Papercut.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFrameworks>net6.0;net8.0;netstandard2.0;netstandard2.1</TargetFrameworks>
+        <LangVersion>latest</LangVersion>
+        <Version>4.0.1</Version>
+        <PackageReleaseNotes>4.0.0 - First release
+4.0.1 - Wait stretagy for Papercut WebUI server started successfully</PackageReleaseNotes>
+    </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="JetBrains.Annotations" VersionOverride="2023.3.0" PrivateAssets="All"/>
+    </ItemGroup>
+    <ItemGroup>
+        <ProjectReference Include="../Testcontainers/Testcontainers.csproj"/>
+    </ItemGroup>
+</Project>

src/Testcontainers.Papercut/Usings.cs

@@ -0,0 +1,6 @@
+global using System;
+global using Docker.DotNet.Models;
+global using DotNet.Testcontainers.Builders;
+global using DotNet.Testcontainers.Configurations;
+global using DotNet.Testcontainers.Containers;
+global using JetBrains.Annotations;

tests/Testcontainers.Papercut.Tests/.editorconfig

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

tests/Testcontainers.Papercut.Tests/PapercutContainerTest.cs

@@ -0,0 +1,85 @@
+namespace Testcontainers.Papercut;
+
+public sealed class PapercutContainerTest : IAsyncLifetime
+{
+    private readonly PapercutContainer _papercutContainer = new PapercutBuilder().Build();
+
+    public Task InitializeAsync()
+    {
+        return _papercutContainer.StartAsync();
+    }
+
+    public Task DisposeAsync()
+    {
+        return _papercutContainer.DisposeAsync().AsTask();
+    }
+
+    [Fact]
+    [Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
+    public async Task ReceivesSentMessage()
+    {
+        // Given
+        const string subject = "Test";
+
+        Message[] messages = [];
+
+        using var httpClient = new HttpClient();
+        httpClient.BaseAddress = new Uri(_papercutContainer.GetBaseAddress());
+
+        using var smtpClient = new SmtpClient(_papercutContainer.Hostname, _papercutContainer.SmtpPort);
+
+        // When
+        smtpClient.Send("[email protected]", "[email protected]", subject, "A test message");
+
+        var tries = 0;
+        do
+        {
+            try
+            {
+                var messagesJson = await httpClient.GetStringAsync("/api/messages")
+                    .ConfigureAwait(true);
+
+                var jsonDocument = JsonDocument.Parse(messagesJson);
+                messages = jsonDocument.RootElement.GetProperty("messages").Deserialize<Message[]>();
+            }
+            catch
+            {
+                tries++;
+                if (tries >= 5)
+                {
+                    throw;
+                }
+                await Task.Delay(25 + Random.Shared.Next(-10, 10));
+            }
+        }
+        while (messages.Length == 0);
+
+        // Then
+        Assert.NotEmpty(messages);
+        Assert.Equal(subject, messages[0].Subject);
+    }
+
+    private readonly struct Message
+    {
+        [JsonConstructor]
+        public Message(string id, string subject, string size, DateTime createdAt)
+        {
+            Id = id;
+            Subject = subject;
+            Size = size;
+            CreatedAt = createdAt;
+        }
+
+        [JsonPropertyName("id")]
+        public string Id { get; }
+
+        [JsonPropertyName("subject")]
+        public string Subject { get; }
+
+        [JsonPropertyName("size")]
+        public string Size { get; }
+
+        [JsonPropertyName("createdAt")]
+        public DateTime CreatedAt { get; }
+    }
+}

tests/Testcontainers.Papercut.Tests/Testcontainers.Papercut.Tests.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFrameworks>net8.0</TargetFrameworks>
+        <IsPackable>false</IsPackable>
+        <IsPublishable>false</IsPublishable>
+    </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="Microsoft.NET.Test.Sdk"/>
+        <PackageReference Include="coverlet.collector"/>
+        <PackageReference Include="xunit.runner.visualstudio"/>
+        <PackageReference Include="xunit"/>
+    </ItemGroup>
+    <ItemGroup>
+        <ProjectReference Include="../../src/Testcontainers.Papercut/Testcontainers.Papercut.csproj"/>
+        <ProjectReference Include="../Testcontainers.Commons/Testcontainers.Commons.csproj"/>
+    </ItemGroup>
+</Project>

tests/Testcontainers.Papercut.Tests/Usings.cs

@@ -0,0 +1,8 @@
+global using System;
+global using System.Net.Http;
+global using System.Net.Mail;
+global using System.Text.Json;
+global using System.Text.Json.Serialization;
+global using System.Threading.Tasks;
+global using DotNet.Testcontainers.Commons;
+global using Xunit;