Change how logging is gathered (#147)

jeffkl · web-flow · commit 062713103dff · 2021-11-10T15:53:06.000-08:00
Also add a new `For()` method

Add some tests to make sure all logging messages are gathered
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/BuildTests.cs b/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/BuildTests.cs
@@ -80,6 +80,59 @@ public void BuildWithGlobalProperties()
             buildOutputWithGlobalProperties.MessageEvents.High.ShouldHaveSingleItem(buildOutputWithGlobalProperties.GetConsoleLog()).Message.ShouldBe("Value = D7BBABDFB2D142D3A75E0C1A33E33780", buildOutputWithGlobalProperties.GetConsoleLog());
         }
 
+        [Fact]
+        public void BuildOutputContainsOutOfProcMessages()
+        {
+            const int messageCount = 100;
+
+            List<ProjectCreator> projects = new List<ProjectCreator>(messageCount);
+
+            for (int i = 0; i < messageCount; i++)
+            {
+                FileInfo projectPath = new FileInfo(Path.Combine(TestRootPath, $"Project{i}", $"Project{i}.proj"));
+
+                projectPath.Directory!.Create();
+
+                projects.Add(
+                    ProjectCreator.Create()
+                        .Target("Build")
+                        .TaskMessage($"Message {i}", MessageImportance.High)
+                        .Save(projectPath.FullName));
+            }
+
+            ProjectCreator.Create(path: GetTempProjectPath())
+                .ForEach(projects, (project, creator) => creator.ItemProjectReference(project))
+                .Target("Build")
+                .Task("MSBuild", parameters: new Dictionary<string, string>
+                {
+                    ["Projects"] = "@(ProjectReference)",
+                    ["BuildInParallel"] = bool.TrueString,
+                })
+                .Save()
+                .TryBuild(out bool result, out BuildOutput buildOutput);
+
+            result.ShouldBeTrue(buildOutput.GetConsoleLog());
+
+            buildOutput.IsShutdown.ShouldBeTrue(buildOutput.GetConsoleLog());
+
+            buildOutput.MessageEvents.High.Count.ShouldBe(messageCount, buildOutput.GetConsoleLog());
+        }
+
+        [Fact]
+        public void BuildOutputIsComplete()
+        {
+            ProjectCreator.Create()
+                .Target("Build")
+                    .For(100, (i, creator) => creator.TaskMessage($"Message {i}", MessageImportance.High))
+                .TryBuild(out bool result, out BuildOutput buildOutput);
+
+            result.ShouldBeTrue(buildOutput.GetConsoleLog());
+
+            buildOutput.IsShutdown.ShouldBeTrue();
+
+            buildOutput.MessageEvents.High.Count.ShouldBe(100, buildOutput.GetConsoleLog());
+        }
+
         [Fact]
         public void CanBuildLotsOfProjects()
         {
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/BuildManagerHost.cs b/src/Microsoft.Build.Utilities.ProjectCreation/BuildManagerHost.cs
@@ -144,32 +144,12 @@ private static BuildResult Build(BuildRequestData buildRequestData, IEnumerable<
         {
             lock (LockObject)
             {
-                MuxLogger muxLogger = new MuxLogger
-                {
-                    Verbosity = LoggerVerbosity.Diagnostic,
-                };
-
                 BuildParameters buildParameters = new BuildParameters
                 {
                     EnableNodeReuse = false,
                     MaxNodeCount = Environment.ProcessorCount,
                     ResetCaches = true,
-                };
-
-                LoggerDescription forwardingLoggerDescription = new LoggerDescription(
-                    loggerClassName: typeof(ConfigurableForwardingLogger).FullName,
-                    loggerAssemblyName: typeof(ConfigurableForwardingLogger).Assembly.GetName().FullName,
-                    loggerAssemblyFile: null,
-                    loggerSwitchParameters: string.Empty,
-                    verbosity: muxLogger.Verbosity);
-
-                ForwardingLoggerRecord forwardingLoggerRecord = new ForwardingLoggerRecord(
-                    muxLogger,
-                    forwardingLoggerDescription);
-
-                buildParameters.ForwardingLoggers = new[]
-                {
-                    forwardingLoggerRecord,
+                    Loggers = loggers,
                 };
 
                 BuildManager.DefaultBuildManager.BeginBuild(buildParameters);
@@ -178,28 +158,16 @@ private static BuildResult Build(BuildRequestData buildRequestData, IEnumerable<
                 {
                     BuildSubmission buildSubmission = BuildManager.DefaultBuildManager.PendBuildRequest(buildRequestData);
 
-                    foreach (ILogger logger in loggers)
-                    {
-                        muxLogger.RegisterLogger(buildSubmission.SubmissionId, logger);
-                    }
-
-                    try
-                    {
-                        SetCurrentHost(BuildManager.DefaultBuildManager);
+                    SetCurrentHost(BuildManager.DefaultBuildManager);
 
-                        BuildResult buildResult = buildSubmission.Execute();
+                    BuildResult buildResult = buildSubmission.Execute();
 
-                        if (buildResult.Exception != null)
-                        {
-                            throw buildResult.Exception;
-                        }
-
-                        return buildResult;
-                    }
-                    finally
+                    if (buildResult.Exception != null)
                     {
-                        muxLogger.UnregisterLoggers(buildSubmission.SubmissionId);
+                        throw buildResult.Exception;
                     }
+
+                    return buildResult;
                 }
                 finally
                 {
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/BuildOutput.cs b/src/Microsoft.Build.Utilities.ProjectCreation/BuildOutput.cs
@@ -29,6 +29,11 @@ private BuildOutput()
             Parameters = string.Empty;
         }
 
+        /// <summary>
+        /// Gets a value indicating whether or not the build output is shut down.
+        /// </summary>
+        public bool IsShutdown { get; private set; }
+
         /// <inheritdoc cref="ILogger.Parameters" />
         public string Parameters { get; set; }
 
@@ -73,6 +78,7 @@ public void Initialize(IEventSource eventSource)
         /// <inheritdoc cref="ILogger.Shutdown" />
         public void Shutdown()
         {
+            IsShutdown = true;
         }
 
         private void OnAnyEventRaised(object sender, BuildEventArgs e)
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Linq.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ProjectCreator.Linq.cs
@@ -9,14 +9,30 @@ namespace Microsoft.Build.Utilities.ProjectCreation
 {
     public partial class ProjectCreator
     {
+        /// <summary>
+        /// Executes the specified action the specified number of times.
+        /// </summary>
+        /// <param name="count">The number of times to execute the action</param>
+        /// <param name="action">An <see cref="Action{T1, T2}" /> that is called the specified number of times.</param>
+        /// <returns>The current <see cref="ProjectCreator" />.</returns>
+        public ProjectCreator For(int count, Action<int, ProjectCreator> action)
+        {
+            for (int i = 0; i < count; i++)
+            {
+                action(i, this);
+            }
+
+            return this;
+        }
+
         /// <summary>
         /// Executes the specified action for each item in a list.
         /// </summary>
         /// <typeparam name="T">The type of the item.</typeparam>
         /// <param name="source">An <see cref="IEnumerable{T}" /> containing items to iterate through.</param>
         /// <param name="action">An <see cref="Action{T, ProjectCreator}" /> to execute against the current <see cref="ProjectCreator" />.</param>
         /// <returns>The current <see cref="ProjectCreator" />.</returns>
-        public ProjectCreator ForEach<T>(IEnumerable<T> source, Action<T, ProjectCreator> action)
+        public ProjectCreator ForEach<T>(IEnumerable<T>? source, Action<T, ProjectCreator> action)
         {
             if (source != null)
             {
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Unshipped.txt
@@ -1,4 +1,5 @@
-﻿Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
+﻿Microsoft.Build.Utilities.ProjectCreation.BuildOutput.IsShutdown.get -> bool
+Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
 Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool
@@ -73,7 +74,8 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! name
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.CustomAction(System.Action<Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>? projectCreator) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
-Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>! source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.For(int count, System.Action<int, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>? source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.FullPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Construction.ProjectRootElement! projectRootElement, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Evaluation.Project! project, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net5.0/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net5.0/PublicAPI.Unshipped.txt
@@ -1,4 +1,5 @@
-﻿Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
+﻿Microsoft.Build.Utilities.ProjectCreation.BuildOutput.IsShutdown.get -> bool
+Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
 Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool
@@ -73,7 +74,8 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! name
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.CustomAction(System.Action<Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>? projectCreator) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
-Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>! source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.For(int count, System.Action<int, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>? source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.FullPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Construction.ProjectRootElement! projectRootElement, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Evaluation.Project! project, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Unshipped.txt
@@ -1,4 +1,5 @@
-﻿Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
+﻿Microsoft.Build.Utilities.ProjectCreation.BuildOutput.IsShutdown.get -> bool
+Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
 Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool
@@ -73,7 +74,8 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! name
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.CustomAction(System.Action<Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>? projectCreator) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
-Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>! source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.For(int count, System.Action<int, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>? source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.FullPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Construction.ProjectRootElement! projectRootElement, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Evaluation.Project! project, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/netcoreapp3.1/PublicAPI.Unshipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/netcoreapp3.1/PublicAPI.Unshipped.txt
@@ -1,4 +1,5 @@
-﻿Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
+﻿Microsoft.Build.Utilities.ProjectCreation.BuildOutput.IsShutdown.get -> bool
+Microsoft.Build.Utilities.ProjectCreation.ExtensionMethods
 Microsoft.Build.Utilities.ProjectCreation.Package.Compare(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.CompareTo(Microsoft.Build.Utilities.ProjectCreation.Package? other) -> int
 Microsoft.Build.Utilities.ProjectCreation.Package.Equals(Microsoft.Build.Utilities.ProjectCreation.Package? x, Microsoft.Build.Utilities.ProjectCreation.Package? y) -> bool
@@ -73,7 +74,8 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! name
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.CustomAction(System.Action<Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>? projectCreator) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
-Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>! source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.For(int count, System.Action<int, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
+Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.ForEach<T>(System.Collections.Generic.IEnumerable<T>? source, System.Action<T, Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!>! action) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.FullPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Construction.ProjectRootElement! projectRootElement, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Import(Microsoft.Build.Evaluation.Project! project, string? condition = null, bool conditionOnExistence = false, string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,11 @@ private BuildOutput()`
`29`	`29`	`Parameters = string.Empty;`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ /// <summary>`
	`33`	`+ /// Gets a value indicating whether or not the build output is shut down.`
	`34`	`+ /// </summary>`
	`35`	`+ public bool IsShutdown { get; private set; }`
	`36`	`+`
`32`	`37`	`/// <inheritdoc cref="ILogger.Parameters" />`
`33`	`38`	`public string Parameters { get; set; }`
`34`	`39`
`@@ -73,6 +78,7 @@ public void Initialize(IEventSource eventSource)`
`73`	`78`	`/// <inheritdoc cref="ILogger.Shutdown" />`
`74`	`79`	`public void Shutdown()`
`75`	`80`	`{`
	`81`	`+ IsShutdown = true;`
`76`	`82`	`}`
`77`	`83`
`78`	`84`	`private void OnAnyEventRaised(object sender, BuildEventArgs e)`