lumiera_documentation/src/test/testoption.cpp

/*
  TestOption  -  handle cmdline for invoking Testsuite

   Copyright (C)
     2008,            Hermann Vosseler <Ichthyostega@web.de>

  **Lumiera** 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 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.

* *****************************************************************/


/** @file testoption.cpp
 ** Implementation of commandline parsing for the unittest test-suite.
 */


#include "lib/error.hpp"
#include "test/testoption.hpp"
#include "test/suite.hpp"




typedef boost::program_options::options_description Syntax;
typedef boost::program_options::variables_map VarMap;

namespace op = boost::program_options;

using lib::VectS;
using std::optional;

namespace test {
  
  
  /** set up an options parser to use the current commandline.
   *  Recognises the following options
   *  \code
   *  --help
   *  --group <groupID>
   *  --describe
   *  \endcode
   */
  TestOption::TestOption (lib::Cmdline& cmdline)
    : syntax("Run a collection of test cases. Supported parameters"),
      parameters()
    {
      syntax.add_options()
        ("help,h",      "produce help message")
        ("group,g",     op::value<string>()->default_value(Suite::ALLGROUP),
                        "the group (selection) of testcases to execute")
        ("describe",    op::bool_switch(),
                        "enumerate all testcases in this Suite in a format usable with ./test.sh.")
        ("seed",        op::value<uint64_t>(),
                        "the group (selection) of testcases to execute")
        ("id",          op::value<VectS>(),
                        "an individual testcase to be called.\nIf not specified, run all.")
        ;
      
      // the testcase-ID is really an positional parameter
      op::positional_options_description posopt;
      posopt.add("id", -1);
      
      op::parsed_options parsed =
        op::command_line_parser (cmdline)
          .options (syntax)
          .positional(posopt)
          .allow_unregistered()
          .run();
      
      op::store (parsed, parameters);
      op::notify(parameters);
      
      // remove all recognised options from original cmdline vector
      cmdline = op::collect_unrecognized(parsed.options, op::include_positional);
    }
  
  
  
  
  /** @return the Tests-Group as given on cmdline, or Suite::ALLGROUP as default
   */
  const string
  TestOption::getTestgroup ()
  {
    ASSERT (parameters.count ("group"));
    return parameters["group"].as<string>();
  }
  
  /** @return ID of a single test to run, empty string if not specified
   */
  const string
  TestOption::getTestID ()
  {
    if (parameters.count ("id") &&
        parameters["id"].as<VectS>().size() > 0)
      return parameters["id"].as<VectS>()[0];
    else
      return string ();
  }
  
  optional<uint64_t>
  TestOption::optSeed()
  {
    if (parameters.count ("seed"))
      return parameters["seed"].as<uint64_t>();
    else
      return std::nullopt;
  }
  
  /** @return \c true if --describe switch was given */
  bool
  TestOption::shouldDescribe ()
  {
    return parameters["describe"].as<bool>();
  }
  
  /** handles the --help switch by printing a syntax description
   * @return \c false if there was no help request and the
   *         Suite should indeed be executed.
   */
  bool
  TestOption::handleHelpRequest()
  {
    if (parameters.count("help"))
      {
        std::cerr << *this;
        return true;
      }
    return false;
  }
  
  
  ostream& 
  operator<< (ostream& os, const TestOption& to)
  {
    return os << to.syntax;
  }

  
  
} // namespace test