commit 8663e9c4f02a052d49496112092f81c09532d78a
author Wyatt Hepler <hepler@google.com> Wed Nov 20 13:58:29 2019 -0800
committer Wyatt Hepler <hepler@google.com> Tue Nov 26 21:29:18 2019 +0000
tree 46a427852c5e527f6694b6f343e992e7ad744c36
parent fe85de25cf7ee185cf3eff0fe76080f440db1f10

Add evaluated string outputs to the test framework

- Integrate StringBuilder with the test framework. Test failures print
  "Actual: " followed by the evaluated values for the expression.
- Update SimplePrintingEventHandler to have the write function
  optionally output the newline.

Example:

[ RUN      ] Status.CompareToStatusCode
../../pw_status/status_test.cc:43: Failure
      Expected: Status(Status::ABORTED) == Status(Status::DATA_LOSS)
        Actual: ABORTED == DATA_LOSS
[  FAILED  ]

Change-Id: I4bd6f63cfd903ce2dc4959a1491825e7e743a522

pw_unit_test/simple_printing_event_handler.cc

diff --git a/pw_unit_test/simple_printing_event_handler.cc b/pw_unit_test/simple_printing_event_handler.cc
index def6354..431f925 100644
--- a/pw_unit_test/simple_printing_event_handler.cc
+++ b/pw_unit_test/simple_printing_event_handler.cc
@@ -21,21 +21,20 @@
 namespace pw::unit_test {
 
 void SimplePrintingEventHandler::RunAllTestsStart() {
-  WriteAndFlush("[==========] Running all tests.");
+  WriteLine("[==========] Running all tests.");
 }
 
 void SimplePrintingEventHandler::RunAllTestsEnd(
     const RunTestsSummary& run_tests_summary) {
-  WriteAndFlush("[==========] Done running all tests.");
-  WriteAndFlush("[  PASSED  ] %d test(s).", run_tests_summary.passed_tests);
+  WriteLine("[==========] Done running all tests.");
+  WriteLine("[  PASSED  ] %d test(s).", run_tests_summary.passed_tests);
   if (run_tests_summary.failed_tests) {
-    WriteAndFlush("[  FAILED  ] %d test(s).", run_tests_summary.failed_tests);
+    WriteLine("[  FAILED  ] %d test(s).", run_tests_summary.failed_tests);
   }
 }
 
 void SimplePrintingEventHandler::TestCaseStart(const TestCase& test_case) {
-  WriteAndFlush(
-      "[ RUN      ] %s.%s", test_case.suite_name, test_case.test_name);
+  WriteLine("[ RUN      ] %s.%s", test_case.suite_name, test_case.test_name);
 }
 
 void SimplePrintingEventHandler::TestCaseEnd(const TestCase& test_case,
@@ -43,11 +42,11 @@
   // Use a switch with no default to detect changes in the test result enum.
   switch (result) {
     case TestResult::kSuccess:
-      WriteAndFlush(
+      WriteLine(
           "[       OK ] %s.%s", test_case.suite_name, test_case.test_name);
       break;
     case TestResult::kFailure:
-      WriteAndFlush(
+      WriteLine(
           "[  FAILED  ] %s.%s", test_case.suite_name, test_case.test_name);
       break;
   }
@@ -60,19 +59,21 @@
   }
 
   const char* result = expectation.success ? "Success" : "Failure";
-  WriteAndFlush(
-      "%s:%d: %s", test_case.file_name, expectation.line_number, result);
-  WriteAndFlush("      Expected: %s", expectation.expression);
+  WriteLine("%s:%d: %s", test_case.file_name, expectation.line_number, result);
+  WriteLine("      Expected: %s", expectation.expression);
+
+  write_("        Actual: ", false);
+  write_(expectation.evaluated_expression, true);
 }
 
-int SimplePrintingEventHandler::WriteAndFlush(const char* format, ...) {
+void SimplePrintingEventHandler::WriteLine(const char* format, ...) {
   va_list args;
 
   va_start(args, format);
   std::vsnprintf(buffer_, sizeof(buffer_), format, args);
   va_end(args);
 
-  return write_(buffer_);
+  write_(buffer_, true);
 }
 
 }  // namespace pw::unit_test