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
|
//===----------------------------------------------------------*- swift -*-===//
//
// This source file is part of the Swift Argument Parser open source project
//
// Copyright (c) 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//
import XCTest
import ArgumentParserTestHelpers
import ArgumentParser
final class ValidationEndToEndTests: XCTestCase {
}
fileprivate enum UserValidationError: LocalizedError {
case userValidationError
var errorDescription: String? {
switch self {
case .userValidationError:
return "UserValidationError"
}
}
}
fileprivate struct Foo: ParsableArguments {
static var usageString: String = """
Usage: foo [--count <count>] [<names> ...] [--version] [--throw]
See 'foo --help' for more information.
"""
static var helpString: String = """
USAGE: foo [--count <count>] [<names> ...] [--version] [--throw]
ARGUMENTS:
<names>
OPTIONS:
--count <count>
--version
--throw
-h, --help Show help information.
"""
@Option()
var count: Int?
@Argument()
var names: [String] = []
@Flag
var version: Bool = false
@Flag(name: [.customLong("throw")])
var throwCustomError: Bool = false
@Flag(help: .hidden)
var showUsageOnly: Bool = false
@Flag(help: .hidden)
var failValidationSilently: Bool = false
@Flag(help: .hidden)
var failSilently: Bool = false
mutating func validate() throws {
if version {
throw CleanExit.message("0.0.1")
}
if names.isEmpty {
throw ValidationError("Must specify at least one name.")
}
if let count = count, names.count != count {
throw ValidationError("Number of names (\(names.count)) doesn't match count (\(count)).")
}
if throwCustomError {
throw UserValidationError.userValidationError
}
if showUsageOnly {
throw ValidationError("")
}
if failValidationSilently {
throw ExitCode.validationFailure
}
if failSilently {
throw ExitCode.failure
}
}
}
extension ValidationEndToEndTests {
func testValidation() throws {
AssertParse(Foo.self, ["Joe"]) { foo in
XCTAssertEqual(foo.names, ["Joe"])
XCTAssertNil(foo.count)
}
AssertParse(Foo.self, ["Joe", "Moe", "--count", "2"]) { foo in
XCTAssertEqual(foo.names, ["Joe", "Moe"])
XCTAssertEqual(foo.count, 2)
}
}
func testValidation_Version() throws {
AssertErrorMessage(Foo.self, ["--version"], "0.0.1")
AssertFullErrorMessage(Foo.self, ["--version"], "0.0.1")
}
func testValidation_Fails() throws {
AssertErrorMessage(Foo.self, [], "Must specify at least one name.")
AssertFullErrorMessage(Foo.self, [], """
Error: Must specify at least one name.
\(Foo.helpString)
""")
AssertErrorMessage(Foo.self, ["--count", "3", "Joe"], """
Number of names (1) doesn't match count (3).
""")
AssertFullErrorMessage(Foo.self, ["--count", "3", "Joe"], """
Error: Number of names (1) doesn't match count (3).
\(Foo.usageString)
""")
}
func testCustomErrorValidation() {
// verify that error description is printed if available via LocalizedError
AssertErrorMessage(Foo.self, ["--throw", "Joe"], UserValidationError.userValidationError.errorDescription!)
}
func testEmptyErrorValidation() {
AssertErrorMessage(Foo.self, ["--show-usage-only", "Joe"], "")
AssertFullErrorMessage(Foo.self, ["--show-usage-only", "Joe"], Foo.usageString)
AssertFullErrorMessage(Foo.self, ["--fail-validation-silently", "Joe"], "")
AssertFullErrorMessage(Foo.self, ["--fail-silently", "Joe"], "")
}
}
fileprivate struct FooCommand: ParsableCommand {
@Flag(help: .hidden)
var foo = false
@Flag(help: .hidden)
var bar = false
mutating func validate() throws {
if foo {
// --foo implies --bar
bar = true
}
}
func run() throws {
XCTAssertEqual(foo, bar)
}
}
extension ValidationEndToEndTests {
func testMutationsPreserved() throws {
var foo = try FooCommand.parseAsRoot(["--foo"])
try foo.run()
}
}
|
