/
ValidationTests.swift
420 lines (394 loc) · 15.4 KB
/
ValidationTests.swift
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
import Vapor
import XCTest
class ValidationTests: XCTestCase {
func testValidate() {
let valid = """
{
"name": "Tanner",
"age": 24,
"gender": "male",
"email": "me@tanner.xyz",
"luckyNumber": 5,
"profilePictureURL": "https://foo.jpg",
"preferredColors": ["blue"],
"pet": {
"name": "Zizek",
"age": 3
},
"favoritePet": null,
"isAdmin": true
}
"""
XCTAssertNoThrow(try User.validate(json: valid))
let invalidUser = """
{
"name": "Tan!ner",
"age": 24,
"gender": "other",
"email": "me@tanner.xyz",
"luckyNumber": 5,
"profilePictureURL": "https://foo.jpg",
"preferredColors": ["blue"],
"pet": {
"name": "Zizek",
"age": 3
},
"isAdmin": true
}
"""
XCTAssertThrowsError(try User.validate(json: invalidUser)) { error in
XCTAssertEqual("\(error)",
"name contains '!' (allowed: A-Z, a-z, 0-9)")
}
let invalidPet = """
{
"name": "Tanner",
"age": 24,
"gender": "male",
"email": "me@tanner.xyz",
"luckyNumber": 5,
"profilePictureURL": "https://foo.jpg",
"preferredColors": ["blue"],
"pet": {
"name": "Zi!zek",
"age": 3
},
"isAdmin": true
}
"""
XCTAssertThrowsError(try User.validate(json: invalidPet)) { error in
XCTAssertEqual("\(error)",
"pet name contains '!' (allowed: whitespace, A-Z, a-z, 0-9)")
}
let invalidBool = """
{
"name": "Tanner",
"age": 24,
"gender": "male",
"email": "me@tanner.xyz",
"luckyNumber": 5,
"profilePictureURL": "https://foo.jpg",
"preferredColors": ["blue"],
"pet": {
"name": "Zizek",
"age": 3
},
"isAdmin": "true"
}
"""
XCTAssertThrowsError(try User.validate(json: invalidBool)) { error in
XCTAssertEqual("\(error)",
"isAdmin is not a(n) Bool")
}
let validOptionalFavoritePet = """
{
"name": "Tanner",
"age": 24,
"gender": "male",
"email": "me@tanner.xyz",
"luckyNumber": 5,
"profilePictureURL": "https://foo.jpg",
"preferredColors": ["blue"],
"pet": {
"name": "Zizek",
"age": 3
},
"favoritePet": {
"name": "Zizek",
"age": 3
},
"isAdmin": true
}
"""
XCTAssertNoThrow(try User.validate(json: validOptionalFavoritePet))
let invalidOptionalFavoritePet = """
{
"name": "Tanner",
"age": 24,
"gender": "male",
"email": "me@tanner.xyz",
"luckyNumber": 5,
"profilePictureURL": "https://foo.jpg",
"preferredColors": ["blue"],
"pet": {
"name": "Zizek",
"age": 3
},
"favoritePet": {
"name": "Zi!zek",
"age": 3
},
"isAdmin": true
}
"""
XCTAssertThrowsError(try User.validate(json: invalidOptionalFavoritePet)) { error in
XCTAssertEqual("\(error)",
"favoritePet name contains '!' (allowed: whitespace, A-Z, a-z, 0-9)")
}
}
func testCatchError() throws {
let invalidUser = """
{
"name": "Tan!ner",
"age": 24,
"gender": "male",
"email": "me@tanner.xyz",
"luckyNumber": 5,
"profilePictureURL": "https://foo.jpg",
"preferredColors": ["blue"],
"pet": {
"name": "Zizek",
"age": 3
},
"isAdmin": true
}
"""
do {
try User.validate(json: invalidUser)
} catch let error as ValidationsError {
XCTAssertEqual(error.failures.count, 1)
let name = error.failures[0]
XCTAssertEqual(name.key.stringValue, "name")
XCTAssertEqual(name.result.isFailure, true)
XCTAssertEqual(name.result.failureDescription, "contains '!' (allowed: A-Z, a-z, 0-9)")
let and = name.result as! ValidatorResults.And
let count = and.left as! ValidatorResults.Range<Int>
XCTAssertEqual(count.result, .greaterThanOrEqualToMin(5))
let character = and.right as! ValidatorResults.CharacterSet
XCTAssertEqual(character.invalidSlice, "!")
}
}
func testNotReadability() {
assert("vapor!🤠",
fails: .ascii && .alphanumeric,
"contains '🤠' (allowed: ASCII) and contains '!' (allowed: A-Z, a-z, 0-9)")
assert("vapor",
fails: !(.ascii && .alphanumeric),
"contains only ASCII and contains only A-Z, a-z, 0-9")
}
func testASCII() {
assert("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789",
passes: .ascii)
assert("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789",
fails: !.ascii,
"contains only ASCII")
assert("\n\r\t", passes: .ascii)
assert("\n\r\t\u{129}", fails: .ascii, "contains 'ĩ' (allowed: ASCII)")
assert(" !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", passes: .ascii)
assert("ABCDEFGHIJKLMNOPQR🤠STUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",
fails: .ascii,
"contains '🤠' (allowed: ASCII)")
}
func testAlphanumeric() {
assert("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789", passes: .alphanumeric)
assert("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/", fails: .alphanumeric, "contains '+' (allowed: A-Z, a-z, 0-9)")
}
func testEmpty() {
assert("", passes: .empty)
assert("something", fails: .empty, "is not empty")
assert([Int](), passes: .empty)
assert([Int](), fails: !.empty, "is empty")
assert([1, 2], fails: .empty, "is not empty")
assert([1, 2], passes: !.empty)
}
func testEmail() {
assert("tanner@vapor.codes", passes: .email)
assert("tanner@vapor.codes", fails: !.email, "is a valid email address")
assert("tanner@vapor.codestanner@vapor.codes", fails: .email, "is not a valid email address")
assert("tanner@vapor.codes.", fails: .email, "is not a valid email address")
assert("tanner@@vapor.codes", fails: .email, "is not a valid email address")
assert("@vapor.codes", fails: .email, "is not a valid email address")
assert("tanner@codes", fails: .email, "is not a valid email address")
assert("asdf", fails: .email, "is not a valid email address")
assert("asdf", passes: !.email)
}
func testRange() {
assert(4, passes: .range(-5...5))
assert(4, passes: .range(..<5))
assert(5, fails: .range(..<5), "is greater than maximum of 4")
assert(5, passes: .range(...10))
assert(11, fails: .range(...10), "is greater than maximum of 10")
assert(4, fails: !.range(-5...5), "is between -5 and 5")
assert(5, passes: .range(-5...5))
assert(-5, passes: .range(-5...5))
assert(6, fails: .range(-5...5), "is greater than maximum of 5")
assert(-6, fails: .range(-5...5), "is less than minimum of -5")
assert(.max, passes: .range(5...))
assert(4, fails: .range(5...), "is less than minimum of 5")
assert(-5, passes: .range(-5..<6))
assert(-4, passes: .range(-5..<6))
assert(5, passes: .range(-5..<6))
assert(-6, fails: .range(-5..<6), "is less than minimum of -5")
assert(6, fails: .range(-5..<6), "is greater than maximum of 5")
assert(6, passes: !.range(-5..<6))
}
func testCountCharacters() {
assert("1", passes: .count(1...6))
assert("1", fails: !.count(1...6), "is between 1 and 6 character(s)")
assert("123", passes: .count(1...6))
assert("123456", passes: .count(1...6))
assert("", fails: .count(1...6), "is less than minimum of 1 character(s)")
assert("1234567", fails: .count(1...6), "is greater than maximum of 6 character(s)")
}
func testCountItems() {
assert([1], passes: .count(1...6))
assert([1], fails: !.count(1...6), "is between 1 and 6 item(s)")
assert([1], passes: .count(...1))
assert([1], fails: .count(..<1), "is greater than maximum of 0 item(s)")
assert([1, 2, 3], passes: .count(1...6))
assert([1, 2, 3, 4, 5, 6], passes: .count(1...6))
assert([Int](), fails: .count(1...6), "is less than minimum of 1 item(s)")
assert([1, 2, 3, 4, 5, 6, 7], fails: .count(1...6), "is greater than maximum of 6 item(s)")
}
func testURL() {
assert("https://www.somedomain.com/somepath.png", passes: .url)
assert("https://www.somedomain.com/somepath.png", fails: !.url, "is a valid URL")
assert("https://www.somedomain.com/", passes: .url)
assert("file:///Users/vapor/rocks/somePath.png", passes: .url)
assert("www.somedomain.com/", fails: .url, "is an invalid URL")
assert("bananas", fails: .url, "is an invalid URL")
assert("bananas", passes: !.url)
}
func testValid() {
assert("some random string", passes: .valid)
assert(true, passes: .valid)
assert("123", passes: .valid)
assert([1, 2, 3], passes: .valid)
assert(Date.init(), passes: .valid)
assert("some random string", fails: !.valid, "is valid")
assert(true, fails: !.valid, "is valid")
assert("123", fails: !.valid, "is valid")
}
func testPreexistingValidatorResultIsIncluded() throws {
struct CustomValidatorResult: ValidatorResult {
var isFailure: Bool {
true
}
var successDescription: String? {
nil
}
var failureDescription: String? {
"custom description"
}
}
var validations = Validations()
validations.add("key", result: CustomValidatorResult())
let error = try validations.validate(json: "{}").error
XCTAssertEqual(error?.description, "key custom description")
}
func testDoubleNegationIsAvoided() throws {
var validations = Validations()
validations.add("key", as: String.self, is: !.empty)
let error = try validations.validate(json: #"{"key": ""}"#).error
XCTAssertEqual(error?.description, "key is empty")
}
func testCaseOf() {
enum StringEnumType: String, CaseIterable {
case case1, case2, case3 = "CASE3"
}
assert("case1", passes: .case(of: StringEnumType.self))
assert("case2", passes: .case(of: StringEnumType.self))
assert("case1", fails: !.case(of: StringEnumType.self), "is case1, case2, or CASE3")
assert("case3", fails: .case(of: StringEnumType.self), "is not case1, case2, or CASE3")
enum IntEnumType: Int, CaseIterable {
case case1 = 1, case2 = 2
}
assert(1, passes: .case(of: IntEnumType.self))
assert(2, passes: .case(of: IntEnumType.self))
assert(1, fails: !.case(of: IntEnumType.self), "is 1 or 2")
assert(3, fails: .case(of: IntEnumType.self), "is not 1 or 2")
enum SingleCaseEnum: String, CaseIterable {
case case1 = "CASE1"
}
assert("CASE1", passes: .case(of: SingleCaseEnum.self))
assert("CASE1", fails: !.case(of: SingleCaseEnum.self), "is CASE1")
assert("CASE2", fails: .case(of: SingleCaseEnum.self), "is not CASE1")
}
}
private func assert<T>(
_ data: T,
fails validator: Validator<T>,
_ description: String,
file: StaticString = #file,
line: UInt = #line
) {
let file = (file)
let result = validator.validate(data)
XCTAssert(result.isFailure, result.successDescription ?? "n/a", file: file, line: line)
XCTAssertEqual(description, result.failureDescription ?? "n/a", file: file, line: line)
}
private func assert<T>(
_ data: T,
passes validator: Validator<T>,
file: StaticString = #file,
line: UInt = #line
) {
let file = (file)
let result = validator.validate(data)
XCTAssert(!result.isFailure, result.failureDescription ?? "n/a", file: file, line: line)
}
private final class User: Validatable, Codable {
enum Gender: String, CaseIterable, Codable {
case male, female, other
}
var id: Int?
var name: String
var age: Int
var gender: Gender
var email: String?
var pet: Pet
var favoritePet: Pet?
var luckyNumber: Int?
var profilePictureURL: String?
var preferredColors: [String]
var isAdmin: Bool
struct Pet: Codable {
var name: String
var age: Int
init(name: String, age: Int) {
self.name = name
self.age = age
}
}
init(id: Int? = nil, name: String, age: Int, gender: Gender, pet: Pet, preferredColors: [String] = [], isAdmin: Bool) {
self.id = id
self.name = name
self.age = age
self.gender = gender
self.pet = pet
self.preferredColors = preferredColors
self.isAdmin = isAdmin
}
static func validations(_ v: inout Validations) {
// validate name is at least 5 characters and alphanumeric
v.add("name", as: String.self, is: .count(5...) && .alphanumeric)
// validate age is 18 or older
v.add("age", as: Int.self, is: .range(18...))
// validate gender is of type Gender
v.add("gender", as: String.self, is: .case(of: Gender.self))
// validate the email is valid and is not nil
v.add("email", as: String?.self, is: !.nil && .email)
v.add("email", as: String?.self, is: .email && !.nil) // test other way
// validate the email is valid or is nil
v.add("email", as: String?.self, is: .nil || .email)
v.add("email", as: String?.self, is: .email || .nil) // test other way
// validate that the lucky number is nil or is 5 or 7
v.add("luckyNumber", as: Int?.self, is: .nil || .in(5, 7))
// validate that the profile picture is nil or a valid URL
v.add("profilePictureURL", as: String?.self, is: .url || .nil)
v.add("preferredColors", as: [String].self, is: !.empty)
// pet validations
v.add("pet") { pet in
pet.add("name", as: String.self,
is: .count(5...) && .characterSet(.alphanumerics + .whitespaces))
pet.add("age", as: Int.self, is: .range(3...))
}
// optional favorite pet validations
v.add("favoritePet", required: false) { pet in
pet.add("name", as: String.self,
is: .count(5...) && .characterSet(.alphanumerics + .whitespaces))
pet.add("age", as: Int.self, is: .range(3...))
}
v.add("isAdmin", as: Bool.self)
}
}