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.
70 lines
2.7 KiB
C#
70 lines
2.7 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 and backfill-source-node subcommands.</summary>
|
|
[Fact]
|
|
public void Audit_HasFiveSubcommands_QueryExportTreeVerifyChainBackfillSourceNode()
|
|
{
|
|
var audit = BuildAudit();
|
|
var names = audit.Subcommands.Select(c => c.Name).OrderBy(n => n).ToArray();
|
|
Assert.Equal(
|
|
new[] { "backfill-source-node", "export", "query", "tree", "verify-chain" },
|
|
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()
|
|
{
|
|
var audit = BuildAudit();
|
|
Assert.All(audit.Subcommands, sub =>
|
|
Assert.True(sub.Action != null, $"Leaf command '{sub.Name}' has no action."));
|
|
}
|
|
}
|