Joseph Doherty
b95ee5a658
Owner decisions recorded: the archive destination stays a directory/UNC (no object-storage client; share + permissions named at enablement), parquet-tools-only reading (no re-import), unsigned like the chain (#107). AuditLog:Archive:RetentionDays (default 0 = never delete; else must exceed AuditLog:RetentionDays, counted from the archived month's end) and DeleteSupersededStaleArchives (default true) run after every purge tick. A retried purge's stale Archived archive is deleted only when a later, verifying, Purged archive of the same partition provably holds every row: same prior anchor and the stale chain-end hash at its chain-end sequence (row or tombstone), every unchained row present by EventId; otherwise it is reported KeptStale. A sole copy left at Archived is never touched. Deletion removes only the archive name's own three files in its folder, manifest first, never a manifest-supplied path. `audit archive cleanup [--dry-run]` = CleanupAuditArchives (Administrator). AuditLogArchiveCleanupTests (MSSQL) cover retried purge, kept stale copy, sole copy, retention and the path guard; each safety rule mutation-checked. Follow-ups filed: #113, #114, #115. Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
73 lines
3.0 KiB
C#
73 lines
3.0 KiB
C#
using System.CommandLine;
|
|
using ZB.MOM.WW.ScadaBridge.CLI.Commands;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
|
|
|
|
/// <summary>
|
|
/// Scaffold tests for the <c>scadabridge audit</c> command group (Audit Log).
|
|
/// Verifies the parent command exists with its subcommands and that every leaf
|
|
/// has an action wired. Also covers <c>backfill-source-node</c>.
|
|
/// </summary>
|
|
public class AuditCommandsScaffoldTests
|
|
{
|
|
private static readonly Option<string> Url = new("--url") { Recursive = true };
|
|
private static readonly Option<string> Username = new("--username") { Recursive = true };
|
|
private static readonly Option<string> Password = new("--password") { Recursive = true };
|
|
private static readonly Option<string> Format = CliOptions.CreateFormatOption();
|
|
|
|
private static Command BuildAudit()
|
|
=> AuditCommands.Build(Url, Format, Username, Password);
|
|
|
|
/// <summary>Verifies that the command group is named <c>audit</c>.</summary>
|
|
[Fact]
|
|
public void Audit_Command_IsNamedAudit()
|
|
{
|
|
var audit = BuildAudit();
|
|
Assert.Equal("audit", audit.Name);
|
|
Assert.False(string.IsNullOrWhiteSpace(audit.Description));
|
|
}
|
|
|
|
/// <summary>Verifies that the audit group exposes the query, export, tree, verify-chain, verify-heads, backfill-source-node and archive subcommands.</summary>
|
|
[Fact]
|
|
public void Audit_HasSevenSubcommands_QueryExportTreeVerifyChainVerifyHeadsBackfillSourceNodeArchive()
|
|
{
|
|
var audit = BuildAudit();
|
|
var names = audit.Subcommands.Select(c => c.Name).OrderBy(n => n).ToArray();
|
|
Assert.Equal(
|
|
new[] { "archive", "backfill-source-node", "export", "query", "tree", "verify-chain", "verify-heads" },
|
|
names);
|
|
}
|
|
|
|
/// <summary>Verifies that the audit help text lists every subcommand.</summary>
|
|
[Fact]
|
|
public void Audit_HelpText_ListsAllSubcommands()
|
|
{
|
|
var root = new RootCommand();
|
|
root.Add(BuildAudit());
|
|
|
|
var output = new StringWriter();
|
|
var exit = root.Parse(new[] { "audit", "--help" })
|
|
.Invoke(new InvocationConfiguration { Output = output });
|
|
|
|
Assert.Equal(0, exit);
|
|
var text = output.ToString();
|
|
Assert.Contains("query", text);
|
|
Assert.Contains("export", text);
|
|
Assert.Contains("tree", text);
|
|
Assert.Contains("verify-chain", text);
|
|
Assert.Contains("backfill-source-node", text);
|
|
}
|
|
|
|
/// <summary>Verifies that every leaf command in the audit group has an action wired.</summary>
|
|
[Fact]
|
|
public void Audit_EveryLeafCommand_HasAnAction()
|
|
{
|
|
// `archive` is a group (list / verify, ScadaBridge#42; cleanup, ScadaBridge#109): check its leaves, not it.
|
|
var audit = BuildAudit();
|
|
var leaves = audit.Subcommands.SelectMany(c => c.Subcommands.Count == 0 ? [c] : c.Subcommands).ToList();
|
|
Assert.Equal(9, leaves.Count); // + verify-heads (ScadaBridge#107), archive cleanup (ScadaBridge#109)
|
|
Assert.All(leaves, sub =>
|
|
Assert.True(sub.Action != null, $"Leaf command '{sub.Name}' has no action."));
|
|
}
|
|
}
|