external/bsd/kyua-cli/dist/engine/testers.hpp

   1 // Copyright 2012 Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 // * Redistributions of source code must retain the above copyright
   9 //   notice, this list of conditions and the following disclaimer.
  10 // * Redistributions in binary form must reproduce the above copyright
  11 //   notice, this list of conditions and the following disclaimer in the
  12 //   documentation and/or other materials provided with the distribution.
  13 // * Neither the name of Google Inc. nor the names of its contributors
  14 //   may be used to endorse or promote products derived from this software
  15 //   without specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 /// \file engine/testers.hpp
  30 /// Invocation of external tester binaries.
  31
  32 #if !defined(ENGINE_TESTERS_HPP)
  33 #define ENGINE_TESTERS_HPP
  34
  35 #include <map>
  36 #include <string>
  37 #include <vector>
  38
  39 #include "utils/datetime.hpp"
  40 #include "utils/optional.hpp"
  41 #include "utils/passwd.hpp"
  42
  43 namespace utils {
  44 namespace config {
  45 class tree;
  46 }  // namespace config
  47 namespace fs {
  48 class path;
  49 }  // namespace fs
  50 }  // namespace utils
  51
  52 namespace engine {
  53
  54
  55 /// Abstraction to invoke an external tester.
  56 ///
  57 /// This class provides the primitives to construct an invocation of an external
  58 /// tester.  In other words: this is the place where the knowledge of what
  59 /// arguments a tester receives and the output it returns.
  60 class tester {
  61     /// Name of the tester interface to use.
  62     std::string _interface;
  63
  64     /// Common arguments to the tester, to be passed before the subcommand.
  65     std::vector< std::string > _common_args;
  66
  67 public:
  68     tester(const std::string&, const utils::optional< utils::passwd::user >&,
  69            const utils::optional< utils::datetime::delta >&);
  70     ~tester(void);
  71
  72     std::string list(const utils::fs::path&) const;
  73     void test(const utils::fs::path&, const std::string&,
  74               const utils::fs::path&, const utils::fs::path&,
  75               const utils::fs::path&,
  76               const std::map< std::string, std::string >&) const;
  77 };
  78
  79
  80 utils::fs::path tester_path(const std::string&);
  81
  82
  83 }  // namespace engine
  84
  85 #endif  // !defined(ENGINE_TESTERS_HPP)