ASP004 check syntax of route parameters. #22

Stub implementation & happy path tests.

Author: JohanLarsson

AspNetCoreAnalyzers.Tests/ASP004ParameterSyntaxTests/ValidCode.cs

@@ -0,0 +1,58 @@
+namespace AspNetCoreAnalyzers.Tests.ASP004ParameterSyntaxTests
+{
+    using Gu.Roslyn.Asserts;
+    using Microsoft.CodeAnalysis.Diagnostics;
+    using NUnit.Framework;
+
+    public class ValidCode
+    {
+        private static readonly DiagnosticAnalyzer Analyzer = new AttributeAnalyzer();
+
+        [TestCase("{value:bool}",                                              "bool")]
+        [TestCase("{value:datetime}",                                          "System.DateTime")]
+        [TestCase("{value:decimal}",                                           "decimal")]
+        [TestCase("{value:double}",                                            "double")]
+        [TestCase("{value:float}",                                             "float")]
+        [TestCase("{value:int}",                                               "int")]
+        [TestCase("api/orders/{value:int:min(1)}",                                "int")]
+        [TestCase("api/orders/{value:int:max(1)}",                                "int")]
+        [TestCase("api/orders/{value:int:range(1,10)}",                           "int")]
+        [TestCase("api/orders/{value:int:required}",                              "int")]
+        [TestCase("{value:long}",                                              "long")]
+        [TestCase("api/orders/{value:min(1)}",                                    "long")]
+        [TestCase("api/orders/{value:max(1)}",                                    "long")]
+        [TestCase("api/orders/{value:range(1,10)}",                               "long")]
+        [TestCase("api/orders/{value:required}",                                  "long")]
+        [TestCase("{value:guid}",                                              "System.Guid")]
+        [TestCase("api/orders/{value:minlength(1)}",                              "string")]
+        [TestCase("api/orders/{value:maxlength(1)}",                              "string")]
+        [TestCase("api/orders/{value:length(1)}",                                 "string")]
+        [TestCase("api/orders/{value:length(1,3)}",                               "string")]
+        [TestCase("api/orders/{value:alpha}",                                     "string")]
+        [TestCase("api/orders/{value:regex(a-(0|1))}",                            "string")]
+        [TestCase("api/orders/{value:regex(^\\\\d{{3}}-\\\\d{{2}}-\\\\d{{4}}$)}", "string")]
+        [TestCase("api/orders/{value:required}",                                  "string")]
+        public void WithParameter(string parameter, string type)
+        {
+            var code = @"
+namespace ValidCode
+{
+    using System.Threading.Tasks;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.EntityFrameworkCore;
+
+    [ApiController]
+    public class OrdersController : Controller
+    {
+        [HttpGet(""api/{value}"")]
+        public async Task<int> GetOrder(int value)
+        {
+            return value;
+        }
+    }
+}".AssertReplace("int", type)
+  .AssertReplace("{value}", parameter);
+            AnalyzerAssert.Valid(Analyzer, code);
+        }
+    }
+}

AspNetCoreAnalyzers.sln

@@ -32,6 +32,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".docs", ".docs", "{1C271AF2
 		documentation\ASP001.md = documentation\ASP001.md
 		documentation\ASP002.md = documentation\ASP002.md
 		documentation\ASP003.md = documentation\ASP003.md
+		documentation\ASP004.md = documentation\ASP004.md
 		README.md = README.md
 		RELEASE_NOTES.md = RELEASE_NOTES.md
 	EndProjectSection

AspNetCoreAnalyzers/ASP004ParameterSyntax.cs

@@ -0,0 +1,19 @@
+namespace AspNetCoreAnalyzers
+{
+    using Microsoft.CodeAnalysis;
+
+    internal static class ASP004ParameterSyntax
+    {
+        public const string DiagnosticId = "ASP004";
+
+        internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(
+            id: DiagnosticId,
+            title: "Syntax error in parameter.",
+            messageFormat: "Syntax error in parameter.",
+            category: AnalyzerCategory.Routing,
+            defaultSeverity: DiagnosticSeverity.Warning,
+            isEnabledByDefault: true,
+            description: "Syntax error in parameter.",
+            helpLinkUri: HelpLink.ForId(DiagnosticId));
+    }
+}

AspNetCoreAnalyzers/Analyzers/AttributeAnalyzer.cs

@@ -16,7 +16,8 @@ public class AttributeAnalyzer : DiagnosticAnalyzer
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(
             ASP001ParameterName.Descriptor,
             ASP002MissingParameter.Descriptor,
-            ASP003ParameterType.Descriptor);
+            ASP003ParameterType.Descriptor,
+            ASP004ParameterSyntax.Descriptor);
 
         public override void Initialize(AnalysisContext context)
         {

AspNetCoreAnalyzers/CodeFixes/ParameterSyntaxFix.cs

@@ -0,0 +1,23 @@
+namespace AspNetCoreAnalyzers
+{
+    using System.Collections.Immutable;
+    using System.Threading.Tasks;
+    using Gu.Roslyn.CodeFixExtensions;
+
+    public class ParameterSyntaxFix : DocumentEditorCodeFixProvider
+    {
+        public override ImmutableArray<string> FixableDiagnosticIds { get; } = ImmutableArray.Create(
+            ASP004ParameterSyntax.DiagnosticId);
+
+        protected override async Task RegisterCodeFixesAsync(DocumentEditorCodeFixContext context)
+        {
+            var syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken)
+                                          .ConfigureAwait(false);
+
+            foreach (var diagnostic in context.Diagnostics)
+            {
+
+            }
+        }
+    }
+}

README.md

@@ -22,6 +22,10 @@ Roslyn analyzers for ASP.NET.Core.
     <td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP003.md">ASP003</a></td>
     <td>Parameter type does not match template.</td>
   </tr>
+  <tr>
+    <td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/tree/master/documentation/ASP004.md">ASP004</a></td>
+    <td>Syntax error in parameter.</td>
+  </tr>
 <table>
 <!-- end generated table -->
 

documentation/ASP004.md

@@ -0,0 +1,84 @@
+# ASP004
+## Syntax error in parameter.
+
+<!-- start generated table -->
+<table>
+  <tr>
+    <td>CheckId</td>
+    <td>ASP004</td>
+  </tr>
+  <tr>
+    <td>Severity</td>
+    <td>Warning</td>
+  </tr>
+  <tr>
+    <td>Enabled</td>
+    <td>true</td>
+  </tr>
+  <tr>
+    <td>Category</td>
+    <td>AspNetCoreAnalyzers.Routing</td>
+  </tr>
+  <tr>
+    <td>Code</td>
+    <td><a href="https://github.com/DotNetAnalyzers/AspNetCoreAnalyzers/blob/master/AspNetCoreAnalyzers/Analyzers/AttributeAnalyzer.cs">AttributeAnalyzer</a></td>
+  </tr>
+</table>
+<!-- end generated table -->
+
+## Description
+
+Syntax error in parameter.
+
+## Motivation
+
+```cs
+[HttpGet(""api/orders/id:int}"")]
+public IActionResult GetId(int id)
+{
+    return this.Ok(id);
+}
+```
+
+In the above code the opening curly brace for the parameter is missing.
+
+## How to fix violations
+
+Use the code fix of fix the syntax manually.
+The code in the example should be:
+
+```cs
+[HttpGet(""api/orders/{id:int}"")]
+public IActionResult GetId(int id)
+{
+    return this.Ok(id);
+}
+```
+
+<!-- start generated config severity -->
+## Configure severity
+
+### Via ruleset file.
+
+Configure the severity per project, for more info see [MSDN](https://msdn.microsoft.com/en-us/library/dd264949.aspx).
+
+### Via #pragma directive.
+```C#
+#pragma warning disable ASP004 // Syntax error in parameter.
+Code violating the rule here
+#pragma warning restore ASP004 // Syntax error in parameter.
+```
+
+Or put this at the top of the file to disable all instances.
+```C#
+#pragma warning disable ASP004 // Syntax error in parameter.
+```
+
+### Via attribute `[SuppressMessage]`.
+
+```C#
+[System.Diagnostics.CodeAnalysis.SuppressMessage("AspNetCoreAnalyzers.Routing", 
+    "ASP004:Syntax error in parameter.", 
+    Justification = "Reason...")]
+```
+<!-- end generated config severity -->