From a04ddca42b2070124c63a61c661e2b96a5bddac2 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Tue, 2 Jun 2020 19:45:25 +1000 Subject: Refactor the tasks so that the in-proc code is in partial classes. --- src/WixToolset.BuildTasks/HeatTask.cs | 20 +------ src/WixToolset.BuildTasks/HeatTask_InProc.cs | 27 +++++++++ src/WixToolset.BuildTasks/ToolsetTask.cs | 73 ++----------------------- src/WixToolset.BuildTasks/ToolsetTask_InProc.cs | 71 ++++++++++++++++++++++++ src/WixToolset.BuildTasks/WixBuild.cs | 46 +--------------- src/WixToolset.BuildTasks/WixBuild_InProc.cs | 53 ++++++++++++++++++ 6 files changed, 158 insertions(+), 132 deletions(-) create mode 100644 src/WixToolset.BuildTasks/HeatTask_InProc.cs create mode 100644 src/WixToolset.BuildTasks/ToolsetTask_InProc.cs create mode 100644 src/WixToolset.BuildTasks/WixBuild_InProc.cs (limited to 'src') diff --git a/src/WixToolset.BuildTasks/HeatTask.cs b/src/WixToolset.BuildTasks/HeatTask.cs index 5feed26d..99cbae77 100644 --- a/src/WixToolset.BuildTasks/HeatTask.cs +++ b/src/WixToolset.BuildTasks/HeatTask.cs @@ -3,16 +3,12 @@ namespace WixToolset.BuildTasks { using Microsoft.Build.Framework; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Data; - using WixToolset.Extensibility.Services; - using WixToolset.Harvesters; /// /// A base MSBuild task to run the WiX harvester. /// Specific harvester tasks should extend this class. /// - public abstract class HeatTask : ToolsetTask + public abstract partial class HeatTask : ToolsetTask { private bool autogenerageGuids; private bool generateGuidsNow; @@ -59,7 +55,6 @@ namespace WixToolset.BuildTasks set { this.transforms = value; } } - protected sealed override string TaskShortName => "HEAT"; protected sealed override string ToolName => "heat.exe"; /// @@ -72,19 +67,6 @@ namespace WixToolset.BuildTasks get; } - protected sealed override int ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener listener, string commandLineString) - { - var messaging = serviceProvider.GetService(); - messaging.SetListener(listener); - - var arguments = serviceProvider.GetService(); - arguments.Populate(commandLineString); - - var commandLine = HeatCommandLineFactory.CreateCommandLine(serviceProvider, true); - var command = commandLine.ParseStandardCommandLine(arguments); - return command?.Execute() ?? -1; - } - /// /// Builds a command line from options in this task. /// diff --git a/src/WixToolset.BuildTasks/HeatTask_InProc.cs b/src/WixToolset.BuildTasks/HeatTask_InProc.cs new file mode 100644 index 00000000..8190d9e2 --- /dev/null +++ b/src/WixToolset.BuildTasks/HeatTask_InProc.cs @@ -0,0 +1,27 @@ +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. + +namespace WixToolset.BuildTasks +{ + using WixToolset.Extensibility; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + using WixToolset.Harvesters; + + public partial class HeatTask + { + protected sealed override string TaskShortName => "HEAT"; + + protected sealed override int ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener listener, string commandLineString) + { + var messaging = serviceProvider.GetService(); + messaging.SetListener(listener); + + var arguments = serviceProvider.GetService(); + arguments.Populate(commandLineString); + + var commandLine = HeatCommandLineFactory.CreateCommandLine(serviceProvider, true); + var command = commandLine.ParseStandardCommandLine(arguments); + return command?.Execute() ?? -1; + } + } +} diff --git a/src/WixToolset.BuildTasks/ToolsetTask.cs b/src/WixToolset.BuildTasks/ToolsetTask.cs index fe6812fc..4fd7af3f 100644 --- a/src/WixToolset.BuildTasks/ToolsetTask.cs +++ b/src/WixToolset.BuildTasks/ToolsetTask.cs @@ -4,15 +4,9 @@ namespace WixToolset.BuildTasks { using System; using System.IO; - using System.Runtime.InteropServices; - using Microsoft.Build.Framework; using Microsoft.Build.Utilities; - using WixToolset.Core; - using WixToolset.Data; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Services; - public abstract class ToolsetTask : ToolTask + public abstract partial class ToolsetTask : ToolTask { /// /// Gets or sets additional options that are appended the the tool command-line. @@ -59,49 +53,6 @@ namespace WixToolset.BuildTasks /// public bool VerboseOutput { get; set; } - protected sealed override int ExecuteTool(string pathToTool, string responseFileCommands, string commandLineCommands) - { - if (this.RunAsSeparateProcess) - { - return base.ExecuteTool(pathToTool, responseFileCommands, commandLineCommands); - } - - return this.ExecuteInProc($"{commandLineCommands} {responseFileCommands}"); - } - - private int ExecuteInProc(string commandLineString) - { - this.Log.LogMessage(MessageImportance.Normal, $"({this.ToolName}){commandLineString}"); - - var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider(); - var listener = new MsbuildMessageListener(this.Log, this.TaskShortName, this.BuildEngine.ProjectFileOfTaskNode); - int exitCode = -1; - - try - { - exitCode = this.ExecuteCore(serviceProvider, listener, commandLineString); - } - catch (WixException e) - { - listener.Write(e.Error); - } - catch (Exception e) - { - this.Log.LogErrorFromException(e, showStackTrace: true, showDetail: true, null); - - if (e is NullReferenceException || e is SEHException) - { - throw; - } - } - - if (exitCode == 0 && this.Log.HasLoggedErrors) - { - exitCode = -1; - } - return exitCode; - } - /// /// Get the path to the executable. /// @@ -113,13 +64,12 @@ namespace WixToolset.BuildTasks protected sealed override string GenerateFullPathToTool() { var thisDllPath = new Uri(typeof(ToolsetTask).Assembly.CodeBase).AbsolutePath; - if (this.RunAsSeparateProcess) + if (!this.RunAsSeparateProcess) { - return Path.Combine(Path.GetDirectoryName(thisDllPath), this.ToolExe); + // We need to return a path that exists, so if we're not actually going to run the tool then just return this dll path. + return thisDllPath; } - - // We need to return a path that exists, so if we're not actually going to run the tool then just return this dll path. - return thisDllPath; + return Path.Combine(Path.GetDirectoryName(thisDllPath), this.ToolExe); } protected sealed override string GenerateResponseFileCommands() @@ -129,15 +79,6 @@ namespace WixToolset.BuildTasks return commandLineBuilder.ToString(); } - protected sealed override void LogToolCommand(string message) - { - // Only log this if we're actually going to do it. - if (this.RunAsSeparateProcess) - { - base.LogToolCommand(message); - } - } - /// /// Builds a command line from options in this and derivative tasks. /// @@ -153,9 +94,5 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendArrayIfNotNull("-wx ", this.TreatSpecificWarningsAsErrors); commandLineBuilder.AppendIfTrue("-wx", this.TreatWarningsAsErrors); } - - protected abstract int ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener messageListener, string commandLineString); - - protected abstract string TaskShortName { get; } } } diff --git a/src/WixToolset.BuildTasks/ToolsetTask_InProc.cs b/src/WixToolset.BuildTasks/ToolsetTask_InProc.cs new file mode 100644 index 00000000..4b365b2a --- /dev/null +++ b/src/WixToolset.BuildTasks/ToolsetTask_InProc.cs @@ -0,0 +1,71 @@ +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. + +namespace WixToolset.BuildTasks +{ + using System; + using System.Runtime.InteropServices; + using Microsoft.Build.Framework; + using WixToolset.Core; + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Services; + + public partial class ToolsetTask + { + protected sealed override int ExecuteTool(string pathToTool, string responseFileCommands, string commandLineCommands) + { + if (this.RunAsSeparateProcess) + { + return base.ExecuteTool(pathToTool, responseFileCommands, commandLineCommands); + } + + return this.ExecuteInProc($"{commandLineCommands} {responseFileCommands}"); + } + + private int ExecuteInProc(string commandLineString) + { + this.Log.LogMessage(MessageImportance.Normal, $"({this.ToolName}){commandLineString}"); + + var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider(); + var listener = new MsbuildMessageListener(this.Log, this.TaskShortName, this.BuildEngine.ProjectFileOfTaskNode); + int exitCode = -1; + + try + { + exitCode = this.ExecuteCore(serviceProvider, listener, commandLineString); + } + catch (WixException e) + { + listener.Write(e.Error); + } + catch (Exception e) + { + this.Log.LogErrorFromException(e, showStackTrace: true, showDetail: true, null); + + if (e is NullReferenceException || e is SEHException) + { + throw; + } + } + + if (exitCode == 0 && this.Log.HasLoggedErrors) + { + exitCode = -1; + } + return exitCode; + } + + protected sealed override void LogToolCommand(string message) + { + // Only log this if we're actually going to do it. + if (this.RunAsSeparateProcess) + { + base.LogToolCommand(message); + } + } + + protected abstract int ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener messageListener, string commandLineString); + + protected abstract string TaskShortName { get; } + } +} diff --git a/src/WixToolset.BuildTasks/WixBuild.cs b/src/WixToolset.BuildTasks/WixBuild.cs index c15bc2f7..b669c52b 100644 --- a/src/WixToolset.BuildTasks/WixBuild.cs +++ b/src/WixToolset.BuildTasks/WixBuild.cs @@ -5,15 +5,11 @@ namespace WixToolset.BuildTasks using System; using System.Collections.Generic; using Microsoft.Build.Framework; - using WixToolset.Data; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Data; - using WixToolset.Extensibility.Services; /// /// An MSBuild task to run the WiX compiler. /// - public sealed class WixBuild : ToolsetTask + public sealed partial class WixBuild : ToolsetTask { public string[] Cultures { get; set; } @@ -76,24 +72,8 @@ namespace WixToolset.BuildTasks public string[] SuppressIces { get; set; } public string AdditionalCub { get; set; } - protected override string TaskShortName => "WIX"; protected override string ToolName => "wix.exe"; - protected override int ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener listener, string commandLineString) - { - var messaging = serviceProvider.GetService(); - messaging.SetListener(listener); - - var arguments = serviceProvider.GetService(); - arguments.Populate(commandLineString); - - var commandLine = serviceProvider.GetService(); - commandLine.ExtensionManager = this.CreateExtensionManagerWithStandardBackends(serviceProvider, messaging, arguments.Extensions); - commandLine.Arguments = arguments; - var command = commandLine.ParseStandardCommandLine(); - return command?.Execute() ?? -1; - } - protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) { commandLineBuilder.AppendTextUnquoted("build"); @@ -126,30 +106,6 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendFileNamesIfNotNull(this.SourceFiles, " "); } - private IExtensionManager CreateExtensionManagerWithStandardBackends(IWixToolsetServiceProvider serviceProvider, IMessaging messaging, string[] extensions) - { - var extensionManager = serviceProvider.GetService(); - - foreach (var type in new[] { typeof(WixToolset.Core.Burn.WixToolsetStandardBackend), typeof(WixToolset.Core.WindowsInstaller.WixToolsetStandardBackend) }) - { - extensionManager.Add(type.Assembly); - } - - foreach (var extension in extensions) - { - try - { - extensionManager.Load(extension); - } - catch (WixException e) - { - messaging.Write(e.Error); - } - } - - return extensionManager; - } - private IEnumerable CalculateBindPathStrings() { if (null != this.BindInputPaths) diff --git a/src/WixToolset.BuildTasks/WixBuild_InProc.cs b/src/WixToolset.BuildTasks/WixBuild_InProc.cs new file mode 100644 index 00000000..8e9f2fec --- /dev/null +++ b/src/WixToolset.BuildTasks/WixBuild_InProc.cs @@ -0,0 +1,53 @@ +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. + +namespace WixToolset.BuildTasks +{ + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + public partial class WixBuild + { + protected override string TaskShortName => "WIX"; + + protected override int ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener listener, string commandLineString) + { + var messaging = serviceProvider.GetService(); + messaging.SetListener(listener); + + var arguments = serviceProvider.GetService(); + arguments.Populate(commandLineString); + + var commandLine = serviceProvider.GetService(); + commandLine.ExtensionManager = this.CreateExtensionManagerWithStandardBackends(serviceProvider, messaging, arguments.Extensions); + commandLine.Arguments = arguments; + var command = commandLine.ParseStandardCommandLine(); + return command?.Execute() ?? -1; + } + + private IExtensionManager CreateExtensionManagerWithStandardBackends(IWixToolsetServiceProvider serviceProvider, IMessaging messaging, string[] extensions) + { + var extensionManager = serviceProvider.GetService(); + + foreach (var type in new[] { typeof(WixToolset.Core.Burn.WixToolsetStandardBackend), typeof(WixToolset.Core.WindowsInstaller.WixToolsetStandardBackend) }) + { + extensionManager.Add(type.Assembly); + } + + foreach (var extension in extensions) + { + try + { + extensionManager.Load(extension); + } + catch (WixException e) + { + messaging.Write(e.Error); + } + } + + return extensionManager; + } + } +} -- cgit v1.2.3-55-g6feb