src/libtest/formatters/json.rs

   1 use super::*;
   2
   3 pub(crate) struct JsonFormatter<T> {
   4     out: OutputLocation<T>,
   5 }
   6
   7 impl<T: Write> JsonFormatter<T> {
   8     pub fn new(out: OutputLocation<T>) -> Self {
   9         Self { out }
  10     }
  11
  12     fn writeln_message(&mut self, s: &str) -> io::Result<()> {
  13         assert!(!s.contains('\n'));
  14
  15         self.out.write_all(s.as_ref())?;
  16         self.out.write_all(b"\n")
  17     }
  18
  19     fn write_message(&mut self, s: &str) -> io::Result<()> {
  20         assert!(!s.contains('\n'));
  21
  22         self.out.write_all(s.as_ref())
  23     }
  24
  25     fn write_event(
  26         &mut self,
  27         ty: &str,
  28         name: &str,
  29         evt: &str,
  30         exec_time: Option<&TestExecTime>,
  31         stdout: Option<Cow<'_, str>>,
  32         extra: Option<&str>,
  33     ) -> io::Result<()> {
  34         self.write_message(&*format!(
  35             r#"{{ "type": "{}", "name": "{}", "event": "{}""#,
  36             ty, name, evt
  37         ))?;
  38         if let Some(exec_time) = exec_time {
  39             self.write_message(&*format!(
  40                 r#", "exec_time": "{}""#,
  41                 exec_time
  42             ))?;
  43         }
  44         if let Some(stdout) = stdout {
  45             self.write_message(&*format!(
  46                 r#", "stdout": "{}""#,
  47                 EscapedString(stdout)
  48             ))?;
  49         }
  50         if let Some(extra) = extra {
  51             self.write_message(&*format!(
  52                 r#", {}"#,
  53                 extra
  54             ))?;
  55         }
  56         self.writeln_message(" }")
  57     }
  58 }
  59
  60 impl<T: Write> OutputFormatter for JsonFormatter<T> {
  61     fn write_run_start(&mut self, test_count: usize) -> io::Result<()> {
  62         self.writeln_message(&*format!(
  63             r#"{{ "type": "suite", "event": "started", "test_count": {} }}"#,
  64             test_count
  65         ))
  66     }
  67
  68     fn write_test_start(&mut self, desc: &TestDesc) -> io::Result<()> {
  69         self.writeln_message(&*format!(
  70             r#"{{ "type": "test", "event": "started", "name": "{}" }}"#,
  71             desc.name
  72         ))
  73     }
  74
  75     fn write_result(
  76         &mut self,
  77         desc: &TestDesc,
  78         result: &TestResult,
  79         exec_time: Option<&TestExecTime>,
  80         stdout: &[u8],
  81         state: &ConsoleTestState,
  82     ) -> io::Result<()> {
  83         let stdout = if (state.options.display_output || *result != TrOk) && stdout.len() > 0 {
  84             Some(String::from_utf8_lossy(stdout))
  85         } else {
  86             None
  87         };
  88         match *result {
  89             TrOk => {
  90                 self.write_event("test", desc.name.as_slice(), "ok", exec_time, stdout, None)
  91             }
  92
  93             TrFailed => {
  94                 self.write_event("test", desc.name.as_slice(), "failed", exec_time, stdout, None)
  95             }
  96
  97             TrFailedMsg(ref m) => self.write_event(
  98                 "test",
  99                 desc.name.as_slice(),
 100                 "failed",
 101                 exec_time,
 102                 stdout,
 103                 Some(&*format!(r#""message": "{}""#, EscapedString(m))),
 104             ),
 105
 106             TrIgnored => {
 107                 self.write_event("test", desc.name.as_slice(), "ignored", exec_time, stdout, None)
 108             }
 109
 110             TrAllowedFail => self.write_event(
 111                 "test",
 112                 desc.name.as_slice(),
 113                 "allowed_failure",
 114                 exec_time,
 115                 stdout,
 116                 None,
 117             ),
 118
 119             TrBench(ref bs) => {
 120                 let median = bs.ns_iter_summ.median as usize;
 121                 let deviation = (bs.ns_iter_summ.max - bs.ns_iter_summ.min) as usize;
 122
 123                 let mbps = if bs.mb_s == 0 {
 124                     String::new()
 125                 } else {
 126                     format!(r#", "mib_per_second": {}"#, bs.mb_s)
 127                 };
 128
 129                 let line = format!(
 130                     "{{ \"type\": \"bench\", \
 131                      \"name\": \"{}\", \
 132                      \"median\": {}, \
 133                      \"deviation\": {}{} }}",
 134                     desc.name, median, deviation, mbps
 135                 );
 136
 137                 self.writeln_message(&*line)
 138             }
 139         }
 140     }
 141
 142     fn write_timeout(&mut self, desc: &TestDesc) -> io::Result<()> {
 143         self.writeln_message(&*format!(
 144             r#"{{ "type": "test", "event": "timeout", "name": "{}" }}"#,
 145             desc.name
 146         ))
 147     }
 148
 149     fn write_run_finish(&mut self, state: &ConsoleTestState) -> io::Result<bool> {
 150         self.writeln_message(&*format!(
 151             "{{ \"type\": \"suite\", \
 152              \"event\": \"{}\", \
 153              \"passed\": {}, \
 154              \"failed\": {}, \
 155              \"allowed_fail\": {}, \
 156              \"ignored\": {}, \
 157              \"measured\": {}, \
 158              \"filtered_out\": {} }}",
 159             if state.failed == 0 { "ok" } else { "failed" },
 160             state.passed,
 161             state.failed + state.allowed_fail,
 162             state.allowed_fail,
 163             state.ignored,
 164             state.measured,
 165             state.filtered_out
 166         ))?;
 167
 168         Ok(state.failed == 0)
 169     }
 170 }
 171
 172 /// A formatting utility used to print strings with characters in need of escaping.
 173 /// Base code taken form `libserialize::json::escape_str`
 174 struct EscapedString<S: AsRef<str>>(S);
 175
 176 impl<S: AsRef<str>> ::std::fmt::Display for EscapedString<S> {
 177     fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
 178         let mut start = 0;
 179
 180         for (i, byte) in self.0.as_ref().bytes().enumerate() {
 181             let escaped = match byte {
 182                 b'"' => "\\\"",
 183                 b'\\' => "\\\\",
 184                 b'\x00' => "\\u0000",
 185                 b'\x01' => "\\u0001",
 186                 b'\x02' => "\\u0002",
 187                 b'\x03' => "\\u0003",
 188                 b'\x04' => "\\u0004",
 189                 b'\x05' => "\\u0005",
 190                 b'\x06' => "\\u0006",
 191                 b'\x07' => "\\u0007",
 192                 b'\x08' => "\\b",
 193                 b'\t' => "\\t",
 194                 b'\n' => "\\n",
 195                 b'\x0b' => "\\u000b",
 196                 b'\x0c' => "\\f",
 197                 b'\r' => "\\r",
 198                 b'\x0e' => "\\u000e",
 199                 b'\x0f' => "\\u000f",
 200                 b'\x10' => "\\u0010",
 201                 b'\x11' => "\\u0011",
 202                 b'\x12' => "\\u0012",
 203                 b'\x13' => "\\u0013",
 204                 b'\x14' => "\\u0014",
 205                 b'\x15' => "\\u0015",
 206                 b'\x16' => "\\u0016",
 207                 b'\x17' => "\\u0017",
 208                 b'\x18' => "\\u0018",
 209                 b'\x19' => "\\u0019",
 210                 b'\x1a' => "\\u001a",
 211                 b'\x1b' => "\\u001b",
 212                 b'\x1c' => "\\u001c",
 213                 b'\x1d' => "\\u001d",
 214                 b'\x1e' => "\\u001e",
 215                 b'\x1f' => "\\u001f",
 216                 b'\x7f' => "\\u007f",
 217                 _ => {
 218                     continue;
 219                 }
 220             };
 221
 222             if start < i {
 223                 f.write_str(&self.0.as_ref()[start..i])?;
 224             }
 225
 226             f.write_str(escaped)?;
 227
 228             start = i + 1;
 229         }
 230
 231         if start != self.0.as_ref().len() {
 232             f.write_str(&self.0.as_ref()[start..])?;
 233         }
 234
 235         Ok(())
 236     }
 237 }