From 159e4bf60b297a18fc09ead6ba8d7fe751984edc Mon Sep 17 00:00:00 2001 From: Liam Date: Thu, 10 Oct 2024 17:59:51 +0100 Subject: [PATCH] feat: Reintroduce Papercut module (#1268) Co-authored-by: Andre Hofmeister <9199345+HofmeisterAn@users.noreply.github.com> --- Testcontainers.sln | 14 ++++ docs/modules/index.md | 1 + src/Testcontainers.Neo4j/Usings.cs | 1 - src/Testcontainers.Papercut/.editorconfig | 1 + .../PapercutBuilder.cs | 83 +++++++++++++++++++ .../PapercutConfiguration.cs | 53 ++++++++++++ .../PapercutContainer.cs | 29 +++++++ .../Testcontainers.Papercut.csproj | 12 +++ src/Testcontainers.Papercut/Usings.cs | 8 ++ .../.editorconfig | 1 + .../PapercutContainerTest.cs | 65 +++++++++++++++ .../Testcontainers.Papercut.Tests.csproj | 17 ++++ tests/Testcontainers.Papercut.Tests/Usings.cs | 8 ++ 13 files changed, 292 insertions(+), 1 deletion(-) create mode 100644 src/Testcontainers.Papercut/.editorconfig create mode 100644 src/Testcontainers.Papercut/PapercutBuilder.cs create mode 100644 src/Testcontainers.Papercut/PapercutConfiguration.cs create mode 100644 src/Testcontainers.Papercut/PapercutContainer.cs create mode 100644 src/Testcontainers.Papercut/Testcontainers.Papercut.csproj create mode 100644 src/Testcontainers.Papercut/Usings.cs create mode 100644 tests/Testcontainers.Papercut.Tests/.editorconfig create mode 100644 tests/Testcontainers.Papercut.Tests/PapercutContainerTest.cs create mode 100644 tests/Testcontainers.Papercut.Tests/Testcontainers.Papercut.Tests.csproj create mode 100644 tests/Testcontainers.Papercut.Tests/Usings.cs diff --git a/Testcontainers.sln b/Testcontainers.sln index aacb19742..10cae3fc2 100644 --- a/Testcontainers.sln +++ b/Testcontainers.sln @@ -79,6 +79,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Neo4j", "src EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Oracle", "src\Testcontainers.Oracle\Testcontainers.Oracle.csproj", "{596EAFC1-0496-495C-B382-D57415FA456A}" 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.PostgreSql", "src\Testcontainers.PostgreSql\Testcontainers.PostgreSql.csproj", "{8AB91636-9055-4900-A72A-7CFFACDFDBF0}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.PubSub", "src\Testcontainers.PubSub\Testcontainers.PubSub.csproj", "{E6642255-667D-476B-B584-089AA5E6C0B1}" @@ -167,6 +169,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Neo4j.Tests" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Oracle.Tests", "tests\Testcontainers.Oracle.Tests\Testcontainers.Oracle.Tests.csproj", "{4AC1088B-9965-4497-AC8E-570F1AD5631F}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Papercut.Tests", "tests\Testcontainers.Papercut.Tests\Testcontainers.Papercut.Tests.csproj", "{F03FA970-BE2B-4AE2-96FE-7E1F805CEA20}" +EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Platform.Linux.Tests", "tests\Testcontainers.Platform.Linux.Tests\Testcontainers.Platform.Linux.Tests.csproj", "{DA1D7ADE-452C-4369-83CC-56289176EACD}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Platform.Windows.Tests", "tests\Testcontainers.Platform.Windows.Tests\Testcontainers.Platform.Windows.Tests.csproj", "{3E55CBE8-AFE8-426D-9470-49D63CD1051C}" @@ -332,6 +336,10 @@ Global {596EAFC1-0496-495C-B382-D57415FA456A}.Debug|Any CPU.Build.0 = Debug|Any CPU {596EAFC1-0496-495C-B382-D57415FA456A}.Release|Any CPU.ActiveCfg = Release|Any CPU {596EAFC1-0496-495C-B382-D57415FA456A}.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 {8AB91636-9055-4900-A72A-7CFFACDFDBF0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {8AB91636-9055-4900-A72A-7CFFACDFDBF0}.Debug|Any CPU.Build.0 = Debug|Any CPU {8AB91636-9055-4900-A72A-7CFFACDFDBF0}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -508,6 +516,10 @@ Global {4AC1088B-9965-4497-AC8E-570F1AD5631F}.Debug|Any CPU.Build.0 = Debug|Any CPU {4AC1088B-9965-4497-AC8E-570F1AD5631F}.Release|Any CPU.ActiveCfg = Release|Any CPU {4AC1088B-9965-4497-AC8E-570F1AD5631F}.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 {DA1D7ADE-452C-4369-83CC-56289176EACD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {DA1D7ADE-452C-4369-83CC-56289176EACD}.Debug|Any CPU.Build.0 = Debug|Any CPU {DA1D7ADE-452C-4369-83CC-56289176EACD}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -591,6 +603,7 @@ Global {BF37BEA1-0816-4326-B1E0-E82290F8FCE0} = {673F23AE-7694-4BB9-ABD4-136D6C13634E} {ADC2372B-6FE0-421D-8277-BB628E8EFC22} = {673F23AE-7694-4BB9-ABD4-136D6C13634E} {596EAFC1-0496-495C-B382-D57415FA456A} = {673F23AE-7694-4BB9-ABD4-136D6C13634E} + {B2608563-8EE4-49AA-A9A0-B1614486AEEF} = {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} @@ -635,6 +648,7 @@ Global {87A3F137-6DC3-4CE5-91E6-01797D076086} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF} {D3F63405-C0FA-4F83-8B79-E30BFF5FF5BF} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF} {4AC1088B-9965-4497-AC8E-570F1AD5631F} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF} + {F03FA970-BE2B-4AE2-96FE-7E1F805CEA20} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF} {DA1D7ADE-452C-4369-83CC-56289176EACD} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF} {3E55CBE8-AFE8-426D-9470-49D63CD1051C} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF} {56D0DCA5-567F-4B3B-8B79-CB108F8EB8A6} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF} diff --git a/docs/modules/index.md b/docs/modules/index.md index 00de47323..cec9c0e32 100644 --- a/docs/modules/index.md +++ b/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 | `changemakerstudiosus/papercut-smtp: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) | diff --git a/src/Testcontainers.Neo4j/Usings.cs b/src/Testcontainers.Neo4j/Usings.cs index adef2193a..271ad97d9 100644 --- a/src/Testcontainers.Neo4j/Usings.cs +++ b/src/Testcontainers.Neo4j/Usings.cs @@ -1,5 +1,4 @@ global using System; -global using System.Linq; global using System.Text.RegularExpressions; global using Docker.DotNet.Models; global using DotNet.Testcontainers; diff --git a/src/Testcontainers.Papercut/.editorconfig b/src/Testcontainers.Papercut/.editorconfig new file mode 100644 index 000000000..6f066619d --- /dev/null +++ b/src/Testcontainers.Papercut/.editorconfig @@ -0,0 +1 @@ +root = true \ No newline at end of file diff --git a/src/Testcontainers.Papercut/PapercutBuilder.cs b/src/Testcontainers.Papercut/PapercutBuilder.cs new file mode 100644 index 000000000..69293818d --- /dev/null +++ b/src/Testcontainers.Papercut/PapercutBuilder.cs @@ -0,0 +1,83 @@ +namespace Testcontainers.Papercut; + +/// +[PublicAPI] +public sealed class PapercutBuilder : ContainerBuilder +{ + public const string PapercutImage = "changemakerstudiosus/papercut-smtp:latest"; + + public const ushort SmtpPort = 25; + + public const ushort HttpPort = 80; + + /// + /// Initializes a new instance of the class. + /// + public PapercutBuilder() + : this(new PapercutConfiguration()) + { + DockerResourceConfiguration = Init().DockerResourceConfiguration; + } + + /// + /// Initializes a new instance of the class. + /// + /// The Docker resource configuration. + private PapercutBuilder(PapercutConfiguration resourceConfiguration) + : base(resourceConfiguration) + { + DockerResourceConfiguration = resourceConfiguration; + } + + /// + protected override PapercutConfiguration DockerResourceConfiguration { get; } + + /// + public override PapercutContainer Build() + { + Validate(); + return new PapercutContainer(DockerResourceConfiguration); + } + + /// + protected override PapercutBuilder Init() + { + return base.Init() + .WithImage(PapercutImage) + .WithPortBinding(SmtpPort, true) + .WithPortBinding(HttpPort, true) + .WithWaitStrategy(Wait.ForUnixContainer().UntilHttpRequestIsSucceeded(request => + request.ForPath("/health").ForPort(HttpPort).ForResponseMessageMatching(IsInstanceHealthyAsync))); + } + + /// + protected override PapercutBuilder Clone(IResourceConfiguration resourceConfiguration) + { + return Merge(DockerResourceConfiguration, new PapercutConfiguration(resourceConfiguration)); + } + + /// + protected override PapercutBuilder Clone(IContainerConfiguration resourceConfiguration) + { + return Merge(DockerResourceConfiguration, new PapercutConfiguration(resourceConfiguration)); + } + + /// + protected override PapercutBuilder Merge(PapercutConfiguration oldValue, PapercutConfiguration newValue) + { + return new PapercutBuilder(new PapercutConfiguration(oldValue, newValue)); + } + + /// + /// Determines whether the instance is healthy or not. + /// + /// The HTTP response that contains the health information. + /// A value indicating whether the instance is healthy or not. + private static async Task IsInstanceHealthyAsync(HttpResponseMessage response) + { + var body = await response.Content.ReadAsStringAsync() + .ConfigureAwait(false); + + return "Papercut WebUI server started successfully.".Equals(body, StringComparison.OrdinalIgnoreCase); + } +} \ No newline at end of file diff --git a/src/Testcontainers.Papercut/PapercutConfiguration.cs b/src/Testcontainers.Papercut/PapercutConfiguration.cs new file mode 100644 index 000000000..6582a0276 --- /dev/null +++ b/src/Testcontainers.Papercut/PapercutConfiguration.cs @@ -0,0 +1,53 @@ +namespace Testcontainers.Papercut; + +/// +[PublicAPI] +public sealed class PapercutConfiguration : ContainerConfiguration +{ + /// + /// Initializes a new instance of the class. + /// + public PapercutConfiguration() + { + } + + /// + /// Initializes a new instance of the class. + /// + /// The Docker resource configuration. + public PapercutConfiguration(IResourceConfiguration resourceConfiguration) + : base(resourceConfiguration) + { + // Passes the configuration upwards to the base implementations to create an updated immutable copy. + } + + /// + /// Initializes a new instance of the class. + /// + /// The Docker resource configuration. + public PapercutConfiguration(IContainerConfiguration resourceConfiguration) + : base(resourceConfiguration) + { + // Passes the configuration upwards to the base implementations to create an updated immutable copy. + } + + /// + /// Initializes a new instance of the class. + /// + /// The Docker resource configuration. + public PapercutConfiguration(PapercutConfiguration resourceConfiguration) + : this(new PapercutConfiguration(), resourceConfiguration) + { + // Passes the configuration upwards to the base implementations to create an updated immutable copy. + } + + /// + /// Initializes a new instance of the class. + /// + /// The old Docker resource configuration. + /// The new Docker resource configuration. + public PapercutConfiguration(PapercutConfiguration oldValue, PapercutConfiguration newValue) + : base(oldValue, newValue) + { + } +} \ No newline at end of file diff --git a/src/Testcontainers.Papercut/PapercutContainer.cs b/src/Testcontainers.Papercut/PapercutContainer.cs new file mode 100644 index 000000000..2ad934865 --- /dev/null +++ b/src/Testcontainers.Papercut/PapercutContainer.cs @@ -0,0 +1,29 @@ +namespace Testcontainers.Papercut; + +/// +[PublicAPI] +public sealed class PapercutContainer : DockerContainer +{ + /// + /// Initializes a new instance of the class. + /// + /// The container configuration. + public PapercutContainer(PapercutConfiguration configuration) + : base(configuration) + { + } + + /// + /// Gets the SMTP port. + /// + public ushort SmtpPort => GetMappedPublicPort(PapercutBuilder.SmtpPort); + + /// + /// Gets the Papercut base address. + /// + /// The Papercut base address. + public string GetBaseAddress() + { + return new UriBuilder(Uri.UriSchemeHttp, Hostname, GetMappedPublicPort(PapercutBuilder.HttpPort)).ToString(); + } +} \ No newline at end of file diff --git a/src/Testcontainers.Papercut/Testcontainers.Papercut.csproj b/src/Testcontainers.Papercut/Testcontainers.Papercut.csproj new file mode 100644 index 000000000..8b2ed72c6 --- /dev/null +++ b/src/Testcontainers.Papercut/Testcontainers.Papercut.csproj @@ -0,0 +1,12 @@ + + + net6.0;net8.0;netstandard2.0;netstandard2.1 + latest + + + + + + + + \ No newline at end of file diff --git a/src/Testcontainers.Papercut/Usings.cs b/src/Testcontainers.Papercut/Usings.cs new file mode 100644 index 000000000..2dfa21a9b --- /dev/null +++ b/src/Testcontainers.Papercut/Usings.cs @@ -0,0 +1,8 @@ +global using System; +global using System.Net.Http; +global using System.Threading.Tasks; +global using Docker.DotNet.Models; +global using DotNet.Testcontainers.Builders; +global using DotNet.Testcontainers.Configurations; +global using DotNet.Testcontainers.Containers; +global using JetBrains.Annotations; \ No newline at end of file diff --git a/tests/Testcontainers.Papercut.Tests/.editorconfig b/tests/Testcontainers.Papercut.Tests/.editorconfig new file mode 100644 index 000000000..6f066619d --- /dev/null +++ b/tests/Testcontainers.Papercut.Tests/.editorconfig @@ -0,0 +1 @@ +root = true \ No newline at end of file diff --git a/tests/Testcontainers.Papercut.Tests/PapercutContainerTest.cs b/tests/Testcontainers.Papercut.Tests/PapercutContainerTest.cs new file mode 100644 index 000000000..5b749ea9e --- /dev/null +++ b/tests/Testcontainers.Papercut.Tests/PapercutContainerTest.cs @@ -0,0 +1,65 @@ +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"; + + using var smtpClient = new SmtpClient(_papercutContainer.Hostname, _papercutContainer.SmtpPort); + + using var httpClient = new HttpClient(); + httpClient.BaseAddress = new Uri(_papercutContainer.GetBaseAddress()); + + // When + smtpClient.Send("from@example.com", "to@example.com", subject, "A test message"); + + var messagesJson = await httpClient.GetStringAsync("/api/messages") + .ConfigureAwait(true); + + var jsonDocument = JsonDocument.Parse(messagesJson); + var messages = jsonDocument.RootElement.GetProperty("messages").Deserialize(); + + // Then + Assert.Single(messages, message => subject.Equals(message.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; } + } +} \ No newline at end of file diff --git a/tests/Testcontainers.Papercut.Tests/Testcontainers.Papercut.Tests.csproj b/tests/Testcontainers.Papercut.Tests/Testcontainers.Papercut.Tests.csproj new file mode 100644 index 000000000..485fcc0f8 --- /dev/null +++ b/tests/Testcontainers.Papercut.Tests/Testcontainers.Papercut.Tests.csproj @@ -0,0 +1,17 @@ + + + net8.0 + false + false + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/Testcontainers.Papercut.Tests/Usings.cs b/tests/Testcontainers.Papercut.Tests/Usings.cs new file mode 100644 index 000000000..763582fff --- /dev/null +++ b/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; \ No newline at end of file