Skip to content

Commit

Permalink
Pass the "plugin class path" from Gradle to the Test Engine, and load…
Browse files Browse the repository at this point in the history 
… the classes under the created PluginClassLoader
  • Loading branch information
@dmikurube
dmikurube committed Sep 18, 2024
1 parent e088998 commit 5806137
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 31 deletions.
26 changes: 25 additions & 1 deletion build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ dependencies {

// embulk-core can be loaded in the top-level class loader.
embulkTestRuntimeOnly "org.embulk:embulk-core:0.11.5"

// To access the Embulk core classes from the tests.
embulkTestCompileOnly "org.embulk:embulk-core:0.11.5"

// TODO: Confirm just 'embulkTestImplementation "org.embulk:embulk-core:0.11.5"' may be better?
}

embulkPlugin {
Expand All @@ -83,7 +88,19 @@ test {
}
}

task embulkTest(type: Test) {
def joinPluginClasspath(FileCollection embulkTestClassesDirs, File embulkTestResourcesDir, FileCollection mainRuntimeClasspath) {
List<String> list = []
embulkTestClassesDirs.files.each { file ->
list.add(file.getAbsolutePath())
}
list.add(embulkTestResourcesDir.getAbsolutePath())
mainRuntimeClasspath.files.each { file ->
list.add(file.getAbsolutePath())
}
return list.join(File.pathSeparator)
}

task embulkTest(type: Test, dependsOn: ":compileJava") {
doFirst {
println "^^^^^ Classpath information in main ^^^^^"
println sourceSets.main.runtimeClasspath
Expand Down Expand Up @@ -117,6 +134,13 @@ task embulkTest(type: Test) {
// Pick up "@EmbulkPluginTest" methods from the classes in "testClassesDirs"
testClassesDirs = sourceSets.embulkTest.output.classesDirs

afterEvaluate { project ->
systemProperty "org.embulk.junit5.plugin.class.path",
joinPluginClasspath(sourceSets.embulkTest.output.classesDirs,
sourceSets.embulkTest.output.resourcesDir,
sourceSets.main.runtimeClasspath)
}

testLogging {
events "started", "passed", "skipped", "failed", "standardOut", "standardError"
exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
Expand Down
92 changes: 64 additions & 28 deletions embulk-junit5-engine/src/main/java/org/embulk/junit5/engine/EmbulkPluginTestEngine.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,18 @@

package org.embulk.junit5.engine;

import java.io.File;
import java.io.UncheckedIOException;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.file.InvalidPathException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Optional;
import java.util.regex.Pattern;
import org.embulk.junit5.api.EmbulkPluginTest;
import org.embulk.plugin.PluginClassLoader;
import org.embulk.plugin.PluginClassLoaderFactory;
Expand All @@ -37,14 +47,39 @@
import org.junit.platform.launcher.LauncherDiscoveryRequest;

public final class EmbulkPluginTestEngine extends HierarchicalTestEngine<EmbulkPluginTestEngineExecutionContext> {
public EmbulkPluginTestEngine() {
public EmbulkPluginTestEngine() throws InvalidPathException, IllegalArgumentException, MalformedURLException {
super();
final Class<?> klass = this.getClass();
this.klassLoader = klass.getClassLoader();
logger.info(() -> "Initializing EmbulkPluginTestEngine@" + Integer.toHexString(this.hashCode()));
logger.info(() -> "EmbulkPluginTestEngine's ClassLoader: " + this.klassLoader.toString());
this.pluginClassLoaderFactory = PluginClassLoaderFactoryImpl.of();
this.pluginClassLoader = null;

final String pluginClassPath = System.getProperty("org.embulk.junit5.plugin.class.path");
logger.info(() -> "System property \"org.embulk.junit5.plugin.class.path\": " + pluginClassPath);
final ArrayList<URL> classPathUrls = new ArrayList<>();
if (pluginClassPath != null && !pluginClassPath.isEmpty()) {
final String[] paths = pluginClassPath.split(Pattern.quote(File.pathSeparator));
for (final String pathString : paths) {
final Path path;
try {
path = Paths.get(pathString);
} catch (final InvalidPathException ex) {
throw ex;
}
try {
classPathUrls.add(path.toUri().toURL());
} catch (final MalformedURLException ex) {
throw new UncheckedIOException(ex);
} catch (final IllegalArgumentException ex) {
throw ex;
}
}
}
logger.info(() -> "Building PluginClassLoader with: " + classPathUrls);

this.pluginClassLoader =
this.pluginClassLoaderFactory.create(Collections.unmodifiableList(classPathUrls), this.klassLoader);
}

/**
Expand Down Expand Up @@ -87,27 +122,16 @@ public TestDescriptor discover(final EngineDiscoveryRequest discoveryRequest, fi

// final Class<?> testClass = classSelector.getJavaClass(); // Not to get the Java class directly!
final String testClassName = classSelector.getClassName();
try {
System.out.println(Class.forName("org.embulk.input.junit5example.ExampleInputPlugin"));
} catch (final Exception ex) {
ex.printStackTrace();
}
try {
System.out.println(Class.forName("org.embulk.input.junit5example.TestExample"));
} catch (final Exception ex) {
ex.printStackTrace();
}
try {
System.out.println(Class.forName("org.embulk.input.junit5example.TestExample1"));
} catch (final Exception ex) {
ex.printStackTrace();
}
try {
System.out.println(Class.forName("org.embulk.util.config.Config"));
} catch (final Exception ex) {
ex.printStackTrace();
}
final Class<?> testClass = findOrLoadClassFrom(this.klassLoader, testClassName);

// Just debug prints.
checkClass("org.embulk.input.junit5example.ExampleInputPlugin");
checkClass("org.embulk.input.junit5example.TestExample");
checkClass("org.embulk.input.junit5example.TestExample1");
checkClass("org.embulk.util.config.Config");

final Class<?> testClass = findOrLoadClassFrom(this.pluginClassLoader, testClassName);
logger.info(() -> "<" + testClass.getName() + "> has been already loaded in [" + testClass.getClassLoader() + "]: "
+ testClass.toString() + "@" + testClass.hashCode());

final TestDescriptor classDescriptor =
new ClassTestDescriptor(uniqueId.append("class", testClass.getName()), testClass);
Expand Down Expand Up @@ -160,16 +184,28 @@ public final Optional<String> getArtifactId() {
return new EmbulkPluginTestEngineExecutionContext();
}

private static Class<?> findOrLoadClassFrom(final ClassLoader klassLoader, final String name) {
final Class<?> foundClass = LoadedClassFinder.findFrom(klassLoader, name);
private static Class<?> checkClass(final String name) {
final Class<?> clazz;
try {
clazz = Class.forName(name);
} catch (final ClassNotFoundException ex) {
logger.info(() -> "<" + name + "> has not been loaded in the top-level classLoader.");
return null;
}
logger.info(() -> "<" + name + "> has been loaded in the top-level classLoader: " + clazz.toString() + "@" + clazz.hashCode());
return clazz;
}

private static Class<?> findOrLoadClassFrom(final PluginClassLoader classLoader, final String name) {
final Class<?> foundClass = LoadedClassFinder.findFrom(classLoader, name);
if (foundClass != null) {
logger.info(() -> "<" + name + "> has been already loaded in [" + klassLoader + "]: " + foundClass.toString());
logger.info(() -> "<" + name + "> has been already loaded in [" + classLoader + "]: " + foundClass.toString());
return foundClass;
}

logger.info(() -> "<" + name + "> has not been loaded in [" + klassLoader + "].");
logger.info(() -> "<" + name + "> has not been loaded in [" + classLoader + "].");
try {
return klassLoader.loadClass(name);
return classLoader.loadClassInThisClassLoader(name, false);
} catch (final ClassNotFoundException ex) {
throw new RuntimeException(ex);
}
Expand Down
7 changes: 5 additions & 2 deletions src/embulkTest/java/org/embulk/input/junit5example/TestExample1.java
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
package org.embulk.input.junit5example;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.embulk.junit5.api.EmbulkPluginTest;

public class TestExample1 {
@EmbulkPluginTest
public void testExample1_1() {
assertEquals(0, 1 - 1);
final ClassLoader classLoader = this.getClass().getClassLoader();
assertEquals("org.embulk.plugin.PluginClassLoader", classLoader.getClass().getName());
}

@EmbulkPluginTest
public void testExample1_2() {
assertEquals(0, 1 - 1);
final ClassLoader classLoader = this.getClass().getClassLoader();
assertTrue(classLoader instanceof org.embulk.plugin.PluginClassLoader);
}
}

0 comments on commit 5806137

Please sign in to comment.