source: trunk/test/Suite.h @ 1432

#ifndef _theplu_yat_test_suite_
#define _theplu_yat_test_suite_

// $Id: Suite.h 1432 2008-08-25 13:54:18Z peter $

/*
  Copyright (C) 2008 Peter Johansson

  This file is part of the yat library, http://trac.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include <fstream>
#include <iostream>
#include <sstream>

namespace theplu {
namespace yat {
namespace test {

  /**
     \internal utility class for tests
   */
  class Suite
  {
  public:
    Suite(int argc, char* argv[]);

    /**
     */
    ~Suite(void);

    /**
       set ok to 'b && ok' 

       \return b
    */
    bool add(bool b);

    /**
       \return In verbose mode std::cerr, else a ofstream to "/dev/null".
    */
    std::ostream& err(void) const;

    /**
       \return true if \f$ |a-b| <= N * \epsilon * min(|a|,|b|) \f$
       where \f$ \epsilon \f$ is std::numeric_limits<double>().epsilon()
    */
    bool equal(double a, double b, unsigned long int N=1);

    /**
       \return true if \f$ |a-b| <= N * sqrt(\epsilon) * min(|a|,|b|) \f$
       where \f$ \epsilon \f$ is std::numeric_limits<double>().epsilon()
    */
    bool equal_sqrt(double a, double b, unsigned long int N=1);

    template<typename Iterator1, typename Iterator2>
    bool equal_range(Iterator1 first1, Iterator1 last1, Iterator2 first2,
                     unsigned int N=1);

    /**
      \return true if test is ok
    */
    bool ok(void) const;

    /**
       \return In verbose mode std::cout, else a ofstream to "/dev/null".
    */
    std::ostream& out(void) const;
    
    /**
       In verbose mode a final message is sent to std::cout.

       If ok() is true: "Test is ok." otherwise
       "Test failed."

       \return 0 if ok.
     */
    int return_value(void) const;

    /**
       Function writes to a stream using operator<<, creates a new
       object using stream constructor, and the new object is written
       to another stream, and function check if the two outputs are
       equal.
    */
    template<class T>
    bool test_stream(const T&) const;

  private:
    bool verbose_;
    bool ok_;
    std::ofstream* dev_null_;

  };

  /**
     \return absolute path to file
     \param local_path path relative to srcdir
   */
  std::string filename(const std::string& local_path);

  template<typename Iterator1, typename Iterator2>
  bool Suite::equal_range(Iterator1 first1, Iterator1 last1, Iterator2 first2,
                          unsigned int N)
  {
    while (first1!=last1){
      if (!this->equal(*first1, *first2, N) )  {
        return false;
      }
      ++first1;
      ++first2;
    }
    return true;
  }


  template<class T>
  bool Suite::test_stream(const T& t) const
  {
    this->err() << "Checking that output stream is valid as an input stream\n";
    std::stringstream ss;
    this->err() << "writing to output\n";
    ss << t;
    this->err() << "creating a new object from output\n";
    T t2(ss);
    std::stringstream ss2;
    this->err() << "writing to output\n";
    ss2 << t2;
    bool ok = ss2.str()==ss.str();
    if (!ok) {
      this->err() << "ERROR: first object gave following output:\n" 
                  << ss.str() << "\n"
                  << "ERROR: and second object gave following output:\n" 
                  << ss2.str() << "\n";
    }
    return ok;
  }

}}}

#endif