micro-test-plus.h File Reference

Main C++ header with the declarations for the µTest++ Testing Framework. More...

#include "micro-test-plus/math.h"
#include "micro-test-plus/extension.h"
#include "micro-test-plus/reflection.h"
#include "micro-test-plus/detail.h"
#include "micro-test-plus/function-comparators.h"
#include "micro-test-plus/exceptions.h"
#include "micro-test-plus/expression-formatter.h"
#include "micro-test-plus/runner-options.h"
#include "micro-test-plus/reporter.h"
#include "micro-test-plus/check-result.h"
#include "micro-test-plus/counters.h"
#include "micro-test-plus/reporter-human.h"
#include "micro-test-plus/reporter-tap.h"
#include "micro-test-plus/utility.h"
#include "micro-test-plus/test.h"
#include "micro-test-plus/runner.h"
#include "micro-test-plus/deprecated.h"

Go to the source code of this file.

Macros
#define	MICRO_OS_PLUS_MICRO_TEST_PLUS_DEPRECATED_ENABLED
	Enables the deprecated definitions of the µTest++ Testing Framework.
#define	MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED
	Enables the µTest++ Testing Framework.
#define	MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
	Enables the trace messages of the µTest++ constructors and destructors.
#define	MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
	Enables the trace messages of the µTest++ member functions.

Detailed Description

This header is the entry point of the µTest++ testing framework, for both embedded and general C++ projects.

It provides all essential declarations required to write and manage tests, including test runner and reporter objects, test suite and test case management, expectations and requirements, function comparators, logical functions, exception verification, and utility functions.

The header also includes all the other headers of the framework.

All public API definitions reside within the micro_os_plus::micro_test_plus namespace and its nested namespaces.

This file is located in the top-level include/micro-os-plus folder; all the other header files are in the include/micro-os-plus/micro-test-plus folder.

To access the complete functionality of the µTest++ framework, users should include this header in their test projects.

The implementation is significantly inspired by Boost UT, with adaptations and extensions to address the requirements of embedded development and the µTest++ framework.

Definition in file micro-test-plus.h.