..
    Copyright (c) 2019 The STE||AR-Group

    SPDX-License-Identifier: BSL-1.0
    Distributed under the Boost Software License, Version 1.0. (See accompanying
    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

.. _modules_testing:

=======
testing
=======

The testing module contains useful macros for testing. The results of tests can
be printed with :cpp:func:`hpx::util::report_errors`. The following macros are
provided:

* :c:macro:`HPX_TEST`
* :c:macro:`HPX_TEST_MSG`
* :c:macro:`HPX_TEST_EQ`
* :c:macro:`HPX_TEST_NEQ`
* :c:macro:`HPX_TEST_LT`
* :c:macro:`HPX_TEST_LTE`
* :c:macro:`HPX_TEST_RANGE`
* :c:macro:`HPX_TEST_EQ_MSG`
* :c:macro:`HPX_TEST_NEQ_MSG`
* :c:macro:`HPX_SANITY`
* :c:macro:`HPX_SANITY_MSG`
* :c:macro:`HPX_SANITY_EQ`
* :c:macro:`HPX_SANITY_NEQ`
* :c:macro:`HPX_SANITY_LT`
* :c:macro:`HPX_SANITY_LTE`
* :c:macro:`HPX_SANITY_RANGE`
* :c:macro:`HPX_SANITY_EQ_MSG`

See the :ref:`API reference <modules_testing_api>` of the module for more details.
