From e087bb766a7f85d78d1bfa7b240a08db4e27f730 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Fri, 8 May 2020 21:57:31 +1000 Subject: Implement Heat tasks from WixToolset.Harvesters --- src/WixToolset.BuildTasks/DoIt.cs | 73 ++------------ src/WixToolset.BuildTasks/HeatDirectory.cs | 11 +-- src/WixToolset.BuildTasks/HeatFile.cs | 11 +-- src/WixToolset.BuildTasks/HeatProject.cs | 11 +-- src/WixToolset.BuildTasks/HeatTask.cs | 52 ++++------ src/WixToolset.BuildTasks/ToolsetTask.cs | 105 +++++++++++++++++++++ .../WixToolset.BuildTasks.csproj | 3 +- src/WixToolset.BuildTasks/wix.harvest.targets | 14 +-- src/WixToolset.BuildTasks/wix.targets | 3 +- .../WixToolset.Tools.Core.csproj | 2 +- .../MsbuildHeatFixture.cs | 75 +++++++++++++++ .../HeatFilePackage/HeatFilePackage.wixproj | 56 +++++++++++ .../TestData/HeatFilePackage/Package.wxs | 21 +++++ .../WixToolsetTest.BuildTasks.csproj | 9 ++ src/wix/wix.csproj | 2 +- src/wixcop/WixCop.csproj | 2 +- 16 files changed, 302 insertions(+), 148 deletions(-) create mode 100644 src/WixToolset.BuildTasks/ToolsetTask.cs create mode 100644 src/test/WixToolsetTest.BuildTasks/MsbuildHeatFixture.cs create mode 100644 src/test/WixToolsetTest.BuildTasks/TestData/HeatFilePackage/HeatFilePackage.wixproj create mode 100644 src/test/WixToolsetTest.BuildTasks/TestData/HeatFilePackage/Package.wxs (limited to 'src') diff --git a/src/WixToolset.BuildTasks/DoIt.cs b/src/WixToolset.BuildTasks/DoIt.cs index 1872f9e4..d95d6e3c 100644 --- a/src/WixToolset.BuildTasks/DoIt.cs +++ b/src/WixToolset.BuildTasks/DoIt.cs @@ -16,10 +16,8 @@ namespace WixToolset.BuildTasks /// /// An MSBuild task to run the WiX compiler. /// - public sealed class DoIt : Task + public sealed class DoIt : ToolsetTask { - public string AdditionalOptions { get; set; } - public string[] Cultures { get; set; } public string[] DefineConstants { get; set; } @@ -37,8 +35,6 @@ namespace WixToolset.BuildTasks public ITaskItem[] LocalizationFiles { get; set; } - public bool NoLogo { get; set; } - public ITaskItem[] LibraryFiles { get; set; } [Output] @@ -59,32 +55,6 @@ namespace WixToolset.BuildTasks public string[] ReferencePaths { get; set; } - /// - /// Gets or sets whether all warnings should be suppressed. - /// - public bool SuppressAllWarnings { get; set; } - - /// - /// Gets or sets a list of specific warnings to be suppressed. - /// - public string[] SuppressSpecificWarnings { get; set; } - - /// - /// Gets or sets whether all warnings should be treated as errors. - /// - public bool TreatWarningsAsErrors { get; set; } - - /// - /// Gets or sets a list of specific warnings to treat as errors. - /// - public string[] TreatSpecificWarningsAsErrors { get; set; } - - /// - /// Gets or sets whether to display verbose output. - /// - public bool VerboseOutput { get; set; } - - public ITaskItem[] BindInputPaths { get; set; } public bool BindFiles { get; set; } @@ -109,37 +79,10 @@ namespace WixToolset.BuildTasks public string[] SuppressIces { get; set; } public string AdditionalCub { get; set; } - public override bool Execute() - { - var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider(); - - var listener = new MsbuildMessageListener(this.Log, "WIX", this.BuildEngine.ProjectFileOfTaskNode); - - try - { - this.ExecuteCore(serviceProvider, listener); - } - 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; - } - } + protected override string TaskShortName => "WIX"; - return !this.Log.HasLoggedErrors; - } - - private void ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener listener) + protected override void ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener listener, string commandLineString) { - var commandLineString = this.BuildCommandLine(); - this.Log.LogMessage(MessageImportance.Normal, "wix.exe " + commandLineString); var messaging = serviceProvider.GetService(); @@ -155,10 +98,8 @@ namespace WixToolset.BuildTasks command?.Execute(); } - private string BuildCommandLine() + protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) { - var commandLineBuilder = new WixCommandLineBuilder(); - commandLineBuilder.AppendTextUnquoted("build"); commandLineBuilder.AppendSwitchIfNotNull("-platform ", this.InstallerPlatform); @@ -166,14 +107,12 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendSwitchIfNotNull("-outputType ", this.OutputType); commandLineBuilder.AppendSwitchIfNotNull("-pdb ", this.PdbFile); commandLineBuilder.AppendSwitchIfNotNull("-pdbType ", this.PdbType); - commandLineBuilder.AppendIfTrue("-nologo", this.NoLogo); commandLineBuilder.AppendArrayIfNotNull("-culture ", this.Cultures); commandLineBuilder.AppendArrayIfNotNull("-d ", this.DefineConstants); commandLineBuilder.AppendArrayIfNotNull("-I ", this.IncludeSearchPaths); commandLineBuilder.AppendExtensions(this.Extensions, this.ExtensionDirectory, this.ReferencePaths); commandLineBuilder.AppendIfTrue("-sval", this.SuppressValidation); commandLineBuilder.AppendArrayIfNotNull("-sice ", this.SuppressIces); - commandLineBuilder.AppendArrayIfNotNull("-sw ", this.SuppressSpecificWarnings); commandLineBuilder.AppendSwitchIfNotNull("-usf ", this.UnreferencedSymbolsFile); commandLineBuilder.AppendSwitchIfNotNull("-cc ", this.CabinetCachePath); commandLineBuilder.AppendSwitchIfNotNull("-intermediatefolder ", this.IntermediateDirectory); @@ -181,14 +120,14 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendSwitchIfNotNull("-outputsfile ", this.BindOutputsFile); commandLineBuilder.AppendSwitchIfNotNull("-builtoutputsfile ", this.BindBuiltOutputsFile); + base.BuildCommandLine(commandLineBuilder); + commandLineBuilder.AppendIfTrue("-bindFiles", this.BindFiles); commandLineBuilder.AppendArrayIfNotNull("-bindPath ", this.CalculateBindPathStrings()); commandLineBuilder.AppendArrayIfNotNull("-loc ", this.LocalizationFiles); commandLineBuilder.AppendArrayIfNotNull("-lib ", this.LibraryFiles); commandLineBuilder.AppendTextIfNotWhitespace(this.AdditionalOptions); commandLineBuilder.AppendFileNamesIfNotNull(this.SourceFiles, " "); - - return commandLineBuilder.ToString(); } private IExtensionManager CreateExtensionManagerWithStandardBackends(IWixToolsetServiceProvider serviceProvider, IMessaging messaging, string[] extensions) diff --git a/src/WixToolset.BuildTasks/HeatDirectory.cs b/src/WixToolset.BuildTasks/HeatDirectory.cs index 112418e7..79da303a 100644 --- a/src/WixToolset.BuildTasks/HeatDirectory.cs +++ b/src/WixToolset.BuildTasks/HeatDirectory.cs @@ -4,7 +4,6 @@ namespace WixToolset.BuildTasks { using Microsoft.Build.Framework; -#if false public sealed class HeatDirectory : HeatTask { private string directory; @@ -77,14 +76,8 @@ namespace WixToolset.BuildTasks get { return "dir"; } } - /// - /// Generate the command line arguments to write to the response file from the properties. - /// - /// Command line string. - protected override string GenerateResponseFileCommands() + protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) { - WixCommandLineBuilder commandLineBuilder = new WixCommandLineBuilder(); - commandLineBuilder.AppendSwitch(this.OperationName); commandLineBuilder.AppendFileNameIfNotNull(this.Directory); @@ -98,8 +91,6 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendSwitchIfNotNull("-var ", this.PreprocessorVariable); base.BuildCommandLine(commandLineBuilder); - return commandLineBuilder.ToString(); } } -#endif } diff --git a/src/WixToolset.BuildTasks/HeatFile.cs b/src/WixToolset.BuildTasks/HeatFile.cs index e21d61f5..57fe579d 100644 --- a/src/WixToolset.BuildTasks/HeatFile.cs +++ b/src/WixToolset.BuildTasks/HeatFile.cs @@ -4,7 +4,6 @@ namespace WixToolset.BuildTasks { using Microsoft.Build.Framework; -#if false public sealed class HeatFile : HeatTask { private string file; @@ -70,14 +69,8 @@ namespace WixToolset.BuildTasks get { return "file"; } } - /// - /// Generate the command line arguments to write to the response file from the properties. - /// - /// Command line string. - protected override string GenerateResponseFileCommands() + protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) { - WixCommandLineBuilder commandLineBuilder = new WixCommandLineBuilder(); - commandLineBuilder.AppendSwitch(this.OperationName); commandLineBuilder.AppendFileNameIfNotNull(this.File); @@ -90,8 +83,6 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendSwitchIfNotNull("-var ", this.PreprocessorVariable); base.BuildCommandLine(commandLineBuilder); - return commandLineBuilder.ToString(); } } -#endif } diff --git a/src/WixToolset.BuildTasks/HeatProject.cs b/src/WixToolset.BuildTasks/HeatProject.cs index c8f56688..71679dc4 100644 --- a/src/WixToolset.BuildTasks/HeatProject.cs +++ b/src/WixToolset.BuildTasks/HeatProject.cs @@ -4,7 +4,6 @@ namespace WixToolset.BuildTasks { using Microsoft.Build.Framework; -#if false public sealed class HeatProject : HeatTask { private string configuration; @@ -83,14 +82,8 @@ namespace WixToolset.BuildTasks get { return "project"; } } - /// - /// Generate the command line arguments to write to the response file from the properties. - /// - /// Command line string. - protected override string GenerateResponseFileCommands() + protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) { - WixCommandLineBuilder commandLineBuilder = new WixCommandLineBuilder(); - commandLineBuilder.AppendSwitch(this.OperationName); commandLineBuilder.AppendFileNameIfNotNull(this.Project); @@ -103,8 +96,6 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendIfTrue("-wixvar", this.GenerateWixVariables); base.BuildCommandLine(commandLineBuilder); - return commandLineBuilder.ToString(); } } -#endif } diff --git a/src/WixToolset.BuildTasks/HeatTask.cs b/src/WixToolset.BuildTasks/HeatTask.cs index 8b12c48c..586f02f7 100644 --- a/src/WixToolset.BuildTasks/HeatTask.cs +++ b/src/WixToolset.BuildTasks/HeatTask.cs @@ -2,24 +2,18 @@ namespace WixToolset.BuildTasks { - using System; - using System.Diagnostics; - using System.Globalization; - using System.IO; - using System.Text; - using Microsoft.Build.Framework; - using Microsoft.Build.Utilities; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + using WixToolset.Harvesters; -#if false /// /// A base MSBuild task to run the WiX harvester. /// Specific harvester tasks should extend this class. /// - public abstract class HeatTask : WixToolTask + public abstract class HeatTask : ToolsetTask { - private const string HeatToolName = "Heat.exe"; - private bool autogenerageGuids; private bool generateGuidsNow; private ITaskItem outputFile; @@ -65,15 +59,7 @@ namespace WixToolset.BuildTasks set { this.transforms = value; } } - /// - /// Get the name of the executable. - /// - /// The ToolName is used with the ToolPath to get the location of heat.exe. - /// The name of the executable. - protected override string ToolName - { - get { return HeatToolName; } - } + protected override string TaskShortName => "HEAT"; /// /// Gets the name of the heat operation performed by the task. @@ -85,20 +71,19 @@ namespace WixToolset.BuildTasks get; } - /// - /// Get the path to the executable. - /// - /// GetFullPathToTool is only called when the ToolPath property is not set (see the ToolName remarks above). - /// The full path to the executable or simply heat.exe if it's expected to be in the system path. - protected override string GenerateFullPathToTool() + protected override void ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener listener, string commandLineString) { - // If there's not a ToolPath specified, it has to be in the system path. - if (String.IsNullOrEmpty(this.ToolPath)) - { - return HeatToolName; - } + this.Log.LogMessage(MessageImportance.Normal, "heat.exe " + commandLineString); + + var messaging = serviceProvider.GetService(); + messaging.SetListener(listener); + + var arguments = serviceProvider.GetService(); + arguments.Populate(commandLineString); - return Path.Combine(Path.GetFullPath(this.ToolPath), HeatToolName); + var commandLine = HeatCommandLineFactory.CreateCommandLine(serviceProvider, true); + var command = commandLine.ParseStandardCommandLine(arguments); + command?.Execute(); } /// @@ -110,14 +95,11 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendIfTrue("-ag", this.AutogenerateGuids); commandLineBuilder.AppendIfTrue("-gg", this.GenerateGuidsNow); - commandLineBuilder.AppendIfTrue("-nologo", this.NoLogo); commandLineBuilder.AppendIfTrue("-sfrag", this.SuppressFragments); commandLineBuilder.AppendIfTrue("-suid", this.SuppressUniqueIds); - commandLineBuilder.AppendArrayIfNotNull("-sw", this.SuppressSpecificWarnings); commandLineBuilder.AppendArrayIfNotNull("-t ", this.Transforms); commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions); commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); } } -#endif } diff --git a/src/WixToolset.BuildTasks/ToolsetTask.cs b/src/WixToolset.BuildTasks/ToolsetTask.cs new file mode 100644 index 00000000..713a938b --- /dev/null +++ b/src/WixToolset.BuildTasks/ToolsetTask.cs @@ -0,0 +1,105 @@ +// 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.Utilities; + using WixToolset.Core; + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Services; + + public abstract class ToolsetTask : Task + { + /// + /// Gets or sets additional options that are appended the the tool command-line. + /// + /// + /// This allows the task to support extended options in the tool which are not + /// explicitly implemented as properties on the task. + /// + public string AdditionalOptions { get; set; } + + /// + /// Gets or sets whether to display the logo. + /// + public bool NoLogo { get; set; } + + /// + /// Gets or sets whether all warnings should be suppressed. + /// + public bool SuppressAllWarnings { get; set; } + + /// + /// Gets or sets a list of specific warnings to be suppressed. + /// + public string[] SuppressSpecificWarnings { get; set; } + + /// + /// Gets or sets whether all warnings should be treated as errors. + /// + public bool TreatWarningsAsErrors { get; set; } + + /// + /// Gets or sets a list of specific warnings to treat as errors. + /// + public string[] TreatSpecificWarningsAsErrors { get; set; } + + /// + /// Gets or sets whether to display verbose output. + /// + public bool VerboseOutput { get; set; } + + public override bool Execute() + { + var serviceProvider = WixToolsetServiceProviderFactory.CreateServiceProvider(); + + var listener = new MsbuildMessageListener(this.Log, this.TaskShortName, this.BuildEngine.ProjectFileOfTaskNode); + + try + { + var commandLineBuilder = new WixCommandLineBuilder(); + this.BuildCommandLine(commandLineBuilder); + + var commandLineString = commandLineBuilder.ToString(); + 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; + } + } + + return !this.Log.HasLoggedErrors; + } + + /// + /// Builds a command line from options in this and derivative tasks. + /// + /// + /// Derivative classes should call BuildCommandLine() on the base class to ensure that common command line options are added to the command. + /// + protected virtual void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) + { + commandLineBuilder.AppendIfTrue("-nologo", this.NoLogo); + commandLineBuilder.AppendArrayIfNotNull("-sw ", this.SuppressSpecificWarnings); + commandLineBuilder.AppendIfTrue("-sw", this.SuppressAllWarnings); + commandLineBuilder.AppendIfTrue("-v", this.VerboseOutput); + commandLineBuilder.AppendArrayIfNotNull("-wx ", this.TreatSpecificWarningsAsErrors); + commandLineBuilder.AppendIfTrue("-wx", this.TreatWarningsAsErrors); + } + + protected abstract void ExecuteCore(IWixToolsetServiceProvider serviceProvider, IMessageListener messageListener, string commandLineString); + + protected abstract string TaskShortName { get; } + } +} diff --git a/src/WixToolset.BuildTasks/WixToolset.BuildTasks.csproj b/src/WixToolset.BuildTasks/WixToolset.BuildTasks.csproj index f8983121..b86b1f53 100644 --- a/src/WixToolset.BuildTasks/WixToolset.BuildTasks.csproj +++ b/src/WixToolset.BuildTasks/WixToolset.BuildTasks.csproj @@ -31,6 +31,7 @@ + @@ -39,7 +40,7 @@ - + diff --git a/src/WixToolset.BuildTasks/wix.harvest.targets b/src/WixToolset.BuildTasks/wix.harvest.targets index e94dfcea..a8be17df 100644 --- a/src/WixToolset.BuildTasks/wix.harvest.targets +++ b/src/WixToolset.BuildTasks/wix.harvest.targets @@ -7,7 +7,7 @@ $(MSBuildThisFileFullPath) - $(WixTargetsPath)WixTasks.dll + $(WixTargetsPath)WixToolset.BuildTasks.dll @@ -260,10 +260,9 @@ Condition=" $(EnableProjectHarvesting) and ('@(HeatProject)' != '' or '@(HarvestProject)' != '') "> @@ -347,10 +345,9 @@ Condition=" '@(HarvestDirectory)' != '' "> - $(WixBinDir) - $(WixToolDir) + $(WixBinDir)