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 model/test_result.hpp 30 /// Definition of the "test result" concept. 31 32 #if !defined(MODEL_TEST_RESULT_HPP) 33 #define MODEL_TEST_RESULT_HPP 34 35 #include "model/test_result_fwd.hpp" 36 37 #include <map> 38 #include <ostream> 39 #include <string> 40 41 namespace model { 42 43 44 /// Test result type metadata. 45 struct test_result_type_desc { 46 enum test_result_type id; 47 std::string name; 48 bool is_run; 49 bool is_good; 50 }; 51 52 53 /// Description of each test result type. 54 extern const std::map<enum test_result_type, 55 const struct test_result_type_desc> test_result_types; 56 57 58 /// Representation of a single test result. 59 /// 60 /// A test result is a simple pair of (type, reason). The type indicates the 61 /// semantics of the results, and the optional reason provides an extra 62 /// description of the result type. 63 /// 64 /// In general, a 'passed' result will not have a reason attached, because a 65 /// successful test case does not deserve any kind of explanation. We used to 66 /// special-case this with a very complex class hierarchy, but it proved to 67 /// result in an extremely-complex to maintain code base that provided no 68 /// benefits. As a result, we allow any test type to carry a reason. 69 class test_result { 70 /// The type of the result. 71 test_result_type _type; 72 73 /// A description of the result; may be empty. 74 std::string _reason; 75 76 public: 77 test_result(const test_result_type, const std::string& = ""); 78 79 test_result_type type(void) const; 80 const std::string& reason(void) const; 81 82 bool good(void) const; 83 84 bool operator==(const test_result&) const; 85 bool operator!=(const test_result&) const; 86 }; 87 88 89 std::ostream& operator<<(std::ostream&, const test_result&); 90 91 92 } // namespace model 93 94 #endif // !defined(MODEL_TEST_RESULT_HPP) 95