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.
35 lines
1.7 KiB
C#
35 lines
1.7 KiB
C#
using Microsoft.Extensions.Options;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests.TestSupport;
|
|
|
|
/// <summary>
|
|
/// Minimal <see cref="IOptionsMonitor{TOptions}"/> test double with a mutable
|
|
/// <see cref="Set"/> so a test can flip a value mid-run and assert the NEXT read observes it
|
|
/// — used by the hot-toggle tests
|
|
/// (<c>SiteRuntimeOptions.PerRunScriptEvents</c>/<c>PerRunScriptEventScripts</c> are read via
|
|
/// <c>IOptionsMonitor.CurrentValue</c> per run specifically so they don't need a restart).
|
|
/// Avoids depending on <c>Microsoft.Extensions.Configuration</c>'s reload-token plumbing,
|
|
/// which is awkward to drive deterministically from xUnit.
|
|
/// </summary>
|
|
public sealed class TestOptionsMonitor<T>(T initial) : IOptionsMonitor<T>
|
|
{
|
|
private T _current = initial;
|
|
|
|
/// <summary>Gets the current value, as most recently set by <see cref="Set"/>.</summary>
|
|
public T CurrentValue => _current;
|
|
|
|
/// <summary>Returns the current value regardless of the requested name.</summary>
|
|
/// <param name="name">The named-options key, ignored by this double.</param>
|
|
/// <returns>The current value.</returns>
|
|
public T Get(string? name) => _current;
|
|
|
|
/// <summary>Change notifications are not supported by this double; no registration is made.</summary>
|
|
/// <param name="listener">The change listener, ignored by this double.</param>
|
|
/// <returns>Always <see langword="null"/>.</returns>
|
|
public IDisposable? OnChange(Action<T, string?> listener) => null;
|
|
|
|
/// <summary>Replaces the current value, observed by the next <see cref="CurrentValue"/> read.</summary>
|
|
/// <param name="value">The new value.</param>
|
|
public void Set(T value) => _current = value;
|
|
}
|