Test.h

/*
 * Copyright (C) 2005-2008 by Dr. Marc Boris Duerner
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * This 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef PT_UNIT_TEST_H
#define PT_UNIT_TEST_H

#include <Pt/Unit/Api.h>
#include <Pt/Unit/Reporter.h>
#include <Pt/Unit/Assertion.h>
#include <Pt/NonCopyable.h>
#include <string>
#include <list>

namespace Pt {

namespace Unit {

    class TestContext;

    class PT_UNIT_API Test : protected NonCopyable
    {
        public:
            virtual ~Test();

            virtual void run() = 0;

            const std::string& name() const;

            void reportStart(const TestContext& ctx);

            void reportFinish(const TestContext& ctx);

            void reportSuccess(const TestContext& ctx);

            void reportAssertion(const TestContext& ctx, const Assertion& ass);

            void reportException(const TestContext& ctx, const std::exception& ex);

            void reportError(const TestContext& ctx);

            void reportMessage(const std::string& msg);

            void setParent(Test* test);

            Test* parent();

            const Test* parent() const;

            void attachReporter(Reporter& r);

            void detachReporter(Reporter& r);

        protected:
            explicit Test(const std::string& name)
            : _name(name)
            , _parent(0)
            { }

        private:
            std::string _name;
            Test* _parent;
            std::list<Reporter*> _reporter;
    };

} // namespace Unit

} // namespace Pt

#endif