Write logs + status on stderr and content on stdout

0xced · 0xced · commit a487b7683e0d · 2025-06-26T10:13:08.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 * Fixed an issue where a project reference (blue) could be wrongly identified as package reference (green)
 * Removed the `--no-browser` option, replaced with the `-u|--url` option
+* Logs and status are now written to stderr. Only actual content is written to stdout, i.e.
+  * The graph URL when `--url print` is used
+  * The output of the `--help` and `--version` options
 
 ## [0.3.0][0.3.0] - 2025-06-24
 
diff --git a/src/nugraph/GraphCommand.cs b/src/nugraph/GraphCommand.cs
@@ -29,16 +29,19 @@ internal sealed partial class FileOrPackage : OneOfBase<FileSystemInfo, PackageI
 [SuppressMessage("ReSharper", "ClassNeverInstantiated.Global", Justification = "Instantiated by Spectre.Console.Cli through reflection")]
 [SuppressMessage("Performance", "CA1812:Avoid uninstantiated internal classes", Justification = "Instantiated by Spectre.Console.Cli through reflection")]
 [Description("Generates dependency graphs for .NET projects and NuGet packages.")]
-internal sealed class GraphCommand(IAnsiConsole console, DirectoryInfo currentWorkingDirectory, TextWriter stdOut, CancellationToken cancellationToken) : CancelableCommand<GraphCommandSettings>(cancellationToken)
+internal sealed class GraphCommand(ProgramEnvironment environment, CancellationToken cancellationToken) : CancelableCommand<GraphCommandSettings>(cancellationToken)
 {
     protected override async Task<int> ExecuteAsync(CommandContext commandContext, GraphCommandSettings settings, CancellationToken cancellationToken)
     {
+        var stdOut = environment.StdOut;
+        var console = environment.ConsoleErr;
+
         if (settings.Diagnose)
         {
-            return await DiagnoseAsync(settings.Sdk, cancellationToken);
+            return await DiagnoseAsync(stdOut, settings.Sdk, cancellationToken);
         }
 
-        var source = settings.Source ?? currentWorkingDirectory;
+        var source = settings.Source ?? environment.CurrentWorkingDirectory;
         var graphUrl = await console.Status().StartAsync($"Generating dependency graph for {source}".EscapeMarkup(), async context =>
         {
             var graph = await source.Match(
@@ -71,7 +74,7 @@ protected override async Task<int> ExecuteAsync(CommandContext commandContext, G
         return 0;
     }
 
-    private async Task<int> DiagnoseAsync(DirectoryInfo? sdk, CancellationToken cancellationToken)
+    private static async Task<int> DiagnoseAsync(TextWriter stdOut, DirectoryInfo? sdk, CancellationToken cancellationToken)
     {
         await stdOut.WriteLineAsync("nugraph:");
         await stdOut.WriteLineAsync($" Version:  {typeof(Program).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ?? "N/A"}");
diff --git a/src/nugraph/Program.cs b/src/nugraph/Program.cs
@@ -9,9 +9,11 @@
 
 namespace nugraph;
 
-public class Program(DirectoryInfo currentWorkingDirectory, IAnsiConsole consoleOut, IAnsiConsole consoleErr, TextWriter stdOut)
+public record ProgramEnvironment(DirectoryInfo CurrentWorkingDirectory, IAnsiConsole ConsoleOut, IAnsiConsole ConsoleErr, TextWriter StdOut);
+
+public class Program(ProgramEnvironment environment)
 {
-    public Program() : this(new DirectoryInfo(Environment.CurrentDirectory), RedirectionFriendlyConsole.Out, RedirectionFriendlyConsole.Error, Console.Out)
+    public Program() : this(new ProgramEnvironment(new DirectoryInfo(Environment.CurrentDirectory), RedirectionFriendlyConsole.Out, RedirectionFriendlyConsole.Error, Console.Out))
     {
     }
 
@@ -48,12 +50,12 @@ public async Task<int> RunAsync(string[] args)
             var version = assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ?? assembly.GetName().Version?.ToString() ?? "N/A";
             config.SetApplicationName(OperatingSystem.IsWindows() ? "nugraph.exe" : "nugraph");
             config.SetApplicationVersion(SemanticVersion.TryParse(version, out var semanticVersion) ? semanticVersion.ToNormalizedString() : version);
-            config.ConfigureConsole(consoleOut);
-            config.Settings.Registrar.RegisterInstance(currentWorkingDirectory);
-            config.Settings.Registrar.RegisterInstance(stdOut);
+            config.ConfigureConsole(environment.ConsoleOut);
+            config.Settings.Registrar.RegisterInstance(environment);
             config.Settings.Registrar.RegisterInstance(cancellationTokenSource.Token);
             config.SetExceptionHandler((exception, _) =>
             {
+                var consoleErr = environment.ConsoleErr;
                 switch (exception)
                 {
                     case OperationCanceledException when cancellationTokenSource.IsCancellationRequested:
diff --git a/tests/nugraph.Tests/NugraphAssertions.cs b/tests/nugraph.Tests/NugraphAssertions.cs
@@ -27,22 +27,19 @@ public class NugraphAssertions(NugraphResult instance, AssertionChain chain) :
     protected override string Identifier => "result";
 
     /// <summary>
-    /// Asserts that the nugraph result is successful.
-    /// <list type="bullet">
-    /// <item>Ensures that exit code is 0.</item>
-    /// <item>Ensures that stderr is empty.</item>
-    /// <item>Ensures that stdout matches the provided pattern.</item>
-    /// </list>
+    /// Asserts that the nugraph result matches the exit code, stdout and stderr content.
     /// </summary>
-    /// <param name="stdOutPattern">The expected pattern that must be written on stdout.</param>
+    /// <param name="exitCode">The expected exit code.</param>
+    /// <param name="stdOutPattern">The expected pattern that must be written on stdout or an empty string to assert that nothing was written.</param>
+    /// <param name="stdErrPattern">The expected pattern that must be written on stderr or an empty string to assert that nothing was written.</param>
     /// <param name="because">
     /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
     /// </param>
     /// <param name="becauseArgs">
     /// Zero or more objects to format using the placeholders in <paramref name="because" />.
     /// </param>
     [CustomAssertion]
-    public AndConstraint<NugraphAssertions> Succeed(string stdOutPattern, [StringSyntax("CompositeFormat")] string because = "", params object[] becauseArgs)
+    public AndConstraint<NugraphAssertions> Match(int exitCode = 0, string stdOutPattern = "", string stdErrPattern = "", [StringSyntax("CompositeFormat")] string because = "", params object[] becauseArgs)
     {
         string[] failures = [];
 
@@ -51,9 +48,19 @@ public AndConstraint<NugraphAssertions> Succeed(string stdOutPattern, [StringSyn
             .ForCondition(result =>
             {
                 using var scope = new AssertionScope();
-                result.ExitCode.Should().Be(0, because, becauseArgs);
-                result.StdErr.Should().BeEmpty(because, becauseArgs);
-                result.StdOut.Should().MatchEquivalentOf(stdOutPattern, opt => opt.IgnoringNewlineStyle(), because, becauseArgs);
+
+                result.ExitCode.Should().Be(exitCode, because, becauseArgs);
+
+                if (string.IsNullOrEmpty(stdOutPattern))
+                    result.StdOut.Should().BeEmpty(because, becauseArgs);
+                else
+                    result.StdOut.Should().MatchEquivalentOf(stdOutPattern, opt => opt.IgnoringNewlineStyle(), because, becauseArgs);
+
+                if (string.IsNullOrEmpty(stdErrPattern))
+                    result.StdErr.Should().BeEmpty(because, becauseArgs);
+                else
+                    result.StdErr.Should().MatchEquivalentOf(stdErrPattern, opt => opt.IgnoringNewlineStyle(), because, becauseArgs);
+
                 failures = scope.Discard();
 
                 return failures.Length == 0;
@@ -100,40 +107,4 @@ public AndConstraint<NugraphAssertions> UrlHasDiagram(string expectedDiagram, [S
 
         return new AndConstraint<NugraphAssertions>(this);
     }
-
-    /// <summary>
-    /// Asserts that the nugraph result is a failure.
-    /// <list type="bullet">
-    /// <item>Ensures that exit code is <paramref name="failCode"/>.</item>
-    /// <item>Ensures that stderr matches the provided pattern.</item>
-    /// </list>
-    /// </summary>
-    /// <param name="failCode">The expected exit code.</param>
-    /// <param name="stdErrPattern">The expected pattern that must be written on stderr.</param>
-    /// <param name="because">
-    /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
-    /// </param>
-    /// <param name="becauseArgs">
-    /// Zero or more objects to format using the placeholders in <paramref name="because" />.
-    /// </param>
-    [CustomAssertion]
-    public AndConstraint<NugraphAssertions> Fail(int failCode, string stdErrPattern, string because = "", params object[] becauseArgs)
-    {
-        string[] failures = [];
-
-        _chain
-            .Given(() => Subject)
-            .ForCondition(result =>
-            {
-                using var scope = new AssertionScope();
-                result.ExitCode.Should().Be(failCode, because, becauseArgs);
-                result.StdErr.Should().MatchEquivalentOf(stdErrPattern, opt => opt.IgnoringNewlineStyle(), because, becauseArgs);
-                failures = scope.Discard();
-
-                return failures.Length == 0;
-            })
-            .FailWith(string.Join(Environment.NewLine, failures.Select(e => e.Replace("{", "{{").Replace("}", "}}"))));
-
-        return new AndConstraint<NugraphAssertions>(this);
-    }
 }
diff --git a/tests/nugraph.Tests/NugraphProgram.cs b/tests/nugraph.Tests/NugraphProgram.cs
@@ -24,7 +24,7 @@ public override async Task<NugraphResult> RunAsync(string[] arguments, string? w
         using var consoleErr = new TestConsole();
         consoleErr.Profile.Width = 256;
         await using var stdOut = new StringWriter();
-        var program = new Program(new DirectoryInfo(workingDirectory ?? Environment.CurrentDirectory), consoleOut, consoleErr, stdOut);
+        var program = new Program(new ProgramEnvironment(new DirectoryInfo(workingDirectory ?? Environment.CurrentDirectory), consoleOut, consoleErr, stdOut));
         var args = arguments.Append("--log").Append(logLevel.ToString()).Append("--url").Append(action.ToString()).ToArray();
         var exitCode = await program.RunAsync(args);
         return new NugraphResult(exitCode, GetOutput(consoleOut, stdOut), GetOutput(consoleErr, null));
diff --git a/tests/nugraph.Tests/NugraphTests.cs b/tests/nugraph.Tests/NugraphTests.cs
@@ -1,7 +1,5 @@
 using System.IO;
 using System.Threading.Tasks;
-using AwesomeAssertions;
-using AwesomeAssertions.Execution;
 using NuGet.Common;
 
 namespace nugraph.Tests;
@@ -15,34 +13,33 @@ public async Task Diagnose()
 
         await File.WriteAllTextAsync($"{nugraph.GetType().Name}.diagnostics.txt", result.StdOut);
 
-        result.Should().Succeed("nugraph:*");
+        result.Should().Match(stdOutPattern: "nugraph:*");
     }
 
     [Test]
     public async Task Version()
     {
         var result = await nugraph.RunAsync(["--version"]);
 
-        result.Should().Succeed(nugraph.Version);
+        result.Should().Match(stdOutPattern: nugraph.Version);
     }
 
     [Test]
     public async Task Help()
     {
         var result = await nugraph.RunAsync(["--help"]);
 
-        result.Should().Succeed("*nugraph*[SOURCE]*");
+        result.Should().Match(stdOutPattern: "*nugraph*[SOURCE]*");
     }
 
     [Test]
     public async Task Package_Serilog()
     {
         var result = await nugraph.RunAsync(["Serilog"]);
 
-        result.Should().Succeed("""
+        result.Should().Match(stdOutPattern:"https://mermaid.live/view#pako:*", stdErrPattern: """
                                 Generating dependency graph for Serilog
                                 Generating dependency graph for Serilog *
-                                https://mermaid.live/view#pako:*
                                 """);
     }
 
@@ -51,10 +48,9 @@ public async Task Package_Serilog_430_net60()
     {
         var result = await nugraph.RunAsync(["Serilog/4.3.0", "--framework", "net6.0"]);
 
-        result.Should().Succeed("""
+        result.Should().Match(stdOutPattern: "https://mermaid.live/view#pako:*", stdErrPattern: """
                                 Generating dependency graph for Serilog 4.3.0
                                 Generating dependency graph for Serilog 4.3.0 (net6.0)
-                                https://mermaid.live/view#pako:*
                                 """)
             .And.UrlHasDiagram("""
                                ---
@@ -81,10 +77,9 @@ public async Task Package_DockerRunner_MermaidSvg()
     {
         var result = await nugraph.RunAsync(["DockerRunner", "--format", "mmd.svg"]);
 
-        result.Should().Succeed("""
+        result.Should().Match(stdOutPattern:"https://mermaid.ink/svg/pako:*", stdErrPattern: """
                                 Generating dependency graph for DockerRunner
                                 Generating dependency graph for DockerRunner 1.0.0-beta.2 (netstandard2.0)
-                                https://mermaid.ink/svg/pako:*
                                 """);
     }
 
@@ -93,10 +88,9 @@ public async Task Package_DockerRunner_GraphvizSvg()
     {
         var result = await nugraph.RunAsync(["DockerRunner", "--format", "dot.svg"]);
 
-        result.Should().Succeed("""
+        result.Should().Match(stdOutPattern:"https://kroki.io/graphviz/svg/*", stdErrPattern: """
                                 Generating dependency graph for DockerRunner
                                 Generating dependency graph for DockerRunner 1.0.0-beta.2 (netstandard2.0)
-                                https://kroki.io/graphviz/svg/*
                                 """);
     }
 
@@ -105,47 +99,35 @@ public async Task Package_DoesNotExist()
     {
         var result = await nugraph.RunAsync(["DoesNotExist"], logLevel: LogLevel.Debug);
 
-        using (new AssertionScope())
-        {
-            result.Should().Fail(66, "Package DoesNotExist was not found*nuget.org [https://api.nuget.org/v3/index.json]*");
-            result.StdOut.Should().ContainAll(
-                "Retrieving DependencyInfoResource for nuget.org",
-                "Resolving DoesNotExist with NuGet.Protocol.DependencyInfoResourceV3",
-                "Generating dependency graph for DoesNotExist");
-        }
+        result.Should().Match(66, stdErrPattern: """
+                                                 *Retrieving DependencyInfoResource for nuget.org*
+                                                 *Resolving DoesNotExist with NuGet.Protocol.DependencyInfoResourceV3*
+                                                 *Package DoesNotExist was not found*nuget.org [https://api.nuget.org/v3/index.json]*
+                                                 """);
     }
 
     [Test]
     public async Task Project_nugraph_WorkingDirectory()
     {
         var result = await nugraph.RunAsync(["-m", "gv"], workingDirectory: RepositoryDirectories.GetPath("src", "nugraph"));
 
-        result.Should().Succeed("""
-                                Generating dependency graph for nugraph
-                                https://edotor.net/#deflate:*
-                                """);
+        result.Should().Match(stdOutPattern: "https://edotor.net/#deflate:*", stdErrPattern: "Generating dependency graph for nugraph");
     }
 
     [Test]
     public async Task Project_nugraph_ExplicitDirectory()
     {
         var result = await nugraph.RunAsync([RepositoryDirectories.GetPath("src", "nugraph"), "-m", "graphviz"]);
 
-        result.Should().Succeed("""
-                                Generating dependency graph for nugraph
-                                https://edotor.net/#deflate:*
-                                """);
+        result.Should().Match(stdOutPattern: "https://edotor.net/#deflate:*", stdErrPattern: "Generating dependency graph for nugraph");
     }
 
     [Test]
     public async Task Project_mmd_ProjectFile()
     {
         var result = await nugraph.RunAsync([RepositoryDirectories.GetPath("tools", "mmd", "mmd.csproj"), "-m", "dot"]);
 
-        result.Should().Succeed("""
-                                Generating dependency graph for mmd.csproj
-                                https://edotor.net/#deflate:*
-                                """)
+        result.Should().Match(stdOutPattern: "https://edotor.net/#deflate:*", stdErrPattern: "Generating dependency graph for mmd.csproj")
             .And.UrlHasDiagram("""
                                # Generated by https://github.com/0xced/nugraph
                                
@@ -169,20 +151,22 @@ public async Task Project_SolutionFile()
     {
         var result = await nugraph.RunAsync([], workingDirectory: RepositoryDirectories.GetPath());
 
-        result.Should().Fail(65, """
-                                 Solution files are not supported.
-                                 Please run nugraph in a directory that contains a single project file or pass an explicit project file as the first argument.
-                                 """);
+        result.Should().Match(65, stdErrPattern: """
+                                                 Generating dependency graph for nugraph
+                                                 Solution files are not supported.
+                                                 Please run nugraph in a directory that contains a single project file or pass an explicit project file as the first argument.
+                                                 """);
     }
 
     [Test]
     public async Task Project_NoProject()
     {
         var result = await nugraph.RunAsync([], workingDirectory: RepositoryDirectories.GetPath("resources"));
 
-        result.Should().Fail(65, """
-                                 The current working directory does not contain a project file.
-                                 Please run nugraph in a directory that contains a single project file or pass an explicit project file as the first argument.
-                                 """);
+        result.Should().Match(65, stdErrPattern: """
+                                                 Generating dependency graph for resources
+                                                 The current working directory does not contain a project file.
+                                                 Please run nugraph in a directory that contains a single project file or pass an explicit project file as the first argument.
+                                                 """);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,16 +29,19 @@ internal sealed partial class FileOrPackage : OneOfBase<FileSystemInfo, PackageI`
`29`	`29`	`[SuppressMessage("ReSharper", "ClassNeverInstantiated.Global", Justification = "Instantiated by Spectre.Console.Cli through reflection")]`
`30`	`30`	`[SuppressMessage("Performance", "CA1812:Avoid uninstantiated internal classes", Justification = "Instantiated by Spectre.Console.Cli through reflection")]`
`31`	`31`	`[Description("Generates dependency graphs for .NET projects and NuGet packages.")]`
`32`		`-internal sealed class GraphCommand(IAnsiConsole console, DirectoryInfo currentWorkingDirectory, TextWriter stdOut, CancellationToken cancellationToken) : CancelableCommand<GraphCommandSettings>(cancellationToken)`
	`32`	`+internal sealed class GraphCommand(ProgramEnvironment environment, CancellationToken cancellationToken) : CancelableCommand<GraphCommandSettings>(cancellationToken)`
`33`	`33`	`{`
`34`	`34`	`protected override async Task<int> ExecuteAsync(CommandContext commandContext, GraphCommandSettings settings, CancellationToken cancellationToken)`
`35`	`35`	`{`
	`36`	`+ var stdOut = environment.StdOut;`
	`37`	`+ var console = environment.ConsoleErr;`
	`38`	`+`
`36`	`39`	`if (settings.Diagnose)`
`37`	`40`	`{`
`38`		`- return await DiagnoseAsync(settings.Sdk, cancellationToken);`
	`41`	`+ return await DiagnoseAsync(stdOut, settings.Sdk, cancellationToken);`
`39`	`42`	`}`
`40`	`43`
`41`		`- var source = settings.Source ?? currentWorkingDirectory;`
	`44`	`+ var source = settings.Source ?? environment.CurrentWorkingDirectory;`
`42`	`45`	`var graphUrl = await console.Status().StartAsync($"Generating dependency graph for {source}".EscapeMarkup(), async context =>`
`43`	`46`	`{`
`44`	`47`	`var graph = await source.Match(`
`@@ -71,7 +74,7 @@ protected override async Task<int> ExecuteAsync(CommandContext commandContext, G`
`71`	`74`	`return 0;`
`72`	`75`	`}`
`73`	`76`
`74`		`- private async Task<int> DiagnoseAsync(DirectoryInfo? sdk, CancellationToken cancellationToken)`
	`77`	`+ private static async Task<int> DiagnoseAsync(TextWriter stdOut, DirectoryInfo? sdk, CancellationToken cancellationToken)`
`75`	`78`	`{`
`76`	`79`	`await stdOut.WriteLineAsync("nugraph:");`
`77`	`80`	`await stdOut.WriteLineAsync($" Version: {typeof(Program).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ?? "N/A"}");`
Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,11 @@`
`9`	`9`
`10`	`10`	`namespace nugraph;`
`11`	`11`
`12`		`-public class Program(DirectoryInfo currentWorkingDirectory, IAnsiConsole consoleOut, IAnsiConsole consoleErr, TextWriter stdOut)`
	`12`	`+public record ProgramEnvironment(DirectoryInfo CurrentWorkingDirectory, IAnsiConsole ConsoleOut, IAnsiConsole ConsoleErr, TextWriter StdOut);`
	`13`	`+`
	`14`	`+public class Program(ProgramEnvironment environment)`
`13`	`15`	`{`
`14`		`- public Program() : this(new DirectoryInfo(Environment.CurrentDirectory), RedirectionFriendlyConsole.Out, RedirectionFriendlyConsole.Error, Console.Out)`
	`16`	`+ public Program() : this(new ProgramEnvironment(new DirectoryInfo(Environment.CurrentDirectory), RedirectionFriendlyConsole.Out, RedirectionFriendlyConsole.Error, Console.Out))`
`15`	`17`	`{`
`16`	`18`	`}`
`17`	`19`
`@@ -48,12 +50,12 @@ public async Task<int> RunAsync(string[] args)`
`48`	`50`	`var version = assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ?? assembly.GetName().Version?.ToString() ?? "N/A";`
`49`	`51`	`config.SetApplicationName(OperatingSystem.IsWindows() ? "nugraph.exe" : "nugraph");`
`50`	`52`	`config.SetApplicationVersion(SemanticVersion.TryParse(version, out var semanticVersion) ? semanticVersion.ToNormalizedString() : version);`
`51`		`- config.ConfigureConsole(consoleOut);`
`52`		`- config.Settings.Registrar.RegisterInstance(currentWorkingDirectory);`
`53`		`- config.Settings.Registrar.RegisterInstance(stdOut);`
	`53`	`+ config.ConfigureConsole(environment.ConsoleOut);`
	`54`	`+ config.Settings.Registrar.RegisterInstance(environment);`
`54`	`55`	`config.Settings.Registrar.RegisterInstance(cancellationTokenSource.Token);`
`55`	`56`	`config.SetExceptionHandler((exception, _) =>`
`56`	`57`	`{`
	`58`	`+ var consoleErr = environment.ConsoleErr;`
`57`	`59`	`switch (exception)`
`58`	`60`	`{`
`59`	`61`	`case OperationCanceledException when cancellationTokenSource.IsCancellationRequested:`