1 files changed, 115 insertions, 0 deletions

diff --git a/src/wix/WixInternal.Core.TestPackage/XmlNodeExtensions.cs b/src/wix/WixInternal.Core.TestPackage/XmlNodeExtensions.cs
new file mode 100644
index 00000000..4fb9b705
--- /dev/null
+++ b/src/wix/WixInternal.Core.TestPackage/XmlNodeExtensions.cs
@@ -0,0 +1,115 @@
+// 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 WixInternal.Core.TestPackage
+{
+    using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using System.Text.RegularExpressions;
+    using System.Xml;
+
+    /// <summary>
+    /// Utility class to help compare XML in tests using string comparisons by using single quotes and stripping all namespaces.
+    /// </summary>
+    public static class XmlNodeExtensions
+    {
+        /// <summary>
+        /// Adds root element around XML then returns it using single quotes and stripping all namespaces.
+        /// </summary>
+        /// <param name="xmlFragment"></param>
+        /// <param name="ignoredAttributesByElementName">Attributes for which the value should be set to '*'.</param>
+        /// <returns></returns>
+        public static string GetFragmentTestXml(this string xmlFragment, Dictionary<string, List<string>> ignoredAttributesByElementName = null)
+        {
+            return $"<root>{xmlFragment}</root>".GetTestXml(ignoredAttributesByElementName);
+        }
+
+        /// <summary>
+        /// Returns the node's outer XML using single quotes and stripping all namespaces.
+        /// </summary>
+        /// <param name="node"></param>
+        /// <param name="ignoredAttributesByElementName">Attributes for which the value should be set to '*'.</param>
+        /// <returns></returns>
+        public static string GetTestXml(this XmlNode node, Dictionary<string, List<string>> ignoredAttributesByElementName = null)
+        {
+            return node.OuterXml.GetTestXml(ignoredAttributesByElementName);
+        }
+
+        /// <summary>
+        /// Returns the XML using single quotes and stripping all namespaces.
+        /// </summary>
+        /// <param name="xml"></param>
+        /// <param name="ignoredAttributesByElementName">Attributes for which the value should be set to '*'.</param>
+        /// <returns></returns>
+        public static string GetTestXml(this string xml, Dictionary<string, List<string>> ignoredAttributesByElementName = null)
+        {
+            string formattedXml;
+            using (var sw = new StringWriter())
+            using (var writer = new TestXmlWriter(sw))
+            {
+                var doc = new XmlDocument();
+                doc.LoadXml(xml);
+
+                if (ignoredAttributesByElementName != null)
+                {
+                    HandleIgnoredAttributes(doc, ignoredAttributesByElementName);
+                }
+
+                doc.Save(writer);
+                formattedXml = sw.ToString();
+            }
+
+            return Regex.Replace(formattedXml, " xmlns(:[^=]+)?='[^']*'", "");
+        }
+
+        /// <summary>
+        /// Returns the XML for each node using single quotes and stripping all namespaces.
+        /// </summary>
+        /// <param name="nodeList"></param>
+        /// <param name="ignoredAttributesByElementName">Attributes for which the value should be set to '*'.</param>
+        /// <returns></returns>
+        public static string[] GetTestXmlLines(this XmlNodeList nodeList, Dictionary<string, List<string>> ignoredAttributesByElementName = null)
+        {
+            return nodeList.Cast<XmlNode>()
+                           .Select(x => x.GetTestXml(ignoredAttributesByElementName))
+                           .ToArray();
+        }
+
+        private static void HandleIgnoredAttributes(XmlNode node, Dictionary<string, List<string>> ignoredAttributesByElementName)
+        {
+            if (node.Attributes != null && ignoredAttributesByElementName.TryGetValue(node.LocalName, out var ignoredAttributes))
+            {
+                foreach (var ignoredAttribute in ignoredAttributes)
+                {
+                    var attribute = node.Attributes[ignoredAttribute];
+                    if (attribute != null)
+                    {
+                        attribute.Value = "*";
+                    }
+                }
+            }
+
+            if (node.ChildNodes != null)
+            {
+                foreach (XmlNode childNode in node.ChildNodes)
+                {
+                    HandleIgnoredAttributes(childNode, ignoredAttributesByElementName);
+                }
+            }
+        }
+
+        private class TestXmlWriter : XmlTextWriter
+        {
+            public TestXmlWriter(TextWriter w)
+                : base(w)
+            {
+                this.QuoteChar = '\'';
+            }
+
+            public override void WriteStartDocument()
+            {
+                //OmitXmlDeclaration
+            }
+        }
+    }
+}