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
|
//===----------------------------------------------------------*- swift -*-===//
//
// This source file is part of the Swift Argument Parser open source project
//
// Copyright (c) 2022 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
@testable import ArgumentParser
// This set of tests assert the help output matches the expected value for
// `@OptionGroup`s with names.
extension HelpGenerationTests {
fileprivate struct Flags: ParsableArguments {
@Flag(help: "example")
var verbose: Bool = false
@Flag(help: "example")
var oversharing: Bool = false
}
fileprivate struct Options: ParsableArguments {
@Option(help: "example")
var name: String = ""
@Option(help: "example")
var age: Int
}
fileprivate struct FlagsAndOptions: ParsableArguments {
@Flag(help: "example")
var experimental: Bool = false
@Option(help: "example")
var prefix: String
}
fileprivate struct ArgsAndFlags: ParsableArguments {
@Argument(help: "example")
var name: String?
@Argument(help: .init("example", visibility: .hidden))
var title: String
@Flag(help: "example")
var existingUser: Bool = false
}
fileprivate struct AllVisible: ParsableCommand {
@OptionGroup(title: "Flags Group")
var flags: Flags
@OptionGroup(title: "Options Group")
var options: Options
@OptionGroup
var flagsAndOptions: FlagsAndOptions
@OptionGroup
var argsAndFlags: ArgsAndFlags
}
fileprivate struct ContainsOptionGroup: ParsableCommand {
@OptionGroup(title: "Flags Group")
var flags: Flags
@OptionGroup
var argsAndFlags: ArgsAndFlags
}
func testAllVisible() {
AssertHelp(.default, for: AllVisible.self, equals: """
USAGE: all-visible [--verbose] [--oversharing] [--name <name>] --age <age> [--experimental] --prefix <prefix> [<name>] [--existing-user]
ARGUMENTS:
<name> example
FLAGS GROUP:
--verbose example
--oversharing example
OPTIONS GROUP:
--name <name> example
--age <age> example
OPTIONS:
--experimental example
--prefix <prefix> example
--existing-user example
-h, --help Show help information.
""")
AssertHelp(.hidden, for: AllVisible.self, equals: """
USAGE: all-visible [--verbose] [--oversharing] [--name <name>] --age <age> [--experimental] --prefix <prefix> [<name>] <title> [--existing-user]
ARGUMENTS:
<name> example
<title> example
FLAGS GROUP:
--verbose example
--oversharing example
OPTIONS GROUP:
--name <name> example
--age <age> example
OPTIONS:
--experimental example
--prefix <prefix> example
--existing-user example
-h, --help Show help information.
""")
}
fileprivate struct Combined: ParsableCommand {
@OptionGroup(title: "Extras")
var flags: Flags
@OptionGroup(title: "Extras")
var options: Options
@OptionGroup(title: "Others")
var flagsAndOptions: FlagsAndOptions
@OptionGroup(title: "Others")
var argsAndFlags: ArgsAndFlags
}
func testCombined() {
AssertHelp(.default, for: Combined.self, equals: """
USAGE: combined [--verbose] [--oversharing] [--name <name>] --age <age> [--experimental] --prefix <prefix> [<name>] [--existing-user]
EXTRAS:
--verbose example
--oversharing example
--name <name> example
--age <age> example
OTHERS:
--experimental example
--prefix <prefix> example
<name> example
--existing-user example
OPTIONS:
-h, --help Show help information.
""")
AssertHelp(.hidden, for: Combined.self, equals: """
USAGE: combined [--verbose] [--oversharing] [--name <name>] --age <age> [--experimental] --prefix <prefix> [<name>] <title> [--existing-user]
EXTRAS:
--verbose example
--oversharing example
--name <name> example
--age <age> example
OTHERS:
--experimental example
--prefix <prefix> example
<name> example
<title> example
--existing-user example
OPTIONS:
-h, --help Show help information.
""")
}
fileprivate struct HiddenGroups: ParsableCommand {
@OptionGroup(title: "Flags Group", visibility: .hidden)
var flags: Flags
@OptionGroup(title: "Options Group", visibility: .hidden)
var options: Options
@OptionGroup(visibility: .hidden)
var flagsAndOptions: FlagsAndOptions
@OptionGroup(visibility: .private)
var argsAndFlags: ArgsAndFlags
}
func testHiddenGroups() {
AssertHelp(.default, for: HiddenGroups.self, equals: """
USAGE: hidden-groups
OPTIONS:
-h, --help Show help information.
""")
AssertHelp(.hidden, for: HiddenGroups.self, equals: """
USAGE: hidden-groups [--verbose] [--oversharing] [--name <name>] --age <age> [--experimental] --prefix <prefix>
FLAGS GROUP:
--verbose example
--oversharing example
OPTIONS GROUP:
--name <name> example
--age <age> example
OPTIONS:
--experimental example
--prefix <prefix> example
-h, --help Show help information.
""")
}
fileprivate struct ParentWithGroups: ParsableCommand {
static var configuration: CommandConfiguration {
.init(subcommands: [ChildWithGroups.self])
}
@OptionGroup(title: "Extras")
var flags: Flags
@OptionGroup
var argsAndFlags: ArgsAndFlags
fileprivate struct ChildWithGroups: ParsableCommand {
@OptionGroup(title: "Child Extras")
var flags: Flags
@OptionGroup(title: "Extras")
var options: Options
@OptionGroup
var argsAndFlags: ArgsAndFlags
}
}
func testParentChild() {
AssertHelp(.default, for: ParentWithGroups.self, equals: """
USAGE: parent-with-groups [--verbose] [--oversharing] [<name>] [--existing-user] <subcommand>
ARGUMENTS:
<name> example
EXTRAS:
--verbose example
--oversharing example
OPTIONS:
--existing-user example
-h, --help Show help information.
SUBCOMMANDS:
child-with-groups
See 'parent-with-groups help <subcommand>' for detailed help.
""")
AssertHelp(.hidden, for: ParentWithGroups.self, equals: """
USAGE: parent-with-groups [--verbose] [--oversharing] [<name>] <title> [--existing-user] <subcommand>
ARGUMENTS:
<name> example
<title> example
EXTRAS:
--verbose example
--oversharing example
OPTIONS:
--existing-user example
-h, --help Show help information.
SUBCOMMANDS:
child-with-groups
See 'parent-with-groups help <subcommand>' for detailed help.
""")
AssertHelp(.default, for: ParentWithGroups.ChildWithGroups.self, root: ParentWithGroups.self, equals: """
USAGE: parent-with-groups child-with-groups [--verbose] [--oversharing] [--name <name>] --age <age> [<name>] [--existing-user]
ARGUMENTS:
<name> example
CHILD EXTRAS:
--verbose example
--oversharing example
EXTRAS:
--name <name> example
--age <age> example
OPTIONS:
--existing-user example
-h, --help Show help information.
""")
AssertHelp(.hidden, for: ParentWithGroups.ChildWithGroups.self, root: ParentWithGroups.self, equals: """
USAGE: parent-with-groups child-with-groups [--verbose] [--oversharing] [--name <name>] --age <age> [<name>] <title> [--existing-user]
ARGUMENTS:
<name> example
<title> example
CHILD EXTRAS:
--verbose example
--oversharing example
EXTRAS:
--name <name> example
--age <age> example
OPTIONS:
--existing-user example
-h, --help Show help information.
""")
}
fileprivate struct GroupsWithUnnamedGroups: ParsableCommand {
@OptionGroup
var extras: ContainsOptionGroup
}
func testUnnamedNestedGroups() {
AssertHelp(.default, for: GroupsWithUnnamedGroups.self, equals: """
USAGE: groups-with-unnamed-groups [--verbose] [--oversharing] [<name>] [--existing-user]
ARGUMENTS:
<name> example
OPTIONS:
--verbose example
--oversharing example
--existing-user example
-h, --help Show help information.
""")
}
fileprivate struct GroupsWithNamedGroups: ParsableCommand {
@OptionGroup(title: "Nested")
var extras: ContainsOptionGroup
}
func testNamedNestedGroups() {
AssertHelp(.default, for: GroupsWithNamedGroups.self, equals: """
USAGE: groups-with-named-groups [--verbose] [--oversharing] [<name>] [--existing-user]
NESTED:
--verbose example
--oversharing example
<name> example
--existing-user example
OPTIONS:
-h, --help Show help information.
""")
}
}
|
