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.
293 lines
12 KiB
C#
293 lines
12 KiB
C#
using System.Security.Claims;
|
|
using Bunit;
|
|
using Microsoft.AspNetCore.Components.Authorization;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Logging.Abstractions;
|
|
using Microsoft.Extensions.Options;
|
|
using NSubstitute;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.Components.Shared;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.Services;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
|
using ZB.MOM.WW.ScadaBridge.Communication;
|
|
using ZB.MOM.WW.ScadaBridge.DeploymentManager;
|
|
using ZB.MOM.WW.ScadaBridge.DeploymentManager.PendingUpdates;
|
|
using ZB.MOM.WW.Secrets.Abstractions;
|
|
using SitesPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Admin.Sites;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Admin;
|
|
|
|
/// <summary>
|
|
/// Regression tests for the Sites page N+1 query fix. The Sites page loaded all sites and then
|
|
/// issued <c>GetDataConnectionsBySiteIdAsync</c> once per site (N+1 database
|
|
/// round-trips on every load and post-delete refresh). The fix fetches all
|
|
/// data connections in a single <c>GetAllDataConnectionsAsync</c> call and
|
|
/// groups them client-side.
|
|
/// </summary>
|
|
public class SitesPageTests : BunitContext
|
|
{
|
|
private readonly ISiteRepository _siteRepo = Substitute.For<ISiteRepository>();
|
|
private readonly IPendingUpdatesCache _pendingUpdates = Substitute.For<IPendingUpdatesCache>();
|
|
|
|
private void RegisterServices()
|
|
{
|
|
Services.AddSingleton(_siteRepo);
|
|
|
|
// Default: an empty snapshot, so the page's badges resolve without a stub.
|
|
// Individual tests re-stub GetAsync before rendering.
|
|
_pendingUpdates.GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>())
|
|
.Returns(_ => Task.FromResult(Snapshot()));
|
|
Services.AddSingleton(_pendingUpdates);
|
|
|
|
var comms = new CommunicationService(
|
|
Options.Create(new CommunicationOptions()),
|
|
NullLogger<CommunicationService>.Instance);
|
|
Services.AddSingleton(comms);
|
|
|
|
var artifactSvc = new ArtifactDeploymentService(
|
|
_siteRepo,
|
|
Substitute.For<IDeploymentManagerRepository>(),
|
|
Substitute.For<ITemplateEngineRepository>(),
|
|
Substitute.For<IExternalSystemRepository>(),
|
|
Substitute.For<INotificationRepository>(),
|
|
comms,
|
|
Substitute.For<IAuditService>(),
|
|
Options.Create(new DeploymentManagerOptions()),
|
|
NullLogger<ArtifactDeploymentService>.Instance,
|
|
new ArtifactRevisionHashService(),
|
|
// These tests don't exercise secret references, so a store that never has
|
|
// anything is never called — CollectAsync only queries a scanned secret: reference.
|
|
new SiteSecretsCollector(Substitute.For<ISecretStore>()));
|
|
Services.AddSingleton(artifactSvc);
|
|
|
|
Services.AddSingleton<IDialogService>(Substitute.For<IDialogService>());
|
|
|
|
var identity = new ClaimsIdentity(
|
|
new[] { new Claim(ClaimTypes.Name, "admin") }, "TestCookie");
|
|
var authState = new AuthenticationState(new ClaimsPrincipal(identity));
|
|
Services.AddSingleton<AuthenticationStateProvider>(
|
|
new StubAuthStateProvider(authState));
|
|
}
|
|
|
|
private sealed class StubAuthStateProvider : AuthenticationStateProvider
|
|
{
|
|
private readonly AuthenticationState _state;
|
|
/// <summary>Initializes a new instance of the <see cref="StubAuthStateProvider"/> class.</summary>
|
|
/// <param name="state">The authentication state returned to callers.</param>
|
|
public StubAuthStateProvider(AuthenticationState state) => _state = state;
|
|
/// <inheritdoc />
|
|
public override Task<AuthenticationState> GetAuthenticationStateAsync()
|
|
=> Task.FromResult(_state);
|
|
}
|
|
|
|
private static List<Site> Sites(params int[] ids)
|
|
=> ids.Select(id => new Site($"Site{id}", $"SITE-{id}") { Id = id }).ToList();
|
|
|
|
private static DataConnection Conn(int siteId, string name)
|
|
=> new(name, "OpcUa", siteId);
|
|
|
|
private static PendingUpdatesSnapshot Snapshot(params SitePendingUpdates[] sites)
|
|
=> new(new DateTimeOffset(2026, 9, 14, 10, 30, 0, TimeSpan.Zero), sites);
|
|
|
|
private static SitePendingUpdates Pending(
|
|
int siteId,
|
|
ArtifactDeploymentState state,
|
|
int deployed = 0,
|
|
int stale = 0,
|
|
int unknown = 0)
|
|
=> new(
|
|
siteId,
|
|
$"SITE-{siteId}",
|
|
$"Site{siteId}",
|
|
state,
|
|
state == ArtifactDeploymentState.NeverDeployed
|
|
? null
|
|
: new DateTimeOffset(2026, 9, 13, 8, 0, 0, TimeSpan.Zero),
|
|
deployed,
|
|
stale,
|
|
unknown);
|
|
|
|
/// <summary>Verifies that loading data fetches all connections in one query rather than one query per site.</summary>
|
|
[Fact]
|
|
public void LoadData_FetchesAllConnectionsInOneQuery_NoPerSiteQueries()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1, 2, 3));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>
|
|
{
|
|
Conn(1, "c1"), Conn(2, "c2"), Conn(3, "c3"),
|
|
});
|
|
|
|
Render<SitesPage>();
|
|
|
|
// Regression: exactly one bulk query, and zero per-site queries.
|
|
_siteRepo.Received(1).GetAllDataConnectionsAsync();
|
|
_siteRepo.DidNotReceive().GetDataConnectionsBySiteIdAsync(Arg.Any<int>());
|
|
}
|
|
|
|
/// <summary>Verifies that loading data groups connections by site and renders them under their site.</summary>
|
|
[Fact]
|
|
public void LoadData_GroupsConnectionsBySite_AndRendersThem()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1, 2));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>
|
|
{
|
|
Conn(1, "alpha-conn"), Conn(2, "beta-conn"),
|
|
});
|
|
|
|
var cut = Render<SitesPage>();
|
|
|
|
Assert.Contains("alpha-conn", cut.Markup);
|
|
Assert.Contains("beta-conn", cut.Markup);
|
|
}
|
|
|
|
/// <summary>Verifies that the artifact badge shows Current, Out of date or Never deployed according to the site's artifact state.</summary>
|
|
[Fact]
|
|
public void ArtifactBadge_ShowsCurrent_OutOfDate_NeverDeployed()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1, 2, 3));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>());
|
|
_pendingUpdates.GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>())
|
|
.Returns(_ => Task.FromResult(Snapshot(
|
|
Pending(1, ArtifactDeploymentState.Current),
|
|
Pending(2, ArtifactDeploymentState.OutOfDate),
|
|
Pending(3, ArtifactDeploymentState.NeverDeployed))));
|
|
|
|
var cut = Render<SitesPage>();
|
|
|
|
cut.WaitForAssertion(() =>
|
|
{
|
|
Assert.Contains("aria-label=\"Artifacts: current\"", cut.Markup);
|
|
Assert.Contains("Artifacts current", cut.Markup);
|
|
Assert.Contains("aria-label=\"Artifacts: out of date\"", cut.Markup);
|
|
Assert.Contains("Artifacts out of date", cut.Markup);
|
|
Assert.Contains("aria-label=\"Artifacts: never deployed\"", cut.Markup);
|
|
Assert.Contains("Artifacts never deployed", cut.Markup);
|
|
});
|
|
}
|
|
|
|
/// <summary>Verifies that the instance line shows the stale count out of the deployed count.</summary>
|
|
[Fact]
|
|
public void InstanceLine_ShowsStaleOfDeployed()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>());
|
|
_pendingUpdates.GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>())
|
|
.Returns(_ => Task.FromResult(Snapshot(
|
|
Pending(1, ArtifactDeploymentState.Current, deployed: 5, stale: 2, unknown: 1))));
|
|
|
|
var cut = Render<SitesPage>();
|
|
|
|
cut.WaitForAssertion(() =>
|
|
{
|
|
Assert.Contains("2 of 5 instances out of date", cut.Markup);
|
|
Assert.Contains("1 could not be evaluated", cut.Markup);
|
|
Assert.Contains("/deployment/topology", cut.Markup);
|
|
});
|
|
}
|
|
|
|
/// <summary>Verifies that the instance line uses the correct singular wording when exactly one instance is affected.</summary>
|
|
[Fact]
|
|
public void InstanceLine_PluralisesTheSingleInstanceCase()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1, 2));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>());
|
|
_pendingUpdates.GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>())
|
|
.Returns(_ => Task.FromResult(Snapshot(
|
|
Pending(1, ArtifactDeploymentState.Current, deployed: 1, stale: 1),
|
|
Pending(2, ArtifactDeploymentState.Current, deployed: 1))));
|
|
|
|
var cut = Render<SitesPage>();
|
|
|
|
cut.WaitForAssertion(() =>
|
|
{
|
|
Assert.Contains("1 of 1 instance out of date", cut.Markup);
|
|
Assert.Contains("All 1 instance current", cut.Markup);
|
|
Assert.DoesNotContain("1 instances", cut.Markup);
|
|
});
|
|
}
|
|
|
|
/// <summary>Verifies that Re-check forces a refresh of the pending-updates snapshot.</summary>
|
|
[Fact]
|
|
public void Recheck_ForcesRefresh()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>());
|
|
|
|
var cut = Render<SitesPage>();
|
|
cut.Find("button[aria-label=\"Re-check pending updates\"]").Click();
|
|
|
|
cut.WaitForAssertion(() =>
|
|
_pendingUpdates.Received().GetAsync(true, Arg.Any<CancellationToken>()));
|
|
}
|
|
|
|
/// <summary>Verifies that a failure loading sites skips the fleet-wide evaluation.</summary>
|
|
[Fact]
|
|
public void SiteLoadFailure_SkipsTheFleetEvaluation()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync()
|
|
.Returns<Task<IReadOnlyList<Site>>>(_ => throw new InvalidOperationException("db down"));
|
|
|
|
var cut = Render<SitesPage>();
|
|
|
|
cut.WaitForAssertion(() => Assert.Contains("Failed to load sites", cut.Markup));
|
|
// No cards to badge, so the whole-fleet flatten must not run at all.
|
|
_pendingUpdates.DidNotReceive().GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>());
|
|
}
|
|
|
|
/// <summary>Verifies that a failed re-check clears the stale as-of caption.</summary>
|
|
[Fact]
|
|
public void FailedRecheck_ClearsTheStaleAsOfCaption()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>());
|
|
_pendingUpdates.GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>())
|
|
.Returns(_ => Task.FromResult(Snapshot(Pending(1, ArtifactDeploymentState.Current))));
|
|
|
|
var cut = Render<SitesPage>();
|
|
cut.WaitForAssertion(() => Assert.Contains("Updates as of", cut.Markup));
|
|
|
|
// The re-check now faults: the error wins, so the caption from the earlier good
|
|
// evaluation must not stand next to "unavailable" badges.
|
|
_pendingUpdates.GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>())
|
|
.Returns<Task<PendingUpdatesSnapshot>>(_ => throw new InvalidOperationException("evaluator down"));
|
|
cut.Find("button[aria-label=\"Re-check pending updates\"]").Click();
|
|
|
|
cut.WaitForAssertion(() =>
|
|
{
|
|
Assert.DoesNotContain("Updates as of", cut.Markup);
|
|
Assert.Contains("Artifacts: unavailable", cut.Markup);
|
|
Assert.Contains("Site1", cut.Markup);
|
|
});
|
|
}
|
|
|
|
/// <summary>Verifies that a cache fault shows an unavailable state while the sites still render.</summary>
|
|
[Fact]
|
|
public void CacheFault_ShowsUnavailable_AndSitesStillRender()
|
|
{
|
|
RegisterServices();
|
|
_siteRepo.GetAllSitesAsync().Returns(Sites(1, 2));
|
|
_siteRepo.GetAllDataConnectionsAsync().Returns(new List<DataConnection>());
|
|
_pendingUpdates.GetAsync(Arg.Any<bool>(), Arg.Any<CancellationToken>())
|
|
.Returns<Task<PendingUpdatesSnapshot>>(_ => throw new InvalidOperationException("evaluator down"));
|
|
|
|
var cut = Render<SitesPage>();
|
|
|
|
cut.WaitForAssertion(() =>
|
|
{
|
|
// The snapshot failing must never take the site list down with it.
|
|
Assert.Contains("Site1", cut.Markup);
|
|
Assert.Contains("Site2", cut.Markup);
|
|
Assert.Contains("Artifacts: unavailable", cut.Markup);
|
|
});
|
|
}
|
|
}
|