- add v3 test for Encoding

Author: PerthCharern

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

@@ -70,6 +70,12 @@
       <None Update="V3Tests\Samples\OpenApiDiscriminator\basicDiscriminator.yaml">
         <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       </None>
+      <None Update="V3Tests\Samples\OpenApiEncoding\advancedEncoding.yaml">
+        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      </None>
+      <None Update="V3Tests\Samples\OpenApiEncoding\basicEncoding.yaml">
+        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      </None>
     <None Update="V3Tests\Samples\OpenApiExample\advancedExample.yaml">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
@@ -120,7 +126,6 @@
   <ItemGroup>
     <Folder Include="V3Tests\Samples\OpenApiSecurityScheme\" />
     <Folder Include="V3Tests\Samples\OpenApiSchema\" />
-    <Folder Include="V3Tests\Samples\OpenApiEncoding\" />
   </ItemGroup>
 
 </Project>

test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiEncodingTests.cs

@@ -0,0 +1,86 @@
+// ------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation.  All rights reserved.
+//  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// ------------------------------------------------------------
+
+using System.IO;
+using System.Linq;
+using FluentAssertions;
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Readers.V3;
+using SharpYaml.Serialization;
+using Xunit;
+
+namespace Microsoft.OpenApi.Readers.Tests.V3Tests
+{
+    [Collection("DefaultSettings")]
+    public class OpenApiEncodingTests
+    {
+        private const string SampleFolderPath = "V3Tests/Samples/OpenApiEncoding";
+
+        [Fact]
+        public void ParseBasicEncodingShouldSucceed()
+        {
+            using (var stream = File.OpenRead(Path.Combine(SampleFolderPath, "basicEncoding.yaml")))
+            {
+                var yamlStream = new YamlStream();
+                yamlStream.Load(new StreamReader(stream));
+                var yamlNode = yamlStream.Documents.First().RootNode;
+
+                var context = new ParsingContext();
+                var diagnostic = new OpenApiDiagnostic();
+
+                var node = new MapNode(context, diagnostic, (YamlMappingNode)yamlNode);
+
+                // Act
+                var encoding = OpenApiV3Deserializer.LoadEncoding(node);
+
+                // Assert
+                encoding.ShouldBeEquivalentTo(
+                    new OpenApiEncoding
+                    {
+                        ContentType = "application/xml; charset=utf-8"
+                    });
+            }
+        }
+
+        [Fact]
+        public void ParseAdvancedEncodingShouldSucceed()
+        {
+            using (var stream = File.OpenRead(Path.Combine(SampleFolderPath, "advancedEncoding.yaml")))
+            {
+                var yamlStream = new YamlStream();
+                yamlStream.Load(new StreamReader(stream));
+                var yamlNode = yamlStream.Documents.First().RootNode;
+
+                var context = new ParsingContext();
+                var diagnostic = new OpenApiDiagnostic();
+
+                var node = new MapNode(context, diagnostic, (YamlMappingNode)yamlNode);
+
+                // Act
+                var encoding = OpenApiV3Deserializer.LoadEncoding(node);
+
+                // Assert
+                encoding.ShouldBeEquivalentTo(
+                    new OpenApiEncoding
+                    {
+                        ContentType = "image/png, image/jpeg",
+                        Headers =
+                        {
+                            ["X-Rate-Limit-Limit"] =
+                            new OpenApiHeader
+                            {
+                                Description = "The number of allowed requests in the current period",
+                                Schema = new OpenApiSchema
+                                {
+                                    Type = "integer"
+                                }
+                            }
+                        }
+                    });
+            }
+        }
+    }
+}

test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiEncoding/advancedEncoding.yaml

@@ -0,0 +1,8 @@
+# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#encodingObject
+# only accept png/jpeg
+contentType: image/png, image/jpeg
+headers:
+    X-Rate-Limit-Limit:
+        description: The number of allowed requests in the current period
+        schema:
+            type: integer

test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiEncoding/basicEncoding.yaml

@@ -0,0 +1,3 @@
+# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#encodingObject
+# require XML Content-Type in utf-8 encoding
+contentType: application/xml; charset=utf-8