Create WixToolset.Heat.nupkg to distribute heat.exe and Heat targets

Moves Heat functionality to the "tools" layer and packages it all
up in WixToolset.Heat.nupkg for distribution in WiX v4.

Completes 6838

1 files changed, 70 insertions, 35 deletions

diff --git a/src/wix/test/WixToolsetTest.Sdk/MsbuildHeatFixture.cs b/src/tools/test/WixToolsetTest.HeatTasks/MsbuildHeatFixture.cs
index f1fa2453..d54da457 100644
--- a/src/wix/test/WixToolsetTest.Sdk/MsbuildHeatFixture.cs
+++ b/src/tools/test/WixToolsetTest.HeatTasks/MsbuildHeatFixture.cs
@@ -3,7 +3,6 @@
 namespace WixToolsetTest.Sdk
 {
     using System;
-    using System.Collections.Generic;
     using System.IO;
     using System.Linq;
     using WixBuildTools.TestSupport;
@@ -14,23 +13,34 @@ namespace WixToolsetTest.Sdk
 
     public class MsbuildHeatFixture
     {
+        public static readonly string HeatTargetsPath = Path.Combine(Path.GetDirectoryName(new Uri(typeof(MsbuildHeatFixture).Assembly.CodeBase).AbsolutePath), "..", "..", "..", "publish", "WixToolset.Heat", "build", "WixToolset.Heat.targets");
+
+        public MsbuildHeatFixture()
+        {
+            EnsureWixSdkCached();
+        }
+
         [Theory]
         [InlineData(BuildSystem.DotNetCoreSdk)]
         [InlineData(BuildSystem.MSBuild)]
         [InlineData(BuildSystem.MSBuild64)]
         public void CanBuildHeatFilePackage(BuildSystem buildSystem)
         {
-            var sourceFolder = TestData.Get(@"TestData\HeatFilePackage");
+            var sourceFolder = TestData.Get("TestData", "HeatFilePackage");
 
-            using (var fs = new TestDataFolderFileSystem())
+            using (var fs = new DisposableFileSystem())
             {
-                fs.Initialize(sourceFolder);
-                var baseFolder = fs.BaseFolder;
-                var binFolder = Path.Combine(baseFolder, @"bin\");
+                var baseFolder = fs.GetFolder();
+                var binFolder = Path.Combine(baseFolder, @"bin");
                 var intermediateFolder = Path.Combine(baseFolder, @"obj\");
-                var projectPath = Path.Combine(baseFolder, "HeatFilePackage.wixproj");
+                var projectPath = Path.Combine(sourceFolder, "HeatFilePackage.wixproj");
 
-                var result = MsbuildUtilities.BuildProject(buildSystem, projectPath);
+                var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[] {
+                    "-Restore",
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "BaseIntermediateOutputPath", intermediateFolder),
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "OutputPath", binFolder),
+                });
                 result.AssertSuccess();
 
                 var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "file", buildSystem, true);
@@ -39,9 +49,7 @@ namespace WixToolsetTest.Sdk
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
                 WixAssert.StringCollectionEmpty(warnings);
 
-                var generatedFilePath = Path.Combine(intermediateFolder, "x86", "Release", "_ProductComponents_INSTALLFOLDER_HeatFilePackage.wixproj_file.wxs");
-                Assert.True(File.Exists(generatedFilePath));
-
+                var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_ProductComponents_INSTALLFOLDER_HeatFilePackage.wixproj_file.wxs");
                 var generatedContents = File.ReadAllText(generatedFilePath);
                 var testXml = generatedContents.GetTestXml();
                 WixAssert.StringEqual(@"<Wix>" +
@@ -59,9 +67,7 @@ namespace WixToolsetTest.Sdk
                     "</Fragment>" +
                     "</Wix>", testXml);
 
-                var pdbPath = Path.Combine(binFolder, "x86", "Release", "HeatFilePackage.wixpdb");
-                Assert.True(File.Exists(pdbPath));
-
+                var pdbPath = Path.Combine(binFolder, "HeatFilePackage.wixpdb");
                 var intermediate = Intermediate.Load(pdbPath);
                 var section = intermediate.Sections.Single();
 
@@ -76,17 +82,21 @@ namespace WixToolsetTest.Sdk
         [InlineData(BuildSystem.MSBuild64)]
         public void CanBuildHeatFileWithMultipleFilesPackage(BuildSystem buildSystem)
         {
-            var sourceFolder = TestData.Get(@"TestData\HeatFileMultipleFilesSameFileName");
+            var sourceFolder = TestData.Get(@"TestData", "HeatFileMultipleFilesSameFileName");
 
-            using (var fs = new TestDataFolderFileSystem())
+            using (var fs = new DisposableFileSystem())
             {
-                fs.Initialize(sourceFolder);
-                var baseFolder = fs.BaseFolder;
+                var baseFolder = fs.GetFolder();
                 var binFolder = Path.Combine(baseFolder, @"bin\");
                 var intermediateFolder = Path.Combine(baseFolder, @"obj\");
-                var projectPath = Path.Combine(baseFolder, "HeatFileMultipleFilesSameFileName.wixproj");
+                var projectPath = Path.Combine(sourceFolder, "HeatFileMultipleFilesSameFileName.wixproj");
 
-                var result = MsbuildUtilities.BuildProject(buildSystem, projectPath);
+                var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[] {
+                    "-Restore",
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "BaseIntermediateOutputPath", intermediateFolder),
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "OutputPath", binFolder),
+                });
                 result.AssertSuccess();
 
                 var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "file", buildSystem, true);
@@ -95,7 +105,7 @@ namespace WixToolsetTest.Sdk
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
                 WixAssert.StringCollectionEmpty(warnings);
 
-                var generatedFilePath = Path.Combine(intermediateFolder, "x86", "Release", "_TxtProductComponents_INSTALLFOLDER_MyProgram.txt_file.wxs");
+                var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_TxtProductComponents_INSTALLFOLDER_MyProgram.txt_file.wxs");
                 Assert.True(File.Exists(generatedFilePath));
 
                 var generatedContents = File.ReadAllText(generatedFilePath);
@@ -115,7 +125,7 @@ namespace WixToolsetTest.Sdk
                     "</Fragment>" +
                     "</Wix>", testXml);
 
-                generatedFilePath = Path.Combine(intermediateFolder, "x86", "Release", "_JsonProductComponents_INSTALLFOLDER_MyProgram.json_file.wxs");
+                generatedFilePath = Path.Combine(intermediateFolder, "Release", "_JsonProductComponents_INSTALLFOLDER_MyProgram.json_file.wxs");
                 Assert.True(File.Exists(generatedFilePath));
 
                 generatedContents = File.ReadAllText(generatedFilePath);
@@ -135,7 +145,7 @@ namespace WixToolsetTest.Sdk
                     "</Fragment>" +
                     "</Wix>", testXml);
 
-                var pdbPath = Path.Combine(binFolder, "x86", "Release", "HeatFileMultipleFilesSameFileName.wixpdb");
+                var pdbPath = Path.Combine(binFolder, "HeatFileMultipleFilesSameFileName.wixpdb");
                 Assert.True(File.Exists(pdbPath));
 
                 var intermediate = Intermediate.Load(pdbPath);
@@ -156,11 +166,13 @@ namespace WixToolsetTest.Sdk
         [InlineData(BuildSystem.MSBuild64, false)]
         public void CanBuildHeatProjectPreSdkStyle(BuildSystem buildSystem, bool useToolsVersion)
         {
-            var sourceFolder = TestData.Get(@"TestData\HeatProject");
+            var sourceFolder = TestData.Get(@"TestData", "HeatProject");
 
             using (var fs = new TestDataFolderFileSystem())
             {
                 fs.Initialize(sourceFolder);
+                File.Copy("global.json", Path.Combine(fs.BaseFolder, "global.json"));
+
                 var baseFolder = Path.Combine(fs.BaseFolder, "HeatProjectPreSdkStyle");
                 var binFolder = Path.Combine(baseFolder, @"bin\");
                 var intermediateFolder = Path.Combine(baseFolder, @"obj\");
@@ -168,8 +180,9 @@ namespace WixToolsetTest.Sdk
 
                 var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[]
                 {
-                    useToolsVersion ? $"-p:HarvestProjectsUseToolsVersion=true" : String.Empty,
-                });
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
+                     useToolsVersion ? $"-p:HarvestProjectsUseToolsVersion=true" : String.Empty,
+                 });
                 result.AssertSuccess();
 
                 var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "project", buildSystem, true);
@@ -187,7 +200,7 @@ namespace WixToolsetTest.Sdk
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
                 WixAssert.StringCollectionEmpty(warnings);
 
-                var generatedFilePath = Path.Combine(intermediateFolder, "x86", "Release", "_ToolsVersion4Cs.wxs");
+                var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_ToolsVersion4Cs.wxs");
                 Assert.True(File.Exists(generatedFilePath));
 
                 var generatedContents = File.ReadAllText(generatedFilePath);
@@ -246,7 +259,7 @@ namespace WixToolsetTest.Sdk
                     "</Fragment>" +
                     "</Wix>", testXml);
 
-                var pdbPath = Path.Combine(binFolder, "x86", "Release", "HeatProjectPreSdkStyle.wixpdb");
+                var pdbPath = Path.Combine(binFolder, "Release", "HeatProjectPreSdkStyle.wixpdb");
                 Assert.True(File.Exists(pdbPath));
 
                 var intermediate = Intermediate.Load(pdbPath);
@@ -271,22 +284,26 @@ namespace WixToolsetTest.Sdk
             using (var fs = new TestDataFolderFileSystem())
             {
                 fs.Initialize(sourceFolder);
+                File.Copy("global.json", Path.Combine(fs.BaseFolder, "global.json"));
+
                 var baseFolder = Path.Combine(fs.BaseFolder, "HeatProjectSdkStyle");
                 var binFolder = Path.Combine(baseFolder, @"bin\");
                 var intermediateFolder = Path.Combine(baseFolder, @"obj\");
-                var projectPath = Path.Combine(baseFolder, "HeatProjectSdkStyle.wixproj");
+                var projectPath = Path.Combine(fs.BaseFolder, "HeatProjectSdkStyle", "HeatProjectSdkStyle.wixproj");
                 var referencedProjectPath = Path.Combine(fs.BaseFolder, "SdkStyleCs", "SdkStyleCs.csproj");
 
                 var result = MsbuildUtilities.BuildProject(buildSystem, referencedProjectPath, new[]
                 {
-                    "-t:restore",
-                });
+                     "-t:restore",
+                     MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
+                 });
                 result.AssertSuccess();
 
                 result = MsbuildUtilities.BuildProject(buildSystem, projectPath, new[]
                 {
-                    useToolsVersion ? $"-p:HarvestProjectsUseToolsVersion=true" : String.Empty,
-                });
+                     MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "HeatTargetsPath", MsbuildHeatFixture.HeatTargetsPath),
+                     useToolsVersion ? $"-p:HarvestProjectsUseToolsVersion=true" : String.Empty,
+                 });
                 result.AssertSuccess();
 
                 var heatCommandLines = MsbuildUtilities.GetToolCommandLines(result, "heat", "project", buildSystem, true);
@@ -304,7 +321,7 @@ namespace WixToolsetTest.Sdk
                 var warnings = result.Output.Where(line => line.Contains(": warning")).ToArray();
                 WixAssert.StringCollectionEmpty(warnings);
 
-                var generatedFilePath = Path.Combine(intermediateFolder, "x86", "Release", "_SdkStyleCs.wxs");
+                var generatedFilePath = Path.Combine(intermediateFolder, "Release", "_SdkStyleCs.wxs");
                 Assert.True(File.Exists(generatedFilePath));
 
                 var generatedContents = File.ReadAllText(generatedFilePath);
@@ -361,7 +378,7 @@ namespace WixToolsetTest.Sdk
                     "</Fragment>" +
                     "</Wix>", testXml);
 
-                var pdbPath = Path.Combine(binFolder, "x86", "Release", "HeatProjectSdkStyle.wixpdb");
+                var pdbPath = Path.Combine(binFolder, "Release", "HeatProjectSdkStyle.wixpdb");
                 Assert.True(File.Exists(pdbPath));
 
                 var intermediate = Intermediate.Load(pdbPath);
@@ -371,5 +388,23 @@ namespace WixToolsetTest.Sdk
                 WixAssert.StringEqual(Path.Combine(fs.BaseFolder, "SdkStyleCs", "bin", "Release", "netstandard2.0\\\\SdkStyleCs.dll"), fileSymbol[FileSymbolFields.Source].AsPath()?.Path);
             }
         }
+
+        /// <summary>
+        /// This method exists to get the WixToolset.Sdk.nupkg into the NuGet package cache using the global.json
+        /// and nuget.config in the root of the repository. By pre-caching the WiX SDK, the rest of the tests will
+        /// pull the binaries out of the cache instead of needing to find the original .nupkg in the build artifacts
+        /// folder (which requires use of nuget.config found in the root of the repo)
+        /// </summary>
+        private static void EnsureWixSdkCached()
+        {
+            // This EnsureWixSdkCached project exists only to pre-cache the WixToolset.Sdk for use by later projects.
+            var sourceFolder = TestData.Get("TestData", "EnsureWixSdkCached");
+
+            var result = MsbuildUtilities.BuildProject(BuildSystem.DotNetCoreSdk, Path.Combine(sourceFolder, "EnsureWixSdkCached.wixproj"), new[]
+            {
+                "-t:restore",
+            });
+            result.AssertSuccess();
+        }
     }
 }