Block use of TargetFramework and TargetFrameworks in .wixproj

Setting these to anything but the default in the WiX Toolset Sdk will create
problems with project restore. Ensure nothing changes.

Resolves 7925

6 files changed, 112 insertions, 0 deletions

diff --git a/src/wix/WixToolset.Sdk/tools/wix.targets b/src/wix/WixToolset.Sdk/tools/wix.targets
index 4de5835f..ddc83052 100644
--- a/src/wix/WixToolset.Sdk/tools/wix.targets
+++ b/src/wix/WixToolset.Sdk/tools/wix.targets
@@ -178,6 +178,32 @@
     <BindVariable Include="$(WixVariables)"  Condition=" '$(WixVariables)' != '' " />
   </ItemGroup>
 
+
+  <!--
+    ***********************************************************************************************
+    ***********************************************************************************************
+                                                                Restore Section
+    ***********************************************************************************************
+    ***********************************************************************************************
+    -->
+  <Target
+    Name="WixTargetFrameworkCheck"
+    BeforeTargets="_LoadRestoreGraphEntryPoints;CollectPackageReferences;Restore"
+    Condition=" ('$(TargetFrameworks)' != '' and '$(TargetFrameworks)' != 'native') or '$(TargetFramework)' != 'native' ">
+
+    <Error
+      Text="The TargetFrameworks property is not supported by the WiX Toolset. Remove the TargetFrameworks property from your project and try building again. TargetFrameworks = $(TargetFrameworks)"
+      File="$(MSBuildProjectFullPath)"
+      Code="WIX9001"
+      Condition=" '$(TargetFrameworks)' != '' " />
+
+    <Error
+      Text="The TargetFramework property is not supported by the WiX Toolset. Remove the TargetFramework property from your project and try building again. TargetFramework = $(TargetFramework)"
+      File="$(MSBuildProjectFullPath)"
+      Code="WIX9002"
+      Condition=" '$(TargetFramework)' != 'native' " />
+  </Target>
+
   <!--
     ***********************************************************************************************
     ***********************************************************************************************
diff --git a/src/wix/test/WixToolsetTest.Sdk/MsbuildFixture.cs b/src/wix/test/WixToolsetTest.Sdk/MsbuildFixture.cs
index ba5093ac..22cb0a75 100644
--- a/src/wix/test/WixToolsetTest.Sdk/MsbuildFixture.cs
+++ b/src/wix/test/WixToolsetTest.Sdk/MsbuildFixture.cs
@@ -850,6 +850,64 @@ namespace WixToolsetTest.Sdk
         [DataRow(BuildSystem.DotNetCoreSdk)]
         [DataRow(BuildSystem.MSBuild)]
         [DataRow(BuildSystem.MSBuild64)]
+        public void CannotBuildWithTargetFrameworks(BuildSystem buildSystem)
+        {
+            var sourceFolder = TestData.Get(@"TestData", "WithTargetFrameworkError");
+
+            using (var fs = new TestDataFolderFileSystem())
+            {
+                fs.Initialize(sourceFolder);
+                var baseFolder = Path.Combine(fs.BaseFolder, "TargetFrameworkError");
+                var binFolder = Path.Combine(baseFolder, @"bin\");
+                var filesFolder = Path.Combine(binFolder, "Release", @"PFiles\");
+                var projectPath = Path.Combine(baseFolder, "TargetFrameworkError.wixproj");
+
+                var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, [
+                    "-Restore",
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "WixMSBuildProps", MsbuildFixture.WixPropsPath)
+                    ]);
+
+                var errors = GetDistinctErrorMessages(result.Output, baseFolder);
+                WixAssert.CompareLineByLine(new[]
+                {
+                    @"<basefolder>\TargetFrameworkError.wixproj : error WIX9002: The TargetFramework property is not supported by the WiX Toolset. Remove the TargetFramework property from your project and try building again. TargetFramework = net472",
+                }, errors);
+            }
+        }
+
+        [TestMethod]
+        [DataRow(BuildSystem.DotNetCoreSdk)]
+        [DataRow(BuildSystem.MSBuild)]
+        [DataRow(BuildSystem.MSBuild64)]
+        public void CannotBuildWithTargetFramework(BuildSystem buildSystem)
+        {
+            var sourceFolder = TestData.Get(@"TestData", "WithTargetFrameworkError");
+
+            using (var fs = new TestDataFolderFileSystem())
+            {
+                fs.Initialize(sourceFolder);
+                var baseFolder = Path.Combine(fs.BaseFolder, "TargetFrameworksError");
+                var binFolder = Path.Combine(baseFolder, @"bin\");
+                var filesFolder = Path.Combine(binFolder, "Release", @"PFiles\");
+                var projectPath = Path.Combine(baseFolder, "TargetFrameworksError.wixproj");
+
+                var result = MsbuildUtilities.BuildProject(buildSystem, projectPath, [
+                    "-Restore",
+                    MsbuildUtilities.GetQuotedPropertySwitch(buildSystem, "WixMSBuildProps", MsbuildFixture.WixPropsPath)
+                    ]);
+
+                var errors = GetDistinctErrorMessages(result.Output, baseFolder);
+                WixAssert.CompareLineByLine(new[]
+                {
+                    @"<basefolder>\TargetFrameworksError.wixproj : error WIX9001: The TargetFrameworks property is not supported by the WiX Toolset. Remove the TargetFrameworks property from your project and try building again. TargetFrameworks = net8.0",
+                }, errors);
+            }
+        }
+
+        [TestMethod]
+        [DataRow(BuildSystem.DotNetCoreSdk)]
+        [DataRow(BuildSystem.MSBuild)]
+        [DataRow(BuildSystem.MSBuild64)]
         public void CanBuildWithWarningWhenExtensionIsMissing(BuildSystem buildSystem)
         {
             var sourceFolder = TestData.Get(@"TestData", "WixlibMissingExtension");
diff --git a/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworkError/Package.wxs b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworkError/Package.wxs
new file mode 100644
index 00000000..ac49711f
--- /dev/null
+++ b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworkError/Package.wxs
@@ -0,0 +1,5 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Package Id="WixTest.Package" Name="MsiPackage" Language="1033" Version="1.0.0.0" Manufacturer="Example Corporation">
+      <File Source="doesnotexist.txt" />
+  </Package>
+</Wix>
diff --git a/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworkError/TargetFrameworkError.wixproj b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworkError/TargetFrameworkError.wixproj
new file mode 100644
index 00000000..3b6e1300
--- /dev/null
+++ b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworkError/TargetFrameworkError.wixproj
@@ -0,0 +1,9 @@
+<Project>
+  <Import Project="$(WixMSBuildProps)" />
+
+  <PropertyGroup>
+    <TargetFramework>net472</TargetFramework>
+  </PropertyGroup>
+
+  <Import Project="$(WixTargetsPath)" />
+</Project>
diff --git a/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworksError/Package.wxs b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworksError/Package.wxs
new file mode 100644
index 00000000..ac49711f
--- /dev/null
+++ b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworksError/Package.wxs
@@ -0,0 +1,5 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Package Id="WixTest.Package" Name="MsiPackage" Language="1033" Version="1.0.0.0" Manufacturer="Example Corporation">
+      <File Source="doesnotexist.txt" />
+  </Package>
+</Wix>
diff --git a/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworksError/TargetFrameworksError.wixproj b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworksError/TargetFrameworksError.wixproj
new file mode 100644
index 00000000..b3f4777f
--- /dev/null
+++ b/src/wix/test/WixToolsetTest.Sdk/TestData/WithTargetFrameworkError/TargetFrameworksError/TargetFrameworksError.wixproj
@@ -0,0 +1,9 @@
+<Project>
+  <Import Project="$(WixMSBuildProps)" />
+
+  <PropertyGroup>
+    <TargetFrameworks>net8.0</TargetFrameworks>
+  </PropertyGroup>
+
+  <Import Project="$(WixTargetsPath)" />
+</Project>