Merge pull request #453 from DerickEddington/report-print-prefix

Make `Report::report` print the "Error: " prefix
shepmaster · May 24, 2024 · cec2d01 · cec2d01
2 parents 36c6bbe + 53c4f63
commit cec2d01
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/src/report.rs b/src/report.rs
@@ -188,7 +188,7 @@ where
         match self.0 {
             Ok(()) => ExitCode::SUCCESS,
             Err(e) => {
-                eprintln!("{}", ReportFormatter(&e));
+                eprintln!("Error: {}", ReportFormatter(&e));
 
                 #[cfg(feature = "unstable-provider-api")]
                 {

diff --git a/tests/report.rs b/tests/report.rs
@@ -142,6 +142,22 @@ fn debug_and_display_are_the_same() {
     assert_eq!(display, debug);
 }
 
+/// `Report as Termination` prints-out the "Error:" prefix.  Ensure that `Report as Display` does
+/// not also add such a prefix, to avoid printing-out "Error: Error: ...".
+#[test]
+fn display_not_prefixed() {
+    #[derive(Debug, Snafu)]
+    #[snafu(display("This is my Display text!"))]
+    struct Error;
+
+    let r = Report::from_error(Error);
+    let msg = r.to_string();
+    let msg = msg.trim_start();
+
+    assert!(!msg.starts_with("Err"));
+    assert!(!msg.starts_with("err"));
+}
+
 #[test]
 fn procedural_macro_works_with_result_return_type() {
     #[derive(Debug, Snafu)]