Replace Win64 attribute with Bitness attribute

2 files changed, 235 insertions, 1 deletions

diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs
index 73daa9a2..18cd7115 100644
--- a/src/WixToolset.Converters/WixConverter.cs
+++ b/src/WixToolset.Converters/WixConverter.cs
@@ -43,6 +43,7 @@ namespace WixToolset.Converters
         private static readonly XName BootstrapperApplicationElementName = WixNamespace + "BootstrapperApplication";
         private static readonly XName BootstrapperApplicationDllElementName = WixNamespace + "BootstrapperApplicationDll";
         private static readonly XName BootstrapperApplicationRefElementName = WixNamespace + "BootstrapperApplicationRef";
+        private static readonly XName ApprovedExeForElevationElementName = WixNamespace + "ApprovedExeForElevation";
         private static readonly XName EmbeddedChainerElementName = WixNamespace + "EmbeddedChainer";
         private static readonly XName CatalogElementName = WixNamespace + "Catalog";
         private static readonly XName ColumnElementName = WixNamespace + "Column";
@@ -73,6 +74,7 @@ namespace WixToolset.Converters
         private static readonly XName PublishElementName = WixNamespace + "Publish";
         private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue";
         private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload";
+        private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch";
         private static readonly XName RequiredPrivilegeElementName = WixNamespace + "RequiredPrivilege";
         private static readonly XName ServiceArgumentElementName = WixNamespace + "ServiceArgument";
         private static readonly XName SetDirectoryElementName = WixNamespace + "SetDirectory";
@@ -151,6 +153,7 @@ namespace WixToolset.Converters
                 { WixConverter.InstallExecuteSequenceElementName, this.ConvertSequenceElement },
                 { WixConverter.BootstrapperApplicationElementName, this.ConvertBootstrapperApplicationElement },
                 { WixConverter.BootstrapperApplicationRefElementName, this.ConvertBootstrapperApplicationRefElement },
+                { WixConverter.ApprovedExeForElevationElementName, this.ConvertApprovedExeForElevationElement },
                 { WixConverter.CatalogElementName, this.ConvertCatalogElement },
                 { WixConverter.ColumnElementName, this.ConvertColumnElement },
                 { WixConverter.CustomTableElementName, this.ConvertCustomTableElement },
@@ -175,6 +178,7 @@ namespace WixToolset.Converters
                 { WixConverter.ProgressTextElementName, this.ConvertProgressTextElement },
                 { WixConverter.PublishElementName, this.ConvertPublishElement },
                 { WixConverter.MultiStringValueElementName, this.ConvertMultiStringValueElement },
+                { WixConverter.RegistrySearchElementName, this.ConvertRegistrySearchElement },
                 { WixConverter.RemotePayloadElementName, this.ConvertRemotePayloadElement },
                 { WixConverter.RequiredPrivilegeElementName, this.ConvertRequiredPrivilegeElement },
                 { WixConverter.CustomActionElementName, this.ConvertCustomActionElement },
@@ -625,6 +629,20 @@ namespace WixToolset.Converters
             }
         }
 
+        private void ConvertApprovedExeForElevationElement(XElement element)
+        {
+            if (this.SourceVersion < 4)
+            {
+                var win64 = element.Attribute("Win64");
+                if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead."))
+                {
+                    var value = win64.Value;
+                    element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32"));
+                    win64.Remove();
+                }
+            }
+        }
+
         private void ConvertBalBootstrapperApplicationRef(XElement element, string theme, XName balBAElementName, XName oldBalBAElementName = null)
         {
             var xBalBa = element.Element(oldBalBAElementName ?? balBAElementName);
@@ -733,6 +751,14 @@ namespace WixToolset.Converters
                     xCondition.Remove();
                 }
             }
+
+            var win64 = element.Attribute("Win64");
+            if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead."))
+            {
+                var value = win64.Value;
+                element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32"));
+                win64.Remove();
+            }
         }
 
         private void ConvertDirectoryElement(XElement element)
@@ -1071,6 +1097,20 @@ namespace WixToolset.Converters
             }
         }
 
+        private void ConvertRegistrySearchElement(XElement element)
+        {
+            if (this.SourceVersion < 4)
+            {
+                var win64 = element.Attribute("Win64");
+                if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead."))
+                {
+                    var value = win64.Value;
+                    element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32"));
+                    win64.Remove();
+                }
+            }
+        }
+
         private void ConvertRequiredPrivilegeElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Name");
 
         private void ConvertRowElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value");
@@ -1241,7 +1281,7 @@ namespace WixToolset.Converters
                 var inheritable = element.Parent.Name == CreateFolderElementName;
                 if (!inheritable)
                 {
-                    if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default"))
+                    if (this.OnError(ConverterTestType.AssignPermissionExInheritable, element, "The PermissionEx Inheritable attribute is being set to 'no' to ensure it remains the same as the v3 default."))
                     {
                         element.Add(new XAttribute("Inheritable", "no"));
                     }
@@ -1253,6 +1293,14 @@ namespace WixToolset.Converters
         {
             if (this.SourceVersion < 4)
             {
+                var win64 = element.Attribute("Win64");
+                if (win64 != null && this.OnError(ConverterTestType.Win64AttributeRenamed, element, "The Win64 attribute has been renamed. Use the Bitness attribute instead."))
+                {
+                    var value = win64.Value;
+                    element.Add(new XAttribute("Bitness", value == "yes" ? "always64" : "always32"));
+                    win64.Remove();
+                }
+
                 var result = element.Attribute("Result")?.Value;
                 if (result == null || result == "value")
                 {
@@ -1742,6 +1790,11 @@ namespace WixToolset.Converters
             /// The ExePackage elements "XxxCommand" attributes have been renamed to "XxxArguments".
             /// </summary>
             RenameExePackageCommandToArguments,
+
+            /// <summary>
+            /// The Win64 attribute has been renamed. Use the Bitness attribute instead.
+            /// </summary>
+            Win64AttributeRenamed,
         }
     }
 }
diff --git a/src/test/WixToolsetTest.Converters/BitnessFixture.cs b/src/test/WixToolsetTest.Converters/BitnessFixture.cs
new file mode 100644
index 00000000..9996806d
--- /dev/null
+++ b/src/test/WixToolsetTest.Converters/BitnessFixture.cs
@@ -0,0 +1,181 @@
+// 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 WixToolsetTest.Converters
+{
+    using System;
+    using System.Xml.Linq;
+    using WixBuildTools.TestSupport;
+    using WixToolset.Converters;
+    using WixToolsetTest.Converters.Mocks;
+    using Xunit;
+
+    public class BitnessFixture : BaseConverterFixture
+    {
+        [Fact]
+        public void FixComponentBitness()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<?xml version=\"1.0\" encoding=\"utf-16\"?>",
+                "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi'>",
+                "  <Fragment>",
+                "    <Component>",
+                "        <File Source='default.exe' />",
+                "    </Component>",
+                "    <Component Win64='no'>",
+                "        <File Source='32bit.exe' />",
+                "    </Component>",
+                "    <Component Win64='yes'>",
+                "        <File Source='64bit.exe' />",
+                "    </Component>",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Fragment>",
+                "    <Component>",
+                "        <File Id=\"default.exe\" Source=\"default.exe\" />",
+                "    </Component>",
+                "    <Component Bitness=\"always32\">",
+                "        <File Id=\"_32bit.exe\" Source=\"32bit.exe\" />",
+                "    </Component>",
+                "    <Component Bitness=\"always64\">",
+                "        <File Id=\"_64bit.exe\" Source=\"64bit.exe\" />",
+                "    </Component>",
+                "  </Fragment>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(7, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+
+        [Fact]
+        public void FixRegistrySearchBitness()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<?xml version=\"1.0\" encoding=\"utf-16\"?>",
+                "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi'>",
+                "  <Fragment>",
+                "    <Property Id='BITNESSDEFAULT'>",
+                "        <RegistrySearch Id='SampleRegSearch' Root='HKLM' Key='SampleReg' Type='raw'></RegistrySearch>",
+                "    </Property>",
+                "    <Property Id='BITNESS32'>",
+                "        <RegistrySearch Id='SampleRegSearch' Root='HKLM' Key='SampleReg' Type='raw' Win64='no'></RegistrySearch>",
+                "    </Property>",
+                "    <Property Id='BITNESS64'>",
+                "        <RegistrySearch Id='SampleRegSearch' Root='HKLM' Key='SampleReg' Type='raw' Win64='yes'></RegistrySearch>",
+                "    </Property>",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Fragment>",
+                "    <Property Id=\"BITNESSDEFAULT\">",
+                "        <RegistrySearch Id=\"SampleRegSearch\" Root=\"HKLM\" Key=\"SampleReg\" Type=\"raw\"></RegistrySearch>",
+                "    </Property>",
+                "    <Property Id=\"BITNESS32\">",
+                "        <RegistrySearch Id=\"SampleRegSearch\" Root=\"HKLM\" Key=\"SampleReg\" Type=\"raw\" Bitness=\"always32\"></RegistrySearch>",
+                "    </Property>",
+                "    <Property Id=\"BITNESS64\">",
+                "        <RegistrySearch Id=\"SampleRegSearch\" Root=\"HKLM\" Key=\"SampleReg\" Type=\"raw\" Bitness=\"always64\"></RegistrySearch>",
+                "    </Property>",
+                "  </Fragment>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(4, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+
+        [Fact]
+        public void FixUtilRegistrySearchBitness()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi' xmlns:util='http://schemas.microsoft.com/wix/UtilExtension'>",
+                "  <Fragment>",
+                "    <util:RegistrySearch Id='RegValue' Root='HKLM' Key='Converter' Variable='Test' />",
+                "    <util:RegistrySearch Id='RegValue2' Root='HKLM' Key='Converter' Variable='Test' Result='value' Win64='no' />",
+                "    <util:RegistrySearch Id='RegValue3' Root='HKLM' Key='Converter' Variable='Test' Result='exists' Win64='yes' />",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\" xmlns:util=\"http://wixtoolset.org/schemas/v4/wxs/util\">",
+                "  <Fragment>",
+                "    <util:RegistrySearch Id=\"RegValue\" Root=\"HKLM\" Key=\"Converter\" Variable=\"Test\" />",
+                "    <util:RegistrySearch Id=\"RegValue2\" Root=\"HKLM\" Key=\"Converter\" Variable=\"Test\" Result=\"value\" Bitness=\"always32\" />",
+                "    <util:RegistrySearch Id=\"RegValue3\" Root=\"HKLM\" Key=\"Converter\" Variable=\"Test\" Result=\"exists\" Bitness=\"always64\" />",
+                "  </Fragment>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(6, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+
+        [Fact]
+        public void FixApprovedExeBitness()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<?xml version=\"1.0\" encoding=\"utf-16\"?>",
+                "<Wix xmlns='http://schemas.microsoft.com/wix/2006/wi'>",
+                "  <Bundle>",
+                "    <ApprovedExeForElevation Id='Default' Key='WixToolset\\BurnTesting' Value='Test' />",
+                "    <ApprovedExeForElevation Id='Bitness32' Key='WixToolset\\BurnTesting' Value='Test' Win64='no' />",
+                "    <ApprovedExeForElevation Id='Bitness64' Key='WixToolset\\BurnTesting' Value='Test' Win64='yes' />",
+                "  </Bundle>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Bundle>",
+                "    <ApprovedExeForElevation Id=\"Default\" Key=\"WixToolset\\BurnTesting\" Value=\"Test\" />",
+                "    <ApprovedExeForElevation Id=\"Bitness32\" Key=\"WixToolset\\BurnTesting\" Value=\"Test\" Bitness=\"always32\" />",
+                "    <ApprovedExeForElevation Id=\"Bitness64\" Key=\"WixToolset\\BurnTesting\" Value=\"Test\" Bitness=\"always64\" />",
+                "  </Bundle>",
+                "</Wix>"
+            };
+
+            var document = XDocument.Parse(parse, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
+
+            var messaging = new MockMessaging();
+            var converter = new WixConverter(messaging, 2, null, null);
+
+            var errors = converter.ConvertDocument(document);
+            Assert.Equal(4, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+    }
+}