-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
SerializerTests.cs
389 lines (341 loc) · 16.4 KB
/
SerializerTests.cs
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Text.Json.Nodes;
using System.Threading.Tasks;
using Xunit;
namespace System.Text.Json.Serialization.Tests
{
/// <summary>
/// Base class abstracting the serialization System Under Test.
/// </summary>
public abstract class SerializerTests
{
protected SerializerTests(JsonSerializerWrapper serializerUnderTest)
{
Serializer = serializerUnderTest;
StreamingSerializer = serializerUnderTest as StreamingJsonSerializerWrapper;
}
/// <summary>
/// The serialization System Under Test to be targeted by deriving test suites.
/// </summary>
protected JsonSerializerWrapper Serializer { get; }
/// <summary>
/// For Systems Under Test that support streaming, exposes the relevant API surface.
/// </summary>
protected StreamingJsonSerializerWrapper? StreamingSerializer { get; }
[Flags]
protected enum SerializedValueContext
{
None = 0,
RootValue = 1,
ObjectProperty = 2,
CollectionElement = 4,
DictionaryValue = 8,
JsonNode = 16,
BoxedValue = 32,
All = RootValue | ObjectProperty | CollectionElement | DictionaryValue | JsonNode | BoxedValue,
}
/// <summary>
/// Tests serialization of a given value within the context of multiple types:
/// root values, object properties, collection elements, dictionary values, etc.
/// </summary>
protected async Task TestMultiContextSerialization<TValue>(
TValue value,
string expectedJson,
Type? expectedExceptionType = null,
SerializedValueContext contexts = SerializedValueContext.All,
JsonSerializerOptions? options = null)
{
Assert.True((contexts & SerializedValueContext.All) != SerializedValueContext.None);
string actualJson;
if (contexts.HasFlag(SerializedValueContext.RootValue))
{
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(value, options));
}
else
{
actualJson = await Serializer.SerializeWrapper(value, options);
JsonTestHelper.AssertJsonEqual(expectedJson, actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.RootValue | SerializedValueContext.BoxedValue))
{
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper<object>(value, options));
}
else
{
actualJson = await Serializer.SerializeWrapper<object>(value, options);
JsonTestHelper.AssertJsonEqual(expectedJson, actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.ObjectProperty))
{
var poco = new GenericPoco<TValue> { Property = value };
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(poco, options));
}
else
{
string propertyName = options?.PropertyNamingPolicy is JsonNamingPolicy policy
? policy.ConvertName(nameof(GenericPoco<TValue>.Property))
: nameof(GenericPoco<TValue>.Property);
actualJson = await Serializer.SerializeWrapper(poco, options);
JsonTestHelper.AssertJsonEqual($@"{{ ""{propertyName}"" : {expectedJson} }}", actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.ObjectProperty | SerializedValueContext.BoxedValue))
{
var poco = new GenericPoco<object> { Property = value };
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(poco, options));
}
else
{
string propertyName = options?.PropertyNamingPolicy is JsonNamingPolicy policy
? policy.ConvertName(nameof(GenericPoco<object>.Property))
: nameof(GenericPoco<object>.Property);
actualJson = await Serializer.SerializeWrapper(poco, options);
JsonTestHelper.AssertJsonEqual($@"{{ ""{propertyName}"" : {expectedJson} }}", actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.CollectionElement))
{
var list = new List<TValue> { value };
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(list, options));
}
else
{
actualJson = await Serializer.SerializeWrapper(list, options);
JsonTestHelper.AssertJsonEqual($"[{expectedJson}]", actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.CollectionElement | SerializedValueContext.BoxedValue))
{
var list = new List<object> { value };
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(list, options));
}
else
{
actualJson = await Serializer.SerializeWrapper(list, options);
JsonTestHelper.AssertJsonEqual($"[{expectedJson}]", actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.DictionaryValue))
{
const string key = "key";
var dictionary = new Dictionary<string, TValue> { [key] = value };
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(dictionary, options));
}
else
{
string jsonKey = options?.DictionaryKeyPolicy is JsonNamingPolicy policy
? policy.ConvertName(key)
: key;
actualJson = await Serializer.SerializeWrapper(dictionary, options);
JsonTestHelper.AssertJsonEqual($@"{{ ""{jsonKey}"" : {expectedJson} }}", actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.DictionaryValue | SerializedValueContext.BoxedValue))
{
const string key = "key";
var dictionary = new Dictionary<string, object> { [key] = value };
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(dictionary, options));
}
else
{
string jsonKey = options?.DictionaryKeyPolicy is JsonNamingPolicy policy
? policy.ConvertName(key)
: key;
actualJson = await Serializer.SerializeWrapper(dictionary, options);
JsonTestHelper.AssertJsonEqual($@"{{ ""{jsonKey}"" : {expectedJson} }}", actualJson);
}
}
if (contexts.HasFlag(SerializedValueContext.JsonNode))
{
const string key = "key";
var jsonObject = new JsonObject { [key] = JsonValue.Create<TValue>(value) };
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.SerializeWrapper(jsonObject, options));
}
else
{
actualJson = await Serializer.SerializeWrapper(jsonObject, options);
JsonTestHelper.AssertJsonEqual($@"{{ ""{key}"" : {expectedJson} }}", actualJson);
}
}
}
/// <summary>
/// Tests serialization of a given list of values within the context of multiple types:
/// root values, object properties, collection elements, dictionary values, etc.
/// </summary>
protected async Task TestMultiContextSerialization<TValue>(
IEnumerable<(TValue Value, string ExpectedJson)> inputs,
SerializedValueContext contexts = SerializedValueContext.All,
JsonSerializerOptions? options = null)
{
inputs = inputs.ToList();
string expectedJson = $"[{string.Join(", ", inputs.Select(x => x.ExpectedJson))}]";
List<TValue> values = inputs.Select(x => x.Value).ToList();
await TestMultiContextSerialization(
values,
expectedJson,
expectedExceptionType: null,
contexts,
options);
}
/// <summary>
/// Tests deserialization of a given value within the context of multiple types:
/// root values, object properties, collection elements, dictionary values, etc.
/// </summary>
protected async Task TestMultiContextDeserialization<TValue>(
string json,
TValue? expectedValue = default,
Type? expectedExceptionType = null,
SerializedValueContext contexts = SerializedValueContext.All,
JsonSerializerOptions? options = null,
IEqualityComparer<TValue>? equalityComparer = null)
{
Assert.True((contexts & SerializedValueContext.All) != SerializedValueContext.None);
string wrappedJson;
equalityComparer ??= expectedValue is IEquatable<TValue>
? EqualityComparer<TValue>.Default
: new JsonEqualityComparer<TValue>();
if (contexts.HasFlag(SerializedValueContext.RootValue))
{
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.DeserializeWrapper<TValue>(json, options));
}
else
{
TValue value = await Serializer.DeserializeWrapper<TValue>(json, options);
Assert.Equal(expectedValue, value, equalityComparer);
}
}
if (contexts.HasFlag(SerializedValueContext.ObjectProperty))
{
string propertyName =
options?.PropertyNamingPolicy is JsonNamingPolicy policy
? policy.ConvertName(nameof(GenericPoco<TValue>.Property))
: nameof(GenericPoco<TValue>.Property);
wrappedJson = $@"{{ ""{propertyName}"" : {json} }}";
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.DeserializeWrapper<GenericPoco<TValue>>(wrappedJson, options));
}
else
{
GenericPoco<TValue> poco = await Serializer.DeserializeWrapper<GenericPoco<TValue>>(wrappedJson, options);
Assert.Equal(expectedValue, poco.Property, equalityComparer);
}
}
if (contexts.HasFlag(SerializedValueContext.CollectionElement))
{
wrappedJson = $@"[{json}]";
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.DeserializeWrapper<List<TValue>>(wrappedJson, options));
}
else
{
List<TValue> list = await Serializer.DeserializeWrapper<List<TValue>>(wrappedJson, options);
Assert.Equal(1, list.Count);
Assert.Equal(expectedValue, list[0], equalityComparer);
}
}
if (contexts.HasFlag(SerializedValueContext.DictionaryValue))
{
const string key = "key";
wrappedJson = $@"{{ ""{key}"" : {json} }}";
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType, () => Serializer.DeserializeWrapper<Dictionary<string, TValue>>(wrappedJson, options));
}
else
{
Dictionary<string, TValue> dictionary = await Serializer.DeserializeWrapper<Dictionary<string, TValue>>(wrappedJson, options);
Assert.Equal(1, dictionary.Count);
Assert.True(dictionary.ContainsKey(key));
Assert.Equal(expectedValue, dictionary[key], equalityComparer);
}
}
if (contexts.HasFlag(SerializedValueContext.JsonNode))
{
const string key = "key";
wrappedJson = $@"{{ ""{key}"" : {json} }}";
if (expectedExceptionType != null)
{
await Assert.ThrowsAsync(expectedExceptionType,
async () =>
{
JsonNode jsonNode = await Serializer.DeserializeWrapper<JsonNode>(wrappedJson, options);
JsonSerializer.Deserialize<TValue>(jsonNode[key], options);
});
}
else
{
JsonNode jsonNode = await Serializer.DeserializeWrapper<JsonNode>(wrappedJson, options);
TValue value = JsonSerializer.Deserialize<TValue>(jsonNode[key], options);
Assert.Equal(expectedValue, value, equalityComparer);
}
}
}
/// <summary>
/// Tests deserialization of a given list of values within the context of multiple types:
/// root values, object properties, collection elements, dictionary values, etc.
/// </summary>
protected async Task TestMultiContextDeserialization<TValue>(
IEnumerable<(string Json, TValue ExpectedValue)> inputs,
SerializedValueContext contexts = SerializedValueContext.All,
JsonSerializerOptions? options = null,
IEqualityComparer<TValue>? equalityComparer = null)
{
inputs = inputs.ToList();
List<TValue> expectedValues = inputs.Select(x => x.ExpectedValue).ToList();
string json = $"[{string.Join(",", inputs.Select(x => x.Json))}]";
var listEqualityComparer = new ListAssertionEqualityComparer<TValue>(equalityComparer);
await TestMultiContextDeserialization<List<TValue>>(json, expectedValues, expectedExceptionType: null, contexts, options, listEqualityComparer);
}
private class GenericPoco<T>
{
public T Property { get; set; }
}
private class JsonEqualityComparer<TValue> : IEqualityComparer<TValue>
{
public bool Equals(TValue? x, TValue? y) => JsonSerializer.Serialize(x) == JsonSerializer.Serialize(y);
public int GetHashCode([DisallowNull] TValue obj) => JsonSerializer.Serialize(obj).GetHashCode();
}
private class ListAssertionEqualityComparer<TValue> : IEqualityComparer<IList<TValue>>
{
private readonly IEqualityComparer<TValue>? _elementComparer;
public ListAssertionEqualityComparer(IEqualityComparer<TValue>? elementComparer)
{
_elementComparer = elementComparer ?? EqualityComparer<TValue>.Default;
}
public bool Equals(IList<TValue>? x, IList<TValue>? y)
{
Assert.Equal(x, y, _elementComparer);
return true;
}
public int GetHashCode([DisallowNull] IList<TValue> obj) => throw new NotImplementedException();
}
}
}