Skip to content

Commit 2c0bf94

Browse files
raphwraphw
authored
Merge pull request #2613 from mockito/graal-support
Support subclass mocks on Graal VM.
2 parents 8314824 + d23dc0e commit 2c0bf94

File tree

6 files changed

+117
-37
lines changed

6 files changed

+117
-37
lines changed

‎src/main/java/org/mockito/internal/creation/bytebuddy/MockMethodAdvice.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
import net.bytebuddy.description.method.MethodDescription;
3434
import net.bytebuddy.description.method.MethodList;
3535
import net.bytebuddy.description.method.ParameterDescription;
36+
import net.bytebuddy.description.type.TypeDefinition;
3637
import net.bytebuddy.description.type.TypeDescription;
3738
import net.bytebuddy.dynamic.scaffold.MethodGraph;
3839
import net.bytebuddy.implementation.Implementation;
@@ -188,7 +189,9 @@ public boolean isOverridden(Object instance, Method origin) {
188189
SoftReference<MethodGraph> reference = graphs.get(instance.getClass());
189190
MethodGraph methodGraph = reference == null ? null : reference.get();
190191
if (methodGraph == null) {
191-
methodGraph = compiler.compile(new TypeDescription.ForLoadedType(instance.getClass()));
192+
methodGraph =
193+
compiler.compile(
194+
(TypeDefinition) TypeDescription.ForLoadedType.of(instance.getClass()));
192195
graphs.put(instance.getClass(), new SoftReference<>(methodGraph));
193196
}
194197
MethodGraph.Node node =

‎src/main/java/org/mockito/internal/creation/bytebuddy/ModuleHandler.java

+24-20
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,25 @@
44
*/
55
package org.mockito.internal.creation.bytebuddy;
66

7-
import static net.bytebuddy.matcher.ElementMatchers.isTypeInitializer;
8-
import static org.mockito.internal.util.StringUtil.join;
9-
10-
import java.lang.reflect.Field;
11-
import java.lang.reflect.Method;
12-
import java.util.Random;
13-
147
import net.bytebuddy.ByteBuddy;
158
import net.bytebuddy.description.modifier.Ownership;
169
import net.bytebuddy.description.modifier.Visibility;
1710
import net.bytebuddy.dynamic.scaffold.subclass.ConstructorStrategy;
1811
import net.bytebuddy.implementation.Implementation;
1912
import net.bytebuddy.implementation.MethodCall;
2013
import net.bytebuddy.implementation.StubMethod;
14+
import net.bytebuddy.utility.GraalImageCode;
15+
import net.bytebuddy.utility.RandomString;
16+
import org.mockito.Mockito;
2117
import org.mockito.codegen.InjectionBase;
2218
import org.mockito.exceptions.base.MockitoException;
2319

20+
import java.lang.reflect.Field;
21+
import java.lang.reflect.Method;
22+
23+
import static net.bytebuddy.matcher.ElementMatchers.isTypeInitializer;
24+
import static org.mockito.internal.util.StringUtil.join;
25+
2426
abstract class ModuleHandler {
2527

2628
abstract boolean isOpened(Class<?> source, Class<?> target);
@@ -35,9 +37,9 @@ abstract class ModuleHandler {
3537

3638
abstract void adjustModuleGraph(Class<?> source, Class<?> target, boolean export, boolean read);
3739

38-
static ModuleHandler make(ByteBuddy byteBuddy, SubclassLoader loader, Random random) {
40+
static ModuleHandler make(ByteBuddy byteBuddy, SubclassLoader loader) {
3941
try {
40-
return new ModuleSystemFound(byteBuddy, loader, random);
42+
return new ModuleSystemFound(byteBuddy, loader);
4143
} catch (Exception ignored) {
4244
return new NoModuleSystemFound();
4345
}
@@ -47,7 +49,6 @@ private static class ModuleSystemFound extends ModuleHandler {
4749

4850
private final ByteBuddy byteBuddy;
4951
private final SubclassLoader loader;
50-
private final Random random;
5152

5253
private final int injectonBaseSuffix;
5354

@@ -58,15 +59,15 @@ private static class ModuleSystemFound extends ModuleHandler {
5859
canRead,
5960
addExports,
6061
addReads,
61-
addOpens,
6262
forName;
6363

64-
private ModuleSystemFound(ByteBuddy byteBuddy, SubclassLoader loader, Random random)
65-
throws Exception {
64+
private ModuleSystemFound(ByteBuddy byteBuddy, SubclassLoader loader) throws Exception {
6665
this.byteBuddy = byteBuddy;
6766
this.loader = loader;
68-
this.random = random;
69-
injectonBaseSuffix = Math.abs(random.nextInt());
67+
injectonBaseSuffix =
68+
GraalImageCode.getCurrent().isDefined()
69+
? 0
70+
: Math.abs(Mockito.class.hashCode());
7071
Class<?> moduleType = Class.forName("java.lang.Module");
7172
getModule = Class.class.getMethod("getModule");
7273
isOpen = moduleType.getMethod("isOpen", String.class, moduleType);
@@ -75,7 +76,6 @@ private ModuleSystemFound(ByteBuddy byteBuddy, SubclassLoader loader, Random ran
7576
canRead = moduleType.getMethod("canRead", moduleType);
7677
addExports = moduleType.getMethod("addExports", String.class, moduleType);
7778
addReads = moduleType.getMethod("addReads", moduleType);
78-
addOpens = moduleType.getMethod("addOpens", String.class, moduleType);
7979
forName = Class.class.getMethod("forName", String.class);
8080
}
8181

@@ -207,9 +207,12 @@ void adjustModuleGraph(Class<?> source, Class<?> target, boolean export, boolean
207207
ConstructorStrategy.Default.NO_CONSTRUCTORS)
208208
.name(
209209
String.format(
210-
"%s$%d",
210+
"%s$%s%s",
211211
"org.mockito.codegen.MockitoTypeCarrier",
212-
Math.abs(random.nextInt())))
212+
RandomString.hashOf(
213+
source.getName().hashCode()),
214+
RandomString.hashOf(
215+
target.getName().hashCode())))
213216
.defineField(
214217
"mockitoType",
215218
Class.class,
@@ -262,10 +265,11 @@ void adjustModuleGraph(Class<?> source, Class<?> target, boolean export, boolean
262265
.subclass(Object.class)
263266
.name(
264267
String.format(
265-
"%s$%s$%d",
268+
"%s$%s$%s%s",
266269
source.getName(),
267270
"MockitoModuleProbe",
268-
Math.abs(random.nextInt())))
271+
RandomString.hashOf(source.getName().hashCode()),
272+
RandomString.hashOf(target.getName().hashCode())))
269273
.invokable(isTypeInitializer())
270274
.intercept(implementation)
271275
.make()

‎src/main/java/org/mockito/internal/creation/bytebuddy/SubclassBytecodeGenerator.java

+63-12
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@
2121

2222
import java.io.IOException;
2323
import java.io.ObjectInputStream;
24+
import java.io.Serializable;
2425
import java.lang.annotation.Annotation;
2526
import java.lang.reflect.Method;
2627
import java.lang.reflect.Modifier;
2728
import java.lang.reflect.Type;
28-
import java.util.ArrayList;
29-
import java.util.Iterator;
30-
import java.util.Random;
29+
import java.util.*;
30+
3131
import net.bytebuddy.ByteBuddy;
3232
import net.bytebuddy.description.method.MethodDescription;
3333
import net.bytebuddy.description.modifier.SynchronizationState;
@@ -39,6 +39,8 @@
3939
import net.bytebuddy.implementation.Implementation;
4040
import net.bytebuddy.implementation.attribute.MethodAttributeAppender;
4141
import net.bytebuddy.matcher.ElementMatcher;
42+
import net.bytebuddy.utility.GraalImageCode;
43+
import net.bytebuddy.utility.RandomString;
4244
import org.mockito.codegen.InjectionBase;
4345
import org.mockito.exceptions.base.MockitoException;
4446
import org.mockito.internal.creation.bytebuddy.ByteBuddyCrossClassLoaderSerializationSupport.CrossClassLoaderSerializableMock;
@@ -52,7 +54,6 @@ class SubclassBytecodeGenerator implements BytecodeGenerator {
5254
private final SubclassLoader loader;
5355
private final ModuleHandler handler;
5456
private final ByteBuddy byteBuddy;
55-
private final Random random;
5657
private final Implementation readReplace;
5758
private final ElementMatcher<? super MethodDescription> matcher;
5859

@@ -82,8 +83,7 @@ protected SubclassBytecodeGenerator(
8283
this.readReplace = readReplace;
8384
this.matcher = matcher;
8485
byteBuddy = new ByteBuddy().with(TypeValidation.DISABLED);
85-
random = new Random();
86-
handler = ModuleHandler.make(byteBuddy, loader, random);
86+
handler = ModuleHandler.make(byteBuddy, loader);
8787
}
8888

8989
private static boolean needsSamePackageClassLoader(MockFeatures<?> features) {
@@ -167,7 +167,8 @@ public <T> Class<? extends T> mockClass(MockFeatures<T> features) {
167167
&& features.serializableMode != SerializableMode.ACROSS_CLASSLOADERS
168168
&& !isComingFromJDK(features.mockedType)
169169
&& (loader.isDisrespectingOpenness()
170-
|| handler.isOpened(features.mockedType, MockAccess.class));
170+
|| handler.isOpened(features.mockedType, MockAccess.class))
171+
&& !GraalImageCode.getCurrent().isDefined();
171172
String typeName;
172173
if (localMock
173174
|| (loader instanceof MultipleParentClassLoader
@@ -180,7 +181,13 @@ public <T> Class<? extends T> mockClass(MockFeatures<T> features) {
180181
+ features.mockedType.getSimpleName();
181182
}
182183
String name =
183-
String.format("%s$%s$%d", typeName, "MockitoMock", Math.abs(random.nextInt()));
184+
String.format(
185+
"%s$%s$%s",
186+
typeName,
187+
"MockitoMock",
188+
GraalImageCode.getCurrent().isDefined()
189+
? suffix(features)
190+
: RandomString.make());
184191

185192
if (localMock) {
186193
handler.adjustModuleGraph(features.mockedType, MockAccess.class, false, true);
@@ -214,17 +221,36 @@ public <T> Class<? extends T> mockClass(MockFeatures<T> features) {
214221
}
215222
}
216223
}
217-
224+
// Graal requires that the byte code of classes is identical what requires that interfaces
225+
// are always
226+
// defined in the exact same order. Therefore, we add an interface to the interface set if
227+
// not mocking
228+
// a class when Graal is active.
229+
@SuppressWarnings("unchecked")
230+
Class<T> target =
231+
GraalImageCode.getCurrent().isDefined() && features.mockedType.isInterface()
232+
? (Class<T>) Object.class
233+
: features.mockedType;
218234
DynamicType.Builder<T> builder =
219235
byteBuddy
220-
.subclass(features.mockedType)
236+
.subclass(target)
221237
.name(name)
222238
.ignoreAlso(BytecodeGenerator.isGroovyMethod(false))
223239
.annotateType(
224-
features.stripAnnotations
240+
features.stripAnnotations || features.mockedType.isInterface()
225241
? new Annotation[0]
226242
: features.mockedType.getAnnotations())
227-
.implement(new ArrayList<Type>(features.interfaces))
243+
.implement(
244+
new ArrayList<>(
245+
GraalImageCode.getCurrent().isDefined()
246+
? sortedSerializable(
247+
features.interfaces,
248+
GraalImageCode.getCurrent().isDefined()
249+
&& features.mockedType
250+
.isInterface()
251+
? features.mockedType
252+
: void.class)
253+
: features.interfaces))
228254
.method(matcher)
229255
.intercept(dispatcher)
230256
.transform(withModifiers(SynchronizationState.PLAIN))
@@ -266,6 +292,31 @@ public <T> Class<? extends T> mockClass(MockFeatures<T> features) {
266292
.getLoaded();
267293
}
268294

295+
private static CharSequence suffix(MockFeatures<?> features) {
296+
// Constructs a deterministic suffix for this mock to assure that mocks always carry the
297+
// same name.
298+
StringBuilder sb = new StringBuilder();
299+
Set<String> names = new TreeSet<>();
300+
names.add(features.mockedType.getName());
301+
for (Class<?> type : features.interfaces) {
302+
names.add(type.getName());
303+
}
304+
return sb.append(RandomString.hashOf(names.hashCode()))
305+
.append(RandomString.hashOf(features.serializableMode.name().hashCode()))
306+
.append(features.stripAnnotations ? "S" : "N");
307+
}
308+
309+
private static Collection<? extends Type> sortedSerializable(
310+
Collection<Class<?>> interfaces, Class<?> mockedType) {
311+
SortedSet<Class<?>> types = new TreeSet<>(Comparator.comparing(Class::getName));
312+
types.addAll(interfaces);
313+
if (mockedType != void.class) {
314+
types.add(mockedType);
315+
}
316+
types.add(Serializable.class);
317+
return types;
318+
}
319+
269320
@Override
270321
public void mockClassStatic(Class<?> type) {
271322
throw new MockitoException("The subclass byte code generator cannot create static mocks");

‎src/main/java/org/mockito/internal/creation/bytebuddy/SubclassInjectionLoader.java

+21-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
import net.bytebuddy.dynamic.loading.ClassInjector;
1313
import net.bytebuddy.dynamic.loading.ClassLoadingStrategy;
14+
import net.bytebuddy.utility.GraalImageCode;
1415
import org.mockito.codegen.InjectionBase;
1516
import org.mockito.exceptions.base.MockitoException;
1617
import org.mockito.internal.util.Platform;
@@ -27,9 +28,14 @@ class SubclassInjectionLoader implements SubclassLoader {
2728
private final SubclassLoader loader;
2829

2930
SubclassInjectionLoader() {
30-
if (!Boolean.getBoolean("org.mockito.internal.noUnsafeInjection")
31+
if (!Boolean.parseBoolean(
32+
System.getProperty(
33+
"org.mockito.internal.noUnsafeInjection",
34+
Boolean.toString(GraalImageCode.getCurrent().isDefined())))
3135
&& ClassInjector.UsingReflection.isAvailable()) {
3236
this.loader = new WithReflection();
37+
} else if (GraalImageCode.getCurrent().isDefined()) {
38+
this.loader = new WithIsolatedLoader();
3339
} else if (ClassInjector.UsingLookup.isAvailable()) {
3440
this.loader = tryLookup();
3541
} else {
@@ -70,6 +76,20 @@ public ClassLoadingStrategy<ClassLoader> resolveStrategy(
7076
}
7177
}
7278

79+
private static class WithIsolatedLoader implements SubclassLoader {
80+
81+
@Override
82+
public boolean isDisrespectingOpenness() {
83+
return false;
84+
}
85+
86+
@Override
87+
public ClassLoadingStrategy<ClassLoader> resolveStrategy(
88+
Class<?> mockedType, ClassLoader classLoader, boolean localMock) {
89+
return ClassLoadingStrategy.Default.WRAPPER;
90+
}
91+
}
92+
7393
private static class WithLookup implements SubclassLoader {
7494

7595
private final Object lookup;

‎src/main/java/org/mockito/internal/util/Platform.java

+5-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,11 @@ public static String describe() {
6969
}
7070

7171
public static boolean isJava8BelowUpdate45() {
72-
return isJava8BelowUpdate45(JVM_VERSION);
72+
if (JVM_VERSION == null) {
73+
return false;
74+
} else {
75+
return isJava8BelowUpdate45(JVM_VERSION);
76+
}
7377
}
7478

7579
static boolean isJava8BelowUpdate45(String jvmVersion) {

‎src/test/java/org/mockitointegration/NoByteCodeDependenciesTest.java

-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515

1616
public class NoByteCodeDependenciesTest {
1717

18-
private ClassLoader contextClassLoader;
19-
2018
@Test
2119
public void pure_mockito_should_not_depend_bytecode_libraries() throws Exception {
2220

0 commit comments

Comments
 (0)