Teuchos - Trilinos Tools Package Version of the Day
Defines
Unit Testing Assert Macros
Unit Testing Support

Defines

#define ECHO(statement)   TEUCHOS_ECHO( statement, out )
 Echo the given statement before it is executed.
#define TEST_ASSERT(v1)   TEUCHOS_TEST_ASSERT( v1, out, success )
 Assert the given statement is true.
#define TEST_EQUALITY_CONST(v1, v2)   TEUCHOS_TEST_EQUALITY_CONST( v1, v2, out, success )
 Assert the equality of v1 and constant v2.
#define TEST_EQUALITY(v1, v2)   TEUCHOS_TEST_EQUALITY( v1, v2, out, success )
 Assert the equality of v1 and v2.
#define TEST_INEQUALITY_CONST(v1, v2)   TEUCHOS_TEST_INEQUALITY_CONST( v1, v2, out, success )
 Assert the inequality of v1 and constant v2.
#define TEST_INEQUALITY(v1, v2)   TEUCHOS_TEST_INEQUALITY( v1, v2, out, success )
 Assert the inequality of v1 and v2.
#define TEST_FLOATING_EQUALITY(v1, v2, tol)   TEUCHOS_TEST_FLOATING_EQUALITY( v1, v2, tol, out, success )
 Assert the relative floating-point equality of rel_error(v1,v2) <= tol.
#define TEST_ITER_EQUALITY(iter1, iter2)   TEUCHOS_TEST_ITER_EQUALITY( iter1, iter2, out, success )
 Assert that two iterators are equal.
#define TEST_ITER_INEQUALITY(iter1, iter2)   TEUCHOS_TEST_ITER_INEQUALITY( iter1, iter2, out, success )
 Assert that two iterators are NOT equal.
#define TEST_ARRAY_ELE_EQUALITY(a, i, val)   TEUCHOS_TEST_ARRAY_ELE_EQUALITY( a, i, val, false, out, local_success )
 Assert that a[i] == val.
#define TEST_ARRAY_ELE_INEQUALITY(a, i, val)   TEUCHOS_TEST_ARRAY_ELE_INEQUALITY( a, i, val, false, out, local_success )
 Assert that a[i] != val.
#define TEST_COMPARE(v1, comp, v2)   TEUCHOS_TEST_COMPARE( v1, comp, v2, out, success )
 Assert that v1 comp v2 (where comp = '==', '>=", "!=", etc).
#define TEST_COMPARE_ARRAYS(a1, a2)
 Assert that a1.size()==a2.size() and a[i]==b[i], i=0....
#define TEST_COMPARE_FLOATING_ARRAYS(a1, a2, tol)
 Assert that a1.size()==a2.size() and rel_error(a[i],b[i]) <= tol, i=0....
#define TEST_THROW(code, ExceptType)   TEUCHOS_TEST_THROW( code, ExceptType, out, success )
 Assert that the statement 'code' throws the exception 'ExceptType' (otherwise the test fails).
#define TEST_NOTHROW(code)   TEUCHOS_TEST_NOTHROW( code, out, success )
 Asserr that the statement 'code' does *not* thrown any excpetions.

Detailed Description

These are macros used to define individual checks within an single unit test (e.g. defined by TEUCHOS_UNIT_TEST()).

NOTE: When a single check fails, the unit test is not aborted but instead will just print the failure to the local stream 'out' with the line number and continue on.

NOTE: The local unit test stream object 'out' will be written to and the variable 'success' will be set to 'false' if a test fails.


Define Documentation

#define ECHO (   statement)    TEUCHOS_ECHO( statement, out )

Echo the given statement before it is executed.

Definition at line 63 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_ASSERT (   v1)    TEUCHOS_TEST_ASSERT( v1, out, success )

Assert the given statement is true.

Definition at line 71 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_EQUALITY_CONST (   v1,
  v2 
)    TEUCHOS_TEST_EQUALITY_CONST( v1, v2, out, success )

Assert the equality of v1 and constant v2.

Examples:
ArrayRCP_test.cpp.

Definition at line 79 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_EQUALITY (   v1,
  v2 
)    TEUCHOS_TEST_EQUALITY( v1, v2, out, success )

Assert the equality of v1 and v2.

Definition at line 87 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_INEQUALITY_CONST (   v1,
  v2 
)    TEUCHOS_TEST_INEQUALITY_CONST( v1, v2, out, success )

Assert the inequality of v1 and constant v2.

Definition at line 95 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_INEQUALITY (   v1,
  v2 
)    TEUCHOS_TEST_INEQUALITY( v1, v2, out, success )

Assert the inequality of v1 and v2.

Definition at line 103 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_FLOATING_EQUALITY (   v1,
  v2,
  tol 
)    TEUCHOS_TEST_FLOATING_EQUALITY( v1, v2, tol, out, success )

Assert the relative floating-point equality of rel_error(v1,v2) <= tol.

Definition at line 112 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_ITER_EQUALITY (   iter1,
  iter2 
)    TEUCHOS_TEST_ITER_EQUALITY( iter1, iter2, out, success )

Assert that two iterators are equal.

Definition at line 120 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_ITER_INEQUALITY (   iter1,
  iter2 
)    TEUCHOS_TEST_ITER_INEQUALITY( iter1, iter2, out, success )

Assert that two iterators are NOT equal.

Definition at line 128 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_ARRAY_ELE_EQUALITY (   a,
  i,
  val 
)    TEUCHOS_TEST_ARRAY_ELE_EQUALITY( a, i, val, false, out, local_success )

Assert that a[i] == val.

Definition at line 136 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_ARRAY_ELE_INEQUALITY (   a,
  i,
  val 
)    TEUCHOS_TEST_ARRAY_ELE_INEQUALITY( a, i, val, false, out, local_success )

Assert that a[i] != val.

Definition at line 144 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_COMPARE (   v1,
  comp,
  v2 
)    TEUCHOS_TEST_COMPARE( v1, comp, v2, out, success )

Assert that v1 comp v2 (where comp = '==', '>=", "!=", etc).

Definition at line 152 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_COMPARE_ARRAYS (   a1,
  a2 
)
Value:
{ \
    const bool l_result = compareArrays(a1,#a1,a2,#a2,out); \
    if (!l_result) success = false; \
  }

Assert that a1.size()==a2.size() and a[i]==b[i], i=0....

Works for any object types that support a1[i], a1.size(), a2[j], and a2.size() and types a1 and a2 can be different types!

Examples:
ArrayRCP_test.cpp.

Definition at line 163 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_COMPARE_FLOATING_ARRAYS (   a1,
  a2,
  tol 
)
Value:
{ \
    const bool result = compareFloatingArrays(a1,#a1,a2,#a2,tol,out); \
    if (!result) success = false; \
  }

Assert that a1.size()==a2.size() and rel_error(a[i],b[i]) <= tol, i=0....

Works for any object types that support a1[i], a1.size(), a2[j], and a2.size() and types a1 and a2 can be different types!

Definition at line 177 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_THROW (   code,
  ExceptType 
)    TEUCHOS_TEST_THROW( code, ExceptType, out, success )

Assert that the statement 'code' throws the exception 'ExceptType' (otherwise the test fails).

Definition at line 189 of file Teuchos_LocalTestingHelpers.hpp.

#define TEST_NOTHROW (   code)    TEUCHOS_TEST_NOTHROW( code, out, success )

Asserr that the statement 'code' does *not* thrown any excpetions.

Definition at line 197 of file Teuchos_LocalTestingHelpers.hpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines