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.
57 lines
2.0 KiB
C#
57 lines
2.0 KiB
C#
using ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Cluster;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CentralUI.PlaywrightTests.Admin;
|
|
|
|
/// <summary>
|
|
/// Provisions a single inbound API method so the API-key form renders at least one method checkbox
|
|
/// (<c>id="method-access-{MethodId}"</c>). Created API keys are deleted per-test; this fixture owns
|
|
/// only the method.
|
|
/// </summary>
|
|
public sealed class ApiSurfaceFixture : IAsyncLifetime
|
|
{
|
|
/// <summary>The id of the provisioned inbound API method.</summary>
|
|
public int MethodId { get; private set; }
|
|
/// <summary>The unique name of the provisioned inbound API method.</summary>
|
|
public string MethodName { get; private set; } = string.Empty;
|
|
/// <summary>Whether the cluster was reachable and the method was provisioned.</summary>
|
|
public bool Available { get; private set; }
|
|
|
|
/// <summary>Prepares the test class before the tests run.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
public async Task InitializeAsync()
|
|
{
|
|
Available = await ClusterAvailability.IsAvailableAsync();
|
|
if (!Available)
|
|
{
|
|
return;
|
|
}
|
|
|
|
try
|
|
{
|
|
MethodName = CliRunner.UniqueName("method");
|
|
MethodId = await CliRunner.CreateApiMethodAsync(MethodName);
|
|
}
|
|
catch
|
|
{
|
|
// Partial-init guard: MethodId is non-zero only if CreateApiMethodAsync succeeded,
|
|
// so skip the delete when nothing was created (avoids a phantom delete --id 0).
|
|
if (MethodId != 0)
|
|
{
|
|
await CliRunner.DeleteApiMethodAsync(MethodId);
|
|
}
|
|
Available = false;
|
|
throw;
|
|
}
|
|
}
|
|
|
|
/// <summary>Releases the resources held by this test class asynchronously.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
public async Task DisposeAsync()
|
|
{
|
|
if (Available)
|
|
{
|
|
await CliRunner.DeleteApiMethodAsync(MethodId);
|
|
}
|
|
}
|
|
}
|