1*b0d29bc4SBrooks Davis // Copyright 2011 The Kyua Authors. 2*b0d29bc4SBrooks Davis // All rights reserved. 3*b0d29bc4SBrooks Davis // 4*b0d29bc4SBrooks Davis // Redistribution and use in source and binary forms, with or without 5*b0d29bc4SBrooks Davis // modification, are permitted provided that the following conditions are 6*b0d29bc4SBrooks Davis // met: 7*b0d29bc4SBrooks Davis // 8*b0d29bc4SBrooks Davis // * Redistributions of source code must retain the above copyright 9*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer. 10*b0d29bc4SBrooks Davis // * Redistributions in binary form must reproduce the above copyright 11*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer in the 12*b0d29bc4SBrooks Davis // documentation and/or other materials provided with the distribution. 13*b0d29bc4SBrooks Davis // * Neither the name of Google Inc. nor the names of its contributors 14*b0d29bc4SBrooks Davis // may be used to endorse or promote products derived from this software 15*b0d29bc4SBrooks Davis // without specific prior written permission. 16*b0d29bc4SBrooks Davis // 17*b0d29bc4SBrooks Davis // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18*b0d29bc4SBrooks Davis // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19*b0d29bc4SBrooks Davis // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20*b0d29bc4SBrooks Davis // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21*b0d29bc4SBrooks Davis // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22*b0d29bc4SBrooks Davis // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23*b0d29bc4SBrooks Davis // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24*b0d29bc4SBrooks Davis // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25*b0d29bc4SBrooks Davis // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26*b0d29bc4SBrooks Davis // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27*b0d29bc4SBrooks Davis // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28*b0d29bc4SBrooks Davis 29*b0d29bc4SBrooks Davis /// \file drivers/scan_results.hpp 30*b0d29bc4SBrooks Davis /// Driver to scan the contents of a results file. 31*b0d29bc4SBrooks Davis /// 32*b0d29bc4SBrooks Davis /// This driver module implements the logic to scan the contents of a results 33*b0d29bc4SBrooks Davis /// file and to notify the presentation layer as soon as data becomes 34*b0d29bc4SBrooks Davis /// available. This is to prevent reading all the data from the file at once, 35*b0d29bc4SBrooks Davis /// which could take too much memory. 36*b0d29bc4SBrooks Davis 37*b0d29bc4SBrooks Davis #if !defined(DRIVERS_SCAN_RESULTS_HPP) 38*b0d29bc4SBrooks Davis #define DRIVERS_SCAN_RESULTS_HPP 39*b0d29bc4SBrooks Davis 40*b0d29bc4SBrooks Davis extern "C" { 41*b0d29bc4SBrooks Davis #include <stdint.h> 42*b0d29bc4SBrooks Davis } 43*b0d29bc4SBrooks Davis 44*b0d29bc4SBrooks Davis #include <set> 45*b0d29bc4SBrooks Davis 46*b0d29bc4SBrooks Davis #include "engine/filters.hpp" 47*b0d29bc4SBrooks Davis #include "model/context_fwd.hpp" 48*b0d29bc4SBrooks Davis #include "store/read_transaction_fwd.hpp" 49*b0d29bc4SBrooks Davis #include "utils/datetime_fwd.hpp" 50*b0d29bc4SBrooks Davis #include "utils/fs/path_fwd.hpp" 51*b0d29bc4SBrooks Davis 52*b0d29bc4SBrooks Davis namespace drivers { 53*b0d29bc4SBrooks Davis namespace scan_results { 54*b0d29bc4SBrooks Davis 55*b0d29bc4SBrooks Davis 56*b0d29bc4SBrooks Davis /// Tuple containing the results of this driver. 57*b0d29bc4SBrooks Davis class result { 58*b0d29bc4SBrooks Davis public: 59*b0d29bc4SBrooks Davis /// Filters that did not match any available test case. 60*b0d29bc4SBrooks Davis /// 61*b0d29bc4SBrooks Davis /// The presence of any filters here probably indicates a usage error. If a 62*b0d29bc4SBrooks Davis /// test filter does not match any test case, it is probably a typo. 63*b0d29bc4SBrooks Davis std::set< engine::test_filter > unused_filters; 64*b0d29bc4SBrooks Davis 65*b0d29bc4SBrooks Davis /// Initializer for the tuple's fields. 66*b0d29bc4SBrooks Davis /// 67*b0d29bc4SBrooks Davis /// \param unused_filters_ The filters that did not match any test case. result(const std::set<engine::test_filter> & unused_filters_)68*b0d29bc4SBrooks Davis result(const std::set< engine::test_filter >& unused_filters_) : 69*b0d29bc4SBrooks Davis unused_filters(unused_filters_) 70*b0d29bc4SBrooks Davis { 71*b0d29bc4SBrooks Davis } 72*b0d29bc4SBrooks Davis }; 73*b0d29bc4SBrooks Davis 74*b0d29bc4SBrooks Davis 75*b0d29bc4SBrooks Davis /// Abstract definition of the hooks for this driver. 76*b0d29bc4SBrooks Davis class base_hooks { 77*b0d29bc4SBrooks Davis public: 78*b0d29bc4SBrooks Davis virtual ~base_hooks(void) = 0; 79*b0d29bc4SBrooks Davis 80*b0d29bc4SBrooks Davis virtual void begin(void); 81*b0d29bc4SBrooks Davis 82*b0d29bc4SBrooks Davis /// Callback executed when the context is loaded. 83*b0d29bc4SBrooks Davis /// 84*b0d29bc4SBrooks Davis /// \param context The context loaded from the database. 85*b0d29bc4SBrooks Davis virtual void got_context(const model::context& context) = 0; 86*b0d29bc4SBrooks Davis 87*b0d29bc4SBrooks Davis /// Callback executed when a test results is found. 88*b0d29bc4SBrooks Davis /// 89*b0d29bc4SBrooks Davis /// \param iter Container for the test result's data. Some of the data are 90*b0d29bc4SBrooks Davis /// lazily fetched, hence why we receive the object instead of the 91*b0d29bc4SBrooks Davis /// individual elements. 92*b0d29bc4SBrooks Davis virtual void got_result(store::results_iterator& iter) = 0; 93*b0d29bc4SBrooks Davis 94*b0d29bc4SBrooks Davis virtual void end(const result& r); 95*b0d29bc4SBrooks Davis }; 96*b0d29bc4SBrooks Davis 97*b0d29bc4SBrooks Davis 98*b0d29bc4SBrooks Davis result drive(const utils::fs::path&, const std::set< engine::test_filter >&, 99*b0d29bc4SBrooks Davis base_hooks&); 100*b0d29bc4SBrooks Davis 101*b0d29bc4SBrooks Davis 102*b0d29bc4SBrooks Davis } // namespace scan_results 103*b0d29bc4SBrooks Davis } // namespace drivers 104*b0d29bc4SBrooks Davis 105*b0d29bc4SBrooks Davis #endif // !defined(DRIVERS_SCAN_RESULTS_HPP) 106