学习笔记：解读CppUnit源码6

看了前面5章的话，就可以了解cppUnit大致的结构了。这里讲讲一些并不是很核心但却是不可货缺的代码。看看他们虽然学不到优秀的设计知识，但是巩固一下C++的基础也不错。

SourceLine.h

//SourceLine应该用这个接口来调用 #define CPPUNIT_SOURCELINE() ::CppUnit::MySourceLine( __FILE__, __LINE__ ) CPPUNIT_NS_BEGIN //记录了有关某个失败测试的错误所在位置， //包括源文件路径和文件内的行号 class CPPUNIT_API MySourceLine { public: MySourceLine() :m_lineNumber(-1) { }; //拷贝构造 MySourceLine( const MySourceLine &other ) { m_lineNumber = other.m_lineNumber; m_fileName = other.m_fileName; }; //拷贝构造 MySourceLine( const std::string &fileName, int lineNumber ) :m_lineNumber(lineNumber) ,m_fileName(fileName) { }; //赋值语句 MySourceLine &operator =( const MySourceLine &other ) { if (&other != this ) { m_fileName = other.fileName(); m_lineNumber = other.lineNumber(); } return *this; }; virtual ~MySourceLine(){}; //是否有文件 bool isValid() const { return !m_fileName.empty(); }; //返回行号 int lineNumber() const { return m_lineNumber; }; //返回文件名 std::string fileName() const { return m_fileName; }; //等于 bool operator ==( const MySourceLine &other ) const { if (m_lineNumber == other.lineNumber() && m_fileName == other.fileName()) { return true; } return false; }; //不等于 bool operator !=( const MySourceLine &other ) const { return !( *this == other ); }; private: std::string m_fileName;//文件名包括路径 int m_lineNumber;//行号 };

C中关于文件名和代码所在的行数有两个宏定义(__FILE__，__LINE__)，方便在调试和其他场合输出。而这个SourceLine类正是对两者的封装。需要补充一点请大家注意SourceLine::operator !=操作符重载，在它的方法实现里面，是调用了operator==，即保证了语义的正确，又避免了代码重复

 

Message.h

class CPPUNIT_API MyMessage { public: MyMessage(){}; MyMessage( const MyMessage &other ) { *this = other; }; explicit MyMessage( const std::string &shortDescription ) :m_shortDescription(shortDescription) { }; MyMessage( const std::string &shortDescription, const std::string &detail1 ) :m_shortDescription(shortDescription) { m_details.push_back(detail1); }; MyMessage( const std::string &shortDescription, const std::string &detail1, const std::string &detail2 ) :m_shortDescription(shortDescription) { m_details.push_back(detail1); m_details.push_back(detail2); }; MyMessage( const std::string &shortDescription, const std::string &detail1, const std::string &detail2, const std::string &detail3 ) :m_shortDescription(shortDescription) { m_details.push_back(detail1); m_details.push_back(detail2); m_details.push_back(detail3); }; MyMessage &operator =( const MyMessage &other ) { if ( this != &other ) { m_shortDescription = other.m_shortDescription.c_str(); m_details.clear(); Details::const_iterator it = other.m_details.begin(); Details::const_iterator itEnd = other.m_details.end(); while ( it != itEnd ) m_details.push_back( (*it++).c_str() ); } return *this; }; const std::string &shortDescription() const { return m_shortDescription; }; int detailCount() const { return m_details.size(); }; std::string detailAt( int index ) const { if ( index < 0 || index >= detailCount() ) throw std::invalid_argument( "Message::detailAt() : invalid index" ); return m_details.at(index); }; std::string details() const { std::string details; for ( Details::const_iterator it = m_details.begin(); it != m_details.end(); ++it ) { details += "- "; details += *it; details += '/n'; } return details; }; void clearDetails() { m_details.clear(); }; void MyMessage::addDetail( const MyMessage &message ) { m_details.insert( m_details.end(), message.m_details.begin(), message.m_details.end() ); } void setShortDescription( const std::string &shortDescription ) { m_shortDescription = shortDescription; }; bool operator ==( const MyMessage &other ) const { return m_shortDescription == other.m_shortDescription && m_details == other.m_details; }; bool operator !=( const MyMessage &other ) const { return !(*this == other); }; private: std::string m_shortDescription; typedef CppUnitDeque<std::string> Details; Details m_details; };

message类是对一个字符串(简短描述)和复数行字符串的一个封装。

Exception.h

class MyException :public std::exception { public: MyException( const MyMessage &message = MyMessage(), const MySourceLine &sourceLine = MySourceLine() ) : m_message( message ) , m_sourceLine( sourceLine ) { }; MyException( const MyException &other ) :std::exception(other) { m_message = other.m_message; m_sourceLine = other.m_sourceLine; }; virtual ~MyException() throw(){}; //赋值语句 MyException &operator =( const MyException &other ) { if (this != &other) { m_sourceLine = other.m_sourceLine; m_message = other.m_message; } return *this; }; //有关异常的详细描述 const char *what() const throw() {//重新定义std::exception的what方法 return m_message.details().c_str(); }; //返回错误发生处 MySourceLine sourceLine() const { return m_sourceLine; }; MyMessage message() const { return m_message; }; void setMessage( const MyMessage &message ) { m_message = m_message; }; //原型模式 virtual MyException *clone() const { return new MyException( *this ); }; protected: MyMessage m_message;// 与本次异常相关的描述信息 MySourceLine m_sourceLine;// 异常发生的具体位置 };

Exception类聚集了异常处理输出所需要的message和sourceLine。其中Exception继承自std::exception目的就是要重载what方法来输出错误信息。

TestFailure.h

class CPPUNIT_API MyTestFailure { public: MyTestFailure( MyTest *failedTest, MyException *thrownException, bool isError ) { m_failedTest = failedTest; m_thrownException = thrownException; m_isError = isError; }; virtual ~MyTestFailure () { delete m_thrownException; }; virtual MyTest *failedTest() const { return m_failedTest; }; virtual MyException *thrownException() const { return m_thrownException; }; virtual MySourceLine sourceLine() const { return m_thrownException->sourceLine(); }; virtual bool isError() const { return m_isError; } virtual std::string failedTestName() const { return m_failedTest->getName(); } virtual MyTestFailure *clone() const { return new MyTestFailure(m_failedTest, m_thrownException, m_isError); }; protected: MyTest *m_failedTest;// 指向失败的测试对象 MyException *m_thrownException;// 指向异常对象（如果有） bool m_isError;// 区分failure和error的标志 private: MyTestFailure( const MyTestFailure &other ); MyTestFailure &operator =( const MyTestFailure& other ); };

这个TestFailure类里面有两种状态：failure和error。failure是我们测试中断言报错的，error就是在保护里面报出的错误。这个类聚集了Test,Exception,Source,这个类的输出跟TestResult的子类：TestResultCollector里面输出。

 

接下来该看看具体如何输出数据

Outputter.h

//输出类的抽象基类 class CPPUNIT_API MyOutputter { public: virtual ~MyOutputter() {}; virtual void write() =0; };

CompilerOutputter.h

//以编译器兼容方式输出TestResultCollector中的内容 class CPPUNIT_API MyCompilerOutputter : public MyOutputter { public: /*! /brief Constructs a CompilerOutputter object. * /param result Result of the test run. * /param stream Stream used to output test result. * /param locationFormat Error location format used by your compiler. Default * to /c CPPUNIT_COMPILER_LOCATION_FORMAT which is defined * in the configuration file. See setLocationFormat() for detail. * /see setLocationFormat(). */ MyCompilerOutputter( MyTestResultCollector *result, std::ostream &stream, const std::string &locationFormat = CPPUNIT_COMPILER_LOCATION_FORMAT ) : m_result( result ) , m_stream( stream ) , m_locationFormat( locationFormat ) , m_wrapColumn( CPPUNIT_WRAP_COLUMN ) { }; /// Destructor. virtual ~MyCompilerOutputter(){}; void setLocationFormat( const std::string &locationFormat ) { m_locationFormat = locationFormat; }; /*! /brief Creates an instance of an outputter that matches your current compiler. * /deprecated This class is specialized through parameterization instead of subclassing... * Use CompilerOutputter::CompilerOutputter instead. */ static MyCompilerOutputter *defaultOutputter( MyTestResultCollector *result, std::ostream &stream ) { return new MyCompilerOutputter( result, stream ); }; void write() { if ( m_result->wasSuccessful() ) printSuccess(); else printFailureReport(); }; void setNoWrap(); void setWrapColumn( int wrapColumn ); int wrapColumn() const; virtual void printSuccess() { m_stream << "OK (" << m_result->runTests() << ")/n"; }; virtual void printFailureReport() { printFailuresList(); printStatistics(); }; virtual void printFailuresList() { for ( int index =0; index < m_result->testFailuresTotal(); ++index) { printFailureDetail( m_result->failures()[ index ] ); } }; virtual void printStatistics() { m_stream << "Failures !!!/n"; m_stream << "Run: " << m_result->runTests() << " " << "Failure total: " << m_result->testFailuresTotal() << " " << "Failures: " << m_result->testFailures() << " " << "Errors: " << m_result->testErrors() << "/n"; }; virtual void printFailureDetail( MyTestFailure *failure ) { printFailureLocation( failure->sourceLine() ); printFailureType( failure ); printFailedTestName( failure ); printFailureMessage( failure ); }; virtual void printFailureLocation( MySourceLine sourceLine ) { if ( !sourceLine.isValid() ) { m_stream << "##Failure Location unknown## : "; return; } std::string location; for ( unsigned int index = 0; index < m_locationFormat.length(); ++index ) { char c = m_locationFormat[ index ]; if ( c == '%' && ( index+1 < m_locationFormat.length() ) ) { char command = m_locationFormat[index+1]; if ( processLocationFormatCommand( command, sourceLine ) ) { ++index; continue; } } m_stream << c; } }; virtual void printFailureType( MyTestFailure *failure ) { m_stream << (failure->isError() ? "Error" : "Assertion"); }; virtual void printFailedTestName( MyTestFailure *failure ) { m_stream << "/nTest name: " << failure->failedTestName(); }; virtual void printFailureMessage( MyTestFailure *failure ) { m_stream << "/n"; }; private: MyCompilerOutputter( const MyCompilerOutputter © ); MyCompilerOutputter& operator =( const MyCompilerOutputter © ); virtual bool processLocationFormatCommand( char command, const MySourceLine &sourceLine ) { switch ( command ) { case 'p': m_stream << sourceLine.fileName(); return true; case 'l': m_stream << sourceLine.lineNumber(); return true; case 'f': m_stream << extractBaseName( sourceLine.fileName() ); return true; } return false; }; virtual std::string extractBaseName( const std::string &fileName ) const { int indexLastDirectorySeparator = fileName.find_last_of( '/' ); if ( indexLastDirectorySeparator < 0 ) indexLastDirectorySeparator = fileName.find_last_of( '//' ); if ( indexLastDirectorySeparator < 0 ) return fileName; return fileName.substr( indexLastDirectorySeparator +1 ); }; private: MyTestResultCollector *m_result; std::ostream &m_stream; std::string m_locationFormat; int m_wrapColumn; };

TextOutputter.h

//以纯文本格式输出TestResultCollector中的内容 class CPPUNIT_API MyTextOutputter : public MyOutputter { public: MyTextOutputter( MyTestResultCollector *result, std::ostream &stream ) :m_result(result),m_stream(stream) { }; virtual ~MyTextOutputter(){}; void write() { printHeader(); m_stream << "/n"; printFailures(); m_stream << "/n"; }; virtual void printFailures() { MyTestResultCollector::TestFailures::const_iterator itFailure = m_result->failures().begin(); int failureNumber = 1; while ( itFailure != m_result->failures().end() ) { m_stream << "/n"; printFailure( *itFailure++, failureNumber++ ); } }; virtual void printHeader() { if ( m_result->wasSuccessful() ) m_stream << "/nOK (" << m_result->runTests () << " tests)/n" ; else { m_stream << "/n"; printFailureWarning(); printStatistics(); } }; virtual void printFailure( MyTestFailure *failure, int failureNumber ) { printFailureListMark( failureNumber ); m_stream << ' '; printFailureTestName( failure ); m_stream << ' '; printFailureType( failure ); m_stream << ' '; printFailureLocation( failure->sourceLine() ); m_stream << "/n"; printFailureDetail( failure->thrownException() ); m_stream << "/n"; }; virtual void printFailureListMark( int failureNumber ) { m_stream << failureNumber << ")"; }; virtual void printFailureTestName( MyTestFailure *failure ) { m_stream << "test: " << failure->failedTestName(); }; virtual void printFailureType( MyTestFailure *failure ) { m_stream << "(" << (failure->isError() ? "E" : "F") << ")"; }; virtual void printFailureLocation( MySourceLine sourceLine ) { if ( !sourceLine.isValid() ) return; m_stream << "line: " << sourceLine.lineNumber() << ' ' << sourceLine.fileName(); }; virtual void printFailureDetail( MyException *thrownException ) { m_stream << thrownException->message().shortDescription() << "/n"; m_stream << thrownException->message().details(); }; virtual void printFailureWarning() { m_stream << "!!!FAILURES!!!/n"; }; virtual void printStatistics() { m_stream << "Test Results:/n"; m_stream << "Run: " << m_result->runTests() << " Failures: " << m_result->testFailures() << " Errors: " << m_result->testErrors() << "/n"; }; protected: MyTestResultCollector *m_result; std::ostream &m_stream; private: MyTextOutputter( const MyTextOutputter © ); MyTextOutputter& operator =( const MyTextOutputter © ); };

如何输出测试信息还有一个类叫：XMLOutputter，具体如何输出个人觉得没有什么好研究的，所以在这里就一笔带过了。