lmxopcua/tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.IntegrationTests/AbLegacyReadSmokeTests.cs

using Shouldly;
using Xunit;
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
using ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.PlcFamilies;

namespace ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.IntegrationTests;

/// <summary>
///     End-to-end smoke tests against the <c>ab_server</c> PCCC Docker container.
///     Promotes the AB Legacy driver from unit-only coverage (<c>FakeAbLegacyTag</c>)
///     to wire-level: real libplctag PCCC stack over real TCP against the ab_server
///     simulator. Parametrised over all three families (SLC 500 / MicroLogix / PLC-5)
///     via <c>[AbLegacyTheory]</c> + <c>[MemberData]</c>.
/// </summary>
[Collection(AbLegacyServerCollection.Name)]
[Trait("Category", "Integration")]
[Trait("Simulator", "ab_server-PCCC")]
public sealed class AbLegacyReadSmokeTests(AbLegacyServerFixture sim)
{
    // Only one ab_server container binds :44818 at a time and `--plc=SLC500` only
    // answers SLC-mode PCCC, etc. When `AB_LEGACY_COMPOSE_PROFILE` is set, the theory
    // filters to that profile alone so the suite matches the running container. Unset
    // (the default for real-hardware runs) parameterises across every family the driver
    // supports.
    /// <summary>Gets the available server profiles based on compose configuration.</summary>
    public static IEnumerable<object[]> Profiles
    {
        get
        {
            var only = Environment.GetEnvironmentVariable("AB_LEGACY_COMPOSE_PROFILE");
            var profiles = KnownProfiles.All.Where(p =>
                string.IsNullOrEmpty(only) ||
                string.Equals(p.ComposeProfile, only, StringComparison.OrdinalIgnoreCase));
            return profiles.Select(p => new object[] { p });
        }
    }

    /// <summary>Verifies that the driver reads seeded N file from the AB server via PCCC.</summary>
    /// <param name="profile">The AB Legacy server profile describing the fixture endpoint.</param>
    [AbLegacyTheory]
    [MemberData(nameof(Profiles))]
    public async Task Driver_reads_seeded_N_file_from_ab_server_PCCC(AbLegacyServerProfile profile)
    {
        if (sim.SkipReasonFor(profile) is { } skip) Assert.Skip(skip);

        // PCCC semantics allow an empty cip-path (real SLC/PLC-5 hardware takes nothing
        // after the `/`), but libplctag's ab_server requires a non-empty path at the
        // CIP unconnected-send layer before the PCCC dispatcher runs. Default `1,0`
        // against the Docker fixture; set AB_LEGACY_CIP_PATH= (empty) against real HW.
        var deviceUri = $"ab://{sim.Host}:{sim.PortFor(profile)}/{sim.CipPath}";
        await using var drv = new AbLegacyDriver(new AbLegacyDriverOptions
        {
            Devices = [new AbLegacyDeviceOptions(deviceUri, profile.Family)],
            RawTags = AbLegacyRawTags.Entries(
                new AbLegacyTagDefinition(
                    Name: "IntCounter",
                    DeviceHostAddress: deviceUri,
                    Address: "N7:0",
                    DataType: AbLegacyDataType.Int)),
            Timeout = TimeSpan.FromSeconds(5),
            Probe = new AbLegacyProbeOptions { Enabled = false },
        }, driverInstanceId: $"ablegacy-smoke-{profile.Family}");

        await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);

        var snapshots = await drv.ReadAsync(
            ["IntCounter"], TestContext.Current.CancellationToken);

        snapshots.Single().StatusCode.ShouldBe(AbLegacyStatusMapper.Good,
            $"N7:0 read must succeed against the {profile.Family} compose profile");
        drv.GetHealth().State.ShouldBe(DriverState.Healthy);
    }

    /// <summary>Verifies that SLC500 write-then-read round trip succeeds on N7 scratch register.</summary>
    [AbLegacyFact]
    public async Task Slc500_write_then_read_round_trip_on_N7_scratch_register()
    {
        // Addresses the SLC500 container by its OWN port, so it no longer matters which other
        // families happen to be running. The old AB_LEGACY_COMPOSE_PROFILE guard existed because every
        // family shared :44818 and this test could otherwise write SLC500 semantics at whichever
        // container held the port; it survives below only for real-hardware runs, where
        // AB_LEGACY_ENDPOINT pins one device and the family IS a property of that device.
        if (sim.SkipReasonFor(KnownProfiles.Slc500) is { } skip) Assert.Skip(skip);

        var only = Environment.GetEnvironmentVariable("AB_LEGACY_COMPOSE_PROFILE");
        if (sim.EndpointPinned && !string.IsNullOrEmpty(only) &&
            !string.Equals(only, "slc500", StringComparison.OrdinalIgnoreCase))
        {
            Assert.Skip($"Pinned endpoint is not SLC500; AB_LEGACY_COMPOSE_PROFILE='{only}'.");
        }

        // PCCC semantics allow an empty cip-path (real SLC/PLC-5 hardware takes nothing
        // after the `/`), but libplctag's ab_server requires a non-empty path at the
        // CIP unconnected-send layer before the PCCC dispatcher runs. Default `1,0`
        // against the Docker fixture; set AB_LEGACY_CIP_PATH= (empty) against real HW.
        var deviceUri = $"ab://{sim.Host}:{sim.PortFor(KnownProfiles.Slc500)}/{sim.CipPath}";
        await using var drv = new AbLegacyDriver(new AbLegacyDriverOptions
        {
            Devices = [new AbLegacyDeviceOptions(deviceUri, AbLegacyPlcFamily.Slc500)],
            RawTags = AbLegacyRawTags.Entries(
                new AbLegacyTagDefinition(
                    Name: "Scratch",
                    DeviceHostAddress: deviceUri,
                    Address: "N7:5",
                    DataType: AbLegacyDataType.Int,
                    Writable: true)),
            Timeout = TimeSpan.FromSeconds(5),
            Probe = new AbLegacyProbeOptions { Enabled = false },
        }, driverInstanceId: "ablegacy-smoke-rw");

        await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);

        const short probe = 0x1234;
        var writeResults = await drv.WriteAsync(
            [new WriteRequest("Scratch", probe)],
            TestContext.Current.CancellationToken);
        writeResults.Single().StatusCode.ShouldBe(AbLegacyStatusMapper.Good,
            "PCCC N7:5 write must succeed end-to-end");

        var readResults = await drv.ReadAsync(
            ["Scratch"], TestContext.Current.CancellationToken);
        readResults.Single().StatusCode.ShouldBe(AbLegacyStatusMapper.Good);
        Convert.ToInt32(readResults.Single().Value).ShouldBe(probe);
    }
}