Add support for collecting stdout and stderr in an exit test.
#773
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
grynspan
added
enhancement
grynspan
requested review from
SeanROlszewski,
briancroom,
dennisweissmann,
stmontgomery and
suzannaratcliff
as code owners
Contributor
Author
|
@swift-ci test |
1 similar comment
Contributor
Author
|
@swift-ci test |
grynspan
commented
Oct 19, 2024
Contributor
Author
|
@swift-ci test |
3 similar comments
Contributor
Author
|
@swift-ci test |
Contributor
Author
|
@swift-ci test |
Contributor
Author
|
@swift-ci test |
grynspan
force-pushed
the
jgrynspan/child-process-stdio
branch
from
0c5af7f to
a7a8d00
Compare
Contributor
Author
|
@swift-ci test |
grynspan
force-pushed
the
jgrynspan/child-process-stdio
branch
from
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.
grynspan
force-pushed
the
jgrynspan/child-process-stdio
branch
from
555d59a to
1d3b1d4
Compare
Contributor
Author
|
@swift-ci test |
Contributor
Author
|
@swift-ci test |
Contributor
Author
|
@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
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
stdoutandstderrcapture 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.Resultto indicate which bits you want:Some changes to pipes were needed to satisfy the compiler's concerns about
Pipebeing a move-only type that contains other move-only types—now it's just a function that returns twoFileHandleinstances. This is simpler anyway.It is possible some callers will want
stdoutandstderrto 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: