Address PR feedback: simplify IConsole, rename to FakeConsole, make console required, remove SizeCapturingStream

Agent-Logs-Url: https://github.com/304NotModified/SLNX-validator/sessions/d2fc4b14-e446-4e41-8704-97bcd27ae058

Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>

Author: Copilot

src/SLNX-validator/IConsole.cs

@@ -1,12 +1,7 @@
 namespace JulianVerdurmen.SlnxValidator;
 
-internal interface IStandardStreamWriter
-{
-    void Write(string value);
-}
-
 internal interface IConsole
 {
-    IStandardStreamWriter Out { get; }
-    IStandardStreamWriter Error { get; }
+    Task WriteAsync(string value);
+    Task WriteErrorAsync(string value);
 }

src/SLNX-validator/SystemConsole.cs

@@ -2,11 +2,6 @@ namespace JulianVerdurmen.SlnxValidator;
 
 internal sealed class SystemConsole : IConsole
 {
-    public IStandardStreamWriter Out { get; } = new ConsoleStreamWriter(Console.Out);
-    public IStandardStreamWriter Error { get; } = new ConsoleStreamWriter(Console.Error);
-
-    private sealed class ConsoleStreamWriter(TextWriter writer) : IStandardStreamWriter
-    {
-        public void Write(string value) => writer.Write(value);
-    }
+    public Task WriteAsync(string value) => Console.Out.WriteAsync(value);
+    public Task WriteErrorAsync(string value) => Console.Error.WriteAsync(value);
 }

src/SLNX-validator/ValidatorRunner.cs

@@ -23,7 +23,7 @@ public async Task<int> RunAsync(ValidatorRunnerOptions options, CancellationToke
 
         if (results.Count == 0)
         {
-            console.Error.Write($"No .slnx files found for input: {options.Input}{Environment.NewLine}");
+            await console.WriteErrorAsync($"No .slnx files found for input: {options.Input}{Environment.NewLine}");
             return options.ContinueOnError ? 0 : 1;
         }
 
@@ -34,14 +34,14 @@ public async Task<int> RunAsync(ValidatorRunnerOptions options, CancellationToke
         {
             await sonarReporter.WriteReportAsync(reportResults, options.SonarqubeReportPath);
             var size = fileSystem.GetFileSize(options.SonarqubeReportPath);
-            console.Out.Write($"SonarQube report written to: {options.SonarqubeReportPath} ({size} bytes){Environment.NewLine}");
+            await console.WriteAsync($"SonarQube report written to: {options.SonarqubeReportPath} ({size} bytes){Environment.NewLine}");
         }
 
         if (options.SarifReportPath is not null)
         {
             await sarifReporter.WriteReportAsync(reportResults, options.SarifReportPath);
             var size = fileSystem.GetFileSize(options.SarifReportPath);
-            console.Out.Write($"SARIF report written to: {options.SarifReportPath} ({size} bytes){Environment.NewLine}");
+            await console.WriteAsync($"SARIF report written to: {options.SarifReportPath} ({size} bytes){Environment.NewLine}");
         }
 
         var hasErrors = results.Any(r => r.Errors.Any(e => options.SeverityOverrides.IsFailingError(e.Code)));

tests/SLNX-validator.Tests/FakeConsole.cs

@@ -0,0 +1,10 @@
+namespace JulianVerdurmen.SlnxValidator.Tests;
+
+internal sealed class FakeConsole : IConsole
+{
+    public List<string> Output { get; } = [];
+    public List<string> ErrorOutput { get; } = [];
+
+    public Task WriteAsync(string value) { Output.Add(value); return Task.CompletedTask; }
+    public Task WriteErrorAsync(string value) { ErrorOutput.Add(value); return Task.CompletedTask; }
+}

tests/SLNX-validator.Tests/MockFileSystem.cs

@@ -7,7 +7,6 @@ internal sealed class MockFileSystem : IFileSystem
 {
     private readonly HashSet<string> _existingPaths;
     private readonly Dictionary<string, string> _fileContents;
-    private readonly Dictionary<string, long> _fileSizes = new(StringComparer.OrdinalIgnoreCase);
 
     /// <summary>Create a mock with files that exist but have no specific content.</summary>
     public MockFileSystem(params string[] existingPaths)
@@ -35,44 +34,12 @@ public Stream CreateFile(string path)
     {
         var ms = new MemoryStream();
         CreatedFiles[path] = ms;
-        return new SizeCapturingStream(ms, size => _fileSizes[path] = size);
+        return ms;
     }
     public Stream OpenRead(string path) =>
         new MemoryStream(Encoding.UTF8.GetBytes(_fileContents.GetValueOrDefault(path, "")));
     public Task<string> ReadAllTextAsync(string path, CancellationToken cancellationToken = default) =>
         Task.FromResult(_fileContents.GetValueOrDefault(path, ""));
-    public long GetFileSize(string path) =>
-        _fileSizes.TryGetValue(path, out var size) ? size :
-        CreatedFiles.TryGetValue(path, out var ms) ? ms.Length : 0;
-
-    /// <summary>Captures the stream length before disposing the underlying <see cref="MemoryStream"/>.</summary>
-    private sealed class SizeCapturingStream(MemoryStream inner, Action<long> onDispose) : Stream
-    {
-        public override bool CanRead => inner.CanRead;
-        public override bool CanSeek => inner.CanSeek;
-        public override bool CanWrite => inner.CanWrite;
-        public override long Length => inner.Length;
-        public override long Position { get => inner.Position; set => inner.Position = value; }
-        public override void Flush() => inner.Flush();
-        public override int Read(byte[] buffer, int offset, int count) => inner.Read(buffer, offset, count);
-        public override long Seek(long offset, SeekOrigin origin) => inner.Seek(offset, origin);
-        public override void SetLength(long value) => inner.SetLength(value);
-        public override void Write(byte[] buffer, int offset, int count) => inner.Write(buffer, offset, count);
-        public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) =>
-            inner.WriteAsync(buffer, offset, count, cancellationToken);
-        public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default) =>
-            inner.WriteAsync(buffer, cancellationToken);
-        public override Task FlushAsync(CancellationToken cancellationToken) => inner.FlushAsync(cancellationToken);
-
-        protected override void Dispose(bool disposing)
-        {
-            if (disposing)
-            {
-                onDispose(inner.Length);
-                inner.Dispose();
-            }
-            base.Dispose(disposing);
-        }
-    }
+    public long GetFileSize(string path) => 0;
 }
 

tests/SLNX-validator.Tests/TestConsole.cs

@@ -9,22 +9,22 @@ namespace JulianVerdurmen.SlnxValidator.Tests;
 
 public class ValidatorRunnerTests
 {
-    private static ValidatorRunner CreateRunner(IFileSystem fileSystem, IRequiredFilesChecker? checker = null, IConsole? console = null)
+    private static ValidatorRunner CreateRunner(IFileSystem fileSystem, IConsole console, IRequiredFilesChecker? checker = null)
     {
         checker ??= Substitute.For<IRequiredFilesChecker>();
         var resolver = Substitute.For<ISlnxFileResolver>();
         var collector = new SlnxCollector(fileSystem, resolver, Substitute.For<ISlnxValidator>(), checker);
         var sonarReporter = new SonarReporter(fileSystem);
         var sarifReporter = new SarifReporter(fileSystem);
-        return new ValidatorRunner(collector, sonarReporter, sarifReporter, checker, fileSystem, console ?? new TestConsole());
+        return new ValidatorRunner(collector, sonarReporter, sarifReporter, checker, fileSystem, console);
     }
 
     private static ValidatorRunnerOptions Options(string input = "test.slnx",
         bool continueOnError = false, string? requiredFilesPattern = null) =>
         new(input, SonarqubeReportPath: null, continueOnError, requiredFilesPattern, WorkingDirectory: ".");
 
     private static ValidatorRunner CreateRunnerWithSlnx(
-        string slnxPath, string slnxContent, IRequiredFilesChecker? checker = null, IConsole? console = null)
+        string slnxPath, string slnxContent, IConsole console, IRequiredFilesChecker? checker = null)
     {
         checker ??= Substitute.For<IRequiredFilesChecker>();
         var fileSystem = new MockFileSystem(new Dictionary<string, string>
@@ -39,7 +39,7 @@ private static ValidatorRunner CreateRunnerWithSlnx(
         var collector = new SlnxCollector(fileSystem, resolver, validator, checker);
         var sonarReporter = new SonarReporter(fileSystem);
         var sarifReporter = new SarifReporter(fileSystem);
-        return new ValidatorRunner(collector, sonarReporter, sarifReporter, checker, fileSystem, console ?? new TestConsole());
+        return new ValidatorRunner(collector, sonarReporter, sarifReporter, checker, fileSystem, console);
     }
 
     #region RunAsync – file resolution
@@ -48,7 +48,7 @@ private static ValidatorRunner CreateRunnerWithSlnx(
     public async Task RunAsync_FileNotFound_ContinueOnErrorFalse_ReturnsOne()
     {
         // Arrange
-        var runner = CreateRunner(new MockFileSystem());
+        var runner = CreateRunner(new MockFileSystem(), new FakeConsole());
 
         // Act
         var exitCode = await runner.RunAsync(Options("nonexistent.slnx"), CancellationToken.None);
@@ -61,7 +61,7 @@ public async Task RunAsync_FileNotFound_ContinueOnErrorFalse_ReturnsOne()
     public async Task RunAsync_FileNotFound_ContinueOnErrorTrue_ReturnsZero()
     {
         // Arrange
-        var runner = CreateRunner(new MockFileSystem());
+        var runner = CreateRunner(new MockFileSystem(), new FakeConsole());
 
         // Act
         var exitCode = await runner.RunAsync(Options("nonexistent.slnx", continueOnError: true), CancellationToken.None);
@@ -74,7 +74,7 @@ public async Task RunAsync_FileNotFound_ContinueOnErrorTrue_ReturnsZero()
     public async Task RunAsync_NoFilesFound_ContinueOnErrorFalse_ReturnsOne()
     {
         // Arrange
-        var runner = CreateRunner(new MockFileSystem());
+        var runner = CreateRunner(new MockFileSystem(), new FakeConsole());
 
         // Act
         var exitCode = await runner.RunAsync(Options("src/*.slnx"), CancellationToken.None);
@@ -87,7 +87,7 @@ public async Task RunAsync_NoFilesFound_ContinueOnErrorFalse_ReturnsOne()
     public async Task RunAsync_NoFilesFound_ContinueOnErrorTrue_ReturnsZero()
     {
         // Arrange
-        var runner = CreateRunner(new MockFileSystem());
+        var runner = CreateRunner(new MockFileSystem(), new FakeConsole());
 
         // Act
         var exitCode = await runner.RunAsync(Options("src/*.slnx", continueOnError: true), CancellationToken.None);
@@ -114,7 +114,7 @@ public async Task RunAsync_RequiredFiles_AllMatchedAndReferenced_ReturnsZero()
         checker.CheckInSlnx(Arg.Any<IReadOnlyList<string>>(), Arg.Any<SlnxFile>())
             .Returns([]);
 
-        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", checker);
+        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", new FakeConsole(), checker);
 
         // Act
         var exitCode = await runner.RunAsync(
@@ -134,7 +134,7 @@ public async Task RunAsync_RequiredFiles_NoMatchOnDisk_ReturnsOne()
         checker.ResolveMatchedPaths(Arg.Any<string>(), Arg.Any<string>())
             .Returns([]); // nothing matched on disk
 
-        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", checker);
+        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", new FakeConsole(), checker);
 
         // Act
         var exitCode = await runner.RunAsync(
@@ -155,7 +155,7 @@ public async Task RunAsync_RequiredFiles_NoMatchOnDisk_ReturnsOne()
     public async Task RunAsync_IgnoreAllCodes_WithErrors_ReturnsZero()
     {
         // Arrange: file with wrong extension generates SLNX002; --ignore * suppresses all codes
-        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
+        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />", new FakeConsole());
         var overrides = SeverityOverridesParser.Parse(null, null, null, null, null, ignore: "*");
 
         // Act
@@ -171,7 +171,7 @@ public async Task RunAsync_IgnoreAllCodes_WithErrors_ReturnsZero()
     public async Task RunAsync_IgnoreSpecificCode_ThatCodeDoesNotCauseExitOne()
     {
         // Arrange: --ignore SLNX002 suppresses the InvalidExtension error
-        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
+        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />", new FakeConsole());
         var overrides = SeverityOverridesParser.Parse(null, null, null, null, null, ignore: "SLNX002");
 
         // Act
@@ -187,7 +187,7 @@ public async Task RunAsync_IgnoreSpecificCode_ThatCodeDoesNotCauseExitOne()
     public async Task RunAsync_MinorOverrideForErrorCode_ReturnsZero()
     {
         // Arrange: --minor SLNX002 downgrades InvalidExtension to non-failing severity
-        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
+        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />", new FakeConsole());
         var overrides = SeverityOverridesParser.Parse(null, null, null, minor: "SLNX002", null, null);
 
         // Act
@@ -203,7 +203,7 @@ public async Task RunAsync_MinorOverrideForErrorCode_ReturnsZero()
     public async Task RunAsync_InfoAllCodes_ReturnsZero()
     {
         // Arrange: --info * downgrades all codes to INFO (non-failing)
-        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
+        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />", new FakeConsole());
         var overrides = SeverityOverridesParser.Parse(null, null, null, null, info: "*", null);
 
         // Act
@@ -219,7 +219,7 @@ public async Task RunAsync_InfoAllCodes_ReturnsZero()
     public async Task RunAsync_InfoAllCodesMajorSpecificCode_SpecificCodeCausesExitOne()
     {
         // Arrange: --info * --major SLNX002  →  SLNX002 stays MAJOR (specific overrides wildcard)
-        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
+        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />", new FakeConsole());
         var overrides = SeverityOverridesParser.Parse(null, null, major: "SLNX002", null, info: "*", null);
 
         // Act
@@ -235,7 +235,7 @@ public async Task RunAsync_InfoAllCodesMajorSpecificCode_SpecificCodeCausesExitO
     public async Task RunAsync_IgnoreAllCodesMajorSpecificCode_SpecificCodeCausesExitOne()
     {
         // Arrange: --ignore * --major SLNX002  →  SLNX002 is MAJOR (specific wins over wildcard ignore)
-        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />");
+        var runner = CreateRunnerWithSlnx("test.xml", "<Solution />", new FakeConsole());
         var overrides = SeverityOverridesParser.Parse(null, null, major: "SLNX002", null, null, ignore: "*");
 
         // Act
@@ -255,40 +255,40 @@ public async Task RunAsync_IgnoreAllCodesMajorSpecificCode_SpecificCodeCausesExi
     public async Task RunAsync_NoFilesFound_WritesErrorToConsole()
     {
         // Arrange
-        var console = new TestConsole();
-        var runner = CreateRunner(new MockFileSystem(), console: console);
+        var console = new FakeConsole();
+        var runner = CreateRunner(new MockFileSystem(), console);
 
         // Act
         await runner.RunAsync(Options("nonexistent.slnx"), CancellationToken.None);
 
         // Assert
-        console.Error.ToString().Should().Contain("No .slnx files found for input: nonexistent.slnx");
+        console.ErrorOutput.Should().ContainMatch("*No .slnx files found for input: nonexistent.slnx*");
     }
 
     [Test]
     public async Task RunAsync_SonarqubeReportPath_WritesConfirmationToConsole()
     {
         // Arrange
         var slnxPath = Path.GetFullPath("test.slnx");
-        var console = new TestConsole();
-        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", console: console);
+        var console = new FakeConsole();
+        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", console);
         var options = new ValidatorRunnerOptions(slnxPath, SonarqubeReportPath: "report.xml",
             ContinueOnError: false, RequiredFilesPattern: null, WorkingDirectory: ".");
 
         // Act
         await runner.RunAsync(options, CancellationToken.None);
 
         // Assert
-        console.Out.ToString().Should().Contain("SonarQube report written to: report.xml");
+        console.Output.Should().ContainMatch("*SonarQube report written to: report.xml*");
     }
 
     [Test]
     public async Task RunAsync_SarifReportPath_WritesConfirmationToConsole()
     {
         // Arrange
         var slnxPath = Path.GetFullPath("test.slnx");
-        var console = new TestConsole();
-        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", console: console);
+        var console = new FakeConsole();
+        var runner = CreateRunnerWithSlnx(slnxPath, "<Solution />", console);
         var options = new ValidatorRunnerOptions(slnxPath, SonarqubeReportPath: null,
             ContinueOnError: false, RequiredFilesPattern: null, WorkingDirectory: ".",
             SarifReportPath: "report.sarif");
@@ -297,7 +297,7 @@ public async Task RunAsync_SarifReportPath_WritesConfirmationToConsole()
         await runner.RunAsync(options, CancellationToken.None);
 
         // Assert
-        console.Out.ToString().Should().Contain("SARIF report written to: report.sarif");
+        console.Output.Should().ContainMatch("*SARIF report written to: report.sarif*");
     }
 
     #endregion