Tests: Exercise output and diagnostic messages from command plugins #7254
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
…mand plugins This test exercises command plugin console output under different verbosity settings: * a stub plugin prints to standard output or sends diagnostic output depending on its arguments * a test uses the stub to generate outputs and checks what `swift package` prints to the console at different verbosity levels
MaxDesiatov
added
plugins
test suite
|
@swift-ci test |
MaxDesiatov
pushed a commit
that referenced
this pull request
Jan 26, 2024
…ild (#7255) This commit adds the option for a build run on behalf of a command plugin to echo logs to the console as they are produced, in addition to the current behaviour of accumulating them in a buffer. Console echoing is turned off by default. ### Motivation: When a plugin asks for a target to be built by calling `packageManager.build`, SwiftPM accumulates the build log in a buffer and returns the whole log when the build completes. No feedback is printed on the console while the build is running, so if the target is large the user can't tell whether the build is making progress or is stuck. ### Modifications: * Added `TeeOutputByteStream`, an `OutputByteStream` which copies its inputs to a set of output streams * Added an `echoLogs` parameter to `packageManager.build`, defaulting to `false` to match the current behaviour. * Added a test to verify that logs are echoed and the existing log accumulation continues to work. ### Result: A command plugin can ask for build outputs to be echoed as they are produced. The user will have some feedback that a build is happening, rather than the long pause which can happen now. This change depends on #7254.
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 test exercises command plugin console output under different verbosity settings:
Motivation:
There doesn't seem to be a test which checks the handling of diagnostic messages from command plugins in a once place. This test will help to avoid regressions in this area.
Modifications:
swift packageprints to the console at different verbosity levelsResult:
This test verifies existing functionality. No change in Swift Package Manager.