Add GetConsoleLog() to BuildOutput class (#4)

Author: jeffkl

src/MSBuildProjectCreator.UnitTests/BuildOutputTests.cs

@@ -13,6 +13,33 @@ namespace Microsoft.Build.Utilities.ProjectCreation.UnitTests
 {
     public class BuildOutputTests
     {
+        [Fact]
+        public void ConsoleLog()
+        {
+            BuildOutput buildOutput = GetProjectLoggerWithEvents(eventSource =>
+            {
+                eventSource.OnErrorRaised("FDC8FB4F8E084055974580DF7CD7531E", "6496288436BE4E7CAE014F163914063C", "7B07B020E38343A89B3FA844A40895E4", 1, 2, 0, 0);
+                eventSource.OnWarningRaised("E00BBDAEEFAB45949AFEE1BF792B1691", "56206897E63F44159603D22BB7C08145", "C455F26F4D4543E78F109BCB00F02BE2", 1, 2, 0, 0);
+                eventSource.OnMessageRaised("55B991507D52403295E92E4FFA8704F3", MessageImportance.High);
+                eventSource.OnMessageRaised("FA7FCCBE43B741998BAB399E74F2997D", MessageImportance.Normal);
+                eventSource.OnMessageRaised("67C0E0E52F2A45A981F3143BAF00A4A3", MessageImportance.Low);
+            });
+
+            buildOutput.GetConsoleLog()
+#pragma warning disable SA1116 // Split parameters must start on line after declaration
+                .ShouldBe(@"7B07B020E38343A89B3FA844A40895E4(1,2): error 6496288436BE4E7CAE014F163914063C: FDC8FB4F8E084055974580DF7CD7531E
+
+C455F26F4D4543E78F109BCB00F02BE2(1,2): warning 56206897E63F44159603D22BB7C08145: E00BBDAEEFAB45949AFEE1BF792B1691
+
+55B991507D52403295E92E4FFA8704F3
+
+FA7FCCBE43B741998BAB399E74F2997D
+
+",
+#pragma warning restore SA1116 // Split parameters must start on line after declaration
+                    StringCompareShould.IgnoreLineEndings);
+        }
+
         [Theory]
         [InlineData("5F56E5B72FDE4405A021F166D0E4D7A8", "B586E6DA25314DA8B6700CF798A88892")]
         public void Errors(string expectedMessage, string expectedCode)

src/MSBuildProjectCreator.UnitTests/MockEventSource.cs

@@ -40,27 +40,37 @@ public sealed class MockEventSource : IEventSource2
 
         public void OnBuildFinished(bool succeeded, string message = null, string helpKeyword = null)
         {
-            BuildFinished?.Invoke(this, new BuildFinishedEventArgs(message, helpKeyword, succeeded));
+            BuildFinishedEventArgs args = new BuildFinishedEventArgs(message, helpKeyword, succeeded);
+            BuildFinished?.Invoke(this, args);
+            OnAnyEventRaised(args);
         }
 
         public void OnErrorRaised(string message, string code = null, string file = null, int lineNumber = -1, int columnNumber = -1, int endLineNumber = -1, int endColumnNumber = -1, string helpKeyword = null, string senderName = null)
         {
-            ErrorRaised?.Invoke(this, new BuildErrorEventArgs(null, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName));
+            BuildErrorEventArgs args = new BuildErrorEventArgs(null, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName);
+            ErrorRaised?.Invoke(this, args);
+            OnAnyEventRaised(args);
         }
 
         public void OnMessageRaised(string message, MessageImportance importance = MessageImportance.Normal)
         {
-            MessageRaised?.Invoke(this, new BuildMessageEventArgs(message, null, null, importance));
+            BuildMessageEventArgs args = new BuildMessageEventArgs(message, null, null, importance);
+            MessageRaised?.Invoke(this, args);
+            OnAnyEventRaised(args);
         }
 
         public void OnProjectFinished(string projectFile, bool succeeded, string message = null, string helpKeyword = null)
         {
-            ProjectFinished?.Invoke(this, new ProjectFinishedEventArgs(message, helpKeyword, projectFile, succeeded));
+            ProjectFinishedEventArgs args = new ProjectFinishedEventArgs(message, helpKeyword, projectFile, succeeded);
+            ProjectFinished?.Invoke(this, args);
+            OnAnyEventRaised(args);
         }
 
         public void OnWarningRaised(string message, string code = null, string file = null, int lineNumber = -1, int columnNumber = -1, int endLineNumber = -1, int endColumnNumber = -1, string helpKeyword = null, string senderName = null)
         {
-            WarningRaised?.Invoke(this, new BuildWarningEventArgs(null, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName));
+            BuildWarningEventArgs args = new BuildWarningEventArgs(null, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName);
+            WarningRaised?.Invoke(this, args);
+            OnAnyEventRaised(args);
         }
 
         // ReSharper disable once UnusedMember.Local

src/MSBuildProjectCreator/BuildOutput.cs

@@ -3,10 +3,12 @@
 // Licensed under the MIT license.
 
 using Microsoft.Build.Framework;
+using Microsoft.Build.Logging;
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
 
 namespace Microsoft.Build.Utilities.ProjectCreation
 {
@@ -35,6 +37,11 @@ public sealed class BuildOutput : ILogger, IDisposable
         /// </summary>
         private readonly List<BuildWarningEventArgs> _warnings = new List<BuildWarningEventArgs>();
 
+        /// <summary>
+        /// Stores all build events.
+        /// </summary>
+        private ConcurrentQueue<BuildEventArgs> _allEvents = new ConcurrentQueue<BuildEventArgs>();
+
         /// <summary>
         /// Stores the <see cref="BuildFinishedEventArgs"/> that were logged when the build finished.
         /// </summary>
@@ -44,6 +51,11 @@ private BuildOutput()
         {
         }
 
+        /// <summary>
+        /// Gets all events that were logged.
+        /// </summary>
+        public IReadOnlyCollection<BuildEventArgs> AllEvents => _allEvents;
+
         /// <summary>
         /// Gets the errors that were logged.
         /// </summary>
@@ -106,6 +118,75 @@ public void Dispose()
             _errors.Clear();
             _messages.Clear();
             _warnings.Clear();
+            _allEvents = null;
+        }
+
+        /// <summary>
+        /// Gets the current build output in the format of a console log.
+        /// </summary>
+        /// <param name="verbosity">The logger verbosity to use.</param>
+        /// <returns>The build output in the format of a console log.</returns>
+        public string GetConsoleLog(LoggerVerbosity verbosity = LoggerVerbosity.Normal)
+        {
+            StringBuilder sb = new StringBuilder(_allEvents.Count * 300);
+
+            ConsoleLogger logger = new ConsoleLogger(verbosity, message => sb.AppendLine(message), color => { }, () => { });
+
+            foreach (BuildEventArgs buildEventArgs in _allEvents)
+            {
+                switch (buildEventArgs)
+                {
+                    case BuildMessageEventArgs buildMessageEventArgs:
+                        logger.MessageHandler(logger, buildMessageEventArgs);
+                        break;
+
+                    case BuildErrorEventArgs buildErrorEventArgs:
+                        logger.ErrorHandler(logger, buildErrorEventArgs);
+                        break;
+
+                    case BuildWarningEventArgs buildWarningEventArgs:
+                        logger.WarningHandler(logger, buildWarningEventArgs);
+                        break;
+
+                    case BuildStartedEventArgs buildStartedEventArgs:
+                        logger.BuildStartedHandler(logger, buildStartedEventArgs);
+                        break;
+
+                    case BuildFinishedEventArgs buildFinishedEventArgs:
+                        logger.BuildFinishedHandler(logger, buildFinishedEventArgs);
+                        break;
+
+                    case ProjectStartedEventArgs projectStartedEventArgs:
+                        logger.ProjectStartedHandler(logger, projectStartedEventArgs);
+                        break;
+
+                    case ProjectFinishedEventArgs projectFinishedEventArgs:
+                        logger.ProjectFinishedHandler(logger, projectFinishedEventArgs);
+                        break;
+
+                    case TargetStartedEventArgs targetStartedEventArgs:
+                        logger.TargetStartedHandler(logger, targetStartedEventArgs);
+                        break;
+
+                    case TargetFinishedEventArgs targetFinishedEventArgs:
+                        logger.TargetFinishedHandler(logger, targetFinishedEventArgs);
+                        break;
+
+                    case TaskStartedEventArgs taskStartedEventArgs:
+                        logger.TaskStartedHandler(logger, taskStartedEventArgs);
+                        break;
+
+                    case TaskFinishedEventArgs taskFinishedEventArgs:
+                        logger.TaskFinishedHandler(logger, taskFinishedEventArgs);
+                        break;
+
+                    case CustomBuildEventArgs customBuildEventArgs:
+                        logger.CustomEventHandler(logger, customBuildEventArgs);
+                        break;
+                }
+            }
+
+            return sb.ToString();
         }
 
         /// <inheritdoc cref="ILogger.Initialize"/>
@@ -116,13 +197,19 @@ public void Initialize(IEventSource eventSource)
             eventSource.MessageRaised += OnMessageRaised;
             eventSource.ProjectFinished += OnProjectFinished;
             eventSource.WarningRaised += OnWarningRaised;
+            eventSource.AnyEventRaised += OnAnyEventRaised;
         }
 
         /// <inheritdoc cref="ILogger.Shutdown"/>
         public void Shutdown()
         {
         }
 
+        private void OnAnyEventRaised(object sender, BuildEventArgs e)
+        {
+            _allEvents.Enqueue(e);
+        }
+
         private void OnBuildFinished(object sender, BuildFinishedEventArgs args) => _buildFinished = args;
 
         private void OnErrorRaised(object sender, BuildErrorEventArgs args) => _errors.Add(args);