Normalize related bundle ids

Fixes 6008

6 files changed, 103 insertions, 36 deletions

diff --git a/src/wix/WixToolset.Core.Burn/Bind/BindBundleCommand.cs b/src/wix/WixToolset.Core.Burn/Bind/BindBundleCommand.cs
index eb822fba..16e63492 100644
--- a/src/wix/WixToolset.Core.Burn/Bind/BindBundleCommand.cs
+++ b/src/wix/WixToolset.Core.Burn/Bind/BindBundleCommand.cs
@@ -102,10 +102,10 @@ namespace WixToolset.Core.Burn
 
             bundleSymbol.ProviderKey = bundleSymbol.BundleId = Guid.NewGuid().ToString("B").ToUpperInvariant();
 
-            bundleSymbol.UpgradeCode = this.NormalizeBundleUpgradeCode(bundleSymbol.SourceLineNumbers, bundleSymbol.UpgradeCode);
-
             bundleSymbol.Attributes |= WixBundleAttributes.PerMachine; // default to per-machine but the first-per user package wil flip the bundle per-user.
 
+            this.NormalizeRelatedBundles(bundleSymbol, section);
+
             // Ensure there is one and only one WixBootstrapperApplicationDllSymbol.
             // The compiler and linker behavior should have colluded to get
             // this behavior.
@@ -178,33 +178,33 @@ namespace WixToolset.Core.Burn
             {
                 switch (facade.PackageSymbol.Type)
                 {
-                case WixBundlePackageType.Exe:
-                {
-                    var command = new ProcessExePackageCommand(facade, payloadSymbols);
-                    command.Execute();
-                }
-                break;
+                    case WixBundlePackageType.Exe:
+                    {
+                        var command = new ProcessExePackageCommand(facade, payloadSymbols);
+                        command.Execute();
+                    }
+                    break;
 
-                case WixBundlePackageType.Msi:
-                {
-                    var command = new ProcessMsiPackageCommand(this.ServiceProvider, this.BackendExtensions, section, facade, packagesPayloads[facade.PackageId]);
-                    command.Execute();
-                }
-                break;
+                    case WixBundlePackageType.Msi:
+                    {
+                        var command = new ProcessMsiPackageCommand(this.ServiceProvider, this.BackendExtensions, section, facade, packagesPayloads[facade.PackageId]);
+                        command.Execute();
+                    }
+                    break;
 
-                case WixBundlePackageType.Msp:
-                {
-                    var command = new ProcessMspPackageCommand(this.Messaging, section, facade, payloadSymbols);
-                    command.Execute();
-                }
-                break;
+                    case WixBundlePackageType.Msp:
+                    {
+                        var command = new ProcessMspPackageCommand(this.Messaging, section, facade, payloadSymbols);
+                        command.Execute();
+                    }
+                    break;
 
-                case WixBundlePackageType.Msu:
-                {
-                    var command = new ProcessMsuPackageCommand(facade, payloadSymbols);
-                    command.Execute();
-                }
-                break;
+                    case WixBundlePackageType.Msu:
+                    {
+                        var command = new ProcessMsuPackageCommand(facade, payloadSymbols);
+                        command.Execute();
+                    }
+                    break;
                 }
 
                 if (null != variableCache)
@@ -496,18 +496,39 @@ namespace WixToolset.Core.Burn
             this.Wixout = this.CreateWixout(trackedFiles, this.Output, manifestPath, baManifestPath, bextManifestPath);
         }
 
-        private string NormalizeBundleUpgradeCode(SourceLineNumber sourceLineNumber, string upgradeCode)
+        private void NormalizeRelatedBundles(WixBundleSymbol bundleSymbol, IntermediateSection section)
         {
-            if (Guid.TryParse(upgradeCode, out var guid))
+            var upgradeCode = bundleSymbol.UpgradeCode;
+
+            foreach (var relatedBundleSymbol in section.Symbols.OfType<WixRelatedBundleSymbol>())
+            {
+                var elementName = "RelatedBundle";
+                var attributeName = "Id";
+
+                if (upgradeCode == relatedBundleSymbol.BundleId)
+                {
+                    elementName = "Bundle";
+                    attributeName = "UpgradeCode";
+                }
+
+                relatedBundleSymbol.BundleId = this.NormalizeBundleRelatedBundleId(relatedBundleSymbol.SourceLineNumbers, relatedBundleSymbol.BundleId, elementName, attributeName);
+            }
+
+            bundleSymbol.UpgradeCode = this.NormalizeBundleRelatedBundleId(bundleSymbol.SourceLineNumbers, bundleSymbol.UpgradeCode, null, null);
+        }
+
+        private string NormalizeBundleRelatedBundleId(SourceLineNumber sourceLineNumber, string relatedBundleId, string elementName, string attributeName)
+        {
+            if (Guid.TryParse(relatedBundleId, out var guid))
             {
                 return guid.ToString("B").ToUpperInvariant();
             }
-            else
+            else if (!String.IsNullOrEmpty(elementName))
             {
-                this.Messaging.Write(ErrorMessages.IllegalGuidValue(sourceLineNumber, "Bundle", "UpgradeCode", upgradeCode));
+                this.Messaging.Write(ErrorMessages.IllegalGuidValue(sourceLineNumber, elementName, attributeName, relatedBundleId));
             }
 
-            return upgradeCode;
+            return relatedBundleId;
         }
 
         private WixOutput CreateWixout(List<ITrackedFile> trackedFiles, Intermediate intermediate, string manifestPath, string baDataPath, string bextDataPath)
@@ -552,7 +573,7 @@ namespace WixToolset.Core.Burn
             variableCache.Add(String.Concat("packageVersion.", id), package.Version);
 
             if (facade.SpecificPackageSymbol is WixBundleMsiPackageSymbol msiPackage)
-            { 
+            {
                 variableCache.Add(String.Concat("packageLanguage.", id), msiPackage.ProductLanguage.ToString());
                 variableCache.Add(String.Concat("packageManufacturer.", id), msiPackage.Manufacturer ?? String.Empty);
             }
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/BundleFixture.cs b/src/wix/test/WixToolsetTest.CoreIntegration/BundleFixture.cs
index 4ac9c3a4..e4a57d4d 100644
--- a/src/wix/test/WixToolsetTest.CoreIntegration/BundleFixture.cs
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/BundleFixture.cs
@@ -332,8 +332,8 @@ namespace WixToolsetTest.CoreIntegration
                 var result = WixRunner.Execute(new[]
                 {
                     "build",
-                    Path.Combine(folder, "BundleWithInvalid", "BundleWithInvalidUpgradeCode.wxs"),
-                    "-loc", Path.Combine(folder, "BundleWithInvalid", "BundleWithInvalidUpgradeCode.wxl"),
+                    Path.Combine(folder, "BundleLocalized", "BundleWithLocalizedUpgradeCode.wxs"),
+                    "-loc", Path.Combine(folder, "BundleLocalized", "BundleWithInvalidUpgradeCode.wxl"),
                     "-bindpath", Path.Combine(folder, ".Data"),
                     "-bindpath", Path.Combine(folder, "SimpleBundle", "data"),
                     "-intermediateFolder", intermediateFolder,
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/BundleManifestFixture.cs b/src/wix/test/WixToolsetTest.CoreIntegration/BundleManifestFixture.cs
index 29c9dd95..7f92f90b 100644
--- a/src/wix/test/WixToolsetTest.CoreIntegration/BundleManifestFixture.cs
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/BundleManifestFixture.cs
@@ -139,6 +139,49 @@ namespace WixToolsetTest.CoreIntegration
         }
 
         [Fact]
+        public void CanBuildBundleManifestWithNormalizedRelatedBundles()
+        {
+            var folder = TestData.Get(@"TestData");
+
+            using (var fs = new DisposableFileSystem())
+            {
+                var baseFolder = fs.GetFolder();
+                var intermediateFolder = Path.Combine(baseFolder, "obj");
+                var bundlePath = Path.Combine(baseFolder, @"bin\test.exe");
+                var baFolderPath = Path.Combine(baseFolder, "ba");
+                var extractFolderPath = Path.Combine(baseFolder, "extract");
+
+                var result = WixRunner.Execute(new[]
+{
+                    "build",
+                    Path.Combine(folder, "BundleLocalized", "BundleWithLocalizedUpgradeCode.wxs"),
+                    "-loc", Path.Combine(folder, "BundleLocalized", "BundleWithValidUpgradeCode.wxl"),
+                    "-bindpath", Path.Combine(folder, ".Data"),
+                    "-bindpath", Path.Combine(folder, "SimpleBundle", "data"),
+                    "-intermediateFolder", intermediateFolder,
+                    "-o", Path.Combine(baseFolder, @"bin\test.exe")
+                });
+
+                result.AssertSuccess();
+
+                var extractResult = BundleExtractor.ExtractBAContainer(null, bundlePath, baFolderPath, extractFolderPath);
+                extractResult.AssertSuccess();
+
+                var manifestRelatedBundlesElements = extractResult.SelectManifestNodes("/burn:BurnManifest/burn:RelatedBundle");
+                Assert.Equal("<RelatedBundle Id='{6D4CE32B-FB91-45DA-A9B5-7E0D9929A3C3}' Action='Upgrade' />", manifestRelatedBundlesElements[0].GetTestXml());
+                Assert.Equal(1, manifestRelatedBundlesElements.Count);
+
+                var dataRelatedBundlesElements = extractResult.SelectBADataNodes("/ba:BootstrapperApplicationData/ba:WixBundleProperties");
+                var ignoreAttributesByElementName = new Dictionary<string, List<string>>
+                {
+                    { "WixBundleProperties", new List<string> { "DisplayName", "Id" } },
+                };
+                Assert.Equal("<WixBundleProperties DisplayName='*' LogPathVariable='WixBundleLog' Compressed='no' Id='*' UpgradeCode='{6D4CE32B-FB91-45DA-A9B5-7E0D9929A3C3}' PerMachine='yes' />", dataRelatedBundlesElements[0].GetTestXml(ignoreAttributesByElementName));
+                Assert.Equal(1, dataRelatedBundlesElements.Count);
+            }
+        }
+
+        [Fact]
         public void PopulatesBEManifestWithBundleExtensionBundleCustomData()
         {
             var folder = TestData.Get(@"TestData");
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleWithInvalid/BundleWithInvalidUpgradeCode.wxl b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleLocalized/BundleWithInvalidUpgradeCode.wxl
index 40688f36..92e1b746 100644
--- a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleWithInvalid/BundleWithInvalidUpgradeCode.wxl
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleLocalized/BundleWithInvalidUpgradeCode.wxl
@@ -1,3 +1,3 @@
 <WixLocalization xmlns="http://wixtoolset.org/schemas/v4/wxl" Culture="en-US">
-  <String Id="InvalidUpgradeCode">NOT-A-GUID</String>
+  <String Id="UpgradeCode">NOT-A-GUID</String>
 </WixLocalization>
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleWithInvalid/BundleWithInvalidUpgradeCode.wxs b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleLocalized/BundleWithLocalizedUpgradeCode.wxs
index dce57226..d9d7f33a 100644
--- a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleWithInvalid/BundleWithInvalidUpgradeCode.wxs
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleLocalized/BundleWithLocalizedUpgradeCode.wxs
@@ -1,6 +1,6 @@
 <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
     <Bundle Name="BundleWithInvalidUpgradeCode"
-            Version="1.0.0.0" Manufacturer="Example Corporation" UpgradeCode="!(loc.InvalidUpgradeCode)">
+            Version="1.0.0.0" Manufacturer="Example Corporation" UpgradeCode="!(loc.UpgradeCode)">
         <BootstrapperApplication>
             <BootstrapperApplicationDll SourceFile="fakeba.dll" />
         </BootstrapperApplication>
diff --git a/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleLocalized/BundleWithValidUpgradeCode.wxl b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleLocalized/BundleWithValidUpgradeCode.wxl
new file mode 100644
index 00000000..c5731331
--- /dev/null
+++ b/src/wix/test/WixToolsetTest.CoreIntegration/TestData/BundleLocalized/BundleWithValidUpgradeCode.wxl
@@ -0,0 +1,3 @@
+<WixLocalization xmlns="http://wixtoolset.org/schemas/v4/wxl" Culture="en-US">
+  <String Id="UpgradeCode">6d4ce32b-fb91-45da-a9b5-7e0d9929a3c3</String>
+</WixLocalization>