/usr/share/gocode/src/github.com/jacobsa/oglemock/controller.go is in golang-github-jacobsa-oglemock-dev 0.0~git20150428-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 | // Copyright 2011 Aaron Jacobs. All Rights Reserved.
// Author: aaronjjacobs@gmail.com (Aaron Jacobs)
//
// 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.
package oglemock
import (
"errors"
"fmt"
"log"
"math"
"reflect"
"sync"
)
// PartialExpecation is a function that should be called exactly once with
// expected arguments or matchers in order to set up an expected method call.
// See Controller.ExpectMethodCall below. It returns an expectation that can be
// further modified (e.g. by calling WillOnce).
//
// If the arguments are of the wrong type, the function reports a fatal error
// and returns nil.
type PartialExpecation func(...interface{}) Expectation
// Controller represents an object that implements the central logic of
// oglemock: recording and verifying expectations, responding to mock method
// calls, and so on.
type Controller interface {
// ExpectCall expresses an expectation that the method of the given name
// should be called on the supplied mock object. It returns a function that
// should be called with the expected arguments, matchers for the arguments,
// or a mix of both.
//
// fileName and lineNumber should indicate the line on which the expectation
// was made, if known.
//
// For example:
//
// mockWriter := [...]
// controller.ExpectCall(mockWriter, "Write", "foo.go", 17)(ElementsAre(0x1))
// .WillOnce(Return(1, nil))
//
// If the mock object doesn't have a method of the supplied name, the
// function reports a fatal error and returns nil.
ExpectCall(
o MockObject,
methodName string,
fileName string,
lineNumber int) PartialExpecation
// Finish causes the controller to check for any unsatisfied expectations,
// and report them as errors if they exist.
//
// The controller may panic if any of its methods (including this one) are
// called after Finish is called.
Finish()
// HandleMethodCall looks for a registered expectation matching the call of
// the given method on mock object o, invokes the appropriate action (if
// any), and returns the values returned by that action (if any).
//
// If the action returns nothing, the controller returns zero values. If
// there is no matching expectation, the controller reports an error and
// returns zero values.
//
// If the mock object doesn't have a method of the supplied name, the
// arguments are of the wrong type, or the action returns the wrong types,
// the function reports a fatal error.
//
// HandleMethodCall is exported for the sake of mock implementations, and
// should not be used directly.
HandleMethodCall(
o MockObject,
methodName string,
fileName string,
lineNumber int,
args []interface{}) []interface{}
}
// methodMap represents a map from method name to set of expectations for that
// method.
type methodMap map[string][]*InternalExpectation
// objectMap represents a map from mock object ID to a methodMap for that object.
type objectMap map[uintptr]methodMap
// NewController sets up a fresh controller, without any expectations set, and
// configures the controller to use the supplied error reporter.
func NewController(reporter ErrorReporter) Controller {
return &controllerImpl{reporter, sync.RWMutex{}, objectMap{}}
}
type controllerImpl struct {
reporter ErrorReporter
mutex sync.RWMutex
expectationsByObject objectMap // Protected by mutex
}
// Return the list of registered expectations for the named method of the
// supplied object, or an empty slice if none have been registered. When this
// method returns, it is guaranteed that c.expectationsByObject has an entry
// for the object.
//
// c.mutex must be held for reading.
func (c *controllerImpl) getExpectationsLocked(
o MockObject,
methodName string) []*InternalExpectation {
id := o.Oglemock_Id()
// Look up the mock object.
expectationsByMethod, ok := c.expectationsByObject[id]
if !ok {
expectationsByMethod = methodMap{}
c.expectationsByObject[id] = expectationsByMethod
}
result, ok := expectationsByMethod[methodName]
if !ok {
return []*InternalExpectation{}
}
return result
}
// Add an expectation to the list registered for the named method of the
// supplied mock object.
//
// c.mutex must be held for writing.
func (c *controllerImpl) addExpectationLocked(
o MockObject,
methodName string,
exp *InternalExpectation) {
// Get the existing list.
existing := c.getExpectationsLocked(o, methodName)
// Store a modified list.
id := o.Oglemock_Id()
c.expectationsByObject[id][methodName] = append(existing, exp)
}
func (c *controllerImpl) ExpectCall(
o MockObject,
methodName string,
fileName string,
lineNumber int) PartialExpecation {
// Find the signature for the requested method.
ov := reflect.ValueOf(o)
method := ov.MethodByName(methodName)
if method.Kind() == reflect.Invalid {
c.reporter.ReportFatalError(
fileName,
lineNumber,
errors.New("Unknown method: "+methodName))
return nil
}
partialAlreadyCalled := false // Protected by c.mutex
return func(args ...interface{}) Expectation {
c.mutex.Lock()
defer c.mutex.Unlock()
// This function should only be called once.
if partialAlreadyCalled {
c.reporter.ReportFatalError(
fileName,
lineNumber,
errors.New("Partial expectation called more than once."))
return nil
}
partialAlreadyCalled = true
// Make sure that the number of args is legal. Keep in mind that the
// method's type has an extra receiver arg.
if len(args) != method.Type().NumIn() {
c.reporter.ReportFatalError(
fileName,
lineNumber,
errors.New(
fmt.Sprintf(
"Expectation for %s given wrong number of arguments: "+
"expected %d, got %d.",
methodName,
method.Type().NumIn(),
len(args))))
return nil
}
// Create an expectation and insert it into the controller's map.
exp := InternalNewExpectation(
c.reporter,
method.Type(),
args,
fileName,
lineNumber)
c.addExpectationLocked(o, methodName, exp)
// Return the expectation to the user.
return exp
}
}
func (c *controllerImpl) Finish() {
c.mutex.Lock()
defer c.mutex.Unlock()
// Check whether the minimum cardinality for each registered expectation has
// been satisfied.
for _, expectationsByMethod := range c.expectationsByObject {
for methodName, expectations := range expectationsByMethod {
for _, exp := range expectations {
exp.mutex.Lock()
defer exp.mutex.Unlock()
minCardinality, _ := computeCardinalityLocked(exp)
if exp.NumMatches < minCardinality {
c.reporter.ReportError(
exp.FileName,
exp.LineNumber,
errors.New(
fmt.Sprintf(
"Unsatisfied expectation; expected %s to be called "+
"at least %d times; called %d times.",
methodName,
minCardinality,
exp.NumMatches)))
}
}
}
}
}
// expectationMatches checks the matchers for the expectation against the
// supplied arguments.
func expectationMatches(exp *InternalExpectation, args []interface{}) bool {
matchers := exp.ArgMatchers
if len(args) != len(matchers) {
panic("expectationMatches: len(args)")
}
// Check each matcher.
for i, matcher := range matchers {
if err := matcher.Matches(args[i]); err != nil {
return false
}
}
return true
}
// Return the expectation that matches the supplied arguments. If there is more
// than one such expectation, the one furthest along in the list for the method
// is returned. If there is no such expectation, nil is returned.
//
// c.mutex must be held for reading.
func (c *controllerImpl) chooseExpectationLocked(
o MockObject,
methodName string,
args []interface{}) *InternalExpectation {
// Do we have any expectations for this method?
expectations := c.getExpectationsLocked(o, methodName)
if len(expectations) == 0 {
return nil
}
for i := len(expectations) - 1; i >= 0; i-- {
if expectationMatches(expectations[i], args) {
return expectations[i]
}
}
return nil
}
// makeZeroReturnValues creates a []interface{} containing appropriate zero
// values for returning from the supplied method type.
func makeZeroReturnValues(signature reflect.Type) []interface{} {
result := make([]interface{}, signature.NumOut())
for i, _ := range result {
outType := signature.Out(i)
zeroVal := reflect.Zero(outType)
result[i] = zeroVal.Interface()
}
return result
}
// computeCardinality decides on the [min, max] range of the number of expected
// matches for the supplied expectations, according to the rules documented in
// expectation.go.
//
// exp.mutex must be held for reading.
func computeCardinalityLocked(exp *InternalExpectation) (min, max uint) {
// Explicit cardinality.
if exp.ExpectedNumMatches >= 0 {
min = uint(exp.ExpectedNumMatches)
max = min
return
}
// Implicit count based on one-time actions.
if len(exp.OneTimeActions) != 0 {
min = uint(len(exp.OneTimeActions))
max = min
// If there is a fallback action, this is only a lower bound.
if exp.FallbackAction != nil {
max = math.MaxUint32
}
return
}
// Implicit lack of restriction based on a fallback action being configured.
if exp.FallbackAction != nil {
min = 0
max = math.MaxUint32
return
}
// Implicit cardinality of one.
min = 1
max = 1
return
}
// chooseAction returns the action that should be invoked for the i'th match to
// the supplied expectation (counting from zero). If the implicit "return zero
// values" action should be used, it returns nil.
//
// exp.mutex must be held for reading.
func chooseActionLocked(i uint, exp *InternalExpectation) Action {
// Exhaust one-time actions first.
if i < uint(len(exp.OneTimeActions)) {
return exp.OneTimeActions[i]
}
// Fallback action (or nil if none is configured).
return exp.FallbackAction
}
// Find an action for the method call, updating expectation match state in the
// process. Return either an action that should be invoked or a set of zero
// values to return immediately.
//
// This is split out from HandleMethodCall in order to more easily avoid
// invoking the action with locks held.
func (c *controllerImpl) chooseActionAndUpdateExpectations(
o MockObject,
methodName string,
fileName string,
lineNumber int,
args []interface{},
) (action Action, zeroVals []interface{}) {
c.mutex.Lock()
defer c.mutex.Unlock()
// Find the signature for the requested method.
ov := reflect.ValueOf(o)
method := ov.MethodByName(methodName)
if method.Kind() == reflect.Invalid {
c.reporter.ReportFatalError(
fileName,
lineNumber,
errors.New("Unknown method: "+methodName),
)
// Should never get here in real code.
log.Println("ReportFatalError unexpectedly returned.")
return
}
// HACK(jacobsa): Make sure we got the correct number of arguments. This will
// need to be refined when issue #5 (variadic methods) is handled.
if len(args) != method.Type().NumIn() {
c.reporter.ReportFatalError(
fileName,
lineNumber,
errors.New(
fmt.Sprintf(
"Wrong number of arguments: expected %d; got %d",
method.Type().NumIn(),
len(args),
),
),
)
// Should never get here in real code.
log.Println("ReportFatalError unexpectedly returned.")
return
}
// Find an expectation matching this call.
expectation := c.chooseExpectationLocked(o, methodName, args)
if expectation == nil {
c.reporter.ReportError(
fileName,
lineNumber,
errors.New(
fmt.Sprintf("Unexpected call to %s with args: %v", methodName, args),
),
)
zeroVals = makeZeroReturnValues(method.Type())
return
}
expectation.mutex.Lock()
defer expectation.mutex.Unlock()
// Increase the number of matches recorded, and check whether we're over the
// number expected.
expectation.NumMatches++
_, maxCardinality := computeCardinalityLocked(expectation)
if expectation.NumMatches > maxCardinality {
c.reporter.ReportError(
expectation.FileName,
expectation.LineNumber,
errors.New(
fmt.Sprintf(
"Unexpected call to %s: "+
"expected to be called at most %d times; called %d times.",
methodName,
maxCardinality,
expectation.NumMatches,
),
),
)
zeroVals = makeZeroReturnValues(method.Type())
return
}
// Choose an action to invoke. If there is none, just return zero values.
action = chooseActionLocked(expectation.NumMatches-1, expectation)
if action == nil {
zeroVals = makeZeroReturnValues(method.Type())
return
}
// Let the action take over.
return
}
func (c *controllerImpl) HandleMethodCall(
o MockObject,
methodName string,
fileName string,
lineNumber int,
args []interface{},
) []interface{} {
// Figure out whether to invoke an action or return zero values.
action, zeroVals := c.chooseActionAndUpdateExpectations(
o,
methodName,
fileName,
lineNumber,
args,
)
if action != nil {
return action.Invoke(args)
}
return zeroVals
}
|