xref: /freebsd/contrib/kyua/drivers/list_tests.cpp (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1 // Copyright 2011 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 #include "drivers/list_tests.hpp"
30 
31 #include "engine/exceptions.hpp"
32 #include "engine/filters.hpp"
33 #include "engine/kyuafile.hpp"
34 #include "engine/scanner.hpp"
35 #include "engine/scheduler.hpp"
36 #include "model/test_program.hpp"
37 #include "utils/optional.ipp"
38 
39 namespace config = utils::config;
40 namespace fs = utils::fs;
41 namespace scheduler = engine::scheduler;
42 
43 using utils::optional;
44 
45 
46 /// Pure abstract destructor.
47 drivers::list_tests::base_hooks::~base_hooks(void)
48 {
49 }
50 
51 
52 /// Executes the operation.
53 ///
54 /// \param kyuafile_path The path to the Kyuafile to be loaded.
55 /// \param build_root If not none, path to the built test programs.
56 /// \param filters The test case filters as provided by the user.
57 /// \param user_config The end-user configuration properties.
58 /// \param hooks The hooks for this execution.
59 ///
60 /// \returns A structure with all results computed by this driver.
61 drivers::list_tests::result
62 drivers::list_tests::drive(const fs::path& kyuafile_path,
63                            const optional< fs::path > build_root,
64                            const std::set< engine::test_filter >& filters,
65                            const config::tree& user_config,
66                            base_hooks& hooks)
67 {
68     scheduler::scheduler_handle handle = scheduler::setup();
69 
70     const engine::kyuafile kyuafile = engine::kyuafile::load(
71         kyuafile_path, build_root, user_config, handle);
72 
73     engine::scanner scanner(kyuafile.test_programs(), filters);
74 
75     while (!scanner.done()) {
76         const optional< engine::scan_result > result = scanner.yield();
77         INV(result);
78         hooks.got_test_case(*result.get().first, result.get().second);
79     }
80 
81     handle.cleanup();
82 
83     return result(scanner.unused_filters());
84 }
85