Joseph Doherty
513fa1aa16
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
41 lines
1.8 KiB
C#
41 lines
1.8 KiB
C#
using System.Reflection;
|
|
using AuditEvent = ZB.MOM.WW.Audit.AuditEvent;
|
|
using IAuditWriter = ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services.IAuditWriter;
|
|
using ICentralAuditWriter = ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services.ICentralAuditWriter;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Commons.Tests.Interfaces.Services;
|
|
|
|
/// <summary>
|
|
/// Reflection-level contract guards for the Audit Log writer interfaces.
|
|
/// Locks in method signature so DI bindings + adapter implementations stay aligned.
|
|
/// </summary>
|
|
public class AuditWriterContractTests
|
|
{
|
|
/// <summary>Verifies that the writer interface exposes <c>WriteAsync</c> with the expected signature.</summary>
|
|
/// <param name="writerType">The writer interface type under test.</param>
|
|
[Theory]
|
|
[InlineData(typeof(IAuditWriter))]
|
|
[InlineData(typeof(ICentralAuditWriter))]
|
|
public void WriteAsync_HasExpectedSignature(Type writerType)
|
|
{
|
|
var method = writerType.GetMethod("WriteAsync", BindingFlags.Instance | BindingFlags.Public);
|
|
Assert.NotNull(method);
|
|
Assert.Equal(typeof(Task), method!.ReturnType);
|
|
|
|
var parameters = method.GetParameters();
|
|
Assert.Equal(2, parameters.Length);
|
|
Assert.Equal(typeof(AuditEvent), parameters[0].ParameterType);
|
|
Assert.Equal(typeof(CancellationToken), parameters[1].ParameterType);
|
|
Assert.True(parameters[1].HasDefaultValue);
|
|
}
|
|
|
|
/// <summary>Verifies that the site and central audit writer interfaces are distinct types.</summary>
|
|
[Fact]
|
|
public void IAuditWriter_AndICentralAuditWriter_AreDistinctTypes()
|
|
{
|
|
Assert.NotEqual(typeof(IAuditWriter), typeof(ICentralAuditWriter));
|
|
Assert.False(typeof(IAuditWriter).IsAssignableFrom(typeof(ICentralAuditWriter)));
|
|
Assert.False(typeof(ICentralAuditWriter).IsAssignableFrom(typeof(IAuditWriter)));
|
|
}
|
|
}
|