test_record_event_handler.h

// Copyright 2024 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
 
#include <string_view>
 
#include "pw_json/builder.h"
#include "pw_unit_test/event_handler.h"
#include "pw_unit_test/internal/test_record_trie.h"
 
namespace pw::unit_test {
namespace json_impl {
 
inline constexpr const char* kSkipMacroIndicator = "(test skipped)";
 
}  // namespace json_impl
 
class TestRecordEventHandler : public EventHandler {
 public:
  TestRecordEventHandler(int64_t seconds_since_epoch)
      : seconds_since_epoch_(seconds_since_epoch) {}
 
  void TestCaseEnd(const TestCase& test_case, TestResult result) override {
    test_record_trie_.AddTestResult(test_case, result);
  }
 
  void RunAllTestsEnd(const RunTestsSummary& summary) override {
    run_tests_summary_ = summary;
  }
 
  void TestCaseExpect(const TestCase& test_case,
                      const TestExpectation& expectation) override {
    // TODO: b/329688428 - Check for test skips directly rather than doing a
    // string comparison
    if (std::string_view(json_impl::kSkipMacroIndicator) ==
        expectation.expression) {
      test_record_trie_.AddTestResultExpectation(test_case,
                                                 TestResult::kSkipped);
    }
  }
 
  std::string GetTestRecordJsonString(size_t max_json_buffer_size,
                                      bool failing_results_only = false) {
    return test_record_trie_.GetTestRecordJsonString(run_tests_summary_,
                                                     seconds_since_epoch_,
                                                     max_json_buffer_size,
                                                     failing_results_only);
  }
 
  void RunAllTestsStart() override {}
  void TestProgramStart(const ProgramSummary&) override {}
  void EnvironmentsSetUpEnd() override {}
  void TestSuiteStart(const TestSuite&) override {}
  void TestSuiteEnd(const TestSuite&) override {}
  void EnvironmentsTearDownEnd() override {}
  void TestProgramEnd(const ProgramSummary&) override {}
  void TestCaseStart(const TestCase&) override {}
  void TestCaseDisabled(const TestCase&) override {}
 
 private:
  // Seconds since epoch from the start of the test run.
  int64_t seconds_since_epoch_;
 
  // A summary of the test run. Set once RunAllTestsEnd is called and used when
  // the consumer of this event handler wants to generate the test record json
  // string.
  RunTestsSummary run_tests_summary_;
 
  // The entrypoint for interacting with the test record trie.
  json_impl::TestRecordTrie test_record_trie_;
};
 
}  // namespace pw::unit_test