Store swagger documents in SwaggerDocuments directory as a part of test execution

Author: maurei

test/OpenApiClientTests/OpenApiClientTests.csproj

@@ -28,18 +28,14 @@
   </ItemGroup>
 
   <ItemGroup>
-    <OpenApiReference Include="..\OpenApiTests\LegacyOpenApiIntegration\swagger.json">
+    <OpenApiReference Include="..\OpenApiTests\SwaggerDocuments\LegacyOpenApiIntegration.json">
       <Namespace>OpenApiClientTests.LegacyClient.GeneratedCode</Namespace>
       <ClassName>OpenApiClient</ClassName>
       <CodeGenerator>NSwagCSharp</CodeGenerator>
       <Options>/UseBaseUrl:false /GenerateClientInterfaces:true /ClientClassAccessModifier:internal</Options>
     </OpenApiReference>
   </ItemGroup>
 
-  <ItemGroup>
-    <EmbeddedResource Include="..\OpenApiTests\LegacyOpenApiIntegration\swagger.json" />
-  </ItemGroup>
-
   <!-- Fixes IntelliSense errors on openapi.json in Visual Studio 2019, which uses the schema for OpenAPI 3.1 by default. -->
   <ProjectExtensions>
     <VisualStudio>

test/OpenApiTests/LegacyOpenApiIntegration/LegacyOpenApiIntegrationTests.cs

@@ -24,7 +24,7 @@ public LegacyOpenApiIntegrationTests()
         public async Task Retrieved_document_matches_expected_document()
         {
             // Arrange
-            string embeddedResourceName = $"{nameof(OpenApiTests)}.{nameof(LegacyOpenApiIntegration)}.swagger.json";
+            string embeddedResourceName = $"{nameof(OpenApiTests)}.SwaggerDocuments.{nameof(LegacyOpenApiIntegration)}.json";
             string expectedDocument = await LoadEmbeddedResourceAsync(embeddedResourceName);
             const string requestUrl = "swagger/v1/swagger.json";
 

test/OpenApiTests/NamingConvention/KebabCase/KebabCaseTests.cs

@@ -1,4 +1,5 @@
 using System;
+using System.IO;
 using System.Net.Http;
 using System.Text.Json;
 using System.Threading;
@@ -22,8 +23,10 @@ public KebabCaseTests(IntegrationTestContext<KebabCaseNamingConventionStartup<Na
             _lazyOpenApiDocument ??= new Lazy<Task<JsonDocument>>(async () =>
             {
                 testContext.UseController<SupermarketsController>();
-                const string requestUrl = "swagger/v1/swagger.json";
-                string content = await GetAsync(requestUrl);
+
+                string content = await GetAsync("swagger/v1/swagger.json");
+
+                await WriteToSwaggerDocumentsFolderAsync(content);
 
                 return JsonDocument.Parse(content);
             }, LazyThreadSafetyMode.ExecutionAndPublication);
@@ -39,6 +42,18 @@ private async Task<string> GetAsync(string requestUrl)
             return await responseMessage.Content.ReadAsStringAsync();
         }
 
+        private static async Task WriteToSwaggerDocumentsFolderAsync(string content)
+        {
+            string path = GetSwaggerDocumentPath(nameof(KebabCase));
+            await File.WriteAllTextAsync(path, content);
+        }
+
+        private static string GetSwaggerDocumentPath(string fileName)
+        {
+            string swaggerDocumentsDirectory = Directory.GetParent(Environment.CurrentDirectory)!.Parent!.Parent!.FullName;
+            return Path.Join(swaggerDocumentsDirectory, "SwaggerDocuments", $"{fileName}.json");
+        }
+
         [Fact]
         public async Task Kebab_naming_policy_is_applied_to_get_collection_endpoint()
         {

test/OpenApiTests/OpenApiTests.csproj

@@ -4,26 +4,26 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <ProjectReference Include="..\..\src\JsonApiDotNetCore.OpenApi\JsonApiDotNetCore.OpenApi.csproj"/>
-        <ProjectReference Include="..\TestBuildingBlocks\TestBuildingBlocks.csproj"/>
+        <ProjectReference Include="..\..\src\JsonApiDotNetCore.OpenApi\JsonApiDotNetCore.OpenApi.csproj" />
+        <ProjectReference Include="..\TestBuildingBlocks\TestBuildingBlocks.csproj" />
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="coverlet.collector" Version="$(CoverletVersion)" PrivateAssets="All"/>
-        <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="$(AspNetCoreVersion)"/>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="$(TestSdkVersion)"/>
-        <PackageReference Include="BlushingPenguin.JsonPath" Version="$(BlushingPenguinVersion)"/>
-        <PackageReference Include="Microsoft.OpenApi.Readers" Version="1.2.3"/>
+        <PackageReference Include="coverlet.collector" Version="$(CoverletVersion)" PrivateAssets="All" />
+        <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="$(AspNetCoreVersion)" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="$(TestSdkVersion)" />
+        <PackageReference Include="BlushingPenguin.JsonPath" Version="$(BlushingPenguinVersion)" />
+        <PackageReference Include="Microsoft.OpenApi.Readers" Version="1.2.3" />
     </ItemGroup>
 
     <ItemGroup>
-        <EmbeddedResource Include="LegacyOpenApiIntegration\swagger.json"/>
+        <EmbeddedResource Include="SwaggerDocuments\LegacyOpenApiIntegration.json" />
     </ItemGroup>
-
+    
     <!-- Fixes IntelliSense errors on openapi.json in Visual Studio 2019, which uses the schema for OpenAPI 3.1 by default. -->
     <ProjectExtensions>
         <VisualStudio>
-            <UserProperties swagger_1json__JsonSchema="https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json"/>
+            <UserProperties swagger_1json__JsonSchema="https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json" />
         </VisualStudio>
     </ProjectExtensions>
 </Project>