-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(GH-1260) Fix issue in parameter emitter where reserved keywords as l…
…egal parameter names in assembly are not being generated correctly. This provides proper escaping of all reserved keywords where the reflected ParameterInfo.Name property of the parameter matches a reserved keyword. At runtime, the CLR reports the un-escaped parameter name (the @parameter escaping is a compile-time hint only) Update usage in ParameterEmitter, add supporting unit/integration tests.
- Loading branch information
Showing
7 changed files
with
232 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
...Scripting/CodeGen/Expected/Methods/NonGeneric_ExtensionMethodWithReservedKeywordParameter
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| public void NonGeneric_ExtensionMethodWithReservedKeywordParameter(System.Int32 @new) | ||
| { | ||
| Cake.Core.Tests.Data.MethodAliasGeneratorData.NonGeneric_ExtensionMethodWithReservedKeywordParameter(Context, @new); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
137 changes: 137 additions & 0 deletions
137
src/Cake.Core.Tests/Unit/Scripting/CodeGen/ParameterFormatterTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Reflection; | ||
| using Cake.Core.Scripting.CodeGen; | ||
| using Xunit; | ||
|
|
||
| namespace Cake.Core.Tests.Unit.Scripting.CodeGen | ||
| { | ||
| public sealed class ParameterFormatterTests | ||
| { | ||
| private readonly ParameterFormatter _parameterFormatter = new ParameterFormatter(); | ||
|
|
||
| [Fact] | ||
| public void Should_Throw_If_Parameter_Info_Is_Null() | ||
| { | ||
| // When | ||
| var result = Record.Exception(() => _parameterFormatter.FormatName((ParameterInfo)null)); | ||
|
|
||
| // Then | ||
| Assert.IsArgumentNullException(result, "parameterInfo"); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(null)] | ||
| [InlineData("")] | ||
| [InlineData("\t")] | ||
| [InlineData(" ")] | ||
| public void Should_Throw_If_Parameter_Name_Is_Null_Or_Whitespace(string arg) | ||
| { | ||
| // When | ||
| var result = Record.Exception(() => _parameterFormatter.FormatName(arg)); | ||
|
|
||
| // Then | ||
| Assert.IsArgumentException(result, "parameterName", "Parameter name cannot be null or whitespace"); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData("abstract", "@abstract")] | ||
| [InlineData("as", "@as")] | ||
| [InlineData("base", "@base")] | ||
| [InlineData("bool", "@bool")] | ||
| [InlineData("break", "@break")] | ||
| [InlineData("byte", "@byte")] | ||
| [InlineData("case", "@case")] | ||
| [InlineData("catch", "@catch")] | ||
| [InlineData("char", "@char")] | ||
| [InlineData("checked", "@checked")] | ||
| [InlineData("class", "@class")] | ||
| [InlineData("const", "@const")] | ||
| [InlineData("continue", "@continue")] | ||
| [InlineData("decimal", "@decimal")] | ||
| [InlineData("default", "@default")] | ||
| [InlineData("delegate", "@delegate")] | ||
| [InlineData("do", "@do")] | ||
| [InlineData("double", "@double")] | ||
| [InlineData("else", "@else")] | ||
| [InlineData("enum", "@enum")] | ||
| [InlineData("event", "@event")] | ||
| [InlineData("explicit", "@explicit")] | ||
| [InlineData("extern", "@extern")] | ||
| [InlineData("false", "@false")] | ||
| [InlineData("finally", "@finally")] | ||
| [InlineData("fixed", "@fixed")] | ||
| [InlineData("float", "@float")] | ||
| [InlineData("for", "@for")] | ||
| [InlineData("foreach", "@foreach")] | ||
| [InlineData("goto", "@goto")] | ||
| [InlineData("if", "@if")] | ||
| [InlineData("implicit", "@implicit")] | ||
| [InlineData("in", "@in")] | ||
| [InlineData("int", "@int")] | ||
| [InlineData("interface", "@interface")] | ||
| [InlineData("internal", "@internal")] | ||
| [InlineData("is", "@is")] | ||
| [InlineData("lock", "@lock")] | ||
| [InlineData("long", "@long")] | ||
| [InlineData("namespace", "@namespace")] | ||
| [InlineData("new", "@new")] | ||
| [InlineData("null", "@null")] | ||
| [InlineData("object", "@object")] | ||
| [InlineData("operator", "@operator")] | ||
| [InlineData("out", "@out")] | ||
| [InlineData("override", "@override")] | ||
| [InlineData("params", "@params")] | ||
| [InlineData("private", "@private")] | ||
| [InlineData("protected", "@protected")] | ||
| [InlineData("public", "@public")] | ||
| [InlineData("readonly", "@readonly")] | ||
| [InlineData("ref", "@ref")] | ||
| [InlineData("return", "@return")] | ||
| [InlineData("sbyte", "@sbyte")] | ||
| [InlineData("sealed", "@sealed")] | ||
| [InlineData("short", "@short")] | ||
| [InlineData("sizeof", "@sizeof")] | ||
| [InlineData("stackalloc", "@stackalloc")] | ||
| [InlineData("static", "@static")] | ||
| [InlineData("string", "@string")] | ||
| [InlineData("struct", "@struct")] | ||
| [InlineData("switch", "@switch")] | ||
| [InlineData("this", "@this")] | ||
| [InlineData("throw", "@throw")] | ||
| [InlineData("true", "@true")] | ||
| [InlineData("try", "@try")] | ||
| [InlineData("typeof", "@typeof")] | ||
| [InlineData("uint", "@uint")] | ||
| [InlineData("ulong", "@ulong")] | ||
| [InlineData("unchecked", "@unchecked")] | ||
| [InlineData("unsafe", "@unsafe")] | ||
| [InlineData("ushort", "@ushort")] | ||
| [InlineData("using", "@using")] | ||
| [InlineData("virtual", "@virtual")] | ||
| [InlineData("void", "@void")] | ||
| [InlineData("volatile", "@volatile")] | ||
| [InlineData("while", "@while")] | ||
| public void Should_Format_Reserved_Keywords_Correctly(string parameterName, string expectedParameterName) | ||
| { | ||
| // When | ||
| var result = _parameterFormatter.FormatName(parameterName); | ||
|
|
||
| // Then | ||
| Assert.Equal(expectedParameterName, result); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData("testParameter", "testParameter")] | ||
| public void Should_Format_Variable_Names_Correctly(string parameterName, string expectedParameterName) | ||
| { | ||
| // When | ||
| var result = _parameterFormatter.FormatName(parameterName); | ||
|
|
||
| // Then | ||
| Assert.Equal(expectedParameterName, result); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Reflection; | ||
|
|
||
| namespace Cake.Core.Scripting.CodeGen | ||
| { | ||
| /// <summary> | ||
| /// Provides support for cleaning parameter names consisting of reserved keywords | ||
| /// </summary> | ||
| internal sealed class ParameterFormatter | ||
| { | ||
| private readonly HashSet<string> _keywords; | ||
|
|
||
| internal ParameterFormatter() | ||
| { | ||
| // https://msdn.microsoft.com/en-us/library/x53a06bb.aspx | ||
| // reserved keywords are a no-go, contextual keywords were added in later versions | ||
| // and were designed to allow for legacy code that might utilize them as variables/parameters | ||
| // to work. i.e., where, yield, etc. | ||
| _keywords = new HashSet<string>(StringComparer.Ordinal) | ||
| { | ||
| "abstract", "as", "base", "bool", "break", "byte", "case", | ||
| "catch", "char", "checked", "class", "const", "continue", | ||
| "decimal", "default", "delegate", "do", "double", "else", "enum", | ||
| "event", "explicit", "extern", "false", "finally", "fixed", "float", | ||
| "for", "foreach", "goto", "if", "implicit", "in", "int", "interface", | ||
| "internal", "is", "lock", "long", "namespace", "new", "null", "object", | ||
| "operator", "out", "override", "params", "private", "protected", | ||
| "public", "readonly", "ref", "return", "sbyte", "sealed", "short", | ||
| "sizeof", "stackalloc", "static", "string", "struct", "switch", | ||
| "this", "throw", "true", "try", "typeof", "uint", "ulong", "unchecked", | ||
| "unsafe", "ushort", "using", "virtual", "void", "volatile", "while" | ||
| }; | ||
| } | ||
|
|
||
| internal string FormatName(ParameterInfo parameterInfo) | ||
| { | ||
| if (parameterInfo == null) | ||
| { | ||
| throw new ArgumentNullException(nameof(parameterInfo)); | ||
| } | ||
|
|
||
| return FormatName(parameterInfo.Name); | ||
| } | ||
|
|
||
| internal string FormatName(string parameterName) | ||
| { | ||
| if (string.IsNullOrWhiteSpace(parameterName)) | ||
| { | ||
| throw new ArgumentException("Parameter name cannot be null or whitespace", nameof(parameterName)); | ||
| } | ||
|
|
||
| return _keywords.Contains(parameterName) ? $"@{parameterName}" : parameterName; | ||
| } | ||
| } | ||
| } |