CppUtils::UnitTest::TestSuiteBuilder

Top-level builder used to declare a test suite, configure dependencies, and define its body.

Description

Note

Returned by testSuite(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

std::string name;

Identifier of the test suite.

std::vector<std::string> prerequisites;

Names of prerequisite test suites that must succeed before this suite runs.

Public methods

template <class... Dependencies>
auto TestSuiteBuilder::dependsOn(Dependencies&&... dependencies) -> TestSuiteBuilder&;

Adds prerequisite test suites that must succeed before executing this suite.

Parameter	Description
dependencies	Prerequisite test suite names.

Returns: Reference to this builder.

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

Converts this suite into a type-parameterized test suite.

Template parameter	Description
Types	Type parameter list.

Returns: TypedTestSuiteBuilder instance.

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

Converts this suite into a value-parameterized test suite over values or a range.

Template parameter	Description
Values	Value types or single range type.

Parameter	Description
values	Values or range to parameterize the suite with.

Returns: ParameterizedTestSuiteBuilder instance.

auto TestSuiteBuilder::operator=(auto&& function) -> TestSuiteRegistration;

Registers the test suite callback into the global test runner.

Parameter	Description
function	Invocable accepting a TestSuite&.

Returns: TestSuiteRegistration token.