using FluentAssertions;
using Microsoft.Extensions.Configuration;
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;
///
/// Loads the committed appsettings.json of both hosts and runs the startup validators
/// against them.
///
///
/// 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 // 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 SecurityHeaders policy names are validated with ValidateOnStart, so a typo in
/// the committed file stops the process. Better to fail here than in a deployment.
///
public class DeployedConfigurationTests
{
public static TheoryData 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().Validate();
act.Should().NotThrow();
}
[Theory]
[MemberData(nameof(HostConfigurations))]
public void HostConfiguration_ShouldShipWithoutASentryDsn(string relativePath)
{
var options = Load(relativePath)
.GetSection(ObservabilityOptions.SectionName)
.Get();
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);
}
///
/// At Information, 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.
///
[Theory]
[MemberData(nameof(HostConfigurations))]
public void HostConfiguration_ShouldPinEfCommandLoggingBelowInformation(string relativePath)
{
var level = Load(relativePath)["Logging:LogLevel:Microsoft.EntityFrameworkCore.Database.Command"];
level.Should().Be("Warning");
}
///
/// 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.
///
[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("RateLimiting:SentryTunnel:PermitLimit").Should().BeGreaterThan(0);
configuration.GetValue("RateLimiting:SentryTunnel:WindowSeconds").Should().BeGreaterThan(0);
}
/// The admin SPA must never fall to the relaxed policy on the host that serves it.
[Fact]
public void MasterHostConfiguration_ShouldApplyTheStrictPolicyToAdmin()
{
var options = Load(Path.Combine("host-config", "master.appsettings.json"))
.GetSection(SecurityHeadersOptions.SectionName)
.Get();
options.Should().NotBeNull();
options!.Enabled.Should().BeTrue();
options.PathPolicies
.Should().Contain(rule => rule.PathPrefix == "/admin" && rule.Policy == CspPolicyCatalog.Strict);
}
///
/// 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 App:PublicBaseUrl only then).
///
[Theory]
[MemberData(nameof(HostConfigurations))]
public void HostConfiguration_StartsWithoutAnyMailSettings(string relativePath)
{
var configuration = Load(relativePath);
var services = new ServiceCollection();
services.AddLogging();
SlpModularCms.Core.Email.EmailServiceCollectionExtensions.AddCmsEmail(services, configuration);
using var sp = services.BuildServiceProvider();
var act = () => sp.GetRequiredService().Validate();
act.Should().NotThrow();
configuration.IsEmailEnabledForTest().Should().BeFalse();
}
[Theory]
[MemberData(nameof(HostConfigurations))]
public void HostConfiguration_NeedsPublicBaseUrl_OnlyOnceAnSmtpHostIsSet(string relativePath)
{
var configuration = new ConfigurationBuilder()
.AddJsonFile(relativePath, optional: false)
.AddInMemoryCollection(new Dictionary { ["Email:Smtp:Host"] = "mail.example.nl" })
.Build();
var services = new ServiceCollection();
services.AddLogging();
SlpModularCms.Core.Email.EmailServiceCollectionExtensions.AddCmsEmail(services, configuration);
using var sp = services.BuildServiceProvider();
var act = () => sp.GetRequiredService().Validate();
// With a host but no App__PublicBaseUrl the host refuses to start, and says which setting is missing.
act.Should().Throw().WithMessage("*App:PublicBaseUrl*");
}
}
internal static class ConfigurationTestExtensions
{
public static bool IsEmailEnabledForTest(this IConfiguration configuration) =>
SlpModularCms.Core.Email.EmailServiceCollectionExtensions.IsEmailEnabled(configuration);
}