Add Help Printing to XCTest executables #286
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@swift-ci please test |
stmontgomery
reviewed
Oct 2, 2019
There was a problem hiding this comment.
Thanks for this improvement! I have just a few small suggestions below. CC @briancroom
| @@ -87,6 +87,33 @@ public func XCTMain(_ testCases: [XCTestCaseEntry]) -> Never { | |||
| case .list(type: .json): | |||
| TestListing(testSuite: rootTestSuite).printTestJSON() | |||
| exit(0) | |||
| case let .help(invalidOption): | |||
| if let invalid = invalidOption { | |||
| print("Error: Invalid option \"\(invalid)\"\n") | |||
There was a problem hiding this comment.
Could this print be output to stderr instead of stdout?
There was a problem hiding this comment.
Makes sense to me... but is there an easier way to print to stderr than what I could figure out?
- Provides usage and examples on --help, -h, or and invalid option
- Examples are customized based on the tests contained in the executable
and the executable name
For example, for Foundation's TestFoundation:
```
> TestFoundation --invalid
Error: Invalid option "--invalid"
Usage: TestFoundation.exe [OPTION]
TestFoundation.exe [TESTCASE]
Run and report results of test cases.
With no OPTION or TESTCASE, runs all test cases.
-h, --help Print this help message
-l, --list-test List tests line by line to standard output
--dump-tests-json List tests in JSON to standard output
Examples:
Run a single test
> TestFoundation.exe TestFoundation.TestAffineTransform/test_BasicConstruction
Run all the tests in TestFoundation.TestAffineTransform
> TestFoundation.exe TestFoundation.TestAffineTransform
```
|
@swift-ci please test |
|
Two week reminder ping :) cc @stmontgomery |
briancroom
approved these changes
Oct 26, 2019
There was a problem hiding this comment.
Sorry for the delay here @gmittert. This looks great to me! Thanks for this contribution.
|
@swift-ci please test |
stmontgomery
approved these changes
Oct 26, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
and the executable name
For example, for Foundation's TestFoundation: