`test_suite` Class

Represents a named group of test cases that self-register to the runner. More...

Declaration

class micro_os_plus::micro_test_plus::test_suite { ... }

Included Headers

#include <micro-os-plus/micro-test-plus.h>

Base class

class	test_suite_base
	Base class for all test suites. More...

Public Constructors Index

template <typename Callable_T, typename... Args_T>
test_suite (const char *name, Callable_T &&callable, Args_T &&... arguments)
	Class template constructor for test_suite. More...

	test_suite (const test_suite &)=delete
	Deleted copy constructor to prevent copying. More...

	test_suite (test_suite &&)=delete
	Deleted move constructor to prevent moving. More...

Public Destructor Index

	~test_suite () override
	Virtual destructor for the test_suite class. More...

Public Operators Index

test_suite &	operator= (const test_suite &)=delete
	Deleted copy assignment operator to prevent copying. More...

test_suite &	operator= (test_suite &&)=delete
	Deleted move assignment operator to prevent moving. More...

Public Member Functions Index

void	begin_test_case (const char *name)
	Marks the beginning of a named test case. More...

void	begin_test_suite (void)
	Begins the execution of the test suite. More...

void	end_test_case (void)
	Marks the end of a test case. More...

void	end_test_suite (void)
	Marks the end of the test suite. More...

constexpr size_t	failed_checks (void)
	Gets the number of test conditions that failed. More...

void	increment_failed (void)
	Increments the count of failed test conditions. More...

void	increment_successful (void)
	Increments the count of passed test conditions. More...

constexpr const char *	name (void)
	Gets the suite name. More...

void	run (void) override
	Runs the sequence of test cases in the suite by invoking the stored callable. More...

constexpr size_t	successful_checks (void)
	Gets the number of conditions that passed. More...

constexpr size_t	test_cases_count (void)
	Gets the number of test cases. More...

constexpr bool	unused (void)
	Checks if the test suite was not used. More...

constexpr bool	was_successful (void)
	Gets the test suite result. More...

Public Member Attributes Index

struct { ... }	current_test_case
	Structure holding the current test case's check counters. More...

size_t	failed_checks = 0
	Number of failed checks in the current test case. More...

size_t	index = 1
	The test suite index, counting from 1. More...

bool	process_deferred_begin = true
	Indicates whether to process deferred begin for test cases. More...

size_t	successful_checks = 0
	Number of successful checks in the current test case. More...

Protected Member Attributes Index

std::function< void(void)>	callable_
	Callable object representing the test suite's execution logic. More...

size_t	failed_checks_ = 0
	Count of test conditions that failed. More...

const char *	name_
	The test suite name. More...

size_t	successful_checks_ = 0
	Count of test conditions that passed. More...

const char *	test_case_name_
	The current test case name. More...

size_t	test_cases_count_ = 0
	Count of test cases in the test suite. More...

Description

Represents a named group of test cases that self-register to the runner.

The test_suite class extends test_suite_base and enables the registration and execution of callable objects (such as lambdas or function pointers) as test suites. Upon construction, each test suite automatically registers itself with the test runner, facilitating automated test discovery and execution across different components and folders of a project.

This class template provides a flexible mechanism for grouping related test cases and managing their execution within the µTest++ framework. It ensures that test suites are non-copyable and non-movable, maintaining unique ownership and consistent state.

All members and methods are defined within the micro_os_plus::micro_test_plus namespace, ensuring clear separation from user code and minimising the risk of naming conflicts.

Definition at line 407 of file test-suite.h.

Public Constructors

test_suite()

template <typename Callable_T, typename... Args_T>

micro_os_plus::micro_test_plus::test_suite::test_suite (const char * name, Callable_T && callable, Args_T &&... arguments)

Class template constructor for test_suite.

Template Parameters

Callable_T	The type of a callable object.
Args_T	The types of the callable arguments.

Parameters

[in] name	The test case name or description, used in reports.
[in] callable	A generic callable object, usually a lambda, invoked to perform the test.
[in] arguments	A possibly empty list of arguments to be passed to the callable.

The rule of five is enforced to prevent accidental copying or moving.

This constructor initialises a test suite by binding the provided callable and its arguments, and registers the suite with the test runner.

The callable is bound using std::bind, allowing for flexible test suite definitions with arbitrary arguments. Upon construction, the test suite is automatically registered with the global runner for execution.

Declaration at line 426 of file test-suite.h, definition at line 88 of file test-suite-inlines.h.

88 test_suite::test_suite (const char* name, Callable_T&& callable,

89 Args_T&&... arguments)

90 : test_suite_base{ name },

91 callable_{ std::bind (callable, arguments...) }

92 {

93#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

94 printf ("%s\n", __PRETTY_FUNCTION__);

95#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

97 runner.register_test_suite (this);

98 }

References micro_os_plus::micro_test_plus::test_suite_base::test_suite_base, callable_, micro_os_plus::micro_test_plus::test_suite_base::name and micro_os_plus::micro_test_plus::runner.

Referenced by test_suite, test_suite, operator= and operator=.

test_suite()

micro_os_plus::micro_test_plus::test_suite::test_suite (const test_suite &)

delete

Deleted copy constructor to prevent copying.

Definition at line 432 of file test-suite.h.

Reference test_suite.

test_suite()

micro_os_plus::micro_test_plus::test_suite::test_suite (test_suite &&)

delete

Deleted move constructor to prevent moving.

Definition at line 437 of file test-suite.h.

Reference test_suite.

Public Destructor

~test_suite()

micro_os_plus::micro_test_plus::test_suite::~test_suite ()

virtual

Virtual destructor for the test_suite class.

The destructor releases any resources associated with the test_suite instance. If tracing is enabled, it outputs the function signature for diagnostic purposes. This ensures that the test suite is properly cleaned up after execution, supporting robust and reliable test management across all files and folders within the µTest++ framework.

Declaration at line 456 of file test-suite.h, definition at line 294 of file test-suite.cpp.

294 test_suite::~test_suite ()

295 {

296#if defined(MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS)

297 printf ("%s\n", __PRETTY_FUNCTION__);

298#endif // MICRO_OS_PLUS_TRACE_MICRO_TEST_PLUS

299 }

Public Operators

operator=()

test_suite & micro_os_plus::micro_test_plus::test_suite::operator= (const test_suite &)

delete

Deleted copy assignment operator to prevent copying.

Definition at line 443 of file test-suite.h.

Reference test_suite.

operator=()

test_suite & micro_os_plus::micro_test_plus::test_suite::operator= (test_suite &&)

delete

Deleted move assignment operator to prevent moving.

Definition at line 450 of file test-suite.h.

Reference test_suite.

Public Member Functions

begin_test_case()

void micro_os_plus::micro_test_plus::test_suite_base::begin_test_case (const char * name)

Marks the beginning of a named test case.

Parameters

[in] name

The test case name.

Returns: Nothing.

This method marks the beginning of a test case within the suite. If the start of the suite was deferred, it ensures the suite is properly begun before proceeding. The method sets the current test case name, increments the total number of test cases, resets the current test case statistics, and notifies the test reporter to begin the test case. This approach guarantees that each test case is clearly identified, accurately tracked, and properly reported across all test cases and folders.

Declaration at line 160 of file test-suite.h, definition at line 177 of file test-suite.cpp.

177 test_suite_base::begin_test_case (const char* name)

178 {

179 if (process_deferred_begin)

180 {

181 reporter->begin_test (runner.test_suites_count ());

182

183 begin_test_suite ();

184 }

185

186 test_case_name_ = name;

187 ++test_cases_count_;

188

189 current_test_case = {};

190

191 reporter->begin_test_case (test_case_name_);

192 }

References micro_os_plus::micro_test_plus::test_suite_base::begin_test_suite, micro_os_plus::micro_test_plus::test_suite_base::current_test_case, micro_os_plus::micro_test_plus::test_suite_base::name, micro_os_plus::micro_test_plus::test_suite_base::process_deferred_begin, micro_os_plus::micro_test_plus::reporter, micro_os_plus::micro_test_plus::runner, micro_os_plus::micro_test_plus::test_suite_base::test_case_name_ and micro_os_plus::micro_test_plus::test_suite_base::test_cases_count_.

begin_test_suite()

void micro_os_plus::micro_test_plus::test_suite_base::begin_test_suite (void)

Begins the execution of the test suite.

Parameters: None.

Returns: Nothing.

This method marks the beginning of a test suite's execution. It resets the deferred begin flag and notifies the test reporter to start the suite, passing the suite's name. This ensures that test suite output is clearly delineated and properly initialised, supporting organised and readable reporting across all test cases and folders.

Declaration at line 255 of file test-suite.h, definition at line 122 of file test-suite.cpp.

122 test_suite_base::begin_test_suite (void)

123 {

124#if defined(_WIN32) || defined(CLOCK_MONOTONIC)

125#if defined(_WIN32)

126 timespec_get (&begin_time, TIME_UTC);

127#else

128 clock_gettime (CLOCK_MONOTONIC, &begin_time);

129#endif

130#endif

131

132 process_deferred_begin = false;

133

134 reporter->begin_test_suite (name_);

135 }

References micro_os_plus::micro_test_plus::test_suite_base::name_, micro_os_plus::micro_test_plus::test_suite_base::process_deferred_begin and micro_os_plus::micro_test_plus::reporter.

Referenced by micro_os_plus::micro_test_plus::test_suite_base::begin_test_case, micro_os_plus::micro_test_plus::test_suite_base::end_test_suite and micro_os_plus::micro_test_plus::test_runner::exit_code.

end_test_case()

void micro_os_plus::micro_test_plus::test_suite_base::end_test_case (void)

Marks the end of a test case.

Parameters: None.

Returns: Nothing.

This method marks the end of a test case within the suite. It notifies the test reporter to conclude the test case, passing the current test case name. This ensures that the results of the test case are accurately finalised and clearly reported, supporting organised and reliable test management across all test cases and folders.

Declaration at line 170 of file test-suite.h, definition at line 203 of file test-suite.cpp.

203 test_suite_base::end_test_case (void)

204 {

205 reporter->end_test_case (test_case_name_);

206 }

References micro_os_plus::micro_test_plus::reporter and micro_os_plus::micro_test_plus::test_suite_base::test_case_name_.

end_test_suite()

void micro_os_plus::micro_test_plus::test_suite_base::end_test_suite (void)

Marks the end of the test suite.

Parameters: None.

Returns: Nothing.

This method marks the end of a test suite's execution. If the suite's start was deferred, it ensures the suite is properly begun before finalising. The method then notifies the test reporter to conclude the suite, passing a reference to the suite instance. This guarantees that all results are accurately summarised and reported, supporting clear and organised test management across all test cases and folders.

Declaration at line 266 of file test-suite.h, definition at line 147 of file test-suite.cpp.

147 test_suite_base::end_test_suite (void)

148 {

149 if (process_deferred_begin)

150 {

151 reporter->begin_test (runner.test_suites_count ());

152

153 begin_test_suite ();

154 }

155

156#if defined(_WIN32) || defined(CLOCK_MONOTONIC)

157#if defined(_WIN32)

158 timespec_get (&end_time, TIME_UTC);

159#else

160 clock_gettime (CLOCK_MONOTONIC, &end_time);

161#endif

162#endif

163 reporter->end_test_suite (*this);

164 }

References micro_os_plus::micro_test_plus::test_suite_base::begin_test_suite, micro_os_plus::micro_test_plus::test_suite_base::process_deferred_begin, micro_os_plus::micro_test_plus::reporter and micro_os_plus::micro_test_plus::runner.

Referenced by micro_os_plus::micro_test_plus::test_runner::exit_code.

failed_checks()

size_t micro_os_plus::micro_test_plus::test_suite_base::failed_checks (void)

inline nodiscard constexpr

Gets the number of test conditions that failed.

Parameters: None.

Returns: An integer with the number of checks that failed.

Definition at line 228 of file test-suite.h.

228 failed_checks (void)

229 {

230 return failed_checks_;

231 }

Reference micro_os_plus::micro_test_plus::test_suite_base::failed_checks_.

increment_failed()

void micro_os_plus::micro_test_plus::test_suite_base::increment_failed (void)

Increments the count of failed test conditions.

Parameters: None.

Returns: Nothing.

This method increments the count of failed checks for the test suite and the current test case. It ensures that each failing assertion is accurately recorded, supporting precise tracking and reporting of test outcomes across all test cases and folders.

Declaration at line 205 of file test-suite.h, definition at line 230 of file test-suite.cpp.

230 test_suite_base::increment_failed (void)

231 {

232 ++failed_checks_;

233 ++current_test_case.failed_checks;

234 }

References micro_os_plus::micro_test_plus::test_suite_base::current_test_case and micro_os_plus::micro_test_plus::test_suite_base::failed_checks_.

increment_successful()

void micro_os_plus::micro_test_plus::test_suite_base::increment_successful (void)

Increments the count of passed test conditions.

Parameters: None.

Returns: Nothing.

This method increments the count of successful checks for the test suite and the current test case. It ensures that each passing assertion is accurately recorded, supporting precise tracking and reporting of test outcomes across all test cases and folders.

Declaration at line 194 of file test-suite.h, definition at line 216 of file test-suite.cpp.

216 test_suite_base::increment_successful (void)

217 {

218 ++successful_checks_;

219 ++current_test_case.successful_checks;

220 }

References micro_os_plus::micro_test_plus::test_suite_base::current_test_case and micro_os_plus::micro_test_plus::test_suite_base::successful_checks_.

name()

const char * micro_os_plus::micro_test_plus::test_suite_base::name (void)

inline nodiscard constexpr

Gets the suite name.

Parameters: None.

Returns: A pointer to the null-terminated test suite name.

Definition at line 180 of file test-suite.h.

180 name (void)

181 {

182 return name_;

183 }

Reference micro_os_plus::micro_test_plus::test_suite_base::name_.

Referenced by test_suite, micro_os_plus::micro_test_plus::test_suite_base::test_suite_base, micro_os_plus::micro_test_plus::test_suite_base::begin_test_case, micro_os_plus::micro_test_plus::test_reporter_basic::end_test_suite, micro_os_plus::micro_test_plus::test_reporter_tap::end_test_suite and micro_os_plus::micro_test_plus::test_suite_base::operator=.

run()

void micro_os_plus::micro_test_plus::test_suite::run (void)

virtual

Runs the sequence of test cases in the suite by invoking the stored callable.

Parameters: None.

Returns: Nothing.

This method executes the test suite by invoking the stored callable object associated with the suite. It ensures that all test cases registered within the suite are executed in sequence, supporting comprehensive and structured testing across all files and folders within the µTest++ framework.

Declaration at line 468 of file test-suite.h, definition at line 280 of file test-suite.cpp.

280 test_suite::run (void)

281 {

282 // Run the test suite function prepared with std::bin();

283 callable_ ();

284 }

Reference callable_.

Referenced by micro_os_plus::micro_test_plus::test_runner::exit_code.

successful_checks()

size_t micro_os_plus::micro_test_plus::test_suite_base::successful_checks (void)

inline nodiscard constexpr

Gets the number of conditions that passed.

Parameters: None.

Returns: An integer with the number of checks that passed.

Definition at line 215 of file test-suite.h.

215 successful_checks (void)

216 {

217 return successful_checks_;

218 }

Reference micro_os_plus::micro_test_plus::test_suite_base::successful_checks_.

test_cases_count()

size_t micro_os_plus::micro_test_plus::test_suite_base::test_cases_count (void)

inline nodiscard constexpr

Gets the number of test cases.

Parameters: None.

Returns: An integer with the number of test cases.

Definition at line 241 of file test-suite.h.

241 test_cases_count (void)

242 {

243 return test_cases_count_;

244 }

Reference micro_os_plus::micro_test_plus::test_suite_base::test_cases_count_.

Referenced by micro_os_plus::micro_test_plus::test_reporter_basic::end_test_suite, micro_os_plus::micro_test_plus::test_reporter_tap::end_test_suite and micro_os_plus::micro_test_plus::test_runner::exit_code.

unused()

bool micro_os_plus::micro_test_plus::test_suite_base::unused (void)

inline nodiscard constexpr

Checks if the test suite was not used.

Parameters: None.

Returns: True if the test suite is not used.

Definition at line 305 of file test-suite.h.

305 unused (void)

306 {

307 return (failed_checks_ == 0 && successful_checks_ == 0

308 && test_cases_count_ == 0);

309 }

References micro_os_plus::micro_test_plus::test_suite_base::failed_checks_, micro_os_plus::micro_test_plus::test_suite_base::successful_checks_ and micro_os_plus::micro_test_plus::test_suite_base::test_cases_count_.

was_successful()

bool micro_os_plus::micro_test_plus::test_suite_base::was_successful (void)

inline nodiscard constexpr

Gets the test suite result.

Parameters: None.

Returns: True if the test suite was successful.

Definition at line 291 of file test-suite.h.

291 was_successful (void)

292 {

293 // Also fail if none passed.

294 return (failed_checks_ == 0 && successful_checks_ != 0);

295 }

References micro_os_plus::micro_test_plus::test_suite_base::failed_checks_ and micro_os_plus::micro_test_plus::test_suite_base::successful_checks_.

Referenced by micro_os_plus::micro_test_plus::test_runner::exit_code.

Public Member Attributes

current_test_case

struct micro_os_plus::micro_test_plus::test_suite_base micro_os_plus::micro_test_plus::test_suite_base::current_test_case

Structure holding the current test case's check counters.

Tracks the number of successful and failed checks for the currently running test case.

Definition at line 380 of file test-suite.h.

Referenced by micro_os_plus::micro_test_plus::test_suite_base::begin_test_case, micro_os_plus::micro_test_plus::test_suite_base::increment_failed and micro_os_plus::micro_test_plus::test_suite_base::increment_successful.

failed_checks

size_t micro_os_plus::micro_test_plus::test_suite_base::failed_checks = 0

Number of failed checks in the current test case.

Definition at line 377 of file test-suite.h.

377 size_t failed_checks = 0;

index

size_t micro_os_plus::micro_test_plus::test_suite_base::index = 1

The test suite index, counting from 1.

Definition at line 341 of file test-suite.h.

341 size_t index = 1;

Referenced by micro_os_plus::micro_test_plus::test_reporter_tap::end_test_suite and micro_os_plus::micro_test_plus::test_runner::register_test_suite.

process_deferred_begin

bool micro_os_plus::micro_test_plus::test_suite_base::process_deferred_begin = true

Indicates whether to process deferred begin for test cases.

Definition at line 358 of file test-suite.h.

358 bool process_deferred_begin = true;

Referenced by micro_os_plus::micro_test_plus::test_suite_base::begin_test_case, micro_os_plus::micro_test_plus::test_suite_base::begin_test_suite and micro_os_plus::micro_test_plus::test_suite_base::end_test_suite.

successful_checks

size_t micro_os_plus::micro_test_plus::test_suite_base::successful_checks = 0

Number of successful checks in the current test case.

Definition at line 372 of file test-suite.h.

372 size_t successful_checks = 0;

Protected Member Attributes

callable_

std::function<void (void)> micro_os_plus::micro_test_plus::test_suite::callable_

protected

Callable object representing the test suite's execution logic.

Definition at line 474 of file test-suite.h.

474 std::function<void (void)> callable_;

Referenced by test_suite and run.

failed_checks_

size_t micro_os_plus::micro_test_plus::test_suite_base::failed_checks_ = 0

protected

Count of test conditions that failed.

Definition at line 330 of file test-suite.h.

330 size_t failed_checks_ = 0;

Referenced by micro_os_plus::micro_test_plus::test_suite_base::failed_checks, micro_os_plus::micro_test_plus::test_suite_base::increment_failed, micro_os_plus::micro_test_plus::test_suite_base::unused and micro_os_plus::micro_test_plus::test_suite_base::was_successful.

name_

const char* micro_os_plus::micro_test_plus::test_suite_base::name_

protected

The test suite name.

Definition at line 315 of file test-suite.h.

315 const char* name_;

Referenced by micro_os_plus::micro_test_plus::test_suite_base::test_suite_base, micro_os_plus::micro_test_plus::test_suite_base::begin_test_suite and micro_os_plus::micro_test_plus::test_suite_base::name.

successful_checks_

size_t micro_os_plus::micro_test_plus::test_suite_base::successful_checks_ = 0

protected

Count of test conditions that passed.

Definition at line 325 of file test-suite.h.

325 size_t successful_checks_ = 0;

Referenced by micro_os_plus::micro_test_plus::test_suite_base::increment_successful, micro_os_plus::micro_test_plus::test_suite_base::successful_checks, micro_os_plus::micro_test_plus::test_suite_base::unused and micro_os_plus::micro_test_plus::test_suite_base::was_successful.

test_case_name_

const char* micro_os_plus::micro_test_plus::test_suite_base::test_case_name_

protected

The current test case name.

Definition at line 320 of file test-suite.h.

320 const char* test_case_name_;

Referenced by micro_os_plus::micro_test_plus::test_suite_base::begin_test_case and micro_os_plus::micro_test_plus::test_suite_base::end_test_case.

test_cases_count_

size_t micro_os_plus::micro_test_plus::test_suite_base::test_cases_count_ = 0

protected

Count of test cases in the test suite.

Definition at line 335 of file test-suite.h.

335 size_t test_cases_count_ = 0;

Referenced by micro_os_plus::micro_test_plus::test_suite_base::begin_test_case, micro_os_plus::micro_test_plus::test_suite_base::test_cases_count and micro_os_plus::micro_test_plus::test_suite_base::unused.

The documentation for this class was generated from the following files:

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.14.0.

Declaration​

Included Headers​

Base class​

Public Constructors Index​

Public Destructor Index​

Public Operators Index​

Public Member Functions Index​

Public Member Attributes Index​

Protected Member Attributes Index​

Description​

Public Constructors​

test_suite()​

test_suite()​

test_suite()​

Public Destructor​

~test_suite()​

Public Operators​

operator=()​

operator=()​

Public Member Functions​

begin_test_case()​

begin_test_suite()​

end_test_case()​

end_test_suite()​

failed_checks()​

increment_failed()​

increment_successful()​

name()​

run()​

successful_checks()​

test_cases_count()​

unused()​

was_successful()​

Public Member Attributes​

current_test_case​

failed_checks​

index​

process_deferred_begin​

successful_checks​

Protected Member Attributes​

callable_​

failed_checks_​

name_​

successful_checks_​

test_case_name_​

test_cases_count_​

Declaration

Included Headers

Base class

Public Constructors Index

Public Destructor Index

Public Operators Index

Public Member Functions Index

Public Member Attributes Index

Protected Member Attributes Index

Description

Public Constructors

test_suite()

test_suite()

test_suite()

Public Destructor

~test_suite()

Public Operators

operator=()

operator=()

Public Member Functions

begin_test_case()

begin_test_suite()

end_test_case()

end_test_suite()

failed_checks()

increment_failed()

increment_successful()

name()

run()

successful_checks()

test_cases_count()

unused()

was_successful()

Public Member Attributes

current_test_case

failed_checks

index

process_deferred_begin

successful_checks

Protected Member Attributes

callable_

failed_checks_

name_

successful_checks_

test_case_name_

test_cases_count_