TestSuite.h

Go to the documentation of this file.

/*
 * Robot Testing Framework
 *
 * Copyright (C) 2015-2019 Istituto Italiano di Tecnologia (IIT)
 *
 * 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.
 *
 * 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 ROBOTTESTINGFRAMEWORK_TESTSUITE_H
#define ROBOTTESTINGFRAMEWORK_TESTSUITE_H

#include <robottestingframework/FixtureManager.h>
#include <robottestingframework/Test.h>
#include <robottestingframework/TestMessage.h>
#include <robottestingframework/TestResult.h>

#include <vector>

namespace robottestingframework {

class TestSuite :
        public Test,
        public FixtureEvents
{

    typedef std::vector<Test*> TestContainer;
    typedef std::vector<Test*>::iterator TestIterator;
    typedef std::vector<FixtureManager*> FixtureContainer;
    typedef std::vector<FixtureManager*>::iterator FixtureIterator;
    typedef std::vector<FixtureManager*>::reverse_iterator FixtureRIterator;

public:
    TestSuite(std::string name);

    virtual ~TestSuite();

    void addTest(Test* test);

    void removeTest(Test* test);

    void reset();

    void addFixtureManager(FixtureManager* manager);

    void fixtureCollapsed(TestMessage reason) override;

    void run(TestResult& rsl) override;

    void interrupt() override;

    bool succeeded() const override;

    TestResult* getResult();

    std::size_t size() const;

protected:
    virtual bool setup();

    virtual void tearDown();

private:
    Test* current;
    TestResult* result;
    bool successful;
    bool fixtureOK;
    bool interrupted;
    TestMessage fixtureMessage;
    FixtureContainer fixtureManagers;
    TestContainer tests;
};

} // namespace robottestingframework

#endif // ROBOTTESTINGFRAMEWORK_TESTSUITE_H