Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.CLI.Tests/Commands/AuditCommandTestHarness.cs
T
Joseph Doherty 513fa1aa16 docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)
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.
2026-10-07 15:05:49 -04:00

68 lines
2.5 KiB
C#

using System.CommandLine;
using ZB.MOM.WW.ScadaBridge.CLI.Commands;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
/// <summary>
/// Shared helpers for invoking the <c>audit</c> command tree in tests and capturing
/// stdout/stderr/exit code.
/// </summary>
internal static class AuditCommandTestHarness
{
/// <summary>Builds a root command with the global options and the audit command tree attached.</summary>
/// <returns>The configured root command.</returns>
public static RootCommand BuildRoot()
{
var url = new Option<string>("--url") { Recursive = true };
var username = new Option<string>("--username") { Recursive = true };
var password = new Option<string>("--password") { Recursive = true };
var format = CliOptions.CreateFormatOption();
var root = new RootCommand();
root.Add(url);
root.Add(username);
root.Add(password);
root.Add(format);
root.Add(AuditCommands.Build(url, format, username, password));
return root;
}
/// <summary>
/// Parses and invokes the command tree, capturing output from both channels the CLI
/// uses: System.CommandLine's parser diagnostics flow through the
/// <see cref="InvocationConfiguration"/> writers, while command actions write through
/// <see cref="Console"/> (consistent with the rest of the CLI). Both are merged into
/// the returned <c>Out</c>/<c>Err</c> strings. Callers must be in the <c>Console</c>
/// xUnit collection so the global <see cref="Console"/> redirect is not racy.
/// </summary>
/// <param name="root">The root command to parse against.</param>
/// <param name="args">The command-line arguments to parse and invoke.</param>
/// <returns>The exit code and the captured standard output and error text.</returns>
public static (int Exit, string Out, string Err) Invoke(RootCommand root, params string[] args)
{
var output = new StringWriter();
var error = new StringWriter();
var originalOut = Console.Out;
var originalErr = Console.Error;
Console.SetOut(output);
Console.SetError(error);
int exit;
try
{
exit = root.Parse(args).Invoke(new InvocationConfiguration
{
Output = output,
Error = error,
});
}
finally
{
Console.SetOut(originalOut);
Console.SetError(originalErr);
}
return (exit, output.ToString(), error.ToString());
}
}