LittleMock.java revision 40d40a3f2ebf988f36b828157be56cc12c9c70ac
19de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson/* 29de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Copyright 2011 Google Inc. 39de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 49de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Licensed under the Apache License, Version 2.0 (the "License"); 59de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * you may not use this file except in compliance with the License. 69de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * You may obtain a copy of the License at 79de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 89de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * http://www.apache.org/licenses/LICENSE-2.0 99de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Unless required by applicable law or agreed to in writing, software 119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * distributed under the License is distributed on an "AS IS" BASIS, 129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * See the License for the specific language governing permissions and 149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * limitations under the License. 159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonpackage com.google.testing.littlemock; 189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 19ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudsonimport java.io.File; 205307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudsonimport java.io.ObjectInputStream; 215307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudsonimport java.io.ObjectStreamClass; 229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.lang.reflect.Field; 239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.lang.reflect.InvocationHandler; 249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.lang.reflect.Method; 259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.lang.reflect.Proxy; 269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.util.ArrayList; 279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.util.Arrays; 289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.util.HashMap; 299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.util.List; 309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.util.Map; 319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonimport java.util.concurrent.Callable; 32ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudsonimport java.util.concurrent.CopyOnWriteArrayList; 3340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudsonimport java.util.concurrent.atomic.AtomicLong; 34ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudsonimport java.util.concurrent.atomic.AtomicReference; 359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson/** 379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Very lightweight and simple mocking framework, inspired by Mockito, http://mockito.org. 389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 39ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * <p>It supports only a <b>small subset</b> of the APIs provided by Mockito and other mocking 40ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * frameworks. 419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 42ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * <p>This project was originally designed to be lightweight and suitable for platforms that don't 43ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * support dynamic class generation, for example Android. Since the release of the open 44ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * source dexmaker project http://code.google.com/p/dexmaker/ we can now mock concrete classes 45ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * too. 469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Here is an example of how to use the framework. 489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Suppose that we have this interface: 509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <pre> 519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * public interface Foo { 529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * public String aString(int input); 539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * public void doSomething(); 549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * } 559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </pre> 569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Then stubbing out mocks works as follows: 589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <pre> 599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Foo mockFoo = mock(Foo.class); // Create the mock. 609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * doReturn("hello").when(mockFoo).aString(anyInt()); // Stub the mock to return "hello". 619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * doThrow(new IOException("oh noes")).when(mockFoo).doSomething(); 629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * assertEquals("hello", mockFoo.aString(5)); // Use the mock - performs as expected. 639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * mockFoo.doSomething(); // This will throw an IOException. 649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </pre> 659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>You can verify in the 'natural place', after the method call has happened, like this: 679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <pre> 689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Foo mockFoo = mock(Foo.class); 699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * assertEquals(null, mockFoo.aString(6)); // Unstubbed method calls return a sensible default. 709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verify(mockFoo).aString(6); // This will pass, aString() was called once. 719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verify(mockFoo, never()).doSomething(); // This will pass, doSomething was never called. 729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verify(mockFoo, times(3)).aString(anyInt()); // This will fail, was called once only. 739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </pre> 749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>The documentation is still incomplete. You can look at the {@link LittleMockTest} class and 769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * its unit tests - since they tell you exactly what operations are supported and how to use them. 779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>The reasons I much prefer Mockito's approach to the one of EasyMock are as follows: 799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <ul> 809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>No need to remember to put your mocks in replay mode.</li> 819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>No need to remember to call verify, a dangerous source of false-positive tests or 829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * alternatively over-specified tests.</li> 839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>Much less over-specification: only verify what you actually care about.</li> 849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>Which in turn leads to better separated tests, each test verifying only a part of the 859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * desired behaviour.</li> 869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>Which also leads to less fragile tests, where adding another method call on your 879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * dependencies doesn't break unrelated tests.</li> 88ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * <li>Simpler sharing of common setup method with specific tests overridding individual 89ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * behavious however they want to, only the most recent stubbed call is the one that counts.</li> 909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>More natural order for tests: set up stubs, execute tests, verify that it worked.</li> 919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>More unified syntax that doesn't require special case for differences between void method 929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * calls and method calls that return a value.</li> 939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </ul> 949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>There were enough reasons that I wanted to give Mockito a try. It didn't work on Android 969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * because of issues with class generation. So I looked at the documentation and examples page and 979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * added tests for all the examples, and then implemented the this framework. I should stress that 989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * this is a clean-room implementation, and as such it's possible that there are a couple of methods 999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * that don't work in the same way as Mockito's implementation. Where that is the case I think we 1009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * should fix once we discover them. There is also some functionality missing, but it will be added 1019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * in due course. 1029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 1039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Over time, the API has diverged slightly from the one of Mockito, as I have added APIs that I 1049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * found convenient but that did not have an equivalent in Mockite itself. For anything that has an 1059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * equivalent in Mockito I tried to keep the same name and syntax, to make it easier to transition 1069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * between using one framework to using the other, e.g., when developing both an Android application 1079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * using this framework and a desktop application using Mockito. 1089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 1099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @author hugohudson@gmail.com (Hugo Hudson) 1109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 1119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson/*@NotThreadSafe*/ 1129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonpublic class LittleMock { 1139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates a {@link Behaviour} suitable for void methods. */ 1149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static Behaviour doNothing() { return doReturn(null); } 1159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates a {@link Behaviour} that returns the given result. */ 1179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> Behaviour doReturn(final T result) { 1189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new BehaviourImpl(new Action() { 1199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override public T doAction(Method method, Object[] args) { return result; } 1209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override public Class<?> getReturnType() { 1219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return (result == null) ? null : result.getClass(); 1229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }); 1249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 1279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Gets a {@link Behaviour} that will execute the given {@link Callable} and return its result. 1289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 1299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> Behaviour doAnswer(final Callable<T> callable) { 1309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new BehaviourImpl(new Action() { 1319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T doAction(Method method, Object[] args) throws Throwable { return callable.call(); } 1339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType() { return null; } 1359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }); 1369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Returns a {@link Behaviour} that throws the given {@link Throwable}. */ 1399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T extends Throwable> Behaviour doThrow(final T exception) { 1409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new BehaviourImpl(new Action() { 1419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method method, Object[] args) throws Throwable { throw exception; } 1439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType() { return null; } 1459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }); 1469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Begins a verification step on a mock: the next method invocation on that mock will verify. */ 1499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T verify(T mock, CallCount howManyTimes) { 15040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return verify(mock, howManyTimes, null); 15140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 15240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 15340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private static final class OrderChecker { 15440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private MethodCall mLastCall; 15540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 15640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson public void checkOrder(List<MethodCall> calls, String fieldName) { 15740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson MethodCall lastTrial = null; 15840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson for (MethodCall trial : calls) { 15940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson if (mLastCall == null || mLastCall.mInvocationOrder < trial.mInvocationOrder) { 16040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson mLastCall = trial; 16140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return; 16240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 16340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson lastTrial = trial; 16440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 16540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson fail(formatFailedVerifyOrderMessage(mLastCall, lastTrial, fieldName)); 16640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 16740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 16840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private String formatFailedVerifyOrderMessage(MethodCall lastCall, MethodCall thisCall, 16940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson String fieldName) { 17040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson StringBuffer sb = new StringBuffer(); 17140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson sb.append("\nCall to:"); 17240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson appendDebugStringForMethodCall(sb, thisCall.mMethod, thisCall.mElement, fieldName, false); 17340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson sb.append("\nShould have happened after:"); 17440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson appendDebugStringForMethodCall(sb, lastCall.mMethod, lastCall.mElement, fieldName, false); 17540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson sb.append("\nBut the calls happened in the wrong order"); 17640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson sb.append("\n"); 17740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return sb.toString(); 17840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 17940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 18040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 18140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private static <T> T verify(T mock, CallCount howManyTimes, OrderChecker orderCounter) { 1829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (howManyTimes == null) { 1839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("Can't pass null for howManyTimes parameter"); 1849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 185ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson DefaultInvocationHandler handler = getHandlerFrom(mock); 186ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mHowManyTimes == null, "Unfinished verify() statements"); 18740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson checkState(handler.mOrderCounter == null, "Unfinished verify() statements"); 188ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mStubbingAction == null, "Unfinished stubbing statements"); 1899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkNoMatchers(); 190ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson handler.mHowManyTimes = howManyTimes; 19140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson handler.mOrderCounter = orderCounter; 192ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedCallCounts.add(howManyTimes); 193ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return handler.<T>getVerifyingMock(); 1949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 196ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** The list of outstanding calls to verify() that haven't finished, used to check for errors. */ 197ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static List<CallCount> sUnfinishedCallCounts = new ArrayList<CallCount>(); 198ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 199ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** The list of outstanding calls to when() that haven't finished, used to check for errors. */ 200ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static List<Action> sUnfinishedStubbingActions = new ArrayList<Action>(); 201ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 2029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Begins a verification step for exactly one method call. */ 2039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T verify(T mock) { return verify(mock, times(1)); } 2049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Assert that no method calls at all happened on these mocks. */ 2069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void verifyZeroInteractions(Object... mocks) { 2079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkNoMatchers(); 2089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Object mock : mocks) { 209ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson List<MethodCall> mMethodCalls = getHandlerFrom(mock).mRecordedCalls; 2109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson expect(mMethodCalls.isEmpty(), "Mock expected zero interactions, had " + mMethodCalls); 2119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Assert that there are no unverified method calls on these mocks. */ 2159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void verifyNoMoreInteractions(Object... mocks) { 2169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[1]; 2179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Object mock : mocks) { 2189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson verifyNoMoreInteractions(mock, callSite); 2199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Check that there are no unverified actions on the given mock. */ 2239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void verifyNoMoreInteractions(Object mock, StackTraceElement callSite) { 2249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkNoMatchers(); 2259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DefaultInvocationHandler handlerFrom = getHandlerFrom(mock); 2269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson List<MethodCall> unverifiedCalls = new ArrayList<MethodCall>(); 2279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall method : handlerFrom.mRecordedCalls) { 2289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!method.mWasVerified) { 2299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson unverifiedCalls.add(method); 2309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (unverifiedCalls.size() > 0) { 2339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 2349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\nWe found these unverified calls:"); 2359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall method : unverifiedCalls) { 2369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, method.mMethod, 2379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson method.mElement, handlerFrom.mFieldName, false); 2389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n\nAfter final interaction was verified:\n"); 2409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(" at ").append(callSite).append("\n"); 2419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new AssertionError(sb.toString()); 2429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches exactly the given number of calls. */ 2469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount times(long n) { return new CallCount(n, n); } 2479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 248ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Claims that the verified call must happen before the given timeout. */ 249ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static Timeout timeout(long timeoutMillis) { 250ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return new Timeout(1, 1, timeoutMillis); 251ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 252ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 253ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson/** Creates a {@link CallCount} that only matches if the method was never called. */ 2549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount never() { return new CallCount(0, 0); } 2559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches at least one method call. */ 2579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount atLeastOnce() { return new CallCount(1, Long.MAX_VALUE); } 2589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches any number of method calls, including none at all. */ 2609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount anyTimes() { return new CallCount(0, Long.MAX_VALUE); } 2619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches at least the given number of calls. */ 2639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount atLeast(long n) { return new CallCount(n, Long.MAX_VALUE); } 2649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches up to the given number of calls but no more. */ 2669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount atMost(long n) { return new CallCount(0, n); } 2679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches any number of calls between the two given bounds. */ 2699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount between(long lower, long upper) { return new CallCount(lower, upper); } 2709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 2729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates an argument matcher that matches any object, don't use for primitives. 2739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p> 2749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <b>Note</b>: This does not enforce that the object is of type {@code T}; use 2759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * {@link #isA(Class)} to do that. 2769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 2779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T anyObject() { return LittleMock.<T>addMatcher(new MatchAnything(), null); } 2789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any string. */ 2809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static String anyString() { return isA(String.class); } 2819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any int. */ 2839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static int anyInt() { return addMatcher(new MatchAnything(), 0); } 2849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any float. */ 2869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static float anyFloat() { return addMatcher(new MatchAnything(), 0f); } 2879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any double. */ 2899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static double anyDouble() { return addMatcher(new MatchAnything(), 0.0); } 2909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any boolean. */ 2929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static boolean anyBoolean() { return addMatcher(new MatchAnything(), false); } 2939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any short. */ 2959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static short anyShort() { return addMatcher(new MatchAnything(), (short) 0); } 2969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any char. */ 2989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static char anyChar() { return addMatcher(new MatchAnything(), '\u0000'); } 2999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any long. */ 3019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static long anyLong() { return addMatcher(new MatchAnything(), 0L); } 3029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any byte. */ 3049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static byte anyByte() { return addMatcher(new MatchAnything(), (byte) 0); } 3059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches exactly this value. */ 3079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T eq(final T expected) { 3089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return addMatcher(new ArgumentMatcher() { 3099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { 31125ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson return areEqual(expected, value); 3129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }, expected); 3149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** An argument matcher that matches any value of the given type or a subtype thereof. */ 3179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T isA(final Class<T> clazz) { 3189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.<T>addMatcher(new ArgumentMatcher() { 3199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { 3219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return value == null || clazz.isAssignableFrom(value.getClass()); 3229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }, null); 3249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 3279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Injects fields annotated with {@link Mock} with a newly created mock, and those 3289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * annotated with {@link Captor} with a suitable capture object. 3299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 3309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This operation is recursive, and travels up the class hierarchy, in order to set all 3319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * suitably annotated fields. 3329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 3339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void initMocks(Object instance) throws Exception { 3349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson injectMocksForClass(instance, instance.getClass()); 3359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Recurse up the class hierarchy injecting mocks as we go, stopping when we reach Object. */ 3389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void injectMocksForClass(Object instance, Class<?> clazz) 3399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throws Exception { 3409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (clazz.equals(Object.class)) { 3419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 3429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Field field : clazz.getDeclaredFields()) { 3449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (field.getAnnotation(Mock.class) != null) { 3459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setField(field, instance, mock(field.getType(), field.getName())); 3469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else if (field.getAnnotation(Captor.class) != null) { 3479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setField(field, instance, createCaptor()); 3489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson injectMocksForClass(instance, clazz.getSuperclass()); 3519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 3549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a correctly typed {@link ArgumentCaptor} , it's easier to use 3559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * {@link #initMocks(Object)}. 3569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 3579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> ArgumentCaptor<T> createCaptor() { 3589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new ArgumentCaptorImpl<T>(); 3599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Implementation of the {@link ArgumentCaptor} interface. */ 3629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class ArgumentCaptorImpl<T extends Object> implements ArgumentCaptor<T> { 3639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final ArrayList<T> mAllValues = new ArrayList<T>(); 3649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private T mValue; 3659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private ArgumentCaptorImpl() { 3679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public void setValue(T value) { 3709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mValue = value; 3719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAllValues.add(mValue); 3729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T getValue() { 3769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mValue; 3779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public List<T> getAllValues() { 3819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mAllValues; 3829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T capture() { 3869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.<T>addMatcher(this, null); 3879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { 3919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // A capture always matches any argument. 3929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This is so that verify(mMock).someMethod(capture(mCapture)) will match any and all calls 3939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // to someMethod() and we will capture the values into mCapture. 3949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return true; 3959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 3999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a mock, more easily done via the {@link #initMocks(Object)} method. 4009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Also if you use this method to create your mock, the field in the error messages will 4029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * be named the same as your class passed in, you only get the actual field name if you 4039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * use the annotation. 4049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @throws IllegalArgumentException if the class you pass in is null 4069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 4079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T mock(Class<T> clazz) { 4089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (clazz == null) { 4099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("Class to mock was null"); 4109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mock(clazz, getDefaultFieldNameFor(clazz)); 4129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a mock, more easily done via the {@link #initMocks(Object)} method. */ 415ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 4169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static <T> T mock(Class<T> clazz, String fieldName) { 417ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) createProxy(clazz, new DefaultInvocationHandler(clazz, fieldName)); 4189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Pick a suitable name for a field of the given clazz. */ 4219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static String getDefaultFieldNameFor(Class<?> clazz) { 4229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return clazz.getSimpleName().substring(0, 1).toLowerCase() 4239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson + clazz.getSimpleName().substring(1); 4249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Clears out the expectations on these mocks. */ 4279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void reset(Object... mocks) { 4289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Object mock : mocks) { 4299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson getHandlerFrom(mock).reset(); 4309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Use this in tear down to check for programming errors. */ 434ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static void checkForProgrammingErrorsDuringTearDown() { 435ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoMatchers(); 436ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoUnfinishedCalls(sUnfinishedCallCounts, "verify()"); 437ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoUnfinishedCalls(sUnfinishedStubbingActions, "stubbing"); 438ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 439ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 440ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Helper function to check that there are no verify or stubbing commands outstanding. */ 441ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static void checkNoUnfinishedCalls(List<?> list, String type) { 442ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (!list.isEmpty()) { 443ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson list.clear(); 444ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Unfinished " + type + " statements"); 445ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 446ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 4479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Implementation of {@link Behaviour}. */ 4499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class BehaviourImpl implements Behaviour { 4509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Action mAction; 4519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private BehaviourImpl(Action action) { 4539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAction = action; 4549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 4579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public <T> T when(T mock) { 458ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson DefaultInvocationHandler handler = getHandlerFrom(mock); 459ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mHowManyTimes == null, "Unfinished verify() statements"); 46040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson checkState(handler.mOrderCounter == null, "Unfinished verify() statements"); 461ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mStubbingAction == null, "Unfinished stubbing statements"); 462ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson handler.mStubbingAction = mAction; 463ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedStubbingActions.add(mAction); 464ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return handler.<T>getStubbingMock(); 4659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 4699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The static list of argument matchers, used in the next method call to the mock. 4709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>In order to support the syntax like this: verify(mFoo).someMethod(anyInt()), it is 4729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * required that the anyInt() method store the value somewhere for use when the someMethod 4739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * is invoked. That somewhere has to be static. I don't like it any more than you do. 4749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>The same goes for anything that is passed into the someMethod as an argument - be it 4769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * a capture(mCaptureString) or eq(5) or whatever. 4779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Avoiding the use of statics requires that we change the syntax of the verify statement, 4799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * and I can't think of an elegant way of doing it, and in any case I really like the current 4809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * syntax, so for now a static variable it is. 4819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This match arguments list should contain either zero elements (the next method call will 4839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * not use any argument matchers) or it should contain exactly one argument matcher for 4849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * every argument being passed to the next method call. You can't mix argument matchers and 4859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * raw values. 4869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 4879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final List<ArgumentMatcher> sMatchArguments = new ArrayList<ArgumentMatcher>(); 4889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 48940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** Global invocation order of every mock method call. */ 49040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private static final AtomicLong sGlobalInvocationOrder = new AtomicLong(); 49140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 4929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Encapsulates a single call of a method with associated arguments. */ 4939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class MethodCall { 4949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The method call. */ 4959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Method mMethod; 4969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The arguments provided at the time the call happened. */ 4979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Object[] mArgs; 49840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** The order in which this method call was invoked. */ 49940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private final long mInvocationOrder; 5009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The line from the test that invoked the handler to create this method call. */ 5019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final StackTraceElement mElement; 5029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Keeps track of method calls that have been verified, for verifyNoMoreInteractions(). */ 5039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean mWasVerified = false; 5049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public MethodCall(Method method, StackTraceElement element, Object[] args) { 5069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mMethod = method; 5079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mElement = element; 5089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mArgs = args; 50940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson mInvocationOrder = sGlobalInvocationOrder.getAndIncrement(); 5109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean argsMatch(Object[] args) { 5139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return Arrays.equals(mArgs, args); 5149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 5179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 5189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "MethodCall [method=" + mMethod + ", args=" + Arrays.toString(mArgs) + "]"; 5199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 52225ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson private static boolean areMethodsSame(Method first, Method second) { 52325ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson return areEqual(first.getDeclaringClass(), second.getDeclaringClass()) && 52425ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson areEqual(first.getName(), second.getName()) && 52525ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson areEqual(first.getReturnType(), second.getReturnType()) && 52625ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson Arrays.equals(first.getParameterTypes(), second.getParameterTypes()); 52725ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } 52825ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson 52925ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson private static boolean areEqual(Object a, Object b) { 53025ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (a == null) { 53125ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson return b == null; 53225ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } 53325ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson return a.equals(b); 53425ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } 53525ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson 5369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Magically handles the invoking of method calls. 5389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This object is in one of three states, default (where invoking methods returns default 5409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * values and records the call), verifying (where invoking method calls makes sure that those 5419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * method calls happen with the supplied arguments or matchers) or stubbing (where the next method 5429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * call tells us which arguments to match in order to perform the desired behaviour). 5439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class DefaultInvocationHandler implements InvocationHandler { 5459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sEqualsMethod; 5469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sHashCodeMethod; 5479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sToStringMethod; 5489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 5509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson try { 5519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sEqualsMethod = Object.class.getMethod("equals", Object.class); 5529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sHashCodeMethod = Object.class.getMethod("hashCode"); 5539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sToStringMethod = Object.class.getMethod("toString"); 5549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } catch (SecurityException e) { 5559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Should never happen. 5569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new RuntimeException("Your JVM/classloader is broken", e); 5579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } catch (NoSuchMethodException e) { 5589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Should never happen. 5599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new RuntimeException("Your JVM/classloader is broken", e); 5609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The class of the mocked objects. */ 5649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Class<?> mClazz; 5659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The field name in which the mock is assigned. */ 5669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final String mFieldName; 5679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The list of method calls executed on the mock. */ 569ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private List<MethodCall> mRecordedCalls = new CopyOnWriteArrayList<MethodCall>(); 5709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The list of method calls that were stubbed out and their corresponding actions. */ 571ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private List<StubbedCall> mStubbedCalls = new CopyOnWriteArrayList<StubbedCall>(); 572ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 5739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The number of times a given call should be verified. 5759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is not null when in the verification state, and it is actually used to determine if we 5779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * are in the verification state. 5789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is reset to null once the verification has occurred. 5809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private CallCount mHowManyTimes = null; 58240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private OrderChecker mOrderCounter = null; 583ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 5849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The action to be associated with the stubbed method. 5869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is not null when in the stubbing state, and it is actually used to determine if we are 5889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * in the stubbing state. 5899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private Action mStubbingAction = null; 5919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 592ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Dynamic proxy used to verify calls against this mock. */ 593ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private final Object mVerifyingMock; 594ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 595ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Dynamic proxy used to stub calls against this mock. */ 596ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private final Object mStubbingMock; 597ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 5989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a new invocation handler for an object. 6009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 6019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param clazz the class the object belongs to 6029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param fieldName The name to be used to refer to the object. This may either be the name of 6039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * the field this mock will be stored into (in case it uses @Mock) or a suitable name to 6049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * use to refer to the object in error messages, based on the name of the class itself. 6059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 6069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public DefaultInvocationHandler(Class<?> clazz, String fieldName) { 6079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mClazz = clazz; 6089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mFieldName = fieldName; 609ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mVerifyingMock = createVerifyingMock(clazz); 610ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbingMock = createStubbingMock(clazz); 611ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 612ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 613ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // Safe if you call getHandlerFrom(mock).getVerifyingMock(), since this is guaranteed to be 614ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // of the same type as mock itself. 615ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 616ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public <T> T getVerifyingMock() { 617ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) mVerifyingMock; 618ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 619ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 620ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // Safe if you call getHandlerFrom(mock).getStubbingMock(), since this is guaranteed to be 621ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // of the same type as mock itself. 622ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 623ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public <T> T getStubbingMock() { 624ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) mStubbingMock; 625ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 626ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 627ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Used to check that we always stub and verify from the same thread. */ 628ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private AtomicReference<Thread> mCurrentThread = new AtomicReference<Thread>(); 629ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 630ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Check that we are stubbing and verifying always from the same thread. */ 631ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private void checkThread() { 632ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Thread currentThread = Thread.currentThread(); 633ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mCurrentThread.compareAndSet(null, currentThread); 634ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (mCurrentThread.get() != currentThread) { 635ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Must always mock and stub from one thread only. " 636ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson + "This thread: " + currentThread + ", the other thread: " + mCurrentThread.get()); 637ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 638ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 639ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 640ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Generate the dynamic proxy that will handle verify invocations. */ 641ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private Object createVerifyingMock(Class<?> clazz) { 642ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return createProxy(clazz, new InvocationHandler() { 643ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 644ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 645ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkThread(); 646ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson expect(mHowManyTimes != null, "verifying mock doesn't know how many times"); 647ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 648ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson ArgumentMatcher[] matchers = checkClearAndGetMatchers(method); 649ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 650ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 65140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson innerVerify(method, matchers, methodCall, proxy, callSite, mHowManyTimes, mOrderCounter); 652ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return defaultReturnValue(method.getReturnType()); 653ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } finally { 654ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedCallCounts.remove(mHowManyTimes); 655ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mHowManyTimes = null; 65640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson mOrderCounter = null; 657ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 658ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 659ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson }); 660ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 661ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 662ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Generate the dynamic proxy that will handle stubbing invocations. */ 663ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private Object createStubbingMock(Class<?> clazz) { 664ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return createProxy(clazz, new InvocationHandler() { 665ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 666ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 667ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkThread(); 668ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson expect(mStubbingAction != null, "stubbing mock doesn't know what action to perform"); 669ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 670ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson ArgumentMatcher[] matchers = checkClearAndGetMatchers(method); 671ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 672ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 673ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson innerStub(method, matchers, methodCall, callSite, mStubbingAction); 674ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return defaultReturnValue(method.getReturnType()); 675ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } finally { 676ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedStubbingActions.remove(mStubbingAction); 677ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbingAction = null; 678ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 679ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 680ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson }); 6819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 6849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 6859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 6869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 687ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return innerRecord(method, args, methodCall, proxy, callSite); 6889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 6919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Checks whether the given method is one of the special object methods that should not 6929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verified or stubbed. 6939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p> 6949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * If this is one of such methods, it throws an AssertionException. 6959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 6969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param method the method to be checked 6979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param operation the name of the operation, used for generating a helpful message 6989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 6999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void checkSpecialObjectMethods(Method method, String operation) { 70025ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(method, sEqualsMethod) 70125ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson || areMethodsSame(method, sHashCodeMethod) 70225ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson || areMethodsSame(method, sToStringMethod)) { 7039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson fail("cannot " + operation + " call to " + method); 7049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void reset() { 7089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mRecordedCalls.clear(); 7099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mStubbedCalls.clear(); 7109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mHowManyTimes = null; 71140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson mOrderCounter = null; 7129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mStubbingAction = null; 7139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private Object innerRecord(Method method, final Object[] args, 7169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall methodCall, Object proxy, StackTraceElement callSite) throws Throwable { 71725ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(method, sEqualsMethod)) { 7189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Use identify for equality, the default behavior on object. 7199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return proxy == args[0]; 72025ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } else if (areMethodsSame(method, sHashCodeMethod)) { 7219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This depends on the fact that each mock has its own DefaultInvocationHandler. 7229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return hashCode(); 72325ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } else if (areMethodsSame(method, sToStringMethod)) { 7249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This is used to identify this is a mock, e.g., in error messages. 7259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "Mock<" + mClazz.getName() + ">"; 7269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mRecordedCalls.add(methodCall); 7289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (StubbedCall stubbedCall : mStubbedCalls) { 72925ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(stubbedCall.mMethodCall.mMethod, methodCall.mMethod)) { 7309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (stubbedCall.mMethodCall.argsMatch(methodCall.mArgs)) { 7319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson methodCall.mWasVerified = true; 7329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbedCall.mAction.doAction(method, args); 7339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If no stub is defined, return the default value. 7379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return defaultReturnValue(method.getReturnType()); 7389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void innerStub(Method method, final ArgumentMatcher[] matchers, MethodCall methodCall, 741ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite, final Action stubbingAction) { 7429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkSpecialObjectMethods(method, "stub"); 7439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkThisActionCanBeUsedForThisMethod(method, stubbingAction, callSite); 7449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers.length == 0) { 7459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If there are no matchers, then this is a simple stubbed method call with an action. 746ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbedCalls.add(0, new StubbedCall(methodCall, stubbingAction)); 7479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 7489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If there are matchers, then we need to make a new method call which matches only 7509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // when all the matchers match. Further, the action that method call needs to take 7519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // is to first record the values into any captures that may be present, and only then 7529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // proceed to execute the original action. 7539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall matchMatchersMethodCall = new MethodCall(method, callSite, matchers) { 7549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 7559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean argsMatch(Object[] args) { return doMatchersMatch(matchers, args); } 7569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }; 7579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Action setCapturesThenAction = new Action() { 7589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 7599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method innerMethod, Object[] innerArgs) throws Throwable { 7609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setCaptures(matchers, innerArgs); 7619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbingAction.doAction(innerMethod, innerArgs); 7629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 7649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType() { 7659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbingAction.getReturnType(); 7669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }; 768ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbedCalls.add(0, new StubbedCall(matchMatchersMethodCall, setCapturesThenAction)); 7699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void checkThisActionCanBeUsedForThisMethod(Method method, final Action stubbingAction, 7729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite) { 7739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Class<?> methodType = method.getReturnType(); 7749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Class<?> actionType = stubbingAction.getReturnType(); 7759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (actionType == null) { 7769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // We could not determine the type returned by this action at the time we 7779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // created it. At this time we cannot check that the returned value is 7789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // appropriate to the return type of the method. 7799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // However, if the type is not correct, any actual invocation of the method 7809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // will fail later on. 7819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 7829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!methodType.isAssignableFrom(actionType)) { 7849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (methodType.isPrimitive() && 7859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson actionType.equals(PRIMITIVE_TO_BOXED_LOOKUP.get(methodType))) { 7869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 7879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 7899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\nCan't return ").append(actionType.getSimpleName()).append(" from stub for:"); 7909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, method, callSite, mFieldName, true); 7919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n"); 7929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException(sb.toString()); 7939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private boolean doMatchersMatch(ArgumentMatcher[] matchers, Object[] args) { 7979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (int i = 0; i < matchers.length; ++i) { 7989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!matchers[i].matches(args[i])) { 7999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return false; 8009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return true; 8039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void innerVerify(Method method, ArgumentMatcher[] matchers, MethodCall methodCall, 80640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson Object proxy, StackTraceElement callSite, CallCount callCount, OrderChecker orderCounter) { 8079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkSpecialObjectMethods(method, "verify"); 80840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson List<MethodCall> calls = countMatchingInvocations(method, matchers, methodCall); 809ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson long callTimeout = callCount.getTimeout(); 81040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson checkState(orderCounter == null || callTimeout == 0, "can't inorder verify with a timeout"); 811ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (callTimeout > 0) { 812ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson long endTime = System.currentTimeMillis() + callTimeout; 81340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson while (!callCount.matches(calls.size())) { 814ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 815ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Thread.sleep(1); 816ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } catch (InterruptedException e) { 817ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson fail("interrupted whilst waiting to verify"); 818ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 819ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (System.currentTimeMillis() > endTime) { 82040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson fail(formatFailedVerifyMessage(methodCall, calls.size(), callTimeout, callCount)); 821ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 82240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson calls = countMatchingInvocations(method, matchers, methodCall); 823ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 824ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } else { 82540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson if (orderCounter != null) { 82640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson orderCounter.checkOrder(calls, mFieldName); 82740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } else if (!callCount.matches(calls.size())) { 82840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson fail(formatFailedVerifyMessage(methodCall, calls.size(), 0, callCount)); 829ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 830ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 831ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 832ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 83340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private List<MethodCall> countMatchingInvocations(Method method, ArgumentMatcher[] matchers, 834ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall) { 83540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson List<MethodCall> methodCalls = new ArrayList<MethodCall>(); 8369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall call : mRecordedCalls) { 83725ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(call.mMethod, method)) { 8389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if ((matchers.length > 0 && doMatchersMatch(matchers, call.mArgs)) || 8399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson call.argsMatch(methodCall.mArgs)) { 8409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setCaptures(matchers, call.mArgs); 84140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson methodCalls.add(call); 8429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson call.mWasVerified = true; 8439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 84640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return methodCalls; 8479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 849ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private String formatFailedVerifyMessage(MethodCall methodCall, int total, long timeoutMillis, 850ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson CallCount callCount) { 8519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 852ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append("\nExpected ").append(callCount); 853ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (timeoutMillis > 0) { 854ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append(" within " + timeoutMillis + "ms"); 855ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 856ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append(" to:"); 8579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, methodCall.mMethod, 8589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson methodCall.mElement, mFieldName, false); 8599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n\n"); 8609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (mRecordedCalls.size() == 0) { 861ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append("No method calls happened on this mock"); 8629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else { 8639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("Method calls that did happen:"); 8649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall recordedCall : mRecordedCalls) { 8659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, recordedCall.mMethod, 8669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson recordedCall.mElement, mFieldName, false); 8679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n"); 8709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return sb.toString(); 8719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** All matchers that are captures will store the corresponding arg value. */ 8749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This suppress warning means that I'm calling setValue with something that I can't promise 8759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // is of the right type. But I think it is unavoidable. Certainly I could give a better 8769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // error message than the class cast exception you'll get when you try to retrieve the value. 8779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @SuppressWarnings("unchecked") 8789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void setCaptures(ArgumentMatcher[] matchers, Object[] args) { 8799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (int i = 0; i < matchers.length; ++i) { 8809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers[i] instanceof ArgumentCaptorImpl) { 8819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson ArgumentCaptorImpl.class.cast(matchers[i]).setValue(args[i]); 8829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** An empty array of matchers, to optimise the toArray() call below. */ 8879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final ArgumentMatcher[] EMPTY_MATCHERS_ARRAY = new ArgumentMatcher[0]; 8889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Makes sure that we have the right number of MATCH_ARGUMENTS for the given method. */ 8909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private ArgumentMatcher[] checkClearAndGetMatchers(Method method) { 8919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson ArgumentMatcher[] matchers = sMatchArguments.toArray(EMPTY_MATCHERS_ARRAY); 8929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.clear(); 8939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers.length > 0 && method.getParameterTypes().length != matchers.length) { 8949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("You can't mix matchers and regular objects."); 8959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return matchers; 8979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void appendDebugStringForMethodCall(StringBuffer sb, Method method, 9019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite, String fieldName, boolean showReturnType) { 9029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n "); 9039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (showReturnType) { 9049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("(").append(method.getReturnType().getSimpleName()).append(") "); 9059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(fieldName).append(".").append(method.getName()).append("("); 9079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson int i = 0; 9089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Class<?> type : method.getParameterTypes()) { 9099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (++i > 1) { 9109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(", "); 9119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(type.getSimpleName()); 9139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(")\n at ").append(callSite); 9159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Call this function when you don't expect there to be any outstanding matcher objects. */ 9189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void checkNoMatchers() { 9199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (sMatchArguments.size() > 0) { 9209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.clear(); 9219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalStateException("You have outstanding matchers, must be programming error"); 9229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** A pairing of a method call and an action to be performed when that call happens. */ 9269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class StubbedCall { 9279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final MethodCall mMethodCall; 9289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Action mAction; 9299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public StubbedCall(MethodCall methodCall, Action action) { 9319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mMethodCall = methodCall; 9329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAction = action; 9339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 9369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 9379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "StubbedCall [methodCall=" + mMethodCall + ", action=" + mAction + "]"; 9389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Represents an action to be performed as a result of a method call. */ 9429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private interface Action { 9439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method method, Object[] arguments) throws Throwable; 9449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The type of the action, or null if we can't determine the type at stub time. */ 9459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType(); 9469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Represents something capable of testing if it matches an argument or not. */ 9492a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson public interface ArgumentMatcher { 9509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value); 9519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** A matcher that matches any argument. */ 9549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class MatchAnything implements ArgumentMatcher { 9559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 9569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { return true; } 9579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Encapsulates the number of times a method is called, between upper and lower bounds. */ 9609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class CallCount { 961ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mLowerBound; 962ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mUpperBound; 9639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 964ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount(long lowerBound, long upperBound) { 9659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mLowerBound = lowerBound; 9669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mUpperBound = upperBound; 9679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Tells us if this call count matches a desired count. */ 9709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(long total) { 9719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return total >= mLowerBound && total <= mUpperBound; 9729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 974ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Tells us how long we should block waiting for the verify to happen. */ 975ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public long getTimeout() { 976ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return 0; 977ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 978ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 979ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount setLowerBound(long lowerBound) { 980ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mLowerBound = lowerBound; 981ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return this; 982ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 983ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 984ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount setUpperBound(long upperBound) { 985ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mUpperBound = upperBound; 986ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return this; 987ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 988ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 9899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 9909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 9919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (mLowerBound == mUpperBound) { 9929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "exactly " + mLowerBound + plural(" call", mLowerBound); 9939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else { 9949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "between " + mLowerBound + plural(" call", mLowerBound) + " and " + 9959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mUpperBound + plural(" call", mUpperBound); 9969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1000ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Encapsulates adding number of times behaviour to a call count with timeout. */ 1001ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static final class Timeout extends CallCount { 1002ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mTimeoutMillis; 1003ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1004ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Timeout(long lowerBound, long upperBound, long timeoutMillis) { 1005ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson super(lowerBound, upperBound); 1006ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mTimeoutMillis = timeoutMillis; 1007ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1008ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1009ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 1010ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public long getTimeout() { 1011ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return mTimeoutMillis; 1012ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1013ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1014ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount times(int times) { return setLowerBound(times).setUpperBound(times); } 1015ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount atLeast(long n) { return setLowerBound(n).setUpperBound(Long.MAX_VALUE); } 1016ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount atLeastOnce() { return setLowerBound(1).setUpperBound(Long.MAX_VALUE); } 1017ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount between(long n, long m) { return setLowerBound(n).setUpperBound(m); } 1018ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1019ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 10209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Helper method to add an 's' to a string iff the count is not 1. */ 10219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static String plural(String prefix, long count) { 10229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return (count == 1) ? prefix : (prefix + "s"); 10239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Helps us implement the eq(), any() and capture() and other methods on one line. */ 10269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static <T> T addMatcher(ArgumentMatcher argument, T value) { 10279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.add(argument); 10289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return value; 10299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10312a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson /** A custom argument matcher, should be used only for object arguments not primitives. */ 10322a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson public static <T> T matches(ArgumentMatcher argument) { 10332a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson sMatchArguments.add(argument); 10342a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson return null; 10352a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson } 10362a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson 10379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Utility method to throw an AssertionError if an assertion fails. */ 10389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void expect(boolean result, String message) { 10399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!result) { 10409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson fail(message); 10419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Throws an AssertionError exception with a message. */ 10459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void fail(String message) { 10469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new AssertionError(message); 10479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Static mapping from class type to default value for that type. */ 10509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final Map<Class<?>, Object> DEFAULT_RETURN_VALUE_LOOKUP; 10519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 10529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP = new HashMap<Class<?>, Object>(); 10539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(int.class, 0); 10549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(boolean.class, false); 10559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(byte.class, (byte) 0); 10569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(long.class, (long) 0); 10579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(short.class, (short) 0); 10589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(float.class, (float) 0); 10599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(double.class, (double) 0); 10609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(char.class, '\u0000'); 10619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(String.class, null); 10629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Static lookup from primitive types to their boxed versions. */ 10659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final Map<Class<?>, Class<?>> PRIMITIVE_TO_BOXED_LOOKUP; 10669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 10679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP = new HashMap<Class<?>, Class<?>>(); 10689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(int.class, Integer.class); 10699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(boolean.class, Boolean.class); 10709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(byte.class, Byte.class); 10719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(long.class, Long.class); 10729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(short.class, Short.class); 10739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(float.class, Float.class); 10749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(double.class, Double.class); 10759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(char.class, Character.class); 10769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** For a given class type, returns the default value for that type. */ 10799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Object defaultReturnValue(Class<?> returnType) { 10809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return DEFAULT_RETURN_VALUE_LOOKUP.get(returnType); 10819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Gets a suitable class loader for use with the proxy. */ 10849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static ClassLoader getClassLoader() { 10859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.class.getClassLoader(); 10869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Sets a member field on an object via reflection (can set private members too). */ 10899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void setField(Field field, Object object, Object value) throws Exception { 10909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.setAccessible(true); 10919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.set(object, value); 10929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.setAccessible(false); 10939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1094ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1095ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Helper method to throw an IllegalStateException if given condition is not met. */ 1096ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static void checkState(boolean condition, String message) { 1097ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (!condition) { 1098ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException(message); 1099ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1100ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1101ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1102ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson /** 1103ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson * If the input object is one of our mocks, returns the {@link DefaultInvocationHandler} 1104ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson * we constructed it with. Otherwise fails with {@link IllegalArgumentException}. 1105ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson */ 1106ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson private static DefaultInvocationHandler getHandlerFrom(Object mock) { 1107ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson try { 1108ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson InvocationHandler invocationHandler = Proxy.getInvocationHandler(mock); 1109ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson if (invocationHandler instanceof DefaultInvocationHandler) { 1110ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson return (DefaultInvocationHandler) invocationHandler; 1111ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1112ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } catch (IllegalArgumentException expectedIfNotAProxy) {} 1113ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson try { 1114ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Class<?> proxyBuilder = Class.forName("com.google.dexmaker.stock.ProxyBuilder"); 1115ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Method getHandlerMethod = proxyBuilder.getMethod("getInvocationHandler", Object.class); 1116ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Object invocationHandler = getHandlerMethod.invoke(proxyBuilder, mock); 1117ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson if (invocationHandler instanceof DefaultInvocationHandler) { 1118ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson return (DefaultInvocationHandler) invocationHandler; 1119ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1120ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } catch (Exception expectedIfNotAProxyBuilderMock) {} 1121ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson throw new IllegalArgumentException("not a valid mock: " + mock); 1122ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1123ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson 1124ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Create a dynamic proxy for the given class, delegating to the given invocation handler. */ 1125ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static Object createProxy(Class<?> clazz, InvocationHandler handler) { 1126ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (clazz.isInterface()) { 1127ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return Proxy.newProxyInstance(getClassLoader(), new Class<?>[] { clazz }, handler); 1128ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1129ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 1130ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Class<?> proxyBuilder = Class.forName("com.google.dexmaker.stock.ProxyBuilder"); 1131ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Method forClassMethod = proxyBuilder.getMethod("forClass", Class.class); 1132ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Object builder = forClassMethod.invoke(null, clazz); 1133ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Method dexCacheMethod = builder.getClass().getMethod("dexCache", File.class); 1134ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson File directory = AppDataDirGuesser.getsInstance().guessSuitableDirectoryForGeneratedClasses(); 1135ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson builder = dexCacheMethod.invoke(builder, directory); 11365307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Method buildClassMethod = builder.getClass().getMethod("buildProxyClass"); 11375307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Class<?> resultClass = (Class<?>) buildClassMethod.invoke(builder); 11385307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Object proxy = unsafeCreateInstance(resultClass); 11395307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Field handlerField = resultClass.getDeclaredField("$__handler"); 11405307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson handlerField.setAccessible(true); 11415307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson handlerField.set(proxy, handler); 11425307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return proxy; 1143ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } catch (Exception e) { 1144ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Could not mock this concrete class", e); 1145ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1146ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 11475307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson 11485307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson /** Attempt to construct an instance of the class using hacky methods to avoid calling super. */ 11495307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson @SuppressWarnings("unchecked") 11505307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson private static <T> T unsafeCreateInstance(Class<T> clazz) { 11515307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson // try dalvikvm, pre-gingerbread 11525307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson try { 11535307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final Method newInstance = ObjectInputStream.class.getDeclaredMethod( 11545307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "newInstance", Class.class, Class.class); 11555307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson newInstance.setAccessible(true); 11565307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return (T) newInstance.invoke(null, clazz, Object.class); 11575307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } catch (Exception ignored) {} 11585307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson // try dalvikvm, post-gingerbread 11595307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson try { 11605307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Method getConstructorId = ObjectStreamClass.class.getDeclaredMethod( 11615307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "getConstructorId", Class.class); 11625307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson getConstructorId.setAccessible(true); 11635307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final int constructorId = (Integer) getConstructorId.invoke(null, Object.class); 11645307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final Method newInstance = ObjectStreamClass.class.getDeclaredMethod( 11655307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "newInstance", Class.class, int.class); 11665307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson newInstance.setAccessible(true); 11675307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return (T) newInstance.invoke(null, clazz, constructorId); 11685307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } catch (Exception ignored) {} 11695307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson throw new IllegalStateException("unsafe create instance failed"); 11705307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } 117140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 117240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** See {@link LittleMock#inOrder(Object[])}. */ 117340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson public interface InOrder { 117440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson <T> T verify(T mock); 117540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 117640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 117740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** 117840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * Used to verify that invocations happen in a given order. 117940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * <p> 118040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * Still slight experimental at the moment: you can only verify one method call at a time, 118140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * and we ignore the mocks array you pass in as an argument, you may use the returned inorder 118240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * to verify all mocks. 118340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * <p> 118440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * This implementation is simple: the InOrder you get from this call can be used to verify that 118540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * a sequence of method calls happened in the order you specify. Every verify you make with 118640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * this InOrder will be compared with every other verify you made, to make sure that all the 118740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * original invocations happened in exactly that same order. 118840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson */ 118940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson public static InOrder inOrder(Object... mocks) { 119040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return new InOrder() { 119140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private final OrderChecker mChecker = new OrderChecker(); 119240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson @Override 119340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson public <T> T verify(T mock) { 119440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return LittleMock.verify(mock, times(1), mChecker); 119540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 119640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson }; 119740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 11989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson} 1199