1 // Copyright 2010 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_case.hpp 30 /// Definition of the "test case" concept. 31 32 #if !defined(MODEL_TEST_CASE_HPP) 33 #define MODEL_TEST_CASE_HPP 34 35 #include "model/test_case_fwd.hpp" 36 37 #include <memory> 38 #include <ostream> 39 #include <string> 40 41 #include "engine/debugger.hpp" 42 #include "model/metadata_fwd.hpp" 43 #include "model/test_result_fwd.hpp" 44 #include "utils/noncopyable.hpp" 45 #include "utils/optional_fwd.hpp" 46 47 48 namespace model { 49 50 51 /// Representation of a test case. 52 /// 53 /// Test cases, on their own, are useless. They only make sense in the context 54 /// of the container test program and as such this class should not be used 55 /// directly. 56 class test_case { 57 struct impl; 58 59 /// Pointer to the shared internal implementation. 60 std::shared_ptr< impl > _pimpl; 61 62 test_case(std::shared_ptr< impl >); 63 64 public: 65 test_case(const std::string&, const metadata&); 66 test_case(const std::string&, const std::string&, const test_result&); 67 ~test_case(void); 68 69 test_case apply_metadata_defaults(const metadata*) const; 70 71 const std::string& name(void) const; 72 metadata get_metadata(void) const; 73 const metadata& get_raw_metadata(void) const; 74 utils::optional< test_result > fake_result(void) const; 75 76 void attach_debugger(engine::debugger_ptr) const; 77 engine::debugger_ptr get_debugger() const; 78 79 bool operator==(const test_case&) const; 80 bool operator!=(const test_case&) const; 81 }; 82 83 84 /// Builder for a test_cases_map object. 85 class test_cases_map_builder : utils::noncopyable { 86 /// Accumulator for the map being built. 87 test_cases_map _test_cases; 88 89 public: 90 test_cases_map_builder& add(const test_case&); 91 test_cases_map_builder& add(const std::string&); 92 test_cases_map_builder& add(const std::string&, const metadata&); 93 94 test_cases_map build(void) const; 95 }; 96 97 98 std::ostream& operator<<(std::ostream&, const test_case&); 99 100 101 } // namespace model 102 103 #endif // !defined(MODEL_TEST_CASE_HPP) 104