Skip to content

Add an extra message to the @BytecodeEnhanced engine discovery errors #10669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add an extra message to the @BytecodeEnhanced engine discovery errors #10669

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 62 additions & 55 deletions ...g/hibernate/testing/bytecode/enhancement/extension/engine/BytecodeEnhancedTestEngine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.extension.ExecutionCondition;
import org.junit.jupiter.api.extension.Extension;
import org.junit.jupiter.api.extension.ExtensionConfigurationException;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.TestInstantiationAwareExtension;
import org.junit.jupiter.api.io.CleanupMode;
Expand Down Expand Up @@ -64,61 +65,67 @@ public String getId() {

@Override
public TestDescriptor discover(EngineDiscoveryRequest discoveryRequest, UniqueId uniqueId) {
final BytecodeEnhancedEngineDescriptor engineDescriptor = new BytecodeEnhancedEngineDescriptor(
(JupiterEngineDescriptor) new JupiterTestEngine().discover( discoveryRequest, uniqueId )
);

for ( TestDescriptor testDescriptor : new HashSet<>( engineDescriptor.getChildren() ) ) {
if ( testDescriptor instanceof ClassBasedTestDescriptor ) {
try {
ClassBasedTestDescriptor descriptor = (ClassBasedTestDescriptor) testDescriptor;
// if the test class is annotated with @BytecodeEnhanced
// we replace the descriptor with the new one that will point to an enhanced test class,
// this also means that we need to add all the child descriptors back as well...
// Then on the extension side we set the classloader that contains the enhanced test class
// and set it back to the original once the test class is destroyed.
Optional<BytecodeEnhanced> bytecodeEnhanced = findAnnotation(
descriptor.getTestClass(), BytecodeEnhanced.class );
if ( bytecodeEnhanced.isPresent() ) {
TestDescriptor parent = descriptor.getParent().orElseThrow( IllegalStateException::new );
Class<?> klass = descriptor.getTestClass();

JupiterConfiguration jc = ( (JupiterEngineDescriptor) parent ).getConfiguration();

String[] testEnhancedClasses = Arrays.stream( bytecodeEnhanced.get().testEnhancedClasses() )
.map( Class::getName ).toArray( String[]::new );

// NOTE: get children before potentially removing from hierarchy, since after that there will be none.
Set<? extends TestDescriptor> children = new HashSet<>( descriptor.getChildren() );
if ( !bytecodeEnhanced.get().runNotEnhancedAsWell() ) {
descriptor.removeFromHierarchy();
}

Map<Object, Class<?>> classes = enhanceTestClass( klass );
if ( classes.size() == 1 ) {
replaceWithEnhanced( classes.values().iterator().next(), descriptor, jc, children, parent, testEnhancedClasses );
}
else {
for ( Map.Entry<Object, Class<?>> entry : classes.entrySet() ) {
replaceWithEnhanced(
entry.getValue(), descriptor, jc, children, parent, testEnhancedClasses, entry.getKey() );
}
}

addEnhancementCheck( false, testEnhancedClasses, descriptor, jc );
}
else {
testDescriptor.removeFromHierarchy();
}
}
catch (ClassNotFoundException | NoSuchMethodException e) {
throw new RuntimeException( e );
}
}
}

return engineDescriptor;
}
try {
final BytecodeEnhancedEngineDescriptor engineDescriptor = new BytecodeEnhancedEngineDescriptor(
(JupiterEngineDescriptor) new JupiterTestEngine().discover( discoveryRequest, uniqueId )
);

for ( TestDescriptor testDescriptor : new HashSet<>( engineDescriptor.getChildren() ) ) {
if ( testDescriptor instanceof ClassBasedTestDescriptor ) {
try {
ClassBasedTestDescriptor descriptor = (ClassBasedTestDescriptor) testDescriptor;
// if the test class is annotated with @BytecodeEnhanced
// we replace the descriptor with the new one that will point to an enhanced test class,
// this also means that we need to add all the child descriptors back as well...
// Then on the extension side we set the classloader that contains the enhanced test class
// and set it back to the original once the test class is destroyed.
Optional<BytecodeEnhanced> bytecodeEnhanced = findAnnotation(
descriptor.getTestClass(), BytecodeEnhanced.class );
if ( bytecodeEnhanced.isPresent() ) {
TestDescriptor parent = descriptor.getParent().orElseThrow( IllegalStateException::new );
Class<?> klass = descriptor.getTestClass();

JupiterConfiguration jc = ( (JupiterEngineDescriptor) parent ).getConfiguration();

String[] testEnhancedClasses = Arrays.stream( bytecodeEnhanced.get().testEnhancedClasses() )
.map( Class::getName ).toArray( String[]::new );

// NOTE: get children before potentially removing from hierarchy, since after that there will be none.
Set<? extends TestDescriptor> children = new HashSet<>( descriptor.getChildren() );
if ( !bytecodeEnhanced.get().runNotEnhancedAsWell() ) {
descriptor.removeFromHierarchy();
}

Map<Object, Class<?>> classes = enhanceTestClass( klass );
if ( classes.size() == 1 ) {
replaceWithEnhanced( classes.values().iterator().next(), descriptor, jc, children, parent, testEnhancedClasses );
}
else {
for ( Map.Entry<Object, Class<?>> entry : classes.entrySet() ) {
replaceWithEnhanced(
entry.getValue(), descriptor, jc, children, parent, testEnhancedClasses, entry.getKey() );
}
}

addEnhancementCheck( false, testEnhancedClasses, descriptor, jc );
}
else {
testDescriptor.removeFromHierarchy();
}
}
catch (ClassNotFoundException | NoSuchMethodException e) {
throw new RuntimeException( e );
}
}
}

return engineDescriptor;
} catch (OutOfMemoryError e) {
throw e;
} catch (Error e) {
throw new ExtensionConfigurationException("Encountered a problem when enhancing the test classes. It is highly likely that @BytecodeEnhanced extension is incompatible with the provided version of JUnit.", e);
}
}

private void addEnhancementCheck(boolean enhance, String[] testEnhancedClasses,
ClassBasedTestDescriptor descriptor, JupiterConfiguration jc) {
Expand Down
Loading