From e9ef9924b00fab9dc3988d10d50d1f11d1ddf097 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 27 Feb 2021 07:25:13 -0800 Subject: Convert Dependency elements to WiX v4 schema --- src/WixToolset.Converters/WixConverter.cs | 136 +++++++++++++++- .../BootstrapperApplicationFixture.cs | 4 +- .../WixToolsetTest.Converters/ConverterFixture.cs | 4 +- .../WixToolsetTest.Converters/DependencyFixture.cs | 178 +++++++++++++++++++++ 4 files changed, 316 insertions(+), 6 deletions(-) create mode 100644 src/test/WixToolsetTest.Converters/DependencyFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index 1ba28df3..c30a40ac 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -32,6 +32,7 @@ namespace WixToolset.Converters private static readonly XNamespace WixNamespace = "http://wixtoolset.org/schemas/v4/wxs"; private static readonly XNamespace Wix3Namespace = "http://schemas.microsoft.com/wix/2006/wi"; private static readonly XNamespace WixBalNamespace = "http://wixtoolset.org/schemas/v4/wxs/bal"; + private static readonly XNamespace WixDependencyNamespace = "http://wixtoolset.org/schemas/v4/wxs/dependency"; private static readonly XNamespace WixUtilNamespace = "http://wixtoolset.org/schemas/v4/wxs/util"; private static readonly XNamespace WixFirewallNamespace = "http://wixtoolset.org/schemas/v4/wxs/firewall"; @@ -53,6 +54,9 @@ namespace WixToolset.Converters private static readonly XName CreateFolderElementName = WixNamespace + "CreateFolder"; private static readonly XName CustomTableElementName = WixNamespace + "CustomTable"; private static readonly XName DataElementName = WixNamespace + "Data"; + private static readonly XName OldProvidesElementName = WixDependencyNamespace + "Provides"; + private static readonly XName OldRequiresElementName = WixDependencyNamespace + "Requires"; + private static readonly XName OldRequiresRefElementName = WixDependencyNamespace + "RequiresRef"; private static readonly XName DirectoryElementName = WixNamespace + "Directory"; private static readonly XName ErrorElementName = WixNamespace + "Error"; private static readonly XName FeatureElementName = WixNamespace + "Feature"; @@ -72,6 +76,9 @@ namespace WixToolset.Converters private static readonly XName ProductElementName = WixNamespace + "Product"; private static readonly XName ProgressTextElementName = WixNamespace + "ProgressText"; private static readonly XName PublishElementName = WixNamespace + "Publish"; + private static readonly XName ProvidesElementName = WixNamespace + "Provides"; + private static readonly XName RequiresElementName = WixNamespace + "Requires"; + private static readonly XName RequiresRefElementName = WixNamespace + "RequiresRef"; private static readonly XName MultiStringValueElementName = WixNamespace + "MultiStringValue"; private static readonly XName RemotePayloadElementName = WixNamespace + "RemotePayload"; private static readonly XName RegistrySearchElementName = WixNamespace + "RegistrySearch"; @@ -106,11 +113,14 @@ namespace WixToolset.Converters private static readonly XName SummaryInformationElementName = WixNamespace + "SummaryInformation"; private static readonly XName MediaTemplateElementName = WixNamespace + "MediaTemplate"; + private static readonly XName DependencyCheckAttributeName = WixDependencyNamespace + "Check"; + private static readonly XName DependencyEnforceAttributeName = WixDependencyNamespace + "Enforce"; + private static readonly Dictionary OldToNewNamespaceMapping = new Dictionary() { { "http://schemas.microsoft.com/wix/BalExtension", "http://wixtoolset.org/schemas/v4/wxs/bal" }, { "http://schemas.microsoft.com/wix/ComPlusExtension", "http://wixtoolset.org/schemas/v4/wxs/complus" }, - { "http://schemas.microsoft.com/wix/DependencyExtension", "http://wixtoolset.org/schemas/v4/wxs/dependency" }, + { "http://schemas.microsoft.com/wix/DependencyExtension", WixDependencyNamespace }, { "http://schemas.microsoft.com/wix/DifxAppExtension", "http://wixtoolset.org/schemas/v4/wxs/difxapp" }, { "http://schemas.microsoft.com/wix/FirewallExtension", "http://wixtoolset.org/schemas/v4/wxs/firewall" }, { "http://schemas.microsoft.com/wix/HttpExtension", "http://wixtoolset.org/schemas/v4/wxs/http" }, @@ -174,6 +184,9 @@ namespace WixToolset.Converters { WixConverter.MsiPackageElementName, this.ConvertWindowsInstallerPackageElement }, { WixConverter.MspPackageElementName, this.ConvertWindowsInstallerPackageElement }, { WixConverter.MsuPackageElementName, this.ConvertSuppressSignatureValidation }, + { WixConverter.OldProvidesElementName, this.ConvertProvidesElement }, + { WixConverter.OldRequiresElementName, this.ConvertRequiresElement }, + { WixConverter.OldRequiresRefElementName, this.ConvertRequiresRefElement }, { WixConverter.PayloadElementName, this.ConvertSuppressSignatureValidation }, { WixConverter.PermissionExElementName, this.ConvertPermissionExElement }, { WixConverter.ProductElementName, this.ConvertProductElement }, @@ -275,6 +288,7 @@ namespace WixToolset.Converters // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); + this.RemoveUnusedNamspaces(document.Root); return this.Errors; } @@ -327,6 +341,7 @@ namespace WixToolset.Converters // Start converting the nodes at the top. this.ConvertNodes(document.Nodes(), 0); + this.RemoveUnusedNamspaces(document.Root); return this.Errors; } @@ -1136,6 +1151,50 @@ namespace WixToolset.Converters private void ConvertShortcutPropertyElement(XElement element) => this.ConvertInnerTextToAttribute(element, "Value"); + private void ConvertProvidesElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = ProvidesElementName; + } + + if (element.Parent.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Provides element has been integrated into the WiX v4 namespace. Add the 'Check' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyCheckAttributeName, "yes")); + } + } + + private void ConvertRequiresElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = RequiresElementName; + } + + if (element.Parent.Name == ProvidesElementName && + element.Parent.Parent?.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The Requires element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); + } + } + + private void ConvertRequiresRefElement(XElement element) + { + if (this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Remove the namespace.")) + { + element.Name = RequiresRefElementName; + } + + if (element.Parent.Name == ProvidesElementName && + element.Parent.Parent?.Name == ComponentElementName && + this.OnError(ConverterTestType.IntegratedDependencyNamespace, element, "The RequiresRef element has been integrated into the WiX v4 namespace. Add the 'Enforce' attribute from the WixDependency.wixext to match v3 runtime behavior.")) + { + element.Add(new XAttribute(DependencyEnforceAttributeName, "yes")); + } + } + private void ConvertSuppressSignatureValidation(XElement element) { var suppressSignatureValidation = element.Attribute("SuppressSignatureValidation"); @@ -1149,7 +1208,7 @@ namespace WixToolset.Converters private void ConvertTagElement(XElement element) { - if (this.OnError(ConverterTestType.TagElementRenamed, element, "The Tag element has been renamed. Use the element 'SoftwareTag' name.")) + if (this.OnError(ConverterTestType.TagElementRenamed, element, "The Tag element has been renamed. Use the 'SoftwareTag' element instead.")) { element.Name = SoftwareTagElementName; } @@ -1311,6 +1370,10 @@ namespace WixToolset.Converters element.Add(new XAttribute("Bitness", value)); win64.Remove(); } + //else if (this.OnError(ConverterTestType.BitnessAttributeRequired, element, "Use the Bitness attribute instead.")) + //{ + // element.Add(new XAttribute("Bitness", "always32")); + //} var result = element.Attribute("Result")?.Value; if (result == null || result == "value") @@ -1460,6 +1523,50 @@ namespace WixToolset.Converters whitespace.Value = value.Append(' ', level * indentationAmount).ToString(); } + /// + /// Removes unused namespaces from the element and its children. + /// + /// Root element to start at. + private void RemoveUnusedNamspaces(XElement root) + { + var declarations = new List(); + var namespaces = new HashSet(); + + VisitElement(root, x => + { + if (x is XAttribute a && a.IsNamespaceDeclaration) + { + declarations.Add(a); + namespaces.Add(a.Value); + } + return true; + }); + + foreach (var ns in namespaces.ToList()) + { + VisitElement(root, x => + { + if ((x is XElement e && e.Name.Namespace == ns) || + (x is XAttribute a && !a.IsNamespaceDeclaration && a.Name.Namespace == ns)) + { + namespaces.Remove(ns); + return false; + } + + return true; + }); + } + + foreach (var declaration in declarations) + { + if (namespaces.Contains(declaration.Value) && + this.OnError(ConverterTestType.RemoveUnusedNamespaces, declaration, "The namespace '{0}' is not used. Remove unused namespaces.", declaration.Value)) + { + declaration.Remove(); + } + } + } + /// /// Output an error message to the console. /// @@ -1601,6 +1708,21 @@ namespace WixToolset.Converters } } + private static bool VisitElement(XElement element, Func visitor) + { + if (!visitor(element)) + { + return false; + } + + if (!element.Attributes().All(a => visitor(a))) + { + return false; + } + + return element.Elements().All(e => VisitElement(e, visitor)); + } + private static bool WasImplicitlyStringTyped(string value) { if (value == null) @@ -1835,6 +1957,16 @@ namespace WixToolset.Converters /// The Tag element has been renamed. Use the element 'SoftwareTag' name. /// TagElementRenamed, + + /// + /// The Dependency namespace has been incorporated into WiX v4 namespace. + /// + IntegratedDependencyNamespace, + + /// + /// Remove unused namespaces. + /// + RemoveUnusedNamespaces, } } } diff --git a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs index 60386470..158ab3be 100644 --- a/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs +++ b/src/test/WixToolsetTest.Converters/BootstrapperApplicationFixture.cs @@ -396,7 +396,7 @@ namespace WixToolsetTest.Converters var expected = new[] { - "", + "", " ", " ", " ", @@ -409,7 +409,7 @@ namespace WixToolsetTest.Converters var converter = new WixConverter(messaging, 2, null, null); var errors = converter.ConvertDocument(document); - Assert.Equal(4, errors); + Assert.Equal(5, errors); var actualLines = UnformattedDocumentLines(document); WixAssert.CompareLineByLine(expected, actualLines); diff --git a/src/test/WixToolsetTest.Converters/ConverterFixture.cs b/src/test/WixToolsetTest.Converters/ConverterFixture.cs index 20f42068..207d5c8f 100644 --- a/src/test/WixToolsetTest.Converters/ConverterFixture.cs +++ b/src/test/WixToolsetTest.Converters/ConverterFixture.cs @@ -166,7 +166,7 @@ namespace WixToolsetTest.Converters ""); var expected = String.Join(Environment.NewLine, - "", + "", " ", ""); @@ -179,7 +179,7 @@ namespace WixToolsetTest.Converters var actual = UnformattedDocumentString(document); - Assert.Equal(3, errors); + Assert.Equal(4, errors); Assert.Equal(expected, actual); Assert.Equal(Wix4Namespace, document.Root.GetDefaultNamespace()); } diff --git a/src/test/WixToolsetTest.Converters/DependencyFixture.cs b/src/test/WixToolsetTest.Converters/DependencyFixture.cs new file mode 100644 index 00000000..41ded927 --- /dev/null +++ b/src/test/WixToolsetTest.Converters/DependencyFixture.cs @@ -0,0 +1,178 @@ +// 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 DependencyFixture : BaseConverterFixture + { + [Fact] + public void FixPackageDependencyProvides() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + 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); + } + + [Fact] + public void FixPackageDependencyRequires() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + 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 FixPackageDependencyRequiresRef() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + " ", + "" + }; + + 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 FixBundleDependencyProvides() + { + var parse = String.Join(Environment.NewLine, + "", + "", + " ", + " ", + " ", + " ", + " ", + ""); + + var expected = new[] + { + "", + " ", + " ", + " ", + " ", + " ", + "" + }; + + 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); + } + } +} -- cgit v1.2.3-55-g6feb