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.
74 lines
3.1 KiB
C#
74 lines
3.1 KiB
C#
using Microsoft.Extensions.Configuration;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using ZB.MOM.WW.LocalDb;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Host.Tests;
|
|
|
|
/// <summary>
|
|
/// Pins that a site node creates the directory holding <c>LocalDb:Path</c> before the
|
|
/// database is opened.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// The guarantee has now had three owners: <c>StoreAndForwardStorage</c> created the
|
|
/// directory for its own SQLite file, LocalDb Phase 2 folded that file into the
|
|
/// consolidated database and the Host took it over as a <c>SiteLocalDbDirectory</c> shim,
|
|
/// and LocalDb 0.1.1 took it into the library itself. This test survived all three moves
|
|
/// unchanged in intent, because what a site node needs is the OUTCOME — resolving
|
|
/// <c>ILocalDb</c> from the site registration must not fail on a fresh machine — not any
|
|
/// particular implementer of it. It is deliberately written against the registration path
|
|
/// rather than the mechanism, so a future move costs nothing here.
|
|
/// </para>
|
|
/// <para>
|
|
/// This is not hypothetical: the default site configuration points at the <i>relative</i>
|
|
/// path <c>./data/site-localdb.db</c>, so any site node whose working directory has no
|
|
/// <c>data/</c> subdirectory hits it. The docker rig escapes only because its volume mount
|
|
/// creates <c>/app/data</c> — which is exactly the kind of coincidence that hides a defect
|
|
/// until a bare-metal or fresh deployment.
|
|
/// </para>
|
|
/// </remarks>
|
|
public class SiteLocalDbDirectoryTests
|
|
{
|
|
/// <summary>Verifies that site registration creates the LocalDb directory when it does not exist.</summary>
|
|
[Fact]
|
|
public void SiteRegistration_CreatesTheLocalDbDirectory_WhenItDoesNotExist()
|
|
{
|
|
var root = Path.Combine(Path.GetTempPath(), "localdb-dir-test-" + Guid.NewGuid().ToString("N"));
|
|
var dbPath = Path.Combine(root, "nested", "site-localdb.db");
|
|
Assert.False(Directory.Exists(root));
|
|
|
|
try
|
|
{
|
|
var config = new ConfigurationBuilder()
|
|
.AddInMemoryCollection(new Dictionary<string, string?>
|
|
{
|
|
["LocalDb:Path"] = dbPath,
|
|
})
|
|
.Build();
|
|
|
|
// The registration path under test. Resolving ILocalDb is what actually opens
|
|
// the file, so this fails with SQLite Error 14 if the directory step regresses
|
|
// — wherever it lives.
|
|
var services = new ServiceCollection();
|
|
services.AddZbLocalDb(config);
|
|
|
|
using var provider = services.BuildServiceProvider();
|
|
using var scope = provider.CreateScope();
|
|
var db = scope.ServiceProvider.GetRequiredService<ILocalDb>();
|
|
|
|
Assert.NotNull(db);
|
|
Assert.True(Directory.Exists(Path.GetDirectoryName(dbPath)!));
|
|
Assert.True(File.Exists(dbPath));
|
|
}
|
|
finally
|
|
{
|
|
SqliteConnectionPoolCleanup();
|
|
if (Directory.Exists(root))
|
|
Directory.Delete(root, recursive: true);
|
|
}
|
|
}
|
|
|
|
private static void SqliteConnectionPoolCleanup() =>
|
|
Microsoft.Data.Sqlite.SqliteConnection.ClearAllPools();
|
|
}
|