OpenAPI.NET/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiHeaderTests.cs at af85cc96e629d53615e98995d54e46b352116f85 · microsoft/OpenAPI.NET · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using FluentAssertions;
using Microsoft.OpenApi.Reader;
using Xunit;

namespace Microsoft.OpenApi.Readers.Tests.V3Tests
{
    [Collection("DefaultSettings")]
    public class OpenApiHeaderTests
    {
        private const string SampleFolderPath = "V3Tests/Samples/OpenApiHeader/";

        [Fact]
        public async Task ParseBasicHeaderShouldSucceed()
        {
            // Arrange
            using var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "basicHeader.yaml"));

            // Act
            var header = await OpenApiModelFactory.LoadAsync<OpenApiHeader>(stream, OpenApiSpecVersion.OpenApi3_0, new(), settings: SettingsFixture.ReaderSettings);

            // Assert
            Assert.Equivalent(
                new OpenApiHeader
                {
                    Description = "The number of allowed requests in the current period",
                    Schema = new OpenApiSchema()
                    {
                        Type = JsonSchemaType.Integer
                    }
                }, header);
        }

        [Fact]
        public async Task ParseHeaderWithContentShouldSucceed()
        {
            // Arrange
            using var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "headerWithContent.yaml"));

            // Act
            var header = await OpenApiModelFactory.LoadAsync<OpenApiHeader>(stream, OpenApiSpecVersion.OpenApi3_0, new(), settings: SettingsFixture.ReaderSettings);

            // Assert
            Assert.Equivalent(
                new OpenApiHeader
                {
                    Description = "A complex header with content",
                    Content = new Dictionary<string, OpenApiMediaType>()
                    {
                        ["application/json"] = new()
                        {
                           Schema = new OpenApiSchema()
                           {
                                Type = JsonSchemaType.Object,
                                Properties = new Dictionary<string, IOpenApiSchema>()
                                {
                                    ["timestamp"] = new OpenApiSchema()
                                    {
                                        Type = JsonSchemaType.String,
                                        Format = "date-time"
                                    },
                                    ["value"] = new OpenApiSchema()
                                    {
                                        Type = JsonSchemaType.Integer
                                    }
                                }
                           }
                        }
                    }
                }, header);
        }

        [Fact]
        public async Task ParseHeaderWithMultipleContentTypesShouldSucceed()
        {
            // Arrange
            using var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "headerWithMultipleContentTypes.yaml"));

            // Act
            var header = await OpenApiModelFactory.LoadAsync<OpenApiHeader>(stream, OpenApiSpecVersion.OpenApi3_0, new(), settings: SettingsFixture.ReaderSettings);

            // Assert
            Assert.Equivalent(
                new OpenApiHeader
                {
                    Description = "A header that accepts multiple content types",
                    Content = new Dictionary<string, OpenApiMediaType>()
                    {
                        ["application/json"] = new()
                        {
                           Schema = new OpenApiSchema()
                           {
                                Type = JsonSchemaType.Object,
                                Properties = new Dictionary<string, IOpenApiSchema>()
                                {
                                    ["data"] = new OpenApiSchema()
                                    {
                                        Type = JsonSchemaType.String
                                    }
                                }
                           }
                        },
                        ["text/plain"] = new()
                        {
                           Schema = new OpenApiSchema()
                           {
                                Type = JsonSchemaType.String
                           }
                        }
                    }
                }, header);
        }

        [Fact]
        public async Task ParseHeaderWithStyleAndContentShouldPreferContent()
        {
            // Arrange
            using var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "headerWithStyleAndContent.yaml"));

            // Act
            var header = await OpenApiModelFactory.LoadAsync<OpenApiHeader>(stream, OpenApiSpecVersion.OpenApi3_0, new(), settings: SettingsFixture.ReaderSettings);

            // Assert
            // Both content and style can be present, content takes precedence for serialization behavior
            Assert.NotNull(header.Content);
            Assert.Single(header.Content);
            Assert.True(header.Content.ContainsKey("application/json"));
            Assert.Equal(ParameterStyle.Simple, header.Style); // Style can still be present
        }
    }
}