From 84a26c3bf9d7a88a7dcbbca4d65b004307600ba2 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Tue, 4 Aug 2020 19:08:10 -0600 Subject: WIXFEAT:4763 Change "string" variable type to literal and add "formatted". --- src/WixToolset.Converters/WixConverter.cs | 54 ++++++++++++++ .../WixToolsetTest.Converters/VariableFixture.cs | 86 ++++++++++++++++++++++ 2 files changed, 140 insertions(+) create mode 100644 src/test/WixToolsetTest.Converters/VariableFixture.cs (limited to 'src') diff --git a/src/WixToolset.Converters/WixConverter.cs b/src/WixToolset.Converters/WixConverter.cs index c9ebdfd3..e4903bcb 100644 --- a/src/WixToolset.Converters/WixConverter.cs +++ b/src/WixToolset.Converters/WixConverter.cs @@ -73,6 +73,7 @@ namespace WixToolset.Converters private static readonly XName ShortcutPropertyElementName = WixNamespace + "ShortcutProperty"; private static readonly XName TextElementName = WixNamespace + "Text"; private static readonly XName UITextElementName = WixNamespace + "UIText"; + private static readonly XName VariableElementName = WixNamespace + "Variable"; private static readonly XName UtilCloseApplicationElementName = WixUtilNamespace + "CloseApplication"; private static readonly XName UtilPermissionExElementName = WixUtilNamespace + "PermissionEx"; private static readonly XName UtilXmlConfigElementName = WixUtilNamespace + "XmlConfig"; @@ -162,6 +163,7 @@ namespace WixToolset.Converters { WixConverter.ShortcutPropertyElementName, this.ConvertShortcutPropertyElement }, { WixConverter.TextElementName, this.ConvertTextElement }, { WixConverter.UITextElementName, this.ConvertUITextElement }, + { WixConverter.VariableElementName, this.ConvertVariableElement }, { WixConverter.UtilCloseApplicationElementName, this.ConvertUtilCloseApplicationElementName }, { WixConverter.UtilPermissionExElementName, this.ConvertUtilPermissionExElement }, { WixConverter.UtilXmlConfigElementName, this.ConvertUtilXmlConfigElement }, @@ -814,6 +816,28 @@ namespace WixToolset.Converters } } + private void ConvertVariableElement(XElement xVariable) + { + var xType = xVariable.Attribute("Type"); + var xValue = xVariable.Attribute("Value"); + if (this.SourceVersion < 4) + { + if (xType == null) + { + if (WasImplicitlyStringTyped(xValue?.Value) && + this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) + { + xVariable.Add(new XAttribute("Type", "formatted")); + } + } + else if (xType.Value == "string" && + this.OnError(ConverterTestType.AssignVariableTypeFormatted, xVariable, "The \"string\" variable type now denotes a literal string. Use \"formatted\" to keep the previous behavior.")) + { + xType.Value = "formatted"; + } + } + } + private void ConvertPropertyElement(XElement xProperty) { var xId = xProperty.Attribute("Id"); @@ -1105,6 +1129,31 @@ namespace WixToolset.Converters } } + private static bool WasImplicitlyStringTyped(string value) + { + if (value == null) + { + return false; + } + else if (value.StartsWith("v", StringComparison.OrdinalIgnoreCase)) + { + if (Int32.TryParse(value.Substring(1), NumberStyles.None, CultureInfo.InvariantCulture.NumberFormat, out var _)) + { + return false; + } + else if (Version.TryParse(value.Substring(1), out var _)) + { + return false; + } + } + else if (Int64.TryParse(value, NumberStyles.Integer, CultureInfo.InvariantCulture.NumberFormat, out var _)) + { + return false; + } + + return true; + } + /// /// Converter test types. These are used to condition error messages down to warnings. /// @@ -1229,6 +1278,11 @@ namespace WixToolset.Converters /// DpiAwareness is new and is defaulted to 'perMonitorV2' which is a change in behavior. /// AssignBootstrapperApplicationDpiAwareness, + + /// + /// The string variable type was previously treated as formatted. + /// + AssignVariableTypeFormatted, } } } diff --git a/src/test/WixToolsetTest.Converters/VariableFixture.cs b/src/test/WixToolsetTest.Converters/VariableFixture.cs new file mode 100644 index 00000000..b7b7388f --- /dev/null +++ b/src/test/WixToolsetTest.Converters/VariableFixture.cs @@ -0,0 +1,86 @@ +// 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 VariableFixture : BaseConverterFixture + { + [Fact] + public void FixFormattedType() + { + 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(3, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + + [Fact] + public void DoesntFixFormattedTypeFromV4() + { + 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(0, errors); + + var actualLines = UnformattedDocumentLines(document); + WixAssert.CompareLineByLine(expected, actualLines); + } + } +} -- cgit v1.2.3-55-g6feb