1// Copyright 2011 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/drivers/debug_test.hpp
30/// Driver to run a single test in a controlled manner.
31///
32/// This driver module implements the logic to execute a particular test
33/// with hooks into the runtime procedure.  This is to permit debugging the
34/// behavior of the test.
35
36#if !defined(ENGINE_DRIVERS_DEBUG_TEST_HPP)
37#define ENGINE_DRIVERS_DEBUG_TEST_HPP
38
39#include "engine/filters.hpp"
40#include "engine/test_case.hpp"
41#include "engine/test_result.hpp"
42#include "utils/config/tree.hpp"
43#include "utils/fs/path.hpp"
44#include "utils/optional.hpp"
45
46namespace engine {
47namespace drivers {
48namespace debug_test {
49
50
51/// Tuple containing the results of this driver.
52class result {
53public:
54    /// A filter matching the executed test case only.
55    test_filter test_case;
56
57    /// The result of the test case.
58    engine::test_result test_result;
59
60    /// Initializer for the tuple's fields.
61    ///
62    /// \param test_case_ The matched test case.
63    /// \param test_result_ The result of the test case.
64    result(const engine::test_filter& test_case_,
65           const engine::test_result& test_result_) :
66        test_case(test_case_),
67        test_result(test_result_)
68    {
69    }
70};
71
72
73result drive(const utils::fs::path&, const utils::optional< utils::fs::path >,
74             const test_filter&, const utils::config::tree&,
75             const utils::fs::path&, const utils::fs::path&);
76
77
78}  // namespace debug_test
79}  // namespace drivers
80}  // namespace engine
81
82#endif  // !defined(ENGINE_DRIVERS_DEBUG_TEST_HPP)
83