Skip to content

Commit 37f3227

Browse files
Abseil Teamgennadiycivil
Abseil Team
authored and
gennadiycivil
committed
Googletest export
Add a matcher `testing::ReturnRoundRobin` which, on each call, returns the next element in the sequence, restarting at the beginning once it has reached the end. PiperOrigin-RevId: 276312136
1 parent 1110c47 commit 37f3227

19 files changed

+485
-1115
lines changed

‎googlemock/docs/cheat_sheet.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -503,16 +503,17 @@ which must be a permanent callback.
503503
#### Returning a Value
504504
505505
<!-- mdformat off(no multiline tables) -->
506-
| | |
507-
| :-------------------------- | :-------------------------------------------- |
508-
| `Return()` | Return from a `void` mock function. |
509-
| `Return(value)` | Return `value`. If the type of `value` is different to the mock function's return type, `value` is converted to the latter type <i>at the time the expectation is set</i>, not when the action is executed. |
510-
| `ReturnArg<N>()` | Return the `N`-th (0-based) argument. |
511-
| `ReturnNew<T>(a1, ..., ak)` | Return `new T(a1, ..., ak)`; a different object is created each time. |
512-
| `ReturnNull()` | Return a null pointer. |
513-
| `ReturnPointee(ptr)` | Return the value pointed to by `ptr`. |
514-
| `ReturnRef(variable)` | Return a reference to `variable`. |
515-
| `ReturnRefOfCopy(value)` | Return a reference to a copy of `value`; the copy lives as long as the action. |
506+
| | |
507+
| :-------------------------------- | :-------------------------------------------- |
508+
| `Return()` | Return from a `void` mock function. |
509+
| `Return(value)` | Return `value`. If the type of `value` is different to the mock function's return type, `value` is converted to the latter type <i>at the time the expectation is set</i>, not when the action is executed. |
510+
| `ReturnArg<N>()` | Return the `N`-th (0-based) argument. |
511+
| `ReturnNew<T>(a1, ..., ak)` | Return `new T(a1, ..., ak)`; a different object is created each time. |
512+
| `ReturnNull()` | Return a null pointer. |
513+
| `ReturnPointee(ptr)` | Return the value pointed to by `ptr`. |
514+
| `ReturnRef(variable)` | Return a reference to `variable`. |
515+
| `ReturnRefOfCopy(value)` | Return a reference to a copy of `value`; the copy lives as long as the action. |
516+
| `ReturnRoundRobin({a1, ..., ak})` | Each call will return the next `ai` in the list, starting at the beginning when the end of the list is reached. |
516517
<!-- mdformat on -->
517518
518519
#### Side Effects

‎googlemock/include/gmock/gmock-actions.h

+47
Original file line numberDiff line numberDiff line change
@@ -716,6 +716,36 @@ class ReturnRefOfCopyAction {
716716
GTEST_DISALLOW_ASSIGN_(ReturnRefOfCopyAction);
717717
};
718718

719+
// Implements the polymorphic ReturnRoundRobin(v) action, which can be
720+
// used in any function that returns the element_type of v.
721+
template <typename T>
722+
class ReturnRoundRobinAction {
723+
public:
724+
explicit ReturnRoundRobinAction(std::vector<T> values) {
725+
GTEST_CHECK_(!values.empty())
726+
<< "ReturnRoundRobin requires at least one element.";
727+
state_->values = std::move(values);
728+
}
729+
730+
template <typename... Args>
731+
T operator()(Args&&...) const {
732+
return state_->Next();
733+
}
734+
735+
private:
736+
struct State {
737+
T Next() {
738+
T ret_val = values[i++];
739+
if (i == values.size()) i = 0;
740+
return ret_val;
741+
}
742+
743+
std::vector<T> values;
744+
size_t i = 0;
745+
};
746+
std::shared_ptr<State> state_ = std::make_shared<State>();
747+
};
748+
719749
// Implements the polymorphic DoDefault() action.
720750
class DoDefaultAction {
721751
public:
@@ -1039,6 +1069,23 @@ internal::ByMoveWrapper<R> ByMove(R x) {
10391069
return internal::ByMoveWrapper<R>(std::move(x));
10401070
}
10411071

1072+
// Creates an action that returns an element of `vals`. Calling this action will
1073+
// repeatedly return the next value from `vals` until it reaches the end and
1074+
// will restart from the beginning.
1075+
template <typename T>
1076+
internal::ReturnRoundRobinAction<T> ReturnRoundRobin(std::vector<T> vals) {
1077+
return internal::ReturnRoundRobinAction<T>(std::move(vals));
1078+
}
1079+
1080+
// Creates an action that returns an element of `vals`. Calling this action will
1081+
// repeatedly return the next value from `vals` until it reaches the end and
1082+
// will restart from the beginning.
1083+
template <typename T>
1084+
internal::ReturnRoundRobinAction<T> ReturnRoundRobin(
1085+
std::initializer_list<T> vals) {
1086+
return internal::ReturnRoundRobinAction<T>(std::vector<T>(vals));
1087+
}
1088+
10421089
// Creates an action that does the default action for the give mock function.
10431090
inline internal::DoDefaultAction DoDefault() {
10441091
return internal::DoDefaultAction();

‎googlemock/scripts/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Please Note:
2+
3+
Files in this directory are no longer supported by the maintainers. They
4+
represent mosty historical artifacts and supported by the community only. There
5+
is no guarantee whatsoever that these scripts still work.

‎googlemock/scripts/generator/cpp/ast.py

+34-12
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,7 @@
1717

1818
"""Generate an Abstract Syntax Tree (AST) for C++."""
1919

20-
__author__ = '[email protected] (Neal Norwitz)'
21-
22-
23-
# TODO:
20+
# FIXME:
2421
# * Tokens should never be exported, need to convert to Nodes
2522
# (return types, parameters, etc.)
2623
# * Handle static class data for templatized classes
@@ -338,7 +335,7 @@ def Requires(self, node):
338335
# TODO(nnorwitz): handle namespaces, etc.
339336
if self.bases:
340337
for token_list in self.bases:
341-
# TODO(nnorwitz): bases are tokens, do name comparison.
338+
# TODO(nnorwitz): bases are tokens, do name comparision.
342339
for token in token_list:
343340
if token.name == node.name:
344341
return True
@@ -381,7 +378,7 @@ def IsExportable(self):
381378

382379
def Requires(self, node):
383380
if self.parameters:
384-
# TODO(nnorwitz): parameters are tokens, do name comparison.
381+
# TODO(nnorwitz): parameters are tokens, do name comparision.
385382
for p in self.parameters:
386383
if p.name == node.name:
387384
return True
@@ -739,6 +736,14 @@ def _GenerateOne(self, token):
739736
if token.token_type == tokenize.NAME:
740737
if (keywords.IsKeyword(token.name) and
741738
not keywords.IsBuiltinType(token.name)):
739+
if token.name == 'enum':
740+
# Pop the next token and only put it back if it's not
741+
# 'class'. This allows us to support the two-token
742+
# 'enum class' keyword as if it were simply 'enum'.
743+
next = self._GetNextToken()
744+
if next.name != 'class':
745+
self._AddBackToken(next)
746+
742747
method = getattr(self, 'handle_' + token.name)
743748
return method()
744749
elif token.name == self.in_class_name_only:
@@ -754,7 +759,8 @@ def _GenerateOne(self, token):
754759
# Handle data or function declaration/definition.
755760
syntax = tokenize.SYNTAX
756761
temp_tokens, last_token = \
757-
self._GetVarTokensUpTo(syntax, '(', ';', '{', '[')
762+
self._GetVarTokensUpToIgnoringTemplates(syntax,
763+
'(', ';', '{', '[')
758764
temp_tokens.insert(0, token)
759765
if last_token.name == '(':
760766
# If there is an assignment before the paren,
@@ -858,7 +864,25 @@ def _GetVarTokensUpTo(self, expected_token_type, *expected_tokens):
858864
last_token = self._GetNextToken()
859865
return tokens, last_token
860866

861-
# TODO(nnorwitz): remove _IgnoreUpTo() it shouldn't be necessary.
867+
# Same as _GetVarTokensUpTo, but skips over '<...>' which could contain an
868+
# expected token.
869+
def _GetVarTokensUpToIgnoringTemplates(self, expected_token_type,
870+
*expected_tokens):
871+
last_token = self._GetNextToken()
872+
tokens = []
873+
nesting = 0
874+
while (nesting > 0 or
875+
last_token.token_type != expected_token_type or
876+
last_token.name not in expected_tokens):
877+
tokens.append(last_token)
878+
last_token = self._GetNextToken()
879+
if last_token.name == '<':
880+
nesting += 1
881+
elif last_token.name == '>':
882+
nesting -= 1
883+
return tokens, last_token
884+
885+
# TODO(nnorwitz): remove _IgnoreUpTo() it shouldn't be necesary.
862886
def _IgnoreUpTo(self, token_type, token):
863887
unused_tokens = self._GetTokensUpTo(token_type, token)
864888

@@ -1264,9 +1288,6 @@ def handle_union(self):
12641288
return self._GetNestedType(Union)
12651289

12661290
def handle_enum(self):
1267-
token = self._GetNextToken()
1268-
if not (token.token_type == tokenize.NAME and token.name == 'class'):
1269-
self._AddBackToken(token)
12701291
return self._GetNestedType(Enum)
12711292

12721293
def handle_auto(self):
@@ -1298,7 +1319,8 @@ def handle_virtual(self):
12981319
if token2.token_type == tokenize.SYNTAX and token2.name == '~':
12991320
return self.GetMethod(FUNCTION_VIRTUAL + FUNCTION_DTOR, None)
13001321
assert token.token_type == tokenize.NAME or token.name == '::', token
1301-
return_type_and_name = self._GetTokensUpTo(tokenize.SYNTAX, '(') # )
1322+
return_type_and_name, _ = self._GetVarTokensUpToIgnoringTemplates(
1323+
tokenize.SYNTAX, '(') # )
13021324
return_type_and_name.insert(0, token)
13031325
if token2 is not token:
13041326
return_type_and_name.insert(1, token2)

‎googlemock/scripts/generator/cpp/gmock_class.py

+77-37
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
11
#!/usr/bin/env python
22
#
3-
# Copyright 2008 Google Inc. All Rights Reserved.
3+
# Copyright 2008, Google Inc.
4+
# All rights reserved.
45
#
5-
# Licensed under the Apache License, Version 2.0 (the "License");
6-
# you may not use this file except in compliance with the License.
7-
# You may obtain a copy of the License at
6+
# Redistribution and use in source and binary forms, with or without
7+
# modification, are permitted provided that the following conditions are
8+
# met:
89
#
9-
# http://www.apache.org/licenses/LICENSE-2.0
10+
# * Redistributions of source code must retain the above copyright
11+
# notice, this list of conditions and the following disclaimer.
12+
# * Redistributions in binary form must reproduce the above
13+
# copyright notice, this list of conditions and the following disclaimer
14+
# in the documentation and/or other materials provided with the
15+
# distribution.
16+
# * Neither the name of Google Inc. nor the names of its
17+
# contributors may be used to endorse or promote products derived from
18+
# this software without specific prior written permission.
1019
#
11-
# Unless required by applicable law or agreed to in writing, software
12-
# distributed under the License is distributed on an "AS IS" BASIS,
13-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14-
# See the License for the specific language governing permissions and
15-
# limitations under the License.
20+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21+
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22+
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23+
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26+
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28+
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1631

1732
"""Generate Google Mock classes from base classes.
1833
@@ -26,9 +41,6 @@
2641
Output is sent to stdout.
2742
"""
2843

29-
__author__ = '[email protected] (Neal Norwitz)'
30-
31-
3244
import os
3345
import re
3446
import sys
@@ -48,6 +60,50 @@
4860
_INDENT = 2
4961

5062

63+
def _RenderType(ast_type):
64+
"""Renders the potentially recursively templated type into a string.
65+
66+
Args:
67+
ast_type: The AST of the type.
68+
69+
Returns:
70+
Rendered string and a boolean to indicate whether we have multiple args
71+
(which is not handled correctly).
72+
"""
73+
has_multiarg_error = False
74+
# Add modifiers like 'const'.
75+
modifiers = ''
76+
if ast_type.modifiers:
77+
modifiers = ' '.join(ast_type.modifiers) + ' '
78+
return_type = modifiers + ast_type.name
79+
if ast_type.templated_types:
80+
# Collect template args.
81+
template_args = []
82+
for arg in ast_type.templated_types:
83+
rendered_arg, e = _RenderType(arg)
84+
if e: has_multiarg_error = True
85+
template_args.append(rendered_arg)
86+
return_type += '<' + ', '.join(template_args) + '>'
87+
# We are actually not handling multi-template-args correctly. So mark it.
88+
if len(template_args) > 1:
89+
has_multiarg_error = True
90+
if ast_type.pointer:
91+
return_type += '*'
92+
if ast_type.reference:
93+
return_type += '&'
94+
return return_type, has_multiarg_error
95+
96+
97+
def _GetNumParameters(parameters, source):
98+
num_parameters = len(parameters)
99+
if num_parameters == 1:
100+
first_param = parameters[0]
101+
if source[first_param.start:first_param.end].strip() == 'void':
102+
# We must treat T(void) as a function with no parameters.
103+
return 0
104+
return num_parameters
105+
106+
51107
def _GenerateMethods(output_lines, source, class_node):
52108
function_type = (ast.FUNCTION_VIRTUAL | ast.FUNCTION_PURE_VIRTUAL |
53109
ast.FUNCTION_OVERRIDE)
@@ -63,32 +119,16 @@ def _GenerateMethods(output_lines, source, class_node):
63119
const = ''
64120
if node.modifiers & ast.FUNCTION_CONST:
65121
const = 'CONST_'
122+
num_parameters = _GetNumParameters(node.parameters, source)
66123
return_type = 'void'
67124
if node.return_type:
68-
# Add modifiers like 'const'.
69-
modifiers = ''
70-
if node.return_type.modifiers:
71-
modifiers = ' '.join(node.return_type.modifiers) + ' '
72-
return_type = modifiers + node.return_type.name
73-
template_args = [arg.name for arg in node.return_type.templated_types]
74-
if template_args:
75-
return_type += '<' + ', '.join(template_args) + '>'
76-
if len(template_args) > 1:
77-
for line in [
78-
'// The following line won\'t really compile, as the return',
79-
'// type has multiple template arguments. To fix it, use a',
80-
'// typedef for the return type.']:
81-
output_lines.append(indent + line)
82-
if node.return_type.pointer:
83-
return_type += '*'
84-
if node.return_type.reference:
85-
return_type += '&'
86-
num_parameters = len(node.parameters)
87-
if len(node.parameters) == 1:
88-
first_param = node.parameters[0]
89-
if source[first_param.start:first_param.end].strip() == 'void':
90-
# We must treat T(void) as a function with no parameters.
91-
num_parameters = 0
125+
return_type, has_multiarg_error = _RenderType(node.return_type)
126+
if has_multiarg_error:
127+
for line in [
128+
'// The following line won\'t really compile, as the return',
129+
'// type has multiple template arguments. To fix it, use a',
130+
'// typedef for the return type.']:
131+
output_lines.append(indent + line)
92132
tmpl = ''
93133
if class_node.templated_types:
94134
tmpl = '_T'

0 commit comments

Comments
 (0)