[Core] Support generating a binlog for any MSBuild target

Previously a binlog file would only be generated if a Build was run.
Now it is possible to have a binlog generated for any MSBuild target.
The filename for the bin log can be specified when running an MSBuild
target by setting the TargetEvaluationContext's BinLogFilePath.

Note that setting the BinLogFilePath if a build session is in progress
will not have any affect, the build session's binlog overrides this
setting.

Author: mrward

main/src/core/MonoDevelop.Core/MonoDevelop.Projects.MSBuild/RemoteProjectBuilder.cs

@@ -91,6 +91,7 @@ public async Task<MSBuildResult> Run (
 			TextWriter logWriter,
 			MSBuildLogger logger,
 			MSBuildVerbosity verbosity,
+			string binLogFilePath,
 			string[] runTargets,
 			string[] evaluateItems,
 			string[] evaluateProperties,
@@ -105,7 +106,7 @@ CancellationToken cancellationToken
 
 			try {
 				BeginOperation ();
-				var res = await SendRun (configurations, loggerId, logger.EnabledEvents, verbosity, runTargets, evaluateItems, evaluateProperties, globalProperties, taskId).ConfigureAwait (false);
+				var res = await SendRun (configurations, loggerId, logger.EnabledEvents, verbosity, binLogFilePath, runTargets, evaluateItems, evaluateProperties, globalProperties, taskId).ConfigureAwait (false);
 				if (res == null && cancellationToken.IsCancellationRequested) {
 					MSBuildTargetResult err = new MSBuildTargetResult (file, false, "", "", file, 1, 1, 1, 1, "Build cancelled", "");
 					return new MSBuildResult (new [] { err });
@@ -170,7 +171,7 @@ Task SendRefreshWithContent (string projectContent)
 			return connection.SendMessage (new RefreshWithContentRequest { ProjectId = projectId, Content = projectContent });
 		}
 
-		async Task<MSBuildResult> SendRun (ProjectConfigurationInfo [] configurations, int loggerId, MSBuildEvent enabledLogEvents, MSBuildVerbosity verbosity, string [] runTargets, string [] evaluateItems, string [] evaluateProperties, Dictionary<string, string> globalProperties, int taskId)
+		async Task<MSBuildResult> SendRun (ProjectConfigurationInfo [] configurations, int loggerId, MSBuildEvent enabledLogEvents, MSBuildVerbosity verbosity, string binLogFilePath, string [] runTargets, string [] evaluateItems, string [] evaluateProperties, Dictionary<string, string> globalProperties, int taskId)
 		{
 			var msg = new RunProjectRequest {
 				ProjectId = projectId,
@@ -182,7 +183,8 @@ async Task<MSBuildResult> SendRun (ProjectConfigurationInfo [] configurations, i
 				EvaluateItems = evaluateItems,
 				EvaluateProperties = evaluateProperties,
 				GlobalProperties = globalProperties,
-				TaskId = taskId
+				TaskId = taskId,
+				BinLogFilePath = binLogFilePath
 			};
 
 			var res = await connection.SendMessage (msg);
@@ -293,13 +295,14 @@ public Task<MSBuildResult> Run (
 			TextWriter logWriter,
 			MSBuildLogger logger,
 			MSBuildVerbosity verbosity,
+			string binLogFilePath,
 			string [] runTargets,
 			string [] evaluateItems,
 			string [] evaluateProperties,
 			Dictionary<string, string> globalProperties,
 			CancellationToken cancellationToken
 		) {
-			return builder.Run (configurations, logWriter, logger, verbosity, runTargets, evaluateItems, evaluateProperties, globalProperties, cancellationToken);
+			return builder.Run (configurations, logWriter, logger, verbosity, binLogFilePath, runTargets, evaluateItems, evaluateProperties, globalProperties, cancellationToken);
 		}
 
 		public void Dispose ()
@@ -317,6 +320,7 @@ Task<MSBuildResult> Run (
 			TextWriter logWriter,
 			MSBuildLogger logger,
 			MSBuildVerbosity verbosity,
+			string binLogFilePath,
 			string [] runTargets,
 			string [] evaluateItems,
 			string [] evaluateProperties,

main/src/core/MonoDevelop.Core/MonoDevelop.Projects/Project.cs

@@ -1509,7 +1509,7 @@ await Task.Run (async delegate {
 				var logger = context.Loggers.Count != 1 ? new ProxyLogger (this, context.Loggers) : context.Loggers.First ();
 
 				try {
-					result = await builder.Run (configs, monitor.Log, logger, context.LogVerbosity, targets, evaluateItems, evaluateProperties, globalProperties, monitor.CancellationToken).ConfigureAwait (false);
+					result = await builder.Run (configs, monitor.Log, logger, context.LogVerbosity, context.BinLogFilePath, targets, evaluateItems, evaluateProperties, globalProperties, monitor.CancellationToken).ConfigureAwait (false);
 				} finally {
 					builder.Dispose ();
 					t1.End ();

main/src/core/MonoDevelop.Core/MonoDevelop.Projects/TargetEvaluationContext.cs

@@ -56,6 +56,8 @@ public ICollection<MSBuildLogger> Loggers {
 			get { return loggers; }
 		}
 
+		public string BinLogFilePath { get; set; }
+
 		/// <summary>
 		/// Gets or sets the builder queue to be used to execute the target
 		/// </summary>

main/src/core/MonoDevelop.Projects.Formats.MSBuild/MonoDevelop.Projects.MSBuild/BuildEngine.Shared.cs

@@ -200,7 +200,7 @@ public BinaryMessage RunProject (RunProjectRequest msg)
 			var pb = GetProject (msg.ProjectId);
 			if (pb != null) {
 				var logger = msg.LogWriterId != -1 ? (IEngineLogWriter) new LogWriter (msg.LogWriterId, msg.EnabledLogEvents) : (IEngineLogWriter) new NullLogWriter ();
-				var res = pb.Run (msg.Configurations, logger, msg.Verbosity, msg.RunTargets, msg.EvaluateItems, msg.EvaluateProperties, msg.GlobalProperties, msg.TaskId);
+				var res = pb.Run (msg.Configurations, logger, msg.Verbosity, msg.BinLogFilePath, msg.RunTargets, msg.EvaluateItems, msg.EvaluateProperties, msg.GlobalProperties, msg.TaskId);
 				return new RunProjectResponse { Result = res };
 			}
 			return msg.CreateResponse ();

main/src/core/MonoDevelop.Projects.Formats.MSBuild/MonoDevelop.Projects.MSBuild/MSBuildLoggerAdapter.cs

@@ -93,6 +93,14 @@ public List<MSBuildTargetResult> BuildResult {
 			get { return results; }
 		}
 
+		public void AddLogger (ILogger logger)
+		{
+			var newLoggers = new ILogger [loggers.Length + 1];
+			Array.Copy (loggers, newLoggers, loggers.Length);
+			newLoggers [loggers.Length] = logger;
+			loggers = newLoggers;
+		}
+
 		void Initialize (IEventSource eventSource)
 		{
 			this.eventSource = eventSource;

main/src/core/MonoDevelop.Projects.Formats.MSBuild/MonoDevelop.Projects.MSBuild/ProjectBuilder.cs

@@ -54,7 +54,7 @@ public ProjectBuilder (BuildEngine buildEngine, ProjectCollection engine, string
 		}
 
 		public MSBuildResult Run (
-			ProjectConfigurationInfo[] configurations, IEngineLogWriter logWriter, MSBuildVerbosity verbosity,
+			ProjectConfigurationInfo[] configurations, IEngineLogWriter logWriter, MSBuildVerbosity verbosity, string binLogFilePath,
 			string[] runTargets, string[] evaluateItems, string[] evaluateProperties, Dictionary<string,string> globalProperties, int taskId)
 		{
 			if (runTargets == null || runTargets.Length == 0)
@@ -71,8 +71,16 @@ public MSBuildResult Run (
 				if (buildEngine.BuildOperationStarted) {
 					loggerAdapter = buildEngine.StartProjectSessionBuild (logWriter);
 				}
-				else
+				else {
 					loggerAdapter = new MSBuildLoggerAdapter (logWriter, verbosity);
+					if (!string.IsNullOrEmpty (binLogFilePath)) {
+						var binaryLogger = new BinaryLogger {
+							Parameters = binLogFilePath,
+							Verbosity = LoggerVerbosity.Diagnostic
+						};
+						loggerAdapter.AddLogger (binaryLogger);
+					}
+				}
 
 				try {
 					project = SetupProject (configurations);

main/src/core/MonoDevelop.Projects.Formats.MSBuild/MonoDevelop.Projects.MSBuild/RemoteBuildEngineMessages.cs

@@ -144,6 +144,9 @@ class RunProjectRequest: BinaryMessage<RunProjectResponse>
 
 		[MessageDataProperty]
 		public int TaskId { get; set; }
+
+		[MessageDataProperty]
+		public string BinLogFilePath { get; set; }
 	}
 
 	[MessageDataTypeAttribute]

main/tests/MonoDevelop.Core.Tests/MonoDevelop.Projects/BuilderManagerTests.cs

@@ -418,6 +418,7 @@ public async Task ReloadProject_ProjectDisposedWhilstTargetRunning_AnotherTarget
 								new StringWriter (),
 								new MSBuildLogger (),
 								MSBuildVerbosity.Quiet,
+								null,
 								new [] { "ResolveAssemblyReferences" },
 								new string [0],
 								new string [0],