Add schema tests

Validate the snapshots against the OpenAPI JSON schemas.

Author: martincostello

Directory.Packages.props

@@ -23,6 +23,7 @@
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
     <PackageVersion Include="MSBuild.ProjectCreation" Version="17.0.1" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
+    <PackageVersion Include="NJsonSchema" Version="11.5.2" />
     <PackageVersion Include="NSubstitute" Version="5.3.0" />
     <PackageVersion Include="NSwag.CodeGeneration.CSharp" Version="14.6.3" />
     <PackageVersion Include="NSwag.MSBuild" Version="14.6.3" />

test/Swashbuckle.AspNetCore.IntegrationTests/CodeGenerationTests.cs

@@ -1,7 +1,6 @@
 #if NET10_0_OR_GREATER
 
 using System.Reflection;
-using System.Text.Json;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Kiota.Abstractions.Authentication;
 using Microsoft.Kiota.Http.HttpClientLibrary;
@@ -20,28 +19,17 @@ public static TheoryData<ClientGeneratorTool, string> SnapshotTestCases()
     {
         var testCases = new TheoryData<ClientGeneratorTool, string>();
 
-        foreach (var path in Directory.EnumerateFiles(Path.Combine(GetProjectRoot(), "snapshots"), "*.txt", SearchOption.AllDirectories))
+        foreach (var testCase in SnapshotTestData.Snapshots())
         {
+            var path = testCase.Data.Item1;
+            var documentVersion = testCase.Data.Item2;
+
             // Deduplicate by ignoring snapshots for other TFMs
             if (!path.EndsWith(".DotNet10_0.verified.txt", StringComparison.Ordinal))
             {
                 continue;
             }
 
-            using var snapshot = File.OpenRead(path);
-            using var document = JsonDocument.Parse(snapshot);
-
-            if (!document.RootElement.TryGetProperty("openapi", out var property) &&
-                !document.RootElement.TryGetProperty("swagger", out property))
-            {
-                continue;
-            }
-
-            if (!Version.TryParse(property.GetString(), out var documentVersion))
-            {
-                continue;
-            }
-
             var version = documentVersion switch
             {
                 { Major: 2 } => OpenApiSpecVersion.OpenApi2_0,
@@ -70,11 +58,13 @@ public static TheoryData<ClientGeneratorTool, string> SnapshotTestCases()
 
     [Theory]
     [MemberData(nameof(SnapshotTestCases))]
-    public async Task OpenApiDocument_Generates_Valid_Client_Code_From_Snapshot(ClientGeneratorTool tool, string path)
+    public async Task OpenApiDocument_Generates_Valid_Client_Code_From_Snapshot(ClientGeneratorTool tool, string snapshot)
     {
         // Arrange
         var generator = new ClientGenerator(outputHelper);
-        var document = await File.ReadAllTextAsync(path, TestContext.Current.CancellationToken);
+        var snapshotPath = Path.Combine(SnapshotTestData.SnapshotsPath(), snapshot);
+
+        var document = await File.ReadAllTextAsync(snapshotPath, TestContext.Current.CancellationToken);
 
         using var project = await generator.GenerateFromStringAsync(tool, document);
 

test/Swashbuckle.AspNetCore.IntegrationTests/SchemaTests.cs

@@ -0,0 +1,27 @@
+using NJsonSchema;
+
+namespace Swashbuckle.AspNetCore.IntegrationTests;
+
+public class SchemaTests
+{
+    [Theory]
+    [MemberData(nameof(SnapshotTestData.Snapshots), MemberType = typeof(SnapshotTestData))]
+    public async Task OpenApiDocumentsAreValid(string snapshot, Version version)
+    {
+        // Arrange
+        var cancellationToken = TestContext.Current.CancellationToken;
+
+        var schemaPath = Path.Combine(SnapshotTestData.SchemasPath(), $"schema.{version.Major}.{version.Minor}.json");
+        var snapshotPath = Path.Combine(SnapshotTestData.SnapshotsPath(), snapshot);
+
+        var schema = await JsonSchema.FromFileAsync(schemaPath, cancellationToken);
+        var specification = await File.ReadAllTextAsync(snapshotPath, cancellationToken);
+
+        // Act
+        var actual = schema.Validate(specification);
+
+        // Assert
+        Assert.NotNull(actual);
+        Assert.Empty(actual);
+    }
+}

test/Swashbuckle.AspNetCore.IntegrationTests/SnapshotTestData.cs

@@ -0,0 +1,46 @@
+using System.Reflection;
+using System.Text.Json;
+
+namespace Swashbuckle.AspNetCore.IntegrationTests;
+
+public static class SnapshotTestData
+{
+    private static string _projectRoot =
+        typeof(SnapshotTestData).Assembly
+            .GetCustomAttributes<AssemblyMetadataAttribute>()
+            .First((p) => p.Key is "ProjectRoot")
+            .Value!;
+
+    public static string SnapshotsPath() => Path.Combine(_projectRoot, "snapshots");
+
+    public static string SchemasPath() => Path.Combine(_projectRoot, "schemas");
+
+    public static TheoryData<string, Version> Snapshots()
+    {
+        var testCases = new TheoryData<string, Version>();
+        var snapshotsPath = Path.Combine(_projectRoot, "snapshots");
+
+        foreach (var path in Directory.EnumerateFiles(snapshotsPath, "*.txt", SearchOption.AllDirectories))
+        {
+            using var snapshot = File.OpenRead(path);
+            using var document = JsonDocument.Parse(snapshot);
+
+            if (!document.RootElement.TryGetProperty("openapi", out var property) &&
+                !document.RootElement.TryGetProperty("swagger", out property))
+            {
+                continue;
+            }
+
+            if (!Version.TryParse(property.GetString(), out var version))
+            {
+                continue;
+            }
+
+            var relativePath = Path.GetRelativePath(snapshotsPath, path);
+
+            testCases.Add(relativePath, version);
+        }
+
+        return testCases;
+    }
+}

test/Swashbuckle.AspNetCore.IntegrationTests/Swashbuckle.AspNetCore.IntegrationTests.csproj

@@ -21,6 +21,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="Microsoft.OpenApi.YamlReader" />
     <PackageReference Include="Microsoft.Playwright" />
+    <PackageReference Include="NJsonSchema" />
     <PackageReference Include="Verify.XunitV3" />
     <PackageReference Include="xunit.runner.visualstudio" />
     <PackageReference Include="xunit.v3.mtp-off" />