1 // Copyright 2010 The Kyua Authors.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
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.
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.
29 /// \file engine/kyuafile.hpp
30 /// Test suite configuration parsing and representation.
32 #if !defined(ENGINE_KYUAFILE_HPP)
33 #define ENGINE_KYUAFILE_HPP
35 #include "engine/kyuafile_fwd.hpp"
40 #include <lutok/state.hpp>
42 #include "engine/scheduler_fwd.hpp"
43 #include "model/test_program_fwd.hpp"
44 #include "utils/config/tree_fwd.hpp"
45 #include "utils/fs/path.hpp"
46 #include "utils/optional_fwd.hpp"
51 /// Representation of the configuration of a test suite.
53 /// Test suites are collections of related test programs. They are described by
54 /// a configuration file.
56 /// Test suites have two path references: one to the "source root" and another
57 /// one to the "build root". The source root points to the directory from which
58 /// the Kyuafile is being read, and all recursive inclusions are resolved
59 /// relative to that directory. The build root points to the directory
60 /// containing the generated test programs and is prepended to the absolute path
61 /// of the test programs referenced by the Kyuafiles. In general, the build
62 /// root will be the same as the source root; however, when using a build system
63 /// that supports "build directories", providing this option comes in handy to
64 /// allow running the tests without much hassle.
66 /// This class provides the parser for test suite configuration files and
67 /// methods to access the parsed data.
69 /// Path to the directory containing the top-level Kyuafile loaded.
70 utils::fs::path _source_root;
72 /// Path to the directory containing the test programs.
73 utils::fs::path _build_root;
75 /// Collection of the test programs defined in the Kyuafile.
76 model::test_programs_vector _test_programs;
79 explicit kyuafile(const utils::fs::path&, const utils::fs::path&,
80 const model::test_programs_vector&);
83 static kyuafile load(const utils::fs::path&,
84 const utils::optional< utils::fs::path >,
85 const utils::config::tree&,
86 scheduler::scheduler_handle&);
88 const utils::fs::path& source_root(void) const;
89 const utils::fs::path& build_root(void) const;
90 const model::test_programs_vector& test_programs(void) const;
96 #endif // !defined(ENGINE_KYUAFILE_HPP)