basics/testcase.hh

Go to the documentation of this file.

// Test from Chuck Allison in C/C++ Users Journal, September 2000:
// "The Simplest Automated Unit Test Framework That Could Possibly Work"

#ifndef TEST_H
#define TEST_H

#include <iostream>
#include <string>
#include <iosfwd>
#include <complex>

namespace test {

  using std::string;
  using std::ostream;

  // The following have underscores because they are macros
  // (and it's impolite to usurp other users' functions!).
  // For consistency, _succeed() also has an underscore.

#define _test(cond) do_test(cond, #cond, __FILE__, __LINE__)

#define _numtest(num, orig) do_numtest(num, orig, #num, #orig, __FILE__, __LINE__)

#define _numtesttol(num, orig, tol) do_numtest(num, orig, #num, #orig, __FILE__, __LINE__, tol)

#define _fail(str) do_fail(str, __FILE__, __LINE__)

  class TestCase {
  public:
    TestCase(ostream* osptr = 0);
    virtual ~TestCase() {}
    virtual void run() = 0;

    long getNumPassed() const { return m_nPass; }
    long getNumFailed() const { return m_nFail; }
    const ostream* getStream() const { return m_osptr; }
    void setStream(ostream* osptr) { m_osptr = osptr; }

    void _succeed() { ++m_nPass; }
    long report() const;
    virtual void reset() { m_nPass = m_nFail = 0; }
  protected:
    bool do_test(bool cond, const string& lbl,
                 const char* fname, long lineno);
    bool do_numtest(double num, double orig, const string& lbl,
        const string& lbl2, const char* fname, long lineno,
        const double tol = 1e-10);
    bool do_numtest(std::complex<double> num, std::complex<double> orig,
        const string& lbl, const string& lbl2, const char* fname,
        long lineno, const double tol = 1e-10);
    void do_fail(const string& lbl,
                 const char* fname, long lineno);
  private:
    ostream* m_osptr;
    long m_nPass;
    long m_nFail;

    TestCase(const TestCase&);
    TestCase& operator=(const TestCase&);
  };

  inline TestCase::TestCase(ostream* osptr) :
    m_osptr(osptr), m_nPass(0), m_nFail(0) {
    if (m_osptr == 0)
      m_osptr = &std::cout;
  }

} // namespace test

#endif // TEST_H