From 6ed066072db5bf15453da1f8da28f727ba46fc5b Mon Sep 17 00:00:00 2001
From: Rob Mensching <rob@firegiant.com>
Date: Sun, 20 Nov 2022 11:12:45 -0800
Subject: Allow signing targets to be overridden in simple Sdk-style .wixproj

Moved the overridable signing targets (like SignMsi) to a new
WixToolset.Signing.props that is included "at the very top of" a
.wixproj using Sdk-style project. That way these signing targets can be
overridden in the .wixproj. When the overridable signing targets were
defined in WixToolset.Signing.targets, then it was necessary to use the
more complex Sdk-style Import syntax to place the signing targets low
enough in the .wixproj.

Closes 7038
---
 .../WixprojPackageVcxprojWindowsApp.wixproj        |   5 +
 src/test/wix/WixE2E/WixE2EFixture.cs               |   8 ++
 src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj       |   1 +
 .../WixToolset.Sdk/tools/WixToolset.Signing.props  | 102 +++++++++++++++++++++
 .../tools/WixToolset.Signing.targets               |  96 +------------------
 src/wix/WixToolset.Sdk/tools/wix.props             |   2 +
 src/wix/WixToolset.Sdk/tools/wix.targets           |   6 +-
 7 files changed, 122 insertions(+), 98 deletions(-)
 create mode 100644 src/wix/WixToolset.Sdk/tools/WixToolset.Signing.props

diff --git a/src/test/wix/TestData/WixprojPackageVcxprojWindowsApp/WixprojPackageVcxprojWindowsApp.wixproj b/src/test/wix/TestData/WixprojPackageVcxprojWindowsApp/WixprojPackageVcxprojWindowsApp.wixproj
index 63caf5c0..27affb11 100644
--- a/src/test/wix/TestData/WixprojPackageVcxprojWindowsApp/WixprojPackageVcxprojWindowsApp.wixproj
+++ b/src/test/wix/TestData/WixprojPackageVcxprojWindowsApp/WixprojPackageVcxprojWindowsApp.wixproj
@@ -3,6 +3,7 @@
 <Project Sdk='WixToolset.Sdk'> 
   <PropertyGroup>
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
+    <SignOutput>true</SignOutput>
   </PropertyGroup>
 
   <ItemGroup>
@@ -12,4 +13,8 @@
 
     <PackageReference Include="Wixtoolset.UI.wixext" />
   </ItemGroup>
+
+  <Target Name="SignMsi">
+    <Warning Text="SignMsi = @(SignMsi)" />
+  </Target>
 </Project>
diff --git a/src/test/wix/WixE2E/WixE2EFixture.cs b/src/test/wix/WixE2E/WixE2EFixture.cs
index f9094fb2..4a0b78d8 100644
--- a/src/test/wix/WixE2E/WixE2EFixture.cs
+++ b/src/test/wix/WixE2E/WixE2EFixture.cs
@@ -55,6 +55,14 @@ namespace WixE2E
 
             var result = RestoreAndBuild(projectPath);
             result.AssertSuccess();
+
+            var signingStatement = result.Output.Where(s => s.Contains("warning :"))
+                                                .Select(s => s.Replace(Path.GetDirectoryName(projectPath), "<projectFolder>").Replace(@"\Debug\", @"\<configuration>\").Replace(@"\Release\", @"\<configuration>\"))
+                                                .ToArray();
+            WixAssert.CompareLineByLine(new[]
+            {
+                @"<projectFolder>\WixprojPackageVcxprojWindowsApp.wixproj(18,5): warning : SignMsi = obj\<configuration>\en-US\WixprojPackageVcxprojWindowsApp.msi;obj\<configuration>\ja-JP\WixprojPackageVcxprojWindowsApp.msi"
+            }, signingStatement);
         }
 
         [Fact]
diff --git a/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj b/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj
index 4a5e6229..eca65bda 100644
--- a/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj
+++ b/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj
@@ -13,6 +13,7 @@
   <ItemGroup>
     <Content Include="build\$(MSBuildThisFileName).props" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="build\$(MSBuildThisFileName).targets" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="tools\WixToolset.Signing.props" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="tools\WixToolset.Signing.targets" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="tools\wix.props" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="tools\wix.targets" CopyToOutputDirectory="PreserveNewest" />
diff --git a/src/wix/WixToolset.Sdk/tools/WixToolset.Signing.props b/src/wix/WixToolset.Sdk/tools/WixToolset.Signing.props
new file mode 100644
index 00000000..0b2522c8
--- /dev/null
+++ b/src/wix/WixToolset.Sdk/tools/WixToolset.Signing.props
@@ -0,0 +1,102 @@
+<?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 xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <WixSigningPropsImported>true</WixSigningPropsImported>
+  </PropertyGroup>
+
+  <!--
+  ==================================================================================================
+  BeforeSigning
+
+    Redefine this target in your project in order to run tasks just before all signing tasks.
+  ==================================================================================================
+  -->
+  <Target Name="BeforeSigning" />
+
+  <!--
+  ==================================================================================================
+  SignMsm
+
+    Redefine this target in your project in order to sign merge modules.
+
+    [IN]
+    @(SignMsm) - merge module files to sign.
+  ==================================================================================================
+  -->
+  <Target Name="SignMsm" />
+
+  <!--
+  ==================================================================================================
+  SignCabs
+
+    Redefine this target in your project in order to sign the cabs of your database.
+
+    [IN]
+    @(SignCabs) - cabinet files to sign.
+  ==================================================================================================
+  -->
+  <Target Name="SignCabs" />
+
+  <!--
+  ==================================================================================================
+  SignMsi
+
+    Redefine this target in your project in order to sign your database, after it has been inscribed
+    with the signatures of your signed cabs.
+
+    [IN]
+    @(SignMsi) - database files to sign.
+  ==================================================================================================
+  -->
+  <Target Name="SignMsi" />
+
+  <!--
+  ==================================================================================================
+  SignContainers
+
+    Redefine this target in your project in order to sign your bundle's detached containers.
+
+    [IN]
+    @(SignContainers) - detached container files to sign.
+  ==================================================================================================
+  -->
+  <Target Name="SignContainers" />
+
+  <!--
+  ==================================================================================================
+  SignBundleEngine
+
+    Redefine this target in your project in order to sign your bundle, after it has been inscribed
+    with the signatures of your signed containers.
+
+    [IN]
+    @(SignBundleEngine) - bundle engine file to sign.
+  ==================================================================================================
+  -->
+  <Target Name="SignBundleEngine" />
+
+  <!--
+  ==================================================================================================
+  SignBundle
+
+    Redefine this target in your project in order to sign your bundle, after the attached container
+    is reattached.
+
+    [IN]
+    @(SignBundle) - bundle file to sign.
+  ==================================================================================================
+  -->
+  <Target Name="SignBundle" />
+
+  <!--
+  ==================================================================================================
+  AfterSigning
+
+    Redefine this target in your project in order to run tasks just after all signing tasks.
+  ==================================================================================================
+  -->
+  <Target Name="AfterSigning" />
+
+</Project>
diff --git a/src/wix/WixToolset.Sdk/tools/WixToolset.Signing.targets b/src/wix/WixToolset.Sdk/tools/WixToolset.Signing.targets
index 8b850fd7..c414bcf1 100644
--- a/src/wix/WixToolset.Sdk/tools/WixToolset.Signing.targets
+++ b/src/wix/WixToolset.Sdk/tools/WixToolset.Signing.targets
@@ -3,10 +3,13 @@
 
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
+    <WixSigningTargetsImported>true</WixSigningTargetsImported>
     <SignedFileName Condition=" '$(SignedFileName)' == '' ">$(MSBuildProjectFile).Signed.txt</SignedFileName>
     <SignedFilePath>$(IntermediateOutputPath)$(SignedFileName)</SignedFilePath>
   </PropertyGroup>
 
+  <Import Project="WixToolset.Signing.props" Condition=" '$(WixSigningPropsImported)' != 'true' " />
+
   <UsingTask TaskName="GetCabList" Condition=" '$(WixTasksPath64)' == '' " AssemblyFile="$(WixTasksPath)" />
   <UsingTask TaskName="GetCabList" Condition=" '$(WixTasksPath64)' != '' " AssemblyFile="$(WixTasksPath)" Architecture="x86" />
   <UsingTask TaskName="GetCabList" Condition=" '$(WixTasksPath64)' != '' " AssemblyFile="$(WixTasksPath64)" Architecture="x64" />
@@ -309,97 +312,4 @@
     </ReattachSignedBundleEngine>
   </Target>
 
-  <!--
-  ==================================================================================================
-  BeforeSigning
-
-    Redefine this target in your project in order to run tasks just before all signing tasks.
-  ==================================================================================================
-  -->
-  <Target Name="BeforeSigning" />
-
-  <!--
-  ==================================================================================================
-  SignMsm
-
-    Redefine this target in your project in order to sign merge modules.
-
-    [IN]
-    @(SignMsm) - merge module files to sign.
-  ==================================================================================================
-  -->
-  <Target Name="SignMsm" />
-
-  <!--
-  ==================================================================================================
-  SignCabs
-
-    Redefine this target in your project in order to sign the cabs of your database.
-
-    [IN]
-    @(SignCabs) - cabinet files to sign.
-  ==================================================================================================
-  -->
-  <Target Name="SignCabs" />
-
-  <!--
-  ==================================================================================================
-  SignMsi
-
-    Redefine this target in your project in order to sign your database, after it has been inscribed
-    with the signatures of your signed cabs.
-
-    [IN]
-    @(SignMsi) - database files to sign.
-  ==================================================================================================
-  -->
-  <Target Name="SignMsi" />
-
-  <!--
-  ==================================================================================================
-  SignContainers
-
-    Redefine this target in your project in order to sign your bundle's detached containers.
-
-    [IN]
-    @(SignContainers) - detached container files to sign.
-  ==================================================================================================
-  -->
-  <Target Name="SignContainers" />
-
-  <!--
-  ==================================================================================================
-  SignBundleEngine
-
-    Redefine this target in your project in order to sign your bundle, after it has been inscribed
-    with the signatures of your signed containers.
-
-    [IN]
-    @(SignBundleEngine) - bundle engine file to sign.
-  ==================================================================================================
-  -->
-  <Target Name="SignBundleEngine" />
-
-  <!--
-  ==================================================================================================
-  SignBundle
-
-    Redefine this target in your project in order to sign your bundle, after the attached container
-    is reattached.
-
-    [IN]
-    @(SignBundle) - bundle file to sign.
-  ==================================================================================================
-  -->
-  <Target Name="SignBundle" />
-
-  <!--
-  ==================================================================================================
-  AfterSigning
-
-    Redefine this target in your project in order to run tasks just after all signing tasks.
-  ==================================================================================================
-  -->
-  <Target Name="AfterSigning" />
-
 </Project>
diff --git a/src/wix/WixToolset.Sdk/tools/wix.props b/src/wix/WixToolset.Sdk/tools/wix.props
index d3c202bf..c526d865 100644
--- a/src/wix/WixToolset.Sdk/tools/wix.props
+++ b/src/wix/WixToolset.Sdk/tools/wix.props
@@ -19,6 +19,8 @@
 
   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
 
+  <Import Project="WixToolset.Signing.props" Condition=" '$(WixSigningPropsImported)' != 'true' " />
+
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
   </PropertyGroup>
diff --git a/src/wix/WixToolset.Sdk/tools/wix.targets b/src/wix/WixToolset.Sdk/tools/wix.targets
index e18eaf62..a4603c47 100644
--- a/src/wix/WixToolset.Sdk/tools/wix.targets
+++ b/src/wix/WixToolset.Sdk/tools/wix.targets
@@ -31,10 +31,6 @@
     <WixTasksPath Condition=" '$(WixTasksPath)' == '' ">$(WixBinDir)WixToolset.BuildTasks.dll</WixTasksPath>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <WixSigningTargetsPath Condition=" '$(WixSigningTargetsPath)' == '' ">$(MSBuildThisFileDirectory)WixToolset.Signing.targets</WixSigningTargetsPath>
-  </PropertyGroup>
-
   <ItemGroup Condition=" '$(EnableDefaultItems)' == 'true' ">
     <Compile Include="**/*.wxs" Exclude="$(DefaultItemExcludes);$(DefaultExcludesInProjectFolder)" Condition=" '$(EnableDefaultCompileItems)' == 'true' " />
     <EmbeddedResource Include="**/*.wxl" Exclude="$(DefaultItemExcludes);$(DefaultExcludesInProjectFolder)" Condition=" '$(EnableDefaultEmbeddedResourceItems)' == 'true' " />
@@ -937,7 +933,7 @@
     </Copy>
   </Target>
 
-  <Import Project="$(WixSigningTargetsPath)"  />
+  <Import Project="WixToolset.Signing.targets" Condition=" '$(WixSigningTargetsImported)' != 'true' " />
 
   <!-- Extension point: Define CustomAfterWixTargets to a .targets file that you want to include after this file. -->
   <Import Project="$(CustomAfterWixTargets)" Condition=" '$(CustomAfterWixTargets)' != '' and Exists('$(CustomAfterWixTargets)')" />
-- 
cgit v1.2.3-55-g6feb