using System.Net.Sockets; using Xunit; using Xunit.Sdk; using ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.PlcFamilies; namespace ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.IntegrationTests; /// /// Reachability probe for the ab_server Docker container running in a PCCC /// plc mode (SLC500 / Micrologix / PLC/5). Same container image /// the AB CIP integration suite uses — libplctag's ab_server supports both /// CIP + PCCC families from one binary. Tests skip via /// / when /// the port isn't live, so dotnet test stays green on a fresh clone without /// Docker running. /// /// /// Env-var overrides: /// /// AB_LEGACY_ENDPOINThost:port of the PCCC-mode simulator. /// Defaults to localhost:44818 (EtherNet/IP port; ab_server's PCCC /// emulation exposes PCCC-over-CIP on the same port as CIP itself). /// AB_LEGACY_CIP_PATH — routing path appended to the ab://host:port/ /// URI. Defaults to 1,0 (port-1/slot-0 backplane), required by ab_server /// which rejects unconnected Send_RR_Data with an empty path at the CIP layer /// before the PCCC dispatcher runs. Real SLC 5/05 / MicroLogix / PLC-5 hardware /// use an empty path — set AB_LEGACY_CIP_PATH= (empty) when pointing at /// real hardware. /// /// Distinct from AB_SERVER_ENDPOINT used by the AB CIP fixture so both /// can point at different containers simultaneously during a combined test run. /// public sealed class AbLegacyServerFixture : IAsyncLifetime { private const string EndpointEnvVar = "AB_LEGACY_ENDPOINT"; private const string CipPathEnvVar = "AB_LEGACY_CIP_PATH"; /// Standard EtherNet/IP port. PCCC-over-CIP rides on the same port as /// native CIP; the differentiator is the --plc flag ab_server was started /// with, not a different TCP listener. public const int DefaultPort = 44818; /// /// ab_server rejects unconnected Send_RR_Data with an empty CIP routing path /// at the CIP layer — the PCCC dispatcher never runs. 1,0 is the generic /// port-1/slot-0 backplane path; any well-formed path passes the gate. Real /// hardware (SLC 5/05 / MicroLogix / PLC-5) uses an empty path because there's /// no backplane to cross, so point AB_LEGACY_CIP_PATH= (empty) at real /// hardware to exercise the authentic wire semantics. /// public const string DefaultCipPath = "1,0"; public string Host { get; } = "127.0.0.1"; public int Port { get; } = DefaultPort; /// CIP routing path portion of the device URI (after the / separator). /// May be empty when targeting real hardware; non-empty against ab_server. public string CipPath { get; } = DefaultCipPath; public string? SkipReason { get; } public AbLegacyServerFixture() { if (Environment.GetEnvironmentVariable(EndpointEnvVar) is { Length: > 0 } raw) { var parts = raw.Split(':', 2); Host = parts[0]; if (parts.Length == 2 && int.TryParse(parts[1], out var p)) Port = p; } // Empty override is intentional (real hardware); treat `null` as "not set, use // default" but preserve an explicit empty-string override. var cipOverride = Environment.GetEnvironmentVariable(CipPathEnvVar); if (cipOverride is not null) CipPath = cipOverride; SkipReason = ResolveSkipReason(Host, Port); } public ValueTask InitializeAsync() => ValueTask.CompletedTask; public ValueTask DisposeAsync() => ValueTask.CompletedTask; /// /// Used by + /// during test-class construction — gates whether the test runs at all. Duplicates the /// fixture logic because attribute ctors fire before the collection fixture instance /// exists. /// public static bool IsServerAvailable() { var (host, port) = ResolveEndpoint(); return ResolveSkipReason(host, port) is null; } private static string? ResolveSkipReason(string host, int port) { if (!TcpProbe(host, port)) { return $"AB Legacy PCCC endpoint at {host}:{port} not reachable within 2 s. " + $"Start the Docker container (docker compose -f Docker/docker-compose.yml " + $"--profile slc500 up -d), attach real hardware, or override {EndpointEnvVar}."; } return null; } private static (string Host, int Port) ResolveEndpoint() { var raw = Environment.GetEnvironmentVariable(EndpointEnvVar); if (raw is null) return ("127.0.0.1", DefaultPort); var parts = raw.Split(':', 2); var port = parts.Length == 2 && int.TryParse(parts[1], out var p) ? p : DefaultPort; return (parts[0], port); } private static bool TcpProbe(string host, int port) { try { using var client = new TcpClient(); var task = client.ConnectAsync(host, port); return task.Wait(TimeSpan.FromSeconds(2)) && client.Connected; } catch { return false; } } } /// /// Per-family marker for the PCCC-mode compose profile a given test targets. The /// compose file (Docker/docker-compose.yml) is the canonical source of truth /// for which --plc mode + tags each family seeds; this record just ties a /// family enum to its compose-profile name + operator-facing notes. /// public sealed record AbLegacyServerProfile( AbLegacyPlcFamily Family, string ComposeProfile, string Notes); /// Canonical profiles covering every PCCC family the driver supports. public static class KnownProfiles { public static readonly AbLegacyServerProfile Slc500 = new( Family: AbLegacyPlcFamily.Slc500, ComposeProfile: "slc500", Notes: "SLC 500 / 5/05 family. ab_server SLC500 mode covers N/F/B/L files."); public static readonly AbLegacyServerProfile MicroLogix = new( Family: AbLegacyPlcFamily.MicroLogix, ComposeProfile: "micrologix", Notes: "MicroLogix 1000 / 1100 / 1400. Shares N/F/B file-type coverage with SLC500; ST (ASCII strings) included."); public static readonly AbLegacyServerProfile Plc5 = new( Family: AbLegacyPlcFamily.Plc5, ComposeProfile: "plc5", Notes: "PLC-5 family. ab_server PLC/5 mode covers N/F/B; per-family quirks on ST / timer file layouts unit-tested only."); public static IReadOnlyList All { get; } = [Slc500, MicroLogix, Plc5]; public static AbLegacyServerProfile ForFamily(AbLegacyPlcFamily family) => All.FirstOrDefault(p => p.Family == family) ?? throw new ArgumentOutOfRangeException(nameof(family), family, "No integration profile for this family."); } [Xunit.CollectionDefinition(Name)] public sealed class AbLegacyServerCollection : Xunit.ICollectionFixture { public const string Name = "AbLegacyServer"; } /// /// [Fact]-equivalent that skips when the PCCC endpoint isn't reachable. /// See for the exact skip semantics. /// public sealed class AbLegacyFactAttribute : FactAttribute { public AbLegacyFactAttribute() { if (!AbLegacyServerFixture.IsServerAvailable()) Skip = "AB Legacy PCCC endpoint not reachable. Start the Docker fixture " + "(docker compose -f Docker/docker-compose.yml --profile slc500 up -d) " + "or point AB_LEGACY_ENDPOINT at real hardware."; } } /// /// [Theory]-equivalent with the same gate as . /// public sealed class AbLegacyTheoryAttribute : TheoryAttribute { public AbLegacyTheoryAttribute() { if (!AbLegacyServerFixture.IsServerAvailable()) Skip = "AB Legacy PCCC endpoint not reachable. Start the Docker fixture " + "(docker compose -f Docker/docker-compose.yml --profile slc500 up -d) " + "or point AB_LEGACY_ENDPOINT at real hardware."; } }