From 0b9fd5ae84460d943e685b9821473f356a66bd3b Mon Sep 17 00:00:00 2001
From: paulomorgado <470455+paulomorgado@users.noreply.github.com>
Date: Mon, 25 May 2020 13:13:25 +0100
Subject: Allow more than one harvested file and files differing by extension
 add component and directory for more disambiguation Fix HarvestFile Ouput
 added unit tests

---
 src/WixToolset.BuildTasks/wix.harvest.targets      |  4 +-
 .../MsbuildHeatFixture.cs                          | 79 +++++++++++++++++++++-
 .../HeatFileMultpleFilesSameFileName.wixproj       | 61 +++++++++++++++++
 .../MyProgram.json                                 |  1 +
 .../HeatFileMultpleFilesSameFileName/MyProgram.txt |  1 +
 .../HeatFileMultpleFilesSameFileName/Package.wxs   | 22 ++++++
 .../WixToolsetTest.BuildTasks.csproj               |  6 +-
 7 files changed, 170 insertions(+), 4 deletions(-)
 create mode 100644 src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/HeatFileMultpleFilesSameFileName.wixproj
 create mode 100644 src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.json
 create mode 100644 src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.txt
 create mode 100644 src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/Package.wxs

(limited to 'src')

diff --git a/src/WixToolset.BuildTasks/wix.harvest.targets b/src/WixToolset.BuildTasks/wix.harvest.targets
index a8be17df..5dd2f729 100644
--- a/src/WixToolset.BuildTasks/wix.harvest.targets
+++ b/src/WixToolset.BuildTasks/wix.harvest.targets
@@ -415,7 +415,7 @@
   <Target Name="HarvestFile"
     DependsOnTargets="$(HarvestFileDependsOn)"
     Inputs="@(HarvestFile);%(HarvestFile.Transforms)"
-    Outputs="$(IntermediateOutputPath)_%(HarvestFile.Filename)_file.wxs"
+    Outputs="@(HarvestFile->'$(IntermediateOutputPath)_%(ComponentGroupName)_%(DirectoryRefId)_%(Filename)%(Extension)_file.wxs')"
     Condition=" '@(HarvestFile)' != '' ">
 
     <HeatFile
@@ -427,7 +427,7 @@
       VerboseOutput="$(HarvestFileVerboseOutput)"
       AutogenerateGuids="$(HarvestFileAutogenerateGuids)"
       GenerateGuidsNow="$(HarvestFileGenerateGuidsNow)"
-      OutputFile="$(IntermediateOutputPath)_%(HarvestFile.Filename)_file.wxs"
+      OutputFile="$(IntermediateOutputPath)_%(HarvestFile.ComponentGroupName)_%(HarvestFile.DirectoryRefId)_%(HarvestFile.Filename)%(HarvestFile.Extension)_file.wxs"
       SuppressFragments="$(HarvestFileSuppressFragments)"
       SuppressUniqueIds="$(HarvestFileSuppressUniqueIds)"
       Transforms="%(HarvestFile.Transforms)"
diff --git a/src/test/WixToolsetTest.BuildTasks/MsbuildHeatFixture.cs b/src/test/WixToolsetTest.BuildTasks/MsbuildHeatFixture.cs
index de78c0bc..13dd0160 100644
--- a/src/test/WixToolsetTest.BuildTasks/MsbuildHeatFixture.cs
+++ b/src/test/WixToolsetTest.BuildTasks/MsbuildHeatFixture.cs
@@ -41,7 +41,7 @@ namespace WixToolsetTest.BuildTasks
                 var warnings = result.Output.Where(line => line.Contains(": warning"));
                 Assert.Empty(warnings);
 
-                var generatedFilePath = Path.Combine(intermediateFolder, @"_HeatFilePackage_file.wxs");
+                var generatedFilePath = Path.Combine(intermediateFolder, @"_ProductComponents_INSTALLFOLDER_HeatFilePackage.wixproj_file.wxs");
                 Assert.True(File.Exists(generatedFilePath));
 
                 var generatedContents = File.ReadAllText(generatedFilePath);
@@ -71,5 +71,82 @@ namespace WixToolsetTest.BuildTasks
                 Assert.Equal(@"SourceDir\HeatFilePackage.wixproj", fileTuple[FileTupleFields.Source].PreviousValue.AsPath().Path);
             }
         }
+
+        [Fact]
+        public void CanBuildHeatFileWithMultipleFilesPackage()
+        {
+            var projectPath = TestData.Get(@"TestData\HeatFileMultpleFilesSameFileName\HeatFileMultpleFilesSameFileName.wixproj");
+
+            using (var fs = new DisposableFileSystem())
+            {
+                var baseFolder = fs.GetFolder();
+                var binFolder = Path.Combine(baseFolder, @"bin\");
+                var intermediateFolder = Path.Combine(baseFolder, @"obj\");
+
+                var result = MsbuildRunner.Execute(projectPath, new[]
+                {
+                    $"-p:WixTargetsPath={WixTargetsPath}",
+                    $"-p:IntermediateOutputPath={intermediateFolder}",
+                    $"-p:OutputPath={binFolder}"
+                });
+                result.AssertSuccess();
+
+                var heatCommandLines = result.Output.Where(line => line.TrimStart().StartsWith("heat.exe file"));
+                Assert.Equal(2, heatCommandLines.Count());
+
+                var warnings = result.Output.Where(line => line.Contains(": warning"));
+                Assert.Empty(warnings);
+
+                var generatedFilePath = Path.Combine(intermediateFolder, @"_TxtProductComponents_INSTALLFOLDER_MyProgram.txt_file.wxs");
+                Assert.True(File.Exists(generatedFilePath));
+
+                var generatedContents = File.ReadAllText(generatedFilePath);
+                var testXml = generatedContents.GetTestXml();
+                Assert.Equal("<Wix>" +
+                    "<Fragment>" +
+                    "<DirectoryRef Id='INSTALLFOLDER'>" +
+                    "<Component Id='MyProgram.txt' Guid='*'>" +
+                    @"<File Id='MyProgram.txt' KeyPath='yes' Source='SourceDir\MyProgram.txt' />" +
+                    "</Component>" +
+                    "</DirectoryRef>" +
+                    "</Fragment>" +
+                    "<Fragment>" +
+                    "<ComponentGroup Id='TxtProductComponents'>" +
+                    "<ComponentRef Id='MyProgram.txt' />" +
+                    "</ComponentGroup>" +
+                    "</Fragment>" +
+                    "</Wix>", testXml);
+
+                generatedFilePath = Path.Combine(intermediateFolder, @"_JsonProductComponents_INSTALLFOLDER_MyProgram.json_file.wxs");
+                Assert.True(File.Exists(generatedFilePath));
+
+                generatedContents = File.ReadAllText(generatedFilePath);
+                testXml = generatedContents.GetTestXml();
+                Assert.Equal("<Wix>" +
+                    "<Fragment>" +
+                    "<DirectoryRef Id='INSTALLFOLDER'>" +
+                    "<Component Id='MyProgram.json' Guid='*'>" +
+                    @"<File Id='MyProgram.json' KeyPath='yes' Source='SourceDir\MyProgram.json' />" +
+                    "</Component>" +
+                    "</DirectoryRef>" +
+                    "</Fragment>" +
+                    "<Fragment>" +
+                    "<ComponentGroup Id='JsonProductComponents'>" +
+                    "<ComponentRef Id='MyProgram.json' />" +
+                    "</ComponentGroup>" +
+                    "</Fragment>" +
+                    "</Wix>", testXml);
+
+                var pdbPath = Path.Combine(binFolder, "HeatFileMultpleFilesSameFileName.wixpdb");
+                Assert.True(File.Exists(pdbPath));
+
+                var intermediate = Intermediate.Load(pdbPath);
+                var section = intermediate.Sections.Single();
+
+                var fileTuples = section.Tuples.OfType<FileTuple>().ToArray();
+                Assert.Equal(@"SourceDir\MyProgram.txt", fileTuples[0][FileTupleFields.Source].PreviousValue.AsPath().Path);
+                Assert.Equal(@"SourceDir\MyProgram.json", fileTuples[1][FileTupleFields.Source].PreviousValue.AsPath().Path);
+            }
+        }
     }
 }
diff --git a/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/HeatFileMultpleFilesSameFileName.wixproj b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/HeatFileMultpleFilesSameFileName.wixproj
new file mode 100644
index 00000000..860fc2dd
--- /dev/null
+++ b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/HeatFileMultpleFilesSameFileName.wixproj
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">x86</Platform>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <ProjectGuid>7fb77005-c6e0-454f-8c2d-0a4a79c918ba</ProjectGuid>
+  </PropertyGroup>
+
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
+    <PlatformName>$(Platform)</PlatformName>
+    <OutputPath>bin\$(Platform)\$(Configuration)\</OutputPath>
+    <DefineConstants>Debug</DefineConstants>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
+    <PlatformName>$(Platform)</PlatformName>
+    <OutputPath>bin\$(Platform)\$(Configuration)\</OutputPath>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
+    <PlatformName>$(Platform)</PlatformName>
+    <OutputPath>bin\$(Platform)\$(Configuration)\</OutputPath>
+    <DefineConstants>Debug</DefineConstants>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
+    <PlatformName>$(Platform)</PlatformName>
+    <OutputPath>bin\$(Platform)\$(Configuration)\</OutputPath>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="Package.wxs" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <BindInputPaths Include="." />
+  </ItemGroup>
+  
+  <PropertyGroup>
+    <HarvestFileSuppressUniqueIds>true</HarvestFileSuppressUniqueIds>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <HarvestFile Include="MyProgram.txt">
+      <ComponentGroupName>TxtProductComponents</ComponentGroupName>
+      <DirectoryRefId>INSTALLFOLDER</DirectoryRefId>
+      <SuppressRootDirectory>true</SuppressRootDirectory>
+    </HarvestFile>
+    <HarvestFile Include="MyProgram.json">
+      <ComponentGroupName>JsonProductComponents</ComponentGroupName>
+      <DirectoryRefId>INSTALLFOLDER</DirectoryRefId>
+      <SuppressRootDirectory>true</SuppressRootDirectory>
+    </HarvestFile>
+  </ItemGroup>
+
+  <Import Project="$(WixTargetsPath)" Condition=" '$(WixTargetsPath)' != '' " />
+  <Import Project="$(MSBuildExtensionsPath32)\WixToolset\v4.x\wix.targets" Condition=" '$(WixTargetsPath)' == '' AND Exists('$(MSBuildExtensionsPath32)\WixToolset\v4.x\wix.targets') " />
+  <Target Name="EnsureWixToolsetInstalled" Condition=" '$(WixTargetsImported)' != 'true' ">
+    <Error Text="WiX Toolset build tools (v4.0 or later) must be installed to build this project. To download the WiX Toolset, go to http://wixtoolset.org/releases/." />
+  </Target>
+</Project>
\ No newline at end of file
diff --git a/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.json b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.json
new file mode 100644
index 00000000..5f282702
--- /dev/null
+++ b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.json
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.txt b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.txt
new file mode 100644
index 00000000..5f282702
--- /dev/null
+++ b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/MyProgram.txt
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/Package.wxs b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/Package.wxs
new file mode 100644
index 00000000..884da274
--- /dev/null
+++ b/src/test/WixToolsetTest.BuildTasks/TestData/HeatFileMultpleFilesSameFileName/Package.wxs
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Product Id="*" Name="HeatFilePackage" Language="1033" Version="1.0.0.0" Manufacturer="Example Corporation" UpgradeCode="047730a5-30fe-4a62-a520-da9381b8226a">
+    <Package InstallerVersion="200" Compressed="yes" InstallScope="perMachine" />
+
+    <MediaTemplate />
+
+    <Feature Id="ProductFeature" Title="HeatFileFeature">
+        <ComponentGroupRef Id="TxtProductComponents" />
+        <ComponentGroupRef Id="JsonProductComponents" />
+    </Feature>
+  </Product>
+
+  <Fragment>
+    <Directory Id="TARGETDIR" Name="SourceDir">
+      <Directory Id="ProgramFilesFolder">
+        <Directory Id="INSTALLFOLDER" Name="MsiPackage" />
+      </Directory>
+    </Directory>
+  </Fragment>
+</Wix>
diff --git a/src/test/WixToolsetTest.BuildTasks/WixToolsetTest.BuildTasks.csproj b/src/test/WixToolsetTest.BuildTasks/WixToolsetTest.BuildTasks.csproj
index 3909cc79..333c7c79 100644
--- a/src/test/WixToolsetTest.BuildTasks/WixToolsetTest.BuildTasks.csproj
+++ b/src/test/WixToolsetTest.BuildTasks/WixToolsetTest.BuildTasks.csproj
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!-- 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. -->
 
 <Project Sdk="Microsoft.NET.Sdk">
@@ -12,6 +12,10 @@
   <ItemGroup>
     <Content Include="TestData\HeatFilePackage\HeatFilePackage.wixproj" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\HeatFilePackage\Package.wxs" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\HeatFileMultpleFilesSameFileName\HeatFileMultpleFilesSameFileName.wixproj" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\HeatFileMultpleFilesSameFileName\Package.wxs" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\HeatFileMultpleFilesSameFileName\MyProgram.txt" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="TestData\HeatFileMultpleFilesSameFileName\MyProgram.json" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\MultiCulturalMsiPackage\MsiPackage\MsiPackage.wixproj" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\MultiCulturalMsiPackage\MsiPackage\Package.de-de.wxl" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="TestData\MultiCulturalMsiPackage\MsiPackage\Package.en-us.wxl" CopyToOutputDirectory="PreserveNewest" />
-- 
cgit v1.2.3-55-g6feb