third_party/pigweed/repo/pw_unit_test/public/pw_unit_test/logging_event_handler.h

   1 // Copyright 2020 The Pigweed Authors
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
   4 // use this file except in compliance with the License. You may obtain a copy of
   5 // the License at
   6 //
   7 //     https://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12 // License for the specific language governing permissions and limitations under
  13 // the License.
  14 #pragma once
  15
  16 #include "pw_unit_test/event_handler.h"
  17
  18 namespace pw::unit_test {
  19
  20 // An event handler implementation that logs human-readable messages to the
  21 // standard Pigweed logging system, pw_log.
  22 class LoggingEventHandler : public EventHandler {
  23  public:
  24   // If verbose is set, expectations values are always displayed.
  25   LoggingEventHandler(bool verbose = false) : verbose_(verbose) {}
  26
  27   void RunAllTestsStart() override;
  28   void RunAllTestsEnd(const RunTestsSummary& run_tests_summary) override;
  29   void TestCaseStart(const TestCase& test_case) override;
  30   void TestCaseEnd(const TestCase& test_case, TestResult result) override;
  31   void TestCaseExpect(const TestCase& test_case,
  32                       const TestExpectation& expectation) override;
  33   void TestCaseDisabled(const TestCase& test_case) override;
  34
  35  private:
  36   bool verbose_;
  37 };
  38
  39 }  // namespace pw::unit_test