OpenAPI.NET/test/Microsoft.OpenApi.Readers.Tests/TestCustomExtension.cs at 12f649959fe73d76c36a51f0126b41f14f4823fd · 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System.Text.Json.Nodes;
using Microsoft.OpenApi.Reader;
using Xunit;

namespace Microsoft.OpenApi.Readers.Tests
{
    public class TestCustomExtension
    {
        [Fact]
        public void ParseCustomExtension()
        {
            var description =
                """
                openapi: 3.0.0
                info:
                    title: A doc with an extension
                    version: 1.0.0
                    x-foo:
                        bar: hey
                        baz: hi!
                paths: {}
                """;
            var settings = new OpenApiReaderSettings
            {
                ExtensionParsers = { { "x-foo", (a,v) => {
                        var fooNode = (JsonObject)a;
                        return new FooExtension() {
                              Bar = (fooNode["bar"].ToString()),
                              Baz = (fooNode["baz"].ToString())
                        };
                } } }
            };
            settings.AddYamlReader();

            var diag = new OpenApiDiagnostic();
            var actual = OpenApiDocument.Parse(description, "yaml", settings: settings);

            var fooExtension = actual.Document.Info.Extensions["x-foo"] as FooExtension;

            Assert.NotNull(fooExtension);
            Assert.Equal("hey", fooExtension.Bar);
            Assert.Equal("hi!", fooExtension.Baz);
        }

        [Fact]
        public void ExtensionParserThrowingOpenApiException_V2_ShouldHaveCorrectPointer()
        {
            var json = @"{
  ""swagger"": ""2.0"",
  ""info"": {
    ""title"": ""Demo"",
    ""version"": ""1""
  },
  ""paths"": {},
  ""definitions"": {
    ""demo"": {
      ""x-tag"": null
    }
  }
}";
            var settings = new OpenApiReaderSettings
            {
                ExtensionParsers =
                {
                    { "x-tag", (any, version) => throw new OpenApiException("Testing") }
                }
            };

            var result = OpenApiDocument.Parse(json, "json", settings);

            Assert.NotNull(result.Diagnostic);
            Assert.NotEmpty(result.Diagnostic.Errors);
            var error = result.Diagnostic.Errors[0];
            Assert.Equal("Testing", error.Message);
            Assert.Equal("#/definitions/demo/x-tag", error.Pointer);
        }

        [Fact]
        public void ExtensionParserThrowingOpenApiException_V3_ShouldHaveCorrectPointer()
        {
            var json = @"{
  ""openapi"": ""3.0.0"",
  ""info"": {
    ""title"": ""Demo"",
    ""version"": ""1""
  },
  ""paths"": {},
  ""components"": {
    ""schemas"": {
      ""demo"": {
        ""x-tag"": null
      }
    }
  }
}";
            var settings = new OpenApiReaderSettings
            {
                ExtensionParsers =
                {
                    { "x-tag", (any, version) => throw new OpenApiException("Testing") }
                }
            };

            var result = OpenApiDocument.Parse(json, "json", settings);

            Assert.NotNull(result.Diagnostic);
            Assert.NotEmpty(result.Diagnostic.Errors);
            var error = result.Diagnostic.Errors[0];
            Assert.Equal("Testing", error.Message);
            Assert.Equal("#/components/schemas/demo/x-tag", error.Pointer);
        }

        [Fact]
        public void ExtensionParserThrowingOpenApiException_V31_ShouldHaveCorrectPointer()
        {
            var json = @"{
  ""openapi"": ""3.1.0"",
  ""info"": {
    ""title"": ""Demo"",
    ""version"": ""1""
  },
  ""components"": {
    ""schemas"": {
      ""demo"": {
        ""x-tag"": null
      }
    }
  }
}";
            var settings = new OpenApiReaderSettings
            {
                ExtensionParsers =
                {
                    { "x-tag", (any, version) => throw new OpenApiException("Testing") }
                }
            };

            var result = OpenApiDocument.Parse(json, "json", settings);

            Assert.NotNull(result.Diagnostic);
            Assert.NotEmpty(result.Diagnostic.Errors);
            var error = result.Diagnostic.Errors[0];
            Assert.Equal("Testing", error.Message);
            Assert.Equal("#/components/schemas/demo/x-tag", error.Pointer);
        }
    }

    internal class FooExtension : IOpenApiExtension, IOpenApiElement
    {
        public string Baz { get; set; }

        public string Bar { get; set; }

        public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
        {
            writer.WriteStartObject();
            writer.WriteProperty("baz", Baz);
            writer.WriteProperty("bar", Bar);
            writer.WriteEndObject();
        }
    }
}