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/type-traits.h"
#include "micro-test-plus/reflection.h"
#include "micro-test-plus/detail.h"
#include "micro-test-plus/literals.h"
#include "micro-test-plus/function-comparators.h"
#include "micro-test-plus/exceptions.h"
#include "micro-test-plus/operators.h"
#include "micro-test-plus/expression-formatter.h"
#include "micro-test-plus/reporter.h"
#include "micro-test-plus/deferred-reporter.h"
#include "micro-test-plus/runner-totals.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"

Go to the source code of this file.

Macros
#define	MICRO_OS_PLUS_MICRO_TEST_PLUS_ENABLED
	Enables the µTest++ Testing Framework.
#define	MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_CONSTRUCTORS_ENABLED
	Enable trace in constructors and destructors in µTest++.
#define	MICRO_OS_PLUS_MICRO_TEST_PLUS_TRACE_ENABLED
	Enable trace in class methods in µTest++.

Detailed Description

This header serves as the principal entry point for the µTest++ testing framework, purpose-built 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, assumptions, comparators, logical operators, exception verification, and utility functions.

The header also incorporates all necessary dependencies and internal headers to ensure the framework operates correctly and efficiently.

All public API definitions reside within the micro_os_plus::micro_test_plus namespace and its nested namespaces, ensuring clear separation from user code and minimising the risk of naming conflicts.

This file is located in the top-level include/micro-os-plus directory; all other header files are organised within the include/micro-os-plus/micro-test-plus directory to maintain a structured and modular codebase.

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.