Use same build session for restore and build (#54)

Fixes #53

Author: jeffkl

src/MSBuildProjectCreator.UnitTests/BuildTests.cs

@@ -122,6 +122,52 @@ public void ProjectCollectionLoggersWork()
             fileLogContents.ShouldContain("2AE492F6EEE04255B31B088051E9AF0F", fileLogContents);
         }
 
+        [Fact]
+        public void ProjectCollectionLoggersWorkWithRestore()
+        {
+            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", "B7F9A257198D4A44A06BB6146AB27440")
+                    .Target("Restore")
+                        .TaskMessage("38EC33B686134B3C8DE4B8E571D4FB24", MessageImportance.High)
+                    .Save(GetTempFileName(".proj"))
+                    .TryBuild(restore: true, out bool result, out BuildOutput buildOutput);
+
+                result.ShouldBeTrue();
+
+                buildOutput.MessageEvents.High.ShouldContain(i => i.Message == "38EC33B686134B3C8DE4B8E571D4FB24", buildOutput.GetConsoleLog());
+                buildOutput.MessageEvents.Normal.ShouldContain(i => i.Message == "B7F9A257198D4A44A06BB6146AB27440", buildOutput.GetConsoleLog());
+            }
+
+            File.Exists(binLogPath).ShouldBeTrue();
+
+            File.Exists(fileLogPath).ShouldBeTrue();
+
+            string fileLogContents = File.ReadAllText(fileLogPath);
+
+            fileLogContents.ShouldContain("38EC33B686134B3C8DE4B8E571D4FB24", fileLogContents);
+            fileLogContents.ShouldContain("B7F9A257198D4A44A06BB6146AB27440", fileLogContents);
+        }
+
         [Fact]
         public void RestoreTargetCanBeRun()
         {

src/MSBuildProjectCreator/ProjectCreator.Build.cs

@@ -68,21 +68,9 @@ public ProjectCreator TryBuild(string target, out bool result, out BuildOutput b
         /// <returns>The current <see cref="ProjectCreator"/>.</returns>
         public ProjectCreator TryBuild(bool restore, string target, out bool result, out BuildOutput buildOutput)
         {
-            if (restore)
-            {
-                TryRestore(out result, out buildOutput);
-
-                if (!result)
-                {
-                    return this;
-                }
-            }
-            else
-            {
-                buildOutput = BuildOutput.Create();
-            }
+            buildOutput = BuildOutput.Create();
 
-            Build(target.ToArrayWithSingleElement(), buildOutput, out result, out _);
+            Build(restore, target.ToArrayWithSingleElement(), buildOutput, out result, out _);
 
             return this;
         }
@@ -140,21 +128,9 @@ public ProjectCreator TryBuild(out bool result, out BuildOutput buildOutput)
         /// <returns>The current <see cref="ProjectCreator"/>.</returns>
         public ProjectCreator TryBuild(bool restore, out bool result, out BuildOutput buildOutput)
         {
-            if (restore)
-            {
-                TryRestore(out result, out buildOutput);
-
-                if (!result)
-                {
-                    return this;
-                }
-            }
-            else
-            {
-                buildOutput = BuildOutput.Create();
-            }
+            buildOutput = BuildOutput.Create();
 
-            Build(null, buildOutput, out result, out _);
+            Build(restore, null, buildOutput, out result, out _);
 
             return this;
         }
@@ -210,21 +186,9 @@ public ProjectCreator TryBuild(string[] targets, out bool result, out BuildOutpu
         /// <returns>The current <see cref="ProjectCreator"/>.</returns>
         public ProjectCreator TryBuild(bool restore, string[] targets, out bool result, out BuildOutput buildOutput, out IDictionary<string, TargetResult> targetOutputs)
         {
-            if (restore)
-            {
-                TryRestore(out result, out buildOutput, out targetOutputs);
-
-                if (!result)
-                {
-                    return this;
-                }
-            }
-            else
-            {
-                buildOutput = BuildOutput.Create();
-            }
+            buildOutput = BuildOutput.Create();
 
-            Build(targets, buildOutput, out result, out targetOutputs);
+            Build(restore, targets, buildOutput, out result, out targetOutputs);
 
             return this;
         }
@@ -286,73 +250,43 @@ public ProjectCreator TryRestore(out bool result, out BuildOutput buildOutput)
         /// <returns>The current <see cref="ProjectCreator"/>.</returns>
         public ProjectCreator TryRestore(out bool result, out BuildOutput buildOutput, out IDictionary<string, TargetResult> targetOutputs)
         {
-            Save();
-
             buildOutput = BuildOutput.Create();
 
             lock (BuildManager.DefaultBuildManager)
             {
-                BuildRequestData restoreRequest = new BuildRequestData(
-                    FullPath,
-                    new Dictionary<string, string>
-                    {
-                        ["ExcludeRestorePackageImports"] = "true",
-                        ["MSBuildRestoreSessionId"] = Guid.NewGuid().ToString("D"),
-                    },
-                    ProjectCollection.DefaultToolsVersion,
-                    targetsToBuild: new[] { "Restore" },
-                    hostServices: null,
-                    flags: BuildRequestDataFlags.ClearCachesAfterBuild | BuildRequestDataFlags.SkipNonexistentTargets | BuildRequestDataFlags.IgnoreMissingEmptyAndInvalidImports);
-
                 BuildParameters buildParameters = new BuildParameters
                 {
-                    Loggers = new List<Framework.ILogger>
-                    {
-                        buildOutput,
-                    },
+                    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;
+                    Restore(out result, out targetOutputs);
                 }
                 finally
                 {
                     BuildManager.DefaultBuildManager.EndBuild();
                 }
             }
 
-            Project.MarkDirty();
-
-            Project.ReevaluateIfNecessary();
-
             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);
+            Build(restore: false, targets, buildOutput, out result, out targetOutputs);
         }
 
-        private void Build(string[] targets, BuildOutput buildOutput, out bool result, out IDictionary<string, TargetResult> targetOutputs)
+        private void Build(bool restore, string[] targets, BuildOutput buildOutput, out bool result, out IDictionary<string, TargetResult> targetOutputs)
         {
+            targetOutputs = null;
+
             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())),
@@ -361,19 +295,77 @@ private void Build(string[] targets, BuildOutput buildOutput, out bool result, o
                 BuildManager.DefaultBuildManager.BeginBuild(buildParameters);
                 try
                 {
-                    BuildSubmission buildSubmission = BuildManager.DefaultBuildManager.PendBuildRequest(restoreRequest);
+                    if (restore)
+                    {
+                        Restore(out result, out targetOutputs);
+
+                        if (!result)
+                        {
+                            return;
+                        }
+                    }
+
+                    BuildRequestData buildRequestData = new BuildRequestData(
+                        ProjectInstance,
+                        targetsToBuild: targets ?? ProjectInstance.DefaultTargets.ToArray(),
+                        hostServices: null,
+                        flags: BuildRequestDataFlags.ReplaceExistingProjectInstance);
+
+                    BuildSubmission buildSubmission = BuildManager.DefaultBuildManager.PendBuildRequest(buildRequestData);
 
                     BuildResult buildResult = buildSubmission.Execute();
 
                     result = buildResult.OverallResult == BuildResultCode.Success;
 
-                    targetOutputs = buildResult.ResultsByTarget;
+                    if (targetOutputs != null)
+                    {
+                        foreach (KeyValuePair<string, TargetResult> targetResult in buildResult.ResultsByTarget)
+                        {
+                            targetOutputs[targetResult.Key] = targetResult.Value;
+                        }
+                    }
+                    else
+                    {
+                        targetOutputs = buildResult.ResultsByTarget;
+                    }
                 }
                 finally
                 {
                     BuildManager.DefaultBuildManager.EndBuild();
                 }
             }
         }
+
+        private void Restore(out bool result, out IDictionary<string, TargetResult> targetOutputs)
+        {
+            Save();
+
+            IDictionary<string, string> globalProperties = new Dictionary<string, string>(ProjectCollection.GlobalProperties);
+
+            globalProperties["ExcludeRestorePackageImports"] = "true";
+            globalProperties["MSBuildRestoreSessionId"] = Guid.NewGuid().ToString("D");
+
+            BuildRequestData buildRequestData = new BuildRequestData(
+                FullPath,
+                globalProperties,
+                ProjectCollection.DefaultToolsVersion,
+                targetsToBuild: new[] { "Restore" },
+                hostServices: null,
+                flags: BuildRequestDataFlags.ClearCachesAfterBuild | BuildRequestDataFlags.SkipNonexistentTargets | BuildRequestDataFlags.IgnoreMissingEmptyAndInvalidImports);
+
+            BuildSubmission buildSubmission = BuildManager.DefaultBuildManager.PendBuildRequest(buildRequestData);
+
+            BuildResult buildResult = buildSubmission.Execute();
+
+            Project.MarkDirty();
+
+            Project.ReevaluateIfNecessary();
+
+            _projectInstance = Project.CreateProjectInstance();
+
+            targetOutputs = buildResult.ResultsByTarget;
+
+            result = buildResult.OverallResult == BuildResultCode.Success;
+        }
     }
 }