Ability to log a summary message

NikolayPianikov · NikolayPianikov · commit e6c13492339c · 2025-02-07T20:41:12.000+03:00
diff --git a/CSharpInteractive.HostApi/IHost.cs b/CSharpInteractive.HostApi/IHost.cs
@@ -88,6 +88,17 @@ public interface IHost
     /// <param name="warning">Warning message.</param>
     void Warning(string? warning);
 
+    /// <summary>
+    /// Writes a summary message to stdOut.
+    /// <example>
+    /// <code>
+    /// Info("Some info");
+    /// </code>
+    /// </example>
+    /// </summary>
+    /// <param name="summary">Summary message.</param>
+    void Summary(string? summary);
+
     /// <summary>
     /// Writes an information message to stdOut.
     /// <example>
diff --git a/CSharpInteractive.Tests/ProcessResultHandlerTests.cs b/CSharpInteractive.Tests/ProcessResultHandlerTests.cs
@@ -29,7 +29,7 @@ internal void ShouldLogInfoWhenFinishedAndHasHandler(ProcessState state)
     }
 
     [Fact]
-    public void ShouldLogInfoWhenFinishedAndHasNoHandler()
+    public void ShouldLogSummaryWhenFinishedAndHasNoHandler()
     {
         // Given
         var handler = CreateInstance();
@@ -38,7 +38,7 @@ public void ShouldLogInfoWhenFinishedAndHasNoHandler()
         handler.Handle(new ProcessResult(_processInfo, ProcessState.Finished, 12, _description), default(Action<object>));
 
         // Then
-        _log.Verify(i => i.Info(_description));
+        _log.Verify(i => i.Summary(_description));
     }
 
     [Fact]
diff --git a/CSharpInteractive.Tests/README_TEMPLATE.md b/CSharpInteractive.Tests/README_TEMPLATE.md
@@ -7,6 +7,7 @@
   - [Writing an empty line to a build log](#writing-an-empty-line-to-a-build-log)
   - [Registering errors in the build log](#registering-errors-in-the-build-log)
   - [Registering warnings in the build log](#registering-warnings-in-the-build-log)
+  - [Registering a summary in the build log](#registering-a-summary-in-the-build-log)
   - [Registering information in the build log](#registering-information-in-the-build-log)
   - [Registering trace information in the build log](#registering-trace-information-in-the-build-log)
 - Arguments and parameters
@@ -136,6 +137,12 @@ Error("Error info", "Error identifier");
 Warning("Warning info");
 ```
 
+### Registering a summary in the build log
+
+``` CSharp
+Summary("Summary message");
+```
+
 ### Registering information in the build log
 
 ``` CSharp
@@ -360,7 +367,7 @@ using HostApi;
 
 var cancellationTokenSource = new CancellationTokenSource();
 var task = new CommandLine("cmd", "/c", "TIMEOUT", "/T", "120")
-    .RunAsync(default, cancellationTokenSource.Token);
+    .RunAsync(null, cancellationTokenSource.Token);
 
 cancellationTokenSource.CancelAfter(TimeSpan.FromMilliseconds(100));
 task.IsCompleted.ShouldBeFalse();
@@ -372,7 +379,7 @@ If timeout expired a process will be killed.
 using HostApi;
 
 var exitCode = new CommandLine("cmd", "/c", "TIMEOUT", "/T", "120")
-    .Run(default, TimeSpan.FromMilliseconds(1))
+    .Run(null, TimeSpan.FromMilliseconds(1))
     .ExitCode;
 ```
 
@@ -678,7 +685,7 @@ new DotNetFormat()
 ``` CSharp
 using HostApi;
 
-string? repositoryPath = default;
+string? repositoryPath = null;
 new DotNetNuGetConfigGet()
     .WithConfigKey("repositoryPath")
     .Run(output => repositoryPath = output.Line).EnsureSuccess();
@@ -1018,7 +1025,7 @@ new DotNet()
 using HostApi;
 
 // Gets the dotnet version, running a command like: "dotnet --version"
-NuGetVersion? version = default;
+NuGetVersion? version = null;
 new DotNetCustom("--version")
     .Run(message => NuGetVersion.TryParse(message.Line, out version))
     .EnsureSuccess();
diff --git a/CSharpInteractive.Tests/UsageScenarios/BaseScenario.cs b/CSharpInteractive.Tests/UsageScenarios/BaseScenario.cs
@@ -73,6 +73,8 @@ public bool HasSdk(string sdkVersion)
 
     public void Warning(string? warning) => Composition.Shared.Root.Host.Warning(warning);
 
+    public void Summary(string? summary) => Composition.Shared.Root.Host.Summary(summary);
+
     public void Info(string? text) => Composition.Shared.Root.Host.Info(text);
 
     public void Trace(string? trace, string? origin = null) => Composition.Shared.Root.Host.Trace(trace, origin);
diff --git a/CSharpInteractive.Tests/UsageScenarios/Comments/CommandLineAsyncCancellation.txt b/CSharpInteractive.Tests/UsageScenarios/Comments/CommandLineAsyncCancellation.txt
@@ -2,7 +2,7 @@ using HostApi;
 
 var cancellationTokenSource = new CancellationTokenSource();
 var task = new CommandLine("cmd", "/c", "TIMEOUT", "/T", "120")
-    .RunAsync(default, cancellationTokenSource.Token);
+    .RunAsync(null, cancellationTokenSource.Token);
 
 cancellationTokenSource.CancelAfter(TimeSpan.FromMilliseconds(100));
 task.IsCompleted.ShouldBeFalse();
diff --git a/CSharpInteractive.Tests/UsageScenarios/Comments/CommandLineWithTimeoutScenario.txt b/CSharpInteractive.Tests/UsageScenarios/Comments/CommandLineWithTimeoutScenario.txt
@@ -1,5 +1,5 @@
 using HostApi;
 
 var exitCode = new CommandLine("cmd", "/c", "TIMEOUT", "/T", "120")
-    .Run(default, TimeSpan.FromMilliseconds(1))
+    .Run(null, TimeSpan.FromMilliseconds(1))
     .ExitCode;
diff --git a/CSharpInteractive.Tests/UsageScenarios/Comments/DotNetCustomScenario.txt b/CSharpInteractive.Tests/UsageScenarios/Comments/DotNetCustomScenario.txt
@@ -1,7 +1,7 @@
 using HostApi;
 
 // Gets the dotnet version, running a command like: "dotnet --version"
-NuGetVersion? version = default;
+NuGetVersion? version = null;
 new DotNetCustom("--version")
     .Run(message => NuGetVersion.TryParse(message.Line, out version))
     .EnsureSuccess();
diff --git a/CSharpInteractive.Tests/UsageScenarios/Comments/DotNetNuGetConfigGetScenario.txt b/CSharpInteractive.Tests/UsageScenarios/Comments/DotNetNuGetConfigGetScenario.txt
@@ -1,6 +1,6 @@
 using HostApi;
 
-string? repositoryPath = default;
+string? repositoryPath = null;
 new DotNetNuGetConfigGet()
     .WithConfigKey("repositoryPath")
     .Run(output => repositoryPath = output.Line).EnsureSuccess();
diff --git a/CSharpInteractive.Tests/UsageScenarios/Comments/LogSummaryScenario.txt b/CSharpInteractive.Tests/UsageScenarios/Comments/LogSummaryScenario.txt
@@ -0,0 +1 @@
+Summary("Summary message");
diff --git a/CSharpInteractive.Tests/UsageScenarios/LogSummaryScenario.cs b/CSharpInteractive.Tests/UsageScenarios/LogSummaryScenario.cs
@@ -0,0 +1,23 @@
+// ReSharper disable StringLiteralTypo
+// ReSharper disable SuggestVarOrType_BuiltInTypes
+
+namespace CSharpInteractive.Tests.UsageScenarios;
+
+using System;
+
+public class LogSummaryScenario(ITestOutputHelper output) : BaseScenario(output)
+{
+    [SkippableFact]
+    public void Run()
+    {
+        Skip.IfNot(string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable("TEAMCITY_VERSION")));
+
+        // $visible=true
+        // $tag=01 Output, logging and tracing
+        // $priority=04
+        // $description=Registering a summary in the build log
+        // {
+        Summary("Summary message");
+        // }
+    }
+}
diff --git a/CSharpInteractive/Core/HostService.cs b/CSharpInteractive/Core/HostService.cs
@@ -45,6 +45,14 @@ public void Warning(string? warning)
         }
     }
 
+    public void Summary(string? summary)
+    {
+        if (summary != null)
+        {
+            log.Summary(summary);
+        }
+    }
+
     public void Info(string? text)
     {
         if (text != null)
diff --git a/CSharpInteractive/Core/ILog.cs b/CSharpInteractive/Core/ILog.cs
@@ -8,6 +8,8 @@ internal interface ILog<T>
 
     void Warning(params Text[] warning);
 
+    void Summary(params Text[] summary);
+
     void Info(params Text[] message);
 
     void Trace(Func<Text[]> traceMessagesFactory, string origin = "");
diff --git a/CSharpInteractive/Core/IStatistics.cs b/CSharpInteractive/Core/IStatistics.cs
@@ -8,6 +8,8 @@ internal interface IStatistics
 
     IReadOnlyCollection<Text[]> Warnings { get; }
 
+    IReadOnlyCollection<Text[]> Summary { get; }
+
     TimeSpan TimeElapsed { get; }
 
     IReadOnlyCollection<CommandLineInfo> CommandLines { get; }
diff --git a/CSharpInteractive/Core/IStatisticsRegistry.cs b/CSharpInteractive/Core/IStatisticsRegistry.cs
@@ -7,4 +7,6 @@ internal interface IStatisticsRegistry
     void RegisterError(Text[] error);
 
     void RegisterWarning(Text[] warning);
+
+    void RegisterSummary(Text[] summary);
 }
diff --git a/CSharpInteractive/Core/Log.cs b/CSharpInteractive/Core/Log.cs
@@ -34,6 +34,17 @@ public void Warning(params Text[] warning)
         stdOut.WriteLine(warning);
     }
 
+    public void Summary(params Text[] summary)
+    {
+        if (summary.Length == 0)
+        {
+            return;
+        }
+
+        statisticsRegistry.RegisterSummary(summary);
+        stdOut.WriteLine(GetMessage(summary, Color.Highlighted));
+    }
+
     public void Info(params Text[] message)
     {
         if (settings.VerbosityLevel >= VerbosityLevel.Normal)
diff --git a/CSharpInteractive/Core/LogExtensions.cs b/CSharpInteractive/Core/LogExtensions.cs
@@ -31,4 +31,10 @@ public static ILog<T> Warning<T>(this ILog<T> log, params string[] warning)
         log.Warning(warning.Select(i => new Text(i, Color.Warning)).ToArray());
         return log;
     }
+
+    public static ILog<T> Summary<T>(this ILog<T> log, params string[] summary)
+    {
+        log.Summary(summary.Select(i => new Text(i, Color.Highlighted)).ToArray());
+        return log;
+    }
 }
diff --git a/CSharpInteractive/Core/ProcessResultHandler.cs b/CSharpInteractive/Core/ProcessResultHandler.cs
@@ -35,7 +35,7 @@ public void Handle<T>(ProcessResult result, Action<T>? handler)
 
                 case ProcessState.Finished:
                 default:
-                    log.Info(description);
+                    log.Summary(description);
                     break;
             }
         }
diff --git a/CSharpInteractive/Core/Statistics.cs b/CSharpInteractive/Core/Statistics.cs
@@ -12,6 +12,7 @@ internal class Statistics : IStatisticsRegistry, IStatistics, ICommandLineStatis
     private readonly Stopwatch _stopwatch = new();
     private readonly List<Text[]> _errors = [];
     private readonly List<Text[]> _warnings = [];
+    private readonly List<Text[]> _summary = [];
     private readonly List<CommandLineInfo> _info = [];
 
     public bool IsEmpty => Errors.Count == 0 && Warnings.Count == 0 && CommandLines.Count == 0;
@@ -22,7 +23,7 @@ public IReadOnlyCollection<Text[]> Errors
         {
             lock (_lockObject)
             {
-                return new ReadOnlyCollection<Text[]>(_errors);
+                return _errors.AsReadOnly();
             }
         }
     }
@@ -33,7 +34,18 @@ public IReadOnlyCollection<Text[]> Warnings
         {
             lock (_lockObject)
             {
-                return new ReadOnlyCollection<Text[]>(_warnings);
+                return _warnings.AsReadOnly();
+            }
+        }
+    }
+
+    public IReadOnlyCollection<Text[]> Summary
+    {
+        get
+        {
+            lock (_lockObject)
+            {
+                return _summary.AsReadOnly();
             }
         }
     }
@@ -70,6 +82,18 @@ public void RegisterWarning(Text[] warning)
         }
     }
 
+    public void RegisterSummary(Text[] summary)
+    {
+        summary = summary.Trim();
+        if (!summary.IsEmptyOrWhiteSpace())
+        {
+            lock (_lockObject)
+            {
+                _summary.Add(summary);
+            }
+        }
+    }
+
     public IReadOnlyCollection<CommandLineInfo> CommandLines
     {
         get
diff --git a/CSharpInteractive/Core/StatisticsPresenter.cs b/CSharpInteractive/Core/StatisticsPresenter.cs
@@ -18,6 +18,11 @@ public void Show(IStatistics statistics)
 
         Show(tests);
 
+        foreach (var summary in statistics.Summary)
+        {
+            log.Info(summary.AddPrefix(_ => Tab));
+        }
+
         foreach (var warning in statistics.Warnings)
         {
             log.Info(warning.AddPrefix(_ => Tab));
diff --git a/CSharpInteractive/Core/SummaryPresenter.cs b/CSharpInteractive/Core/SummaryPresenter.cs
@@ -23,11 +23,6 @@ public void Show(Summary summary)
         if (!statistics.IsEmpty)
         {
             log.Info(new Text("Summary:", Color.Header));
-            foreach (var commandLineInfo in statistics.CommandLines)
-            {
-                log.Info(commandLineInfo.ProcessResult.Description.AddPrefix(_ => Tab));
-            }
-
             statisticsPresenter.Show(statistics);
         }
 
diff --git a/CSharpInteractive/Core/TeamCityLog.cs b/CSharpInteractive/Core/TeamCityLog.cs
@@ -26,6 +26,12 @@ public void Warning(params Text[] warning)
         teamCityWriter.WriteWarning(message);
     }
 
+    public void Summary(params Text[] summary)
+    {
+        statisticsRegistry.RegisterSummary(summary);
+        teamCityWriter.WriteMessage(lineFormatter.Format(summary));
+    }
+
     public void Info(params Text[] message)
     {
         if (settings.VerbosityLevel >= VerbosityLevel.Normal)
diff --git a/CSharpInteractive/Host.cs b/CSharpInteractive/Host.cs
@@ -162,6 +162,17 @@ private static void CurrentDomainOnUnhandledException(object sender, UnhandledEx
     /// <param name="warning">Warning message.</param>
     public static void Warning(string? warning) => CurHost.Warning(warning);
 
+    /// <summary>
+    /// Writes a summary message to stdOut.
+    /// <example>
+    /// <code>
+    /// Info("Some info");
+    /// </code>
+    /// </example>
+    /// </summary>
+    /// <param name="summary">Summary message.</param>
+    public static void Summary(string? summary) => CurHost.Summary(summary);
+
     /// <summary>
     /// Writes an information message to stdOut.
     /// <example>
diff --git a/README.md b/README.md
diff --git a/Samples/MySampleLib/Build/Program.cs b/Samples/MySampleLib/Build/Program.cs

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ internal void ShouldLogInfoWhenFinishedAndHasHandler(ProcessState state)`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`[Fact]`
`32`		`- public void ShouldLogInfoWhenFinishedAndHasNoHandler()`
	`32`	`+ public void ShouldLogSummaryWhenFinishedAndHasNoHandler()`
`33`	`33`	`{`
`34`	`34`	`// Given`
`35`	`35`	`var handler = CreateInstance();`
`@@ -38,7 +38,7 @@ public void ShouldLogInfoWhenFinishedAndHasNoHandler()`
`38`	`38`	`handler.Handle(new ProcessResult(_processInfo, ProcessState.Finished, 12, _description), default(Action<object>));`
`39`	`39`
`40`	`40`	`// Then`
`41`		`- _log.Verify(i => i.Info(_description));`
	`41`	`+ _log.Verify(i => i.Summary(_description));`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`[Fact]`