Add more validation tests

Author: C0nquistadore

src/Dibix.Sdk.CodeGeneration/Parser/SqlStoredProcedureVisitor.cs

@@ -198,16 +198,14 @@ private void ValidateJsonFileResult(SqlStatementDefinition definition)
             if (definition.GenerateResultClass)
                 return;
 
-            SourceLocation location = definition.ResultType.Location;
             if (definition.ResultType is SchemaTypeReference schemaTypeReference)
             {
                 SchemaDefinition schemaDefinition = SchemaRegistry.GetSchema(schemaTypeReference);
-                location = schemaDefinition.Location;
                 if (schemaDefinition is ObjectSchema { IsJsonFileResult: not null })
                     return;
             }
 
-            Logger.LogError("When using the @FileResult Json option, the output contract should have the '$isJsonFileResult' property set to true", location);
+            Logger.LogError("When using the @FileResult Json option, the output contract should have the '$isJsonFileResult' property set to true", definition.ResultType.Location);
         }
         #endregion
 

tests/Dibix.Sdk.Tests.Database/Contracts/JsonFileResultContractError.json

@@ -0,0 +1,7 @@
+{
+  "JsonFileResultContractError": {
+    "X": "uuid?",
+    "FileName": "string",
+    "Directions": "Direction*"
+  }
+}

tests/Dibix.Sdk.Tests.Database/Contracts/Request.json

@@ -1,6 +1,8 @@
 {
   "Request": {
+    "$isJsonFileResult": true,
     "Id": "Entry",
-    "Ids": "Entry*"
+    "Ids": "Entry*",
+    "UnusedProperty": "string"
   }
 }

tests/Dibix.Sdk.Tests.Database/Contracts/UnusedContract.json

@@ -0,0 +1,5 @@
+{
+  "UnusedContract": {
+    "UnusedProperty": "string"
+  }
+}

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

@@ -163,6 +163,7 @@
     <Build Include="CodeAnalysis\dbx_codeanalysis_error_043.sql" />
     <Build Include="Tests\Syntax\dbx_tests_syntax_fileresultjson_gridresult_merge.sql" />
     <Build Include="Tests\Syntax\dbx_tests_syntax_fileresultjson_gridresult.sql" />
+    <Build Include="Tests\Syntax\dbx_tests_syntax_fileresultjson_gridresult_merge_error.sql" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="CodeAnalysis" />
@@ -203,6 +204,8 @@
     <None Include="Contracts\NestedEnumerableContainer.json" />
     <None Include="Contracts\NestedEnumerableSubItem.json" />
     <None Include="Contracts\JsonFileResultContract.json" />
+    <None Include="Contracts\UnusedContract.json" />
+    <None Include="Contracts\JsonFileResultContractError.json" />
   </ItemGroup>
   <Import Condition="'$(NetCoreBuild)' == 'true'" Project="$(NETCoreTargetsPath)\Microsoft.Data.Tools.Schema.SqlTasks.targets" />
   <ItemGroup>

tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpointWithErrors.json

@@ -107,7 +107,6 @@
     {
       "method": "GET",
       "target": "EmptyWithParamsAndComplexUdt",
-      "operationId": "GetEmptyWithParamsAndComplexUdtAndAmbiguousRoute",
       "childRoute": "ambiguous/route/{a}/{c}/{password}",
       "params": {
         "b": "QUERY.b",

tests/Dibix.Sdk.Tests.Database/Tests/Syntax/dbx_tests_syntax_fileresultjson_gridresult_merge_error.sql

@@ -0,0 +1,12 @@
+-- @Name FileResultJsonMergeGridResultError
+-- @Return ClrTypes:JsonFileResultContractError Mode:SingleOrDefault
+-- @Return ClrTypes:Direction Name:Directions
+-- @MergeGridResult
+-- @FileResult Json
+CREATE PROCEDURE [dbo].[dbx_tests_syntax_fileresultjson_gridresult_merge_error]
+AS
+BEGIN
+	SELECT [x] = N'527B8008-AE6E-421F-91B2-5A0583070BCD', [filename] = N'the_file_result.json'
+
+	SELECT 1
+END

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

@@ -554,6 +554,7 @@ public void Endpoint_WithValidationErrors_Error()
                   , @"Tests\Syntax\dbx_tests_syntax_empty_params.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_empty_params_udt.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_fileresult.sql"
+                  , @"Tests\Syntax\dbx_tests_syntax_fileresultjson_gridresult_merge_error.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_singleconcreteresult.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_singleconcreteresult_missingcolumn.sql"
                 }
@@ -563,7 +564,9 @@ public void Endpoint_WithValidationErrors_Error()
                   , @"Contracts\GenericContract.json"
                   , @"Contracts\InputContract.json"
                   , @"Contracts\Entry.json"
+                  , @"Contracts\JsonFileResultContractError.json"
                   , @"Contracts\Request.json"
+                  , @"Contracts\UnusedContract.json"
                 }
               , endpoints: new[] { @"Endpoints\GenericEndpointWithErrors.json" }
               , isEmbedded: false

tests/Dibix.Sdk.Tests/Resources/CodeGeneration/Endpoint_WithValidationErrors_Error.txt

@@ -1,4 +1,5 @@
 One or more errors occured during code generation:
+Tests\Syntax\dbx_tests_syntax_fileresultjson_gridresult_merge_error.sql(2,21,2,21):error:When using the @FileResult Json option, the output contract should have the '$isJsonFileResult' property set to true
 Tests\Syntax\dbx_tests_syntax_singleconcreteresult_missingcolumn.sql(4,12,4,12):error:Property 'ImageUrl' on type 'Dibix.Sdk.Tests.DomainModel.GenericContract' not mapped
 Endpoints\GenericEndpointWithErrors.json(9,15,9,15):error:Unknown property source 'WTF'
 Endpoints\GenericEndpointWithErrors.json(6,18,6,18):error:Location of parameter 'password' cannot be inferred. Please declare the source of the parameter.
@@ -19,6 +20,10 @@ Endpoints\GenericEndpointWithErrors.json(109,18,109,18):error:Location of parame
 Endpoints\GenericEndpointWithErrors.json(10,19,10,19):error:Source 'ENV' does not support property 'MachinePassword'
 Endpoints\GenericEndpointWithErrors.json(11,21,11,21):error:Source 'CLAIM' does not support property 'None'
 Endpoints\GenericEndpointWithErrors.json(16,21,16,21):error:The parameter 'wtf' is a path parameter, therefore cannot be read using the 'QUERY' source
+Contracts\Request.json(3,6,3,6):error:Contract 'Dibix.Sdk.Tests.DomainModel.Request' has '$isJsonFileResult' set to true, but the contract is not used within a statement marked with the '@FileResult Json' option
+Contracts\Request.json(3,6,3,6):error:Contract 'Dibix.Sdk.Tests.DomainModel.Request' has '$isJsonFileResult' set to true, and therefore should implement a property 'FileName' of type 'string'
+Contracts\Request.json(6,6,6,6):error:Unused contract definition property: Dibix.Sdk.Tests.DomainModel.Request.UnusedProperty
+Contracts\UnusedContract.json(2,4,2,4):error:Unused contract definition: Dibix.Sdk.Tests.DomainModel.UnusedContract
 Endpoints\GenericEndpointWithErrors.json(6,18,6,18):error:Deep object query parameters are not supported: ids
 Endpoints\GenericEndpointWithErrors.json(6,18,6,18):error:Deep object query parameters are not supported: primitive
 Endpoints\GenericEndpointWithErrors.json(6,18,6,18):error:Deep object query parameters are not supported: nested
@@ -29,9 +34,11 @@ Endpoints\GenericEndpointWithErrors.json(58,27,58,27):error:The path segment 'ge
 Endpoints\GenericEndpointWithErrors.json(109,18,109,18):error:Deep object query parameters are not supported: ids
 Endpoints\GenericEndpointWithErrors.json(109,18,109,18):error:Deep object query parameters are not supported: nested
 Endpoints\GenericEndpointWithErrors.json(109,18,109,18):error:Deep object query parameters are not supported: primitivenested
-Endpoints\GenericEndpointWithErrors.json(122,18,122,18):error:Required nullable query parameters are not supported: 'c'. Either make the parameter optional by providing a default value, add it to the path/body or make it non-nullable.
-Endpoints\GenericEndpointWithErrors.json(152,8,152,8):error:HTTP method DELETE should not specify a body. For an endpoint, that is used to delete a resource, its business key should be part of the URL as path segments using the 'childRoute' property.
+Endpoints\GenericEndpointWithErrors.json(121,18,121,18):error:Required nullable query parameters are not supported: 'c'. Either make the parameter optional by providing a default value, add it to the path/body or make it non-nullable.
+Endpoints\GenericEndpointWithErrors.json(151,8,151,8):error:HTTP method DELETE should not specify a body. For an endpoint, that is used to delete a resource, its business key should be part of the URL as path segments using the 'childRoute' property.
 Endpoints\GenericEndpointWithErrors.json(86,5,86,5):error:Equivalent path defined: GET Tests/GenericEndpoint/ambiguous/route/{a}/{c}/{password}
 Endpoints\GenericEndpointWithErrors.json(96,5,96,5):error:Equivalent path defined: POST Tests/GenericEndpoint/ambiguous/route/{b}/{c}/{password}
 Endpoints\GenericEndpointWithErrors.json(86,5,86,5):error:Duplicate method defined within path: GET Tests/GenericEndpoint/ambiguous/route/{a}/{c}/{password}
-Endpoints\GenericEndpointWithErrors.json(107,5,107,5):error:Duplicate method defined within path: GET Tests/GenericEndpoint/ambiguous/route/{a}/{c}/{password}
+Endpoints\GenericEndpointWithErrors.json(107,5,107,5):error:Duplicate method defined within path: GET Tests/GenericEndpoint/ambiguous/route/{a}/{c}/{password}
+Endpoints\GenericEndpointWithErrors.json(6,18,6,18):error:Ambiguous action name 'EmptyWithParamsAndComplexUdt'. Please use the 'operationId' property to define a unique name when reusing accessor targets.
+Endpoints\GenericEndpointWithErrors.json(109,18,109,18):error:Ambiguous action name 'EmptyWithParamsAndComplexUdt'. Please use the 'operationId' property to define a unique name when reusing accessor targets.