Emit deprecation warning for Heat.

Fixes wixtoolset/issues#8913
wixtoolset · Jan 23, 2025 · 727f334 · 727f334
1 parent 7288b0b
commit 727f334
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 9 deletions.
diff --git a/src/ext/Bal/test/examples/Directory.wixproj.props b/src/ext/Bal/test/examples/Directory.wixproj.props
@@ -4,7 +4,7 @@
   <PropertyGroup>
     <OutputType>Bundle</OutputType>
     <TargetExt>.exe</TargetExt>
-    <HarvestDirectoryAdditionalOptions>-generate payloadgroup</HarvestDirectoryAdditionalOptions>
+    <HarvestDirectoryAdditionalOptions>-generate payloadgroup -sw5149</HarvestDirectoryAdditionalOptions>
     <OutputPath>$(OutputPath)examples\</OutputPath>
     <DefaultCompressionLevel>None</DefaultCompressionLevel>
     <InstallerPlatform>x64</InstallerPlatform>

diff --git a/src/test/burn/TestData/Manual/BundleB/BundleB.wixproj b/src/test/burn/TestData/Manual/BundleB/BundleB.wixproj
@@ -4,7 +4,7 @@
     <OutputType>Bundle</OutputType>
     <BA>hyperlinkLicense</BA>
     <UpgradeCode>{5DE2F206-3C37-4265-81F7-095284E16B08}</UpgradeCode>
-    <HarvestDirectoryAdditionalOptions>-generate payloadgroup</HarvestDirectoryAdditionalOptions>
+    <HarvestDirectoryAdditionalOptions>-generate payloadgroup -sw5149</HarvestDirectoryAdditionalOptions>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/tools/heat/Data/HarvesterWarnings.cs b/src/tools/heat/Data/HarvesterWarnings.cs
@@ -2,13 +2,17 @@
 
 namespace WixToolset.Harvesters.Data
 {
-    using System;
     using System.Resources;
     using WixToolset.Data;
 
 #pragma warning disable 1591 // TODO: add documentation
     public static class HarvesterWarnings
     {
+        public static Message HeatIsDeprecated()
+        {
+            return Message(null, Ids.HeatIsDeprecated, "Heat is deprecated and will be removed in WiX v7. Consider alternative solutions, like the Files element.");
+        }
+
         public static Message AssemblyHarvestFailed(string file, string message)
         {
             return Message(null, Ids.AssemblyHarvestFailed, "Could not harvest data from a file that was expected to be an assembly: {0}. If this file is not an assembly you can ignore this warning. Otherwise, this error detail may be helpful to diagnose the failure: {1}", file, message);
@@ -66,6 +70,7 @@ private static Message Message(SourceLineNumber sourceLineNumber, Ids id, Resour
 
         public enum Ids
         {
+            HeatIsDeprecated = 5149,
             SelfRegHarvestFailed = 5150,
             AssemblyHarvestFailed = 5151,
             TypeLibLoadFailed = 5152,

diff --git a/src/tools/heat/HeatCommand.cs b/src/tools/heat/HeatCommand.cs
@@ -15,7 +15,6 @@ namespace WixToolset.Harvesters
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
     using WixToolset.Harvesters.Extensibility;
-    using Wix = WixToolset.Harvesters.Serialize;
 
     internal class HeatCommand : BaseCommandLineCommand
     {

diff --git a/src/tools/heat/Program.cs b/src/tools/heat/Program.cs
@@ -12,6 +12,7 @@ namespace WixToolset.Tools.Heat
     using WixToolset.Extensibility.Data;
     using WixToolset.Extensibility.Services;
     using WixToolset.Harvesters;
+    using WixToolset.Harvesters.Data;
     using WixToolset.Harvesters.Extensibility;
     using WixToolset.Tools.Core;
 
@@ -78,6 +79,9 @@ public Task<int> Run(IServiceProvider serviceProvider, IMessageListener listener
 
             var commandLine = HeatCommandLineFactory.CreateCommandLine(serviceProvider, heatExtensions);
             var command = commandLine.ParseStandardCommandLine(arguments);
+
+            messaging.Write(HarvesterWarnings.HeatIsDeprecated());
+
             return command?.ExecuteAsync(CancellationToken.None) ?? Task.FromResult(1);
         }
     }

diff --git a/src/tools/test/WixToolsetTest.Heat/HeatRunner.cs b/src/tools/test/WixToolsetTest.Heat/HeatRunner.cs
@@ -37,7 +37,7 @@ public static int Execute(string[] args, out List<Message> messages, bool warnin
         /// <returns></returns>
         public static WixRunnerResult Execute(params string[] args)
         {
-            return Execute(true, args);
+            return Execute(warningsAsErrors: false, args);
         }
 
         /// <summary>

diff --git a/src/tools/test/WixToolsetTest.HeatTasks/MsbuildHeatFixture.cs b/src/tools/test/WixToolsetTest.HeatTasks/MsbuildHeatFixture.cs
@@ -47,7 +47,7 @@ public void CanBuildHeatFilePackage(BuildSystem buildSystem)
                 Assert.Single(heatCommandLines);
 
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
-                WixAssert.StringCollectionEmpty(warnings);
+                Assert.All(warnings, warning => warning.Contains("warning HEAT5149"));
 
                 var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_ProductComponents_INSTALLFOLDER_HeatFilePackage.wixproj_file.wxs");
                 var generatedContents = File.ReadAllText(generatedFilePath);
@@ -103,7 +103,7 @@ public void CanBuildHeatFileWithMultipleFilesPackage(BuildSystem buildSystem)
                 Assert.Equal(2, heatCommandLines.Count());
 
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
-                WixAssert.StringCollectionEmpty(warnings);
+                Assert.All(warnings, warning => warning.Contains("warning HEAT5149"));
 
                 var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_TxtProductComponents_INSTALLFOLDER_MyProgram.txt_file.wxs");
                 Assert.True(File.Exists(generatedFilePath));
@@ -198,7 +198,7 @@ public void CanBuildHeatProjectPreSdkStyle(BuildSystem buildSystem, bool useTool
                 }
 
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
-                WixAssert.StringCollectionEmpty(warnings);
+                Assert.All(warnings, warning => warning.Contains("warning HEAT5149"));
 
                 var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_Tools Version 4Cs.wxs");
                 Assert.True(File.Exists(generatedFilePath));
@@ -319,7 +319,7 @@ public void CanBuildHeatProjectSdkStyle(BuildSystem buildSystem, bool useToolsVe
                 }
 
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
-                WixAssert.StringCollectionEmpty(warnings);
+                Assert.All(warnings, warning => warning.Contains("warning HEAT5149"));
 
                 var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_SdkStyleCs.wxs");
                 Assert.True(File.Exists(generatedFilePath));