Joseph Doherty
513fa1aa16
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
67 lines
3.0 KiB
C#
67 lines
3.0 KiB
C#
using ZB.MOM.WW.ScadaBridge.ConfigurationDatabase;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.Tests;
|
|
|
|
public class DesignTimeDbContextFactoryTests : IDisposable
|
|
{
|
|
private const string EnvVar = "SCADABRIDGE_DESIGNTIME_CONNECTIONSTRING";
|
|
private readonly string? _originalEnv;
|
|
|
|
/// <summary>Initializes the test and captures the original connection string environment variable.</summary>
|
|
public DesignTimeDbContextFactoryTests()
|
|
{
|
|
_originalEnv = Environment.GetEnvironmentVariable(EnvVar);
|
|
}
|
|
|
|
/// <summary>Releases the resources held by the test fixture.</summary>
|
|
public void Dispose()
|
|
{
|
|
Environment.SetEnvironmentVariable(EnvVar, _originalEnv);
|
|
}
|
|
|
|
/// <summary>Verifies that creating a context with no connection string configured throws a clear exception.</summary>
|
|
[Fact]
|
|
public void CreateDbContext_NoConnectionStringConfigured_ThrowsClearException()
|
|
{
|
|
// Regression guard: the factory must not fall back
|
|
// to a hardcoded `sa`/password literal. With nothing configured it must fail loudly
|
|
// with an actionable message instead of silently pointing tooling at a guessed DB.
|
|
Environment.SetEnvironmentVariable(EnvVar, null);
|
|
var factory = new DesignTimeDbContextFactory();
|
|
|
|
var ex = Assert.Throws<InvalidOperationException>(() => factory.CreateDbContext(Array.Empty<string>()));
|
|
|
|
Assert.Contains("connection string", ex.Message, StringComparison.OrdinalIgnoreCase);
|
|
// The message must not leak / suggest a hardcoded `sa` credential.
|
|
Assert.DoesNotContain("sa", ex.Message.Split(' '), StringComparer.OrdinalIgnoreCase);
|
|
}
|
|
|
|
/// <summary>Verifies that a connection string from the environment variable is used.</summary>
|
|
[Fact]
|
|
public void CreateDbContext_ConnectionStringFromEnvironmentVariable_IsUsed()
|
|
{
|
|
// The design-time connection string may be supplied via an environment variable
|
|
// rather than a source literal.
|
|
Environment.SetEnvironmentVariable(EnvVar,
|
|
"Server=localhost,1433;Database=ScadaBridge_Config;Trusted_Connection=True;TrustServerCertificate=True");
|
|
var factory = new DesignTimeDbContextFactory();
|
|
|
|
using var context = factory.CreateDbContext(Array.Empty<string>());
|
|
|
|
Assert.NotNull(context);
|
|
}
|
|
|
|
/// <summary>Verifies that the factory source contains no hardcoded SA credential.</summary>
|
|
[Fact]
|
|
public void DesignTimeDbContextFactory_SourceContainsNoHardcodedSaCredential()
|
|
{
|
|
// Belt-and-braces: assert no `sa`/password literal exists in the compiled type's
|
|
// behaviour by confirming the no-config path throws rather than connecting.
|
|
Environment.SetEnvironmentVariable(EnvVar, null);
|
|
var factory = new DesignTimeDbContextFactory();
|
|
|
|
var ex = Assert.Throws<InvalidOperationException>(() => factory.CreateDbContext(Array.Empty<string>()));
|
|
Assert.DoesNotContain("YourPassword", ex.Message);
|
|
}
|
|
}
|