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.
341 lines
15 KiB
C#
341 lines
15 KiB
C#
using System.Security.Claims;
|
|
using Bunit;
|
|
using Microsoft.AspNetCore.Components.Authorization;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Logging.Abstractions;
|
|
using NSubstitute;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.Auth;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Deployment;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types.Enums;
|
|
using ZB.MOM.WW.ScadaBridge.DeploymentManager;
|
|
using ZB.MOM.WW.ScadaBridge.Security;
|
|
using DeploymentsPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Deployment.Deployments;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Deployment;
|
|
|
|
/// <summary>
|
|
/// Coverage for the Deployment Status page's server-side paging, server-computed
|
|
/// status tiles and debounced filter input (residual R3).
|
|
///
|
|
/// <para>
|
|
/// Before this change the page read EVERY deployment record and EVERY instance on
|
|
/// each load, then site-scoped, sorted, counted the four tiles and sliced a 25-row
|
|
/// page in the Blazor circuit's memory. These tests pin the replacement contract:
|
|
/// the page asks the repository for ONE page plus the filtered total, asks for the
|
|
/// tile counts separately, pushes the site-scope grant into the query rather than
|
|
/// intersecting in memory, and never touches the instance repository.
|
|
/// </para>
|
|
/// </summary>
|
|
public class DeploymentsServerPagingTests : BunitContext
|
|
{
|
|
private IDeploymentManagerRepository _deployRepo = null!;
|
|
private ITemplateEngineRepository _templateRepo = null!;
|
|
private DeploymentStatusNotifier _notifier = null!;
|
|
|
|
/// <summary>Records every filter/page/pageSize triple the page queried with.</summary>
|
|
private readonly List<(DeploymentListFilter Filter, int Page, int PageSize)> _pageCalls = new();
|
|
|
|
private void RegisterServices(
|
|
DeploymentListPage? page = null,
|
|
DeploymentStatusCounts? counts = null,
|
|
string[]? siteClaims = null)
|
|
{
|
|
_deployRepo = Substitute.For<IDeploymentManagerRepository>();
|
|
_templateRepo = Substitute.For<ITemplateEngineRepository>();
|
|
_notifier = new DeploymentStatusNotifier(NullLogger<DeploymentStatusNotifier>.Instance);
|
|
|
|
var resultPage = page ?? DeploymentListPage.Empty;
|
|
|
|
_deployRepo.QueryDeploymentListPageAsync(
|
|
Arg.Any<DeploymentListFilter>(), Arg.Any<int>(), Arg.Any<int>(), Arg.Any<CancellationToken>())
|
|
.Returns(ci =>
|
|
{
|
|
_pageCalls.Add((ci.ArgAt<DeploymentListFilter>(0), ci.ArgAt<int>(1), ci.ArgAt<int>(2)));
|
|
return Task.FromResult(resultPage);
|
|
});
|
|
|
|
_deployRepo.GetDeploymentStatusCountsAsync(
|
|
Arg.Any<DeploymentListFilter>(), Arg.Any<CancellationToken>())
|
|
.Returns(counts ?? DeploymentStatusCounts.Empty);
|
|
|
|
Services.AddSingleton(_deployRepo);
|
|
Services.AddSingleton(_templateRepo);
|
|
Services.AddSingleton<IDeploymentStatusNotifier>(_notifier);
|
|
|
|
var claims = new List<Claim> { new(ClaimTypes.Name, "deployer") };
|
|
foreach (var siteId in siteClaims ?? Array.Empty<string>())
|
|
{
|
|
claims.Add(new Claim(JwtTokenService.SiteIdClaimType, siteId));
|
|
}
|
|
|
|
var identity = new ClaimsIdentity(claims, "TestCookie");
|
|
var stubAuth = new StubAuthStateProvider(
|
|
new AuthenticationState(new ClaimsPrincipal(identity)));
|
|
Services.AddSingleton<AuthenticationStateProvider>(stubAuth);
|
|
Services.AddScoped(_ => new SiteScopeService(stubAuth));
|
|
}
|
|
|
|
private sealed class StubAuthStateProvider : AuthenticationStateProvider
|
|
{
|
|
private readonly AuthenticationState _state;
|
|
/// <summary>Initializes the provider with the authentication state it will return.</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 DeploymentListRow Row(int id, string instance, DeploymentStatus status = DeploymentStatus.Success) =>
|
|
new(
|
|
Id: id,
|
|
DeploymentId: $"dep-{id:D4}",
|
|
InstanceId: id,
|
|
InstanceUniqueName: instance,
|
|
SiteId: 1,
|
|
Status: status,
|
|
RevisionHash: $"rev{id:D4}hash",
|
|
DeployedBy: "deployer",
|
|
DeployedAt: DateTimeOffset.UtcNow.AddMinutes(-id),
|
|
CompletedAt: DateTimeOffset.UtcNow,
|
|
ErrorMessage: null);
|
|
|
|
// ── Paging ────────────────────────────────────────────────────────────────
|
|
|
|
/// <summary>Verifies that the initial load requests page one from the server and never reads every instance.</summary>
|
|
[Fact]
|
|
public void InitialLoad_RequestsPageOneFromTheServer_AndNeverReadsEveryInstance()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 1));
|
|
|
|
Render<DeploymentsPage>();
|
|
|
|
var call = Assert.Single(_pageCalls);
|
|
Assert.Equal(1, call.Page);
|
|
Assert.Equal(25, call.PageSize);
|
|
|
|
// The full-instance-table read that used to build the name/site maps is gone.
|
|
_templateRepo.DidNotReceiveWithAnyArgs().GetAllInstancesAsync();
|
|
}
|
|
|
|
/// <summary>Verifies that the server-reported total count drives the pager rather than the rows on screen.</summary>
|
|
[Fact]
|
|
public void TotalCountFromServer_DrivesThePager_NotTheRowsOnScreen()
|
|
{
|
|
// One page of 25 rows out of 130 total => 6 pages. Under the old
|
|
// client-materialized model the pager could only ever see the rows it held.
|
|
var rows = Enumerable.Range(1, 25).Select(i => Row(i, $"Inst-{i}")).ToList();
|
|
RegisterServices(new DeploymentListPage(rows, TotalCount: 130));
|
|
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
Assert.Contains("130 matching deployments", cut.Find("[data-test=\"deploy-result-count\"]").TextContent);
|
|
|
|
// Windowed pager: first, last and a radius around the current page.
|
|
var pageButtons = cut.FindAll("ul.pagination li.page-item").Count;
|
|
Assert.True(pageButtons > 2, "Pager must render page buttons, not just Previous/Next.");
|
|
Assert.Contains("6", cut.Find("ul.pagination").TextContent);
|
|
}
|
|
|
|
/// <summary>Verifies that moving to the next page re-queries the server for page two.</summary>
|
|
[Fact]
|
|
public void NextPage_RequeriesTheServerForPageTwo()
|
|
{
|
|
var rows = Enumerable.Range(1, 25).Select(i => Row(i, $"Inst-{i}")).ToList();
|
|
RegisterServices(new DeploymentListPage(rows, TotalCount: 130));
|
|
|
|
var cut = Render<DeploymentsPage>();
|
|
_pageCalls.Clear();
|
|
|
|
cut.Find("[data-test=\"deploy-page-next\"]").Click();
|
|
|
|
var call = Assert.Single(_pageCalls);
|
|
Assert.Equal(2, call.Page);
|
|
}
|
|
|
|
/// <summary>Verifies that a single-page result renders no pager.</summary>
|
|
[Fact]
|
|
public void SinglePageResult_RendersNoPager()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 1));
|
|
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
Assert.Empty(cut.FindAll("ul.pagination"));
|
|
}
|
|
|
|
// ── Status tiles ──────────────────────────────────────────────────────────
|
|
|
|
/// <summary>Verifies that the status tiles show server-computed counts rather than counts of the visible page.</summary>
|
|
[Fact]
|
|
public void Tiles_RenderServerComputedCounts_NotCountsOfTheVisiblePage()
|
|
{
|
|
// The page holds ONE row, but the server reports fleet-wide counts. Under
|
|
// the old model the tiles were Count() over the in-memory list, so paging
|
|
// would have silently reduced them to per-page counts.
|
|
RegisterServices(
|
|
new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 400),
|
|
new DeploymentStatusCounts(Pending: 7, InProgress: 3, Success: 380, Failed: 10));
|
|
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
Assert.Contains("7", cut.Find("[data-test=\"deploy-tile-pending\"]").TextContent);
|
|
Assert.Contains("3", cut.Find("[data-test=\"deploy-tile-inprogress\"]").TextContent);
|
|
Assert.Contains("380", cut.Find("[data-test=\"deploy-tile-success\"]").TextContent);
|
|
Assert.Contains("10", cut.Find("[data-test=\"deploy-tile-failed\"]").TextContent);
|
|
Assert.Contains("400", cut.Find("[data-test=\"deploy-tile-all\"]").TextContent);
|
|
}
|
|
|
|
/// <summary>Verifies that clicking a status tile applies the filter on the server and resets to page one.</summary>
|
|
[Fact]
|
|
public void ClickingAStatusTile_AppliesTheFilterServerSide_AndResetsToPageOne()
|
|
{
|
|
var rows = Enumerable.Range(1, 25).Select(i => Row(i, $"Inst-{i}")).ToList();
|
|
RegisterServices(new DeploymentListPage(rows, TotalCount: 130));
|
|
|
|
var cut = Render<DeploymentsPage>();
|
|
cut.Find("[data-test=\"deploy-page-next\"]").Click();
|
|
_pageCalls.Clear();
|
|
|
|
cut.Find("[data-test=\"deploy-tile-failed\"]").Click();
|
|
|
|
var call = Assert.Single(_pageCalls);
|
|
Assert.Equal(DeploymentStatus.Failed, call.Filter.Status);
|
|
Assert.Equal(1, call.Page);
|
|
Assert.Equal("true", cut.Find("[data-test=\"deploy-tile-failed\"]").GetAttribute("aria-pressed"));
|
|
}
|
|
|
|
/// <summary>Verifies that clicking the active status tile again clears the status filter.</summary>
|
|
[Fact]
|
|
public void ClickingTheActiveTileAgain_ClearsTheStatusFilter()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 1));
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
cut.Find("[data-test=\"deploy-tile-pending\"]").Click();
|
|
_pageCalls.Clear();
|
|
cut.Find("[data-test=\"deploy-tile-pending\"]").Click();
|
|
|
|
var call = Assert.Single(_pageCalls);
|
|
Assert.Null(call.Filter.Status);
|
|
Assert.Equal("true", cut.Find("[data-test=\"deploy-tile-all\"]").GetAttribute("aria-pressed"));
|
|
}
|
|
|
|
// ── Site scoping ──────────────────────────────────────────────────────────
|
|
|
|
/// <summary>Verifies that a system-wide user queries with no site scope.</summary>
|
|
[Fact]
|
|
public void SystemWideUser_QueriesWithNoSiteScope()
|
|
{
|
|
RegisterServices();
|
|
|
|
Render<DeploymentsPage>();
|
|
|
|
Assert.Null(Assert.Single(_pageCalls).Filter.SiteIdScope);
|
|
}
|
|
|
|
/// <summary>Verifies that a site-scoped user's permitted site ids are pushed into the query.</summary>
|
|
[Fact]
|
|
public void SiteScopedUser_PushesThePermittedSiteIdsIntoTheQuery()
|
|
{
|
|
RegisterServices(siteClaims: new[] { "3", "7" });
|
|
|
|
Render<DeploymentsPage>();
|
|
|
|
var scope = Assert.Single(_pageCalls).Filter.SiteIdScope;
|
|
Assert.NotNull(scope);
|
|
Assert.Equal(new[] { 3, 7 }, scope!.OrderBy(x => x));
|
|
}
|
|
|
|
// ── Filter debounce ───────────────────────────────────────────────────────
|
|
|
|
/// <summary>Verifies that search input is debounced so a burst of keystrokes issues a single query.</summary>
|
|
[Fact]
|
|
public void SearchInput_IsDebounced_SoABurstOfKeystrokesIssuesOneQuery()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 1));
|
|
var cut = Render<DeploymentsPage>();
|
|
_pageCalls.Clear();
|
|
|
|
// Type "Reactor" one character at a time, well inside the 500ms window.
|
|
const string term = "Reactor";
|
|
for (var i = 1; i <= term.Length; i++)
|
|
{
|
|
cut.Find("[data-test=\"deploy-search\"]").Input(term[..i]);
|
|
}
|
|
|
|
// No query yet — the trailing debounce has not elapsed.
|
|
Assert.Empty(_pageCalls);
|
|
|
|
cut.WaitForAssertion(() => Assert.NotEmpty(_pageCalls), TimeSpan.FromSeconds(3));
|
|
Thread.Sleep(300);
|
|
|
|
var call = Assert.Single(_pageCalls);
|
|
Assert.Equal(term, call.Filter.Search);
|
|
Assert.Equal(1, call.Page);
|
|
}
|
|
|
|
/// <summary>Verifies that clearing the filters resets the search text and status and re-queries the server.</summary>
|
|
[Fact]
|
|
public void ClearFilters_ResetsSearchAndStatus_AndRequeries()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 1));
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
cut.Find("[data-test=\"deploy-tile-failed\"]").Click();
|
|
_pageCalls.Clear();
|
|
|
|
cut.Find("[data-test=\"deploy-clear-filters\"]").Click();
|
|
|
|
var call = Assert.Single(_pageCalls);
|
|
Assert.Null(call.Filter.Status);
|
|
Assert.Null(call.Filter.NormalizedSearch);
|
|
Assert.Equal(1, call.Page);
|
|
}
|
|
|
|
/// <summary>Verifies that the clear-filters button is enabled as soon as the operator types, not only once the debounce fires.</summary>
|
|
[Fact]
|
|
public void ClearFilters_IsEnabledAsSoonAsTheOperatorTypes_NotOnlyOnceTheDebounceFires()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 1));
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
Assert.True(cut.Find("[data-test=\"deploy-clear-filters\"]").HasAttribute("disabled"));
|
|
|
|
cut.Find("[data-test=\"deploy-search\"]").Input("Rea");
|
|
|
|
// Still inside the 500ms window — the escape hatch must not be dead.
|
|
Assert.False(cut.Find("[data-test=\"deploy-clear-filters\"]").HasAttribute("disabled"));
|
|
}
|
|
|
|
/// <summary>Verifies that disposing the page with an armed filter timer does not issue a query.</summary>
|
|
[Fact]
|
|
public void DisposeWithAnArmedFilterTimer_DoesNotQuery()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(1, "Inst-1") }, TotalCount: 1));
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
cut.Find("[data-test=\"deploy-search\"]").Input("abc");
|
|
cut.Instance.Dispose();
|
|
_pageCalls.Clear();
|
|
|
|
Thread.Sleep(900);
|
|
|
|
Assert.Empty(_pageCalls);
|
|
}
|
|
|
|
// ── Rendering ─────────────────────────────────────────────────────────────
|
|
|
|
/// <summary>Verifies that the instance name comes from the joined server row rather than a client-side lookup table.</summary>
|
|
[Fact]
|
|
public void InstanceName_ComesFromTheJoinedRow_NotAClientSideLookupTable()
|
|
{
|
|
RegisterServices(new DeploymentListPage(new[] { Row(42, "Line3.Filler") }, TotalCount: 1));
|
|
|
|
var cut = Render<DeploymentsPage>();
|
|
|
|
Assert.Contains("Line3.Filler", cut.Markup);
|
|
}
|
|
}
|