Add conversion for renaming RemotePayload, and warn about changed hash.

#3992, #4183

3 files changed, 169 insertions, 33 deletions

diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs
index 83a333f0..83053725 100644
--- a/src/WixToolset.Converters/WixConverter.cs
+++ b/src/WixToolset.Converters/WixConverter.cs
@@ -66,10 +66,12 @@ namespace WixToolset.Converters
         private static readonly XName LaunchElementName = WixNamespace + "Launch";
         private static readonly XName LevelElementName = WixNamespace + "Level";
         private static readonly XName ExePackageElementName = WixNamespace + "ExePackage";
+        private static readonly XName ExePackagePayloadElementName = WixNamespace + "ExePackagePayload";
         private static readonly XName ModuleElementName = WixNamespace + "Module";
         private static readonly XName MsiPackageElementName = WixNamespace + "MsiPackage";
         private static readonly XName MspPackageElementName = WixNamespace + "MspPackage";
         private static readonly XName MsuPackageElementName = WixNamespace + "MsuPackage";
+        private static readonly XName MsuPackagePayloadElementName = WixNamespace + "MsuPackagePayload";
         private static readonly XName PackageElementName = WixNamespace + "Package";
         private static readonly XName PayloadElementName = WixNamespace + "Payload";
         private static readonly XName PermissionExElementName = WixNamespace + "PermissionEx";
@@ -1099,6 +1101,44 @@ namespace WixToolset.Converters
 
         private void ConvertRemotePayloadElement(XElement element)
         {
+            var xParent = element.Parent;
+
+            if (xParent.Name == ExePackageElementName &&
+                this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'ExePackagePayload' instead."))
+            {
+                element.Name = ExePackagePayloadElementName;
+            }
+            else if (xParent.Name == MsuPackageElementName &&
+                     this.OnError(ConverterTestType.RemotePayloadRenamed, element, "The RemotePayload element has been renamed. Use the 'MsuPackagePayload' instead."))
+            {
+                element.Name = MsuPackagePayloadElementName;
+            }
+
+            var xName = xParent.Attribute("Name");
+            if (xName != null &&
+                this.OnError(ConverterTestType.NameAttributeMovedToRemotePayload, xParent, "The Name attribute must be specified on the child XxxPackagePayload element when using a remote payload."))
+            {
+                element.SetAttributeValue("Name", xName.Value);
+                xName.Remove();
+            }
+
+            var xDownloadUrl = xParent.Attribute("DownloadUrl");
+            if (xDownloadUrl != null &&
+                this.OnError(ConverterTestType.DownloadUrlAttributeMovedToRemotePayload, xParent, "The DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload."))
+            {
+                element.SetAttributeValue("DownloadUrl", xDownloadUrl.Value);
+                xDownloadUrl.Remove();
+            }
+
+            var xCompressed = xParent.Attribute("Compressed");
+            if (xCompressed != null &&
+                this.OnError(ConverterTestType.CompressedAttributeUnnecessaryForRemotePayload, xParent, "The Compressed attribute should not be specified when using a remote payload."))
+            {
+                xCompressed.Remove();
+            }
+
+            this.OnError(ConverterTestType.BurnHashAlgorithmChanged, element, "The hash algorithm for bundles changed from SHA1 to SHA512.");
+
             RemoveIfPresent(element.Attribute("CertificatePublicKey"));
             RemoveIfPresent(element.Attribute("CertificateThumbprint"));
 
@@ -1957,6 +1997,31 @@ namespace WixToolset.Converters
             /// Remove unused namespaces.
             /// </summary>
             RemoveUnusedNamespaces,
+
+            /// <summary>
+            /// The Remote element has been renamed. Use the "XxxPackagePayload" element instead.
+            /// </summary>
+            RemotePayloadRenamed,
+
+            /// <summary>
+            /// The XxxPackage/@Name attribute must be specified on the child XxxPackagePayload element when using a remote payload.
+            /// </summary>
+            NameAttributeMovedToRemotePayload,
+
+            /// <summary>
+            /// The XxxPackage/@Compressed attribute should not be specified when using a remote payload.
+            /// </summary>
+            CompressedAttributeUnnecessaryForRemotePayload,
+
+            /// <summary>
+            /// The XxxPackage/@DownloadUrl attribute must be specified on the child XxxPackagePayload element when using a remote payload.
+            /// </summary>
+            DownloadUrlAttributeMovedToRemotePayload,
+
+            /// <summary>
+            /// The hash algorithm used for bundles changed from SHA1 to SHA512.
+            /// </summary>
+            BurnHashAlgorithmChanged,
         }
     }
 }
diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs
index 207d5c8f..4d815247 100644
--- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs
+++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs
@@ -331,39 +331,6 @@ namespace WixToolsetTest.Converters
         }
 
         [Fact]
-        public void CanConvertRemotePayloadElement()
-        {
-            var parse = String.Join(Environment.NewLine,
-                "<Wix xmlns='http://wixtoolset.org/schemas/v4/wxs'>",
-                "  <RemotePayload",
-                "      Description='Microsoft ASP.NET Core 3.1.8 - Shared Framework'",
-                "      Hash='61DC9EAA0C8968E48E13C5913ED202A2F8F94DBA'",
-                "      CertificatePublicKey='3756E9BBF4461DCD0AA68E0D1FCFFA9CEA47AC18'",
-                "      CertificateThumbprint='2485A7AFA98E178CB8F30C9838346B514AEA4769'",
-                "      ProductName='Microsoft ASP.NET Core 3.1.8 - Shared Framework'",
-                "      Size='7841880'",
-                "      Version='3.1.8.20421' />",
-                "</Wix>");
-
-            var expected = String.Join(Environment.NewLine,
-                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
-                "  <RemotePayload Description=\"Microsoft ASP.NET Core 3.1.8 - Shared Framework\" Hash=\"61DC9EAA0C8968E48E13C5913ED202A2F8F94DBA\" ProductName=\"Microsoft ASP.NET Core 3.1.8 - Shared Framework\" Size=\"7841880\" Version=\"3.1.8.20421\" />",
-                "</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);
-
-            var actual = UnformattedDocumentString(document);
-
-            Assert.Equal(2, errors);
-            Assert.Equal(expected, actual);
-        }
-
-        [Fact]
         public void CanConvertSuppressSignatureValidationNo()
         {
             var parse = String.Join(Environment.NewLine,
diff --git a/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs b/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs
new file mode 100644
index 00000000..b2640e13
--- /dev/null
+++ b/src/test/WixToolsetTest.Converters/RemotePayloadFixture.cs
@@ -0,0 +1,104 @@
+// 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 RemotePayloadFixture : BaseConverterFixture
+    {
+        [Fact]
+        public void CanConvertExePackageRemotePayload()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<Wix xmlns='http://wixtoolset.org/schemas/v4/wxs'>",
+                "  <Fragment>",
+                "    <PackageGroup Id='exe'>",
+                "      <ExePackage Name='example.exe' DownloadUrl='example.com'>",
+                "        <RemotePayload",
+                "          Description='Microsoft ASP.NET Core 3.1.8 - Shared Framework'",
+                "          Hash='61DC9EAA0C8968E48E13C5913ED202A2F8F94DBA'",
+                "          CertificatePublicKey='3756E9BBF4461DCD0AA68E0D1FCFFA9CEA47AC18'",
+                "          CertificateThumbprint='2485A7AFA98E178CB8F30C9838346B514AEA4769'",
+                "          ProductName='Microsoft ASP.NET Core 3.1.8 - Shared Framework'",
+                "          Size='7841880'",
+                "          Version='3.1.8.20421' />",
+                "      </ExePackage>",
+                "    </PackageGroup>",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Fragment>",
+                "    <PackageGroup Id=\"exe\">",
+                "      <ExePackage>",
+                "        <ExePackagePayload Description=\"Microsoft ASP.NET Core 3.1.8 - Shared Framework\" Hash=\"61DC9EAA0C8968E48E13C5913ED202A2F8F94DBA\" ProductName=\"Microsoft ASP.NET Core 3.1.8 - Shared Framework\" Size=\"7841880\" Version=\"3.1.8.20421\" Name=\"example.exe\" DownloadUrl=\"example.com\" />",
+                "      </ExePackage>",
+                "    </PackageGroup>",
+                "  </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 CanConvertMsuPackageRemotePayload()
+        {
+            var parse = String.Join(Environment.NewLine,
+                "<Wix xmlns='http://wixtoolset.org/schemas/v4/wxs'>",
+                "  <Fragment>",
+                "    <PackageGroup Id='msu'>",
+                "      <MsuPackage Name='example.msu' DownloadUrl='example.com' Compressed='no'>",
+                "        <RemotePayload",
+                "          Description='msu description'",
+                "          Hash='71DC9EAA0C8968E48E13C5913ED202A2F8F94DBB'",
+                "          ProductName='msu product name'",
+                "          Size='500'",
+                "          Version='0.0.0.0' />",
+                "      </MsuPackage>",
+                "    </PackageGroup>",
+                "  </Fragment>",
+                "</Wix>");
+
+            var expected = new[]
+            {
+                "<Wix xmlns=\"http://wixtoolset.org/schemas/v4/wxs\">",
+                "  <Fragment>",
+                "    <PackageGroup Id=\"msu\">",
+                "      <MsuPackage>",
+                "        <MsuPackagePayload Description=\"msu description\" Hash=\"71DC9EAA0C8968E48E13C5913ED202A2F8F94DBB\" ProductName=\"msu product name\" Size=\"500\" Version=\"0.0.0.0\" Name=\"example.msu\" DownloadUrl=\"example.com\" />",
+                "      </MsuPackage>",
+                "    </PackageGroup>",
+                "  </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(5, errors);
+
+            var actualLines = UnformattedDocumentLines(document);
+            WixAssert.CompareLineByLine(expected, actualLines);
+        }
+    }
+}