1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
// Copyright 2010 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @fileoverview Helper class for recording the calls of a function.
*
* Example:
* <pre>
* var stubs = new goog.testing.PropertyReplacer();
*
* function tearDown() {
* stubs.reset();
* }
*
* function testShuffle() {
* stubs.set(Math, 'random', goog.testing.recordFunction(Math.random));
* var arr = shuffle([1, 2, 3, 4, 5]);
* assertSameElements([1, 2, 3, 4, 5], arr);
* assertEquals(4, Math.random.getCallCount());
* }
*
* function testOpenDialog() {
* stubs.set(goog.ui, 'Dialog',
* goog.testing.recordConstructor(goog.ui.Dialog));
* openConfirmDialog();
* var lastDialogInstance = goog.ui.Dialog.getLastCall().getThis();
* assertEquals('confirm', lastDialogInstance.getTitle());
* }
* </pre>
*
*/
goog.provide('goog.testing.FunctionCall');
goog.provide('goog.testing.recordConstructor');
goog.provide('goog.testing.recordFunction');
/**
* Wraps the function into another one which calls the inner function and
* records its calls. The recorded function will have 3 static methods:
* {@code getCallCount}, {@code getCalls} and {@code getLastCall} but won't
* inherit the original function's prototype and static fields.
*
* @param {!Function=} opt_f The function to wrap and record. Defaults to
* {@link goog.nullFunction}.
* @return {!Function} The wrapped function.
*/
goog.testing.recordFunction = function(opt_f) {
var f = opt_f || goog.nullFunction;
var calls = [];
function recordedFunction() {
try {
var ret = f.apply(this, arguments);
calls.push(new goog.testing.FunctionCall(f, this, arguments, ret, null));
return ret;
} catch (err) {
calls.push(new goog.testing.FunctionCall(f, this, arguments, undefined,
err));
throw err;
}
}
/**
* @return {number} Total number of calls.
*/
recordedFunction.getCallCount = function() {
return calls.length;
};
/**
* @return {!Array.<!goog.testing.FunctionCall>} All calls of the recorded
* function.
*/
recordedFunction.getCalls = function() {
return calls;
};
/**
* @return {goog.testing.FunctionCall} Last call of the recorded function or
* null if it hasn't been called.
*/
recordedFunction.getLastCall = function() {
return calls[calls.length - 1] || null;
};
/**
* Returns and removes the last call of the recorded function.
* @return {goog.testing.FunctionCall} Last call of the recorded function or
* null if it hasn't been called.
*/
recordedFunction.popLastCall = function() {
return calls.pop() || null;
};
/**
* Resets the recorded function and removes all calls.
*/
recordedFunction.reset = function() {
calls.length = 0;
};
return recordedFunction;
};
/**
* Same as {@link goog.testing.recordFunction} but the recorded function will
* have the same prototype and static fields as the original one. It can be
* used with constructors.
*
* @param {!Function} ctor The function to wrap and record.
* @return {!Function} The wrapped function.
*/
goog.testing.recordConstructor = function(ctor) {
var recordedConstructor = goog.testing.recordFunction(ctor);
recordedConstructor.prototype = ctor.prototype;
goog.mixin(recordedConstructor, ctor);
return recordedConstructor;
};
/**
* Struct for a single function call.
* @param {!Function} func The called function.
* @param {!Object} thisContext {@code this} context of called function.
* @param {!Arguments} args Arguments of the called function.
* @param {*} ret Return value of the function or undefined in case of error.
* @param {*} error The error thrown by the function or null if none.
* @constructor
*/
goog.testing.FunctionCall = function(func, thisContext, args, ret, error) {
this.function_ = func;
this.thisContext_ = thisContext;
this.arguments_ = Array.prototype.slice.call(args);
this.returnValue_ = ret;
this.error_ = error;
};
/**
* @return {!Function} The called function.
*/
goog.testing.FunctionCall.prototype.getFunction = function() {
return this.function_;
};
/**
* @return {!Object} {@code this} context of called function. It is the same as
* the created object if the function is a constructor.
*/
goog.testing.FunctionCall.prototype.getThis = function() {
return this.thisContext_;
};
/**
* @return {!Array} Arguments of the called function.
*/
goog.testing.FunctionCall.prototype.getArguments = function() {
return this.arguments_;
};
/**
* Returns the nth argument of the called function.
* @param {number} index 0-based index of the argument.
* @return {*} The argument value or undefined if there is no such argument.
*/
goog.testing.FunctionCall.prototype.getArgument = function(index) {
return this.arguments_[index];
};
/**
* @return {*} Return value of the function or undefined in case of error.
*/
goog.testing.FunctionCall.prototype.getReturnValue = function() {
return this.returnValue_;
};
/**
* @return {*} The error thrown by the function or null if none.
*/
goog.testing.FunctionCall.prototype.getError = function() {
return this.error_;
};
|
