src/libtest/formatters/json.rs

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