Joseph Doherty
bd6c0b4d3d
Add missing <returns>/<param>/<summary>/<typeparam> tags and clean up misused inheritdoc across 481 files so the documented API surface is complete. Documentation-only (zero code lines changed). The 131 remaining findings are inheritdoc-style warnings deliberately left to preserve hand-written implementation rationale (plan-decision notes, race-condition explanations).
73 lines
3.2 KiB
C#
73 lines
3.2 KiB
C#
using Shouldly;
|
|
using Xunit;
|
|
using ZB.MOM.WW.OtOpcUa.Core.Abstractions;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Driver.S7.Tests;
|
|
|
|
/// <summary>
|
|
/// Scaffold-level tests that don't need a live S7 PLC — exercise driver lifecycle shape,
|
|
/// default option values, and failure-mode transitions. PR 64 adds IReadable/IWritable
|
|
/// tests against a mock-server, PR 65 adds discovery + subscribe.
|
|
/// </summary>
|
|
[Trait("Category", "Unit")]
|
|
public sealed class S7DriverScaffoldTests
|
|
{
|
|
/// <summary>Verifies that default options target S7-1500 slot 0 on port 102.</summary>
|
|
[Fact]
|
|
public void Default_options_target_S7_1500_slot_0_on_port_102()
|
|
{
|
|
var opts = new S7DriverOptions();
|
|
opts.Port.ShouldBe(102, "ISO-on-TCP is always 102 for S7; documented in driver-specs.md §5");
|
|
opts.CpuType.ShouldBe(S7CpuType.S71500);
|
|
opts.Rack.ShouldBe((short)0);
|
|
opts.Slot.ShouldBe((short)0, "S7-1200/1500 onboard PN ports are slot 0 by convention");
|
|
}
|
|
|
|
/// <summary>Verifies that the default probe interval is reasonable for S7 scan cycles.</summary>
|
|
[Fact]
|
|
public void Default_probe_interval_is_reasonable_for_S7_scan_cycle()
|
|
{
|
|
// S7 PLCs scan 2-10 ms but comms mailbox typically processed once per scan.
|
|
// 5 s default probe is lightweight — ~0.001% of comms budget.
|
|
new S7ProbeOptions().Interval.ShouldBe(TimeSpan.FromSeconds(5));
|
|
}
|
|
|
|
/// <summary>Verifies that tag definition defaults to writable with S7 max string length.</summary>
|
|
[Fact]
|
|
public void Tag_definition_defaults_to_writable_with_S7_max_string_length()
|
|
{
|
|
var tag = new S7TagDefinition("T", "DB1.DBW0", S7DataType.Int16);
|
|
tag.Writable.ShouldBeTrue();
|
|
tag.StringLength.ShouldBe(254, "S7 STRING type max length is 254 chars");
|
|
}
|
|
|
|
/// <summary>Verifies that the driver instance reports type and ID before connect.</summary>
|
|
[Fact]
|
|
public void Driver_instance_reports_type_and_id_before_connect()
|
|
{
|
|
var opts = new S7DriverOptions { Host = "127.0.0.1" };
|
|
using var drv = new S7Driver(opts, "s7-test");
|
|
drv.DriverType.ShouldBe("S7");
|
|
drv.DriverInstanceId.ShouldBe("s7-test");
|
|
drv.GetHealth().State.ShouldBe(DriverState.Unknown, "health starts Unknown until InitializeAsync runs");
|
|
}
|
|
|
|
/// <summary>Verifies that Initialize against unreachable host transitions to Faulted and throws.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task Initialize_against_unreachable_host_transitions_to_Faulted_and_throws()
|
|
{
|
|
// Pick an RFC 5737 reserved-for-documentation IP so the connect attempt fails fast
|
|
// (no DNS mismatch, no accidental traffic to a real PLC).
|
|
var opts = new S7DriverOptions { Host = "192.0.2.1", Timeout = TimeSpan.FromMilliseconds(250) };
|
|
using var drv = new S7Driver(opts, "s7-unreach");
|
|
|
|
await Should.ThrowAsync<Exception>(async () =>
|
|
await drv.InitializeAsync("{}", TestContext.Current.CancellationToken));
|
|
|
|
var health = drv.GetHealth();
|
|
health.State.ShouldBe(DriverState.Faulted, "unreachable host must flip the driver to Faulted so operators see it");
|
|
health.LastError.ShouldNotBeNull();
|
|
}
|
|
}
|