xref: /aosp_15_r20/external/pigweed/pw_unit_test/public/pw_unit_test/logging_event_handler.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
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 /// Predefined event handler implementation that produces human-readable
21 /// GoogleTest-style test output and logs it via ``pw_log``. See
22 /// ``pw::unit_test::EventHandler`` for explanations of emitted events.
23 class LoggingEventHandler : public EventHandler {
24  public:
25   // If verbose is set, expectations values are always displayed.
verbose_(verbose)26   LoggingEventHandler(bool verbose = false) : verbose_(verbose) {}
27   void TestProgramStart(const ProgramSummary& program_summary) override;
28   void EnvironmentsSetUpEnd() override;
29   void TestSuiteStart(const TestSuite& test_suite) override;
30   void TestSuiteEnd(const TestSuite& test_suite) override;
31   void EnvironmentsTearDownEnd() override;
32   void TestProgramEnd(const ProgramSummary& program_summary) override;
33 
34   void RunAllTestsStart() override;
35   void RunAllTestsEnd(const RunTestsSummary& run_tests_summary) override;
36   void TestCaseStart(const TestCase& test_case) override;
37   void TestCaseEnd(const TestCase& test_case, TestResult result) override;
38   void TestCaseExpect(const TestCase& test_case,
39                       const TestExpectation& expectation) override;
40   void TestCaseDisabled(const TestCase& test_case) override;
41 
42  private:
43   bool verbose_;
44 };
45 
46 }  // namespace pw::unit_test
47