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/scanner.hpp 30 /// Utilities to scan through list of tests in a test suite. 31 32 #if !defined(ENGINE_SCANNER_HPP) 33 #define ENGINE_SCANNER_HPP 34 35 #include "engine/scanner_fwd.hpp" 36 37 #include <memory> 38 #include <set> 39 40 #include "engine/filters_fwd.hpp" 41 #include "model/test_program_fwd.hpp" 42 #include "utils/optional_fwd.hpp" 43 44 namespace engine { 45 46 47 /// Scans a list of test programs, yielding one test case at a time. 48 /// 49 /// This class contains the state necessary to process a collection of test 50 /// programs (possibly as provided by the Kyuafile) and to extract an arbitrary 51 /// (test program, test_case) pair out of them one at a time. 52 /// 53 /// The scanning algorithm guarantees that test programs are initialized 54 /// dynamically, should they need to load their list of test cases from disk. 55 /// 56 /// The order of the extraction is not guaranteed. 57 class scanner { 58 struct impl; 59 /// Pointer to the internal implementation data. 60 std::shared_ptr< impl > _pimpl; 61 62 public: 63 scanner(const model::test_programs_vector&, const std::set< test_filter >&); 64 ~scanner(void); 65 66 bool done(void); 67 utils::optional< scan_result > yield(void); 68 69 std::set< test_filter > unused_filters(void) const; 70 }; 71 72 73 } // namespace engine 74 75 76 #endif // !defined(ENGINE_SCANNER_HPP) 77