Testing.hpp File Reference

#include <Pothos/Config.hpp>
#include <Pothos/Plugin.hpp>
#include <Pothos/Callable.hpp>
#include <Pothos/Exception.hpp>
#include <memory>
#include <string>

Go to the source code of this file.

Classes
struct	Pothos::TestingBase

Namespaces
	Pothos

Macros
#define	POTHOS_TEST_BLOCK(path, name)
#define	POTHOS_TEST_CHECKPOINT()   Pothos::TestingBase::current().report("checkpoint", "", "", __LINE__, __FILE__)
	Checkpoint macro to track last successful line executed. More...
#define	__POTHOS_TEST_STATEMENT(message, statement)
	Private macro to test a statement for exceptions. More...
#define	__POTHOS_TEST_ASSERT(message, statement)
	Private macro to assert on a statement's truth. More...
#define	POTHOS_TEST_TRUE(statement)
	Test if statement is true. More...
#define	POTHOS_TEST_EQUAL(lhs, rhs)
	Test if an equality operation is true. More...
#define	POTHOS_TEST_CLOSE(lhs, rhs, tol)
	Test if two values are equal within tolerance. More...
#define	POTHOS_TEST_EQUALV(lhs, rhs)
	Test two vectors for equality. More...
#define	POTHOS_TEST_EQUALA(lhs, rhs, size)
	Test two arrays for equality. More...
#define	POTHOS_TEST_THROWS(statement, expectedException)
	Test that a statement throws a particular exception. More...

Detailed Description

Macros for creating self-test plugins. Self tests are installed into the registry and executed at runtime. The test macros are loosely based on the Boost unit test suite.

Copyright

Copyright (c) 2013-2017 Josh Blum SPDX-License-Identifier: BSL-1.0

Macro Definition Documentation

__POTHOS_TEST_ASSERT

#define __POTHOS_TEST_ASSERT	(		message,
			statement
	)

Value:

{ \
    __POTHOS_TEST_STATEMENT(message, if (statement) {} else throw std::string("statement \"" #statement "\" evaluated false");); \
}

Private macro to assert on a statement's truth.

__POTHOS_TEST_STATEMENT

#define __POTHOS_TEST_STATEMENT	(		message,
			statement
	)

Value:

{ \
    Pothos::TestingBase::current().report(message, #statement, "", __LINE__, __FILE__); \
    try{statement;} \
    catch(const std::string &ex){Pothos::TestingBase::current().report(message, #statement, ex, __LINE__, __FILE__);} \
    catch(const Pothos::Exception &ex){Pothos::TestingBase::current().report(message, #statement, ex.displayText(), __LINE__, __FILE__);} \
    catch(const std::exception &ex){Pothos::TestingBase::current().report(message, #statement, ex.what(), __LINE__, __FILE__);} \
    catch(...){Pothos::TestingBase::current().report(message, #statement, "unknown", __LINE__, __FILE__);} \
}

Private macro to test a statement for exceptions.

POTHOS_TEST_BLOCK

#define POTHOS_TEST_BLOCK	(		path,
			name
	)

Value:

POTHOS_STATIC_FIXTURE_DECL void name ## Runner(void); \
    template <Pothos::Detail::InitFcn runner> \
    struct name : Pothos::TestingBase \
    { \
        void runTestsImpl(void) \
        { \
            POTHOS_TEST_CHECKPOINT(); \
            runner(); \
        } \
    }; \
    pothos_static_block(name) \
    { \
        std::shared_ptr<Pothos::TestingBase> testObj(new name<name ## Runner>()); \
        Pothos::PluginRegistry::add(Pothos::Plugin( \
            Pothos::PluginPath(path).join(#name), Pothos::Object(testObj))); \
    } \
    POTHOS_STATIC_FIXTURE_DECL void name ## Runner(void)

Declare a unit test block of code inside a plugin.

The unit test will be installed into /path/name in the PluginRegistry. Once installed, this unit test can be checked with the test utility.

Parameters

path	a valid PluginPath
name	a valid function name

Example usage:

POTHOS_TEST_BLOCK("/sys/foo", test_bar)
{
    POTHOS_TEST_EQUAL(etc...);
}

POTHOS_TEST_CHECKPOINT

#define POTHOS_TEST_CHECKPOINT

(

)

Pothos::TestingBase::current().report("checkpoint", "", "", __LINE__, __FILE__)

Checkpoint macro to track last successful line executed.

POTHOS_TEST_CLOSE

#define POTHOS_TEST_CLOSE	(		lhs,
			rhs,
			tol
	)

Value:

{ \
    __POTHOS_TEST_ASSERT( \
        "assert close " + Pothos::TestingBase::current().toString(lhs) + \
        " ~= " + Pothos::TestingBase::current().toString(rhs), (std::abs((lhs) - (rhs)) <= (tol))); \
}

Test if two values are equal within tolerance.

POTHOS_TEST_EQUAL

#define POTHOS_TEST_EQUAL	(		lhs,
			rhs
	)

Value:

{ \
    __POTHOS_TEST_ASSERT( \
        "assert equal " + Pothos::TestingBase::current().toString(lhs) + \
        " == " + Pothos::TestingBase::current().toString(rhs), (lhs) == (rhs)); \
}

Test if an equality operation is true.

POTHOS_TEST_EQUALA

#define POTHOS_TEST_EQUALA	(		lhs,
			rhs,
			size
	)

Value:

{ \
    for (size_t i = 0; i < (size); i++) \
    { \
        __POTHOS_TEST_ASSERT( \
            "index " + Pothos::TestingBase::current().toString(i) + \
            " asserts " + Pothos::TestingBase::current().toString((lhs)[i]) + \
            " == " + Pothos::TestingBase::current().toString((rhs)[i]), (lhs)[i] == (rhs)[i]); \
    } \
}

Test two arrays for equality.

POTHOS_TEST_EQUALV

#define POTHOS_TEST_EQUALV	(		lhs,
			rhs
	)

Value:

{ \
    POTHOS_TEST_EQUAL((lhs).size(), (rhs).size()); \
    for (size_t i = 0; i < (lhs).size(); i++) \
    { \
        __POTHOS_TEST_ASSERT( \
            "index " + Pothos::TestingBase::current().toString(i) + \
            " asserts " + Pothos::TestingBase::current().toString((lhs)[i]) + \
            " == " + Pothos::TestingBase::current().toString((rhs)[i]), (lhs)[i] == (rhs)[i]); \
    } \
}

Test two vectors for equality.

POTHOS_TEST_THROWS

#define POTHOS_TEST_THROWS	(		statement,
			expectedException
	)

Value:

{ \
    Pothos::TestingBase::current().report(#statement, #statement, "", __LINE__, __FILE__); \
    __POTHOS_TEST_STATEMENT(#statement " must throw " #expectedException, \
        try{statement;throw std::string("statement \"" #statement "\" did not throw");} \
        catch(const expectedException &){}); \
}

Test that a statement throws a particular exception.

POTHOS_TEST_TRUE

#define POTHOS_TEST_TRUE

(

statement

)

Value:

{ \
    __POTHOS_TEST_ASSERT("assert true " #statement, statement); \
}

Test if statement is true.