1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/*
* Copyright (C) 2012 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.dx.mockito;
import com.android.dx.stock.ProxyBuilder;
import org.mockito.exceptions.base.MockitoException;
import org.mockito.exceptions.stacktrace.StackTraceCleaner;
import org.mockito.internal.util.reflection.LenientCopyTool;
import org.mockito.invocation.MockHandler;
import org.mockito.mock.MockCreationSettings;
import org.mockito.plugins.MockMaker;
import org.mockito.plugins.StackTraceCleanerProvider;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Proxy;
import java.util.Set;
/**
* Generates mock instances on Android's runtime.
*/
public final class DexmakerMockMaker implements MockMaker, StackTraceCleanerProvider {
private final UnsafeAllocator unsafeAllocator = UnsafeAllocator.create();
private boolean isApi28;
public DexmakerMockMaker() {
try {
Class buildVersion = Class.forName("android.os.Build$VERSION");
isApi28 = buildVersion.getDeclaredField("SDK_INT").getInt(null) >= 28;
} catch (ClassNotFoundException | NoSuchFieldException | IllegalAccessException e) {
System.err.println("Could not determine platform API level, assuming >= 28: " + e);
isApi28 = true;
}
if (isApi28) {
// Blacklisted APIs were introduced in Android P:
//
// https://android-developers.googleblog.com/2018/02/
// improving-stability-by-reducing-usage.html
//
// This feature prevents access to blacklisted fields and calling of blacklisted APIs
// if the calling class is not trusted.
Method allowHiddenApiReflectionFromMethod;
try {
Class vmDebug = Class.forName("dalvik.system.VMDebug");
allowHiddenApiReflectionFromMethod = vmDebug.getDeclaredMethod(
"allowHiddenApiReflectionFrom", Class.class);
} catch (ClassNotFoundException | NoSuchMethodException e) {
throw new IllegalStateException(
"Cannot find VMDebug#allowHiddenApiReflectionFrom. Method is needed to "
+ "allow spies to copy blacklisted fields.");
}
// The LenientCopyTool copies the fields to a spy when creating the copy from an
// existing object. Some of the fields might be blacklisted. Marking the LenientCopyTool
// as trusted allows the tool to copy all fields, including the blacklisted ones.
try {
allowHiddenApiReflectionFromMethod.invoke(null, LenientCopyTool.class);
} catch (InvocationTargetException | IllegalAccessException e) {
System.err.println("Cannot allow LenientCopyTool to copy spies of blacklisted "
+ "fields. This might break spying on system classes.");
}
// The ProxyBuilder class needs to be able to see hidden methods in order to proxy
// them correctly. If it cannot see blacklisted methods, then other system classes
// which call hidden methods on the mock will call through to the real method rather
// than the proxy, which may cause crashes or other unexpected behavior.
try {
allowHiddenApiReflectionFromMethod.invoke(null, ProxyBuilder.class);
} catch (InvocationTargetException | IllegalAccessException e) {
System.err.println("Cannot allow ProxyBuilder to proxy blacklisted "
+ "methods. This might break mocking on system classes.");
}
}
}
@Override
public <T> T createMock(MockCreationSettings<T> settings, MockHandler handler) {
Class<T> typeToMock = settings.getTypeToMock();
Set<Class<?>> interfacesSet = settings.getExtraInterfaces();
Class<?>[] extraInterfaces = interfacesSet.toArray(new Class[interfacesSet.size()]);
InvocationHandler invocationHandler = new InvocationHandlerAdapter(handler);
if (typeToMock.isInterface()) {
// support interfaces via java.lang.reflect.Proxy
Class[] classesToMock = new Class[extraInterfaces.length + 1];
classesToMock[0] = typeToMock;
System.arraycopy(extraInterfaces, 0, classesToMock, 1, extraInterfaces.length);
// newProxyInstance returns the type of typeToMock
@SuppressWarnings("unchecked")
T mock = (T) Proxy.newProxyInstance(typeToMock.getClassLoader(), classesToMock, invocationHandler);
return mock;
} else {
// support concrete classes via dexmaker's ProxyBuilder
try {
ProxyBuilder builder = ProxyBuilder.forClass(typeToMock)
.implementing(extraInterfaces);
if (isApi28) {
builder.markTrusted();
}
if (Boolean.parseBoolean(
System.getProperty("dexmaker.share_classloader", "false"))) {
builder.withSharedClassLoader();
}
Class<? extends T> proxyClass = builder.buildProxyClass();
T mock = unsafeAllocator.newInstance(proxyClass);
ProxyBuilder.setInvocationHandler(mock, invocationHandler);
return mock;
} catch (RuntimeException e) {
throw e;
} catch (Exception e) {
throw new MockitoException("Failed to mock " + typeToMock, e);
}
}
}
@Override
public void resetMock(Object mock, MockHandler newHandler, MockCreationSettings settings) {
InvocationHandlerAdapter adapter = getInvocationHandlerAdapter(mock);
adapter.setHandler(newHandler);
}
@Override
public TypeMockability isTypeMockable(final Class<?> type) {
return new TypeMockability() {
@Override
public boolean mockable() {
return !type.isPrimitive() && !Modifier.isFinal(type.getModifiers());
}
@Override
public String nonMockableReason() {
if (type.isPrimitive()) {
return "primitive type";
}
if (Modifier.isFinal(type.getModifiers())) {
return "final or anonymous class";
}
return "not handled type";
}
};
}
@Override
public MockHandler getHandler(Object mock) {
InvocationHandlerAdapter adapter = getInvocationHandlerAdapter(mock);
return adapter != null ? adapter.getHandler() : null;
}
@Override
public StackTraceCleaner getStackTraceCleaner(final StackTraceCleaner defaultCleaner) {
return new StackTraceCleaner() {
@Override
public boolean isIn(StackTraceElement candidate) {
String className = candidate.getClassName();
return defaultCleaner.isIn(candidate)
&& !className.endsWith("_Proxy") // dexmaker class proxies
&& !className.startsWith("$Proxy") // dalvik interface proxies
&& !className.startsWith("java.lang.reflect.Proxy")
&& !(className.startsWith("com.android.dx.mockito.")
// Do not clean unit tests
&& !className.startsWith("com.android.dx.mockito.tests"));
}
};
}
private InvocationHandlerAdapter getInvocationHandlerAdapter(Object mock) {
if (mock == null) {
return null;
}
if (Proxy.isProxyClass(mock.getClass())) {
InvocationHandler invocationHandler = Proxy.getInvocationHandler(mock);
return invocationHandler instanceof InvocationHandlerAdapter
? (InvocationHandlerAdapter) invocationHandler
: null;
}
if (ProxyBuilder.isProxyClass(mock.getClass())) {
InvocationHandler invocationHandler = ProxyBuilder.getInvocationHandler(mock);
return invocationHandler instanceof InvocationHandlerAdapter
? (InvocationHandlerAdapter) invocationHandler
: null;
}
return null;
}
}
|
