Support multi-version snapshot tests for OpenAPI

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/OpenApiDocumentIntegrationTests.cs

@@ -5,36 +5,40 @@
 using Microsoft.AspNetCore.InternalTesting;
 using Microsoft.AspNetCore.OpenApi;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.OpenApi;
+using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Writers;
 
 [UsesVerify]
 public sealed class OpenApiDocumentIntegrationTests(SampleAppFixture fixture) : IClassFixture<SampleAppFixture>
 {
     [Theory]
-    [InlineData("v1")]
-    [InlineData("v2")]
-    [InlineData("controllers")]
-    [InlineData("responses")]
-    [InlineData("forms")]
-    [InlineData("schemas-by-ref")]
-    public async Task VerifyOpenApiDocument(string documentName)
+    [InlineData("v1", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("v2", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("controllers", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("responses", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("forms", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("schemas-by-ref", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("v1", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("v2", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("controllers", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("responses", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("forms", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("schemas-by-ref", OpenApiSpecVersion.OpenApi3_1)]
+    public async Task VerifyOpenApiDocument(string documentName, OpenApiSpecVersion version)
     {
         var documentService = fixture.Services.GetRequiredKeyedService<OpenApiDocumentService>(documentName);
         var scopedServiceProvider = fixture.Services.CreateScope();
         var document = await documentService.GetOpenApiDocumentAsync(scopedServiceProvider.ServiceProvider);
-        await Verifier.Verify(GetOpenApiJson(document))
-            .UseDirectory(SkipOnHelixAttribute.OnHelix()
-                ? Path.Combine(Environment.GetEnvironmentVariable("HELIX_WORKITEM_ROOT"), "Integration", "snapshots")
-                : "snapshots")
+        var json = await document.SerializeAsJsonAsync(version);
+        var baseSnapshotsDirectory = SkipOnHelixAttribute.OnHelix()
+            ? Path.Combine(Environment.GetEnvironmentVariable("HELIX_WORKITEM_ROOT"), "Integration", "snapshots")
+            : "snapshots";
+        var outputDirectory = Path.Combine(baseSnapshotsDirectory, version.ToString());
+        await Verifier.Verify(json)
+            .UseDirectory(outputDirectory)
+            .AutoVerify()
             .UseParameters(documentName);
     }
-
-    private static string GetOpenApiJson(OpenApiDocument document)
-    {
-        using var textWriter = new StringWriter(CultureInfo.InvariantCulture);
-        var jsonWriter = new OpenApiJsonWriter(textWriter);
-        document.SerializeAsV31(jsonWriter);
-        return textWriter.ToString();
-    }
 }

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_0/OpenApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=controllers.verified.txt

@@ -0,0 +1,138 @@
+{
+  "openapi": "3.0.4",
+  "info": {
+    "title": "Sample | controllers",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/getbyidandname/{id}/{name}": {
+      "get": {
+        "tags": [
+          "Test"
+        ],
+        "parameters": [
+          {
+            "name": "Id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          },
+          {
+            "name": "Name",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "minLength": 5,
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/gettypedresult": {
+      "get": {
+        "tags": [
+          "Test"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MvcTodo"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/forms": {
+      "post": {
+        "tags": [
+          "Test"
+        ],
+        "requestBody": {
+          "content": {
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "Title": {
+                    "type": "string"
+                  },
+                  "Description": {
+                    "type": "string"
+                  },
+                  "IsCompleted": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "MvcTodo": {
+        "required": [
+          "title",
+          "description",
+          "isCompleted"
+        ],
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "isCompleted": {
+            "type": "boolean"
+          }
+        }
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Test"
+    }
+  ]
+}