58a0cccc67
AbServerProfileGate — static helper that reads `AB_SERVER_PROFILE` env var (defaults to "abserver") + exposes `SkipUnless(params string[] requiredProfiles)` matching the MODBUS_SIM_PROFILE pattern the DL205StringQuirkTests uses one directory over. Emulate-only tests call `AbServerProfileGate.SkipUnless("emulate")` at the top of each fact body; ab_server-default runs see them skip with a clear message pointing at the Emulate setup steps.
AbCipEmulateUdtReadTests — one test proving the #194 whole-UDT read optimization works against the real Logix Template Object, not just the golden byte buffers the unit suite uses. Builds an `AbCipDriverOptions` with a Structure tag `Motor1 : Motor_UDT` that has three declared members (Speed : DINT, Torque : REAL, Status : DINT), reads them via the `.Speed / .Torque / .Status` dotted-tag syntax, asserts the driver gets the grouped whole-UDT path + decodes each at the right offset. Required seed values documented inline + in LogixProject/README.md: Speed=1800, Torque=42.5f, Status=0x0001.
AbCipEmulateAlmdTests — one test proving the #177 ALMD projection fires `OnAlarmEvent` when a real ALMD instruction's `In` edge rises, not just the fake `InFaulted` timer edges the unit suite drives. Needs a `SimulateAlarm : BOOL` tag routed through `MainRoutine` ladder (`XIC SimulateAlarm OTE HighTempAlarm.In`) so the test case can pulse the input via the existing `IWritable.WriteAsync` path instead of scripting Emulate via its own socket. Alarm-projection options carry `EnableAlarmProjection = true` + 200 ms poll interval; a `TaskCompletionSource` gates the raise-event assertion with a 5 s deadline. Cleanup writes SimulateAlarm=false so consecutive runs start from known state.
LogixProject/README.md — the Studio 5000 project state the Emulate-tier tests depend on. Explains why L5X over ACD (text diff, reproducible import, no per-install state), the UDT + tag + routine structure, how to bring it up on the Emulate PC. Ships as a stub pending actual author + L5X export + commit; the README itself keeps the requirements visible so the L5X author has a checklist.
docs/drivers/AbServer-Test-Fixture.md — new §Logix Emulate golden-box tier section with the coverage-promotion table (ab_server / Emulate / hardware per gap), the setup-env-var recipe, the costs to accept (license, Hyper-V conflict, manual lifecycle). "When to trust" table extended from 3 columns (ab_server / unit / rig) to 4 (ab_server / unit / Logix Emulate / rig); two new rows for EtherNet/IP embedded-switch + redundant-chassis failover that even Emulate can't help with. Follow-up candidates list gets Logix Emulate as option 1 ahead of the pre-existing "extend ab_server upstream" + "stand up a lab rig". See-also file list gains AbServerProfileGate.cs + Docker/ + Emulate/ + LogixProject/README.md entries.
docs/v2/dev-environment.md — §C Integration host gains a Rockwell Studio 5000 Logix Emulate row: purpose (AB CIP golden-box tier closing UDT/ALMD/AOI/safety/ConnectionSize gaps), type (Windows-only, Hyper-V conflict matching TwinCAT XAR's constraint), port 44818, credentials note, owner split between integration-host admin for license+install and developer for per-session runtime start.
Verified: Emulate tests skip cleanly when AB_SERVER_PROFILE is unset — both `[SKIP]` with the operator-facing message pointing at the env-var setup. Whole-solution build 0 errors. Tests will transition from skip → pass once the L5X + Emulate PC land per #223.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
82 lines
3.9 KiB
C#
82 lines
3.9 KiB
C#
using Shouldly;
|
|
using Xunit;
|
|
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
|
|
using ZB.MOM.WW.OtOpcUa.Driver.AbCip;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Driver.AbCip.IntegrationTests.Emulate;
|
|
|
|
/// <summary>
|
|
/// Golden-box-tier UDT read tests against Rockwell Studio 5000 Logix Emulate.
|
|
/// Promotes the whole-UDT-read optimization (task #194) from unit-only coverage
|
|
/// (golden Template Object byte buffers + <see cref="AbCipUdtMemberLayoutTests"/>)
|
|
/// to end-to-end wire-level coverage — Emulate's firmware speaks the same CIP
|
|
/// Template Object responses real hardware does, so the member-offset math + the
|
|
/// <c>AbCipUdtReadPlanner</c> grouping get validated against production semantics.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para><b>Required Emulate project state</b> (see <c>LogixProject/README.md</c>
|
|
/// for the L5X export that seeds this; ship the project once Emulate is on the
|
|
/// integration host):</para>
|
|
/// <list type="bullet">
|
|
/// <item>UDT <c>Motor_UDT</c> with members <c>Speed : DINT</c>, <c>Torque : REAL</c>,
|
|
/// <c>Status : DINT</c> — the member set <see cref="AbCipUdtMemberLayoutTests"/>
|
|
/// uses as its declared-layout golden reference.</item>
|
|
/// <item>Controller-scope tag <c>Motor1 : Motor_UDT</c> with seed values
|
|
/// Speed=<c>1800</c>, Torque=<c>42.5f</c>, Status=<c>0x0001</c>.</item>
|
|
/// </list>
|
|
/// <para>Runs only when <c>AB_SERVER_PROFILE=emulate</c>. With ab_server
|
|
/// (the default), skips cleanly — ab_server lacks UDT / Template Object emulation
|
|
/// so this wire-level test couldn't pass against it regardless.</para>
|
|
/// </remarks>
|
|
[Collection("AbServerEmulate")]
|
|
[Trait("Category", "Integration")]
|
|
[Trait("Tier", "Emulate")]
|
|
public sealed class AbCipEmulateUdtReadTests
|
|
{
|
|
[AbServerFact]
|
|
public async Task WholeUdt_read_decodes_each_member_at_its_Template_Object_offset()
|
|
{
|
|
AbServerProfileGate.SkipUnless(AbServerProfileGate.Emulate);
|
|
|
|
var endpoint = Environment.GetEnvironmentVariable("AB_SERVER_ENDPOINT")
|
|
?? throw new InvalidOperationException(
|
|
"AB_SERVER_ENDPOINT must be set to the Logix Emulate instance " +
|
|
"(e.g. '10.0.0.42:44818') when AB_SERVER_PROFILE=emulate.");
|
|
|
|
var options = new AbCipDriverOptions
|
|
{
|
|
Devices = [new AbCipDeviceOptions($"ab://{endpoint}/1,0")],
|
|
Tags = [
|
|
new AbCipTagDefinition(
|
|
Name: "Motor1",
|
|
DeviceHostAddress: $"ab://{endpoint}/1,0",
|
|
TagPath: "Motor1",
|
|
DataType: AbCipDataType.Structure,
|
|
Members: [
|
|
new AbCipStructureMember("Speed", AbCipDataType.DInt),
|
|
new AbCipStructureMember("Torque", AbCipDataType.Real),
|
|
new AbCipStructureMember("Status", AbCipDataType.DInt),
|
|
]),
|
|
],
|
|
Timeout = TimeSpan.FromSeconds(5),
|
|
};
|
|
|
|
await using var drv = new AbCipDriver(options, driverInstanceId: "emulate-udt-smoke");
|
|
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken);
|
|
|
|
// Whole-UDT read optimization from task #194: one libplctag read on the
|
|
// parent tag, three decodes from the buffer at member offsets. Asserts
|
|
// Emulate's Template Object response matches what AbCipUdtMemberLayout
|
|
// computes from the declared member set.
|
|
var snapshots = await drv.ReadAsync(
|
|
["Motor1.Speed", "Motor1.Torque", "Motor1.Status"],
|
|
TestContext.Current.CancellationToken);
|
|
|
|
snapshots.Count.ShouldBe(3);
|
|
foreach (var s in snapshots) s.StatusCode.ShouldBe(AbCipStatusMapper.Good);
|
|
Convert.ToInt32(snapshots[0].Value).ShouldBe(1800);
|
|
Convert.ToSingle(snapshots[1].Value).ShouldBe(42.5f, tolerance: 0.001f);
|
|
Convert.ToInt32(snapshots[2].Value).ShouldBe(0x0001);
|
|
}
|
|
}
|