Update registration disappears during upgrade.bob/UpdateRegistrationAcrossUpgrades

Update registration is stored in a shared registry key that Burn takes
care to keep around across upgrades. The approach it used broke
between WiX v3 and WiX v5. This change makes it work again by
writing update registration when the session ends.

2 files changed, 94 insertions, 0 deletions

diff --git a/src/test/burn/WixTestTools/BundleUpdateRegistration.cs b/src/test/burn/WixTestTools/BundleUpdateRegistration.cs
new file mode 100644
index 00000000..2ce68122
--- /dev/null
+++ b/src/test/burn/WixTestTools/BundleUpdateRegistration.cs
@@ -0,0 +1,57 @@
+// 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.
+
+namespace WixTestTools
+{
+    using System;
+    using Microsoft.Win32;
+
+    public class BundleUpdateRegistration
+    {
+        public const string BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PACKAGE_NAME = "PackageName";
+        public const string BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PACKAGE_VERSION = "PackageVersion";
+        public const string BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PUBLISHER = "Publisher";
+        public const string BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PUBLISHING_GROUP = "PublishingGroup";
+
+        public string PackageName { get; set; }
+
+        public string PackageVersion { get; set; }
+
+        public string Publisher { get; set; }
+
+        public string PublishingGroup { get; set; }
+
+        public static bool TryGetPerMachineBundleUpdateRegistration(string manufacturer, string productFamily, string name, bool x64, out BundleUpdateRegistration registration)
+        {
+            return TryGetUpdateRegistration(manufacturer, productFamily, name, x64, perUser: false, out registration);
+        }
+
+        public static bool TryGetPerUserBundleUpdateRegistration(string manufacturer, string productFamily, string name, out BundleUpdateRegistration registration)
+        {
+            return TryGetUpdateRegistration(manufacturer, productFamily, name, x64: true, perUser: true, out registration);
+        }
+
+        private static bool TryGetUpdateRegistration(string manufacturer, string productFamily, string name, bool x64, bool perUser, out BundleUpdateRegistration registration)
+        {
+            var baseKey = perUser ? Registry.CurrentUser : Registry.LocalMachine;
+            var baseKeyPath = x64 ? @$"SOFTWARE\{manufacturer}\Updates\{productFamily}\{name}"
+                : @$"SOFTWARE\WOW6432Node\{manufacturer}\Updates\{productFamily}\{name}";
+            using var idKey = baseKey.OpenSubKey(baseKeyPath);
+
+            if (idKey == null)
+            {
+                registration = null;
+                return false;
+            }
+
+            registration = new BundleUpdateRegistration()
+            {
+                PackageName = idKey.GetValue(BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PACKAGE_NAME) as string,
+                PackageVersion = idKey.GetValue(BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PACKAGE_VERSION) as string,
+                Publisher = idKey.GetValue(BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PUBLISHER) as string,
+                PublishingGroup = idKey.GetValue(BURN_UPDATE_REGISTRATION_REGISTRY_BUNDLE_PUBLISHING_GROUP) as string,
+            };
+
+            return true;
+        }
+    }
+}
diff --git a/src/test/burn/WixTestTools/BundleVerifier.cs b/src/test/burn/WixTestTools/BundleVerifier.cs
index da61d96e..b6181047 100644
--- a/src/test/burn/WixTestTools/BundleVerifier.cs
+++ b/src/test/burn/WixTestTools/BundleVerifier.cs
@@ -6,6 +6,7 @@ namespace WixTestTools
     using System.IO;
     using System.Linq;
     using System.Text;
+    using System.Xml.Linq;
     using Microsoft.Win32;
     using WixInternal.TestSupport;
     using WixToolset.Data;
@@ -23,6 +24,8 @@ namespace WixTestTools
 
         private WixBundleSymbol BundleSymbol { get; set; }
 
+        private WixUpdateRegistrationSymbol UpdateRegistrationSymbol { get; set; }
+
         private WixBundleSymbol GetBundleSymbol()
         {
             if (this.BundleSymbol == null)
@@ -36,6 +39,19 @@ namespace WixTestTools
             return this.BundleSymbol;
         }
 
+        private WixUpdateRegistrationSymbol GetUpdateRegistrationSymbol()
+        {
+            if (this.UpdateRegistrationSymbol == null)
+            {
+                using var wixOutput = WixOutput.Read(this.BundlePdb);
+                var intermediate = Intermediate.Load(wixOutput);
+                var section = intermediate.Sections.Single();
+                this.UpdateRegistrationSymbol = section.Symbols.OfType<WixUpdateRegistrationSymbol>().Single();
+            }
+
+            return this.UpdateRegistrationSymbol;
+        }
+
         public string GetFullBurnPolicyRegistryPath()
         {
             var bundleSymbol = this.GetBundleSymbol();
@@ -118,6 +134,27 @@ namespace WixTestTools
             }
         }
 
+        public bool TryGetUpdateRegistration(out BundleUpdateRegistration registration)
+        {
+            var bundleSymbol = this.GetBundleSymbol();
+            var x64 = bundleSymbol.Platform != Platform.X86;
+
+            var updateRegistrationSymbol = this.GetUpdateRegistrationSymbol();
+            var manufacturer = updateRegistrationSymbol.Manufacturer;
+            var productFamily = updateRegistrationSymbol.ProductFamily;
+            var name = updateRegistrationSymbol.Name;
+
+
+            if (bundleSymbol.PerMachine)
+            {
+                return BundleUpdateRegistration.TryGetPerMachineBundleUpdateRegistration(manufacturer, productFamily, name, x64, out registration);
+            }
+            else
+            {
+                return BundleUpdateRegistration.TryGetPerUserBundleUpdateRegistration(manufacturer, productFamily, name, out registration);
+            }
+        }
+
         public BundleRegistration VerifyRegisteredAndInPackageCache(int? expectedSystemComponent = null)
         {
             Assert.True(this.TryGetRegistration(out var registration));