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