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 <ostream> 38#include <string> 39 40namespace model { 41 42 43/// Representation of a single test result. 44/// 45/// A test result is a simple pair of (type, reason). The type indicates the 46/// semantics of the results, and the optional reason provides an extra 47/// description of the result type. 48/// 49/// In general, a 'passed' result will not have a reason attached, because a 50/// successful test case does not deserve any kind of explanation. We used to 51/// special-case this with a very complex class hierarchy, but it proved to 52/// result in an extremely-complex to maintain code base that provided no 53/// benefits. As a result, we allow any test type to carry a reason. 54class test_result { 55 /// The type of the result. 56 test_result_type _type; 57 58 /// A description of the result; may be empty. 59 std::string _reason; 60 61public: 62 test_result(const test_result_type, const std::string& = ""); 63 64 test_result_type type(void) const; 65 const std::string& reason(void) const; 66 67 bool good(void) const; 68 69 bool operator==(const test_result&) const; 70 bool operator!=(const test_result&) const; 71}; 72 73 74std::ostream& operator<<(std::ostream&, const test_result&); 75 76 77} // namespace model 78 79#endif // !defined(MODEL_TEST_RESULT_HPP) 80