test_registry.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <cstddef>
#include <functional>
#include <memory>
#include <source_location>
#include <string>
#include <string_view>
#include <vector>
 
#include <kaycxx/test/callback.hpp>
#include <kaycxx/test/hook.hpp>
#include <kaycxx/test/reporter.hpp>
#include <kaycxx/test/run_options.hpp>
#include <kaycxx/test/skip.hpp>
#include <kaycxx/test/test_filter.hpp>
 
namespace kaycxx::test::detail {
 
class test_suite;
 
} // namespace kaycxx::test::detail
 
namespace kaycxx::test {
 
class test_registry {
public:
    test_registry();
 
    ~test_registry();
 
    test_registry(test_registry const&) = delete;
    test_registry& operator=(test_registry const&) = delete;
 
    void add_suite(std::string_view description, callback body, std::source_location location = std::source_location::current());
 
    void add_test(std::string_view description, callback body, std::source_location location = std::source_location::current());
 
    void add_test(std::string_view description, skip_condition condition, callback body, std::source_location location = std::source_location::current());
 
    void add_before_all_hook(hook value);
 
    void add_before_each_hook(hook value);
 
    void add_after_each_hook(hook value);
 
    void add_after_all_hook(hook value);
 
    bool run(reporter& reporter, run_options const& options = {});
 
    bool run(reporter& reporter, test_filter const& filter, run_options const& options = {});
 
    std::vector<std::string> list_tests() const;
 
    std::vector<std::string> list_tests(test_filter const& filter) const;
 
    std::size_t num_test_suites() const;
 
    std::size_t num_test_suites(test_filter const& filter) const;
 
    std::size_t num_test_cases() const;
 
    std::size_t num_test_cases(test_filter const& filter) const;
 
private:
    std::vector<std::unique_ptr<detail::test_suite>> root_suites_;
 
    std::vector<std::reference_wrapper<detail::test_suite>> suite_stack_;
 
    detail::test_suite& current();
 
    detail::test_suite& add_suite_node(std::string_view description, std::source_location location);
};
 
test_registry& default_registry();
 
test_registry& active_registry();
 
test_registry& set_active_registry(test_registry& registry);
 
void reset_active_registry();
 
} // namespace kaycxx::test