For instance, to run a test on all the precompiled classes, with all the APIs, use a subclass * such as the following: * *
* public class MyParameterizedTest extends AsmTest {
*
* @ParameterizedTest
* @MethodSource(ALL_CLASSES_AND_ALL_APIS)
* public void testSomeFeature(PrecompiledClass classParameter, Api apiParameter) {
* byte[] b = classParameter.getBytes();
* ClassWriter classWriter = new ClassWriter(apiParameter.value(), 0);
* ...
* }
* }
*
*
* @author Eric Bruneton
*/
public abstract class AsmTest {
/** The size of the temporary byte array used to read class input streams chunk by chunk. */
private static final int INPUT_STREAM_DATA_CHUNK_SIZE = 4096;
/**
* MethodSource name to be used in parameterized tests that must be instantiated for all possible
* (precompiled class, api) pairs.
*/
public static final String ALL_CLASSES_AND_ALL_APIS = "allClassesAndAllApis";
/**
* MethodSource name to be used in parameterized tests that must be instantiated for all
* precompiled classes, with the latest api.
*/
public static final String ALL_CLASSES_AND_LATEST_API = "allClassesAndLatestApi";
/**
* The expected pattern (i.e. regular expression) that ASM's UnsupportedOperationException
* messages are supposed to match.
*/
public static final String UNSUPPORTED_OPERATION_MESSAGE_PATTERN = ".* requires ASM[56789].*";
/** JDK version with the corresponding ASM version. */
enum JdkVersion {
JDK7(7, Api.ASM4),
JDK8(8, Api.ASM5),
JDK9(9, Api.ASM6),
JDK11(11, Api.ASM7),
JDK14(14, Api.ASM8),
JDK15(15, Api.ASM9);
private final int majorVersion;
private final Api minimumApi;
JdkVersion(final int majorVersion, final Api minimumApi) {
this.majorVersion = majorVersion;
this.minimumApi = minimumApi;
}
/**
* Returns the major version of the current JDK version.
*
* @return the major version of the current JDK version.
*/
public int majorVersion() {
return majorVersion;
}
/**
* Returns the minimum ASM Api version supporting the current JDK version.
*
* @return the minimum ASM Api version supporting the current JDK version.
*/
public Api minimumApi() {
return minimumApi;
}
}
/**
* A precompiled class, hand-crafted to contain some set of class file structures. These classes
* are not compiled as part of the build. Instead, they have been compiled beforehand, with the
* appropriate JDKs (including some now very hard to download and install).
*/
public enum PrecompiledClass {
DEFAULT_PACKAGE("DefaultPackage"),
JDK3_ALL_INSTRUCTIONS("jdk3.AllInstructions"),
JDK3_ALL_STRUCTURES("jdk3.AllStructures"),
JDK3_ANONYMOUS_INNER_CLASS("jdk3.AllStructures$1"),
JDK3_ARTIFICIAL_STRUCTURES("jdk3.ArtificialStructures"),
JDK3_INNER_CLASS("jdk3.AllStructures$InnerClass"),
JDK3_LARGE_METHOD("jdk3.LargeMethod"),
JDK3_SUB_OPTIMAL_MAX_STACK_AND_LOCALS("jdk3.SubOptimalMaxStackAndLocals"),
JDK5_ALL_INSTRUCTIONS("jdk5.AllInstructions"),
JDK5_ALL_STRUCTURES("jdk5.AllStructures"),
JDK5_ANNOTATION("jdk5.AllStructures$InvisibleAnnotation"),
JDK5_ENUM("jdk5.AllStructures$EnumClass"),
JDK5_LOCAL_CLASS("jdk5.AllStructures$1LocalClass"),
JDK8_ALL_FRAMES("jdk8.AllFrames", JdkVersion.JDK8),
JDK8_ALL_INSTRUCTIONS("jdk8.AllInstructions", JdkVersion.JDK8),
JDK8_ALL_STRUCTURES("jdk8.AllStructures", JdkVersion.JDK8),
JDK8_ANONYMOUS_INNER_CLASS("jdk8.AllStructures$1", JdkVersion.JDK8),
JDK8_ARTIFICIAL_STRUCTURES("jdk8.Artificial$()$Structures", JdkVersion.JDK8),
JDK8_INNER_CLASS("jdk8.AllStructures$InnerClass", JdkVersion.JDK8),
JDK8_LARGE_METHOD("jdk8.LargeMethod", JdkVersion.JDK8),
JDK9_MODULE("jdk9.module-info", JdkVersion.JDK9),
JDK11_ALL_INSTRUCTIONS("jdk11.AllInstructions", JdkVersion.JDK11),
JDK11_ALL_STRUCTURES("jdk11.AllStructures", JdkVersion.JDK11),
JDK11_ALL_STRUCTURES_NESTED("jdk11.AllStructures$Nested", JdkVersion.JDK11),
JDK14_ALL_STRUCTURES_RECORD("jdk14.AllStructures$RecordSubType", JdkVersion.JDK14, true),
JDK14_ALL_STRUCTURES_EMPTY_RECORD("jdk14.AllStructures$EmptyRecord", JdkVersion.JDK14, true),
JDK15_ALL_STRUCTURES("jdk15.AllStructures", JdkVersion.JDK15, true);
private final String name;
private final JdkVersion jdkVersion;
private final boolean preview;
private byte[] bytes;
PrecompiledClass(final String name, final JdkVersion jdkVersion, final boolean preview) {
this.name = name;
this.jdkVersion = jdkVersion;
this.preview = preview;
}
PrecompiledClass(final String name, final JdkVersion jdkVersion) {
this(name, jdkVersion, false);
}
PrecompiledClass(final String name) {
this(name, JdkVersion.JDK7, false);
}
/**
* Returns the fully qualified name of this class.
*
* @return the fully qualified name of this class.
*/
public String getName() {
return name;
}
/**
* Returns the internal name of this class.
*
* @return the internal name of this class.
*/
public String getInternalName() {
return name.endsWith(ClassFile.MODULE_INFO) ? ClassFile.MODULE_INFO : name.replace('.', '/');
}
/**
* Returns true if this class was compiled with a JDK which is more recent than the given ASM
* API. For instance, returns true for a class compiled with the JDK 1.8 if the ASM API version
* is ASM4.
*
* @param api an ASM API version.
* @return whether this class was compiled with a JDK which is more recent than api.
*/
public boolean isMoreRecentThan(final Api api) {
return api.value() < jdkVersion.minimumApi().value();
}
/**
* Returns true if this class was compiled with a JDK which is not compatible with the JDK used
* to run the tests.
*
* @return true if this class was compiled with a JDK which is not compatible with the JDK used
* to run the tests.
*/
public boolean isNotCompatibleWithCurrentJdk() {
if (preview) {
if (!Util.previewFeatureEnabled()) {
return true;
}
return Util.getMajorJavaVersion() != jdkVersion.majorVersion();
}
return Util.getMajorJavaVersion() < jdkVersion.majorVersion();
}
/**
* Returns the content of this class.
*
* @return the content of this class.
*/
public byte[] getBytes() {
if (bytes == null) {
bytes = AsmTest.getBytes(name, ".class");
}
return bytes.clone();
}
@Override
public String toString() {
return name;
}
}
/**
* An invalid class, hand-crafted to contain some set of invalid class file structures. These
* classes are not compiled as part of the build. Instead, they have been compiled beforehand, and
* then manually edited to introduce errors.
*/
public enum InvalidClass {
INVALID_BYTECODE_OFFSET("invalid.InvalidBytecodeOffset"),
INVALID_CLASS_VERSION("invalid.InvalidClassVersion"),
INVALID_CODE_LENGTH("invalid.InvalidCodeLength"),
INVALID_CONSTANT_POOL_INDEX("invalid.InvalidConstantPoolIndex"),
INVALID_CONSTANT_POOL_REFERENCE("invalid.InvalidConstantPoolReference"),
INVALID_CP_INFO_TAG("invalid.InvalidCpInfoTag"),
INVALID_ELEMENT_VALUE("invalid.InvalidElementValue"),
INVALID_INSN_TYPE_ANNOTATION_TARGET_TYPE("invalid.InvalidInsnTypeAnnotationTargetType"),
INVALID_OPCODE("invalid.InvalidOpcode"),
INVALID_SOURCE_DEBUG_EXTENSION("invalid.InvalidSourceDebugExtension"),
INVALID_STACK_MAP_FRAME_TYPE("invalid.InvalidStackMapFrameType"),
INVALID_TYPE_ANNOTATION_TARGET_TYPE("invalid.InvalidTypeAnnotationTargetType"),
INVALID_VERIFICATION_TYPE_INFO("invalid.InvalidVerificationTypeInfo"),
INVALID_WIDE_OPCODE("invalid.InvalidWideOpcode");
private final String name;
InvalidClass(final String name) {
this.name = name;
}
/**
* Returns the fully qualified name of this class.
*
* @return the fully qualified name of this class.
*/
public String getName() {
return name;
}
/**
* Returns the content of this class.
*
* @return the content of this class.
*/
public byte[] getBytes() {
return AsmTest.getBytes(name, ".clazz");
}
@Override
public String toString() {
return name;
}
}
/** An ASM API version. */
public enum Api {
ASM4("ASM4", 4 << 16),
ASM5("ASM5", 5 << 16),
ASM6("ASM6", 6 << 16),
ASM7("ASM7", 7 << 16),
ASM8("ASM8", 8 << 16),
ASM9("ASM9", 9 << 16),
;
private final String name;
private final int value;
Api(final String name, final int value) {
this.name = name;
this.value = value;
}
/**
* Returns the int value of this version, as expected by ASM.
*
* @return one of the ASM4, ASM5, ASM6, ASM7, ASM8 or ASM9 constants from the ASM Opcodes
* interface.
*/
public int value() {
return value;
}
/**
* Returns a human readable symbol corresponding to this version.
*
* @return one of "ASM4", "ASM5", "ASM6" "ASM7", "ASM8" or "ASM9".
*/
@Override
public String toString() {
return name;
}
}
/**
* Builds a list of test arguments for a parameterized test. Parameterized test cases annotated
* with {@code @MethodSource("allClassesAndAllApis")} will be executed on all the possible
* (precompiledClass, api) pairs.
*
* @return all the possible (precompiledClass, api) pairs, for all the precompiled classes and all
* the given ASM API versions.
*/
public static Stream