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
|
//===----------------------------------------------------------*- 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 FlagsEndToEndTests: XCTestCase {
}
// MARK: -
fileprivate struct Bar: ParsableArguments {
@Flag
var verbose: Bool = false
@Flag(inversion: .prefixedNo)
var extattr: Bool = false
@Flag(inversion: .prefixedNo, exclusivity: .exclusive)
var extattr2: Bool?
@Flag(inversion: .prefixedEnableDisable, exclusivity: .chooseFirst)
var logging: Bool = false
}
extension FlagsEndToEndTests {
func testParsing_defaultValue() throws {
AssertParse(Bar.self, []) { options in
XCTAssertEqual(options.verbose, false)
XCTAssertEqual(options.extattr, false)
XCTAssertEqual(options.extattr2, nil)
}
}
func testParsing_settingValue() throws {
AssertParse(Bar.self, ["--verbose"]) { options in
XCTAssertEqual(options.verbose, true)
XCTAssertEqual(options.extattr, false)
XCTAssertEqual(options.extattr2, nil)
}
AssertParse(Bar.self, ["--extattr"]) { options in
XCTAssertEqual(options.verbose, false)
XCTAssertEqual(options.extattr, true)
XCTAssertEqual(options.extattr2, nil)
}
AssertParse(Bar.self, ["--extattr2"]) { options in
XCTAssertEqual(options.verbose, false)
XCTAssertEqual(options.extattr, false)
XCTAssertEqual(options.extattr2, .some(true))
}
}
func testParsing_invert() throws {
AssertParse(Bar.self, ["--no-extattr"]) { options in
XCTAssertEqual(options.extattr, false)
}
AssertParse(Bar.self, ["--extattr", "--no-extattr"]) { options in
XCTAssertEqual(options.extattr, false)
}
AssertParse(Bar.self, ["--extattr", "--no-extattr", "--no-extattr"]) { options in
XCTAssertEqual(options.extattr, false)
}
AssertParse(Bar.self, ["--no-extattr", "--no-extattr", "--extattr"]) { options in
XCTAssertEqual(options.extattr, true)
}
AssertParse(Bar.self, ["--extattr", "--no-extattr", "--extattr"]) { options in
XCTAssertEqual(options.extattr, true)
}
AssertParse(Bar.self, ["--enable-logging"]) { options in
XCTAssertEqual(options.logging, true)
}
AssertParse(Bar.self, ["--no-extattr2", "--no-extattr2"]) { options in
XCTAssertEqual(options.extattr2, false)
}
AssertParse(Bar.self, ["--disable-logging", "--enable-logging"]) { options in
XCTAssertEqual(options.logging, false)
}
}
}
fileprivate struct Foo: ParsableArguments {
@Flag(inversion: .prefixedEnableDisable)
var index: Bool = false
@Flag(inversion: .prefixedEnableDisable)
var sandbox: Bool = true
@Flag(inversion: .prefixedEnableDisable)
var requiredElement: Bool
@Flag(inversion: .prefixedEnableDisable)
var optional: Bool? = nil
}
extension FlagsEndToEndTests {
func testParsingEnableDisable_defaultValue() throws {
AssertParse(Foo.self, ["--enable-required-element"]) { options in
XCTAssertEqual(options.index, false)
XCTAssertEqual(options.sandbox, true)
XCTAssertEqual(options.requiredElement, true)
XCTAssertNil(options.optional)
}
}
func testParsingEnableDisable_disableAll() throws {
AssertParse(Foo.self, ["--disable-index", "--disable-sandbox", "--disable-required-element", "--disable-optional"]) { options in
XCTAssertEqual(options.index, false)
XCTAssertEqual(options.sandbox, false)
XCTAssertEqual(options.requiredElement, false)
XCTAssertEqual(options.optional, false)
}
}
func testParsingEnableDisable_enableAll() throws {
AssertParse(Foo.self, ["--enable-index", "--enable-sandbox", "--enable-required-element", "--enable-optional"]) { options in
XCTAssertEqual(options.index, true)
XCTAssertEqual(options.sandbox, true)
XCTAssertEqual(options.requiredElement, true)
XCTAssertEqual(options.optional, true)
}
}
func testParsingEnableDisable_Fails() throws {
XCTAssertThrowsError(try Foo.parse([]))
XCTAssertThrowsError(try Foo.parse(["--disable-index"]))
XCTAssertThrowsError(try Foo.parse(["--disable-sandbox"]))
}
}
enum Color: String, EnumerableFlag {
case pink
case purple
case silver
}
enum Size: String, EnumerableFlag {
case small
case medium
case large
case extraLarge
case humongous
static func name(for value: Size) -> NameSpecification {
switch value {
case .small, .medium, .large:
return .shortAndLong
case .humongous:
return [.long, .customLong("huge")]
default:
return .long
}
}
static func help(for value: Size) -> ArgumentHelp? {
switch value {
case .small:
return "A smallish size."
case .medium:
return "Not too big, not too small."
case .humongous:
return "Roughly the size of a barge."
case .large, .extraLarge:
return nil
}
}
}
enum Shape: String, EnumerableFlag {
case round
case square
case oblong
}
fileprivate struct Baz: ParsableArguments {
@Flag()
var color: Color
@Flag(help: "The size to use.")
var size: Size = .small
@Flag()
var shape: Shape?
}
extension FlagsEndToEndTests {
func testParsingCaseIterable_defaultValues() throws {
AssertParse(Baz.self, ["--pink"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .small)
XCTAssertEqual(options.shape, nil)
}
AssertParse(Baz.self, ["--pink", "--medium"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .medium)
XCTAssertEqual(options.shape, nil)
}
AssertParse(Baz.self, ["--pink", "--round"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .small)
XCTAssertEqual(options.shape, .round)
}
}
func testParsingCaseIterable_AllValues() throws {
AssertParse(Baz.self, ["--pink", "--small", "--round"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .small)
XCTAssertEqual(options.shape, .round)
}
AssertParse(Baz.self, ["--purple", "--medium", "--square"]) { options in
XCTAssertEqual(options.color, .purple)
XCTAssertEqual(options.size, .medium)
XCTAssertEqual(options.shape, .square)
}
AssertParse(Baz.self, ["--silver", "--large", "--oblong"]) { options in
XCTAssertEqual(options.color, .silver)
XCTAssertEqual(options.size, .large)
XCTAssertEqual(options.shape, .oblong)
}
}
func testParsingCaseIterable_CustomName() throws {
AssertParse(Baz.self, ["--pink", "--extra-large"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .extraLarge)
XCTAssertEqual(options.shape, nil)
}
AssertParse(Baz.self, ["--pink", "--huge"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .humongous)
XCTAssertEqual(options.shape, nil)
}
AssertParse(Baz.self, ["--pink", "--humongous"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .humongous)
XCTAssertEqual(options.shape, nil)
}
AssertParse(Baz.self, ["--pink", "--huge", "--humongous"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.size, .humongous)
XCTAssertEqual(options.shape, nil)
}
}
func testParsingCaseIterable_Help() throws {
AssertHelp(.default, for: Baz.self, equals: """
USAGE: baz --pink --purple --silver [--small] [--medium] [--large] [--extra-large] [--humongous] [--round] [--square] [--oblong]
OPTIONS:
--pink/--purple/--silver
-s, --small A smallish size. (default: --small)
-m, --medium Not too big, not too small.
-l, --large The size to use.
--extra-large The size to use.
--humongous, --huge Roughly the size of a barge.
--round/--square/--oblong
-h, --help Show help information.
""")
}
func testParsingCaseIterable_Fails() throws {
// Missing color
XCTAssertThrowsError(try Baz.parse([]))
XCTAssertThrowsError(try Baz.parse(["--large", "--square"]))
// Repeating flags
XCTAssertThrowsError(try Baz.parse(["--pink", "--purple"]))
XCTAssertThrowsError(try Baz.parse(["--pink", "--small", "--large"]))
XCTAssertThrowsError(try Baz.parse(["--pink", "--round", "--square"]))
// Case name instead of raw value
XCTAssertThrowsError(try Baz.parse(["--pink", "--extraLarge"]))
}
}
fileprivate struct Qux: ParsableArguments {
@Flag()
var color: [Color] = []
@Flag()
var size: [Size] = [.small, .medium]
}
extension FlagsEndToEndTests {
func testParsingCaseIterableArray_Values() throws {
AssertParse(Qux.self, []) { options in
XCTAssertEqual(options.color, [])
XCTAssertEqual(options.size, [.small, .medium])
}
AssertParse(Qux.self, ["--pink"]) { options in
XCTAssertEqual(options.color, [.pink])
XCTAssertEqual(options.size, [.small, .medium])
}
AssertParse(Qux.self, ["--pink", "--purple", "--small"]) { options in
XCTAssertEqual(options.color, [.pink, .purple])
XCTAssertEqual(options.size, [.small])
}
AssertParse(Qux.self, ["--pink", "--small", "--purple", "--medium"]) { options in
XCTAssertEqual(options.color, [.pink, .purple])
XCTAssertEqual(options.size, [.small, .medium])
}
AssertParse(Qux.self, ["--pink", "--pink", "--purple", "--pink"]) { options in
XCTAssertEqual(options.color, [.pink, .pink, .purple, .pink])
XCTAssertEqual(options.size, [.small, .medium])
}
}
func testParsingCaseIterableArray_Fails() throws {
XCTAssertThrowsError(try Qux.parse(["--pink", "--small", "--bloop"]))
}
}
fileprivate struct RepeatOK: ParsableArguments {
@Flag(exclusivity: .chooseFirst)
var color: Color
@Flag(exclusivity: .chooseLast)
var shape: Shape
@Flag(exclusivity: .exclusive)
var size: Size = .small
}
extension FlagsEndToEndTests {
func testParsingCaseIterable_RepeatableFlags() throws {
AssertParse(RepeatOK.self, ["--pink", "--purple", "--square"]) { options in
XCTAssertEqual(options.color, .pink)
XCTAssertEqual(options.shape, .square)
}
AssertParse(RepeatOK.self, ["--round", "--oblong", "--silver"]) { options in
XCTAssertEqual(options.color, .silver)
XCTAssertEqual(options.shape, .oblong)
}
AssertParse(RepeatOK.self, ["--large", "--pink", "--round", "-l"]) { options in
XCTAssertEqual(options.size, .large)
}
}
}
|
