TestResult.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBTEST_TESTRESULT_H
#define __LIBTEST_TESTRESULT_H
 
#include <String.h>
 
#define OK   TestResult( TestResult::Success )
#define FAIL TestResult( TestResult::Failure )
#define SKIP TestResult( TestResult::Skipped )
 
class TestResult
{
  public:
 
    enum Result
    {
        Success,
        Failure,
        Skipped
    };
 
  public:
 
    TestResult(Result result, const char *description = "");
 
    bool isOK() const;
 
    bool isFailed() const;
 
    bool isSkipped() const;
 
    const Result getResult() const;
 
    String & getDescription();
 
  private:
 
    const Result m_result;
 
    String m_description;
};
 
#endif /* __LIBTEST_TESTRESULT_H */