6ae0fea558
Async cancellation hygiene, fire-and-forget observability, retry/shutdown semantics, and audit-row coverage across 9 modules. Highlights: Cancellation & lifecycle: - AuditLog-006: SqliteAuditWriter.Dispose hops to thread pool, escaping the captured SyncContext that risked sync-over-async deadlock. - AuditLog-010: SiteAuditTelemetryActor owns a private lifecycle CTS, threaded through drain paths instead of CancellationToken.None. - Comm-019: CentralCommunicationActor adds lifecycle CTS for repo calls. - Host-019: Migration StartupRetry forwards ApplicationStopping so SIGTERM during the bounded-retry window aborts cleanly. Cursor / retry / counter correctness: - AuditLog-004: SiteAuditReconciliationActor's cursor now holds at `since` when any row's idempotent insert is still being retried (per-EventId retry counter, MaxPermanentInsertAttempts=5 escape valve with LogCritical abandon). No more silent abandonment of permanently-failing rows. - ConfigDB-019: Dropped the catch-and-continue on EnsureLookaheadAsync's SPLIT loop — by class-doc construction the catch could only mask real failures and let the next iteration create permanent partition holes. - HM-017/018: HealthReportSender + CentralHealthReportLoop snapshot per-interval counters before sending, restore via new ISiteHealthCollector.AddIntervalCounters on transport failure so counts aren't silently lost. Fire-and-forget / shutdown waits: - InboundAPI-018: AuditWriteMiddleware observes faulted audit-write tasks via OnlyOnFaulted continuation (Warning log; response unchanged). - SnF-024: StoreAndForwardService.StopAsync awaits in-flight retry sweep with a bounded SweepShutdownWaitTimeout (10s). Leak / refactor: - Comm-021: SiteStreamGrpcServer.SubscribeInstance wraps Subscribe in its own try/catch so a throw doesn't leak the relay actor or _activeStreams entry. - Comm-022: VERIFIED already-closed by Comm-016's dead-code purge. - CLI-017: BundleCommands' three subcommands delegate to ExecuteCommandAsync (auth-failure exit-code contract unified). Defensive / validation: - CLI-021: CliConfig.Load wraps file-read/JSON parse so malformed config prints a warning and returns defaults instead of crashing the CLI. - Host-022: ParseLevel emits stderr one-shot warning for unrecognised MinimumLevel instead of silently coercing to Information. - ESG-019: ExternalSystemClient sets HttpClient.Timeout=Infinite so the per-call CTS is the sole timeout source (was clipped to 100s by .NET). - Security-020: New SecurityOptionsValidator (IValidateOptions) rejects empty LdapServer/LdapSearchBase with ValidateOnStart. - DM-019: Lifecycle command timeouts now emit DisableTimedOut/EnableTimedOut/ DeleteTimedOut audit entries (mirrors DeployFailed pattern). Plus reconciled stale per-module Open-findings counters that had drifted from prior sessions. 20+ new regression tests across 11 test projects; build clean; affected suites all green. README regenerated: 75 open (was 93).
123 lines
4.7 KiB
C#
123 lines
4.7 KiB
C#
using ScadaLink.CLI;
|
|
|
|
namespace ScadaLink.CLI.Tests;
|
|
|
|
[Collection("Environment")]
|
|
public class CliConfigTests
|
|
{
|
|
[Fact]
|
|
public void Load_DefaultFormat_IsJson()
|
|
{
|
|
var origUrl = Environment.GetEnvironmentVariable("SCADALINK_MANAGEMENT_URL");
|
|
var origFormat = Environment.GetEnvironmentVariable("SCADALINK_FORMAT");
|
|
|
|
try
|
|
{
|
|
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", null);
|
|
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", null);
|
|
|
|
var config = CliConfig.Load();
|
|
|
|
// DefaultFormat is always "json" unless overridden by config file or env var
|
|
Assert.Equal("json", config.DefaultFormat);
|
|
}
|
|
finally
|
|
{
|
|
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", origUrl);
|
|
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", origFormat);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void Load_ManagementUrl_FromEnvironment()
|
|
{
|
|
var orig = Environment.GetEnvironmentVariable("SCADALINK_MANAGEMENT_URL");
|
|
try
|
|
{
|
|
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", "http://central:5000");
|
|
|
|
var config = CliConfig.Load();
|
|
|
|
Assert.Equal("http://central:5000", config.ManagementUrl);
|
|
}
|
|
finally
|
|
{
|
|
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", orig);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void Load_Format_FromEnvironment()
|
|
{
|
|
var orig = Environment.GetEnvironmentVariable("SCADALINK_FORMAT");
|
|
try
|
|
{
|
|
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", "table");
|
|
|
|
var config = CliConfig.Load();
|
|
|
|
Assert.Equal("table", config.DefaultFormat);
|
|
}
|
|
finally
|
|
{
|
|
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", orig);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// CLI-021 regression: a malformed ~/.scadalink/config.json must NOT abort the
|
|
/// CLI before any command runs — Load() must warn (to stderr) and return a
|
|
/// usable default config so command-line overrides (--url, --username, etc.)
|
|
/// and env vars can still take effect.
|
|
/// </summary>
|
|
[Fact]
|
|
public void Load_MalformedConfigFile_DoesNotThrow_WarnsAndReturnsDefault()
|
|
{
|
|
var tempHome = Path.Combine(Path.GetTempPath(), "scadalink-cli-test-" + Guid.NewGuid().ToString("N"));
|
|
Directory.CreateDirectory(Path.Combine(tempHome, ".scadalink"));
|
|
File.WriteAllText(
|
|
Path.Combine(tempHome, ".scadalink", "config.json"),
|
|
"{ this is not valid json :: ");
|
|
|
|
var origHome = Environment.GetEnvironmentVariable("HOME");
|
|
var origUserProfile = Environment.GetEnvironmentVariable("USERPROFILE");
|
|
var origUrl = Environment.GetEnvironmentVariable("SCADALINK_MANAGEMENT_URL");
|
|
var origFormat = Environment.GetEnvironmentVariable("SCADALINK_FORMAT");
|
|
var origUser = Environment.GetEnvironmentVariable("SCADALINK_USERNAME");
|
|
var origPass = Environment.GetEnvironmentVariable("SCADALINK_PASSWORD");
|
|
var origStderr = Console.Error;
|
|
try
|
|
{
|
|
Environment.SetEnvironmentVariable("HOME", tempHome);
|
|
Environment.SetEnvironmentVariable("USERPROFILE", tempHome);
|
|
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", null);
|
|
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", null);
|
|
Environment.SetEnvironmentVariable("SCADALINK_USERNAME", null);
|
|
Environment.SetEnvironmentVariable("SCADALINK_PASSWORD", null);
|
|
|
|
var stderrCapture = new StringWriter();
|
|
Console.SetError(stderrCapture);
|
|
|
|
// Must not throw.
|
|
var config = CliConfig.Load();
|
|
|
|
Assert.Equal("json", config.DefaultFormat);
|
|
Assert.Null(config.ManagementUrl);
|
|
var stderrText = stderrCapture.ToString();
|
|
Assert.Contains("warning", stderrText, StringComparison.OrdinalIgnoreCase);
|
|
Assert.Contains("config.json", stderrText);
|
|
}
|
|
finally
|
|
{
|
|
Console.SetError(origStderr);
|
|
Environment.SetEnvironmentVariable("HOME", origHome);
|
|
Environment.SetEnvironmentVariable("USERPROFILE", origUserProfile);
|
|
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", origUrl);
|
|
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", origFormat);
|
|
Environment.SetEnvironmentVariable("SCADALINK_USERNAME", origUser);
|
|
Environment.SetEnvironmentVariable("SCADALINK_PASSWORD", origPass);
|
|
try { Directory.Delete(tempHome, recursive: true); } catch { /* best-effort cleanup */ }
|
|
}
|
|
}
|
|
}
|