reporter_output_test.cc 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604
  1. #undef NDEBUG
  2. #include <utility>
  3. #include "benchmark/benchmark.h"
  4. #include "output_test.h"
  5. // ========================================================================= //
  6. // ---------------------- Testing Prologue Output -------------------------- //
  7. // ========================================================================= //
  8. ADD_CASES(TC_ConsoleOut, {{"^[-]+$", MR_Next},
  9. {"^Benchmark %s Time %s CPU %s Iterations$", MR_Next},
  10. {"^[-]+$", MR_Next}});
  11. static int AddContextCases() {
  12. AddCases(TC_ConsoleErr,
  13. {
  14. {"%int[-/]%int[-/]%int %int:%int:%int$", MR_Default},
  15. {"Running .*/reporter_output_test(\\.exe)?$", MR_Next},
  16. {"Run on \\(%int X %float MHz CPU s?\\)", MR_Next},
  17. });
  18. AddCases(TC_JSONOut,
  19. {{"^\\{", MR_Default},
  20. {"\"context\":", MR_Next},
  21. {"\"date\": \"", MR_Next},
  22. {"\"host_name\":", MR_Next},
  23. {"\"executable\": \".*(/|\\\\)reporter_output_test(\\.exe)?\",",
  24. MR_Next},
  25. {"\"num_cpus\": %int,$", MR_Next},
  26. {"\"mhz_per_cpu\": %float,$", MR_Next},
  27. {"\"cpu_scaling_enabled\": ", MR_Next},
  28. {"\"caches\": \\[$", MR_Next}});
  29. auto const& Info = benchmark::CPUInfo::Get();
  30. auto const& Caches = Info.caches;
  31. if (!Caches.empty()) {
  32. AddCases(TC_ConsoleErr, {{"CPU Caches:$", MR_Next}});
  33. }
  34. for (size_t I = 0; I < Caches.size(); ++I) {
  35. std::string num_caches_str =
  36. Caches[I].num_sharing != 0 ? " \\(x%int\\)$" : "$";
  37. AddCases(
  38. TC_ConsoleErr,
  39. {{"L%int (Data|Instruction|Unified) %intK" + num_caches_str, MR_Next}});
  40. AddCases(TC_JSONOut, {{"\\{$", MR_Next},
  41. {"\"type\": \"", MR_Next},
  42. {"\"level\": %int,$", MR_Next},
  43. {"\"size\": %int,$", MR_Next},
  44. {"\"num_sharing\": %int$", MR_Next},
  45. {"}[,]{0,1}$", MR_Next}});
  46. }
  47. AddCases(TC_JSONOut, {{"],$"}});
  48. auto const& LoadAvg = Info.load_avg;
  49. if (!LoadAvg.empty()) {
  50. AddCases(TC_ConsoleErr,
  51. {{"Load Average: (%float, ){0,2}%float$", MR_Next}});
  52. }
  53. AddCases(TC_JSONOut, {{"\"load_avg\": \\[(%float,?){0,3}],$", MR_Next}});
  54. return 0;
  55. }
  56. int dummy_register = AddContextCases();
  57. ADD_CASES(TC_CSVOut, {{"%csv_header"}});
  58. // ========================================================================= //
  59. // ------------------------ Testing Basic Output --------------------------- //
  60. // ========================================================================= //
  61. void BM_basic(benchmark::State& state) {
  62. for (auto _ : state) {
  63. }
  64. }
  65. BENCHMARK(BM_basic);
  66. ADD_CASES(TC_ConsoleOut, {{"^BM_basic %console_report$"}});
  67. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_basic\",$"},
  68. {"\"run_name\": \"BM_basic\",$", MR_Next},
  69. {"\"run_type\": \"iteration\",$", MR_Next},
  70. {"\"iterations\": %int,$", MR_Next},
  71. {"\"real_time\": %float,$", MR_Next},
  72. {"\"cpu_time\": %float,$", MR_Next},
  73. {"\"time_unit\": \"ns\"$", MR_Next},
  74. {"}", MR_Next}});
  75. ADD_CASES(TC_CSVOut, {{"^\"BM_basic\",%csv_report$"}});
  76. // ========================================================================= //
  77. // ------------------------ Testing Bytes per Second Output ---------------- //
  78. // ========================================================================= //
  79. void BM_bytes_per_second(benchmark::State& state) {
  80. for (auto _ : state) {
  81. }
  82. state.SetBytesProcessed(1);
  83. }
  84. BENCHMARK(BM_bytes_per_second);
  85. ADD_CASES(TC_ConsoleOut, {{"^BM_bytes_per_second %console_report "
  86. "bytes_per_second=%float[kM]{0,1}/s$"}});
  87. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_bytes_per_second\",$"},
  88. {"\"run_name\": \"BM_bytes_per_second\",$", MR_Next},
  89. {"\"run_type\": \"iteration\",$", MR_Next},
  90. {"\"iterations\": %int,$", MR_Next},
  91. {"\"real_time\": %float,$", MR_Next},
  92. {"\"cpu_time\": %float,$", MR_Next},
  93. {"\"time_unit\": \"ns\",$", MR_Next},
  94. {"\"bytes_per_second\": %float$", MR_Next},
  95. {"}", MR_Next}});
  96. ADD_CASES(TC_CSVOut, {{"^\"BM_bytes_per_second\",%csv_bytes_report$"}});
  97. // ========================================================================= //
  98. // ------------------------ Testing Items per Second Output ---------------- //
  99. // ========================================================================= //
  100. void BM_items_per_second(benchmark::State& state) {
  101. for (auto _ : state) {
  102. }
  103. state.SetItemsProcessed(1);
  104. }
  105. BENCHMARK(BM_items_per_second);
  106. ADD_CASES(TC_ConsoleOut, {{"^BM_items_per_second %console_report "
  107. "items_per_second=%float[kM]{0,1}/s$"}});
  108. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_items_per_second\",$"},
  109. {"\"run_name\": \"BM_items_per_second\",$", MR_Next},
  110. {"\"run_type\": \"iteration\",$", MR_Next},
  111. {"\"iterations\": %int,$", MR_Next},
  112. {"\"real_time\": %float,$", MR_Next},
  113. {"\"cpu_time\": %float,$", MR_Next},
  114. {"\"time_unit\": \"ns\",$", MR_Next},
  115. {"\"items_per_second\": %float$", MR_Next},
  116. {"}", MR_Next}});
  117. ADD_CASES(TC_CSVOut, {{"^\"BM_items_per_second\",%csv_items_report$"}});
  118. // ========================================================================= //
  119. // ------------------------ Testing Label Output --------------------------- //
  120. // ========================================================================= //
  121. void BM_label(benchmark::State& state) {
  122. for (auto _ : state) {
  123. }
  124. state.SetLabel("some label");
  125. }
  126. BENCHMARK(BM_label);
  127. ADD_CASES(TC_ConsoleOut, {{"^BM_label %console_report some label$"}});
  128. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_label\",$"},
  129. {"\"run_name\": \"BM_label\",$", MR_Next},
  130. {"\"run_type\": \"iteration\",$", MR_Next},
  131. {"\"iterations\": %int,$", MR_Next},
  132. {"\"real_time\": %float,$", MR_Next},
  133. {"\"cpu_time\": %float,$", MR_Next},
  134. {"\"time_unit\": \"ns\",$", MR_Next},
  135. {"\"label\": \"some label\"$", MR_Next},
  136. {"}", MR_Next}});
  137. ADD_CASES(TC_CSVOut, {{"^\"BM_label\",%csv_label_report_begin\"some "
  138. "label\"%csv_label_report_end$"}});
  139. // ========================================================================= //
  140. // ------------------------ Testing Error Output --------------------------- //
  141. // ========================================================================= //
  142. void BM_error(benchmark::State& state) {
  143. state.SkipWithError("message");
  144. for (auto _ : state) {
  145. }
  146. }
  147. BENCHMARK(BM_error);
  148. ADD_CASES(TC_ConsoleOut, {{"^BM_error[ ]+ERROR OCCURRED: 'message'$"}});
  149. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_error\",$"},
  150. {"\"run_name\": \"BM_error\",$", MR_Next},
  151. {"\"run_type\": \"iteration\",$", MR_Next},
  152. {"\"error_occurred\": true,$", MR_Next},
  153. {"\"error_message\": \"message\",$", MR_Next}});
  154. ADD_CASES(TC_CSVOut, {{"^\"BM_error\",,,,,,,,true,\"message\"$"}});
  155. // ========================================================================= //
  156. // ------------------------ Testing No Arg Name Output -----------------------
  157. // //
  158. // ========================================================================= //
  159. void BM_no_arg_name(benchmark::State& state) {
  160. for (auto _ : state) {
  161. }
  162. }
  163. BENCHMARK(BM_no_arg_name)->Arg(3);
  164. ADD_CASES(TC_ConsoleOut, {{"^BM_no_arg_name/3 %console_report$"}});
  165. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_no_arg_name/3\",$"},
  166. {"\"run_name\": \"BM_no_arg_name/3\",$", MR_Next},
  167. {"\"run_type\": \"iteration\",$", MR_Next}});
  168. ADD_CASES(TC_CSVOut, {{"^\"BM_no_arg_name/3\",%csv_report$"}});
  169. // ========================================================================= //
  170. // ------------------------ Testing Arg Name Output ----------------------- //
  171. // ========================================================================= //
  172. void BM_arg_name(benchmark::State& state) {
  173. for (auto _ : state) {
  174. }
  175. }
  176. BENCHMARK(BM_arg_name)->ArgName("first")->Arg(3);
  177. ADD_CASES(TC_ConsoleOut, {{"^BM_arg_name/first:3 %console_report$"}});
  178. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_arg_name/first:3\",$"},
  179. {"\"run_name\": \"BM_arg_name/first:3\",$", MR_Next},
  180. {"\"run_type\": \"iteration\",$", MR_Next}});
  181. ADD_CASES(TC_CSVOut, {{"^\"BM_arg_name/first:3\",%csv_report$"}});
  182. // ========================================================================= //
  183. // ------------------------ Testing Arg Names Output ----------------------- //
  184. // ========================================================================= //
  185. void BM_arg_names(benchmark::State& state) {
  186. for (auto _ : state) {
  187. }
  188. }
  189. BENCHMARK(BM_arg_names)->Args({2, 5, 4})->ArgNames({"first", "", "third"});
  190. ADD_CASES(TC_ConsoleOut,
  191. {{"^BM_arg_names/first:2/5/third:4 %console_report$"}});
  192. ADD_CASES(TC_JSONOut,
  193. {{"\"name\": \"BM_arg_names/first:2/5/third:4\",$"},
  194. {"\"run_name\": \"BM_arg_names/first:2/5/third:4\",$", MR_Next},
  195. {"\"run_type\": \"iteration\",$", MR_Next}});
  196. ADD_CASES(TC_CSVOut, {{"^\"BM_arg_names/first:2/5/third:4\",%csv_report$"}});
  197. // ========================================================================= //
  198. // ------------------------ Testing Big Args Output ------------------------ //
  199. // ========================================================================= //
  200. void BM_BigArgs(benchmark::State& state) {
  201. for (auto _ : state) {
  202. }
  203. }
  204. BENCHMARK(BM_BigArgs)->RangeMultiplier(2)->Range(1U << 30U, 1U << 31U);
  205. ADD_CASES(TC_ConsoleOut, {{"^BM_BigArgs/1073741824 %console_report$"},
  206. {"^BM_BigArgs/2147483648 %console_report$"}});
  207. // ========================================================================= //
  208. // ----------------------- Testing Complexity Output ----------------------- //
  209. // ========================================================================= //
  210. void BM_Complexity_O1(benchmark::State& state) {
  211. for (auto _ : state) {
  212. }
  213. state.SetComplexityN(state.range(0));
  214. }
  215. BENCHMARK(BM_Complexity_O1)->Range(1, 1 << 18)->Complexity(benchmark::o1);
  216. SET_SUBSTITUTIONS({{"%bigOStr", "[ ]* %float \\([0-9]+\\)"},
  217. {"%RMS", "[ ]*[0-9]+ %"}});
  218. ADD_CASES(TC_ConsoleOut, {{"^BM_Complexity_O1_BigO %bigOStr %bigOStr[ ]*$"},
  219. {"^BM_Complexity_O1_RMS %RMS %RMS[ ]*$"}});
  220. // ========================================================================= //
  221. // ----------------------- Testing Aggregate Output ------------------------ //
  222. // ========================================================================= //
  223. // Test that non-aggregate data is printed by default
  224. void BM_Repeat(benchmark::State& state) {
  225. for (auto _ : state) {
  226. }
  227. }
  228. // need two repetitions min to be able to output any aggregate output
  229. BENCHMARK(BM_Repeat)->Repetitions(2);
  230. ADD_CASES(TC_ConsoleOut,
  231. {{"^BM_Repeat/repeats:2 %console_report$"},
  232. {"^BM_Repeat/repeats:2 %console_report$"},
  233. {"^BM_Repeat/repeats:2_mean %console_time_only_report [ ]*2$"},
  234. {"^BM_Repeat/repeats:2_median %console_time_only_report [ ]*2$"},
  235. {"^BM_Repeat/repeats:2_stddev %console_time_only_report [ ]*2$"}});
  236. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_Repeat/repeats:2\",$"},
  237. {"\"run_name\": \"BM_Repeat/repeats:2\"", MR_Next},
  238. {"\"run_type\": \"iteration\",$", MR_Next},
  239. {"\"name\": \"BM_Repeat/repeats:2\",$"},
  240. {"\"run_name\": \"BM_Repeat/repeats:2\",$", MR_Next},
  241. {"\"run_type\": \"iteration\",$", MR_Next},
  242. {"\"name\": \"BM_Repeat/repeats:2_mean\",$"},
  243. {"\"run_name\": \"BM_Repeat/repeats:2\",$", MR_Next},
  244. {"\"run_type\": \"aggregate\",$", MR_Next},
  245. {"\"aggregate_name\": \"mean\",$", MR_Next},
  246. {"\"iterations\": 2,$", MR_Next},
  247. {"\"name\": \"BM_Repeat/repeats:2_median\",$"},
  248. {"\"run_name\": \"BM_Repeat/repeats:2\",$", MR_Next},
  249. {"\"run_type\": \"aggregate\",$", MR_Next},
  250. {"\"aggregate_name\": \"median\",$", MR_Next},
  251. {"\"iterations\": 2,$", MR_Next},
  252. {"\"name\": \"BM_Repeat/repeats:2_stddev\",$"},
  253. {"\"run_name\": \"BM_Repeat/repeats:2\",$", MR_Next},
  254. {"\"run_type\": \"aggregate\",$", MR_Next},
  255. {"\"aggregate_name\": \"stddev\",$", MR_Next},
  256. {"\"iterations\": 2,$", MR_Next}});
  257. ADD_CASES(TC_CSVOut, {{"^\"BM_Repeat/repeats:2\",%csv_report$"},
  258. {"^\"BM_Repeat/repeats:2\",%csv_report$"},
  259. {"^\"BM_Repeat/repeats:2_mean\",%csv_report$"},
  260. {"^\"BM_Repeat/repeats:2_median\",%csv_report$"},
  261. {"^\"BM_Repeat/repeats:2_stddev\",%csv_report$"}});
  262. // but for two repetitions, mean and median is the same, so let's repeat..
  263. BENCHMARK(BM_Repeat)->Repetitions(3);
  264. ADD_CASES(TC_ConsoleOut,
  265. {{"^BM_Repeat/repeats:3 %console_report$"},
  266. {"^BM_Repeat/repeats:3 %console_report$"},
  267. {"^BM_Repeat/repeats:3 %console_report$"},
  268. {"^BM_Repeat/repeats:3_mean %console_time_only_report [ ]*3$"},
  269. {"^BM_Repeat/repeats:3_median %console_time_only_report [ ]*3$"},
  270. {"^BM_Repeat/repeats:3_stddev %console_time_only_report [ ]*3$"}});
  271. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_Repeat/repeats:3\",$"},
  272. {"\"run_name\": \"BM_Repeat/repeats:3\",$", MR_Next},
  273. {"\"run_type\": \"iteration\",$", MR_Next},
  274. {"\"name\": \"BM_Repeat/repeats:3\",$"},
  275. {"\"run_name\": \"BM_Repeat/repeats:3\",$", MR_Next},
  276. {"\"run_type\": \"iteration\",$", MR_Next},
  277. {"\"name\": \"BM_Repeat/repeats:3\",$"},
  278. {"\"run_name\": \"BM_Repeat/repeats:3\",$", MR_Next},
  279. {"\"run_type\": \"iteration\",$", MR_Next},
  280. {"\"name\": \"BM_Repeat/repeats:3_mean\",$"},
  281. {"\"run_name\": \"BM_Repeat/repeats:3\",$", MR_Next},
  282. {"\"run_type\": \"aggregate\",$", MR_Next},
  283. {"\"aggregate_name\": \"mean\",$", MR_Next},
  284. {"\"iterations\": 3,$", MR_Next},
  285. {"\"name\": \"BM_Repeat/repeats:3_median\",$"},
  286. {"\"run_name\": \"BM_Repeat/repeats:3\",$", MR_Next},
  287. {"\"run_type\": \"aggregate\",$", MR_Next},
  288. {"\"aggregate_name\": \"median\",$", MR_Next},
  289. {"\"iterations\": 3,$", MR_Next},
  290. {"\"name\": \"BM_Repeat/repeats:3_stddev\",$"},
  291. {"\"run_name\": \"BM_Repeat/repeats:3\",$", MR_Next},
  292. {"\"run_type\": \"aggregate\",$", MR_Next},
  293. {"\"aggregate_name\": \"stddev\",$", MR_Next},
  294. {"\"iterations\": 3,$", MR_Next}});
  295. ADD_CASES(TC_CSVOut, {{"^\"BM_Repeat/repeats:3\",%csv_report$"},
  296. {"^\"BM_Repeat/repeats:3\",%csv_report$"},
  297. {"^\"BM_Repeat/repeats:3\",%csv_report$"},
  298. {"^\"BM_Repeat/repeats:3_mean\",%csv_report$"},
  299. {"^\"BM_Repeat/repeats:3_median\",%csv_report$"},
  300. {"^\"BM_Repeat/repeats:3_stddev\",%csv_report$"}});
  301. // median differs between even/odd number of repetitions, so just to be sure
  302. BENCHMARK(BM_Repeat)->Repetitions(4);
  303. ADD_CASES(TC_ConsoleOut,
  304. {{"^BM_Repeat/repeats:4 %console_report$"},
  305. {"^BM_Repeat/repeats:4 %console_report$"},
  306. {"^BM_Repeat/repeats:4 %console_report$"},
  307. {"^BM_Repeat/repeats:4 %console_report$"},
  308. {"^BM_Repeat/repeats:4_mean %console_time_only_report [ ]*4$"},
  309. {"^BM_Repeat/repeats:4_median %console_time_only_report [ ]*4$"},
  310. {"^BM_Repeat/repeats:4_stddev %console_time_only_report [ ]*4$"}});
  311. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_Repeat/repeats:4\",$"},
  312. {"\"run_name\": \"BM_Repeat/repeats:4\",$", MR_Next},
  313. {"\"run_type\": \"iteration\",$", MR_Next},
  314. {"\"name\": \"BM_Repeat/repeats:4\",$"},
  315. {"\"run_name\": \"BM_Repeat/repeats:4\",$", MR_Next},
  316. {"\"run_type\": \"iteration\",$", MR_Next},
  317. {"\"name\": \"BM_Repeat/repeats:4\",$"},
  318. {"\"run_name\": \"BM_Repeat/repeats:4\",$", MR_Next},
  319. {"\"run_type\": \"iteration\",$", MR_Next},
  320. {"\"name\": \"BM_Repeat/repeats:4\",$"},
  321. {"\"run_name\": \"BM_Repeat/repeats:4\",$", MR_Next},
  322. {"\"run_type\": \"iteration\",$", MR_Next},
  323. {"\"name\": \"BM_Repeat/repeats:4_mean\",$"},
  324. {"\"run_name\": \"BM_Repeat/repeats:4\",$", MR_Next},
  325. {"\"run_type\": \"aggregate\",$", MR_Next},
  326. {"\"aggregate_name\": \"mean\",$", MR_Next},
  327. {"\"iterations\": 4,$", MR_Next},
  328. {"\"name\": \"BM_Repeat/repeats:4_median\",$"},
  329. {"\"run_name\": \"BM_Repeat/repeats:4\",$", MR_Next},
  330. {"\"run_type\": \"aggregate\",$", MR_Next},
  331. {"\"aggregate_name\": \"median\",$", MR_Next},
  332. {"\"iterations\": 4,$", MR_Next},
  333. {"\"name\": \"BM_Repeat/repeats:4_stddev\",$"},
  334. {"\"run_name\": \"BM_Repeat/repeats:4\",$", MR_Next},
  335. {"\"run_type\": \"aggregate\",$", MR_Next},
  336. {"\"aggregate_name\": \"stddev\",$", MR_Next},
  337. {"\"iterations\": 4,$", MR_Next}});
  338. ADD_CASES(TC_CSVOut, {{"^\"BM_Repeat/repeats:4\",%csv_report$"},
  339. {"^\"BM_Repeat/repeats:4\",%csv_report$"},
  340. {"^\"BM_Repeat/repeats:4\",%csv_report$"},
  341. {"^\"BM_Repeat/repeats:4\",%csv_report$"},
  342. {"^\"BM_Repeat/repeats:4_mean\",%csv_report$"},
  343. {"^\"BM_Repeat/repeats:4_median\",%csv_report$"},
  344. {"^\"BM_Repeat/repeats:4_stddev\",%csv_report$"}});
  345. // Test that a non-repeated test still prints non-aggregate results even when
  346. // only-aggregate reports have been requested
  347. void BM_RepeatOnce(benchmark::State& state) {
  348. for (auto _ : state) {
  349. }
  350. }
  351. BENCHMARK(BM_RepeatOnce)->Repetitions(1)->ReportAggregatesOnly();
  352. ADD_CASES(TC_ConsoleOut, {{"^BM_RepeatOnce/repeats:1 %console_report$"}});
  353. ADD_CASES(TC_JSONOut, {{"\"name\": \"BM_RepeatOnce/repeats:1\",$"},
  354. {"\"run_name\": \"BM_RepeatOnce/repeats:1\",$", MR_Next},
  355. {"\"run_type\": \"iteration\",$", MR_Next}});
  356. ADD_CASES(TC_CSVOut, {{"^\"BM_RepeatOnce/repeats:1\",%csv_report$"}});
  357. // Test that non-aggregate data is not reported
  358. void BM_SummaryRepeat(benchmark::State& state) {
  359. for (auto _ : state) {
  360. }
  361. }
  362. BENCHMARK(BM_SummaryRepeat)->Repetitions(3)->ReportAggregatesOnly();
  363. ADD_CASES(
  364. TC_ConsoleOut,
  365. {{".*BM_SummaryRepeat/repeats:3 ", MR_Not},
  366. {"^BM_SummaryRepeat/repeats:3_mean %console_time_only_report [ ]*3$"},
  367. {"^BM_SummaryRepeat/repeats:3_median %console_time_only_report [ ]*3$"},
  368. {"^BM_SummaryRepeat/repeats:3_stddev %console_time_only_report [ ]*3$"}});
  369. ADD_CASES(TC_JSONOut,
  370. {{".*BM_SummaryRepeat/repeats:3 ", MR_Not},
  371. {"\"name\": \"BM_SummaryRepeat/repeats:3_mean\",$"},
  372. {"\"run_name\": \"BM_SummaryRepeat/repeats:3\",$", MR_Next},
  373. {"\"run_type\": \"aggregate\",$", MR_Next},
  374. {"\"aggregate_name\": \"mean\",$", MR_Next},
  375. {"\"iterations\": 3,$", MR_Next},
  376. {"\"name\": \"BM_SummaryRepeat/repeats:3_median\",$"},
  377. {"\"run_name\": \"BM_SummaryRepeat/repeats:3\",$", MR_Next},
  378. {"\"run_type\": \"aggregate\",$", MR_Next},
  379. {"\"aggregate_name\": \"median\",$", MR_Next},
  380. {"\"iterations\": 3,$", MR_Next},
  381. {"\"name\": \"BM_SummaryRepeat/repeats:3_stddev\",$"},
  382. {"\"run_name\": \"BM_SummaryRepeat/repeats:3\",$", MR_Next},
  383. {"\"run_type\": \"aggregate\",$", MR_Next},
  384. {"\"aggregate_name\": \"stddev\",$", MR_Next},
  385. {"\"iterations\": 3,$", MR_Next}});
  386. ADD_CASES(TC_CSVOut, {{".*BM_SummaryRepeat/repeats:3 ", MR_Not},
  387. {"^\"BM_SummaryRepeat/repeats:3_mean\",%csv_report$"},
  388. {"^\"BM_SummaryRepeat/repeats:3_median\",%csv_report$"},
  389. {"^\"BM_SummaryRepeat/repeats:3_stddev\",%csv_report$"}});
  390. // Test that non-aggregate data is not displayed.
  391. // NOTE: this test is kinda bad. we are only testing the display output.
  392. // But we don't check that the file output still contains everything...
  393. void BM_SummaryDisplay(benchmark::State& state) {
  394. for (auto _ : state) {
  395. }
  396. }
  397. BENCHMARK(BM_SummaryDisplay)->Repetitions(2)->DisplayAggregatesOnly();
  398. ADD_CASES(
  399. TC_ConsoleOut,
  400. {{".*BM_SummaryDisplay/repeats:2 ", MR_Not},
  401. {"^BM_SummaryDisplay/repeats:2_mean %console_time_only_report [ ]*2$"},
  402. {"^BM_SummaryDisplay/repeats:2_median %console_time_only_report [ ]*2$"},
  403. {"^BM_SummaryDisplay/repeats:2_stddev %console_time_only_report [ ]*2$"}});
  404. ADD_CASES(TC_JSONOut,
  405. {{".*BM_SummaryDisplay/repeats:2 ", MR_Not},
  406. {"\"name\": \"BM_SummaryDisplay/repeats:2_mean\",$"},
  407. {"\"run_name\": \"BM_SummaryDisplay/repeats:2\",$", MR_Next},
  408. {"\"run_type\": \"aggregate\",$", MR_Next},
  409. {"\"aggregate_name\": \"mean\",$", MR_Next},
  410. {"\"iterations\": 2,$", MR_Next},
  411. {"\"name\": \"BM_SummaryDisplay/repeats:2_median\",$"},
  412. {"\"run_name\": \"BM_SummaryDisplay/repeats:2\",$", MR_Next},
  413. {"\"run_type\": \"aggregate\",$", MR_Next},
  414. {"\"aggregate_name\": \"median\",$", MR_Next},
  415. {"\"iterations\": 2,$", MR_Next},
  416. {"\"name\": \"BM_SummaryDisplay/repeats:2_stddev\",$"},
  417. {"\"run_name\": \"BM_SummaryDisplay/repeats:2\",$", MR_Next},
  418. {"\"run_type\": \"aggregate\",$", MR_Next},
  419. {"\"aggregate_name\": \"stddev\",$", MR_Next},
  420. {"\"iterations\": 2,$", MR_Next}});
  421. ADD_CASES(TC_CSVOut,
  422. {{".*BM_SummaryDisplay/repeats:2 ", MR_Not},
  423. {"^\"BM_SummaryDisplay/repeats:2_mean\",%csv_report$"},
  424. {"^\"BM_SummaryDisplay/repeats:2_median\",%csv_report$"},
  425. {"^\"BM_SummaryDisplay/repeats:2_stddev\",%csv_report$"}});
  426. // Test repeats with custom time unit.
  427. void BM_RepeatTimeUnit(benchmark::State& state) {
  428. for (auto _ : state) {
  429. }
  430. }
  431. BENCHMARK(BM_RepeatTimeUnit)
  432. ->Repetitions(3)
  433. ->ReportAggregatesOnly()
  434. ->Unit(benchmark::kMicrosecond);
  435. ADD_CASES(
  436. TC_ConsoleOut,
  437. {{".*BM_RepeatTimeUnit/repeats:3 ", MR_Not},
  438. {"^BM_RepeatTimeUnit/repeats:3_mean %console_us_time_only_report [ ]*3$"},
  439. {"^BM_RepeatTimeUnit/repeats:3_median %console_us_time_only_report [ "
  440. "]*3$"},
  441. {"^BM_RepeatTimeUnit/repeats:3_stddev %console_us_time_only_report [ "
  442. "]*3$"}});
  443. ADD_CASES(TC_JSONOut,
  444. {{".*BM_RepeatTimeUnit/repeats:3 ", MR_Not},
  445. {"\"name\": \"BM_RepeatTimeUnit/repeats:3_mean\",$"},
  446. {"\"run_name\": \"BM_RepeatTimeUnit/repeats:3\",$", MR_Next},
  447. {"\"run_type\": \"aggregate\",$", MR_Next},
  448. {"\"aggregate_name\": \"mean\",$", MR_Next},
  449. {"\"iterations\": 3,$", MR_Next},
  450. {"\"time_unit\": \"us\",?$"},
  451. {"\"name\": \"BM_RepeatTimeUnit/repeats:3_median\",$"},
  452. {"\"run_name\": \"BM_RepeatTimeUnit/repeats:3\",$", MR_Next},
  453. {"\"run_type\": \"aggregate\",$", MR_Next},
  454. {"\"aggregate_name\": \"median\",$", MR_Next},
  455. {"\"iterations\": 3,$", MR_Next},
  456. {"\"time_unit\": \"us\",?$"},
  457. {"\"name\": \"BM_RepeatTimeUnit/repeats:3_stddev\",$"},
  458. {"\"run_name\": \"BM_RepeatTimeUnit/repeats:3\",$", MR_Next},
  459. {"\"run_type\": \"aggregate\",$", MR_Next},
  460. {"\"aggregate_name\": \"stddev\",$", MR_Next},
  461. {"\"iterations\": 3,$", MR_Next},
  462. {"\"time_unit\": \"us\",?$"}});
  463. ADD_CASES(TC_CSVOut,
  464. {{".*BM_RepeatTimeUnit/repeats:3 ", MR_Not},
  465. {"^\"BM_RepeatTimeUnit/repeats:3_mean\",%csv_us_report$"},
  466. {"^\"BM_RepeatTimeUnit/repeats:3_median\",%csv_us_report$"},
  467. {"^\"BM_RepeatTimeUnit/repeats:3_stddev\",%csv_us_report$"}});
  468. // ========================================================================= //
  469. // -------------------- Testing user-provided statistics ------------------- //
  470. // ========================================================================= //
  471. const auto UserStatistics = [](const std::vector<double>& v) {
  472. return v.back();
  473. };
  474. void BM_UserStats(benchmark::State& state) {
  475. for (auto _ : state) {
  476. state.SetIterationTime(150 / 10e8);
  477. }
  478. }
  479. // clang-format off
  480. BENCHMARK(BM_UserStats)
  481. ->Repetitions(3)
  482. ->Iterations(5)
  483. ->UseManualTime()
  484. ->ComputeStatistics("", UserStatistics);
  485. // clang-format on
  486. // check that user-provided stats is calculated, and is after the default-ones
  487. // empty string as name is intentional, it would sort before anything else
  488. ADD_CASES(TC_ConsoleOut, {{"^BM_UserStats/iterations:5/repeats:3/manual_time [ "
  489. "]* 150 ns %time [ ]*5$"},
  490. {"^BM_UserStats/iterations:5/repeats:3/manual_time [ "
  491. "]* 150 ns %time [ ]*5$"},
  492. {"^BM_UserStats/iterations:5/repeats:3/manual_time [ "
  493. "]* 150 ns %time [ ]*5$"},
  494. {"^BM_UserStats/iterations:5/repeats:3/"
  495. "manual_time_mean [ ]* 150 ns %time [ ]*3$"},
  496. {"^BM_UserStats/iterations:5/repeats:3/"
  497. "manual_time_median [ ]* 150 ns %time [ ]*3$"},
  498. {"^BM_UserStats/iterations:5/repeats:3/"
  499. "manual_time_stddev [ ]* 0.000 ns %time [ ]*3$"},
  500. {"^BM_UserStats/iterations:5/repeats:3/manual_time_ "
  501. "[ ]* 150 ns %time [ ]*3$"}});
  502. ADD_CASES(
  503. TC_JSONOut,
  504. {{"\"name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$"},
  505. {"\"run_name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$",
  506. MR_Next},
  507. {"\"run_type\": \"iteration\",$", MR_Next},
  508. {"\"iterations\": 5,$", MR_Next},
  509. {"\"real_time\": 1\\.5(0)*e\\+(0)*2,$", MR_Next},
  510. {"\"name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$"},
  511. {"\"run_name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$",
  512. MR_Next},
  513. {"\"run_type\": \"iteration\",$", MR_Next},
  514. {"\"iterations\": 5,$", MR_Next},
  515. {"\"real_time\": 1\\.5(0)*e\\+(0)*2,$", MR_Next},
  516. {"\"name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$"},
  517. {"\"run_name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$",
  518. MR_Next},
  519. {"\"run_type\": \"iteration\",$", MR_Next},
  520. {"\"iterations\": 5,$", MR_Next},
  521. {"\"real_time\": 1\\.5(0)*e\\+(0)*2,$", MR_Next},
  522. {"\"name\": \"BM_UserStats/iterations:5/repeats:3/manual_time_mean\",$"},
  523. {"\"run_name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$",
  524. MR_Next},
  525. {"\"run_type\": \"aggregate\",$", MR_Next},
  526. {"\"aggregate_name\": \"mean\",$", MR_Next},
  527. {"\"iterations\": 3,$", MR_Next},
  528. {"\"real_time\": 1\\.5(0)*e\\+(0)*2,$", MR_Next},
  529. {"\"name\": \"BM_UserStats/iterations:5/repeats:3/manual_time_median\",$"},
  530. {"\"run_name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$",
  531. MR_Next},
  532. {"\"run_type\": \"aggregate\",$", MR_Next},
  533. {"\"aggregate_name\": \"median\",$", MR_Next},
  534. {"\"iterations\": 3,$", MR_Next},
  535. {"\"real_time\": 1\\.5(0)*e\\+(0)*2,$", MR_Next},
  536. {"\"name\": \"BM_UserStats/iterations:5/repeats:3/manual_time_stddev\",$"},
  537. {"\"run_name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$",
  538. MR_Next},
  539. {"\"run_type\": \"aggregate\",$", MR_Next},
  540. {"\"aggregate_name\": \"stddev\",$", MR_Next},
  541. {"\"iterations\": 3,$", MR_Next},
  542. {"\"real_time\": %float,$", MR_Next},
  543. {"\"name\": \"BM_UserStats/iterations:5/repeats:3/manual_time_\",$"},
  544. {"\"run_name\": \"BM_UserStats/iterations:5/repeats:3/manual_time\",$",
  545. MR_Next},
  546. {"\"run_type\": \"aggregate\",$", MR_Next},
  547. {"\"aggregate_name\": \"\",$", MR_Next},
  548. {"\"iterations\": 3,$", MR_Next},
  549. {"\"real_time\": 1\\.5(0)*e\\+(0)*2,$", MR_Next}});
  550. ADD_CASES(
  551. TC_CSVOut,
  552. {{"^\"BM_UserStats/iterations:5/repeats:3/manual_time\",%csv_report$"},
  553. {"^\"BM_UserStats/iterations:5/repeats:3/manual_time\",%csv_report$"},
  554. {"^\"BM_UserStats/iterations:5/repeats:3/manual_time\",%csv_report$"},
  555. {"^\"BM_UserStats/iterations:5/repeats:3/manual_time_mean\",%csv_report$"},
  556. {"^\"BM_UserStats/iterations:5/repeats:3/"
  557. "manual_time_median\",%csv_report$"},
  558. {"^\"BM_UserStats/iterations:5/repeats:3/"
  559. "manual_time_stddev\",%csv_report$"},
  560. {"^\"BM_UserStats/iterations:5/repeats:3/manual_time_\",%csv_report$"}});
  561. // ========================================================================= //
  562. // --------------------------- TEST CASES END ------------------------------ //
  563. // ========================================================================= //
  564. int main(int argc, char* argv[]) { RunOutputTests(argc, argv); }