Added validation that HTTP verbs should not be present in endpoint action path

Author: C0nquistadore

src/Dibix.Sdk/CodeGeneration/Model/ActionDefinition.cs

@@ -10,7 +10,7 @@ public sealed class ActionDefinition
         public ActionMethod Method { get; set; }
         public string OperationId { get; set; }
         public string Description { get; set; }
-        public string ChildRoute { get; set; }
+        public Token<string> ChildRoute { get; set; }
         public ActionRequestBody RequestBody { get; set; }
         public ActionFileResponse FileResponse { get; private set; }
         public IList<ActionParameter> Parameters { get; }

src/Dibix.Sdk/CodeGeneration/Model/ControllerDefinitionProvider.cs

@@ -147,7 +147,7 @@ private void ReadControllerAction(string filePath, ControllerDefinition controll
             actionDefinition.Method = method;
             actionDefinition.OperationId = (string)action.Property("operationId")?.Value ?? actionDefinition.Target.OperationName;
             actionDefinition.Description = (string)action.Property("description")?.Value;
-            actionDefinition.ChildRoute = childRoute;
+            actionDefinition.ChildRoute = childRouteProperty.ToToken(childRoute, filePath);
             actionDefinition.RequestBody = requestBody;
 
             if (TryReadFileResponse(action, out ActionFileResponse fileResponse, out IJsonLineInfo fileResponseLocation))
@@ -170,7 +170,7 @@ private void ReadControllerAction(string filePath, ControllerDefinition controll
               .Append(' ')
               .Append(controller.Name);
 
-            if (!String.IsNullOrEmpty(actionDefinition.ChildRoute))
+            if (actionDefinition.ChildRoute != null)
                 sb.Append('/').Append(actionDefinition.ChildRoute);
 
             IJsonLineInfo lineInfo = action;

src/Dibix.Sdk/CodeGeneration/Model/Token.cs

@@ -0,0 +1,22 @@
+namespace Dibix.Sdk.CodeGeneration
+{
+    public sealed class Token<T>
+    {
+        public T Value { get; }
+        public string Source { get; }
+        public int Line { get; }
+        public int Column { get; }
+
+        public Token(T value, string source, int line, int column)
+        {
+            this.Value = value;
+            this.Source = source;
+            this.Line = line;
+            this.Column = column;
+        }
+
+        public static implicit operator T(Token<T> token) => token != null ? token.Value : default;
+
+        public override string ToString() => $"{this.Value} at ({this.Line}, {this.Column})";
+    }
+}

src/Dibix.Sdk/CodeGeneration/Model/TokenExtensions.cs

@@ -0,0 +1,18 @@
+using Dibix.Sdk.Json;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace Dibix.Sdk.CodeGeneration
+{
+    internal static class TokenExtensions
+    {
+        public static Token<T> ToToken<T>(this JToken json, T value, string source)
+        {
+            if (json == null)
+                return null;
+
+            IJsonLineInfo lineInfo = json.GetLineInfo();
+            return new Token<T>(value, source, lineInfo.LineNumber, lineInfo.LinePosition);
+        }
+    }
+}

src/Dibix.Sdk/CodeGeneration/Output/ApiDescriptionWriter.cs

@@ -96,8 +96,8 @@ private string WriteBody(CodeGenerationContext context, IList<ControllerDefiniti
                     if (!String.IsNullOrEmpty(action.Description))
                         writer.WriteLine($"y.Description = \"{action.Description}\";");
 
-                    if (!String.IsNullOrEmpty(action.ChildRoute))
-                        writer.WriteLine($"y.ChildRoute = \"{action.ChildRoute}\";");
+                    if (action.ChildRoute != null)
+                        writer.WriteLine($"y.ChildRoute = \"{action.ChildRoute.Value}\";");
 
                     // TODO: Involves a breaking change
                     //if (action.RequestBody != null)

src/Dibix.Sdk/CodeGeneration/Output/CodeGenerationTask.cs

@@ -144,8 +144,9 @@ string projectName
 
             ICodeGenerationModelValidator modelValidator = new CompositeCodeGenerationModelValidator
             (
-                new ContractArtifactModelValidator(logger)
-              , new ActionParameterPropertySourceModelValidator(actionParameterSourceRegistry, schemaRegistry, logger)
+                new ActionParameterPropertySourceModelValidator(actionParameterSourceRegistry, schemaRegistry, logger)
+              , new ContractArtifactModelValidator(logger)
+              , new EndpointModelValidator(logger)
               , new UserDefinedTypeParameterModelValidator(schemaRegistry, logger)
             );
 

src/Dibix.Sdk/CodeGeneration/Validation/EndpointModelValidator.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Collections.Generic;
+
+namespace Dibix.Sdk.CodeGeneration
+{
+    internal sealed class EndpointModelValidator : ICodeGenerationModelValidator
+    {
+        private static readonly ICollection<string> HttpMethods = new HashSet<string>(Enum.GetNames(typeof(ActionMethod)), StringComparer.OrdinalIgnoreCase);
+        private readonly ILogger _logger;
+
+        public EndpointModelValidator(ILogger logger)
+        {
+            this._logger = logger;
+        }
+
+        public bool Validate(CodeGenerationModel model)
+        {
+            bool isValid = true;
+
+            foreach (ControllerDefinition controller in model.Controllers)
+            {
+                foreach (ActionDefinition action in controller.Actions)
+                {
+                    if (!this.ValidateAction(action))
+                        isValid = false;
+                }
+            }
+
+            return isValid;
+        }
+
+        private bool ValidateAction(ActionDefinition action)
+        {
+            if (action.ChildRoute == null)
+                return true;
+
+            bool result = true;
+
+            string[] segments = action.ChildRoute.Value.Split('/');
+
+            int columnOffset = 0;
+            foreach (string segment in segments)
+            {
+                if (HttpMethods.Contains(segment))
+                {
+                    this._logger.LogError($"The path segment '{segment}' is a known HTTP verb, which should be indicated by the action method and is therefore redundant: {action.ChildRoute.Value}", action.ChildRoute.Source, action.ChildRoute.Line, columnOffset);
+                    result = false;
+                }
+                columnOffset += segment.Length + 1; // Skip segment and slash
+            }
+
+            return result;
+        }
+    }
+}

tests/Dibix.Sdk.Tests.Database/Dibix.Sdk.Tests.Database.sqlproj

@@ -170,7 +170,7 @@
     <None Include="Endpoints\GenericEndpoint.json" />
     <None Include="Contracts\InputContract.json" />
     <None Include="Endpoints\GenericEndpointWithOutputParam.json" />
-    <None Include="Endpoints\GenericEndpointWithInvalidSource.json" />
+    <None Include="Endpoints\GenericEndpointWithErrors.json" />
     <None Include="Contracts\Request.json" />
     <None Include="Contracts\Entry.json" />
     <None Include="Contracts\AnotherInputContract.json" />

…ts/GenericEndpointWithInvalidSource.json …Endpoints/GenericEndpointWithErrors.jsontests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpointWithInvalidSource.json renamed to tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpointWithErrors.json tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpointWithInvalidSource.json renamed to tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpointWithErrors.json

@@ -13,6 +13,7 @@
       "method": "POST",
       "target": "EmptyWithParams",
       "body": "Request",
+      "childRoute": "this/get/is/wrong",
       "params": {
         "v": "BODY.X",
         "w": "BODY.Id.Nm",

tests/Dibix.Sdk.Tests/CodeGeneration/CodeGenerationTaskTests.cs

@@ -533,14 +533,15 @@ public void Endpoint_WithInvalidPropertySource_Error()
                   , @"Contracts\Entry.json"
                   , @"Contracts\Request.json"
                 }
-              , endpoints: new [] { @"Endpoints\GenericEndpointWithInvalidSource.json" }
+              , endpoints: new [] { @"Endpoints\GenericEndpointWithErrors.json" }
               , isEmbedded: false
               , expectedException: @"One or more errors occured during code generation:
-Endpoints\GenericEndpointWithInvalidSource.json(8,15,8,15):error:Unknown property source 'WTF'
-Endpoints\GenericEndpointWithInvalidSource.json(9,19,9,19):error:Source 'ENV' does not support property 'MachinePassword'
-Endpoints\GenericEndpointWithInvalidSource.json(17,20,17,20):error:Property 'X' not found on contract 'Dibix.Sdk.Tests.DomainModel.Request'
-Endpoints\GenericEndpointWithInvalidSource.json(18,23,18,23):error:Property 'Nm' not found on contract 'Dibix.Sdk.Tests.DomainModel.Entry'
-Endpoints\GenericEndpointWithInvalidSource.json(23,27,23,27):error:Property 'Nm' not found on contract 'Dibix.Sdk.Tests.DomainModel.Entry'"
+Endpoints\GenericEndpointWithErrors.json(8,15,8,15):error:Unknown property source 'WTF'
+Endpoints\GenericEndpointWithErrors.json(9,19,9,19):error:Source 'ENV' does not support property 'MachinePassword'
+Endpoints\GenericEndpointWithErrors.json(18,20,18,20):error:Property 'X' not found on contract 'Dibix.Sdk.Tests.DomainModel.Request'
+Endpoints\GenericEndpointWithErrors.json(19,23,19,23):error:Property 'Nm' not found on contract 'Dibix.Sdk.Tests.DomainModel.Entry'
+Endpoints\GenericEndpointWithErrors.json(24,27,24,27):error:Property 'Nm' not found on contract 'Dibix.Sdk.Tests.DomainModel.Entry'
+Endpoints\GenericEndpointWithErrors.json(16,5,16,5):error:The path segment 'get' is a known HTTP verb, which should be indicated by the action method and is therefore redundant: this/get/is/wrong"
             );
         }
 
@@ -573,4 +574,4 @@ public void InvalidContractSchema_Error()
             );
         }
     }
-}
+}