xref: /freebsd/contrib/kyua/engine/atf.hpp (revision e17f5b1d307b7b8910d67883e57a9604305906d5)
1 // Copyright 2014 The Kyua Authors.
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/atf.hpp
30 /// Execution engine for test programs that implement the atf interface.
31 
32 #if !defined(ENGINE_ATF_HPP)
33 #define ENGINE_ATF_HPP
34 
35 #include "engine/scheduler.hpp"
36 
37 namespace engine {
38 
39 
40 /// Implementation of the scheduler interface for atf test programs.
41 class atf_interface : public engine::scheduler::interface {
42 public:
43     void exec_list(const model::test_program&,
44                    const utils::config::properties_map&) const UTILS_NORETURN;
45 
46     model::test_cases_map parse_list(
47         const utils::optional< utils::process::status >&,
48         const utils::fs::path&,
49         const utils::fs::path&) const;
50 
51     void exec_test(const model::test_program&, const std::string&,
52                    const utils::config::properties_map&,
53                    const utils::fs::path&) const
54         UTILS_NORETURN;
55 
56     void exec_cleanup(const model::test_program&, const std::string&,
57                       const utils::config::properties_map&,
58                       const utils::fs::path&) const
59         UTILS_NORETURN;
60 
61     model::test_result compute_result(
62         const utils::optional< utils::process::status >&,
63         const utils::fs::path&,
64         const utils::fs::path&,
65         const utils::fs::path&) const;
66 };
67 
68 
69 }  // namespace engine
70 
71 
72 #endif  // !defined(ENGINE_ATF_HPP)
73