CppUtils::UnitTest::TestSuite::TestBuilder

Builder for configuring and registering an individual test case.

Description

Note

Returned by TestSuite::test(std::string); not intended to be instantiated directly by user code.

Related guide

See the Declaring a test suite section for detailed explanations and usage examples.

Public attributes

TestSuite& parentSuite;

Reference to the enclosing test suite registering the test.

std::string testName;

Identifier of the test case.

Public methods

TestBuilder::TestBuilder(std::chrono::seconds timeout, TestSuite& suite, std::string name);

template <class... Types>
[[nodiscard]] auto TestBuilder::forTypes() -> TypedTestBuilder<Types...>;

Converts this test into a type-parameterized test across the specified types.

Template parameter	Description
Types	Type parameters to instantiate the test with.

Returns: TypedTestBuilder instance.

template <class... Values>
[[nodiscard]] auto TestBuilder::forValues(Values&&... values);

Converts this test into a value-parameterized test across discrete values or a range.

Template parameter	Description
Values	Value types or single range type.

Parameter	Description
values	Values or range to iterate over.

Returns: ParameterizedTestBuilder instance.

auto TestBuilder::operator=(auto&& function) -> void;

Assigns the test body callback and registers the test into the parent suite.

Parameter	Description
function	Invocable containing test logic (accepts optional std::stop_token).