LittleMock.java revision 5307b6d112c825e70dc30aea1c878f4e965127e2
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; 33ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudsonimport java.util.concurrent.atomic.AtomicReference; 349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson/** 369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Very lightweight and simple mocking framework, inspired by Mockito, http://mockito.org. 379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 38ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * <p>It supports only a <b>small subset</b> of the APIs provided by Mockito and other mocking 39ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * frameworks. 409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 41ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * <p>This project was originally designed to be lightweight and suitable for platforms that don't 42ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * support dynamic class generation, for example Android. Since the release of the open 43ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * source dexmaker project http://code.google.com/p/dexmaker/ we can now mock concrete classes 44ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * too. 459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Here is an example of how to use the framework. 479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Suppose that we have this interface: 499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <pre> 509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * public interface Foo { 519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * public String aString(int input); 529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * public void doSomething(); 539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * } 549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </pre> 559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Then stubbing out mocks works as follows: 579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <pre> 589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Foo mockFoo = mock(Foo.class); // Create the mock. 599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * doReturn("hello").when(mockFoo).aString(anyInt()); // Stub the mock to return "hello". 609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * doThrow(new IOException("oh noes")).when(mockFoo).doSomething(); 619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * assertEquals("hello", mockFoo.aString(5)); // Use the mock - performs as expected. 629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * mockFoo.doSomething(); // This will throw an IOException. 639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </pre> 649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>You can verify in the 'natural place', after the method call has happened, like this: 669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <pre> 679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Foo mockFoo = mock(Foo.class); 689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * assertEquals(null, mockFoo.aString(6)); // Unstubbed method calls return a sensible default. 699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verify(mockFoo).aString(6); // This will pass, aString() was called once. 709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verify(mockFoo, never()).doSomething(); // This will pass, doSomething was never called. 719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verify(mockFoo, times(3)).aString(anyInt()); // This will fail, was called once only. 729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </pre> 739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>The documentation is still incomplete. You can look at the {@link LittleMockTest} class and 759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * its unit tests - since they tell you exactly what operations are supported and how to use them. 769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>The reasons I much prefer Mockito's approach to the one of EasyMock are as follows: 789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <ul> 799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>No need to remember to put your mocks in replay mode.</li> 809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>No need to remember to call verify, a dangerous source of false-positive tests or 819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * alternatively over-specified tests.</li> 829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>Much less over-specification: only verify what you actually care about.</li> 839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>Which in turn leads to better separated tests, each test verifying only a part of the 849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * desired behaviour.</li> 859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>Which also leads to less fragile tests, where adding another method call on your 869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * dependencies doesn't break unrelated tests.</li> 87ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * <li>Simpler sharing of common setup method with specific tests overridding individual 88ba73a086722c0eb6dd33e4de0764ae1f45d8d895Hugo Hudson * behavious however they want to, only the most recent stubbed call is the one that counts.</li> 899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>More natural order for tests: set up stubs, execute tests, verify that it worked.</li> 909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <li>More unified syntax that doesn't require special case for differences between void method 919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * calls and method calls that return a value.</li> 929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * </ul> 939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>There were enough reasons that I wanted to give Mockito a try. It didn't work on Android 959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * because of issues with class generation. So I looked at the documentation and examples page and 969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * added tests for all the examples, and then implemented the this framework. I should stress that 979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * this is a clean-room implementation, and as such it's possible that there are a couple of methods 989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * that don't work in the same way as Mockito's implementation. Where that is the case I think we 999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * should fix once we discover them. There is also some functionality missing, but it will be added 1009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * in due course. 1019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 1029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Over time, the API has diverged slightly from the one of Mockito, as I have added APIs that I 1039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * found convenient but that did not have an equivalent in Mockite itself. For anything that has an 1049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * equivalent in Mockito I tried to keep the same name and syntax, to make it easier to transition 1059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * between using one framework to using the other, e.g., when developing both an Android application 1069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * using this framework and a desktop application using Mockito. 1079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 1089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @author hugohudson@gmail.com (Hugo Hudson) 1099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 1109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson/*@NotThreadSafe*/ 1119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudsonpublic class LittleMock { 1129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates a {@link Behaviour} suitable for void methods. */ 1139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static Behaviour doNothing() { return doReturn(null); } 1149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates a {@link Behaviour} that returns the given result. */ 1169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> Behaviour doReturn(final T result) { 1179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new BehaviourImpl(new Action() { 1189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override public T doAction(Method method, Object[] args) { return result; } 1199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override public Class<?> getReturnType() { 1209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return (result == null) ? null : result.getClass(); 1219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }); 1239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 1269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Gets a {@link Behaviour} that will execute the given {@link Callable} and return its result. 1279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 1289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> Behaviour doAnswer(final Callable<T> callable) { 1299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new BehaviourImpl(new Action() { 1309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T doAction(Method method, Object[] args) throws Throwable { return callable.call(); } 1329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType() { return null; } 1349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }); 1359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Returns a {@link Behaviour} that throws the given {@link Throwable}. */ 1389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T extends Throwable> Behaviour doThrow(final T exception) { 1399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new BehaviourImpl(new Action() { 1409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method method, Object[] args) throws Throwable { throw exception; } 1429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 1439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType() { return null; } 1449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }); 1459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Begins a verification step on a mock: the next method invocation on that mock will verify. */ 1489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T verify(T mock, CallCount howManyTimes) { 1499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (howManyTimes == null) { 1509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("Can't pass null for howManyTimes parameter"); 1519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 152ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson DefaultInvocationHandler handler = getHandlerFrom(mock); 153ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mHowManyTimes == null, "Unfinished verify() statements"); 154ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mStubbingAction == null, "Unfinished stubbing statements"); 1559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkNoMatchers(); 156ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson handler.mHowManyTimes = howManyTimes; 157ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedCallCounts.add(howManyTimes); 158ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return handler.<T>getVerifyingMock(); 1599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 161ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** The list of outstanding calls to verify() that haven't finished, used to check for errors. */ 162ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static List<CallCount> sUnfinishedCallCounts = new ArrayList<CallCount>(); 163ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 164ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** The list of outstanding calls to when() that haven't finished, used to check for errors. */ 165ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static List<Action> sUnfinishedStubbingActions = new ArrayList<Action>(); 166ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Begins a verification step for exactly one method call. */ 1689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T verify(T mock) { return verify(mock, times(1)); } 1699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Assert that no method calls at all happened on these mocks. */ 1719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void verifyZeroInteractions(Object... mocks) { 1729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkNoMatchers(); 1739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Object mock : mocks) { 174ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson List<MethodCall> mMethodCalls = getHandlerFrom(mock).mRecordedCalls; 1759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson expect(mMethodCalls.isEmpty(), "Mock expected zero interactions, had " + mMethodCalls); 1769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Assert that there are no unverified method calls on these mocks. */ 1809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void verifyNoMoreInteractions(Object... mocks) { 1819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[1]; 1829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Object mock : mocks) { 1839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson verifyNoMoreInteractions(mock, callSite); 1849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 1879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Check that there are no unverified actions on the given mock. */ 1889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void verifyNoMoreInteractions(Object mock, StackTraceElement callSite) { 1899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkNoMatchers(); 1909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DefaultInvocationHandler handlerFrom = getHandlerFrom(mock); 1919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson List<MethodCall> unverifiedCalls = new ArrayList<MethodCall>(); 1929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall method : handlerFrom.mRecordedCalls) { 1939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!method.mWasVerified) { 1949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson unverifiedCalls.add(method); 1959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (unverifiedCalls.size() > 0) { 1989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 1999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\nWe found these unverified calls:"); 2009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall method : unverifiedCalls) { 2019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, method.mMethod, 2029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson method.mElement, handlerFrom.mFieldName, false); 2039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n\nAfter final interaction was verified:\n"); 2059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(" at ").append(callSite).append("\n"); 2069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new AssertionError(sb.toString()); 2079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches exactly the given number of calls. */ 2119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount times(long n) { return new CallCount(n, n); } 2129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 213ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Claims that the verified call must happen before the given timeout. */ 214ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static Timeout timeout(long timeoutMillis) { 215ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return new Timeout(1, 1, timeoutMillis); 216ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 217ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 218ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson/** Creates a {@link CallCount} that only matches if the method was never called. */ 2199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount never() { return new CallCount(0, 0); } 2209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches at least one method call. */ 2229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount atLeastOnce() { return new CallCount(1, Long.MAX_VALUE); } 2239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches any number of method calls, including none at all. */ 2259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount anyTimes() { return new CallCount(0, Long.MAX_VALUE); } 2269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches at least the given number of calls. */ 2289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount atLeast(long n) { return new CallCount(n, Long.MAX_VALUE); } 2299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches up to the given number of calls but no more. */ 2319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount atMost(long n) { return new CallCount(0, n); } 2329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a {@link CallCount} that matches any number of calls between the two given bounds. */ 2349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static CallCount between(long lower, long upper) { return new CallCount(lower, upper); } 2359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 2379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates an argument matcher that matches any object, don't use for primitives. 2389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p> 2399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <b>Note</b>: This does not enforce that the object is of type {@code T}; use 2409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * {@link #isA(Class)} to do that. 2419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 2429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T anyObject() { return LittleMock.<T>addMatcher(new MatchAnything(), null); } 2439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any string. */ 2459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static String anyString() { return isA(String.class); } 2469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any int. */ 2489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static int anyInt() { return addMatcher(new MatchAnything(), 0); } 2499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any float. */ 2519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static float anyFloat() { return addMatcher(new MatchAnything(), 0f); } 2529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any double. */ 2549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static double anyDouble() { return addMatcher(new MatchAnything(), 0.0); } 2559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any boolean. */ 2579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static boolean anyBoolean() { return addMatcher(new MatchAnything(), false); } 2589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any short. */ 2609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static short anyShort() { return addMatcher(new MatchAnything(), (short) 0); } 2619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any char. */ 2639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static char anyChar() { return addMatcher(new MatchAnything(), '\u0000'); } 2649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any long. */ 2669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static long anyLong() { return addMatcher(new MatchAnything(), 0L); } 2679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches any byte. */ 2699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static byte anyByte() { return addMatcher(new MatchAnything(), (byte) 0); } 2709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Generates an argument matcher that matches exactly this value. */ 2729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T eq(final T expected) { 2739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return addMatcher(new ArgumentMatcher() { 2749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 2759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { 2769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return (expected == null) ? (value == null) : expected.equals(value); 2779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }, expected); 2799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** An argument matcher that matches any value of the given type or a subtype thereof. */ 2829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T isA(final Class<T> clazz) { 2839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.<T>addMatcher(new ArgumentMatcher() { 2849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 2859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { 2869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return value == null || clazz.isAssignableFrom(value.getClass()); 2879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }, null); 2899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 2909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 2919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 2929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Injects fields annotated with {@link Mock} with a newly created mock, and those 2939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * annotated with {@link Captor} with a suitable capture object. 2949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 2959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This operation is recursive, and travels up the class hierarchy, in order to set all 2969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * suitably annotated fields. 2979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 2989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void initMocks(Object instance) throws Exception { 2999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson injectMocksForClass(instance, instance.getClass()); 3009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Recurse up the class hierarchy injecting mocks as we go, stopping when we reach Object. */ 3039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void injectMocksForClass(Object instance, Class<?> clazz) 3049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throws Exception { 3059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (clazz.equals(Object.class)) { 3069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 3079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Field field : clazz.getDeclaredFields()) { 3099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (field.getAnnotation(Mock.class) != null) { 3109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setField(field, instance, mock(field.getType(), field.getName())); 3119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else if (field.getAnnotation(Captor.class) != null) { 3129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setField(field, instance, createCaptor()); 3139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson injectMocksForClass(instance, clazz.getSuperclass()); 3169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 3199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a correctly typed {@link ArgumentCaptor} , it's easier to use 3209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * {@link #initMocks(Object)}. 3219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 3229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> ArgumentCaptor<T> createCaptor() { 3239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return new ArgumentCaptorImpl<T>(); 3249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Implementation of the {@link ArgumentCaptor} interface. */ 3279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class ArgumentCaptorImpl<T extends Object> implements ArgumentCaptor<T> { 3289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final ArrayList<T> mAllValues = new ArrayList<T>(); 3299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private T mValue; 3309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private ArgumentCaptorImpl() { 3329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public void setValue(T value) { 3359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mValue = value; 3369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAllValues.add(mValue); 3379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T getValue() { 3419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mValue; 3429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public List<T> getAllValues() { 3469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mAllValues; 3479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public T capture() { 3519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.<T>addMatcher(this, null); 3529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 3559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { 3569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // A capture always matches any argument. 3579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This is so that verify(mMock).someMethod(capture(mCapture)) will match any and all calls 3589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // to someMethod() and we will capture the values into mCapture. 3599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return true; 3609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 3649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a mock, more easily done via the {@link #initMocks(Object)} method. 3659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 3669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Also if you use this method to create your mock, the field in the error messages will 3679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * be named the same as your class passed in, you only get the actual field name if you 3689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * use the annotation. 3699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 3709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @throws IllegalArgumentException if the class you pass in is null 3719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 3729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static <T> T mock(Class<T> clazz) { 3739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (clazz == null) { 3749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("Class to mock was null"); 3759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return mock(clazz, getDefaultFieldNameFor(clazz)); 3779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Creates a mock, more easily done via the {@link #initMocks(Object)} method. */ 380ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 3819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static <T> T mock(Class<T> clazz, String fieldName) { 382ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) createProxy(clazz, new DefaultInvocationHandler(clazz, fieldName)); 3839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Pick a suitable name for a field of the given clazz. */ 3869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static String getDefaultFieldNameFor(Class<?> clazz) { 3879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return clazz.getSimpleName().substring(0, 1).toLowerCase() 3889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson + clazz.getSimpleName().substring(1); 3899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Clears out the expectations on these mocks. */ 3929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public static void reset(Object... mocks) { 3939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Object mock : mocks) { 3949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson getHandlerFrom(mock).reset(); 3959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 3979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 3989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Use this in tear down to check for programming errors. */ 399ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static void checkForProgrammingErrorsDuringTearDown() { 400ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoMatchers(); 401ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoUnfinishedCalls(sUnfinishedCallCounts, "verify()"); 402ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkNoUnfinishedCalls(sUnfinishedStubbingActions, "stubbing"); 403ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 404ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 405ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Helper function to check that there are no verify or stubbing commands outstanding. */ 406ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static void checkNoUnfinishedCalls(List<?> list, String type) { 407ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (!list.isEmpty()) { 408ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson list.clear(); 409ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Unfinished " + type + " statements"); 410ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 411ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 4129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Implementation of {@link Behaviour}. */ 4149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class BehaviourImpl implements Behaviour { 4159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Action mAction; 4169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private BehaviourImpl(Action action) { 4189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAction = action; 4199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 4229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public <T> T when(T mock) { 423ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson DefaultInvocationHandler handler = getHandlerFrom(mock); 424ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mHowManyTimes == null, "Unfinished verify() statements"); 425ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkState(handler.mStubbingAction == null, "Unfinished stubbing statements"); 426ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson handler.mStubbingAction = mAction; 427ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedStubbingActions.add(mAction); 428ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return handler.<T>getStubbingMock(); 4299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 4339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The static list of argument matchers, used in the next method call to the mock. 4349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>In order to support the syntax like this: verify(mFoo).someMethod(anyInt()), it is 4369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * required that the anyInt() method store the value somewhere for use when the someMethod 4379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * is invoked. That somewhere has to be static. I don't like it any more than you do. 4389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>The same goes for anything that is passed into the someMethod as an argument - be it 4409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * a capture(mCaptureString) or eq(5) or whatever. 4419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>Avoiding the use of statics requires that we change the syntax of the verify statement, 4439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * and I can't think of an elegant way of doing it, and in any case I really like the current 4449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * syntax, so for now a static variable it is. 4459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This match arguments list should contain either zero elements (the next method call will 4479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * not use any argument matchers) or it should contain exactly one argument matcher for 4489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * every argument being passed to the next method call. You can't mix argument matchers and 4499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * raw values. 4509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 4519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final List<ArgumentMatcher> sMatchArguments = new ArrayList<ArgumentMatcher>(); 4529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Encapsulates a single call of a method with associated arguments. */ 4549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class MethodCall { 4559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The method call. */ 4569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Method mMethod; 4579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The arguments provided at the time the call happened. */ 4589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Object[] mArgs; 4599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The line from the test that invoked the handler to create this method call. */ 4609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final StackTraceElement mElement; 4619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Keeps track of method calls that have been verified, for verifyNoMoreInteractions(). */ 4629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean mWasVerified = false; 4639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public MethodCall(Method method, StackTraceElement element, Object[] args) { 4659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mMethod = method; 4669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mElement = element; 4679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mArgs = args; 4689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean argsMatch(Object[] args) { 4719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return Arrays.equals(mArgs, args); 4729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 4759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 4769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "MethodCall [method=" + mMethod + ", args=" + Arrays.toString(mArgs) + "]"; 4779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 4799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 4819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Magically handles the invoking of method calls. 4829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 4839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>This object is in one of three states, default (where invoking methods returns default 4849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * values and records the call), verifying (where invoking method calls makes sure that those 4859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * method calls happen with the supplied arguments or matchers) or stubbing (where the next method 4869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * call tells us which arguments to match in order to perform the desired behaviour). 4879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 4889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class DefaultInvocationHandler implements InvocationHandler { 4899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sEqualsMethod; 4909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sHashCodeMethod; 4919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Method sToStringMethod; 4929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 4939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 4949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson try { 4959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sEqualsMethod = Object.class.getMethod("equals", Object.class); 4969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sHashCodeMethod = Object.class.getMethod("hashCode"); 4979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sToStringMethod = Object.class.getMethod("toString"); 4989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } catch (SecurityException e) { 4999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Should never happen. 5009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new RuntimeException("Your JVM/classloader is broken", e); 5019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } catch (NoSuchMethodException e) { 5029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Should never happen. 5039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new RuntimeException("Your JVM/classloader is broken", e); 5049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 5069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The class of the mocked objects. */ 5089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Class<?> mClazz; 5099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The field name in which the mock is assigned. */ 5109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final String mFieldName; 5119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 5129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The list of method calls executed on the mock. */ 513ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private List<MethodCall> mRecordedCalls = new CopyOnWriteArrayList<MethodCall>(); 5149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The list of method calls that were stubbed out and their corresponding actions. */ 515ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private List<StubbedCall> mStubbedCalls = new CopyOnWriteArrayList<StubbedCall>(); 516ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 5179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The number of times a given call should be verified. 5199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is not null when in the verification state, and it is actually used to determine if we 5219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * are in the verification state. 5229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is reset to null once the verification has occurred. 5249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private CallCount mHowManyTimes = null; 526ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 5279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * The action to be associated with the stubbed method. 5299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p>It is not null when in the stubbing state, and it is actually used to determine if we are 5319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * in the stubbing state. 5329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private Action mStubbingAction = null; 5349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 535ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Dynamic proxy used to verify calls against this mock. */ 536ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private final Object mVerifyingMock; 537ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 538ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Dynamic proxy used to stub calls against this mock. */ 539ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private final Object mStubbingMock; 540ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 5419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 5429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Creates a new invocation handler for an object. 5439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 5449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param clazz the class the object belongs to 5459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param fieldName The name to be used to refer to the object. This may either be the name of 5469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * the field this mock will be stored into (in case it uses @Mock) or a suitable name to 5479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * use to refer to the object in error messages, based on the name of the class itself. 5489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 5499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public DefaultInvocationHandler(Class<?> clazz, String fieldName) { 5509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mClazz = clazz; 5519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mFieldName = fieldName; 552ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mVerifyingMock = createVerifyingMock(clazz); 553ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbingMock = createStubbingMock(clazz); 554ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 555ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 556ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // Safe if you call getHandlerFrom(mock).getVerifyingMock(), since this is guaranteed to be 557ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // of the same type as mock itself. 558ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 559ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public <T> T getVerifyingMock() { 560ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) mVerifyingMock; 561ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 562ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 563ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // Safe if you call getHandlerFrom(mock).getStubbingMock(), since this is guaranteed to be 564ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson // of the same type as mock itself. 565ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @SuppressWarnings("unchecked") 566ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public <T> T getStubbingMock() { 567ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return (T) mStubbingMock; 568ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 569ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 570ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Used to check that we always stub and verify from the same thread. */ 571ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private AtomicReference<Thread> mCurrentThread = new AtomicReference<Thread>(); 572ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 573ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Check that we are stubbing and verifying always from the same thread. */ 574ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private void checkThread() { 575ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Thread currentThread = Thread.currentThread(); 576ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mCurrentThread.compareAndSet(null, currentThread); 577ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (mCurrentThread.get() != currentThread) { 578ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Must always mock and stub from one thread only. " 579ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson + "This thread: " + currentThread + ", the other thread: " + mCurrentThread.get()); 580ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 581ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 582ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 583ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Generate the dynamic proxy that will handle verify invocations. */ 584ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private Object createVerifyingMock(Class<?> clazz) { 585ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return createProxy(clazz, new InvocationHandler() { 586ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 587ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 588ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkThread(); 589ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson expect(mHowManyTimes != null, "verifying mock doesn't know how many times"); 590ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 591ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson ArgumentMatcher[] matchers = checkClearAndGetMatchers(method); 592ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 593ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 594ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson innerVerify(method, matchers, methodCall, proxy, callSite, mHowManyTimes); 595ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return defaultReturnValue(method.getReturnType()); 596ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } finally { 597ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedCallCounts.remove(mHowManyTimes); 598ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mHowManyTimes = null; 599ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 600ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 601ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson }); 602ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 603ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 604ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Generate the dynamic proxy that will handle stubbing invocations. */ 605ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private Object createStubbingMock(Class<?> clazz) { 606ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return createProxy(clazz, new InvocationHandler() { 607ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 608ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 609ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson checkThread(); 610ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson expect(mStubbingAction != null, "stubbing mock doesn't know what action to perform"); 611ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 612ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson ArgumentMatcher[] matchers = checkClearAndGetMatchers(method); 613ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 614ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 615ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson innerStub(method, matchers, methodCall, callSite, mStubbingAction); 616ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return defaultReturnValue(method.getReturnType()); 617ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } finally { 618ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sUnfinishedStubbingActions.remove(mStubbingAction); 619ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbingAction = null; 620ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 621ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 622ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson }); 6239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 6269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 6279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite = new Exception().getStackTrace()[2]; 6289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall methodCall = new MethodCall(method, callSite, args); 629ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return innerRecord(method, args, methodCall, proxy, callSite); 6309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** 6339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * Checks whether the given method is one of the special object methods that should not 6349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * verified or stubbed. 6359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * <p> 6369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * If this is one of such methods, it throws an AssertionException. 6379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * 6389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param method the method to be checked 6399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson * @param operation the name of the operation, used for generating a helpful message 6409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson */ 6419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void checkSpecialObjectMethods(Method method, String operation) { 6429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (method.equals(sEqualsMethod) 6439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson || method.equals(sHashCodeMethod) 6449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson || method.equals(sToStringMethod)) { 6459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson fail("cannot " + operation + " call to " + method); 6469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void reset() { 6509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mRecordedCalls.clear(); 6519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mStubbedCalls.clear(); 6529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mHowManyTimes = null; 6539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mStubbingAction = null; 6549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private Object innerRecord(Method method, final Object[] args, 6579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall methodCall, Object proxy, StackTraceElement callSite) throws Throwable { 6589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (method.equals(sEqualsMethod)) { 6599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // Use identify for equality, the default behavior on object. 6609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return proxy == args[0]; 6619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else if (method.equals(sHashCodeMethod)) { 6629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This depends on the fact that each mock has its own DefaultInvocationHandler. 6639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return hashCode(); 6649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else if (method.equals(sToStringMethod)) { 6659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This is used to identify this is a mock, e.g., in error messages. 6669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "Mock<" + mClazz.getName() + ">"; 6679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mRecordedCalls.add(methodCall); 6699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (StubbedCall stubbedCall : mStubbedCalls) { 6709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (stubbedCall.mMethodCall.mMethod.equals(methodCall.mMethod)) { 6719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (stubbedCall.mMethodCall.argsMatch(methodCall.mArgs)) { 6729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson methodCall.mWasVerified = true; 6739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbedCall.mAction.doAction(method, args); 6749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If no stub is defined, return the default value. 6789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return defaultReturnValue(method.getReturnType()); 6799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 6819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void innerStub(Method method, final ArgumentMatcher[] matchers, MethodCall methodCall, 682ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson StackTraceElement callSite, final Action stubbingAction) { 6839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkSpecialObjectMethods(method, "stub"); 6849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkThisActionCanBeUsedForThisMethod(method, stubbingAction, callSite); 6859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers.length == 0) { 6869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If there are no matchers, then this is a simple stubbed method call with an action. 687ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbedCalls.add(0, new StubbedCall(methodCall, stubbingAction)); 6889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 6899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 6909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // If there are matchers, then we need to make a new method call which matches only 6919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // when all the matchers match. Further, the action that method call needs to take 6929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // is to first record the values into any captures that may be present, and only then 6939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // proceed to execute the original action. 6949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson MethodCall matchMatchersMethodCall = new MethodCall(method, callSite, matchers) { 6959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 6969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean argsMatch(Object[] args) { return doMatchersMatch(matchers, args); } 6979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }; 6989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Action setCapturesThenAction = new Action() { 6999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 7009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method innerMethod, Object[] innerArgs) throws Throwable { 7019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setCaptures(matchers, innerArgs); 7029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbingAction.doAction(innerMethod, innerArgs); 7039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 7059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType() { 7069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return stubbingAction.getReturnType(); 7079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson }; 709ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mStubbedCalls.add(0, new StubbedCall(matchMatchersMethodCall, setCapturesThenAction)); 7109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void checkThisActionCanBeUsedForThisMethod(Method method, final Action stubbingAction, 7139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite) { 7149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Class<?> methodType = method.getReturnType(); 7159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson Class<?> actionType = stubbingAction.getReturnType(); 7169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (actionType == null) { 7179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // We could not determine the type returned by this action at the time we 7189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // created it. At this time we cannot check that the returned value is 7199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // appropriate to the return type of the method. 7209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // However, if the type is not correct, any actual invocation of the method 7219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // will fail later on. 7229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 7239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!methodType.isAssignableFrom(actionType)) { 7259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (methodType.isPrimitive() && 7269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson actionType.equals(PRIMITIVE_TO_BOXED_LOOKUP.get(methodType))) { 7279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return; 7289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 7309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\nCan't return ").append(actionType.getSimpleName()).append(" from stub for:"); 7319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, method, callSite, mFieldName, true); 7329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n"); 7339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException(sb.toString()); 7349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private boolean doMatchersMatch(ArgumentMatcher[] matchers, Object[] args) { 7389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (int i = 0; i < matchers.length; ++i) { 7399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!matchers[i].matches(args[i])) { 7409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return false; 7419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return true; 7449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 7469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void innerVerify(Method method, ArgumentMatcher[] matchers, MethodCall methodCall, 747ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Object proxy, StackTraceElement callSite, CallCount callCount) { 7489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson checkSpecialObjectMethods(method, "verify"); 749ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson int total = countMatchingInvocations(method, matchers, methodCall); 750ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson long callTimeout = callCount.getTimeout(); 751ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (callTimeout > 0) { 752ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson long endTime = System.currentTimeMillis() + callTimeout; 753ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson while (!callCount.matches(total)) { 754ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 755ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Thread.sleep(1); 756ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } catch (InterruptedException e) { 757ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson fail("interrupted whilst waiting to verify"); 758ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 759ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (System.currentTimeMillis() > endTime) { 760ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson fail(formatFailedVerifyMessage(methodCall, total, callTimeout, callCount)); 761ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 762ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson total = countMatchingInvocations(method, matchers, methodCall); 763ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 764ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } else { 765ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (!callCount.matches(total)) { 766ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson fail(formatFailedVerifyMessage(methodCall, total, 0, callCount)); 767ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 768ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 769ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 770ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 771ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private int countMatchingInvocations(Method method, ArgumentMatcher[] matchers, 772ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson MethodCall methodCall) { 7739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson int total = 0; 7749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall call : mRecordedCalls) { 7759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (call.mMethod.equals(method)) { 7769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if ((matchers.length > 0 && doMatchersMatch(matchers, call.mArgs)) || 7779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson call.argsMatch(methodCall.mArgs)) { 7789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson setCaptures(matchers, call.mArgs); 7799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson ++total; 7809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson call.mWasVerified = true; 7819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 784ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return total; 7859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 7869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 787ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private String formatFailedVerifyMessage(MethodCall methodCall, int total, long timeoutMillis, 788ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson CallCount callCount) { 7899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StringBuffer sb = new StringBuffer(); 790ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append("\nExpected ").append(callCount); 791ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (timeoutMillis > 0) { 792ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append(" within " + timeoutMillis + "ms"); 793ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 794ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append(" to:"); 7959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, methodCall.mMethod, 7969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson methodCall.mElement, mFieldName, false); 7979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n\n"); 7989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (mRecordedCalls.size() == 0) { 799ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson sb.append("No method calls happened on this mock"); 8009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else { 8019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("Method calls that did happen:"); 8029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (MethodCall recordedCall : mRecordedCalls) { 8039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson appendDebugStringForMethodCall(sb, recordedCall.mMethod, 8049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson recordedCall.mElement, mFieldName, false); 8059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n"); 8089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return sb.toString(); 8099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** All matchers that are captures will store the corresponding arg value. */ 8129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // This suppress warning means that I'm calling setValue with something that I can't promise 8139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // is of the right type. But I think it is unavoidable. Certainly I could give a better 8149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson // error message than the class cast exception you'll get when you try to retrieve the value. 8159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @SuppressWarnings("unchecked") 8169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private void setCaptures(ArgumentMatcher[] matchers, Object[] args) { 8179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (int i = 0; i < matchers.length; ++i) { 8189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers[i] instanceof ArgumentCaptorImpl) { 8199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson ArgumentCaptorImpl.class.cast(matchers[i]).setValue(args[i]); 8209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** An empty array of matchers, to optimise the toArray() call below. */ 8259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final ArgumentMatcher[] EMPTY_MATCHERS_ARRAY = new ArgumentMatcher[0]; 8269de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Makes sure that we have the right number of MATCH_ARGUMENTS for the given method. */ 8289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private ArgumentMatcher[] checkClearAndGetMatchers(Method method) { 8299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson ArgumentMatcher[] matchers = sMatchArguments.toArray(EMPTY_MATCHERS_ARRAY); 8309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.clear(); 8319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (matchers.length > 0 && method.getParameterTypes().length != matchers.length) { 8329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalArgumentException("You can't mix matchers and regular objects."); 8339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return matchers; 8359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8389de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void appendDebugStringForMethodCall(StringBuffer sb, Method method, 8399de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson StackTraceElement callSite, String fieldName, boolean showReturnType) { 8409de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("\n "); 8419de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (showReturnType) { 8429de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append("(").append(method.getReturnType().getSimpleName()).append(") "); 8439de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8449de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(fieldName).append(".").append(method.getName()).append("("); 8459de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson int i = 0; 8469de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson for (Class<?> type : method.getParameterTypes()) { 8479de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (++i > 1) { 8489de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(", "); 8499de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8509de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(type.getSimpleName()); 8519de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8529de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sb.append(")\n at ").append(callSite); 8539de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8549de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8559de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Call this function when you don't expect there to be any outstanding matcher objects. */ 8569de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void checkNoMatchers() { 8579de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (sMatchArguments.size() > 0) { 8589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.clear(); 8599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new IllegalStateException("You have outstanding matchers, must be programming error"); 8609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** A pairing of a method call and an action to be performed when that call happens. */ 8649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class StubbedCall { 8659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final MethodCall mMethodCall; 8669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private final Action mAction; 8679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public StubbedCall(MethodCall methodCall, Action action) { 8699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mMethodCall = methodCall; 8709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mAction = action; 8719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 8749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 8759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "StubbedCall [methodCall=" + mMethodCall + ", action=" + mAction + "]"; 8769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Represents an action to be performed as a result of a method call. */ 8809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private interface Action { 8819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Object doAction(Method method, Object[] arguments) throws Throwable; 8829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** The type of the action, or null if we can't determine the type at stub time. */ 8839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public Class<?> getReturnType(); 8849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Represents something capable of testing if it matches an argument or not. */ 8879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /*package*/ interface ArgumentMatcher { 8889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value); 8899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** A matcher that matches any argument. */ 8929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class MatchAnything implements ArgumentMatcher { 8939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 8949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(Object value) { return true; } 8959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 8969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 8979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Encapsulates the number of times a method is called, between upper and lower bounds. */ 8989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static class CallCount { 899ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mLowerBound; 900ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mUpperBound; 9019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 902ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount(long lowerBound, long upperBound) { 9039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mLowerBound = lowerBound; 9049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mUpperBound = upperBound; 9059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Tells us if this call count matches a desired count. */ 9089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public boolean matches(long total) { 9099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return total >= mLowerBound && total <= mUpperBound; 9109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 912ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Tells us how long we should block waiting for the verify to happen. */ 913ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public long getTimeout() { 914ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return 0; 915ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 916ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 917ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount setLowerBound(long lowerBound) { 918ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mLowerBound = lowerBound; 919ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return this; 920ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 921ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 922ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount setUpperBound(long upperBound) { 923ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mUpperBound = upperBound; 924ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return this; 925ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 926ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 9279de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson @Override 9289de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson public String toString() { 9299de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (mLowerBound == mUpperBound) { 9309de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "exactly " + mLowerBound + plural(" call", mLowerBound); 9319de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } else { 9329de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return "between " + mLowerBound + plural(" call", mLowerBound) + " and " + 9339de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson mUpperBound + plural(" call", mUpperBound); 9349de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9359de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9369de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9379de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 938ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Encapsulates adding number of times behaviour to a call count with timeout. */ 939ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public static final class Timeout extends CallCount { 940ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private long mTimeoutMillis; 941ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 942ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public Timeout(long lowerBound, long upperBound, long timeoutMillis) { 943ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson super(lowerBound, upperBound); 944ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson mTimeoutMillis = timeoutMillis; 945ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 946ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 947ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson @Override 948ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public long getTimeout() { 949ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return mTimeoutMillis; 950ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 951ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 952ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount times(int times) { return setLowerBound(times).setUpperBound(times); } 953ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount atLeast(long n) { return setLowerBound(n).setUpperBound(Long.MAX_VALUE); } 954ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount atLeastOnce() { return setLowerBound(1).setUpperBound(Long.MAX_VALUE); } 955ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson public CallCount between(long n, long m) { return setLowerBound(n).setUpperBound(m); } 956ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 957ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 9589de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Helper method to add an 's' to a string iff the count is not 1. */ 9599de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static String plural(String prefix, long count) { 9609de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return (count == 1) ? prefix : (prefix + "s"); 9619de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9629de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9639de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Helps us implement the eq(), any() and capture() and other methods on one line. */ 9649de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static <T> T addMatcher(ArgumentMatcher argument, T value) { 9659de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson sMatchArguments.add(argument); 9669de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return value; 9679de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9689de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9699de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Utility method to throw an AssertionError if an assertion fails. */ 9709de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void expect(boolean result, String message) { 9719de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson if (!result) { 9729de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson fail(message); 9739de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9749de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9759de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9769de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Throws an AssertionError exception with a message. */ 9779de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void fail(String message) { 9789de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson throw new AssertionError(message); 9799de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9809de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9819de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Static mapping from class type to default value for that type. */ 9829de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final Map<Class<?>, Object> DEFAULT_RETURN_VALUE_LOOKUP; 9839de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 9849de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP = new HashMap<Class<?>, Object>(); 9859de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(int.class, 0); 9869de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(boolean.class, false); 9879de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(byte.class, (byte) 0); 9889de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(long.class, (long) 0); 9899de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(short.class, (short) 0); 9909de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(float.class, (float) 0); 9919de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(double.class, (double) 0); 9929de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(char.class, '\u0000'); 9939de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson DEFAULT_RETURN_VALUE_LOOKUP.put(String.class, null); 9949de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 9959de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 9969de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Static lookup from primitive types to their boxed versions. */ 9979de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static final Map<Class<?>, Class<?>> PRIMITIVE_TO_BOXED_LOOKUP; 9989de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson static { 9999de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP = new HashMap<Class<?>, Class<?>>(); 10009de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(int.class, Integer.class); 10019de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(boolean.class, Boolean.class); 10029de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(byte.class, Byte.class); 10039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(long.class, Long.class); 10049de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(short.class, Short.class); 10059de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(float.class, Float.class); 10069de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(double.class, Double.class); 10079de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson PRIMITIVE_TO_BOXED_LOOKUP.put(char.class, Character.class); 10089de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10099de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10109de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** For a given class type, returns the default value for that type. */ 10119de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static Object defaultReturnValue(Class<?> returnType) { 10129de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return DEFAULT_RETURN_VALUE_LOOKUP.get(returnType); 10139de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10149de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10159de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Gets a suitable class loader for use with the proxy. */ 10169de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static ClassLoader getClassLoader() { 10179de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson return LittleMock.class.getClassLoader(); 10189de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 10199de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson 10209de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson /** Sets a member field on an object via reflection (can set private members too). */ 10219de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson private static void setField(Field field, Object object, Object value) throws Exception { 10229de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.setAccessible(true); 10239de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.set(object, value); 10249de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson field.setAccessible(false); 10259de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson } 1026ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1027ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Helper method to throw an IllegalStateException if given condition is not met. */ 1028ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static void checkState(boolean condition, String message) { 1029ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (!condition) { 1030ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException(message); 1031ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1032ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1033ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson 1034ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson /** 1035ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson * If the input object is one of our mocks, returns the {@link DefaultInvocationHandler} 1036ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson * we constructed it with. Otherwise fails with {@link IllegalArgumentException}. 1037ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson */ 1038ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson private static DefaultInvocationHandler getHandlerFrom(Object mock) { 1039ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson try { 1040ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson InvocationHandler invocationHandler = Proxy.getInvocationHandler(mock); 1041ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson if (invocationHandler instanceof DefaultInvocationHandler) { 1042ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson return (DefaultInvocationHandler) invocationHandler; 1043ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1044ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } catch (IllegalArgumentException expectedIfNotAProxy) {} 1045ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson try { 1046ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Class<?> proxyBuilder = Class.forName("com.google.dexmaker.stock.ProxyBuilder"); 1047ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Method getHandlerMethod = proxyBuilder.getMethod("getInvocationHandler", Object.class); 1048ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson Object invocationHandler = getHandlerMethod.invoke(proxyBuilder, mock); 1049ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson if (invocationHandler instanceof DefaultInvocationHandler) { 1050ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson return (DefaultInvocationHandler) invocationHandler; 1051ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1052ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } catch (Exception expectedIfNotAProxyBuilderMock) {} 1053ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson throw new IllegalArgumentException("not a valid mock: " + mock); 1054ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson } 1055ae4e4ac4facc3eacff13ab7ed115292fb5009d1eHugo Hudson 1056ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson /** Create a dynamic proxy for the given class, delegating to the given invocation handler. */ 1057ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson private static Object createProxy(Class<?> clazz, InvocationHandler handler) { 1058ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson if (clazz.isInterface()) { 1059ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson return Proxy.newProxyInstance(getClassLoader(), new Class<?>[] { clazz }, handler); 1060ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1061ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson try { 1062ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Class<?> proxyBuilder = Class.forName("com.google.dexmaker.stock.ProxyBuilder"); 1063ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Method forClassMethod = proxyBuilder.getMethod("forClass", Class.class); 1064ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Object builder = forClassMethod.invoke(null, clazz); 1065ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson Method dexCacheMethod = builder.getClass().getMethod("dexCache", File.class); 1066ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson File directory = AppDataDirGuesser.getsInstance().guessSuitableDirectoryForGeneratedClasses(); 1067ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson builder = dexCacheMethod.invoke(builder, directory); 10685307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Method buildClassMethod = builder.getClass().getMethod("buildProxyClass"); 10695307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Class<?> resultClass = (Class<?>) buildClassMethod.invoke(builder); 10705307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Object proxy = unsafeCreateInstance(resultClass); 10715307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Field handlerField = resultClass.getDeclaredField("$__handler"); 10725307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson handlerField.setAccessible(true); 10735307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson handlerField.set(proxy, handler); 10745307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return proxy; 1075ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } catch (Exception e) { 1076ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson throw new IllegalStateException("Could not mock this concrete class", e); 1077ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 1078ebb9a5e46fa2c58fa091a8de2c12d87828fae2b0Hugo Hudson } 10795307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson 10805307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson /** Attempt to construct an instance of the class using hacky methods to avoid calling super. */ 10815307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson @SuppressWarnings("unchecked") 10825307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson private static <T> T unsafeCreateInstance(Class<T> clazz) { 10835307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson // try dalvikvm, pre-gingerbread 10845307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson try { 10855307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final Method newInstance = ObjectInputStream.class.getDeclaredMethod( 10865307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "newInstance", Class.class, Class.class); 10875307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson newInstance.setAccessible(true); 10885307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return (T) newInstance.invoke(null, clazz, Object.class); 10895307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } catch (Exception ignored) {} 10905307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson // try dalvikvm, post-gingerbread 10915307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson try { 10925307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson Method getConstructorId = ObjectStreamClass.class.getDeclaredMethod( 10935307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "getConstructorId", Class.class); 10945307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson getConstructorId.setAccessible(true); 10955307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final int constructorId = (Integer) getConstructorId.invoke(null, Object.class); 10965307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson final Method newInstance = ObjectStreamClass.class.getDeclaredMethod( 10975307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson "newInstance", Class.class, int.class); 10985307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson newInstance.setAccessible(true); 10995307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson return (T) newInstance.invoke(null, clazz, constructorId); 11005307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } catch (Exception ignored) {} 11015307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson throw new IllegalStateException("unsafe create instance failed"); 11025307b6d112c825e70dc30aea1c878f4e965127e2Hugo Hudson } 11039de203bcac3d285f4fa57c93085e467eaab9f8f9Hugo Hudson} 1104