scenariocase.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Ondrej Starek
 *
 * This file is part of OTest2
 *
 * OTest2 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 3 of the License,
 * or (at your option) any later version.
 *
 * OTest2 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 OTest2.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef OTest2_INCLUDE_OTEST2_SCENARIOCASE_H_
#define OTest2_INCLUDE_OTEST2_SCENARIOCASE_H_
 
#include <otest2/objectrepeaterfactoryptr.h>
#include <otest2/scenario.h>
 
namespace OTest2 {
 
class Tags;
class ScenarioCaseBuilder;
 
class ScenarioCase : public Scenario {
  private:
    struct Impl;
    Impl* pimpl;
    friend class ScenarioCaseBuilder;
 
  public:
    explicit ScenarioCase(
        const std::string& name_,
        const Tags& tags_,
        ObjectRepeaterFactoryPtr repeater_factory_);
 
    explicit ScenarioCase(
        const std::string& name_,
        const std::string& section_path_,
        const Tags& tags_,
        ObjectRepeaterFactoryPtr repeater_factory_);
 
    static ScenarioCaseBuilder createBuilder(
        const std::string& name_,
        const Tags& tags_,
        ObjectRepeaterFactoryPtr repeater_factory_);
 
    virtual ~ScenarioCase();
 
    /* -- avoid copying */
    ScenarioCase(
        const ScenarioCase&) = delete;
    ScenarioCase& operator = (
        const ScenarioCase&) = delete;
 
    /* -- scenario */
    virtual ScenarioPtr filterScenario(
        TagsStack& tags_,
        ScenarioContainerPtr parent_,
        const RunnerFilter& filter_) const override;
    virtual std::pair<std::string, ObjectRepeaterPtr> createRepeater(
        const Context& context_) const override;
    virtual void enterObject(
        const Context& context_) const noexcept override;
    virtual void leaveObject(
        const Context& context_) const noexcept override;
    virtual ScenarioIterPtr getChildren() const override;
};
 
class ScenarioCaseBuilder {
  private:
    struct Impl;
    Impl* pimpl;
 
  public:
    /* -- avoid copying */
    ScenarioCaseBuilder(
        const ScenarioCaseBuilder&) = delete;
    ScenarioCaseBuilder& operator = (
        const ScenarioCaseBuilder&) = delete;
 
    explicit ScenarioCaseBuilder(
        const std::string& name_,
        const Tags& tags_,
        ObjectRepeaterFactoryPtr repeater_factory_);
 
    ScenarioCaseBuilder(
        ScenarioCaseBuilder&& other_);
 
    ~ScenarioCaseBuilder();
 
    ScenarioCaseBuilder& pushSection(
        const std::string& name_);
 
    ScenarioCaseBuilder& popSection();
 
    ScenarioPtr getScenario();
};
 
} /* -- namespace OTest2 */
 
#endif /* -- OTest2_INCLUDE_OTEST2_SCENARIOCASE_H_ */