Merge pull request #328 from kirtchev-adacore/wip/issue-326-escape-backslashes-on-windows

JSON emitter: escape backslashes on Windows

Author: oli-obk

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+* the JSON output now properly escapes backslashes on Windows
+
 ### Changed
 
 ### Removed

src/status_emitter/json.rs

@@ -13,54 +13,67 @@ use bstr::ByteSlice;
 
 // MAINTENANCE REGION START
 
-// When integrating with a new libtest version, update all emit_xxx functions.
+// When integrating with a new libtest version, update all xxx_event functions.
 
-fn emit_suite_end(failed: usize, filtered_out: usize, ignored: usize, passed: usize, status: &str) {
+fn suite_end_event(
+    failed: usize,
+    filtered_out: usize,
+    ignored: usize,
+    passed: usize,
+    status: &str,
+) -> String {
     // Adapted from test::formatters::json::write_run_finish().
-    println!(
+    format!(
         r#"{{ "type": "suite", "event": "{status}", "passed": {passed}, "failed": {failed}, "ignored": {ignored}, "measured": 0, "filtered_out": {filtered_out} }}"#
-    );
+    )
 }
 
-fn emit_suite_start() {
+fn suite_start_event() -> String {
     // Adapted from test::formatters::json::write_run_start().
-    println!(r#"{{ "type": "suite", "event": "started" }}"#);
+    String::from(r#"{ "type": "suite", "event": "started" }"#)
 }
 
-fn emit_test_end(name: &String, revision: &String, path: &Path, status: &str, diags: &str) {
-    let displayed_path = path.display();
-    let stdout = if diags.is_empty() {
-        String::new()
-    } else {
-        let triaged_diags = serde_json::to_string(diags).unwrap();
-        format!(r#", "stdout": {triaged_diags}"#)
-    };
+fn test_end_event(name: &str, revision: &str, path: &Path, status: &str, diags: &str) -> String {
+    let name_attribute = make_name_attribute(name, revision, path);
+    let stdout_attribute = make_stdout_attribute(diags);
 
     // Adapted from test::formatters::json::write_event().
-    println!(
-        r#"{{ "type": "test", "event": "{status}", "name": "{name} ({revision}) - {displayed_path}"{stdout} }}"#
-    );
+    format!(r#"{{ "type": "test", "event": "{status}"{name_attribute}{stdout_attribute} }}"#)
 }
 
-fn emit_test_start(name: &String, revision: &String, path: &Path) {
-    let displayed_path = path.display();
+fn test_start_event(name: &str, revision: &str, path: &Path) -> String {
+    let name_attribute = make_name_attribute(name, revision, path);
 
     // Adapted from test::formatters::json::write_test_start().
-    println!(
-        r#"{{ "type": "test", "event": "started", "name": "{name} ({revision}) - {displayed_path}" }}"#
-    );
+    format!(r#"{{ "type": "test", "event": "started"{name_attribute} }}"#)
 }
 
 // MAINTENANCE REGION END
 
+fn make_name_attribute(name: &str, revision: &str, path: &Path) -> String {
+    let path_display = path.display();
+    let escaped_value =
+        serde_json::to_string(&format!("{name} ({revision}) - {path_display}")).unwrap();
+    format!(r#", "name": {escaped_value}"#)
+}
+
+fn make_stdout_attribute(diags: &str) -> String {
+    if diags.is_empty() {
+        String::new()
+    } else {
+        let escaped_diags = serde_json::to_string(diags).unwrap();
+        format!(r#", "stdout": {escaped_diags}"#)
+    }
+}
+
 /// A JSON output emitter.
 #[derive(Clone)]
 pub struct JSON {}
 
 impl JSON {
     /// Create a new instance of a JSON output emitter.
     pub fn new() -> Self {
-        emit_suite_start();
+        println!("{}", suite_start_event());
 
         JSON {}
     }
@@ -88,7 +101,10 @@ impl StatusEmitter for JSON {
             "ok"
         };
 
-        emit_suite_end(failed, filtered, ignored, succeeded, status);
+        println!(
+            "{}",
+            suite_end_event(failed, filtered, ignored, succeeded, status)
+        );
 
         Box::new(())
     }
@@ -99,7 +115,7 @@ impl StatusEmitter for JSON {
         let name = path.to_str().unwrap().to_string();
         let revision = String::new();
 
-        emit_test_start(&name, &revision, &path);
+        println!("{}", test_start_event(&name, &revision, &path));
 
         Box::new(JSONStatus {
             name,
@@ -140,7 +156,10 @@ impl TestStatus for JSONStatus {
             String::new()
         };
 
-        emit_test_end(&self.name, &self.revision, self.path(), status, &diags);
+        println!(
+            "{}",
+            test_end_event(&self.name, &self.revision, self.path(), status, &diags)
+        );
     }
 
     /// Invoked before each failed test prints its errors along with a drop guard that can
@@ -186,3 +205,79 @@ impl TestStatus for JSONStatus {
         &self.revision
     }
 }
+
+#[test]
+fn suite_end_event_constructs_event() {
+    assert_eq!(
+        suite_end_event(
+            12, // failed
+            34, // filtered_out
+            56, // ignored
+            78, // passed
+            "status"
+        ),
+        r#"{ "type": "suite", "event": "status", "passed": 78, "failed": 12, "ignored": 56, "measured": 0, "filtered_out": 34 }"#
+    );
+}
+
+#[test]
+fn suite_start_event_constructs_event() {
+    assert_eq!(
+        suite_start_event(),
+        r#"{ "type": "suite", "event": "started" }"#
+    );
+}
+
+#[test]
+fn test_end_event_constructs_event() {
+    assert_eq!(
+        test_end_event("name", "revision", Path::new("aaa/bbb"), "status", "diags"),
+        r#"{ "type": "test", "event": "status", "name": "name (revision) - aaa/bbb", "stdout": "diags" }"#
+    );
+}
+
+#[test]
+fn test_end_event_constructs_event_with_escapes() {
+    assert_eq!(
+        test_end_event(
+            r#"aaa\bbb"#,
+            r#"ccc ddd\eee"#,
+            Path::new(r#"fff\ggg"#),
+            "status",
+            r#""rustc" "--error-format=json""#
+        ),
+        r#"{ "type": "test", "event": "status", "name": "aaa\\bbb (ccc ddd\\eee) - fff\\ggg", "stdout": "\"rustc\" \"--error-format=json\"" }"#
+    );
+}
+
+#[test]
+fn test_end_event_constructs_event_without_revision() {
+    assert_eq!(
+        test_end_event("name", "", Path::new("aaa/bbb"), "status", "diags"),
+        r#"{ "type": "test", "event": "status", "name": "name () - aaa/bbb", "stdout": "diags" }"#
+    );
+}
+
+#[test]
+fn test_end_event_constructs_event_without_stdout() {
+    assert_eq!(
+        test_end_event("name", "revision", Path::new("aaa/bbb"), "status", ""),
+        r#"{ "type": "test", "event": "status", "name": "name (revision) - aaa/bbb" }"#
+    );
+}
+
+#[test]
+fn test_start_event_constructs_event() {
+    assert_eq!(
+        test_start_event("name", "revision", Path::new("aaa/bbb")),
+        r#"{ "type": "test", "event": "started", "name": "name (revision) - aaa/bbb" }"#
+    );
+}
+
+#[test]
+fn test_start_event_constructs_event_with_escapes() {
+    assert_eq!(
+        test_start_event(r#"aaa\bbb"#, r#"ccc ddd\eee"#, Path::new(r#"fff\ggg"#)),
+        r#"{ "type": "test", "event": "started", "name": "aaa\\bbb (ccc ddd\\eee) - fff\\ggg" }"#
+    );
+}