Files
ScadaBridge/tests/ZB.MOM.WW.ScadaBridge.CLI.Tests/CommandHelpersTests.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

163 lines
6.1 KiB
C#

using ZB.MOM.WW.ScadaBridge.CLI;
using ZB.MOM.WW.ScadaBridge.CLI.Commands;
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests;
[Collection("Console")]
public class CommandHelpersTests
{
/// <summary>Verifies that a successful response in JSON format returns exit code zero.</summary>
[Fact]
public void HandleResponse_Success_JsonFormat_ReturnsZero()
{
var writer = new StringWriter();
Console.SetOut(writer);
var response = new ManagementResponse(200, "{\"id\":1,\"name\":\"test\"}", null, null);
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(0, exitCode);
Assert.Contains("{\"id\":1,\"name\":\"test\"}", writer.ToString());
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that a successful response with array data in table format returns exit code zero.</summary>
[Fact]
public void HandleResponse_Success_TableFormat_ArrayData_ReturnsZero()
{
var writer = new StringWriter();
Console.SetOut(writer);
var json = "[{\"Id\":1,\"Name\":\"Alpha\"},{\"Id\":2,\"Name\":\"Beta\"}]";
var response = new ManagementResponse(200, json, null, null);
var exitCode = CommandHelpers.HandleResponse(response, "table");
Assert.Equal(0, exitCode);
var output = writer.ToString();
Assert.Contains("Id", output);
Assert.Contains("Name", output);
Assert.Contains("Alpha", output);
Assert.Contains("Beta", output);
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that a successful response with object data in table format returns exit code zero.</summary>
[Fact]
public void HandleResponse_Success_TableFormat_ObjectData_ReturnsZero()
{
var writer = new StringWriter();
Console.SetOut(writer);
var json = "{\"Id\":1,\"Name\":\"Alpha\",\"Status\":\"Active\"}";
var response = new ManagementResponse(200, json, null, null);
var exitCode = CommandHelpers.HandleResponse(response, "table");
Assert.Equal(0, exitCode);
var output = writer.ToString();
Assert.Contains("Property", output);
Assert.Contains("Value", output);
Assert.Contains("Id", output);
Assert.Contains("Alpha", output);
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that an empty array in table format reports that there are no results.</summary>
[Fact]
public void HandleResponse_Success_TableFormat_EmptyArray_ShowsNoResults()
{
var writer = new StringWriter();
Console.SetOut(writer);
var response = new ManagementResponse(200, "[]", null, null);
var exitCode = CommandHelpers.HandleResponse(response, "table");
Assert.Equal(0, exitCode);
Assert.Contains("(no results)", writer.ToString());
Console.SetOut(new StreamWriter(Console.OpenStandardOutput()) { AutoFlush = true });
}
/// <summary>Verifies that an error response returns exit code one.</summary>
[Fact]
public void HandleResponse_Error_ReturnsOne()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementResponse(400, null, "Something failed", "FAIL_CODE");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
Assert.Contains("Something failed", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that an unauthorized response returns exit code two.</summary>
[Fact]
public void HandleResponse_Unauthorized_ReturnsTwo()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementResponse(403, null, "Access denied", "UNAUTHORIZED");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(2, exitCode);
Assert.Contains("Access denied", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that an authentication failure response returns exit code one.</summary>
[Fact]
public void HandleResponse_AuthFailure_ReturnsOne()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementResponse(401, null, "Invalid credentials", "AUTH_FAILED");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
Assert.Contains("Invalid credentials", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that a connection failure response returns exit code one.</summary>
[Fact]
public void HandleResponse_ConnectionFailure_ReturnsOne()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementResponse(0, null, "Connection failed: No such host", "CONNECTION_FAILED");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
Assert.Contains("Connection failed", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
/// <summary>Verifies that a timeout response returns exit code one.</summary>
[Fact]
public void HandleResponse_Timeout_ReturnsOne()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementResponse(504, null, "Request timed out.", "TIMEOUT");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
Assert.Contains("timed out", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
}