forked from luizaes/json-data-masking
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJsonMaskTests.cs
More file actions
423 lines (354 loc) · 13.7 KB
/
Copy pathJsonMaskTests.cs
File metadata and controls
423 lines (354 loc) · 13.7 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
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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
using JsonDataMasking.Masks;
using JsonDataMasking.Test.MockData;
using System;
using System.Collections.Generic;
using System.Linq;
using Xunit;
namespace JsonDataMasking.Test
{
public class JsonMaskTests
{
private const string CustomerDocument = "99999999999";
private const int ShowElementsNumber = 3;
private readonly string DefaultMask = new('*', JsonMask.DefaultMaskSize);
[Fact]
public void MaskSensitiveData_DoesNotMaskProperty_WhenDoesNotHaveAttribute()
{
// Arrange
var customerType = "Corporate";
var customer = new CustomerMock { CustomerType = customerType };
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.Equal(customerType, maskedCustomerData.CustomerType);
}
[Fact]
public void MaskSensitiveData_MasksEntireProperty_WhenHasAttributeAndNoArgumentsAreGiven()
{
// Arrange
var customer = new CustomerMock { FullName = "John Doe" };
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.Equal(DefaultMask, maskedCustomerData.FullName);
}
[Fact]
public void MaskSensitiveData_SubstitutesEntireProperty_WhenHasAttributeWithSubstituteText()
{
// Arrange
var customer = new CustomerMock { CreditCardNumber = "9999 9999 9999 9999" };
var expectedMask = "REDACTED";
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.Equal(expectedMask, maskedCustomerData.CreditCardNumber);
}
[Fact]
public void MaskSensitiveData_PreservesPropertyLength_WhenHasAttributeWithPreserveLength()
{
// Arrange
var customer = new CustomerMock { Document = CustomerDocument };
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.True(CustomerDocument.Length == maskedCustomerData?.Document?.Length);
}
[Fact]
public void MaskSensitiveData_DoesNotMaskFirstFieldElements_WhenHasAttributeWithShowFirst()
{
// Arrange
var customer = new CustomerMock { Document = CustomerDocument };
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.True(CustomerDocument[..ShowElementsNumber] == maskedCustomerData?.Document?[..ShowElementsNumber]);
}
[Fact]
public void MaskSensitiveData_DoesNotMaskLastFieldElements_WhenHasAttributeWithShowLast()
{
// Arrange
var customer = new CustomerMock { Document = CustomerDocument };
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.True(CustomerDocument.Substring(CustomerDocument.Length - ShowElementsNumber, ShowElementsNumber)
== maskedCustomerData?.Document?.Substring(CustomerDocument.Length - ShowElementsNumber, ShowElementsNumber));
}
[Fact]
public void MaskSensitiveData_UsesCustomMask_WhenHasAttributeWithCustomMaskCharacter()
{
// Arrange
var customer = new CustomerMock { CreditCardSecurityCode = "123" };
var expectedMask = new string('#', JsonMask.DefaultMaskSize);
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.Equal(expectedMask, maskedCustomerData.CreditCardSecurityCode);
}
[Fact]
public void MaskSensitiveData_MasksUsingDefaultSize_WhenHasAttributeWithInvalidShowFirstAndLastRange()
{
// Arrange
var login = new LoginMock { Email = "email@email.com" };
// Act
var maskedLogin = JsonMask.MaskSensitiveData(login);
// Assert
Assert.Equal(DefaultMask, maskedLogin.Email);
}
[Fact]
public void MaskSensitiveData_DoesNotMaskProperty_WhenPropertyHasAttributeWithNullValue()
{
// Arrange
var customer = new CustomerMock { };
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.Null(maskedCustomerData.Document);
}
[Fact]
public void MaskSensitiveData_MasksProperty_WhenNestedPropertyHasAttribute()
{
// Arrange
var customer = new CustomerMock {
Address = new CustomerAddressMock {
ZipCode = "99999999"
}
};
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.Equal(DefaultMask, maskedCustomerData.Address?.ZipCode);
}
[Fact]
public void MaskSensitiveData_MasksProperty_WhenListHasAttribute()
{
// Arrange
var customer = new CustomerMock
{
Documents = new List<string>
{
"12345",
"54321"
}
};
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.True(maskedCustomerData.Documents?.All(value => DefaultMask.Equals(value)));
}
[Fact]
public void MaskSensitiveData_MasksProperty_WhenDictionaryHasAttribute()
{
// Arrange
var customer = new CustomerMock
{
CustomFields = new Dictionary<string, string>
{
{ "document", "12345" },
{ "name", "Jane Doe" }
}
};
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.True(maskedCustomerData.CustomFields?.All(pair => DefaultMask.Equals(pair.Value)));
}
[Fact]
public void MaskSensitiveData_MasksProperty_WhenIEnumerableHasAttribute()
{
// Arrange
var customer = new CustomerMock
{
CustomerIds = new List<string>
{
Guid.NewGuid().ToString(),
Guid.NewGuid().ToString()
}.AsEnumerable()
};
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.True(maskedCustomerData.CustomerIds?.All(id => DefaultMask.Equals(id)));
}
[Fact]
public void MaskSensitiveData_MasksProperty_WhenNestedCollectionHasAttribute()
{
// Arrange
var customer = new CustomerMock
{
Addresses = new List<CustomerAddressMock>
{
new CustomerAddressMock
{
ZipCode = "9999999"
}
}.AsEnumerable()
};
// Act
var maskedCustomerData = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.True(maskedCustomerData.Addresses?.All(address => DefaultMask.Equals(address?.ZipCode)));
}
[Fact]
public void MaskSensitiveData_DoesNotMaskProperty_WhenCollectionDoesNotHaveAttribute()
{
// Arrange
var customerAddress = new CustomerAddressMock
{
GeoCoordinates = new List<double>
{
1.11111111,
1.11111111
}
};
// Act
var maskedCustomerAddress = JsonMask.MaskSensitiveData(customerAddress);
// Assert
Assert.True(maskedCustomerAddress.GeoCoordinates?.All(gc => customerAddress.GeoCoordinates.Contains(gc)));
}
[Fact]
public void MaskSensitiveData_ThrowsNotSupportedException_WhenDictionaryHasInvalidValueType()
{
// Arrange
var customerBalance = new CustomerBalance
{
AccountsBalance = new Dictionary<string, int>
{
{ "accountBank1", 10000 },
{ "accountBank2", 50 },
}
};
// Act and assert
Assert.Throws<NotSupportedException>(() => JsonMask.MaskSensitiveData(customerBalance));
}
[Fact]
public void MaskSensitiveData_DoesNotModifyOriginalObject_WhenMaskingTheObjectsProperties()
{
// Arrange
var customer = new CustomerMock
{
FullName = "John Doe"
};
// Act
var maskedCustomer = JsonMask.MaskSensitiveData(customer);
// Assert
Assert.NotEqual(customer.FullName, maskedCustomer.FullName);
}
[Fact]
public void MaskSensitiveData_ThrowsArgumentNullException_WhenObjectIsNull()
{
// Arrange
CustomerMock? customer = null;
// Act and assert
Assert.Throws<ArgumentNullException>(() => JsonMask.MaskSensitiveData(customer));
}
[Fact]
public void MaskSensitiveData_ThrowsNotSupportedException_WhenPropertyHasBaseObjectType()
{
// Arrange
var credentials = new AuthCredentialsMock
{
ApiKey = new CreditCardMock { SecurityCode = 123},
ApiToken = "123"
};
// Act and assert
Assert.Throws<NotSupportedException>(() => JsonMask.MaskSensitiveData(credentials));
}
[Fact]
public void MaskSensitiveData_MasksProperty_WhenDataHasAnonymousType()
{
// Arrange
var customer = new CustomerMock
{
FullName = "John Doe"
};
var anonymousObj = new { customer };
var expectedObj = new CustomerMock { FullName = "*****" };
// Act
var maskedAnonymousObj = JsonMask.MaskSensitiveData(anonymousObj);
// Assert
Assert.Equal(expectedObj.FullName, maskedAnonymousObj.customer.FullName);
}
[Fact]
public void MaskSensitiveData_DoesNotEnterInfiniteLoop_WhenDataHasACycle()
{
// Arrange
var loopObj = new LoopMock
{
Child = new LoopMock
{
Child = new LoopMock()
}
};
// Act
var maskedLoopObj = JsonMask.MaskSensitiveData(loopObj);
// Assert
Assert.NotNull(maskedLoopObj);
}
[Fact]
public void MaskSensitiveData_ThrowsNotSupportedException_WhenPropertyIsArray()
{
// Arrange
var passcodes = new PasscodesMock
{
Passcodes = new[]
{
"test1234",
"abcd"
}
};
// Act and assert
Assert.Throws<NotSupportedException>(() => JsonMask.MaskSensitiveData(passcodes));
}
[Fact]
public void MaskSensitiveData_MasksOtherBaseTypes_WhenTheyHaveAttribute()
{
// Arrange
var baseTypes = new BasicTypesSensitiveMock();
// Act
var maskedBaseTypes = JsonMask.MaskSensitiveData(baseTypes);
// Assert
Assert.False(maskedBaseTypes.Bool);
Assert.Equal(0, maskedBaseTypes.Byte);
Assert.Equal(0, maskedBaseTypes.Sbyte);
Assert.Equal(0, maskedBaseTypes.Short);
Assert.Equal(0, maskedBaseTypes.Ushort);
Assert.Equal(0, maskedBaseTypes.Int);
Assert.Equal(0u, maskedBaseTypes.Uint);
Assert.Equal(0, maskedBaseTypes.Long);
Assert.Equal(0u, maskedBaseTypes.Ulong);
Assert.Equal(0, maskedBaseTypes.Float);
Assert.Equal(0, maskedBaseTypes.Double);
Assert.Equal(0, maskedBaseTypes.Decimal);
Assert.Equal('\0', maskedBaseTypes.Char);
Assert.Equal(new DateTime(), maskedBaseTypes.DateTime);
Assert.Equal(new DateTimeOffset(), maskedBaseTypes.DateTimeOffset);
Assert.Equal(Guid.Empty, maskedBaseTypes.Guid);
}
[Fact]
public void MaskSensitiveData_DoesNotMaskOtherBaseTypes_WhenWithoutSensitiveAttribute()
{
// Arrange
var nonSensitiveBaseTypes = new BasicTypesMock();
// Act
var maskedBaseTypes = JsonMask.MaskSensitiveData(nonSensitiveBaseTypes);
// Assert
Assert.True(maskedBaseTypes.Bool);
Assert.Equal(1, maskedBaseTypes.Byte);
Assert.Equal(1, maskedBaseTypes.Sbyte);
Assert.Equal(1, maskedBaseTypes.Short);
Assert.Equal(1, maskedBaseTypes.Ushort);
Assert.Equal(1, maskedBaseTypes.Int);
Assert.Equal(1u, maskedBaseTypes.Uint);
Assert.Equal(1, maskedBaseTypes.Long);
Assert.Equal(1u, maskedBaseTypes.Ulong);
Assert.Equal(1, maskedBaseTypes.Float);
Assert.Equal(1, maskedBaseTypes.Double);
Assert.Equal(1, maskedBaseTypes.Decimal);
Assert.Equal('1', maskedBaseTypes.Char);
Assert.Equal(new DateTime().AddYears(1), maskedBaseTypes.DateTime);
Assert.Equal(new DateTimeOffset().AddYears(1), maskedBaseTypes.DateTimeOffset);
Assert.Equal(Guid.Parse("ffffffff-ffff-ffff-ffff-ffffffffffff"), maskedBaseTypes.Guid);
}
}
}