enable streaming of integration test output #21912
Conversation
There was a problem hiding this comment.
Just confirming: this is designed to be used in an adhoc way? For instance: someone is working on a specific feature with a particular integration test of interest, so they temporarily turn stream_output=True on while iterating.
If so, sounds cool!
It might be nifty to document "permanently" too, in addition to the "transient" mention in release notes (likely only seen by someone upgrading to 2.25). Maybe https://www.pantsbuild.org/stable/docs/writing-plugins/the-rules-api/testing-plugins#approach-4-run_pants-integration-tests-for-pants is a good place to mention it too?
The code looks fine, and the release note paragraph seems fine as is (my suggestions are optional), plus it seems like it only needs light edits to be sensible as long-term docs... so approved conditional on copying that somewhere sensible more permanent!
Co-authored-by: Huon Wilson <wilson.huon@gmail.com>
Add support to the Pants integration test framework to stream output to the console. This is very useful when debugging long-running integration tests which would otherwise show no output while they run since the integration test framework currently only captures output to a buffer.
Adds a
stream_outputparameter toPantsJoinHandle.join,run_pants_with_workdir, andrun_pants. Enablestream_output=Trueon a specific invocation ofrun_pants_with_workdirandrun_pants, and then run the test with--debugso the test is invoked as an interactive process.