Repository navigation
Expand file tree
/
Copy pathAsyncApiReference_Should.cs
More file actions
254 lines (218 loc) · 9.45 KB
/
Copy pathAsyncApiReference_Should.cs
File metadata and controls
254 lines (218 loc) · 9.45 KB
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
// Copyright (c) The LEGO Group. All rights reserved.
namespace LEGO.AsyncAPI.Tests
{
using FluentAssertions;
using FluentAssertions.Primitives;
using LEGO.AsyncAPI.Models;
using LEGO.AsyncAPI.Readers;
using NUnit.Framework;
using System.Linq;
public class AsyncApiReference_Should : TestBase
{
[Test]
public void AsyncApiReference_WithExternalFragmentUriReference_AllowReference()
{
// Arrange
var actual = """
payload:
$ref: http://example.com/some-resource#/path/to/external/fragment
""";
var reader = new AsyncApiStringReader();
// Act
var deserialized = reader.ReadFragment<AsyncApiMessage>(actual, AsyncApiVersion.AsyncApi2_0, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
deserialized.Payload.UnresolvedReference.Should().BeTrue();
var reference = deserialized.Payload.Reference;
reference.ExternalResource.Should().Be("http://example.com/some-resource");
reference.Id.Should().Be("/path/to/external/fragment");
reference.IsFragment.Should().BeTrue();
reference.IsExternal.Should().BeTrue();
reference.Type.Should().Be(ReferenceType.Schema);
var expected = deserialized.SerializeAsYaml(AsyncApiVersion.AsyncApi2_0);
actual.Should()
.BePlatformAgnosticEquivalentTo(expected);
}
[Test]
public void AsyncApiReference_WithFragmentReference_AllowReference()
{
// Arrange
var actual = """
payload:
$ref: /fragments/myFragment
""";
var reader = new AsyncApiStringReader();
// Act
var deserialized = reader.ReadFragment<AsyncApiMessage>(actual, AsyncApiVersion.AsyncApi2_0, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
deserialized.Payload.UnresolvedReference.Should().BeTrue();
var reference = deserialized.Payload.Reference;
reference.Type.Should().Be(ReferenceType.Schema);
reference.ExternalResource.Should().Be("/fragments/myFragment");
reference.Id.Should().BeNull();
reference.IsFragment.Should().BeTrue();
reference.IsExternal.Should().BeTrue();
var expected = deserialized.SerializeAsYaml(AsyncApiVersion.AsyncApi2_0);
actual.Should()
.BePlatformAgnosticEquivalentTo(expected);
}
[Test]
public void AsyncApiReference_WithInternalComponentReference_AllowReference()
{
// Arrange
var actual = """
payload:
$ref: '#/components/schemas/test'
""";
var reader = new AsyncApiStringReader();
// Act
var deserialized = reader.ReadFragment<AsyncApiMessage>(actual, AsyncApiVersion.AsyncApi2_0, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
var reference = deserialized.Payload.Reference;
reference.ExternalResource.Should().BeNull();
reference.Type.Should().Be(ReferenceType.Schema);
reference.Id.Should().Be("test");
reference.IsFragment.Should().BeFalse();
reference.IsExternal.Should().BeFalse();
var expected = deserialized.SerializeAsYaml(AsyncApiVersion.AsyncApi2_0);
actual.Should()
.BePlatformAgnosticEquivalentTo(expected);
}
[Test]
public void AsyncApiReference_WithExternalFragmentReference_AllowReference()
{
// Arrange
var actual = """
payload:
$ref: ./myjsonfile.json#/fragment
""";
var reader = new AsyncApiStringReader();
// Act
var deserialized = reader.ReadFragment<AsyncApiMessage>(actual, AsyncApiVersion.AsyncApi2_0, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
var reference = deserialized.Payload.Reference;
reference.ExternalResource.Should().Be("./myjsonfile.json");
reference.Id.Should().Be("/fragment");
reference.IsFragment.Should().BeTrue();
reference.IsExternal.Should().BeTrue();
var expected = deserialized.SerializeAsYaml(AsyncApiVersion.AsyncApi2_0);
actual.Should()
.BePlatformAgnosticEquivalentTo(expected);
}
[Test]
public void AsyncApiReference_WithExternalComponentReference_AllowReference()
{
// Arrange
var actual = """
payload:
$ref: ./someotherdocument.json#/components/schemas/test
""";
var reader = new AsyncApiStringReader();
// Act
var deserialized = reader.ReadFragment<AsyncApiMessage>(actual, AsyncApiVersion.AsyncApi2_0, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
var reference = deserialized.Payload.Reference;
reference.ExternalResource.Should().Be("./someotherdocument.json");
reference.Type.Should().Be(ReferenceType.Schema);
reference.Id.Should().Be("test");
reference.IsFragment.Should().BeFalse();
reference.IsExternal.Should().BeTrue();
var expected = deserialized.SerializeAsYaml(AsyncApiVersion.AsyncApi2_0);
actual.Should()
.BePlatformAgnosticEquivalentTo(expected);
}
[Test]
public void AsyncApiDocument_WithInternalComponentReference_ResolvesReference()
{
// Arrange
var actual = """
asyncapi: 2.6.0
info:
title: My AsyncAPI Document
version: 1.0.0
channels:
myChannel:
$ref: '#/components/channels/myChannel'
components:
channels:
myChannel:
description: customDescription
""";
var settings = new AsyncApiReaderSettings()
{
ReferenceResolution = ReferenceResolutionSetting.ResolveReferences,
};
var reader = new AsyncApiStringReader(settings);
// Act
var deserialized = reader.Read(actual, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
var channel = deserialized.Channels.First().Value;
channel.UnresolvedReference.Should().BeFalse();
channel.Description.Should().Be("customDescription");
channel.Reference.ExternalResource.Should().BeNull();
channel.Reference.Id.Should().Be("myChannel");
channel.Reference.IsExternal.Should().BeFalse();
channel.Reference.Type.Should().Be(ReferenceType.Channel);
}
[Test]
public void AsyncApiDocument_WithExternalReference_DoesNotResolve()
{
// Arrange
var actual = """
asyncapi: 2.6.0
info:
title: My AsyncAPI Document
version: 1.0.0
channels:
myChannel:
$ref: http://example.com/channel.json
""";
var settings = new AsyncApiReaderSettings()
{
ReferenceResolution = ReferenceResolutionSetting.ResolveReferences,
};
var reader = new AsyncApiStringReader(settings);
// Act
var deserialized = reader.Read(actual, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
var channel = deserialized.Channels.First().Value;
channel.UnresolvedReference.Should().BeTrue();
channel.Description.Should().BeNull();
channel.Reference.ExternalResource.Should().Be("http://example.com/channel.json");
channel.Reference.Type.Should().Be(ReferenceType.Channel);
channel.Reference.Id.Should().BeNull();
channel.Reference.IsExternal.Should().BeTrue();
channel.Reference.IsFragment.Should().BeFalse();
}
[Test]
public void AsyncApiReference_WithExternalReference_AllowsReferenceDoesNotResolve()
{
// Arrange
var actual = """
payload:
$ref: http://example.com/json.json
""";
var reader = new AsyncApiStringReader();
// Act
var deserialized = reader.ReadFragment<AsyncApiMessage>(actual, AsyncApiVersion.AsyncApi2_0, out var diagnostic);
// Assert
diagnostic.Errors.Should().BeEmpty();
var reference = deserialized.Payload.Reference;
reference.ExternalResource.Should().Be("http://example.com/json.json");
reference.Id.Should().BeNull();
reference.IsExternal.Should().BeTrue();
reference.IsFragment.Should().BeFalse();
diagnostic.Errors.Should().BeEmpty();
var expected = deserialized.SerializeAsYaml(AsyncApiVersion.AsyncApi2_0);
expected
.Should()
.BePlatformAgnosticEquivalentTo(actual);
}
}
}