Allow MsiPackage ForcePerMachine to set the ALLUSERS property

Fixes 7232

4 files changed, 122 insertions, 50 deletions

diff --git a/src/wix/WixToolset.Core.Burn/Bundles/PerformBundleBackendValidationCommand.cs b/src/wix/WixToolset.Core.Burn/Bundles/PerformBundleBackendValidationCommand.cs
index 49a25c0a..01df9f32 100644
--- a/src/wix/WixToolset.Core.Burn/Bundles/PerformBundleBackendValidationCommand.cs
+++ b/src/wix/WixToolset.Core.Burn/Bundles/PerformBundleBackendValidationCommand.cs
@@ -130,7 +130,14 @@ namespace WixToolset.Core.Burn.Bundles
 
         private void ValidateMsiProperty(WixBundleMsiPropertySymbol symbol)
         {
-            this.BackendHelper.ValidateBundleMsiPropertyName(symbol.SourceLineNumbers, "MsiProperty", "Name", symbol.Name);
+            // Validate the MSI properties *except* for the ALLUSERS property when set during binding (most likely
+            // by the MsiPackage/@ForcePerMachine attribute).
+            var nameField = symbol.Fields[(int)WixBundleMsiPropertySymbolFields.Name];
+            var name = nameField.AsString();
+            if (name != "ALLUSERS" || nameField.Context != "wix.bind")
+            {
+                this.BackendHelper.ValidateBundleMsiPropertyName(symbol.SourceLineNumbers, "MsiProperty", "Name", name);
+            }
 
             if (symbol.Condition != null)
             {
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/BundlePackageFixture.cs b/src/wix/test/WixToolsetTest.CoreIntegration/BundlePackageFixture.cs
index 2538c0dc..e4ac2dd6 100644
--- a/src/wix/test/WixToolsetTest.CoreIntegration/BundlePackageFixture.cs
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/BundlePackageFixture.cs
@@ -51,16 +51,7 @@ namespace WixToolsetTest.CoreIntegration
 
                 Assert.True(File.Exists(chainBundlePath));
 
-                string chainBundleId;
-                using (var wixOutput = WixOutput.Read(chainPdbPath))
-                {
-
-                    var intermediate = Intermediate.Load(wixOutput);
-                    var section = intermediate.Sections.Single();
-
-                    var bundleSymbol = section.Symbols.OfType<WixBundleSymbol>().Single();
-                    chainBundleId = bundleSymbol.BundleId;
-                }
+                var chainBundleId = GetBundleIdFromWixpdb(chainPdbPath);
 
                 // parent.exe
                 result = WixRunner.Execute(new[]
@@ -78,16 +69,7 @@ namespace WixToolsetTest.CoreIntegration
 
                 Assert.True(File.Exists(parentBundlePath));
 
-                string parentBundleId;
-                using (var wixOutput = WixOutput.Read(parentPdbPath))
-                {
-
-                    var intermediate = Intermediate.Load(wixOutput);
-                    var section = intermediate.Sections.Single();
-
-                    var bundleSymbol = section.Symbols.OfType<WixBundleSymbol>().Single();
-                    parentBundleId = bundleSymbol.BundleId;
-                }
+                var parentBundleId = GetBundleIdFromWixpdb(parentPdbPath);
 
                 var extractResult = BundleExtractor.ExtractBAContainer(null, parentBundlePath, parentBaFolderPath, extractFolderPath);
                 extractResult.AssertSuccess();
@@ -140,16 +122,7 @@ namespace WixToolsetTest.CoreIntegration
 
                 Assert.True(File.Exists(grandparentBundlePath));
 
-                string grandparentBundleId;
-                using (var wixOutput = WixOutput.Read(grandparentPdbPath))
-                {
-
-                    var intermediate = Intermediate.Load(wixOutput);
-                    var section = intermediate.Sections.Single();
-
-                    var bundleSymbol = section.Symbols.OfType<WixBundleSymbol>().Single();
-                    grandparentBundleId = bundleSymbol.BundleId;
-                }
+                var grandparentBundleId = GetBundleIdFromWixpdb(grandparentPdbPath);
 
                 var grandparentExtractResult = BundleExtractor.ExtractBAContainer(null, grandparentBundlePath, grandparentBaFolderPath, extractFolderPath);
                 grandparentExtractResult.AssertSuccess();
@@ -229,16 +202,8 @@ namespace WixToolsetTest.CoreIntegration
                 Assert.True(File.Exists(parentBundlePath));
 
                 var chainBundleId = "{216BDA7F-74BD-45E8-957B-500552F05629}";
-                string parentBundleId;
-                using (var wixOutput = WixOutput.Read(parentPdbPath))
-                {
-
-                    var intermediate = Intermediate.Load(wixOutput);
-                    var section = intermediate.Sections.Single();
 
-                    var bundleSymbol = section.Symbols.OfType<WixBundleSymbol>().Single();
-                    parentBundleId = bundleSymbol.BundleId;
-                }
+                var parentBundleId = GetBundleIdFromWixpdb(parentPdbPath);
 
                 var extractResult = BundleExtractor.ExtractBAContainer(null, parentBundlePath, parentBaFolderPath, extractFolderPath);
                 extractResult.AssertSuccess();
@@ -316,16 +281,7 @@ namespace WixToolsetTest.CoreIntegration
 
                 Assert.True(File.Exists(parentBundlePath));
 
-                string parentBundleId;
-                using (var wixOutput = WixOutput.Read(parentPdbPath))
-                {
-
-                    var intermediate = Intermediate.Load(wixOutput);
-                    var section = intermediate.Sections.Single();
-
-                    var bundleSymbol = section.Symbols.OfType<WixBundleSymbol>().Single();
-                    parentBundleId = bundleSymbol.BundleId;
-                }
+                var parentBundleId = GetBundleIdFromWixpdb(parentPdbPath);
 
                 var extractResult = BundleExtractor.ExtractBAContainer(null, parentBundlePath, baFolderPath, extractFolderPath);
                 extractResult.AssertSuccess();
@@ -363,5 +319,89 @@ namespace WixToolsetTest.CoreIntegration
                 }, packageElements);
             }
         }
+
+        [Fact]
+        public void CanBuildBundleWithAllUsersPackage()
+        {
+            var folder = TestData.Get("TestData");
+
+            using (var fs = new DisposableFileSystem())
+            {
+                var baseFolder = fs.GetFolder();
+                var dataPath = Path.Combine(folder, ".Data");
+
+                var msiIntermediateFolder = Path.Combine(baseFolder, "obj", "msi");
+                var msiBinFolder = Path.Combine(baseFolder, "bin", "msi");
+                var msiPath = Path.Combine(msiBinFolder, "test.msi");
+
+                var bundleIntermediateFolder = Path.Combine(baseFolder, "obj", "bundle");
+                var bundleBinFolder = Path.Combine(baseFolder, "bin", "bundle");
+                var bundlePath = Path.Combine(bundleBinFolder, "bundle.exe");
+                var bundlePdbPath = Path.Combine(bundleBinFolder, "bundle.wixpdb");
+
+                var baFolderPath = Path.Combine(baseFolder, "extract", "ba");
+                var extractFolderPath = Path.Combine(baseFolder, "extract", "files");
+
+                var result = WixRunner.Execute(new[]
+                {
+                    "build",
+                    Path.Combine(folder, "BundleAllUsers", "AllUsersPackage.wxs"),
+                    "-bindpath", dataPath,
+                    "-intermediateFolder", msiIntermediateFolder,
+                    "-o", msiPath
+                });
+
+                result.AssertSuccess();
+
+                result = WixRunner.Execute(new[]
+                {
+                    "build",
+                    Path.Combine(folder, "BundleAllUsers", "BundleWithAllUsersPackage.wxs"),
+                    "-bindpath", dataPath,
+                    "-bindpath", msiBinFolder,
+                    "-intermediateFolder", bundleIntermediateFolder,
+                    "-o", bundlePath
+                });
+
+                result.AssertSuccess();
+
+                var parentBundleId = GetBundleIdFromWixpdb(bundlePdbPath);
+
+                var extractResult = BundleExtractor.ExtractBAContainer(null, bundlePath, baFolderPath, extractFolderPath);
+                extractResult.AssertSuccess();
+
+                var registrations = extractResult.GetManifestTestXmlLines("/burn:BurnManifest/burn:Registration");
+                WixAssert.CompareLineByLine(new[]
+                {
+                    $"<Registration Id='{parentBundleId}' ExecutableName='bundle.exe' PerMachine='yes' Tag='' Version='9.9' ProviderKey='{parentBundleId}'>" +
+                    "<Arp DisplayName='All Users Bundle' DisplayVersion='9.9' Publisher='Example Corporation' />" +
+                    "</Registration>"
+                }, registrations);
+
+                var ignoreAttributesByElementName = new Dictionary<string, List<string>>
+                {
+                    { "WixPackageProperties", new List<string> { "DownloadSize", "PackageSize" } },
+                };
+
+                var packageElements = extractResult.GetBADataTestXmlLines("/ba:BootstrapperApplicationData/ba:WixPackageProperties", ignoreAttributesByElementName);
+                WixAssert.CompareLineByLine(new[]
+                {
+                    "<WixPackageProperties Package='test.msi' Vital='yes' DisplayName='All Users Package' DownloadSize='*' PackageSize='*' InstalledSize='28' PackageType='Msi' Permanent='no' LogPathVariable='WixBundleLog_test.msi' RollbackLogPathVariable='WixBundleRollbackLog_test.msi' Compressed='no' ProductCode='{33333333-3333-3333-3333-333333333333}' UpgradeCode='{4BE34BEE-CA23-488E-96A0-B15878E3654B}' Version='1.0' Cache='keep' />",
+                }, packageElements);
+            }
+        }
+
+        private static string GetBundleIdFromWixpdb(string bundlePdbPath)
+        {
+            using (var wixOutput = WixOutput.Read(bundlePdbPath))
+            {
+
+                var intermediate = Intermediate.Load(wixOutput);
+                var section = intermediate.Sections.Single();
+
+                var bundleSymbol = section.Symbols.OfType<WixBundleSymbol>().Single();
+                return bundleSymbol.BundleId;
+            }
+        }
     }
 }
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleAllUsers/AllUsersPackage.wxs b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleAllUsers/AllUsersPackage.wxs
new file mode 100644
index 00000000..63046563
--- /dev/null
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleAllUsers/AllUsersPackage.wxs
@@ -0,0 +1,14 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Package ProductCode="33333333-3333-3333-3333-333333333333" Name="All Users Package" Version="1.0" Manufacturer="Example Corporation" UpgradeCode="4BE34BEE-CA23-488E-96A0-B15878E3654B" Compressed="no" Scope="perUserOrMachine">
+
+    <StandardDirectory Id="ProgramFilesFolder">
+        <Directory Id="INSTALLFOLDER" Name="Example" />
+    </StandardDirectory>
+
+    <Feature Id="Main">
+      <Component Directory="INSTALLFOLDER">
+        <File Source="test.txt" />
+      </Component>
+    </Feature>
+  </Package>
+</Wix>
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleAllUsers/BundleWithAllUsersPackage.wxs b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleAllUsers/BundleWithAllUsersPackage.wxs
new file mode 100644
index 00000000..6344e861
--- /dev/null
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleAllUsers/BundleWithAllUsersPackage.wxs
@@ -0,0 +1,11 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Bundle Name="All Users Bundle" Version="9.9" Manufacturer="Example Corporation" UpgradeCode="{4BE34BEE-CA23-488E-96A0-B15878E3654B}" Compressed="no">
+    <BootstrapperApplication>
+      <BootstrapperApplicationDll SourceFile="fakeba.dll" />
+    </BootstrapperApplication>
+
+    <Chain>
+      <MsiPackage SourceFile="test.msi" ForcePerMachine="yes" />
+    </Chain>
+  </Bundle>
+</Wix>