From 4998acd24b34ff1664bff2380a9759aed41aa60b Mon Sep 17 00:00:00 2001 From: Gang Wang Date: Wed, 12 Jul 2023 10:38:22 +0000 Subject: [PATCH 1/3] Rename liveLogger to be terminallogger --- documentation/README.md | 2 +- .../terminallogger/Opt-In-Mechanism.md | 2 +- .../Components/Logging/LoggingService.cs | 4 +- .../CommandLineSwitches_Tests.cs | 11 ++-- ...writesWithNewTargetFramework.verified.txt} | 0 ...sts.DisplayNodesShowsCurrent.verified.txt} | 0 ...sts.PrintBuildSummary_Failed.verified.txt} | 0 ...uildSummary_FailedWithErrors.verified.txt} | 0 ...ummary_SucceededWithWarnings.verified.txt} | 0 ...PrintsBuildSummary_Succeeded.verified.txt} | 0 ...ogger_Tests.cs => TerminalLogger_Tests.cs} | 20 +++---- src/MSBuild/CommandLineSwitches.cs | 4 +- src/MSBuild/MSBuild.csproj | 2 +- src/MSBuild/Resources/Strings.resx | 14 ++--- src/MSBuild/Resources/xlf/Strings.cs.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.de.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.es.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.fr.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.it.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.ja.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.ko.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.pl.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.pt-BR.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.ru.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.tr.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.zh-Hans.xlf | 10 ++-- src/MSBuild/Resources/xlf/Strings.zh-Hant.xlf | 10 ++-- .../AnsiCodes.cs | 2 +- .../BuildMessage.cs | 2 +- .../ITerminal.cs | 4 +- .../MessageSeverity.cs | 2 +- .../{LiveLogger => TerminalLogger}/Project.cs | 2 +- .../Terminal.cs | 2 +- .../TerminalColor.cs | 2 +- .../TerminalLogger.cs} | 12 ++--- src/MSBuild/XMake.cs | 54 +++++++++---------- 36 files changed, 133 insertions(+), 138 deletions(-) rename src/MSBuild.UnitTests/Snapshots/{LiveLogger_Tests.DisplayNodesOverwritesWithNewTargetFramework.verified.txt => TerminalLogger_Tests.DisplayNodesOverwritesWithNewTargetFramework.verified.txt} (100%) rename src/MSBuild.UnitTests/Snapshots/{LiveLogger_Tests.DisplayNodesShowsCurrent.verified.txt => TerminalLogger_Tests.DisplayNodesShowsCurrent.verified.txt} (100%) rename src/MSBuild.UnitTests/Snapshots/{LiveLogger_Tests.PrintBuildSummary_Failed.verified.txt => TerminalLogger_Tests.PrintBuildSummary_Failed.verified.txt} (100%) rename src/MSBuild.UnitTests/Snapshots/{LiveLogger_Tests.PrintBuildSummary_FailedWithErrors.verified.txt => TerminalLogger_Tests.PrintBuildSummary_FailedWithErrors.verified.txt} (100%) rename src/MSBuild.UnitTests/Snapshots/{LiveLogger_Tests.PrintBuildSummary_SucceededWithWarnings.verified.txt => TerminalLogger_Tests.PrintBuildSummary_SucceededWithWarnings.verified.txt} (100%) rename src/MSBuild.UnitTests/Snapshots/{LiveLogger_Tests.PrintsBuildSummary_Succeeded.verified.txt => TerminalLogger_Tests.PrintsBuildSummary_Succeeded.verified.txt} (100%) rename src/MSBuild.UnitTests/{LiveLogger_Tests.cs => TerminalLogger_Tests.cs} (95%) rename src/MSBuild/{LiveLogger => TerminalLogger}/AnsiCodes.cs (98%) rename src/MSBuild/{LiveLogger => TerminalLogger}/BuildMessage.cs (86%) rename src/MSBuild/{LiveLogger => TerminalLogger}/ITerminal.cs (96%) rename src/MSBuild/{LiveLogger => TerminalLogger}/MessageSeverity.cs (84%) rename src/MSBuild/{LiveLogger => TerminalLogger}/Project.cs (97%) rename src/MSBuild/{LiveLogger => TerminalLogger}/Terminal.cs (98%) rename src/MSBuild/{LiveLogger => TerminalLogger}/TerminalColor.cs (89%) rename src/MSBuild/{LiveLogger/LiveLogger.cs => TerminalLogger/TerminalLogger.cs} (98%) diff --git a/documentation/README.md b/documentation/README.md index ec88f6bcae7..199be8361fb 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -74,7 +74,7 @@ The folder contains collection of docs and references for MSBuild, detailed info ### Logging * [Binary log](wiki/Binary-Log.md) -* [Live logger: how to opt in](livelogger/Opt-In-Mechanism.md) +* [Terminal logger: how to opt in](terminallogger/Opt-In-Mechanism.md) ## Archived Designs * [Resolve Assembly Reference as a service](specs/rar-as-service.md) diff --git a/documentation/terminallogger/Opt-In-Mechanism.md b/documentation/terminallogger/Opt-In-Mechanism.md index 2092a1feaba..f6d63e7f4ac 100644 --- a/documentation/terminallogger/Opt-In-Mechanism.md +++ b/documentation/terminallogger/Opt-In-Mechanism.md @@ -15,7 +15,7 @@ Using the `/terminallogger` or `/tl` command line switches, users are able to op ### Enabling for all builds -Users can set the `MSBUILDLIVELOGGER` environment variable to enable TerminalLogger without adding a swtich to all build invocations. +Users can set the `MSBUILDTERMINALLOGGER` environment variable to enable TerminalLogger without adding a swtich to all build invocations. ### TerminalLogger parameters diff --git a/src/Build/BackEnd/Components/Logging/LoggingService.cs b/src/Build/BackEnd/Components/Logging/LoggingService.cs index dc8467773b0..94822204c9c 100644 --- a/src/Build/BackEnd/Components/Logging/LoggingService.cs +++ b/src/Build/BackEnd/Components/Logging/LoggingService.cs @@ -1657,8 +1657,8 @@ private void UpdateMinimumMessageImportance(ILogger logger) // The null logger has no effect on minimum verbosity. Execution.BuildManager.NullLogger => null, - // The live logger consumes only high priority messages. - _ => innerLogger.GetType().FullName == "Microsoft.Build.Logging.LiveLogger.LiveLogger" + // The terminal logger consumes only high priority messages. + _ => innerLogger.GetType().FullName == "Microsoft.Build.Logging.TerminalLogger.TerminalLogger" ? MessageImportance.High // If the logger is not on our allow list, there are no importance guarantees. Fall back to "any importance". : MessageImportance.Low, diff --git a/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs b/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs index 551114540e1..eac8d17ff92 100644 --- a/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs +++ b/src/MSBuild.UnitTests/CommandLineSwitches_Tests.cs @@ -157,23 +157,18 @@ public void DistributedFileLoggerSwitchIdentificationTests(string distributedfil } [Theory] - [InlineData("ll")] - [InlineData("LL")] - [InlineData("livelogger")] - [InlineData("LiveLogger")] - [InlineData("LIVELOGGER")] [InlineData("tl")] [InlineData("TL")] [InlineData("terminallogger")] [InlineData("TerminalLogger")] [InlineData("TERMINALLOGGER")] - public void LiveLoggerSwitchIdentificationTests(string livelogger) + public void TerminalLoggerSwitchIdentificationTests(string terminallogger) { CommandLineSwitches.ParameterizedSwitch parameterlessSwitch; string duplicateSwitchErrorMessage; - CommandLineSwitches.IsParameterizedSwitch(livelogger, out parameterlessSwitch, out duplicateSwitchErrorMessage, out bool multipleParametersAllowed, out string missingParametersErrorMessage, out bool unquoteParameters, out bool emptyParametersAllowed).ShouldBeTrue(); - parameterlessSwitch.ShouldBe(CommandLineSwitches.ParameterizedSwitch.LiveLogger); + CommandLineSwitches.IsParameterizedSwitch(terminallogger, out parameterlessSwitch, out duplicateSwitchErrorMessage, out bool multipleParametersAllowed, out string missingParametersErrorMessage, out bool unquoteParameters, out bool emptyParametersAllowed).ShouldBeTrue(); + parameterlessSwitch.ShouldBe(CommandLineSwitches.ParameterizedSwitch.TerminalLogger); duplicateSwitchErrorMessage.ShouldBeNull(); multipleParametersAllowed.ShouldBeTrue(); missingParametersErrorMessage.ShouldBeNull(); diff --git a/src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.DisplayNodesOverwritesWithNewTargetFramework.verified.txt b/src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.DisplayNodesOverwritesWithNewTargetFramework.verified.txt similarity index 100% rename from src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.DisplayNodesOverwritesWithNewTargetFramework.verified.txt rename to src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.DisplayNodesOverwritesWithNewTargetFramework.verified.txt diff --git a/src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.DisplayNodesShowsCurrent.verified.txt b/src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.DisplayNodesShowsCurrent.verified.txt similarity index 100% rename from src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.DisplayNodesShowsCurrent.verified.txt rename to src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.DisplayNodesShowsCurrent.verified.txt diff --git a/src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintBuildSummary_Failed.verified.txt b/src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummary_Failed.verified.txt similarity index 100% rename from src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintBuildSummary_Failed.verified.txt rename to src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummary_Failed.verified.txt diff --git a/src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintBuildSummary_FailedWithErrors.verified.txt b/src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummary_FailedWithErrors.verified.txt similarity index 100% rename from src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintBuildSummary_FailedWithErrors.verified.txt rename to src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummary_FailedWithErrors.verified.txt diff --git a/src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintBuildSummary_SucceededWithWarnings.verified.txt b/src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummary_SucceededWithWarnings.verified.txt similarity index 100% rename from src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintBuildSummary_SucceededWithWarnings.verified.txt rename to src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummary_SucceededWithWarnings.verified.txt diff --git a/src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintsBuildSummary_Succeeded.verified.txt b/src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintsBuildSummary_Succeeded.verified.txt similarity index 100% rename from src/MSBuild.UnitTests/Snapshots/LiveLogger_Tests.PrintsBuildSummary_Succeeded.verified.txt rename to src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintsBuildSummary_Succeeded.verified.txt diff --git a/src/MSBuild.UnitTests/LiveLogger_Tests.cs b/src/MSBuild.UnitTests/TerminalLogger_Tests.cs similarity index 95% rename from src/MSBuild.UnitTests/LiveLogger_Tests.cs rename to src/MSBuild.UnitTests/TerminalLogger_Tests.cs index 1a359d69aad..cc5f55f1b44 100644 --- a/src/MSBuild.UnitTests/LiveLogger_Tests.cs +++ b/src/MSBuild.UnitTests/TerminalLogger_Tests.cs @@ -11,7 +11,7 @@ using System.Threading.Tasks; using Microsoft.Build.Framework; -using Microsoft.Build.Logging.LiveLogger; +using Microsoft.Build.Logging.TerminalLogger; using VerifyTests; using VerifyXunit; @@ -22,7 +22,7 @@ namespace Microsoft.Build.UnitTests { [UsesVerify] - public class LiveLogger_Tests : IEventSource, IDisposable + public class TerminalLogger_Tests : IEventSource, IDisposable { private const int _nodeCount = 8; private const string _eventSender = "Test"; @@ -31,7 +31,7 @@ public class LiveLogger_Tests : IEventSource, IDisposable private StringWriter _outputWriter = new(); private readonly Terminal _mockTerminal; - private readonly LiveLogger _liveLogger; + private readonly TerminalLogger _terminallogger; private readonly DateTime _buildStartTime = new DateTime(2023, 3, 30, 16, 30, 0); private readonly DateTime _buildFinishTime = new DateTime(2023, 3, 30, 16, 30, 5); @@ -40,12 +40,12 @@ public class LiveLogger_Tests : IEventSource, IDisposable private static Regex s_elapsedTime = new($@"\d+{Regex.Escape(CultureInfo.CurrentCulture.NumberFormat.NumberDecimalSeparator)}\ds", RegexOptions.Compiled); - public LiveLogger_Tests() + public TerminalLogger_Tests() { _mockTerminal = new Terminal(_outputWriter); - _liveLogger = new LiveLogger(_mockTerminal); + _terminallogger = new TerminalLogger(_mockTerminal); - _liveLogger.Initialize(this, _nodeCount); + _terminallogger.Initialize(this, _nodeCount); UseProjectRelativeDirectory("Snapshots"); @@ -98,7 +98,7 @@ public LiveLogger_Tests() public void Dispose() { - _liveLogger.Shutdown(); + _terminallogger.Shutdown(); } #endregion @@ -251,7 +251,7 @@ public void DisplayNodesShowsCurrent() { InvokeLoggerCallbacksForSimpleProject(succeeded: false, async () => { - _liveLogger.DisplayNodes(); + _terminallogger.DisplayNodes(); await Verify(_outputWriter.ToString(), _settings); }); @@ -270,7 +270,7 @@ public async Task DisplayNodesOverwritesWithNewTargetFramework() TargetStarted?.Invoke(_eventSender, MakeTargetStartedEventArgs(_projectFile, "Build")); TaskStarted?.Invoke(_eventSender, MakeTaskStartedEventArgs(_projectFile, "Task")); - _liveLogger.DisplayNodes(); + _terminallogger.DisplayNodes(); // This is a bit fast and loose with the events that would be fired // in a real "stop building that TF for the project and start building @@ -281,7 +281,7 @@ public async Task DisplayNodesOverwritesWithNewTargetFramework() ProjectStarted?.Invoke(_eventSender, pse2); TargetStarted?.Invoke(_eventSender, MakeTargetStartedEventArgs(_projectFile, "Build")); - _liveLogger.DisplayNodes(); + _terminallogger.DisplayNodes(); await Verify(_outputWriter.ToString(), _settings); } diff --git a/src/MSBuild/CommandLineSwitches.cs b/src/MSBuild/CommandLineSwitches.cs index 5b2f7e67fb4..efaf786d8da 100644 --- a/src/MSBuild/CommandLineSwitches.cs +++ b/src/MSBuild/CommandLineSwitches.cs @@ -89,7 +89,7 @@ internal enum ParameterizedSwitch FileLoggerParameters7, FileLoggerParameters8, FileLoggerParameters9, - LiveLogger, + TerminalLogger, NodeReuse, Preprocess, Targets, @@ -246,7 +246,7 @@ internal ParameterizedSwitchInfo( new ParameterizedSwitchInfo( new string[] { "fileloggerparameters7", "flp7" }, ParameterizedSwitch.FileLoggerParameters7, null, false, "MissingFileLoggerParameterError", true, false), new ParameterizedSwitchInfo( new string[] { "fileloggerparameters8", "flp8" }, ParameterizedSwitch.FileLoggerParameters8, null, false, "MissingFileLoggerParameterError", true, false), new ParameterizedSwitchInfo( new string[] { "fileloggerparameters9", "flp9" }, ParameterizedSwitch.FileLoggerParameters9, null, false, "MissingFileLoggerParameterError", true, false), - new ParameterizedSwitchInfo( new string[] { "livelogger", "ll", "terminallogger", "tl" }, ParameterizedSwitch.LiveLogger, null, true, null, true, true), + new ParameterizedSwitchInfo( new string[] { "terminallogger", "tl" }, ParameterizedSwitch.TerminalLogger, null, true, null, true, true), new ParameterizedSwitchInfo( new string[] { "nodereuse", "nr" }, ParameterizedSwitch.NodeReuse, null, false, "MissingNodeReuseParameterError", true, false), new ParameterizedSwitchInfo( new string[] { "preprocess", "pp" }, ParameterizedSwitch.Preprocess, null, false, null, true, false), new ParameterizedSwitchInfo( new string[] { "targets", "ts" }, ParameterizedSwitch.Targets, null, false, null, true, false), diff --git a/src/MSBuild/MSBuild.csproj b/src/MSBuild/MSBuild.csproj index 219437cdacf..ccc3337c0bf 100644 --- a/src/MSBuild/MSBuild.csproj +++ b/src/MSBuild/MSBuild.csproj @@ -172,7 +172,7 @@ true - + true diff --git a/src/MSBuild/Resources/Strings.resx b/src/MSBuild/Resources/Strings.resx index 94b963cb2ec..cf3903bc70c 100644 --- a/src/MSBuild/Resources/Strings.resx +++ b/src/MSBuild/Resources/Strings.resx @@ -1379,7 +1379,7 @@ The '{0}' switch is not supported for solution files. - + Restore complete ({0}s) @@ -1405,31 +1405,31 @@ failed with errors - Part of Live Logger summary message: "Build {BuildResult_X} in {duration}s" + Part of Terminal Logger summary message: "Build {BuildResult_X} in {duration}s" failed with warnings - Part of Live Logger summary message: "Build {BuildResult_X} in {duration}s" + Part of Terminal Logger summary message: "Build {BuildResult_X} in {duration}s" failed - Part of Live Logger summary message: "Build {BuildResult_X} in {duration}s" + Part of Terminal Logger summary message: "Build {BuildResult_X} in {duration}s" succeeded - Part of Live Logger summary message: "Build {BuildResult_X} in {duration}s" + Part of Terminal Logger summary message: "Build {BuildResult_X} in {duration}s" succeeded with warnings - Part of Live Logger summary message: "Build {BuildResult_X} in {duration}s" + Part of Terminal Logger summary message: "Build {BuildResult_X} in {duration}s" @@ -1481,7 +1481,7 @@ {4}: duration in seconds with 1 decimal point - +