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.
171 lines
8.4 KiB
C#
171 lines
8.4 KiB
C#
using System.Security.Claims;
|
|
using Bunit;
|
|
using Microsoft.AspNetCore.Components;
|
|
using Microsoft.AspNetCore.Components.Authorization;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using NSubstitute;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.Auth;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.Services;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Instances;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Templates;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
|
using ZB.MOM.WW.ScadaBridge.DeploymentManager;
|
|
using ZB.MOM.WW.ScadaBridge.Security;
|
|
using ZB.MOM.WW.ScadaBridge.TemplateEngine.Services;
|
|
using InstanceConfigurePage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Deployment.InstanceConfigure;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Deployment;
|
|
|
|
/// <summary>
|
|
/// Drill-in test for the Instance Configure page. The
|
|
/// chip routes operators into the central Audit Log pre-filtered by
|
|
/// <c>?instance={Instance.UniqueName}</c>. Instance is UI-only on the filter
|
|
/// bar (the repository filter contract has no instance column), so the page
|
|
/// uses the UI-text seam — the Audit Log's filter bar pre-populates its
|
|
/// Instance free-text input from this query string.
|
|
/// </summary>
|
|
public class InstanceConfigureAuditDrillinTests : BunitContext
|
|
{
|
|
private readonly ITemplateEngineRepository _templateRepo =
|
|
Substitute.For<ITemplateEngineRepository>();
|
|
private readonly ISiteRepository _siteRepo = Substitute.For<ISiteRepository>();
|
|
|
|
/// <summary>Initializes the test context and registers the services the Instance Configure page depends on.</summary>
|
|
public InstanceConfigureAuditDrillinTests()
|
|
{
|
|
// Loose JS interop because shared components on the page render
|
|
// localStorage / clipboard touches that we don't care about here.
|
|
JSInterop.Mode = JSRuntimeMode.Loose;
|
|
|
|
Services.AddSingleton(_templateRepo);
|
|
Services.AddSingleton(_siteRepo);
|
|
|
|
Services.AddSingleton(new InstanceService(_templateRepo, Substitute.For<IAuditService>()));
|
|
Services.AddSingleton(Substitute.For<IFlatteningPipeline>());
|
|
|
|
// The page renders <NodeBrowserDialog/> and <TestBindingsDialog/> at
|
|
// the bottom; their @inject directives need a registered service even
|
|
// though this test doesn't open either dialog.
|
|
Services.AddSingleton(Substitute.For<IBrowseService>());
|
|
Services.AddSingleton(Substitute.For<IBindingTester>());
|
|
|
|
// Auth: a system-wide Deployment user so SiteScope grants everything.
|
|
var claims = new[]
|
|
{
|
|
new Claim(JwtTokenService.UsernameClaimType, "deployer"),
|
|
new Claim(JwtTokenService.RoleClaimType, "Deployer"),
|
|
};
|
|
var user = new ClaimsPrincipal(new ClaimsIdentity(claims, "TestAuth"));
|
|
var authProvider = new TestAuthStateProvider(user);
|
|
Services.AddSingleton<AuthenticationStateProvider>(authProvider);
|
|
Services.AddSingleton(new SiteScopeService(authProvider));
|
|
Services.AddAuthorizationCore();
|
|
Services.AddTestConfigurationMutations();
|
|
AuthorizationPolicies.AddScadaBridgeAuthorization(Services);
|
|
}
|
|
|
|
/// <summary>Verifies that the page renders a recent audit activity link carrying the instance unique name.</summary>
|
|
[Fact]
|
|
public void Page_HasRecentAuditActivityLink_WithInstanceUniqueName()
|
|
{
|
|
var instance = new Instance("Pump-Station-007")
|
|
{
|
|
Id = 42,
|
|
TemplateId = 1,
|
|
SiteId = 1,
|
|
State = ZB.MOM.WW.ScadaBridge.Commons.Types.Enums.InstanceState.NotDeployed,
|
|
};
|
|
|
|
_templateRepo.GetInstanceByIdAsync(42, Arg.Any<CancellationToken>()).Returns(instance);
|
|
_templateRepo.GetTemplateByIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new Template("Pump") { Id = 1 });
|
|
_siteRepo.GetAllSitesAsync(Arg.Any<CancellationToken>())
|
|
.Returns(new List<Site> { new("Plant A", "plant-a") { Id = 1 } });
|
|
_templateRepo.GetAreasBySiteIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<Area>());
|
|
_templateRepo.GetAttributesByTemplateIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<TemplateAttribute>());
|
|
_siteRepo.GetDataConnectionsBySiteIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<DataConnection>());
|
|
_templateRepo.GetBindingsByInstanceIdAsync(42, Arg.Any<CancellationToken>())
|
|
.Returns(new List<InstanceConnectionBinding>());
|
|
_templateRepo.GetOverridesByInstanceIdAsync(42, Arg.Any<CancellationToken>())
|
|
.Returns(new List<InstanceAttributeOverride>());
|
|
_templateRepo.GetAlarmsByTemplateIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<TemplateAlarm>());
|
|
_templateRepo.GetAlarmOverridesByInstanceIdAsync(42, Arg.Any<CancellationToken>())
|
|
.Returns(new List<InstanceAlarmOverride>());
|
|
|
|
var cut = Render<InstanceConfigurePage>(p => p.Add(c => c.Id, 42));
|
|
|
|
cut.WaitForAssertion(() =>
|
|
{
|
|
var link = cut.Find("a[data-test=\"audit-link\"]");
|
|
Assert.Equal("/audit/log?instance=Pump-Station-007", link.GetAttribute("href"));
|
|
Assert.Contains("Recent audit activity", link.TextContent);
|
|
});
|
|
}
|
|
|
|
/// <summary>
|
|
/// Regression: the Test Bindings button must be enabled for an attribute
|
|
/// bound to an MxGateway connection. The site-side ReadTagValuesCommand
|
|
/// path is protocol-agnostic (routes through IDataConnection.ReadBatchAsync,
|
|
/// which MxGateway implements), so the UI must not gate the button on
|
|
/// protocol == "OpcUa". Previously BuildTestableRows filtered to OPC UA
|
|
/// only, leaving the button greyed for MxGateway bindings.
|
|
/// </summary>
|
|
/// <param name="protocol">The data connection protocol of the bound attribute.</param>
|
|
[Theory]
|
|
[InlineData("MxGateway")]
|
|
[InlineData("OpcUa")]
|
|
public void TestBindingsButton_Enabled_ForReadableProtocol(string protocol)
|
|
{
|
|
var instance = new Instance("Pump-42")
|
|
{
|
|
Id = 42,
|
|
TemplateId = 1,
|
|
SiteId = 1,
|
|
State = ZB.MOM.WW.ScadaBridge.Commons.Types.Enums.InstanceState.NotDeployed,
|
|
};
|
|
|
|
_templateRepo.GetInstanceByIdAsync(42, Arg.Any<CancellationToken>()).Returns(instance);
|
|
_templateRepo.GetTemplateByIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new Template("Pump") { Id = 1 });
|
|
_siteRepo.GetAllSitesAsync(Arg.Any<CancellationToken>())
|
|
.Returns(new List<Site> { new("Plant A", "plant-a") { Id = 1 } });
|
|
_templateRepo.GetAreasBySiteIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<Area>());
|
|
// One data-sourced attribute (non-empty DataSourceReference => testable row).
|
|
_templateRepo.GetAttributesByTemplateIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<TemplateAttribute>
|
|
{
|
|
new("Speed") { Id = 1, DataSourceReference = "TestMachine_001.TestHistoryValue" },
|
|
});
|
|
// A connection on the attribute's chosen protocol.
|
|
_siteRepo.GetDataConnectionsBySiteIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<DataConnection> { new("Shared", protocol, 1) { Id = 7 } });
|
|
_templateRepo.GetBindingsByInstanceIdAsync(42, Arg.Any<CancellationToken>())
|
|
.Returns(new List<InstanceConnectionBinding>
|
|
{
|
|
new("Speed") { Id = 1, InstanceId = 42, DataConnectionId = 7 },
|
|
});
|
|
_templateRepo.GetOverridesByInstanceIdAsync(42, Arg.Any<CancellationToken>())
|
|
.Returns(new List<InstanceAttributeOverride>());
|
|
_templateRepo.GetAlarmsByTemplateIdAsync(1, Arg.Any<CancellationToken>())
|
|
.Returns(new List<TemplateAlarm>());
|
|
_templateRepo.GetAlarmOverridesByInstanceIdAsync(42, Arg.Any<CancellationToken>())
|
|
.Returns(new List<InstanceAlarmOverride>());
|
|
|
|
var cut = Render<InstanceConfigurePage>(p => p.Add(c => c.Id, 42));
|
|
|
|
cut.WaitForAssertion(() =>
|
|
{
|
|
var testButton = cut.FindAll("button").Single(b => b.TextContent.Trim().StartsWith("Test Bindings", StringComparison.Ordinal));
|
|
Assert.False(testButton.HasAttribute("disabled"),
|
|
$"Test Bindings should be enabled for a {protocol} binding.");
|
|
});
|
|
}
|
|
}
|