ed2ed0a367
Owner decision 2026-11-15, at IT security's request, pending a family-wide general solution. Removed: the chaining service, hasher, verifier, chain head/tombstone entities and store, the #139 chain-start cutoff, AuditLog:HashChain (incl. ChainBacklog and HeadExport with its File/Syslog sinks and export service), the audit-chain-head-export health check, the VerifyAuditChain / VerifyAuditChainHeads management commands and the `audit verify-chain` / `audit verify-heads` CLI commands, and the two-login plumbing (AuditLog:MaintenanceConnectionString, AuditMaintenanceContext, the keyed audit-maintenance repository/archive). Purge, archive, retention, partition roll-forward and backfill-source-node all run on the runtime connection again, as before #107. Parquet archive (#42) kept, chain-free: format v2 (ten stored columns, no tombstone file, manifest without chain state), the switch guard is the row count only (51003 gone), verify = data-file size, SHA-256 and row count, and superseded-stale cleanup proves coverage by EventId. Format-v1 archives still list, verify and are cleaned up (their tombstone file too). Migration RemoveAuditLogHashChain drops the chain indexes, the scadabridge_audit_chainer role (members first), both chain tables, ChainSeq/RowHash and the purger's AuditMaintenanceGrants grants; writer/purger roles stay. Down restores them. Every chain-column reference is EXEC-deferred for the idempotent script (#126); FlipAuditLogClusteredKey's two chain index statements get the same deferral, behaviour unchanged, so re-running the idempotent script on a migrated database works. The partition-switch staging table adds the chain columns only when the live table has them, so the new binary purges either schema. Deploy gate: old binaries map the chain columns, so the migration ships with the new binaries, both centrals stopped. A leftover AuditLog:HashChain section or MaintenanceConnectionString (DEV/QA still carry AuditLog__HashChain__Enabled=true) is ignored with one startup warning (RetiredAuditSettingsWarning). Claude-Session: https://claude.ai/code/session_01GT67AFKC45MBz1wPZnVbX8
163 lines
7.8 KiB
C#
163 lines
7.8 KiB
C#
using System.Net;
|
|
using System.Net.Sockets;
|
|
using System.Text;
|
|
using System.Text.Json;
|
|
using ZB.MOM.WW.ScadaBridge.CLI.Commands;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
|
|
|
|
/// <summary>
|
|
/// Tests for <c>scadabridge audit archive list</c> / <c>verify</c> (ScadaBridge#42): each
|
|
/// sends its management command (<c>ListAuditArchives</c>, <c>VerifyAuditArchive</c>), and
|
|
/// <c>verify</c> maps the verdict onto the exit code (0 verified, 3 not verified).
|
|
/// </summary>
|
|
[Collection("Console")]
|
|
public class AuditArchiveCommandTests
|
|
{
|
|
private const string Name = "auditlog-2025-10-20261109T120000123Z";
|
|
|
|
private const string ListBody =
|
|
"{\"enabled\":true,\"archives\":[{\"name\":\"" + Name + "\",\"partition\":\"2025-10\",\"status\":\"Purged\"," +
|
|
"\"rowCount\":11,\"dataBytes\":4096}]}";
|
|
|
|
private const string VerifiedBody =
|
|
"{\"name\":\"" + Name + "\",\"partition\":\"2025-10\",\"manifestStatus\":\"Purged\",\"verified\":true,\"filesIntact\":true," +
|
|
"\"rowsRead\":11}";
|
|
|
|
private const string MismatchBody =
|
|
"{\"name\":\"" + Name + "\",\"partition\":\"2025-10\",\"manifestStatus\":\"Purged\",\"verified\":false,\"filesIntact\":false," +
|
|
"\"fileProblem\":\"The data file holds 10 rows; the manifest records 11.\",\"rowsRead\":10}";
|
|
|
|
/// <summary>The audit group carries the archive group with list + verify + cleanup (ScadaBridge#109).</summary>
|
|
[Fact]
|
|
public void AuditGroup_HasArchiveListVerifyAndCleanup()
|
|
{
|
|
var root = AuditCommandTestHarness.BuildRoot();
|
|
var archive = root.Subcommands.Single(c => c.Name == "audit").Subcommands.Single(c => c.Name == "archive");
|
|
Assert.Equal(["cleanup", "list", "verify"], archive.Subcommands.Select(c => c.Name).Order());
|
|
}
|
|
|
|
/// <summary><c>list</c> sends ListAuditArchives and prints the archives.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task List_SendsListAuditArchives_AndPrintsTheArchives()
|
|
{
|
|
var (exit, output, request) = await RunAsync(ListBody, "audit", "archive", "list", "--format", "table");
|
|
|
|
Assert.Equal(0, exit);
|
|
Assert.Contains(Name, output);
|
|
Assert.Contains("Archiving: enabled", output);
|
|
using var payload = JsonDocument.Parse(request);
|
|
Assert.Equal("ListAuditArchives", payload.RootElement.GetProperty("command").GetString());
|
|
}
|
|
|
|
/// <summary><c>verify</c> sends VerifyAuditArchive with the name and maps the verdict to the exit code.</summary>
|
|
/// <param name="body">The verification result the fake endpoint serves.</param>
|
|
/// <param name="format">Output format.</param>
|
|
/// <param name="expectedExit">Expected exit code.</param>
|
|
/// <param name="expectedText">Text the report must contain.</param>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Theory]
|
|
[InlineData(VerifiedBody, "table", 0, "Rows read : 11")]
|
|
[InlineData(VerifiedBody, "json", 0, "\"verified\":true")]
|
|
[InlineData(MismatchBody, "table", 3, "Verified : NO")]
|
|
[InlineData(MismatchBody, "json", 3, "\"filesIntact\":false")]
|
|
public async Task Verify_SendsVerifyAuditArchive_AndMapsVerdictToExitCode(
|
|
string body, string format, int expectedExit, string expectedText)
|
|
{
|
|
var (exit, output, request) = await RunAsync(body, "audit", "archive", "verify", "--name", Name, "--format", format);
|
|
|
|
Assert.Equal(expectedExit, exit);
|
|
Assert.Contains(expectedText, output);
|
|
using var payload = JsonDocument.Parse(request);
|
|
Assert.Equal("VerifyAuditArchive", payload.RootElement.GetProperty("command").GetString());
|
|
var name = payload.RootElement.GetProperty("payload").EnumerateObject()
|
|
.First(p => string.Equals(p.Name, "name", StringComparison.OrdinalIgnoreCase)).Value.GetString();
|
|
Assert.Equal(Name, name);
|
|
}
|
|
|
|
/// <summary>
|
|
/// <c>cleanup</c> (ScadaBridge#109) sends CleanupAuditArchives with the dry-run flag and
|
|
/// reports each action; it always exits 0.
|
|
/// </summary>
|
|
/// <param name="dryRun">Whether <c>--dry-run</c> is passed.</param>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Theory]
|
|
[InlineData(true)]
|
|
[InlineData(false)]
|
|
public async Task Cleanup_SendsCleanupAuditArchives_WithTheDryRunFlag(bool dryRun)
|
|
{
|
|
var body = "{\"dryRun\":" + (dryRun ? "true" : "false") + ",\"retentionDays\":0,\"items\":[{\"name\":\"" + Name
|
|
+ "\",\"partition\":\"2025-10\",\"action\":\"DeletedSuperseded\",\"detail\":\"superseded by x\"}]}";
|
|
string[] args = dryRun
|
|
? ["audit", "archive", "cleanup", "--dry-run", "--format", "table"]
|
|
: ["audit", "archive", "cleanup", "--format", "table"];
|
|
var (exit, output, request) = await RunAsync(body, args);
|
|
|
|
Assert.Equal(0, exit);
|
|
Assert.Contains("DeletedSuperseded", output);
|
|
Assert.Contains("never delete", output);
|
|
Assert.Equal(dryRun, output.Contains("Dry run", StringComparison.Ordinal));
|
|
using var payload = JsonDocument.Parse(request);
|
|
Assert.Equal("CleanupAuditArchives", payload.RootElement.GetProperty("command").GetString());
|
|
Assert.Equal(dryRun, payload.RootElement.GetProperty("payload").EnumerateObject()
|
|
.First(p => string.Equals(p.Name, "dryRun", StringComparison.OrdinalIgnoreCase)).Value.GetBoolean());
|
|
}
|
|
|
|
/// <summary><c>verify</c> without <c>--name</c> is a usage error.</summary>
|
|
[Fact]
|
|
public void Verify_MissingName_ProducesRequiredFlagError()
|
|
{
|
|
var root = AuditCommandTestHarness.BuildRoot();
|
|
var (exit, _, err) = AuditCommandTestHarness.Invoke(root, "audit", "archive", "verify");
|
|
|
|
Assert.NotEqual(0, exit);
|
|
Assert.Contains("--name", err);
|
|
}
|
|
|
|
private static async Task<(int Exit, string Output, string Request)> RunAsync(string body, params string[] args)
|
|
{
|
|
var listener = new TcpListener(IPAddress.Loopback, 0);
|
|
listener.Start();
|
|
try
|
|
{
|
|
var port = ((IPEndPoint)listener.LocalEndpoint).Port;
|
|
string? requestBody = null;
|
|
var server = Task.Run(async () =>
|
|
{
|
|
using var client = await listener.AcceptTcpClientAsync();
|
|
await using var stream = client.GetStream();
|
|
using var reader = new StreamReader(stream, Encoding.UTF8, leaveOpen: true);
|
|
var length = 0;
|
|
while (await reader.ReadLineAsync() is { Length: > 0 } line)
|
|
if (line.StartsWith("Content-Length:", StringComparison.OrdinalIgnoreCase))
|
|
length = int.Parse(line[15..].Trim());
|
|
var buffer = new char[length];
|
|
var read = 0;
|
|
while (read < length)
|
|
{
|
|
var count = await reader.ReadAsync(buffer.AsMemory(read));
|
|
if (count == 0) throw new EndOfStreamException();
|
|
read += count;
|
|
}
|
|
requestBody = new string(buffer);
|
|
var bytes = Encoding.UTF8.GetBytes(body);
|
|
var headers = Encoding.ASCII.GetBytes(
|
|
$"HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: {bytes.Length}\r\nConnection: close\r\n\r\n");
|
|
await stream.WriteAsync(headers);
|
|
await stream.WriteAsync(bytes);
|
|
});
|
|
|
|
var root = AuditCommandTestHarness.BuildRoot();
|
|
var (exit, output, _) = AuditCommandTestHarness.Invoke(
|
|
root, [.. args, "--url", $"http://127.0.0.1:{port}", "--username", "u", "--password", "p"]);
|
|
await server.WaitAsync(TimeSpan.FromSeconds(5));
|
|
return (exit, output, requestBody!);
|
|
}
|
|
finally
|
|
{
|
|
listener.Stop();
|
|
}
|
|
}
|
|
}
|