Skip to content

Option parsing fixes when args have unexpected suffixes #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
owenv merged 1 commit into from
Nov 15, 2020
Merged

Option parsing fixes when args have unexpected suffixes #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions Sources/SwiftOptions/OptionParsing.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,13 @@ extension OptionTable {
index: index - 1, argument: argument)
}

// Make sure this option is supported by the current driver kind.
guard option.isAccepted(by: driverKind) else {
throw OptionParseError.unsupportedOption(
index: index - 1, argument: argument, option: option,
currentDriverKind: driverKind)
let verifyOptionIsAcceptedByDriverKind = {
// Make sure this option is supported by the current driver kind.
guard option.isAccepted(by: driverKind) else {
throw OptionParseError.unsupportedOption(
index: index - 1, argument: argument, option: option,
currentDriverKind: driverKind)
}
}

// Translate the argument
Expand All @@ -90,6 +92,7 @@ extension OptionTable {

case .commaJoined:
// Comma-separated list of arguments follows the option spelling.
try verifyOptionIsAcceptedByDriverKind()
let rest = argument.dropFirst(option.spelling.count)
parsedOptions.addOption(
option,
Expand All @@ -101,16 +104,19 @@ extension OptionTable {
throw OptionParseError.unknownOption(
index: index - 1, argument: argument)
}
try verifyOptionIsAcceptedByDriverKind()
parsedOptions.addOption(option, argument: .none)

case .joined:
// Argument text follows the option spelling.
try verifyOptionIsAcceptedByDriverKind()
parsedOptions.addOption(
option,
argument: .single(String(argument.dropFirst(option.spelling.count))))

case .joinedOrSeparate:
// Argument text follows the option spelling.
try verifyOptionIsAcceptedByDriverKind()
let arg = argument.dropFirst(option.spelling.count)
if !arg.isEmpty {
parsedOptions.addOption(option, argument: .single(String(arg)))
Expand All @@ -131,6 +137,12 @@ extension OptionTable {
index = arguments.endIndex

case .separate:
if argument != option.spelling {
throw OptionParseError.unknownOption(
index: index - 1, argument: argument)
}
try verifyOptionIsAcceptedByDriverKind()

if index == arguments.endIndex {
throw OptionParseError.missingArgument(
index: index - 1, argument: argument)
Expand Down
9 changes: 9 additions & 0 deletions Tests/SwiftOptionsTests/OptionParsingTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(error as? OptionParseError, .unknownOption(index: 0, argument: "-unrecognized"))
}

// Ensure we check for an unexpected suffix on flags before checking if they are accepted by the current mode.
XCTAssertThrowsError(try options.parse(["-c-NOT"], for: .interactive)) { error in
XCTAssertEqual(error as? OptionParseError, .unknownOption(index: 0, argument: "-c-NOT"))
}

XCTAssertThrowsError(try options.parse(["-module-name-NOT", "foo"], for: .batch)) { error in
XCTAssertEqual(error as? OptionParseError, .unknownOption(index: 0, argument: "-module-name-NOT"))
}

XCTAssertThrowsError(try options.parse(["-I"], for: .batch)) { error in
XCTAssertEqual(error as? OptionParseError, .missingArgument(index: 0, argument: "-I"))
}
Expand Down