[12177] | 1 | // Copyright 2007, 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 |
---|
| 11 | // copyright notice, this list of conditions and the following disclaimer |
---|
| 12 | // in the documentation and/or other materials provided with the |
---|
| 13 | // distribution. |
---|
| 14 | // * Neither the name of Google Inc. nor the names of its |
---|
| 15 | // contributors may be used to endorse or promote products derived from |
---|
| 16 | // this software without specific prior written permission. |
---|
| 17 | // |
---|
| 18 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
---|
| 19 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
---|
| 20 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
---|
| 21 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
---|
| 22 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
---|
| 23 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
---|
| 24 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
---|
| 25 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
---|
| 26 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
---|
| 27 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
---|
| 28 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
---|
| 29 | // |
---|
| 30 | // Author: wan@google.com (Zhanyong Wan) |
---|
| 31 | |
---|
| 32 | // Google Mock - a framework for writing C++ mock classes. |
---|
| 33 | // |
---|
| 34 | // This file implements cardinalities. |
---|
| 35 | |
---|
| 36 | #include "gmock/gmock-cardinalities.h" |
---|
| 37 | |
---|
| 38 | #include <limits.h> |
---|
| 39 | #include <ostream> // NOLINT |
---|
| 40 | #include <sstream> |
---|
| 41 | #include <string> |
---|
| 42 | #include "gmock/internal/gmock-internal-utils.h" |
---|
| 43 | #include "gtest/gtest.h" |
---|
| 44 | |
---|
| 45 | namespace testing { |
---|
| 46 | |
---|
| 47 | namespace { |
---|
| 48 | |
---|
| 49 | // Implements the Between(m, n) cardinality. |
---|
| 50 | class BetweenCardinalityImpl : public CardinalityInterface { |
---|
| 51 | public: |
---|
| 52 | BetweenCardinalityImpl(int min, int max) |
---|
| 53 | : min_(min >= 0 ? min : 0), |
---|
| 54 | max_(max >= min_ ? max : min_) { |
---|
| 55 | std::stringstream ss; |
---|
| 56 | if (min < 0) { |
---|
| 57 | ss << "The invocation lower bound must be >= 0, " |
---|
| 58 | << "but is actually " << min << "."; |
---|
| 59 | internal::Expect(false, __FILE__, __LINE__, ss.str()); |
---|
| 60 | } else if (max < 0) { |
---|
| 61 | ss << "The invocation upper bound must be >= 0, " |
---|
| 62 | << "but is actually " << max << "."; |
---|
| 63 | internal::Expect(false, __FILE__, __LINE__, ss.str()); |
---|
| 64 | } else if (min > max) { |
---|
| 65 | ss << "The invocation upper bound (" << max |
---|
| 66 | << ") must be >= the invocation lower bound (" << min |
---|
| 67 | << ")."; |
---|
| 68 | internal::Expect(false, __FILE__, __LINE__, ss.str()); |
---|
| 69 | } |
---|
| 70 | } |
---|
| 71 | |
---|
| 72 | // Conservative estimate on the lower/upper bound of the number of |
---|
| 73 | // calls allowed. |
---|
| 74 | virtual int ConservativeLowerBound() const { return min_; } |
---|
| 75 | virtual int ConservativeUpperBound() const { return max_; } |
---|
| 76 | |
---|
| 77 | virtual bool IsSatisfiedByCallCount(int call_count) const { |
---|
| 78 | return min_ <= call_count && call_count <= max_ ; |
---|
| 79 | } |
---|
| 80 | |
---|
| 81 | virtual bool IsSaturatedByCallCount(int call_count) const { |
---|
| 82 | return call_count >= max_; |
---|
| 83 | } |
---|
| 84 | |
---|
| 85 | virtual void DescribeTo(::std::ostream* os) const; |
---|
| 86 | private: |
---|
| 87 | const int min_; |
---|
| 88 | const int max_; |
---|
| 89 | |
---|
| 90 | GTEST_DISALLOW_COPY_AND_ASSIGN_(BetweenCardinalityImpl); |
---|
| 91 | }; |
---|
| 92 | |
---|
| 93 | // Formats "n times" in a human-friendly way. |
---|
| 94 | inline internal::string FormatTimes(int n) { |
---|
| 95 | if (n == 1) { |
---|
| 96 | return "once"; |
---|
| 97 | } else if (n == 2) { |
---|
| 98 | return "twice"; |
---|
| 99 | } else { |
---|
| 100 | std::stringstream ss; |
---|
| 101 | ss << n << " times"; |
---|
| 102 | return ss.str(); |
---|
| 103 | } |
---|
| 104 | } |
---|
| 105 | |
---|
| 106 | // Describes the Between(m, n) cardinality in human-friendly text. |
---|
| 107 | void BetweenCardinalityImpl::DescribeTo(::std::ostream* os) const { |
---|
| 108 | if (min_ == 0) { |
---|
| 109 | if (max_ == 0) { |
---|
| 110 | *os << "never called"; |
---|
| 111 | } else if (max_ == INT_MAX) { |
---|
| 112 | *os << "called any number of times"; |
---|
| 113 | } else { |
---|
| 114 | *os << "called at most " << FormatTimes(max_); |
---|
| 115 | } |
---|
| 116 | } else if (min_ == max_) { |
---|
| 117 | *os << "called " << FormatTimes(min_); |
---|
| 118 | } else if (max_ == INT_MAX) { |
---|
| 119 | *os << "called at least " << FormatTimes(min_); |
---|
| 120 | } else { |
---|
| 121 | // 0 < min_ < max_ < INT_MAX |
---|
| 122 | *os << "called between " << min_ << " and " << max_ << " times"; |
---|
| 123 | } |
---|
| 124 | } |
---|
| 125 | |
---|
| 126 | } // Unnamed namespace |
---|
| 127 | |
---|
| 128 | // Describes the given call count to an ostream. |
---|
| 129 | void Cardinality::DescribeActualCallCountTo(int actual_call_count, |
---|
| 130 | ::std::ostream* os) { |
---|
| 131 | if (actual_call_count > 0) { |
---|
| 132 | *os << "called " << FormatTimes(actual_call_count); |
---|
| 133 | } else { |
---|
| 134 | *os << "never called"; |
---|
| 135 | } |
---|
| 136 | } |
---|
| 137 | |
---|
| 138 | // Creates a cardinality that allows at least n calls. |
---|
| 139 | Cardinality AtLeast(int n) { return Between(n, INT_MAX); } |
---|
| 140 | |
---|
| 141 | // Creates a cardinality that allows at most n calls. |
---|
| 142 | Cardinality AtMost(int n) { return Between(0, n); } |
---|
| 143 | |
---|
| 144 | // Creates a cardinality that allows any number of calls. |
---|
| 145 | Cardinality AnyNumber() { return AtLeast(0); } |
---|
| 146 | |
---|
| 147 | // Creates a cardinality that allows between min and max calls. |
---|
| 148 | Cardinality Between(int min, int max) { |
---|
| 149 | return Cardinality(new BetweenCardinalityImpl(min, max)); |
---|
| 150 | } |
---|
| 151 | |
---|
| 152 | // Creates a cardinality that allows exactly n calls. |
---|
| 153 | Cardinality Exactly(int n) { return Between(n, n); } |
---|
| 154 | |
---|
| 155 | } // namespace testing |
---|