dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(tests): fix CommentChecker findings across tests/ — 13,392 → 0 (repo-wide scan clean)

Browse Source 
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.
This commit is contained in:
Joseph Doherty
2026-10-07 15:05:49 -04:00
parent 0ffd4bdbea
commit 513fa1aa16
998 changed files with 17896 additions and 2395 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.SiteRuntime.Tests/Scripts/ScriptFileReaderTests.cs
+48
View File
@@ -19,6 +19,7 @@ public sealed class ScriptFileReaderTests : IDisposable
private readonly string _base;
private readonly string _root;
/// <summary>Initializes the tests with a temporary root directory.</summary>
public ScriptFileReaderTests()
{
_base = Path.Combine(Path.GetTempPath(), "sb-files-" + Guid.NewGuid().ToString("N"));
@@ -26,6 +27,7 @@ public sealed class ScriptFileReaderTests : IDisposable
Directory.CreateDirectory(_root);
}
/// <summary>Releases the resources held by this test class.</summary>
public void Dispose()
{
try { Directory.Delete(_base, recursive: true); } catch { /* best effort */ }
@@ -52,6 +54,8 @@ public sealed class ScriptFileReaderTests : IDisposable
private static async Task<ScriptFileAccessFailure> FailureOf(Func<Task> act) =>
(await Assert.ThrowsAsync<ScriptFileAccessException>(act)).Failure;
/// <summary>Verifies that file access is disabled by default when no roots are configured.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task NoRoots_IsDisabled_ByDefault()
{
@@ -62,6 +66,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal(ScriptFileAccessFailure.Disabled, await FailureOf(() => reader.ExistsAsync(path, default)));
}
/// <summary>Verifies that text under a root is read and a byte order mark is detected.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ReadsText_UnderRoot_AndDetectsBom()
{
@@ -73,6 +79,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal("ReactorTempSP,1050\n", text);
}
/// <summary>Verifies that a file in a nested directory under the root can be read.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task ReadsFromNestedDirectory()
{
@@ -80,6 +88,9 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal("a,1", await Reader().ReadTextAsync(path, default));
}
/// <summary>Verifies that an empty or relative path is rejected.</summary>
/// <param name="path">The empty or relative path to read.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
[Theory]
[InlineData("")]
[InlineData(" ")]
@@ -89,6 +100,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal(ScriptFileAccessFailure.InvalidPath, await FailureOf(() => Reader().ReadTextAsync(path, default)));
}
/// <summary>Verifies that a path outside the configured root is rejected.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RejectsPathOutsideRoot()
{
@@ -99,6 +112,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await FailureOf(() => Reader().ReadTextAsync(outside, default)));
}
/// <summary>Verifies that a dot-dot traversal out of the root is rejected.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RejectsDotDotTraversalOutOfRoot()
{
@@ -109,6 +124,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await FailureOf(() => Reader().ReadTextAsync(sneaky, default)));
}
/// <summary>Verifies that a sibling directory sharing the root's name prefix is not treated as inside the root.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SiblingDirectorySharingThePrefix_IsNotInsideTheRoot()
{
@@ -122,6 +139,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await FailureOf(() => Reader().ReadTextAsync(path, default)));
}
/// <summary>Verifies that the root directory itself is not treated as a file.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task TheRootItself_IsNotAFile()
{
@@ -129,6 +148,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await FailureOf(() => Reader().ReadTextAsync(_root, default)));
}
/// <summary>Verifies that a symlinked file inside the root is refused.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SymlinkedFileInsideRoot_IsRefused()
{
@@ -141,6 +162,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await FailureOf(() => Reader().ReadTextAsync(link, default)));
}
/// <summary>Verifies that a symlinked directory inside the root is refused.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SymlinkedDirectoryInsideRoot_IsRefused()
{
@@ -153,6 +176,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await FailureOf(() => Reader().ReadTextAsync(Path.Combine(_root, "linked", "secret.txt"), default)));
}
/// <summary>Verifies that a missing file reports not found and that the existence check returns false.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task MissingFile_IsNotFound_AndExistsIsFalse()
{
@@ -162,6 +187,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.False(await Reader().ExistsAsync(path, default));
}
/// <summary>Verifies that the existence check returns true for a file but still enforces the roots.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Exists_TrueForFile_ButStillEnforcesRoots()
{
@@ -171,6 +198,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await FailureOf(() => Reader().ExistsAsync(Path.Combine(_base, "whatever.txt"), default)));
}
/// <summary>Verifies that a file over the size cap is reported as too large.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task FileOverTheCap_IsTooLarge()
{
@@ -180,6 +209,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal(2048, (await Reader(maxBytes: 2048).ReadTextAsync(path, default)).Length);
}
/// <summary>Verifies that a file under a second configured root can be read.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task SecondRoot_IsHonoured()
{
@@ -191,6 +222,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal("ok", await Reader(1024 * 1024, _root, other).ReadTextAsync(path, default));
}
/// <summary>Verifies that a root configured with a trailing separator works.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RootConfiguredWithTrailingSeparator_Works()
{
@@ -198,6 +231,7 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal("ok", await Reader(1024 * 1024, _root + Path.DirectorySeparatorChar).ReadTextAsync(path, default));
}
/// <summary>Verifies that line splitting handles mixed line endings and drops a trailing empty line.</summary>
[Fact]
public void SplitLines_HandlesMixedEndings_AndDropsTrailingEmptyLine()
{
@@ -206,6 +240,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal([""], FilesAccessor.SplitLines("\n"));
}
/// <summary>Verifies that the script accessor throws a disabled error when no reader is configured.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Accessor_WithoutReader_ThrowsDisabled()
{
@@ -213,6 +249,8 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal(ScriptFileAccessFailure.Disabled, await FailureOf(() => files.ReadTextAsync("C:/x.txt")));
}
/// <summary>Verifies that the script accessor honours the script deadline.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task Accessor_HonoursTheScriptDeadline()
{
@@ -224,6 +262,8 @@ public sealed class ScriptFileReaderTests : IDisposable
await Assert.ThrowsAnyAsync<OperationCanceledException>(() => files.ReadTextAsync(path));
}
/// <summary>Verifies that a real script compiles through the trust gate and parses a recipe file.</summary>
/// <returns>A task that represents the asynchronous operation.</returns>
[Fact]
public async Task RealScript_CompilesThroughTheTrustGate_AndParsesARecipe()
{
@@ -263,6 +303,7 @@ public sealed class ScriptFileReaderTests : IDisposable
Assert.Equal("missing", await run(Path.Combine(_root, "nope.txt")));
}
/// <summary>Verifies that raw System.IO usage is still rejected by the trust gate.</summary>
[Fact]
public void RawSystemIo_IsStillRejectedByTheTrustGate()
{
@@ -274,8 +315,15 @@ public sealed class ScriptFileReaderTests : IDisposable
private sealed class StaticMonitor(SiteRuntimeOptions value) : IOptionsMonitor<SiteRuntimeOptions>
{
/// <summary>Gets the fixed options instance.</summary>
public SiteRuntimeOptions CurrentValue => value;
/// <summary>Returns the fixed options instance regardless of name.</summary>
/// <param name="name">The options name, ignored.</param>
/// <returns>The fixed options instance.</returns>
public SiteRuntimeOptions Get(string? name) => value;
/// <summary>Ignores the listener because the options never change.</summary>
/// <param name="listener">The change listener, ignored.</param>
/// <returns>Always <see langword="null"/>.</returns>
public IDisposable? OnChange(Action<SiteRuntimeOptions, string?> listener) => null;
}
}