Tasks #211 #212 #213 — AbCip / S7 / AbLegacy server-side factories + seed SQL

Parent: #209. Follow-up to #210 (Modbus). Registers the remaining three non-Galaxy driver factories so a Config DB `DriverType` in {`AbCip`, `S7`, `AbLegacy`} actually boots a live driver instead of being silently skipped by DriverInstanceBootstrapper. Each factory follows the same shape as ModbusDriverFactoryExtensions + the existing Galaxy + FOCAS patterns: - Static `Register(DriverFactoryRegistry)` entry point. - Internal `CreateInstance(driverInstanceId, driverConfigJson)` — deserialises a DTO, strict-parses enum fields (fail-fast with an explicit "expected one of" list), composes the driver's options object, returns a new driver. - DriverType keys: `"AbCip"`, `"S7"`, `"AbLegacy"` (case-insensitive at the registry layer). DTO surfaces cover every option the respective driver's Options class exposes — devices, tags, probe, timeouts, per-driver quirks (AbCip `EnableControllerBrowse` / `EnableAlarmProjection`, S7 Rack/Slot/ CpuType, AbLegacy PlcFamily). Seed SQL (mirrors `seed-modbus-smoke.sql` shape): - `seed-abcip-smoke.sql` — `abcip-smoke` cluster + ControlLogix device + `TestDINT:DInt` tag, pointing at the ab_server compose fixture (`ab://127.0.0.1:44818/1,0`). - `seed-s7-smoke.sql` — `s7-smoke` cluster + S71500 CPU + `DB1.DBW0:Int16` tag at the python-snap7 fixture (`127.0.0.1:1102`, non-priv port). - `seed-ablegacy-smoke.sql` — `ablegacy-smoke` cluster + SLC 500 + `N7:5` tag. Hardware-gated per #222; placeholder gateway to be replaced with real SLC/MicroLogix/PLC-5/RSEmulate before running. Build plumbing: - Each driver project now ProjectReferences `Core` (was `Core.Abstractions`-only). `DriverFactoryRegistry` lives in `Core.Hosting` so the factory extensions can't compile without it. Matches the FOCAS + Galaxy.Proxy reference shape. - `Server.csproj` adds the three new driver ProjectReferences so Program.cs resolves the symbols at compile-time + ships the assemblies at runtime. Full-solution build: 0 errors, 334 pre-existing xUnit1051 warnings only. Live boot verification of all four (Modbus + these three) happens in the exit-gate PR — factories + seeds are pre-conditions and are being shipped first so the exit-gate PR can scope to "does the server publish the expected NodeIds + does the e2e script pass." Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-21 11:15:38 -04:00
parent 35d24c2f80
commit 7ba783de77
11 changed files with 773 additions and 0 deletions
--- a/src/ZB.MOM.WW.OtOpcUa.Driver.S7/S7DriverFactoryExtensions.cs
+++ b/src/ZB.MOM.WW.OtOpcUa.Driver.S7/S7DriverFactoryExtensions.cs
@@ -0,0 +1,125 @@
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using ZB.MOM.WW.OtOpcUa.Core.Hosting;
+using S7NetCpuType = global::S7.Net.CpuType;
+
+namespace ZB.MOM.WW.OtOpcUa.Driver.S7;
+
+/// <summary>
+///     Static factory registration helper for <see cref="S7Driver"/>. Server's Program.cs
+///     calls <see cref="Register"/> once at startup; the bootstrapper (task #248) then
+///     materialises S7 DriverInstance rows from the central config DB into live driver
+///     instances. Mirrors <c>GalaxyProxyDriverFactoryExtensions</c>.
+/// </summary>
+public static class S7DriverFactoryExtensions
+{
+    public const string DriverTypeName = "S7";
+
+    public static void Register(DriverFactoryRegistry registry)
+    {
+        ArgumentNullException.ThrowIfNull(registry);
+        registry.Register(DriverTypeName, CreateInstance);
+    }
+
+    internal static S7Driver CreateInstance(string driverInstanceId, string driverConfigJson)
+    {
+        ArgumentException.ThrowIfNullOrWhiteSpace(driverInstanceId);
+        ArgumentException.ThrowIfNullOrWhiteSpace(driverConfigJson);
+
+        var dto = JsonSerializer.Deserialize<S7DriverConfigDto>(driverConfigJson, JsonOptions)
+            ?? throw new InvalidOperationException(
+                $"S7 driver config for '{driverInstanceId}' deserialised to null");
+
+        if (string.IsNullOrWhiteSpace(dto.Host))
+            throw new InvalidOperationException(
+                $"S7 driver config for '{driverInstanceId}' missing required Host");
+
+        var options = new S7DriverOptions
+        {
+            Host = dto.Host!,
+            Port = dto.Port ?? 102,
+            CpuType = ParseEnum<S7NetCpuType>(dto.CpuType, driverInstanceId, "CpuType",
+                fallback: S7NetCpuType.S71500),
+            Rack = dto.Rack ?? 0,
+            Slot = dto.Slot ?? 0,
+            Timeout = TimeSpan.FromMilliseconds(dto.TimeoutMs ?? 5_000),
+            Tags = dto.Tags is { Count: > 0 }
+                ? [.. dto.Tags.Select(t => BuildTag(t, driverInstanceId))]
+                : [],
+            Probe = new S7ProbeOptions
+            {
+                Enabled = dto.Probe?.Enabled ?? true,
+                Interval = TimeSpan.FromMilliseconds(dto.Probe?.IntervalMs ?? 5_000),
+                Timeout = TimeSpan.FromMilliseconds(dto.Probe?.TimeoutMs ?? 2_000),
+                ProbeAddress = dto.Probe?.ProbeAddress ?? "MW0",
+            },
+        };
+
+        return new S7Driver(options, driverInstanceId);
+    }
+
+    private static S7TagDefinition BuildTag(S7TagDto t, string driverInstanceId) =>
+        new(
+            Name: t.Name ?? throw new InvalidOperationException(
+                $"S7 config for '{driverInstanceId}' has a tag missing Name"),
+            Address: t.Address ?? throw new InvalidOperationException(
+                $"S7 tag '{t.Name}' in '{driverInstanceId}' missing Address"),
+            DataType: ParseEnum<S7DataType>(t.DataType, driverInstanceId, "DataType",
+                tagName: t.Name),
+            Writable: t.Writable ?? true,
+            StringLength: t.StringLength ?? 254,
+            WriteIdempotent: t.WriteIdempotent ?? false);
+
+    private static T ParseEnum<T>(string? raw, string driverInstanceId, string field,
+        string? tagName = null, T? fallback = null) where T : struct, Enum
+    {
+        if (string.IsNullOrWhiteSpace(raw))
+        {
+            if (fallback.HasValue) return fallback.Value;
+            throw new InvalidOperationException(
+                $"S7 tag '{tagName ?? "<unnamed>"}' in '{driverInstanceId}' missing {field}");
+        }
+        return Enum.TryParse<T>(raw, ignoreCase: true, out var v)
+            ? v
+            : throw new InvalidOperationException(
+                $"S7 {(tagName is null ? "config" : $"tag '{tagName}'")} has unknown {field} '{raw}'. " +
+                $"Expected one of {string.Join(", ", Enum.GetNames<T>())}");
+    }
+
+    private static readonly JsonSerializerOptions JsonOptions = new()
+    {
+        PropertyNameCaseInsensitive = true,
+        ReadCommentHandling = JsonCommentHandling.Skip,
+        AllowTrailingCommas = true,
+    };
+
+    internal sealed class S7DriverConfigDto
+    {
+        public string? Host { get; init; }
+        public int? Port { get; init; }
+        public string? CpuType { get; init; }
+        public short? Rack { get; init; }
+        public short? Slot { get; init; }
+        public int? TimeoutMs { get; init; }
+        public List<S7TagDto>? Tags { get; init; }
+        public S7ProbeDto? Probe { get; init; }
+    }
+
+    internal sealed class S7TagDto
+    {
+        public string? Name { get; init; }
+        public string? Address { get; init; }
+        public string? DataType { get; init; }
+        public bool? Writable { get; init; }
+        public int? StringLength { get; init; }
+        public bool? WriteIdempotent { get; init; }
+    }
+
+    internal sealed class S7ProbeDto
+    {
+        public bool? Enabled { get; init; }
+        public int? IntervalMs { get; init; }
+        public int? TimeoutMs { get; init; }
+        public string? ProbeAddress { get; init; }
+    }
+}