Joseph Doherty
39db75083d
A driver builds its RawPath -> definition table at init and tolerates a
per-tag miss: an unmappable TagConfig, an unparseable address, a
capability-matrix rejection. That tolerance is right -- one bad tag must not
take down the other few thousand. What was missing is any statement of the
fact afterwards. A skip is not an error and happens before any read, so the
driver stays Healthy, errors/5 min stays 0, Last error stays empty, and Last
read advances live off the tags that did map. On the wonder Makino in #540
that reading held while focas-z-34184 ignored 20 of its 22 tags.
New optional capability ISkippedTagReporter, backed by a shared
SkippedTagLedger so the reset/commit/cap rules are one implementation rather
than one per driver. The report -- authored count, exact skipped count, and a
capped sample of RawPath + reason -- rides DriverHealthChanged to a new Tags
column on /hosts, over the Phase 5 telemetry stream. No table: a driver-only
node has no ConfigDb to write to, the lesson from #521.
The issue named eight drivers. It is twelve -- every driver in
DriverTypeNames.All has an authored-tag skip path. Calculation (no scriptId),
MTConnect (no readable DataItem id), Galaxy (no attributeRef) and OpcUaClient
(no nodeId) were unlisted, and OpcUaClient's was the quietest of the twelve:
NamespaceMap drops such an entry with a bare `continue` and not even a log
line. SkippedTagReporterFleetTests pins the invariant reflectively over every
IDriver in src/Drivers/, so a thirteenth cannot re-introduce the silence.
Sql drops a tag at TWO points and its report is the union of both: a blob
that does not map, AND an identifier the 8.1 catalog gate rejects against the
live catalog. The second is what schema drift produces -- a renamed column, a
dropped view -- months after a deployment sealed green, and reporting only
the first would have that driver claim "0 skipped" while polling half its
tags, which is worse than reporting nothing because the column would then be
actively reassuring.
Deliberately additive to driver state, never a change of it. Latching
non-Healthy for a config problem would satisfy both halves of the #527
comms-loss conjunction -- 90 s without a successful read AND non-Healthy --
and a driver whose tags were ALL skipped has no successful reads by
construction, so it would reconnect-loop forever against a healthy device.
Three details that are load-bearing rather than incidental:
- The skip digest is part of the publish fingerprint. A skipped tag leaves
every other fingerprint component identical to a clean driver's, so without
it PublishHealthSnapshot's dedup swallows exactly the publish carrying the
signal -- the trap that already bit the rediscovery and host-status
channels. The digest covers the sample, not just the counts: a redeploy
that fixes one tag and breaks another leaves both counts unchanged.
- The count is exact; only the sample is capped, and the tooltip says so when
it is showing fewer than it counted. A truncated list that looked complete
would have an operator fix twenty tags and believe the job done.
- The ledger stages and commits, so an init that throws part-way leaves the
previous report standing. A partial snapshot would read as "we now skip
fewer tags", the opposite of the truth.
The proto field needs no companion presence flag, unlike host_statuses: a
singular message field carries real presence in proto3, and a has_ flag would
collide with protoc's generated HasSkippedTags.
Verified red-first three ways: dropping SkippedTagDigest from the fingerprint
fails the two dedup tests, removing the seam from one driver fails the fleet
guard, and dropping the catalog-gate leg fails the Sql union test. Full
solution builds with zero new warnings against 4e22f024.
77 lines
3.0 KiB
C#
77 lines
3.0 KiB
C#
using System.Reflection;
|
|
using Shouldly;
|
|
using Xunit;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Core.Abstractions.Tests;
|
|
|
|
/// <summary>
|
|
/// Asserts that <c>Core.Abstractions</c> stays a true contract project — it must not depend on
|
|
/// any implementation type, any other OtOpcUa project, or anything beyond BCL + System types.
|
|
/// Per <c>docs/v2/plan.md</c> decision #59 (Core.Abstractions internal-only for now; design as
|
|
/// if public to minimize churn later).
|
|
/// </summary>
|
|
public sealed class InterfaceIndependenceTests
|
|
{
|
|
private static readonly Assembly Assembly = typeof(IDriver).Assembly;
|
|
|
|
/// <summary>Verifies that the assembly has no references outside the BCL.</summary>
|
|
[Fact]
|
|
public void Assembly_HasNoReferencesOutsideBcl()
|
|
{
|
|
// Allowed reference assembly name prefixes — BCL + the assembly itself.
|
|
var allowed = new[]
|
|
{
|
|
"System",
|
|
"Microsoft.Win32",
|
|
"netstandard",
|
|
"mscorlib",
|
|
"ZB.MOM.WW.OtOpcUa.Core.Abstractions",
|
|
};
|
|
|
|
var referenced = Assembly.GetReferencedAssemblies();
|
|
var disallowed = referenced
|
|
.Where(r => !allowed.Any(a => r.Name!.StartsWith(a, StringComparison.Ordinal)))
|
|
.ToList();
|
|
|
|
disallowed.ShouldBeEmpty(
|
|
$"Core.Abstractions must reference only BCL/System assemblies. " +
|
|
$"Found disallowed references: {string.Join(", ", disallowed.Select(a => a.Name))}");
|
|
}
|
|
|
|
/// <summary>Verifies that all public types live in the root namespace.</summary>
|
|
[Fact]
|
|
public void AllPublicTypes_LiveInRootNamespace()
|
|
{
|
|
// Per the decision-#59 "design as if public" rule — no nested sub-namespaces; one flat surface.
|
|
var publicTypes = Assembly.GetExportedTypes();
|
|
var nonRoot = publicTypes
|
|
.Where(t => t.Namespace != "ZB.MOM.WW.OtOpcUa.Core.Abstractions")
|
|
.ToList();
|
|
|
|
nonRoot.ShouldBeEmpty(
|
|
$"Core.Abstractions should expose all public types in the root namespace. " +
|
|
$"Found types in other namespaces: {string.Join(", ", nonRoot.Select(t => $"{t.FullName}"))}");
|
|
}
|
|
|
|
/// <summary>Verifies that every capability interface is public.</summary>
|
|
/// <param name="type">The interface type to check.</param>
|
|
[Theory]
|
|
[InlineData(typeof(IDriver))]
|
|
[InlineData(typeof(ITagDiscovery))]
|
|
[InlineData(typeof(IReadable))]
|
|
[InlineData(typeof(IWritable))]
|
|
[InlineData(typeof(ISubscribable))]
|
|
[InlineData(typeof(IAlarmSource))]
|
|
[InlineData(typeof(IHistoryProvider))]
|
|
[InlineData(typeof(IRediscoverable))]
|
|
[InlineData(typeof(IHostConnectivityProbe))]
|
|
[InlineData(typeof(ISkippedTagReporter))]
|
|
[InlineData(typeof(IDriverConfigEditor))]
|
|
[InlineData(typeof(IAddressSpaceBuilder))]
|
|
public void EveryCapabilityInterface_IsPublic(Type type)
|
|
{
|
|
type.IsPublic.ShouldBeTrue($"{type.Name} must be public — drivers in separate assemblies implement it.");
|
|
type.IsInterface.ShouldBeTrue($"{type.Name} must be an interface, not a class.");
|
|
}
|
|
}
|