1 // Copyright 2010 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/kyuafile.hpp 30 /// Test suite configuration parsing and representation. 31 32 #if !defined(ENGINE_KYUAFILE_HPP) 33 #define ENGINE_KYUAFILE_HPP 34 35 #include <string> 36 #include <vector> 37 38 #include <lutok/state.hpp> 39 40 #include "engine/test_program.hpp" 41 #include "utils/fs/path.hpp" 42 #include "utils/optional.hpp" 43 44 namespace engine { 45 46 47 /// Representation of the configuration of a test suite. 48 /// 49 /// Test suites are collections of related test programs. They are described by 50 /// a configuration file. 51 /// 52 /// Test suites have two path references: one to the "source root" and another 53 /// one to the "build root". The source root points to the directory from which 54 /// the Kyuafile is being read, and all recursive inclusions are resolved 55 /// relative to that directory. The build root points to the directory 56 /// containing the generated test programs and is prepended to the absolute path 57 /// of the test programs referenced by the Kyuafiles. In general, the build 58 /// root will be the same as the source root; however, when using a build system 59 /// that supports "build directories", providing this option comes in handy to 60 /// allow running the tests without much hassle. 61 /// 62 /// This class provides the parser for test suite configuration files and 63 /// methods to access the parsed data. 64 class kyuafile { 65 /// Path to the directory containing the top-level Kyuafile loaded. 66 utils::fs::path _source_root; 67 68 /// Path to the directory containing the test programs. 69 utils::fs::path _build_root; 70 71 /// Collection of the test programs defined in the Kyuafile. 72 test_programs_vector _test_programs; 73 74 public: 75 explicit kyuafile(const utils::fs::path&, const utils::fs::path&, 76 const test_programs_vector&); 77 ~kyuafile(void); 78 79 static kyuafile load(const utils::fs::path&, 80 const utils::optional< utils::fs::path >); 81 82 const utils::fs::path& source_root(void) const; 83 const utils::fs::path& build_root(void) const; 84 const test_programs_vector& test_programs(void) const; 85 }; 86 87 88 } // namespace engine 89 90 #endif // !defined(ENGINE_KYUAFILE_HPP) 91