Fix loggers when collecting build output (#45)

Fixes #44

Author: jeffkl

src/MSBuildProjectCreator.UnitTests/BuildTests.cs

@@ -2,7 +2,10 @@
 //
 // Licensed under the MIT license.
 
+using Microsoft.Build.Evaluation;
 using Microsoft.Build.Execution;
+using Microsoft.Build.Framework;
+using Microsoft.Build.Logging;
 using NuGet.Packaging.Core;
 using Shouldly;
 using System.Collections.Generic;
@@ -76,6 +79,47 @@ public void CanRestoreAndBuild()
             buildOutput.MessageEvents.High.ShouldContain(i => i.Message == "Building...", buildOutput.GetConsoleLog());
         }
 
+        [Fact]
+        public void ProjectCollectionLoggersWork()
+        {
+            string binLogPath = Path.Combine(TestRootPath, "test.binlog");
+            string fileLogPath = Path.Combine(TestRootPath, "test.log");
+
+            using (ProjectCollection projectCollection = new ProjectCollection())
+            {
+                projectCollection.RegisterLogger(new BinaryLogger
+                {
+                    Parameters = $"LogFile={binLogPath}",
+                });
+                projectCollection.RegisterLogger(new FileLogger
+                {
+                    Parameters = $"LogFile={fileLogPath}",
+                    Verbosity = LoggerVerbosity.Normal,
+                    ShowSummary = true,
+                });
+
+                ProjectCreator.Templates
+                    .LogsMessage(
+                        text: "$(Property1)",
+                        projectCollection: projectCollection)
+                    .Property("Property1", "2AE492F6EEE04255B31B088051E9AF0F")
+                    .Save(GetTempFileName(".proj"))
+                    .TryBuild(out bool result, out BuildOutput buildOutput);
+
+                result.ShouldBeTrue();
+
+                buildOutput.MessageEvents.Normal.ShouldContain(i => i.Message == "2AE492F6EEE04255B31B088051E9AF0F", buildOutput.GetConsoleLog());
+            }
+
+            File.Exists(binLogPath).ShouldBeTrue();
+
+            File.Exists(fileLogPath).ShouldBeTrue();
+
+            string fileLogContents = File.ReadAllText(fileLogPath);
+
+            fileLogContents.ShouldContain("2AE492F6EEE04255B31B088051E9AF0F", fileLogContents);
+        }
+
         [Fact]
         public void RestoreTargetCanBeRun()
         {

src/MSBuildProjectCreator.UnitTests/ProjectTests.cs

@@ -83,7 +83,7 @@ public void TryGetProjectBuildOutput()
                 .Import(@"$(MSBuildBinPath)\Microsoft.Common.targets")
                 .TryGetProject(out Project _, out BuildOutput buildOutput);
 
-            buildOutput.WarningEvents.ShouldHaveSingleItem().Code.ShouldBe("MSB4011");
+            buildOutput.WarningEvents.ShouldHaveSingleItem(buildOutput.GetConsoleLog()).Code.ShouldBe("MSB4011", buildOutput.GetConsoleLog());
         }
 
         [Fact]

src/MSBuildProjectCreator/ExtensionMethods.cs

@@ -30,7 +30,7 @@ public static IEnumerable<T> AsEnumerable<T>(this T item)
         }
 
         /// <summary>
-        /// Merge's two dictionaries by combining all values and overriding with the first with the second.
+        /// Merges two dictionaries by combining all values and overriding with the first with the second.
         /// </summary>
         /// <param name="first">The first dictionary and all of its values to start with.</param>
         /// <param name="second">The second dictionary to merge with the first and override its values.</param>
@@ -41,7 +41,7 @@ public static IDictionary<string, string> Merge(this IDictionary<string, string>
         }
 
         /// <summary>
-        /// Merge's two dictionaries by combining all values and overriding with the first with the second.
+        /// Merges two dictionaries by combining all values and overriding with the first with the second.
         /// </summary>
         /// <param name="first">The first dictionary and all of its values to start with.</param>
         /// <param name="second">The second dictionary to merge with the first and override its values.</param>
@@ -60,5 +60,20 @@ public static IDictionary<string, string> Merge(this IDictionary<string, string>
 
             return result;
         }
+
+        /// <summary>
+        /// Gets the current object as an array of objects.
+        /// </summary>
+        /// <typeparam name="T">The type of the object.</typeparam>
+        /// <param name="item">The item to make into an array.</param>
+        /// <returns>An array of T objects.</returns>
+        public static T[] ToArrayWithSingleElement<T>(this T item)
+            where T : class
+        {
+            return new[]
+            {
+                item,
+            };
+        }
     }
 }

src/MSBuildProjectCreator/ProjectCreator.Build.cs

@@ -41,10 +41,7 @@ public ProjectCreator TryBuild(bool restore, string target, out bool result)
                 }
             }
 
-            lock (BuildManager.DefaultBuildManager)
-            {
-                result = Project.Build(target);
-            }
+            Build(target.ToArrayWithSingleElement(), out result, out _, out _);
 
             return this;
         }
@@ -85,10 +82,7 @@ public ProjectCreator TryBuild(bool restore, string target, out bool result, out
                 buildOutput = BuildOutput.Create();
             }
 
-            lock (BuildManager.DefaultBuildManager)
-            {
-                result = Project.Build(target, buildOutput.AsEnumerable());
-            }
+            Build(target.ToArrayWithSingleElement(), buildOutput, out result, out _);
 
             return this;
         }
@@ -121,10 +115,7 @@ public ProjectCreator TryBuild(bool restore, out bool result)
                 }
             }
 
-            lock (BuildManager.DefaultBuildManager)
-            {
-                result = Project.Build();
-            }
+            Build(null, out result, out _, out _);
 
             return this;
         }
@@ -163,10 +154,7 @@ public ProjectCreator TryBuild(bool restore, out bool result, out BuildOutput bu
                 buildOutput = BuildOutput.Create();
             }
 
-            lock (BuildManager.DefaultBuildManager)
-            {
-                result = Project.Build(buildOutput.AsEnumerable());
-            }
+            Build(null, buildOutput, out result, out _);
 
             return this;
         }
@@ -236,12 +224,7 @@ public ProjectCreator TryBuild(bool restore, string[] targets, out bool result,
                 buildOutput = BuildOutput.Create();
             }
 
-            lock (BuildManager.DefaultBuildManager)
-            {
-                ProjectInstance projectInstance = Project.CreateProjectInstance();
-
-                result = projectInstance.Build(targets, buildOutput.AsEnumerable(), out targetOutputs);
-            }
+            Build(targets, buildOutput, out result, out targetOutputs);
 
             return this;
         }
@@ -352,5 +335,45 @@ public ProjectCreator TryRestore(out bool result, out BuildOutput buildOutput, o
 
             return this;
         }
+
+        private void Build(string[] targets, out bool result, out BuildOutput buildOutput, out IDictionary<string, TargetResult> targetOutputs)
+        {
+            buildOutput = BuildOutput.Create();
+
+            Build(targets, buildOutput, out result, out targetOutputs);
+        }
+
+        private void Build(string[] targets, BuildOutput buildOutput, out bool result, out IDictionary<string, TargetResult> targetOutputs)
+        {
+            lock (BuildManager.DefaultBuildManager)
+            {
+                BuildRequestData restoreRequest = new BuildRequestData(
+                    ProjectInstance,
+                    targetsToBuild: targets ?? ProjectInstance.DefaultTargets.ToArray(),
+                    hostServices: null,
+                    flags: BuildRequestDataFlags.ReplaceExistingProjectInstance);
+
+                BuildParameters buildParameters = new BuildParameters
+                {
+                    Loggers = new List<Framework.ILogger>(ProjectCollection.Loggers.Concat(buildOutput.AsEnumerable())),
+                };
+
+                BuildManager.DefaultBuildManager.BeginBuild(buildParameters);
+                try
+                {
+                    BuildSubmission buildSubmission = BuildManager.DefaultBuildManager.PendBuildRequest(restoreRequest);
+
+                    BuildResult buildResult = buildSubmission.Execute();
+
+                    result = buildResult.OverallResult == BuildResultCode.Success;
+
+                    targetOutputs = buildResult.ResultsByTarget;
+                }
+                finally
+                {
+                    BuildManager.DefaultBuildManager.EndBuild();
+                }
+            }
+        }
     }
 }

src/MSBuildProjectCreator/ProjectCreator.Project.cs

@@ -96,7 +96,7 @@ public ProjectCreator TryGetProject(
         {
             buildOutput = BuildOutput.Create();
 
-            projectCollection = projectCollection ?? ProjectCollection ?? new ProjectCollection();
+            projectCollection = projectCollection ?? new ProjectCollection();
 
             projectCollection.RegisterLogger(buildOutput);