| CppUnit project page | FAQ | CppUnit home page |
A set of functions to help writing assertion macros.Here is an example of assertion, a simplified version of the actual assertion implemented in examples/cppunittest/XmlUniformiser.h: More...
#include <Asserter.h>
Static Public Member Functions | |
| static void CPPUNIT_API | fail (const Message &message, const SourceLine &sourceLine=SourceLine()) |
| Throws a Exception with the specified message and location. | |
| static void CPPUNIT_API | fail (std::string message, const SourceLine &sourceLine=SourceLine()) |
| Throws a Exception with the specified message and location. | |
| static void CPPUNIT_API | failIf (bool shouldFail, const Message &message, const SourceLine &sourceLine=SourceLine()) |
| Throws a Exception with the specified message and location. | |
| static void CPPUNIT_API | failIf (bool shouldFail, std::string message, const SourceLine &sourceLine=SourceLine()) |
| Throws a Exception with the specified message and location. | |
| static std::string CPPUNIT_API | makeExpected (const std::string &expectedValue) |
| Returns a expected value string for a message. Typically used to create 'not equal' message, or to check that a message contains the expected content when writing unit tests for your custom assertions. | |
| static std::string CPPUNIT_API | makeActual (const std::string &actualValue) |
| Returns an actual value string for a message. Typically used to create 'not equal' message, or to check that a message contains the expected content when writing unit tests for your custom assertions. | |
| static Message CPPUNIT_API | makeNotEqualMessage (const std::string &expectedValue, const std::string &actualValue, const AdditionalMessage &additionalMessage=AdditionalMessage(), const std::string &shortDescription="equality assertion failed") |
| static void CPPUNIT_API | failNotEqual (std::string expected, std::string actual, const SourceLine &sourceLine, const AdditionalMessage &additionalMessage=AdditionalMessage(), std::string shortDescription="equality assertion failed") |
| Throws an Exception with the specified message and location. | |
| static void CPPUNIT_API | failNotEqualIf (bool shouldFail, std::string expected, std::string actual, const SourceLine &sourceLine, const AdditionalMessage &additionalMessage=AdditionalMessage(), std::string shortDescription="equality assertion failed") |
| Throws an Exception with the specified message and location. | |
A set of functions to help writing assertion macros.
Here is an example of assertion, a simplified version of the actual assertion implemented in examples/cppunittest/XmlUniformiser.h:
#include <cppunit/SourceLine.h> #include <cppunit/TestAssert.h> void checkXmlEqual( std::string expectedXml, std::string actualXml, CppUnit::SourceLine sourceLine ) { std::string expected = XmlUniformiser( expectedXml ).stripped(); std::string actual = XmlUniformiser( actualXml ).stripped(); if ( expected == actual ) return; ::CppUnit::Asserter::failNotEqual( expected, actual, sourceLine ); } #define CPPUNITTEST_ASSERT_XML_EQUAL( expected, actual ) \ checkXmlEqual( expected, actual, \ CPPUNIT_SOURCELINE() )
| void Asserter::fail | ( | const Message & | message, |
| const SourceLine & | sourceLine = SourceLine() |
||
| ) | [static] |
Throws a Exception with the specified message and location.
| CPPUNIT_NS_BEGIN void Asserter::fail | ( | std::string | message, |
| const SourceLine & | sourceLine = SourceLine() |
||
| ) | [static] |
Throws a Exception with the specified message and location.
| void Asserter::failIf | ( | bool | shouldFail, |
| std::string | message, | ||
| const SourceLine & | sourceLine = SourceLine() |
||
| ) | [static] |
Throws a Exception with the specified message and location.
| shouldFail | if true then the exception is thrown. Otherwise nothing happen. |
| message | Message explaining the assertion failiure. |
| sourceLine | Location of the assertion. |
| void Asserter::failIf | ( | bool | shouldFail, |
| const Message & | message, | ||
| const SourceLine & | sourceLine = SourceLine() |
||
| ) | [static] |
| void Asserter::failNotEqual | ( | std::string | expected, |
| std::string | actual, | ||
| const SourceLine & | sourceLine, | ||
| const AdditionalMessage & | additionalMessage = AdditionalMessage(), |
||
| std::string | shortDescription = "equality assertion failed" |
||
| ) | [static] |
Throws an Exception with the specified message and location.
| expected | Text describing the expected value. |
| actual | Text describing the actual value. |
| sourceLine | Location of the assertion. |
| additionalMessage | Additional message. Usually used to report what are the differences between the expected and actual value. |
| shortDescription | Short description for the failure message. |
| void Asserter::failNotEqualIf | ( | bool | shouldFail, |
| std::string | expected, | ||
| std::string | actual, | ||
| const SourceLine & | sourceLine, | ||
| const AdditionalMessage & | additionalMessage = AdditionalMessage(), |
||
| std::string | shortDescription = "equality assertion failed" |
||
| ) | [static] |
Throws an Exception with the specified message and location.
| shouldFail | if true then the exception is thrown. Otherwise nothing happen. |
| expected | Text describing the expected value. |
| actual | Text describing the actual value. |
| sourceLine | Location of the assertion. |
| additionalMessage | Additional message. Usually used to report where the "difference" is located. |
| shortDescription | Short description for the failure message. |
| std::string Asserter::makeActual | ( | const std::string & | actualValue | ) | [static] |
Returns an actual value string for a message. Typically used to create 'not equal' message, or to check that a message contains the expected content when writing unit tests for your custom assertions.
| actualValue | String that represents the actual value. |
| std::string Asserter::makeExpected | ( | const std::string & | expectedValue | ) | [static] |
Returns a expected value string for a message. Typically used to create 'not equal' message, or to check that a message contains the expected content when writing unit tests for your custom assertions.
| expectedValue | String that represents the expected value. |
| Message Asserter::makeNotEqualMessage | ( | const std::string & | expectedValue, |
| const std::string & | actualValue, | ||
| const AdditionalMessage & | additionalMessage = AdditionalMessage(), |
||
| const std::string & | shortDescription = "equality assertion failed" |
||
| ) | [static] |
|
|
hosts this site. |
Send comments to: CppUnit Developers |