/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 **/

#ifndef QUICKSTEP_UTILITY_TEXTBASED_TEST_TEXTBASED_TEST_RUNNER_HPP_
#define QUICKSTEP_UTILITY_TEXTBASED_TEST_TEXTBASED_TEST_RUNNER_HPP_

#include <set>
#include <string>

#include "utility/Macros.hpp"

namespace quickstep {

/** \addtogroup Utility
 *  @{
 */

/**
 * @brief Interface for a test runner in text-based tests.
 */
class TextBasedTestRunner {
 public:
  virtual ~TextBasedTestRunner() {
  }

  /**
   * @brief Generate an \p output from \p input given \p options.
   *
   * @param input The input text.
   * @param options Options provided in the text test file for the input.
   * @param output The output text.
   */
  virtual void runTestCase(const std::string &input, const std::set<std::string> &options,
                           std::string *output) = 0;
 protected:
  TextBasedTestRunner() {
  }

 private:
  DISALLOW_COPY_AND_ASSIGN(TextBasedTestRunner);
};

/** @} */

}  // namespace quickstep

#endif /* QUICKSTEP_UTILITY_TEXTBASED_TEST_TEXTBASED_TEST_RUNNER_HPP_ */