1*b0d29bc4SBrooks Davis // Copyright 2010 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 engine/atf_result.hpp 30*b0d29bc4SBrooks Davis /// Functions and types to process the results of ATF-based test cases. 31*b0d29bc4SBrooks Davis 32*b0d29bc4SBrooks Davis #if !defined(ENGINE_ATF_RESULT_HPP) 33*b0d29bc4SBrooks Davis #define ENGINE_ATF_RESULT_HPP 34*b0d29bc4SBrooks Davis 35*b0d29bc4SBrooks Davis #include "engine/atf_result_fwd.hpp" 36*b0d29bc4SBrooks Davis 37*b0d29bc4SBrooks Davis #include <istream> 38*b0d29bc4SBrooks Davis #include <ostream> 39*b0d29bc4SBrooks Davis 40*b0d29bc4SBrooks Davis #include "model/test_result_fwd.hpp" 41*b0d29bc4SBrooks Davis #include "utils/optional.hpp" 42*b0d29bc4SBrooks Davis #include "utils/fs/path_fwd.hpp" 43*b0d29bc4SBrooks Davis #include "utils/process/status_fwd.hpp" 44*b0d29bc4SBrooks Davis 45*b0d29bc4SBrooks Davis namespace engine { 46*b0d29bc4SBrooks Davis 47*b0d29bc4SBrooks Davis 48*b0d29bc4SBrooks Davis /// Internal representation of the raw result files of ATF-based tests. 49*b0d29bc4SBrooks Davis /// 50*b0d29bc4SBrooks Davis /// This class is used exclusively to represent the transient result files read 51*b0d29bc4SBrooks Davis /// from test cases before generating the "public" version of the result. This 52*b0d29bc4SBrooks Davis /// class should actually not be exposed in the header files, but it is for 53*b0d29bc4SBrooks Davis /// testing purposes only. 54*b0d29bc4SBrooks Davis class atf_result { 55*b0d29bc4SBrooks Davis public: 56*b0d29bc4SBrooks Davis /// List of possible types for the test case result. 57*b0d29bc4SBrooks Davis enum types { 58*b0d29bc4SBrooks Davis broken, 59*b0d29bc4SBrooks Davis expected_death, 60*b0d29bc4SBrooks Davis expected_exit, 61*b0d29bc4SBrooks Davis expected_failure, 62*b0d29bc4SBrooks Davis expected_signal, 63*b0d29bc4SBrooks Davis expected_timeout, 64*b0d29bc4SBrooks Davis failed, 65*b0d29bc4SBrooks Davis passed, 66*b0d29bc4SBrooks Davis skipped, 67*b0d29bc4SBrooks Davis }; 68*b0d29bc4SBrooks Davis 69*b0d29bc4SBrooks Davis private: 70*b0d29bc4SBrooks Davis /// The test case result. 71*b0d29bc4SBrooks Davis types _type; 72*b0d29bc4SBrooks Davis 73*b0d29bc4SBrooks Davis /// The optional integral argument that may accompany the result. 74*b0d29bc4SBrooks Davis /// 75*b0d29bc4SBrooks Davis /// Should only be present if the type is expected_exit or expected_signal. 76*b0d29bc4SBrooks Davis utils::optional< int > _argument; 77*b0d29bc4SBrooks Davis 78*b0d29bc4SBrooks Davis /// A description of the test case result. 79*b0d29bc4SBrooks Davis /// 80*b0d29bc4SBrooks Davis /// Should always be present except for the passed type. 81*b0d29bc4SBrooks Davis utils::optional< std::string > _reason; 82*b0d29bc4SBrooks Davis 83*b0d29bc4SBrooks Davis public: 84*b0d29bc4SBrooks Davis atf_result(const types); 85*b0d29bc4SBrooks Davis atf_result(const types, const std::string&); 86*b0d29bc4SBrooks Davis atf_result(const types, const utils::optional< int >&, const std::string&); 87*b0d29bc4SBrooks Davis 88*b0d29bc4SBrooks Davis static atf_result parse(std::istream&); 89*b0d29bc4SBrooks Davis static atf_result load(const utils::fs::path&); 90*b0d29bc4SBrooks Davis 91*b0d29bc4SBrooks Davis types type(void) const; 92*b0d29bc4SBrooks Davis const utils::optional< int >& argument(void) const; 93*b0d29bc4SBrooks Davis const utils::optional< std::string >& reason(void) const; 94*b0d29bc4SBrooks Davis 95*b0d29bc4SBrooks Davis bool good(void) const; 96*b0d29bc4SBrooks Davis atf_result apply(const utils::optional< utils::process::status >&) const; 97*b0d29bc4SBrooks Davis model::test_result externalize(void) const; 98*b0d29bc4SBrooks Davis 99*b0d29bc4SBrooks Davis bool operator==(const atf_result&) const; 100*b0d29bc4SBrooks Davis bool operator!=(const atf_result&) const; 101*b0d29bc4SBrooks Davis }; 102*b0d29bc4SBrooks Davis 103*b0d29bc4SBrooks Davis 104*b0d29bc4SBrooks Davis std::ostream& operator<<(std::ostream&, const atf_result&); 105*b0d29bc4SBrooks Davis 106*b0d29bc4SBrooks Davis 107*b0d29bc4SBrooks Davis model::test_result calculate_atf_result( 108*b0d29bc4SBrooks Davis const utils::optional< utils::process::status >&, 109*b0d29bc4SBrooks Davis const utils::fs::path&); 110*b0d29bc4SBrooks Davis 111*b0d29bc4SBrooks Davis 112*b0d29bc4SBrooks Davis } // namespace engine 113*b0d29bc4SBrooks Davis 114*b0d29bc4SBrooks Davis #endif // !defined(ENGINE_ATF_IFACE_RESULTS_HPP) 115