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 36100e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder /** 36200e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder * Create a correctly typed ArgumentCaptor that also works for primitive types. 36300e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder * For example, to capture an int, use 36400e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder * <code>ArgumentCaptor<Integer> c = createCaptor(Integer.class);</code> 36500e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder */ 36600e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder public static <T> ArgumentCaptor<T> createCaptor(Class<T> clazz) { 36700e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return new ArgumentCaptorImpl<T>(clazz); 36800e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 36900e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder 3709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Implementation of the {@link ArgumentCaptor} interface. */ 3719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class ArgumentCaptorImpl<T extends Object> implements ArgumentCaptor<T> { 3729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final ArrayList<T> mAllValues = new ArrayList<T>(); 3739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private T mValue; 37400e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder private Class<T> mClass; 3759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private ArgumentCaptorImpl() { 37700e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder mClass = null; 37800e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 37900e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder 38000e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder private ArgumentCaptorImpl(Class<T> clazz) { 38100e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder mClass = clazz; 3829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public void setValue(T value) { 3859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mValue = value; 3869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAllValues.add(mValue); 3879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T getValue() { 3919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mValue; 3929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public List<T> getAllValues() { 3969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mAllValues; 3979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 4009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T capture() { 40100e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (mClass != null) { 40200e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Integer.class.isAssignableFrom(mClass)) { 40300e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Integer>addMatcher(this, 0); 40400e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 40500e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Float.class.isAssignableFrom(mClass)) { 40600e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Float>addMatcher(this, 0f); 40700e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 40800e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Double.class.isAssignableFrom(mClass)) { 40900e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Double>addMatcher(this, 0.0); 41000e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 41100e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Boolean.class.isAssignableFrom(mClass)) { 41200e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Boolean>addMatcher(this, false); 41300e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 41400e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Short.class.isAssignableFrom(mClass)) { 41500e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Short>addMatcher(this, (short) 0); 41600e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 41700e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Character.class.isAssignableFrom(mClass)) { 41800e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Character>addMatcher(this, '\u0000'); 41900e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 42000e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Long.class.isAssignableFrom(mClass)) { 42100e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Long>addMatcher(this, 0L); 42200e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 42300e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder if (Byte.class.isAssignableFrom(mClass)) { 42400e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder return (T) LittleMock.<Byte>addMatcher(this, (byte) 0); 42500e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 42600e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder } 4279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.<T>addMatcher(this, null); 4289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 43000e20ef3c702f7388c98bdeee300d218c7871f4dMarc Schroeder 4319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 4329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { 4339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // A capture always matches any argument. 4349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This is so that verify(mMock).someMethod(capture(mCapture)) will match any and all calls 4359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // to someMethod() and we will capture the values into mCapture. 4369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return true; 4379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 4419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a mock, more easily done via the {@link #initMocks(Object)} method. 4429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Also if you use this method to create your mock, the field in the error messages will 4449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * be named the same as your class passed in, you only get the actual field name if you 4459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * use the annotation. 4469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @throws IllegalArgumentException if the class you pass in is null 4489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 4499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T mock(Class<T> clazz) { 4509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (clazz == null) { 4519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("Class to mock was null"); 4529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mock(clazz, getDefaultFieldNameFor(clazz)); 4549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a mock, more easily done via the {@link #initMocks(Object)} method. */ 457ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 4589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static <T> T mock(Class<T> clazz, String fieldName) { 459ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) createProxy(clazz, new DefaultInvocationHandler(clazz, fieldName)); 4609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Pick a suitable name for a field of the given clazz. */ 4639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static String getDefaultFieldNameFor(Class<?> clazz) { 4649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return clazz.getSimpleName().substring(0, 1).toLowerCase() 4659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson + clazz.getSimpleName().substring(1); 4669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Clears out the expectations on these mocks. */ 4699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void reset(Object... mocks) { 4709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Object mock : mocks) { 4719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson getHandlerFrom(mock).reset(); 4729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Use this in tear down to check for programming errors. */ 476ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static void checkForProgrammingErrorsDuringTearDown() { 477ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoMatchers(); 478ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoUnfinishedCalls(sUnfinishedCallCounts, "verify()"); 479ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoUnfinishedCalls(sUnfinishedStubbingActions, "stubbing"); 480ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 481ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 482ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Helper function to check that there are no verify or stubbing commands outstanding. */ 483ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static void checkNoUnfinishedCalls(List<?> list, String type) { 484ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (!list.isEmpty()) { 485ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson list.clear(); 486ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Unfinished " + type + " statements"); 487ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 488ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 4899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Implementation of {@link Behaviour}. */ 4919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class BehaviourImpl implements Behaviour { 4929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Action mAction; 4939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private BehaviourImpl(Action action) { 4959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAction = action; 4969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 4999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public <T> T when(T mock) { 500ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson DefaultInvocationHandler handler = getHandlerFrom(mock); 501ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mHowManyTimes == null, "Unfinished verify() statements"); 50240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson checkState(handler.mOrderCounter == null, "Unfinished verify() statements"); 503ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mStubbingAction == null, "Unfinished stubbing statements"); 504ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson handler.mStubbingAction = mAction; 505ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedStubbingActions.add(mAction); 506ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return handler.<T>getStubbingMock(); 5079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The static list of argument matchers, used in the next method call to the mock. 5129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>In order to support the syntax like this: verify(mFoo).someMethod(anyInt()), it is 5149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * required that the anyInt() method store the value somewhere for use when the someMethod 5159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * is invoked. That somewhere has to be static. I don't like it any more than you do. 5169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>The same goes for anything that is passed into the someMethod as an argument - be it 5189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * a capture(mCaptureString) or eq(5) or whatever. 5199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Avoiding the use of statics requires that we change the syntax of the verify statement, 5219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * and I can't think of an elegant way of doing it, and in any case I really like the current 5229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * syntax, so for now a static variable it is. 5239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This match arguments list should contain either zero elements (the next method call will 5259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * not use any argument matchers) or it should contain exactly one argument matcher for 5269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * every argument being passed to the next method call. You can't mix argument matchers and 5279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * raw values. 5289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final List<ArgumentMatcher> sMatchArguments = new ArrayList<ArgumentMatcher>(); 5309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 53140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** Global invocation order of every mock method call. */ 53240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private static final AtomicLong sGlobalInvocationOrder = new AtomicLong(); 53340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 5349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Encapsulates a single call of a method with associated arguments. */ 5359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class MethodCall { 5369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The method call. */ 5379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Method mMethod; 5389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The arguments provided at the time the call happened. */ 5399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Object[] mArgs; 54040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** The order in which this method call was invoked. */ 54140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private final long mInvocationOrder; 5429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The line from the test that invoked the handler to create this method call. */ 5439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final StackTraceElement mElement; 5449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Keeps track of method calls that have been verified, for verifyNoMoreInteractions(). */ 5459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean mWasVerified = false; 5469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public MethodCall(Method method, StackTraceElement element, Object[] args) { 5489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mMethod = method; 5499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mElement = element; 5509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mArgs = args; 55140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson mInvocationOrder = sGlobalInvocationOrder.getAndIncrement(); 5529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean argsMatch(Object[] args) { 5559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return Arrays.equals(mArgs, args); 5569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 5599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 5609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "MethodCall [method=" + mMethod + ", args=" + Arrays.toString(mArgs) + "]"; 5619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 56425ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson private static boolean areMethodsSame(Method first, Method second) { 56525ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson return areEqual(first.getDeclaringClass(), second.getDeclaringClass()) && 56625ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson areEqual(first.getName(), second.getName()) && 56725ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson areEqual(first.getReturnType(), second.getReturnType()) && 56825ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson Arrays.equals(first.getParameterTypes(), second.getParameterTypes()); 56925ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } 57025ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson 57125ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson private static boolean areEqual(Object a, Object b) { 57225ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (a == null) { 57325ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson return b == null; 57425ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } 57525ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson return a.equals(b); 57625ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } 57725ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson 5789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Magically handles the invoking of method calls. 5809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This object is in one of three states, default (where invoking methods returns default 5829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * values and records the call), verifying (where invoking method calls makes sure that those 5839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * method calls happen with the supplied arguments or matchers) or stubbing (where the next method 5849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * call tells us which arguments to match in order to perform the desired behaviour). 5859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class DefaultInvocationHandler implements InvocationHandler { 5879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sEqualsMethod; 5889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sHashCodeMethod; 5899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sToStringMethod; 5909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 5929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson try { 5939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sEqualsMethod = Object.class.getMethod("equals", Object.class); 5949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sHashCodeMethod = Object.class.getMethod("hashCode"); 5959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sToStringMethod = Object.class.getMethod("toString"); 5969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } catch (SecurityException e) { 5979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Should never happen. 5989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new RuntimeException("Your JVM/classloader is broken", e); 5999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } catch (NoSuchMethodException e) { 6009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Should never happen. 6019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new RuntimeException("Your JVM/classloader is broken", e); 6029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The class of the mocked objects. */ 6069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Class<?> mClazz; 6079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The field name in which the mock is assigned. */ 6089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final String mFieldName; 6099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The list of method calls executed on the mock. */ 611ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private List<MethodCall> mRecordedCalls = new CopyOnWriteArrayList<MethodCall>(); 6129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The list of method calls that were stubbed out and their corresponding actions. */ 613ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private List<StubbedCall> mStubbedCalls = new CopyOnWriteArrayList<StubbedCall>(); 614ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 6159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 6169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The number of times a given call should be verified. 6179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 6189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is not null when in the verification state, and it is actually used to determine if we 6199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * are in the verification state. 6209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 6219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is reset to null once the verification has occurred. 6229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 6239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private CallCount mHowManyTimes = null; 62440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private OrderChecker mOrderCounter = null; 625ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 6269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 6279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The action to be associated with the stubbed method. 6289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 6299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is not null when in the stubbing state, and it is actually used to determine if we are 6309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * in the stubbing state. 6319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 6329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private Action mStubbingAction = null; 6339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 634ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Dynamic proxy used to verify calls against this mock. */ 635ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private final Object mVerifyingMock; 636ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 637ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Dynamic proxy used to stub calls against this mock. */ 638ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private final Object mStubbingMock; 639ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 6409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 6419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a new invocation handler for an object. 6429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 6439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param clazz the class the object belongs to 6449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param fieldName The name to be used to refer to the object. This may either be the name of 6459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * the field this mock will be stored into (in case it uses @Mock) or a suitable name to 6469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * use to refer to the object in error messages, based on the name of the class itself. 6479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 6489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public DefaultInvocationHandler(Class<?> clazz, String fieldName) { 6499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mClazz = clazz; 6509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mFieldName = fieldName; 651ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mVerifyingMock = createVerifyingMock(clazz); 652ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbingMock = createStubbingMock(clazz); 653ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 654ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 655ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // Safe if you call getHandlerFrom(mock).getVerifyingMock(), since this is guaranteed to be 656ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // of the same type as mock itself. 657ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 658ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public <T> T getVerifyingMock() { 659ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) mVerifyingMock; 660ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 661ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 662ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // Safe if you call getHandlerFrom(mock).getStubbingMock(), since this is guaranteed to be 663ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // of the same type as mock itself. 664ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 665ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public <T> T getStubbingMock() { 666ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) mStubbingMock; 667ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 668ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 669ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Used to check that we always stub and verify from the same thread. */ 670ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private AtomicReference<Thread> mCurrentThread = new AtomicReference<Thread>(); 671ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 672ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Check that we are stubbing and verifying always from the same thread. */ 673ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private void checkThread() { 674ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Thread currentThread = Thread.currentThread(); 675ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mCurrentThread.compareAndSet(null, currentThread); 676ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (mCurrentThread.get() != currentThread) { 677ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Must always mock and stub from one thread only. " 678ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson + "This thread: " + currentThread + ", the other thread: " + mCurrentThread.get()); 679ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 680ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 681ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 682ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Generate the dynamic proxy that will handle verify invocations. */ 683ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private Object createVerifyingMock(Class<?> clazz) { 684ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return createProxy(clazz, new InvocationHandler() { 685ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 686ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 687ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkThread(); 688ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson expect(mHowManyTimes != null, "verifying mock doesn't know how many times"); 689ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 690ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson ArgumentMatcher[] matchers = checkClearAndGetMatchers(method); 691ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 692ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 69340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson innerVerify(method, matchers, methodCall, proxy, callSite, mHowManyTimes, mOrderCounter); 694ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return defaultReturnValue(method.getReturnType()); 695ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } finally { 696ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedCallCounts.remove(mHowManyTimes); 697ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mHowManyTimes = null; 69840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson mOrderCounter = null; 699ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 700ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 701ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson }); 702ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 703ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 704ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Generate the dynamic proxy that will handle stubbing invocations. */ 705ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private Object createStubbingMock(Class<?> clazz) { 706ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return createProxy(clazz, new InvocationHandler() { 707ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 708ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 709ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkThread(); 710ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson expect(mStubbingAction != null, "stubbing mock doesn't know what action to perform"); 711ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 712ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson ArgumentMatcher[] matchers = checkClearAndGetMatchers(method); 713ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 714ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 715ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson innerStub(method, matchers, methodCall, callSite, mStubbingAction); 716ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return defaultReturnValue(method.getReturnType()); 717ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } finally { 718ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedStubbingActions.remove(mStubbingAction); 719ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbingAction = null; 720ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 721ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 722ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson }); 7239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 7269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 7279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 7289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 729ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return innerRecord(method, args, methodCall, proxy, callSite); 7309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 7339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Checks whether the given method is one of the special object methods that should not 7349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verified or stubbed. 7359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p> 7369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * If this is one of such methods, it throws an AssertionException. 7379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 7389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param method the method to be checked 7399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param operation the name of the operation, used for generating a helpful message 7409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 7419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void checkSpecialObjectMethods(Method method, String operation) { 74225ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(method, sEqualsMethod) 74325ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson || areMethodsSame(method, sHashCodeMethod) 74425ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson || areMethodsSame(method, sToStringMethod)) { 7459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson fail("cannot " + operation + " call to " + method); 7469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void reset() { 7509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mRecordedCalls.clear(); 7519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mStubbedCalls.clear(); 7529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mHowManyTimes = null; 75340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson mOrderCounter = null; 7549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mStubbingAction = null; 7559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private Object innerRecord(Method method, final Object[] args, 7589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall methodCall, Object proxy, StackTraceElement callSite) throws Throwable { 75925ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(method, sEqualsMethod)) { 7609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Use identify for equality, the default behavior on object. 7619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return proxy == args[0]; 76225ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } else if (areMethodsSame(method, sHashCodeMethod)) { 7639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This depends on the fact that each mock has its own DefaultInvocationHandler. 7649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return hashCode(); 76525ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson } else if (areMethodsSame(method, sToStringMethod)) { 7669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This is used to identify this is a mock, e.g., in error messages. 7679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "Mock<" + mClazz.getName() + ">"; 7689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mRecordedCalls.add(methodCall); 7709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (StubbedCall stubbedCall : mStubbedCalls) { 77125ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(stubbedCall.mMethodCall.mMethod, methodCall.mMethod)) { 7729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (stubbedCall.mMethodCall.argsMatch(methodCall.mArgs)) { 7739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson methodCall.mWasVerified = true; 7749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbedCall.mAction.doAction(method, args); 7759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If no stub is defined, return the default value. 7799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return defaultReturnValue(method.getReturnType()); 7809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void innerStub(Method method, final ArgumentMatcher[] matchers, MethodCall methodCall, 783ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite, final Action stubbingAction) { 7849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkSpecialObjectMethods(method, "stub"); 7859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkThisActionCanBeUsedForThisMethod(method, stubbingAction, callSite); 7869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers.length == 0) { 7879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If there are no matchers, then this is a simple stubbed method call with an action. 788ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbedCalls.add(0, new StubbedCall(methodCall, stubbingAction)); 7899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 7909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If there are matchers, then we need to make a new method call which matches only 7929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // when all the matchers match. Further, the action that method call needs to take 7939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // is to first record the values into any captures that may be present, and only then 7949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // proceed to execute the original action. 7959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall matchMatchersMethodCall = new MethodCall(method, callSite, matchers) { 7969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 7979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean argsMatch(Object[] args) { return doMatchersMatch(matchers, args); } 7989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }; 7999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Action setCapturesThenAction = new Action() { 8009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 8019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method innerMethod, Object[] innerArgs) throws Throwable { 8029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setCaptures(matchers, innerArgs); 8039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbingAction.doAction(innerMethod, innerArgs); 8049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 8069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType() { 8079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbingAction.getReturnType(); 8089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }; 810ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbedCalls.add(0, new StubbedCall(matchMatchersMethodCall, setCapturesThenAction)); 8119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void checkThisActionCanBeUsedForThisMethod(Method method, final Action stubbingAction, 8149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite) { 8159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Class<?> methodType = method.getReturnType(); 8169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Class<?> actionType = stubbingAction.getReturnType(); 8179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (actionType == null) { 8189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // We could not determine the type returned by this action at the time we 8199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // created it. At this time we cannot check that the returned value is 8209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // appropriate to the return type of the method. 8219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // However, if the type is not correct, any actual invocation of the method 8229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // will fail later on. 8239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 8249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!methodType.isAssignableFrom(actionType)) { 8269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (methodType.isPrimitive() && 8279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson actionType.equals(PRIMITIVE_TO_BOXED_LOOKUP.get(methodType))) { 8289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 8299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 8319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\nCan't return ").append(actionType.getSimpleName()).append(" from stub for:"); 8329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, method, callSite, mFieldName, true); 8339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n"); 8349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException(sb.toString()); 8359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private boolean doMatchersMatch(ArgumentMatcher[] matchers, Object[] args) { 8399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (int i = 0; i < matchers.length; ++i) { 8409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!matchers[i].matches(args[i])) { 8419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return false; 8429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return true; 8459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void innerVerify(Method method, ArgumentMatcher[] matchers, MethodCall methodCall, 84840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson Object proxy, StackTraceElement callSite, CallCount callCount, OrderChecker orderCounter) { 8499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkSpecialObjectMethods(method, "verify"); 85040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson List<MethodCall> calls = countMatchingInvocations(method, matchers, methodCall); 851ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson long callTimeout = callCount.getTimeout(); 85240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson checkState(orderCounter == null || callTimeout == 0, "can't inorder verify with a timeout"); 853ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (callTimeout > 0) { 854ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson long endTime = System.currentTimeMillis() + callTimeout; 85540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson while (!callCount.matches(calls.size())) { 856ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 857ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Thread.sleep(1); 858ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } catch (InterruptedException e) { 859ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson fail("interrupted whilst waiting to verify"); 860ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 861ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (System.currentTimeMillis() > endTime) { 86240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson fail(formatFailedVerifyMessage(methodCall, calls.size(), callTimeout, callCount)); 863ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 86440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson calls = countMatchingInvocations(method, matchers, methodCall); 865ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 866ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } else { 86740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson if (orderCounter != null) { 86840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson orderCounter.checkOrder(calls, mFieldName); 86940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } else if (!callCount.matches(calls.size())) { 87040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson fail(formatFailedVerifyMessage(methodCall, calls.size(), 0, callCount)); 871ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 872ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 873ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 874ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 87540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private List<MethodCall> countMatchingInvocations(Method method, ArgumentMatcher[] matchers, 876ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall) { 87740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson List<MethodCall> methodCalls = new ArrayList<MethodCall>(); 8789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall call : mRecordedCalls) { 87925ab6b601720d62298a39f1b8bbd1dc99c252725Hugo Hudson if (areMethodsSame(call.mMethod, method)) { 8809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if ((matchers.length > 0 && doMatchersMatch(matchers, call.mArgs)) || 8819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson call.argsMatch(methodCall.mArgs)) { 8829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setCaptures(matchers, call.mArgs); 88340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson methodCalls.add(call); 8849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson call.mWasVerified = true; 8859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 88840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return methodCalls; 8899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 891ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private String formatFailedVerifyMessage(MethodCall methodCall, int total, long timeoutMillis, 892ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson CallCount callCount) { 8939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 894ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append("\nExpected ").append(callCount); 895ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (timeoutMillis > 0) { 896ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append(" within " + timeoutMillis + "ms"); 897ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 898ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append(" to:"); 8999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, methodCall.mMethod, 9009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson methodCall.mElement, mFieldName, false); 9019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n\n"); 9029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (mRecordedCalls.size() == 0) { 903ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append("No method calls happened on this mock"); 9049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else { 9059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("Method calls that did happen:"); 9069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall recordedCall : mRecordedCalls) { 9079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, recordedCall.mMethod, 9089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson recordedCall.mElement, mFieldName, false); 9099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n"); 9129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return sb.toString(); 9139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** All matchers that are captures will store the corresponding arg value. */ 9169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This suppress warning means that I'm calling setValue with something that I can't promise 9179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // is of the right type. But I think it is unavoidable. Certainly I could give a better 9189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // error message than the class cast exception you'll get when you try to retrieve the value. 9199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @SuppressWarnings("unchecked") 9209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void setCaptures(ArgumentMatcher[] matchers, Object[] args) { 9219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (int i = 0; i < matchers.length; ++i) { 9229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers[i] instanceof ArgumentCaptorImpl) { 9239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson ArgumentCaptorImpl.class.cast(matchers[i]).setValue(args[i]); 9249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** An empty array of matchers, to optimise the toArray() call below. */ 9299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final ArgumentMatcher[] EMPTY_MATCHERS_ARRAY = new ArgumentMatcher[0]; 9309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Makes sure that we have the right number of MATCH_ARGUMENTS for the given method. */ 9329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private ArgumentMatcher[] checkClearAndGetMatchers(Method method) { 9339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson ArgumentMatcher[] matchers = sMatchArguments.toArray(EMPTY_MATCHERS_ARRAY); 9349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.clear(); 9359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers.length > 0 && method.getParameterTypes().length != matchers.length) { 9369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("You can't mix matchers and regular objects."); 9379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return matchers; 9399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void appendDebugStringForMethodCall(StringBuffer sb, Method method, 9439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite, String fieldName, boolean showReturnType) { 9449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n "); 9459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (showReturnType) { 9469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("(").append(method.getReturnType().getSimpleName()).append(") "); 9479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(fieldName).append(".").append(method.getName()).append("("); 9499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson int i = 0; 9509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Class<?> type : method.getParameterTypes()) { 9519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (++i > 1) { 9529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(", "); 9539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(type.getSimpleName()); 9559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(")\n at ").append(callSite); 9579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Call this function when you don't expect there to be any outstanding matcher objects. */ 9609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void checkNoMatchers() { 9619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (sMatchArguments.size() > 0) { 9629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.clear(); 9639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalStateException("You have outstanding matchers, must be programming error"); 9649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** A pairing of a method call and an action to be performed when that call happens. */ 9689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class StubbedCall { 9699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final MethodCall mMethodCall; 9709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Action mAction; 9719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public StubbedCall(MethodCall methodCall, Action action) { 9739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mMethodCall = methodCall; 9749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAction = action; 9759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 9789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 9799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "StubbedCall [methodCall=" + mMethodCall + ", action=" + mAction + "]"; 9809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Represents an action to be performed as a result of a method call. */ 9849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private interface Action { 9859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method method, Object[] arguments) throws Throwable; 9869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The type of the action, or null if we can't determine the type at stub time. */ 9879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType(); 9889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Represents something capable of testing if it matches an argument or not. */ 9912a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson public interface ArgumentMatcher { 9929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value); 9939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** A matcher that matches any argument. */ 9969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class MatchAnything implements ArgumentMatcher { 9979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 9989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { return true; } 9999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Encapsulates the number of times a method is called, between upper and lower bounds. */ 10029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class CallCount { 1003ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mLowerBound; 1004ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mUpperBound; 10059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1006ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount(long lowerBound, long upperBound) { 10079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mLowerBound = lowerBound; 10089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mUpperBound = upperBound; 10099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Tells us if this call count matches a desired count. */ 10129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(long total) { 10139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return total >= mLowerBound && total <= mUpperBound; 10149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1016ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Tells us how long we should block waiting for the verify to happen. */ 1017ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public long getTimeout() { 1018ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return 0; 1019ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1020ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1021ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount setLowerBound(long lowerBound) { 1022ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mLowerBound = lowerBound; 1023ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return this; 1024ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1025ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1026ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount setUpperBound(long upperBound) { 1027ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mUpperBound = upperBound; 1028ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return this; 1029ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1030ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 10319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 10329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 10339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (mLowerBound == mUpperBound) { 10349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "exactly " + mLowerBound + plural(" call", mLowerBound); 10359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else { 10369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "between " + mLowerBound + plural(" call", mLowerBound) + " and " + 10379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mUpperBound + plural(" call", mUpperBound); 10389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1042ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Encapsulates adding number of times behaviour to a call count with timeout. */ 1043ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static final class Timeout extends CallCount { 1044ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mTimeoutMillis; 1045ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1046ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Timeout(long lowerBound, long upperBound, long timeoutMillis) { 1047ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson super(lowerBound, upperBound); 1048ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mTimeoutMillis = timeoutMillis; 1049ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1050ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1051ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 1052ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public long getTimeout() { 1053ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return mTimeoutMillis; 1054ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1055ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1056ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount times(int times) { return setLowerBound(times).setUpperBound(times); } 1057ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount atLeast(long n) { return setLowerBound(n).setUpperBound(Long.MAX_VALUE); } 1058ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount atLeastOnce() { return setLowerBound(1).setUpperBound(Long.MAX_VALUE); } 1059ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount between(long n, long m) { return setLowerBound(n).setUpperBound(m); } 1060ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1061ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 10629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Helper method to add an 's' to a string iff the count is not 1. */ 10639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static String plural(String prefix, long count) { 10649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return (count == 1) ? prefix : (prefix + "s"); 10659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Helps us implement the eq(), any() and capture() and other methods on one line. */ 10689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static <T> T addMatcher(ArgumentMatcher argument, T value) { 10699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.add(argument); 10709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return value; 10719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10732a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson /** A custom argument matcher, should be used only for object arguments not primitives. */ 10742a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson public static <T> T matches(ArgumentMatcher argument) { 10752a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson sMatchArguments.add(argument); 10762a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson return null; 10772a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson } 10782a267dd8513e727846c03395429f69e4ab17f1c6Hugo Hudson 10799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Utility method to throw an AssertionError if an assertion fails. */ 10809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void expect(boolean result, String message) { 10819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!result) { 10829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson fail(message); 10839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Throws an AssertionError exception with a message. */ 10879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void fail(String message) { 10889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new AssertionError(message); 10899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Static mapping from class type to default value for that type. */ 10929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final Map<Class<?>, Object> DEFAULT_RETURN_VALUE_LOOKUP; 10939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 10949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP = new HashMap<Class<?>, Object>(); 10959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(int.class, 0); 10969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(boolean.class, false); 10979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(byte.class, (byte) 0); 10989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(long.class, (long) 0); 10999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(short.class, (short) 0); 11009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(float.class, (float) 0); 11019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(double.class, (double) 0); 11029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(char.class, '\u0000'); 11039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(String.class, null); 11049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 11059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 11069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Static lookup from primitive types to their boxed versions. */ 11079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final Map<Class<?>, Class<?>> PRIMITIVE_TO_BOXED_LOOKUP; 11089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 11099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP = new HashMap<Class<?>, Class<?>>(); 11109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(int.class, Integer.class); 11119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(boolean.class, Boolean.class); 11129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(byte.class, Byte.class); 11139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(long.class, Long.class); 11149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(short.class, Short.class); 11159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(float.class, Float.class); 11169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(double.class, Double.class); 11179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(char.class, Character.class); 11189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 11199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 11209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** For a given class type, returns the default value for that type. */ 11219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Object defaultReturnValue(Class<?> returnType) { 11229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return DEFAULT_RETURN_VALUE_LOOKUP.get(returnType); 11239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 11249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 11259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Gets a suitable class loader for use with the proxy. */ 11269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static ClassLoader getClassLoader() { 11279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.class.getClassLoader(); 11289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 11299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 11309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Sets a member field on an object via reflection (can set private members too). */ 11319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void setField(Field field, Object object, Object value) throws Exception { 11329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.setAccessible(true); 11339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.set(object, value); 11349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.setAccessible(false); 11359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1136ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1137ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Helper method to throw an IllegalStateException if given condition is not met. */ 1138ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static void checkState(boolean condition, String message) { 1139ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (!condition) { 1140ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException(message); 1141ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1142ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1143ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 11444541568ab5ac306c7dc2b648f7908610868180deHugo Hudson /** Helper method to throw an IllegalStateException if given condition is not met. */ 11454541568ab5ac306c7dc2b648f7908610868180deHugo Hudson private static void checkState(boolean condition) { 11464541568ab5ac306c7dc2b648f7908610868180deHugo Hudson if (!condition) { 11474541568ab5ac306c7dc2b648f7908610868180deHugo Hudson throw new IllegalStateException(); 11484541568ab5ac306c7dc2b648f7908610868180deHugo Hudson } 11494541568ab5ac306c7dc2b648f7908610868180deHugo Hudson } 11504541568ab5ac306c7dc2b648f7908610868180deHugo Hudson 1151ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson /** 1152ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson * If the input object is one of our mocks, returns the {@link DefaultInvocationHandler} 1153ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson * we constructed it with. Otherwise fails with {@link IllegalArgumentException}. 1154ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson */ 1155ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson private static DefaultInvocationHandler getHandlerFrom(Object mock) { 1156ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson try { 1157ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson InvocationHandler invocationHandler = Proxy.getInvocationHandler(mock); 1158ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson if (invocationHandler instanceof DefaultInvocationHandler) { 1159ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson return (DefaultInvocationHandler) invocationHandler; 1160ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1161ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } catch (IllegalArgumentException expectedIfNotAProxy) {} 1162ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson try { 1163ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Class<?> proxyBuilder = Class.forName("com.google.dexmaker.stock.ProxyBuilder"); 1164ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Method getHandlerMethod = proxyBuilder.getMethod("getInvocationHandler", Object.class); 1165ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Object invocationHandler = getHandlerMethod.invoke(proxyBuilder, mock); 1166ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson if (invocationHandler instanceof DefaultInvocationHandler) { 1167ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson return (DefaultInvocationHandler) invocationHandler; 1168ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1169ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } catch (Exception expectedIfNotAProxyBuilderMock) {} 11704541568ab5ac306c7dc2b648f7908610868180deHugo Hudson try { 11714541568ab5ac306c7dc2b648f7908610868180deHugo Hudson // Try with javassist. 11724541568ab5ac306c7dc2b648f7908610868180deHugo Hudson Class<?> proxyObjectClass = Class.forName("javassist.util.proxy.ProxyObject"); 11734541568ab5ac306c7dc2b648f7908610868180deHugo Hudson Method getHandlerMethod = proxyObjectClass.getMethod("getHandler"); 11744541568ab5ac306c7dc2b648f7908610868180deHugo Hudson Object methodHandler = getHandlerMethod.invoke(mock); 11754541568ab5ac306c7dc2b648f7908610868180deHugo Hudson InvocationHandler invocationHandler = Proxy.getInvocationHandler(methodHandler); 11764541568ab5ac306c7dc2b648f7908610868180deHugo Hudson Method getOriginalMethod = invocationHandler.getClass().getMethod("$$getOriginal"); 11774541568ab5ac306c7dc2b648f7908610868180deHugo Hudson Object original = getOriginalMethod.invoke(invocationHandler); 11784541568ab5ac306c7dc2b648f7908610868180deHugo Hudson if (original instanceof DefaultInvocationHandler) { 11794541568ab5ac306c7dc2b648f7908610868180deHugo Hudson return (DefaultInvocationHandler) original; 11804541568ab5ac306c7dc2b648f7908610868180deHugo Hudson } 11814541568ab5ac306c7dc2b648f7908610868180deHugo Hudson } catch (Exception expectedIfNotJavassistProxy) {} 1182ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson throw new IllegalArgumentException("not a valid mock: " + mock); 1183ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1184ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson 1185e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson private static boolean canUseJavassist() { 1186e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson try { 1187e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Class.forName("javassist.util.proxy.ProxyFactory"); 1188e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return true; 1189e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } catch (Exception expectedIfNotJavassistProxy) { 1190e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return false; 1191e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1192e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1193e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson 1194ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Create a dynamic proxy for the given class, delegating to the given invocation handler. */ 11954541568ab5ac306c7dc2b648f7908610868180deHugo Hudson private static Object createProxy(Class<?> clazz, final InvocationHandler handler) { 11964541568ab5ac306c7dc2b648f7908610868180deHugo Hudson // Interfaces are simple. Just proxy them using java.lang.reflect.Proxy. 1197ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (clazz.isInterface()) { 1198ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return Proxy.newProxyInstance(getClassLoader(), new Class<?>[] { clazz }, handler); 1199ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 12004541568ab5ac306c7dc2b648f7908610868180deHugo Hudson // Try with javassist. 1201e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson if (canUseJavassist()) { 1202e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson try { 1203e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Class<?> proxyFactoryClass = Class.forName("javassist.util.proxy.ProxyFactory"); 1204e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Object proxyFactory = proxyFactoryClass.newInstance(); 1205e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Method setSuperclassMethod = proxyFactoryClass.getMethod("setSuperclass", Class.class); 1206e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson setSuperclassMethod.invoke(proxyFactory, clazz); 1207e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Class<?> methodFilterClass = Class.forName("javassist.util.proxy.MethodFilter"); 1208e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson InvocationHandler methodFilterHandler = new InvocationHandler() { 1209e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson @Override 1210e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 1211e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson checkState(method.getName().equals("isHandled")); 1212e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson checkState(args.length == 1); 1213e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson checkState(args[0] instanceof Method); 1214e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Method invokedMethod = (Method) args[0]; 1215e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson String methodName = invokedMethod.getName(); 1216e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Class<?>[] params = invokedMethod.getParameterTypes(); 1217e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson if ("equals".equals(methodName) && params.length == 1 1218e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson && Object.class.equals(params[0])) { 1219e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return false; 1220e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1221e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson if ("hashCode".equals(methodName) && params.length == 0) { 1222e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return false; 1223e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1224e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson if ("toString".equals(methodName) && params.length == 0) { 1225e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return false; 1226e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1227e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson if ("finalize".equals(methodName) && params.length == 0) { 1228e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return false; 1229e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1230e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return true; 1231e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1232e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson }; 1233e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Object methodFilter = Proxy.newProxyInstance(getClassLoader(), 1234e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson new Class<?>[] { methodFilterClass }, methodFilterHandler); 1235e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Method setFilterMethod = proxyFactoryClass.getMethod("setFilter", methodFilterClass); 1236e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson setFilterMethod.invoke(proxyFactory, methodFilter); 1237e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Method createClassMethod = proxyFactoryClass.getMethod("createClass"); 1238e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Class<?> createdClass = (Class<?>) createClassMethod.invoke(proxyFactory); 1239e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson InvocationHandler methodHandlerHandler = new InvocationHandler() { 1240e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson @SuppressWarnings("unused") 1241e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson public InvocationHandler $$getOriginal() { 1242e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return handler; 1243e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1244e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson @Override 1245e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 1246e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson checkState(method.getName().equals("invoke")); 1247e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson checkState(args.length == 4); 1248e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson checkState(args[1] instanceof Method); 1249e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Method invokedMethod = (Method) args[1]; 1250e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson checkState(args[3] instanceof Object[]); 1251e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return handler.invoke(args[0], invokedMethod, (Object[]) args[3]); 1252e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } 1253e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson }; 1254e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Class<?> methodHandlerClass = Class.forName("javassist.util.proxy.MethodHandler"); 1255e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Object methodHandler = Proxy.newProxyInstance(getClassLoader(), 1256e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson new Class<?>[] { methodHandlerClass }, methodHandlerHandler); 1257e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Object proxy = unsafeCreateInstance(createdClass); 1258e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Class<?> proxyObjectClass = Class.forName("javassist.util.proxy.ProxyObject"); 1259e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson Method setHandlerMethod = proxyObjectClass.getMethod("setHandler", methodHandlerClass); 1260e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson setHandlerMethod.invoke(proxy, methodHandler); 1261e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson return proxy; 1262e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson } catch (Exception e) { 1263e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson // Not supported, something went wrong. Fall through, try android dexmaker. 1264e3f71eadc205f4346f6a97b44820df40490f5c4bHugo Hudson e.printStackTrace(System.err); 12654541568ab5ac306c7dc2b648f7908610868180deHugo Hudson } 12664541568ab5ac306c7dc2b648f7908610868180deHugo Hudson } 12674541568ab5ac306c7dc2b648f7908610868180deHugo Hudson // So, this is a class. First try using Android's ProxyBuilder from dexmaker. 1268ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 1269ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Class<?> proxyBuilder = Class.forName("com.google.dexmaker.stock.ProxyBuilder"); 1270ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Method forClassMethod = proxyBuilder.getMethod("forClass", Class.class); 1271ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Object builder = forClassMethod.invoke(null, clazz); 1272ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Method dexCacheMethod = builder.getClass().getMethod("dexCache", File.class); 1273ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson File directory = AppDataDirGuesser.getsInstance().guessSuitableDirectoryForGeneratedClasses(); 1274ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson builder = dexCacheMethod.invoke(builder, directory); 12755307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Method buildClassMethod = builder.getClass().getMethod("buildProxyClass"); 12765307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Class<?> resultClass = (Class<?>) buildClassMethod.invoke(builder); 12775307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Object proxy = unsafeCreateInstance(resultClass); 12785307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Field handlerField = resultClass.getDeclaredField("$__handler"); 12795307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson handlerField.setAccessible(true); 12805307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson handlerField.set(proxy, handler); 12815307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return proxy; 1282ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } catch (Exception e) { 1283ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Could not mock this concrete class", e); 1284ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1285ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 12865307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson 12875307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson /** Attempt to construct an instance of the class using hacky methods to avoid calling super. */ 12885307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson @SuppressWarnings("unchecked") 12895307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson private static <T> T unsafeCreateInstance(Class<T> clazz) { 12904541568ab5ac306c7dc2b648f7908610868180deHugo Hudson // try jvm 12914541568ab5ac306c7dc2b648f7908610868180deHugo Hudson try { 12924541568ab5ac306c7dc2b648f7908610868180deHugo Hudson Class<?> unsafeClass = Class.forName("sun.misc.Unsafe"); 12934541568ab5ac306c7dc2b648f7908610868180deHugo Hudson Field f = unsafeClass.getDeclaredField("theUnsafe"); 12944541568ab5ac306c7dc2b648f7908610868180deHugo Hudson f.setAccessible(true); 12954541568ab5ac306c7dc2b648f7908610868180deHugo Hudson final Object unsafe = f.get(null); 12964541568ab5ac306c7dc2b648f7908610868180deHugo Hudson final Method allocateInstance = unsafeClass.getMethod("allocateInstance", Class.class); 12974541568ab5ac306c7dc2b648f7908610868180deHugo Hudson return (T) allocateInstance.invoke(unsafe, clazz); 12984541568ab5ac306c7dc2b648f7908610868180deHugo Hudson } catch (Exception ignored) {} 12995307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson // try dalvikvm, pre-gingerbread 13005307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson try { 13015307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final Method newInstance = ObjectInputStream.class.getDeclaredMethod( 13025307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "newInstance", Class.class, Class.class); 13035307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson newInstance.setAccessible(true); 13045307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return (T) newInstance.invoke(null, clazz, Object.class); 13055307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } catch (Exception ignored) {} 13065307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson // try dalvikvm, post-gingerbread 13075307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson try { 13085307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Method getConstructorId = ObjectStreamClass.class.getDeclaredMethod( 13095307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "getConstructorId", Class.class); 13105307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson getConstructorId.setAccessible(true); 13115307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final int constructorId = (Integer) getConstructorId.invoke(null, Object.class); 13125307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final Method newInstance = ObjectStreamClass.class.getDeclaredMethod( 13135307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "newInstance", Class.class, int.class); 13145307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson newInstance.setAccessible(true); 13155307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return (T) newInstance.invoke(null, clazz, constructorId); 13165307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } catch (Exception ignored) {} 1317328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson // try dalvikvm, with change https://android-review.googlesource.com/#/c/52331/ 1318328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson try { 1319328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson Method getConstructorId = ObjectStreamClass.class 1320328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson .getDeclaredMethod("getConstructorId", Class.class); 1321328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson getConstructorId.setAccessible(true); 1322328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson final long constructorId = (Long) getConstructorId.invoke(null, Object.class); 1323328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson final Method newInstance = ObjectStreamClass.class 1324328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson .getDeclaredMethod("newInstance", Class.class, long.class); 1325328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson newInstance.setAccessible(true); 1326328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson return (T) newInstance.invoke(null, clazz, constructorId); 1327328b01eada8965cd38feea884d4080c31e3763b0Ian Parkinson } catch (Exception ignored) {} 13285307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson throw new IllegalStateException("unsafe create instance failed"); 13295307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } 133040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 133140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** See {@link LittleMock#inOrder(Object[])}. */ 133240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson public interface InOrder { 133340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson <T> T verify(T mock); 133440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 133540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson 133640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson /** 133740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * Used to verify that invocations happen in a given order. 133840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * <p> 133940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * Still slight experimental at the moment: you can only verify one method call at a time, 134040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * and we ignore the mocks array you pass in as an argument, you may use the returned inorder 134140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * to verify all mocks. 134240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * <p> 134340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * This implementation is simple: the InOrder you get from this call can be used to verify that 134440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * a sequence of method calls happened in the order you specify. Every verify you make with 134540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * this InOrder will be compared with every other verify you made, to make sure that all the 134640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson * original invocations happened in exactly that same order. 134740d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson */ 134840d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson public static InOrder inOrder(Object... mocks) { 134940d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return new InOrder() { 135040d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson private final OrderChecker mChecker = new OrderChecker(); 135140d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson @Override 135240d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson public <T> T verify(T mock) { 135340d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson return LittleMock.verify(mock, times(1), mChecker); 135440d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 135540d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson }; 135640d40a3f2ebf988f36b828157be56cc12c9c70acHugo Hudson } 13579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson} 1358