-
Notifications
You must be signed in to change notification settings - Fork 109
Add support for collecting stdout
and stderr
in an exit test.
#773
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.
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
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 test |
1 similar comment
@swift-ci test |
grynspan
commented
Oct 19, 2024
@swift-ci test |
0c5af7f
to
a7a8d00
Compare
@swift-ci test |
a7a8d00
to
555d59a
Compare
This PR adds `stdout` and `stderr` capture to exit tests. Gathering these streams can be very expensive, so they are _opt-in_. There is a new argument to `#expect(exitsWith:)`, `observedValues`, to which you can pass one or more key paths on `ExitTest.Result` to indicate which bits you want: ```swift let result = await #expect(exitsWith: .failure, observing: [\.standardOutputContent]) { print("Goodbye, world!") fatalError() } #expect(result.standardOutputContent.contains(UInt8(ascii: "G"))) ``` Some changes to pipes were needed to satisfy the compiler's concerns about `Pipe` being a move-only type that contains other move-only types—now it's just a function that returns two `FileHandle` instances. This is simpler anyway. It is possible some callers will want `stdout` and `stderr` to be set, but to something other than a pipe (such as a file on disk or a PTY.) While these are interesting cases, they are beyond the scope of this PR.
555d59a
to
1d3b1d4
Compare
@swift-ci test |
@swift-ci test |
@swift-ci test |
stmontgomery
approved these changes
Oct 22, 2024
stmontgomery
approved these changes
Oct 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
command-line experience
⌨️ enhancements to the command line interface
enhancement
New feature or request
exit-tests
☠️ Work related to exit tests
tools integration
🛠️ Integration of swift-testing into tools/IDEs
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.
This PR adds
stdout
andstderr
capture to exit tests.Gathering these streams can be very expensive, so they are opt-in. There is a new argument to
#expect(exitsWith:)
,observedValues
, to which you can pass one or more key paths onExitTest.Result
to indicate which bits you want:Some changes to pipes were needed to satisfy the compiler's concerns about
Pipe
being a move-only type that contains other move-only types—now it's just a function that returns twoFileHandle
instances. This is simpler anyway.It is possible some callers will want
stdout
andstderr
to be set, but to something other than a pipe (such as a file on disk or a PTY.) While these are interesting cases, they are beyond the scope of this PR.Checklist: