Report span of test when should_panic test failed

Signed-off-by: xizheyin <[email protected]>

Author: xizheyin

library/test/src/test_result.rs

@@ -45,6 +45,18 @@ pub(crate) fn calc_result<'a>(
     time_opts: Option<&time::TestTimeOptions>,
     exec_time: Option<&time::TestExecTime>,
 ) -> TestResult {
+    let span_str = if desc.source_file != "" {
+        format!(" at {}:{}:{}", desc.source_file, desc.start_line, desc.start_col)
+    } else {
+        "".to_string()
+    };
+
+    let span_should_panic_with_message_didnot_panic = if desc.source_file != "" {
+        format!("should panic with message{}\n      ", span_str)
+    } else {
+        "".to_string()
+    };
+
     let result = match (&desc.should_panic, task_result) {
         (&ShouldPanic::No, Ok(())) | (&ShouldPanic::Yes, Err(_)) => TestResult::TrOk,
         (&ShouldPanic::YesWithMessage(msg), Err(err)) => {
@@ -57,22 +69,22 @@ pub(crate) fn calc_result<'a>(
                 TestResult::TrOk
             } else if let Some(panic_str) = maybe_panic_str {
                 TestResult::TrFailedMsg(format!(
-                    r#"panic did not contain expected string
+                    r#"{span_should_panic_with_message_didnot_panic}panic did not contain expected string
       panic message: `{panic_str:?}`,
- expected substring: `{msg:?}`"#
+      expected substring: `{msg:?}`"#
                 ))
             } else {
                 TestResult::TrFailedMsg(format!(
-                    r#"expected panic with string value,
- found non-string value: `{:?}`
-     expected substring: `{:?}`"#,
+                    r#"{span_should_panic_with_message_didnot_panic}expected panic with string value,
+      found non-string value: `{:?}`
+      expected substring: `{:?}`"#,
                     (*err).type_id(),
                     msg
                 ))
             }
         }
         (&ShouldPanic::Yes, Ok(())) | (&ShouldPanic::YesWithMessage(_), Ok(())) => {
-            TestResult::TrFailedMsg("test did not panic as expected".to_string())
+            TestResult::TrFailedMsg(format!("test did not panic as expected{}", span_str))
         }
         _ => TestResult::TrFailed,
     };

library/test/src/tests.rs

@@ -201,7 +201,7 @@ fn test_should_panic_bad_message() {
     let expected = "foobar";
     let failed_msg = r#"panic did not contain expected string
       panic message: `"an error message"`,
- expected substring: `"foobar"`"#;
+      expected substring: `"foobar"`"#;
     let desc = TestDescAndFn {
         desc: TestDesc {
             name: StaticTestName("whatever"),
@@ -237,8 +237,8 @@ fn test_should_panic_non_string_message_type() {
     let expected = "foobar";
     let failed_msg = format!(
         r#"expected panic with string value,
- found non-string value: `{:?}`
-     expected substring: `"foobar"`"#,
+      found non-string value: `{:?}`
+      expected substring: `"foobar"`"#,
         TypeId::of::<i32>()
     );
     let desc = TestDescAndFn {

tests/ui/test-should-panic-failed-show-span.rs

@@ -0,0 +1,41 @@
+//@ run-fail
+//@ check-run-results
+//@ compile-flags: --test
+//@ run-flags: --test-threads=1
+
+#[test]
+#[should_panic]
+fn should_panic_with_any_message() {
+    panic!("Panic!");
+}
+
+#[test]
+#[should_panic = "message"]
+fn should_panic_with_message() {
+    panic!("message");
+}
+
+#[test]
+#[should_panic]
+fn should_panic_with_any_message_does_not_panic() {
+    // DON'T PANIC
+}
+
+
+#[test]
+#[should_panic = "message"]
+fn should_panic_with_message_does_not_panic() {
+    // DON'T PANIC
+}
+
+#[test]
+#[should_panic = "message"]
+fn should_panic_with_substring_panics_with_incorrect_string() {
+    panic!("ZOMGWTFBBQ");
+}
+
+#[test]
+#[should_panic = "message"]
+fn should_panic_with_substring_panics_with_non_string_value() {
+    panic!(123); //~ WARNING panic message is not a string literal
+}

tests/ui/test-should-panic-failed-show-span.run.stdout

@@ -0,0 +1,40 @@
+
+running 6 tests
+test should_panic_with_any_message - should panic ... ok
+test should_panic_with_any_message_does_not_panic - should panic ... FAILED
+test should_panic_with_message - should panic ... ok
+test should_panic_with_message_does_not_panic - should panic ... FAILED
+test should_panic_with_substring_panics_with_incorrect_string - should panic ... FAILED
+test should_panic_with_substring_panics_with_non_string_value - should panic ... FAILED
+
+failures:
+
+---- should_panic_with_any_message_does_not_panic stdout ----
+note: test did not panic as expected at $DIR/test-should-panic-failed-show-span.rs:20:4
+---- should_panic_with_message_does_not_panic stdout ----
+note: test did not panic as expected at $DIR/test-should-panic-failed-show-span.rs:27:4
+---- should_panic_with_substring_panics_with_incorrect_string stdout ----
+
+thread 'should_panic_with_substring_panics_with_incorrect_string' panicked at $DIR/test-should-panic-failed-show-span.rs:34:5:
+ZOMGWTFBBQ
+note: should panic with message at $DIR/test-should-panic-failed-show-span.rs:33:4
+      panic did not contain expected string
+      panic message: `"ZOMGWTFBBQ"`,
+      expected substring: `"message"`
+---- should_panic_with_substring_panics_with_non_string_value stdout ----
+
+thread 'should_panic_with_substring_panics_with_non_string_value' panicked at $DIR/test-should-panic-failed-show-span.rs:40:5:
+Box<dyn Any>
+note: should panic with message at $DIR/test-should-panic-failed-show-span.rs:39:4
+      expected panic with string value,
+      found non-string value: `TypeId(0x56ced5e4a15bd89050bb9674fa2df013)`
+      expected substring: `"message"`
+
+failures:
+    should_panic_with_any_message_does_not_panic
+    should_panic_with_message_does_not_panic
+    should_panic_with_substring_panics_with_incorrect_string
+    should_panic_with_substring_panics_with_non_string_value
+
+test result: FAILED. 2 passed; 4 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+

tests/ui/test-should-panic-failed-show-span.stderr

@@ -0,0 +1,21 @@
+warning: panic message is not a string literal
+  --> $DIR/test-should-panic-failed-show-span.rs:40:12
+   |
+LL |     panic!(123);
+   |            ^^^
+   |
+   = note: this usage of `panic!()` is deprecated; it will be a hard error in Rust 2021
+   = note: for more information, see <https://doc.rust-lang.org/nightly/edition-guide/rust-2021/panic-macro-consistency.html>
+   = note: `#[warn(non_fmt_panics)]` on by default
+help: add a "{}" format string to `Display` the message
+   |
+LL |     panic!("{}", 123);
+   |            +++++
+help: or use std::panic::panic_any instead
+   |
+LL -     panic!(123);
+LL +     std::panic::panic_any(123);
+   |
+
+warning: 1 warning emitted
+