FUTester.hpp 5.36 KB
Newer Older
1
// See LICENCE file at project root
2 3
#ifndef UTESTER_HPP
#define UTESTER_HPP
4

5
#include "ScalFmmConfig.h"
6 7 8 9

#include <iostream>
#include <list>
#include <string>
10
#include <cstdio>
11 12 13


#define TestClass(X)\
14 15 16 17
    int main(void){\
    X Controller;\
    return Controller.Run();\
    }\
18 19 20 21 22 23 24 25 26 27


/**
* @author Berenger Bramas (berenger.bramas@inria.fr)
* Please read the license
*
* This class is used to make simple unit test cases
*
* Please refer to testUTest.cpp to see an example
* @warning Create a derived class that implement SetTests() and use TestClass() macro
BRAMAS Berenger's avatar
BRAMAS Berenger committed
28
*
29
* We recommend to have a look to a unit test to better understand how it works,
BRAMAS Berenger's avatar
BRAMAS Berenger committed
30
* as for example @example TestList
31 32 33
*/
template <class TestClass>
class FUTester{
34 35 36 37 38 39 40 41 42 43
    // Test function pointer
    typedef void (TestClass::*TestFunc)(void);

    /** Test descriptor */
    struct TestFuncDescriptor{
        TestFunc func;		//< Test adress
        std::string name;	//< Test name
    };


44
    std::list<TestFuncDescriptor> tests={};	//< all tests
45 46 47 48 49 50 51 52 53

    int totalTests;				//< number of tests

    int currentTest;			//< current processing test in the run
    int currentStep;			//< current processing step in the run

    int failedSteps;			//< number of failed step in the current test
    int failedTests;			//< number of failed tests

54
protected:
55
    /** Constructor */
56 57
  FUTester() : totalTests(0),currentTest(0),currentStep(0),failedSteps(0),failedTests(0)
  {    }
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

    /** Callback before processing test */
    virtual void Before(){}

    /** Callback after processing test */
    virtual void After(){}

    /** Callback before each unit test */
    virtual void PreTest(){}

    /** Callback after each unit test */
    virtual void PostTest(){}

    /**
    * This function has to add tests
73
        * <code> AddTest(&MyTest::TestOne); </code>
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
    */
    virtual void SetTests() = 0;

    /**
    * Add a test without giving a name
    * @param inFunc test function address
    */
    void AddTest(TestFunc inFunc){
        char buff[256];
        sprintf(buff,"Unnamed Test number %d",totalTests+1);
        AddTest(inFunc,buff);
    }

    /**
    * Add a test with a name
    * @param inFunc test function address
    * @param inFuncName function name
    */
    void AddTest(TestFunc inFunc, const std::string& inFuncName){
        ++totalTests;
        TestFuncDescriptor desc;
        desc.func = inFunc;
        desc.name = inFuncName;
        tests.push_back(desc);
    }

    /**
    * To print a message manually in the test
    * @param value a object that ostream can work on
    */
    template <class Output>
    void Print(const Output& value){
        std::cout<< "--- Output from program : " << value << "\n";
    }

    /**
    * To test
    * @param result the test result
    * if result is false test failed
    */
    void uassert(const bool result){
        ++currentStep;
        if(!result){
            std::cout << ">> Step " << currentStep << " Failed\n";
            ++failedSteps;
        }
    }

    /**
    * To test equality
    * @param v1 value one
    * @param v2 value 2
    * if v1 is not equal v2 test failed
    */
    template <class T>
    void equal(const T& v1, const T& v2){
        uassert(v1 == v2);
    }

    /**
    * To test equality
    * @param v1 value one
    * @param v2 value 2
    * if v1 is equal v2 test failed
    */
    template <class T>
    void different(const T& v1, const T& v2){
        uassert(v1 != v2);
    }

144
public :
145 146
    /**
    * Processing the test
147
        * return application exit code (= nb of errors)
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    */
    int Run(){
        tests.clear();
        // register tests
        SetTests();

        TestClass* const toTest = static_cast<TestClass*>(this);
        currentTest = 0;
        failedTests = 0;

        Before();

        // for each tests
        const typename std::list<TestFuncDescriptor>::const_iterator end = tests.end();
        for(typename std::list<TestFuncDescriptor>::iterator iter = tests.begin() ; iter != end ; ++iter){
            currentStep = 0;
            failedSteps = 0;

            std::cout << "[Start] " << (*iter).name << "\n";

            PreTest();
            TestFunc ff = (*iter).func;
            (toTest->*ff)();
            PostTest();

            if(failedSteps){
                std::cout << "[Finished] FAILED (" << failedSteps << "/" << currentStep<< " steps failed)\n";
                ++failedTests;
            }
            else{
                std::cout << "[Finished] PASSED (" << currentStep << " steps)\n";
            }

            ++currentTest;
        }


        After();

        std::cout <<"Test is over, " << (totalTests-failedTests) << " Passed, " << failedTests << " Failed\n";

        return failedTests;
    }
191 192 193

};

194
#ifdef SCALFMM_USE_MPI
195

BRAMAS Berenger's avatar
BRAMAS Berenger committed
196
#include "Utils/FMpi.hpp"
197

198
#define TestClassMpi(X)						\
199
    int main(int argc, char** argv){				\
200 201
    X Controller(argc,argv);					\
    return Controller.Run();					\
202 203
    }								\

204 205 206
template <class TestClass>
class FUTesterMpi : public FUTester<TestClass>{
protected:
207 208 209 210 211
    FMpi app;

    //Constructor with params to initialize FMpi
    FUTesterMpi(int argc, char ** argv) : app(argc,argv){
    }
212

213
    /**
214 215 216
   * To print a message manually in the test
   * @param value a object that ostream can work on
   */
217 218 219 220 221
    template <class Output>
    void Print(const Output& value){
        if(app.global().processId()==0){
            std::cout<< "--- Output from program : " << value << "\n";
        }
222 223
    }

224

225
};
226

227
#endif  
228
#endif