event_handler.h

// Copyright 2020 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
 
namespace pw {
namespace unit_test {
 
// The result of a complete test run.
enum class TestResult {
  kSuccess = 0,
  kFailure = 1,
  // Test skipped at runtime. This is neither a success nor a failure.
  kSkipped = 2,
};
 
struct TestCase {
  // Name of the test suite to which this test case belongs.
  const char* suite_name;
 
  // Name of the test case.
  const char* test_name;
 
  // Path to the file in which the test case is defined.
  const char* file_name;
};
 
struct TestExpectation {
  // The source code for the expression which was run.
  const char* expression;
 
  // The expression with arguments evaluated.
  const char* evaluated_expression;
 
  // Line number at which the expectation is located.
  int line_number;
 
  // Whether the expectation succeeded.
  bool success;
};
 
struct RunTestsSummary {
  // The number of passed tests among the run tests.
  int passed_tests;
 
  // The number of passed tests among the run tests.
  int failed_tests;
 
  // The number of tests skipped or filtered out.
  int skipped_tests;
 
  // The number of disabled tests encountered.
  int disabled_tests;
};
 
struct ProgramSummary {
  // The total number of tests to run in the program.
  int tests_to_run;
 
  // The number of test suites included in the program.
  int test_suites;
 
  // Test summary for the program once complete.
  RunTestsSummary tests_summary;
};
 
struct TestSuite {
  // Name of the test suite.
  const char* name;
 
  // Total number of tests in suite to run.
  int test_to_run_count;
};
 
class EventHandler {
 public:
  virtual ~EventHandler() = default;
 
  virtual void TestProgramStart(const ProgramSummary& program_summary) = 0;
 
  virtual void EnvironmentsSetUpEnd() = 0;
 
  virtual void TestSuiteStart(const TestSuite& test_suite) = 0;
 
  virtual void TestSuiteEnd(const TestSuite& test_suite) = 0;
 
  virtual void EnvironmentsTearDownEnd() = 0;
 
  virtual void TestProgramEnd(const ProgramSummary& program_summary) = 0;
 
  virtual void RunAllTestsStart() = 0;
 
  virtual void RunAllTestsEnd(const RunTestsSummary& run_tests_summary) = 0;
 
  virtual void TestCaseStart(const TestCase& test_case) = 0;
 
  virtual void TestCaseEnd(const TestCase& test_case, TestResult result) = 0;
 
  virtual void TestCaseDisabled(const TestCase&) {}
 
  virtual void TestCaseExpect(const TestCase& test_case,
                              const TestExpectation& expectation) = 0;
};
 
void RegisterEventHandler(EventHandler* event_handler);
 
}  // namespace unit_test
}  // namespace pw