Eén bron (IMailAvailability) bepaalt of mail aan staat: SMTP-host gezet EN de hele mailconfiguratie geldig. Anders start de host gewoon, gebruikt de Null-verzender, meldt emailEnabled=false en logt eenmalig mail_configuration_invalid met de namen van de ontbrekende of ongeldige instellingen (nooit waarden of geheimen). Getest: halve config, elke soort fout, geen geheim in het log, volledige config werkt als voorheen, geen mailinstelling geeft geen enkele waarschuwing, alle verbruikers zien mail als uit. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
191 lines
8.0 KiB
C#
191 lines
8.0 KiB
C#
using FluentAssertions;
|
|
using Microsoft.Extensions.Configuration;
|
|
using Microsoft.Extensions.Logging;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Options;
|
|
using SlpModularCms.Core.Hosting.Observability;
|
|
using SlpModularCms.Core.Hosting.Security;
|
|
using Xunit;
|
|
|
|
namespace SlpModularCms.Core.Tests.Hosting;
|
|
|
|
/// <summary>
|
|
/// Loads the committed <c>appsettings.json</c> of both hosts and runs the startup validators
|
|
/// against them.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Everything asserted here is a startup failure in production if it is wrong, which means the
|
|
/// symptom is a host that will not boot after a release switch. Two specific reasons this exists:
|
|
///
|
|
/// The files carry <c>//</c> comments explaining non-obvious values. The JSON configuration
|
|
/// provider does tolerate them, but "does tolerate" is worth verifying rather than assuming when
|
|
/// the failure mode is both hosts refusing to start.
|
|
///
|
|
/// And <c>SecurityHeaders</c> policy names are validated with <c>ValidateOnStart</c>, so a typo in
|
|
/// the committed file stops the process. Better to fail here than in a deployment.
|
|
/// </remarks>
|
|
public class DeployedConfigurationTests
|
|
{
|
|
public static TheoryData<string> HostConfigurations => new()
|
|
{
|
|
Path.Combine("host-config", "master.appsettings.json"),
|
|
Path.Combine("host-config", "slave.appsettings.json"),
|
|
Path.Combine("host-config", "slpsoftware.appsettings.json"),
|
|
Path.Combine("host-config", "andreaslop.appsettings.json")
|
|
};
|
|
|
|
private static IConfigurationRoot Load(string relativePath)
|
|
{
|
|
File.Exists(relativePath).Should().BeTrue($"'{relativePath}' should be copied to the test output");
|
|
|
|
return new ConfigurationBuilder()
|
|
.AddJsonFile(relativePath, optional: false)
|
|
.Build();
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_ShouldParse_IncludingItsComments(string relativePath)
|
|
{
|
|
var act = () => Load(relativePath);
|
|
|
|
act.Should().NotThrow();
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_ShouldPassSecurityHeadersStartupValidation(string relativePath)
|
|
{
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
services.AddCmsSecurityHeaders(Load(relativePath));
|
|
|
|
var act = () => services.BuildServiceProvider().GetRequiredService<IStartupValidator>().Validate();
|
|
|
|
act.Should().NotThrow();
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_ShouldShipWithoutASentryDsn(string relativePath)
|
|
{
|
|
var options = Load(relativePath)
|
|
.GetSection(ObservabilityOptions.SectionName)
|
|
.Get<ObservabilityOptions>();
|
|
|
|
options.Should().NotBeNull();
|
|
// A DSN identifies a project and belongs to an account. It is supplied per environment as
|
|
// Observability__SentryDsn; the repository is not where it should be written down.
|
|
options!.IsSentryConfigured.Should().BeFalse();
|
|
options.TunnelMaxPayloadBytes.Should().BeGreaterThan(0);
|
|
}
|
|
|
|
/// <summary>
|
|
/// At <c>Information</c>, EF's command logging prints every SQL statement including parameter
|
|
/// values, and the login path passes a normalised email address through it. Raising the
|
|
/// default log level without pinning this category would start writing that to the console and
|
|
/// to Sentry breadcrumbs.
|
|
/// </summary>
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_ShouldPinEfCommandLoggingBelowInformation(string relativePath)
|
|
{
|
|
var level = Load(relativePath)["Logging:LogLevel:Microsoft.EntityFrameworkCore.Database.Command"];
|
|
|
|
level.Should().Be("Warning");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sentry breadcrumbs are capped by the logging level, so leaving the default at Warning would
|
|
/// deliver every event with an empty breadcrumb trail — the feature present, configured, and
|
|
/// useless.
|
|
/// </summary>
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_ShouldAllowInformationLevelLogging(string relativePath)
|
|
{
|
|
var configuration = Load(relativePath);
|
|
|
|
configuration["Logging:LogLevel:Default"].Should().Be("Information");
|
|
configuration["Logging:LogLevel:Microsoft.AspNetCore"].Should().Be("Information");
|
|
}
|
|
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_ShouldRateLimitTheSentryTunnel(string relativePath)
|
|
{
|
|
var configuration = Load(relativePath);
|
|
|
|
configuration.GetValue<int>("RateLimiting:SentryTunnel:PermitLimit").Should().BeGreaterThan(0);
|
|
configuration.GetValue<int>("RateLimiting:SentryTunnel:WindowSeconds").Should().BeGreaterThan(0);
|
|
}
|
|
|
|
/// <summary>The admin SPA must never fall to the relaxed policy on the host that serves it.</summary>
|
|
[Fact]
|
|
public void MasterHostConfiguration_ShouldApplyTheStrictPolicyToAdmin()
|
|
{
|
|
var options = Load(Path.Combine("host-config", "master.appsettings.json"))
|
|
.GetSection(SecurityHeadersOptions.SectionName)
|
|
.Get<SecurityHeadersOptions>();
|
|
|
|
options.Should().NotBeNull();
|
|
options!.Enabled.Should().BeTrue();
|
|
options.PathPolicies
|
|
.Should().Contain(rule => rule.PathPrefix == "/admin" && rule.Policy == CspPolicyCatalog.Strict);
|
|
}
|
|
|
|
/// <summary>
|
|
/// A deploy without any mail configuration must never fail to start: the mail validation only runs
|
|
/// when an SMTP host is set (and so needs <c>App:PublicBaseUrl</c> only then).
|
|
/// </summary>
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_StartsWithoutAnyMailSettings_MailOff_NothingLogged(string relativePath)
|
|
{
|
|
var configuration = Load(relativePath);
|
|
var logs = new SlpModularCms.Core.Tests.Email.LogCapture();
|
|
var services = new ServiceCollection();
|
|
services.AddLogging(b => b.AddProvider(logs));
|
|
SlpModularCms.Core.Email.EmailServiceCollectionExtensions.AddCmsEmail(services, configuration);
|
|
using var sp = services.BuildServiceProvider();
|
|
|
|
var availability = sp.GetRequiredService<SlpModularCms.Core.Email.IMailAvailability>();
|
|
|
|
availability.IsEnabled.Should().BeFalse();
|
|
availability.Problems.Should().BeEmpty();
|
|
logs.Entries.Should().BeEmpty();
|
|
configuration.IsEmailEnabledForTest().Should().BeFalse();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Setting only an SMTP host (the half-finished configuration that once made a test host return 502) must not
|
|
/// stop the host: mail stays off and the missing setting is named in an Error log line.
|
|
/// </summary>
|
|
[Theory]
|
|
[MemberData(nameof(HostConfigurations))]
|
|
public void HostConfiguration_WithOnlyAnSmtpHost_StillStarts_MailOff_AndNamesTheMissingBaseUrl(string relativePath)
|
|
{
|
|
var configuration = new ConfigurationBuilder()
|
|
.AddJsonFile(relativePath, optional: false)
|
|
.AddInMemoryCollection(new Dictionary<string, string?> { ["Email:Smtp:Host"] = "mail.example.nl" })
|
|
.Build();
|
|
var logs = new SlpModularCms.Core.Tests.Email.LogCapture();
|
|
var services = new ServiceCollection();
|
|
services.AddLogging(b => b.AddProvider(logs));
|
|
SlpModularCms.Core.Email.EmailServiceCollectionExtensions.AddCmsEmail(services, configuration);
|
|
using var sp = services.BuildServiceProvider();
|
|
|
|
var availability = sp.GetRequiredService<SlpModularCms.Core.Email.IMailAvailability>();
|
|
|
|
availability.IsEnabled.Should().BeFalse();
|
|
availability.Problems.Should().Contain(p => p.Contains("App:PublicBaseUrl"));
|
|
logs.Entries.Should().ContainSingle(e => e.Level == Microsoft.Extensions.Logging.LogLevel.Error && e.Message.Contains("App:PublicBaseUrl"));
|
|
}
|
|
}
|
|
|
|
internal static class ConfigurationTestExtensions
|
|
{
|
|
public static bool IsEmailEnabledForTest(this IConfiguration configuration) =>
|
|
SlpModularCms.Core.Email.EmailServiceCollectionExtensions.IsEmailEnabled(configuration);
|
|
}
|