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
|
//===----------------------------------------------------------*- 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
@testable import ArgumentParser
import ArgumentParserTestHelpers
final class HelpTests: XCTestCase {
}
func getErrorText<T: ParsableArguments>(_: T.Type, _ arguments: [String]) -> String {
do {
_ = try T.parse(arguments)
XCTFail("Didn't generate a help error")
return ""
} catch {
return T.message(for: error)
}
}
func getErrorText<T: ParsableCommand>(_: T.Type, _ arguments: [String], screenWidth: Int) -> String {
do {
let command = try T.parseAsRoot(arguments)
if let helpCommand = command as? HelpCommand {
return helpCommand.generateHelp(screenWidth: screenWidth)
} else {
XCTFail("Didn't generate a help error")
return ""
}
} catch {
return T.message(for: error)
}
}
extension HelpTests {
func testGlobalHelp() throws {
XCTAssertEqual(
getErrorText(Package.self, ["help"]).trimmingLines(),
"""
USAGE: package <subcommand>
OPTIONS:
-h, --help Show help information.
SUBCOMMANDS:
clean
config
describe
generate-xcodeproj
See 'package help <subcommand>' for detailed help.
""".trimmingLines())
}
func testGlobalHelp_messageForCleanExit_helpRequest() throws {
XCTAssertEqual(
Package.message(for: CleanExit.helpRequest()).trimmingLines(),
"""
USAGE: package <subcommand>
OPTIONS:
-h, --help Show help information.
SUBCOMMANDS:
clean
config
describe
generate-xcodeproj
See 'package help <subcommand>' for detailed help.
""".trimmingLines()
)
}
func testGlobalHelp_messageForCleanExit_message() throws {
let expectedMessage = "Failure"
XCTAssertEqual(
Package.message(for: CleanExit.message(expectedMessage)).trimmingLines(),
expectedMessage
)
}
func testConfigHelp() throws {
XCTAssertEqual(
getErrorText(Package.self, ["help", "config"], screenWidth: 80).trimmingLines(),
"""
USAGE: package config <subcommand>
OPTIONS:
-h, --help Show help information.
SUBCOMMANDS:
get-mirror
set-mirror
unset-mirror
See 'package help config <subcommand>' for detailed help.
""".trimmingLines())
}
func testGetMirrorHelp() throws {
XCTAssertEqual(
getErrorText(Package.self, ["help", "config", "get-mirror"], screenWidth: 80).trimmingLines(),
"""
USAGE: package config get-mirror [<options>] --package-url <package-url>
OPTIONS:
--build-path <build-path>
Specify build/cache directory (default: ./.build)
-c, --configuration <configuration>
Build with configuration (default: debug)
--enable-automatic-resolution/--disable-automatic-resolution
Use automatic resolution if Package.resolved file is
out-of-date (default: --enable-automatic-resolution)
--enable-index-store/--disable-index-store
Use indexing-while-building feature (default:
--enable-index-store)
--enable-package-manifest-caching/--disable-package-manifest-caching
Cache Package.swift manifests (default:
--enable-package-manifest-caching)
--enable-prefetching/--disable-prefetching
(default: --enable-prefetching)
--enable-sandbox/--disable-sandbox
Use sandbox when executing subprocesses (default:
--enable-sandbox)
--enable-pubgrub-resolver/--disable-pubgrub-resolver
[Experimental] Enable the new Pubgrub dependency
resolver (default: --disable-pubgrub-resolver)
--static-swift-stdlib/--no-static-swift-stdlib
Link Swift stdlib statically (default:
--no-static-swift-stdlib)
--package-path <package-path>
Change working directory before any other operation
(default: .)
--sanitize Turn on runtime checks for erroneous behavior
--skip-update Skip updating dependencies from their remote during a
resolution
-v, --verbose Increase verbosity of informational output
-Xcc <c-compiler-flag> Pass flag through to all C compiler invocations
-Xcxx <cxx-compiler-flag>
Pass flag through to all C++ compiler invocations
-Xlinker <linker-flag> Pass flag through to all linker invocations
-Xswiftc <swift-compiler-flag>
Pass flag through to all Swift compiler invocations
--package-url <package-url>
The package dependency URL
-h, --help Show help information.
""".trimmingLines())
}
}
struct Simple: ParsableArguments {
@Flag var verbose: Bool = false
@Option() var min: Int?
@Argument() var max: Int
static var helpText = """
USAGE: simple [--verbose] [--min <min>] <max>
ARGUMENTS:
<max>
OPTIONS:
--verbose
--min <min>
-h, --help Show help information.
""".trimmingLines()
}
extension HelpTests {
func testSimpleHelp() throws {
XCTAssertEqual(
getErrorText(Simple.self, ["--help"]).trimmingLines(),
Simple.helpText)
XCTAssertEqual(
getErrorText(Simple.self, ["-h"]).trimmingLines(),
Simple.helpText)
}
}
struct CustomHelp: ParsableCommand {
static let configuration = CommandConfiguration(
helpNames: [.customShort("?"), .customLong("show-help")]
)
}
extension HelpTests {
func testCustomHelpNames() {
let helpNames = [CustomHelp.self].getHelpNames(visibility: .default)
XCTAssertEqual(helpNames, [.short("?"), .long("show-help")])
let helpHiddenNames = [CustomHelp.self].getHelpNames(visibility: .hidden)
XCTAssertEqual(helpHiddenNames, [.long("show-help-hidden")])
AssertFullErrorMessage(CustomHelp.self, ["--error"], """
Error: Unknown option '--error'
Usage: custom-help
See 'custom-help --show-help' for more information.
""")
}
}
struct NoHelp: ParsableCommand {
static let configuration = CommandConfiguration(
helpNames: []
)
@Option(help: "How many florps?") var count: Int
}
extension HelpTests {
func testNoHelpNames() {
let helpNames = [NoHelp.self].getHelpNames(visibility: .default)
XCTAssertEqual(helpNames, [])
let helpHiddenNames = [NoHelp.self].getHelpNames(visibility: .hidden)
XCTAssertEqual(helpHiddenNames, [])
AssertFullErrorMessage(NoHelp.self, ["--error"], """
Error: Missing expected argument '--count <count>'
Help: --count <count> How many florps?
Usage: no-help --count <count>
""")
XCTAssertEqual(
NoHelp.message(for: CleanExit.helpRequest()).trimmingLines(),
"""
USAGE: no-help --count <count>
OPTIONS:
--count <count> How many florps?
""")
}
}
struct SubCommandCustomHelp: ParsableCommand {
static var configuration = CommandConfiguration (
helpNames: [.customShort("p"), .customLong("parent-help")]
)
struct InheritHelp: ParsableCommand {
}
struct ModifiedHelp: ParsableCommand {
static var configuration = CommandConfiguration (
helpNames: [.customShort("s"), .customLong("subcommand-help")]
)
struct InheritImmediateParentdHelp: ParsableCommand {
}
}
}
extension HelpTests {
func testSubCommandInheritHelpNames() {
let names = [
SubCommandCustomHelp.self,
SubCommandCustomHelp.InheritHelp.self,
].getHelpNames(visibility: .default)
XCTAssertEqual(names, [.short("p"), .long("parent-help")])
}
func testSubCommandCustomHelpNames() {
let names = [
SubCommandCustomHelp.self,
SubCommandCustomHelp.ModifiedHelp.self
].getHelpNames(visibility: .default)
XCTAssertEqual(names, [.short("s"), .long("subcommand-help")])
}
func testInheritImmediateParentHelpNames() {
let names = [
SubCommandCustomHelp.self,
SubCommandCustomHelp.ModifiedHelp.self,
SubCommandCustomHelp.ModifiedHelp.InheritImmediateParentdHelp.self
].getHelpNames(visibility: .default)
XCTAssertEqual(names, [.short("s"), .long("subcommand-help")])
}
}
|
