Regression test `println!()` panic message on `ErrorKind::BrokenPipe` #108980

Enselic · 2023-03-10T12:12:31Z

No existing test (that I could find) failed if the panic!() of the println!() family of functions was removed, or if its message was changed:

rust/library/std/src/io/stdio.rs

Lines 1007 to 1009 in 104f430

    
           if let Err(e) = global_s().write_fmt(args) { 
        
               panic!("failed printing to {label}: {e}"); 
        
           }

So add such a test.

This is in preparation of adding a hint about the existence of unix_sigpipe if that is the reason for the panic.

Even if we don't end up adding a hint, this is still a sensible test to have, I think.

@rustbot label +A-testsuite +A-io +T-libs +O-unix

rustbot · 2023-03-10T12:12:39Z

r? @jackh726

(rustbot has picked a reviewer for you, use r? to override)

Enselic · 2023-03-10T12:15:57Z

I'm pretty sure T-libs is more appropriate for this PR than T-compiler.

@rustbot label -T-compiler

r? T-libs

rustbot · 2023-03-10T12:16:00Z

Failed to set assignee to T-libs: invalid assignee

Note: Only org members, users with write permissions, or people who have commented on the PR may be assigned.

tests/ui/process/println-and-broken-pipe.run.stderr

Noratrieb · 2023-03-10T14:10:23Z

r? libs

Enselic · 2023-03-10T15:15:00Z

CI passed and the code and its output looks good to me. This is ready for review.

@rustbot ready

@rustbot label -A-testsuite

Enselic · 2023-04-30T19:25:34Z

@joshtriplett Friendly 7-week review ping. There is no urgency to review this; I just want to double-check that this PR has not gone under your radar :)

Elevator pitch for this PR: I want to make the println!() panic message on BrokenPipe suggest the use of unix_sigpipe. But before I make any changes I want there to be a regression test in place for the current behavior. This PR is that regression test.

tgross35

LGTM, thorough test

workingjubilee · 2023-07-26T05:58:50Z

@bors r+ rollup=always

bors · 2023-07-26T05:58:52Z

📌 Commit 4dc5e61 has been approved by workingjubilee

It is now in the queue for this repository.

workingjubilee · 2023-07-26T05:59:10Z

or: looks good to me.
r? @workingjubilee

…=workingjubilee Regression test `println!()` panic message on `ErrorKind::BrokenPipe` No existing test (that I could find) failed if the `panic!()` of the `println!()` family of functions was removed, or if its message was changed: https://github.com/rust-lang/rust/blob/104f4300cfddbd956e32820ef202a732f06ec848/library/std/src/io/stdio.rs#L1007-L1009 So add such a test. This is in preparation of adding a hint about the existence of [`unix_sigpipe`](rust-lang#97889) if that is the reason for the panic. Even if we don't end up adding a hint, this is still a sensible test to have, I think. `@rustbot` label +A-testsuite +A-io +T-libs +O-unix

No existing test failed if the [`panic!()`][1] of the `println!()` family of functions was removed, or if its message was changed. So add such a test. [1] https://github.com/rust-lang/rust/blob/104f4300cfddbd956e32820ef202a732f06ec848/library/std/src/io/stdio.rs#L1007-L1009

Enselic · 2023-07-26T11:47:03Z

@workingjubilee I pushed a fix for the CI failure. I had to add .env("RUST_BACKTRACE", "0") to the test child process. I could reproduce the CI failure locally with RUST_BACKTRACE=1 ./x test --force-rerun tests/ui/process/println-with-broken-pipe.rs and this fix worked locally, so will probably also work in bors CI.

workingjubilee · 2023-07-26T18:21:10Z

Thank you for being so quick to look into that! I am going to give this a slightly closer look to verify before r+ing again.

workingjubilee · 2023-07-27T20:46:46Z

tests/ui/process/println-with-broken-pipe.rs

+    let mut args = env::args();
+    let me = args.next().unwrap();


workingjubilee · 2023-07-27T20:46:56Z

tests/ui/process/println-with-broken-pipe.rs

+
+    // Set up a pipeline with a short-lived consumer and wait for it to finish.
+    // This will produce the `println!()` panic message on stderr.
+    let mut producer = Command::new(&me)


Extremely cute.

workingjubilee · 2023-07-27T20:47:45Z

@bors r+

bors · 2023-07-27T20:47:47Z

📌 Commit 075a6bb has been approved by workingjubilee

It is now in the queue for this repository.

workingjubilee · 2023-07-27T20:48:50Z

I feel confident this will pass CI this time, however,
@bors rollup=iffy

bors · 2023-07-27T23:33:03Z

⌛ Testing commit 075a6bb with merge 6cacb52...

bors · 2023-07-28T01:21:21Z

☀️ Test successful - checks-actions
Approved by: workingjubilee
Pushing 6cacb52 to master...

rust-timer · 2023-07-28T12:41:42Z

Finished benchmarking commit (6cacb52): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-3.1%	[-3.1%, -3.1%]	1
All ❌✅ (primary)	-	-	0

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-7.4%	[-8.0%, -6.7%]	5
All ❌✅ (primary)	-	-	0

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 654.841s -> 652.994s (-0.28%)

rustbot assigned jackh726 Mar 10, 2023

rustbot removed the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Mar 10, 2023

Enselic commented Mar 10, 2023

View reviewed changes

tests/ui/process/println-and-broken-pipe.run.stderr Outdated Show resolved Hide resolved

Enselic mentioned this pull request Mar 10, 2023

Tracking Issue for unix_sigpipe #97889

Open

23 tasks

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 10, 2023

rustbot assigned joshtriplett and unassigned jackh726 Mar 10, 2023

Enselic force-pushed the println-and-broken-pipe branch from 678aa27 to 4dc5e61 Compare March 10, 2023 14:29

tgross35 approved these changes Jul 14, 2023

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 26, 2023

rustbot assigned workingjubilee and unassigned joshtriplett Jul 26, 2023

workingjubilee mentioned this pull request Jul 26, 2023

Rollup of 5 pull requests #114085

Closed

Enselic force-pushed the println-and-broken-pipe branch from 4dc5e61 to 075a6bb Compare July 26, 2023 11:44

workingjubilee approved these changes Jul 27, 2023

View reviewed changes

bors added the merged-by-bors This PR was explicitly merged by bors. label Jul 28, 2023

bors merged commit 6cacb52 into rust-lang:master Jul 28, 2023

rustbot added this to the 1.73.0 milestone Jul 28, 2023

Enselic deleted the println-and-broken-pipe branch October 7, 2023 16:42

matthiaskrgr mentioned this pull request Feb 11, 2024

ICE: const parameter types cannot be generic #120941

Closed

	if let Err(e) = global_s().write_fmt(args) {
	panic!("failed printing to {label}: {e}");
	}

Regression test println!() panic message on ErrorKind::BrokenPipe #108980

Regression test println!() panic message on ErrorKind::BrokenPipe #108980

Uh oh!

Conversation

Enselic commented Mar 10, 2023

Uh oh!

rustbot commented Mar 10, 2023

Uh oh!

Enselic commented Mar 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Mar 10, 2023

Uh oh!

Uh oh!

Noratrieb commented Mar 10, 2023

Uh oh!

Enselic commented Mar 10, 2023

Uh oh!

Enselic commented Apr 30, 2023

Uh oh!

tgross35 left a comment

Choose a reason for hiding this comment

Uh oh!

workingjubilee commented Jul 26, 2023

Uh oh!

bors commented Jul 26, 2023

Uh oh!

workingjubilee commented Jul 26, 2023

Uh oh!

Enselic commented Jul 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

workingjubilee commented Jul 26, 2023

Uh oh!

workingjubilee Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

workingjubilee Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

workingjubilee commented Jul 27, 2023

Uh oh!

bors commented Jul 27, 2023

Uh oh!

workingjubilee commented Jul 27, 2023

Uh oh!

bors commented Jul 27, 2023

Uh oh!

bors commented Jul 28, 2023

Uh oh!

rust-timer commented Jul 28, 2023

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Uh oh!

Uh oh!

Regression test `println!()` panic message on `ErrorKind::BrokenPipe` #108980

Regression test `println!()` panic message on `ErrorKind::BrokenPipe` #108980

Enselic commented Mar 10, 2023 •

edited

Loading

Enselic commented Jul 26, 2023 •

edited

Loading