blob: dcfbd9b6bd9c7927fc8152f0a2fb8f66b3a80892 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2003, 2018 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Ralf Ebert - Bug 307076 : JUnit Plug-in test runner exception "No Classloader found for plug-in ..." is confusing
*******************************************************************************/
package org.eclipse.pde.internal.junit.runtime;
import java.io.*;
import java.net.URI;
import java.net.URL;
import java.util.*;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jdt.internal.junit.runner.RemoteTestRunner;
import org.eclipse.osgi.internal.framework.EquinoxBundle;
import org.osgi.framework.Bundle;
import org.osgi.framework.FrameworkUtil;
import org.osgi.framework.wiring.BundleWiring;
/**
* Runs JUnit tests contained inside a plugin.
*/
public class RemotePluginTestRunner extends RemoteTestRunner {
private String fTestPluginName;
private ClassLoader fLoaderClassLoader;
class BundleClassLoader extends ClassLoader {
private Bundle bundle;
public BundleClassLoader(Bundle target) {
this.bundle = target;
}
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
return bundle.loadClass(name);
}
@Override
protected URL findResource(String name) {
return bundle.getResource(name);
}
@Override
protected Enumeration<URL> findResources(String name) throws IOException {
return bundle.getResources(name);
}
}
static class TestBundleClassLoader extends ClassLoader {
protected Bundle bundle;
public TestBundleClassLoader(Bundle target) {
this.bundle = target;
}
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
return bundle.loadClass(name);
}
@Override
protected URL findResource(String name) {
return bundle.getResource(name);
}
@Override
protected Enumeration<URL> findResources(String name) throws IOException {
return bundle.getResources(name);
}
@Override
public Enumeration<URL> getResources(String res) throws IOException {
List<URL> resources = new ArrayList<>(6);
String location = null;
URL url = null;
if (bundle instanceof EquinoxBundle) {
location = ((EquinoxBundle) bundle).getLocation();
}
if (location != null && location.startsWith("reference:")) { //$NON-NLS-1$
location = location.substring(10, location.length());
URI uri = URI.create(location);
String newPath = uri.getPath() + "bin" + '/' + res; //$NON-NLS-1$
URI newUri = uri.resolve(newPath);
url = newUri.normalize().toURL();
}
if (url != null) {
File f = new File(url.getFile());
if (f.exists()){
resources.add(url);
} else {
Set<String> outputPaths = getOutputPaths();
for (String string : outputPaths) {
URI uri = URI.create(location);
String newPath = uri.getPath() + string + '/' + res;
URI newUri = uri.resolve(newPath);
url = newUri.normalize().toURL();
if (url != null) {
File f2 = new File(url.getFile());
if (f2.exists()) {
resources.add(url);
}
}
}
}
}
else
return Collections.emptyEnumeration();
return Collections.enumeration(resources);
}
private Set<String> getOutputPaths() {
String location = bundle.getLocation();
location = location.substring(16);
File cpFile = new File(location + ".classpath"); //$NON-NLS-1$
Set<String> paths = new HashSet<String>();
try (BufferedReader br = new BufferedReader(new FileReader(cpFile.getAbsoluteFile()))) {
String line;
while ((line = br.readLine()) != null) {
if (line.contains("kind=\"output\"")) { //$NON-NLS-1$
int index = line.indexOf(" path=\""); //$NON-NLS-1$
if (index >= 0) {
line = line.substring(index);
line = line.substring(line.indexOf("\"") + 1); //$NON-NLS-1$
line = line.substring(0, line.indexOf("\"")); //$NON-NLS-1$
paths.add(line);
}
}
if (line.contains("kind=\"src\"") && line.contains("path=\"")) { //$NON-NLS-1$ //$NON-NLS-2$
int index = line.indexOf(" output=\""); //$NON-NLS-1$
if (index >= 0) {
line = line.substring(index);
line = line.substring(line.indexOf("\"") + 1); //$NON-NLS-1$
line = line.substring(0, line.indexOf("\"")); //$NON-NLS-1$-2$
paths.add(line);
}
}
}
} catch (IOException e) {
// return set collected so far
}
return paths;
}
}
class MultiBundleClassLoader extends ClassLoader {
private List<Bundle> bundleList;
public MultiBundleClassLoader(List<Bundle> platformEngineBundles) {
this.bundleList = platformEngineBundles;
}
@Override
protected Class<?> findClass(String name) throws ClassNotFoundException {
Class<?> c = null;
for (Bundle temp : bundleList) {
try {
c = temp.loadClass(name);
if (c != null)
return c;
} catch (ClassNotFoundException e) {
}
}
return c;
}
@Override
protected URL findResource(String name) {
URL url = null;
for (Bundle temp : bundleList) {
url = temp.getResource(name);
if (url != null)
return url;
}
return url;
}
@Override
protected Enumeration<URL> findResources(String name) throws IOException {
Enumeration<URL> enumFinal = null;
for (int i = 0; i < bundleList.size(); i++) {
if (i == 0) {
enumFinal = bundleList.get(i).getResources(name);
continue;
}
Enumeration<URL> e2 = bundleList.get(i).getResources(name);
Vector<URL> temp = new Vector<>();
while (enumFinal != null && enumFinal.hasMoreElements()) {
temp.add(enumFinal.nextElement());
}
while (e2 != null && e2.hasMoreElements()) {
temp.add(e2.nextElement());
}
enumFinal = temp.elements();
}
return enumFinal;
}
}
/**
* The main entry point. Supported arguments in addition
* to the ones supported by RemoteTestRunner:
* <pre>
* -testpluginname: the name of the plugin containing the tests.
* </pre>
* @see RemoteTestRunner
*/
public static void main(String[] args) {
RemotePluginTestRunner testRunner = new RemotePluginTestRunner();
testRunner.init(args);
ClassLoader currentTCCL = Thread.currentThread().getContextClassLoader();
if (isJUnit5(args)) {
//change the classloader so that the test classes in testplugin are discoverable
//by junit5 framework see bug 520811
if (runAsJUnit5(args))
Thread.currentThread().setContextClassLoader(getPluginClassLoader2(testRunner.getfTestPluginName()));
else
Thread.currentThread().setContextClassLoader(getPluginClassLoader(testRunner.getfTestPluginName()));
}
testRunner.run();
if (isJUnit5(args)) {
Thread.currentThread().setContextClassLoader(currentTCCL);
}
}
private static ClassLoader getPluginClassLoader2(String getfTestPluginName) {
Bundle bundle = Platform.getBundle(getfTestPluginName);
if (bundle == null) {
throw new IllegalArgumentException("Bundle \"" + getfTestPluginName + "\" not found. Possible causes include missing dependencies, too restrictive version ranges, or a non-matching required execution environment."); //$NON-NLS-1$ //$NON-NLS-2$
}
final String pluginId = getfTestPluginName;
List<String> engines = new ArrayList<String>();
Bundle bund = FrameworkUtil.getBundle(RemotePluginTestRunner.class);
Bundle[] bundles = bund.getBundleContext().getBundles();
for (Bundle iBundle : bundles) {
try {
BundleWiring bundleWiring = Platform.getBundle(iBundle.getSymbolicName()).adapt(BundleWiring.class);
Collection<String> listResources = bundleWiring.listResources("META-INF/services", "org.junit.platform.engine.TestEngine", BundleWiring.LISTRESOURCES_LOCAL); //$NON-NLS-1$//$NON-NLS-2$
if (!listResources.isEmpty())
engines.add(iBundle.getSymbolicName());
} catch (Exception e) {
// check the next bundle
}
}
engines.add(pluginId);
List<Bundle> platformEngineBundles = new ArrayList<Bundle>();
for (Iterator<String> iterator = engines.iterator(); iterator.hasNext();) {
String string = iterator.next();
Bundle bundle2 = Platform.getBundle(string);
platformEngineBundles.add(bundle2);
}
return new MultiBundleClassLoader2(platformEngineBundles);
}
private static ClassLoader getPluginClassLoader(String getfTestPluginName) {
Bundle bundle = Platform.getBundle(getfTestPluginName);
if (bundle == null) {
throw new IllegalArgumentException("Bundle \"" + getfTestPluginName + "\" not found. Possible causes include missing dependencies, too restrictive version ranges, or a non-matching required execution environment."); //$NON-NLS-1$ //$NON-NLS-2$
}
return new TestBundleClassLoader(bundle);
}
/**
* Returns the Plugin class loader of the plugin containing the test.
* @see RemoteTestRunner#getTestClassLoader()
*/
@Override
protected ClassLoader getTestClassLoader() {
final String pluginId = getfTestPluginName();
return getClassLoader(pluginId);
}
public ClassLoader getClassLoader(final String bundleId) {
Bundle bundle = Platform.getBundle(bundleId);
if (bundle == null) {
throw new IllegalArgumentException("Bundle \"" + bundleId + "\" not found. Possible causes include missing dependencies, too restrictive version ranges, or a non-matching required execution environment."); //$NON-NLS-1$ //$NON-NLS-2$
}
return new BundleClassLoader(bundle);
}
@Override
public void init(String[] args) {
readPluginArgs(args);
boolean isJUnit5 = isJUnit5(args);
if (isJUnit5) {
// changing the classloader to get the testengines for junit5
// during initialization - see bug 520811
ClassLoader currentTCCL = Thread.currentThread().getContextClassLoader();
try {
// Get all bundles with junit5 test engine
List<String> platformEngines = new ArrayList<String>();
Bundle bundle = FrameworkUtil.getBundle(getClass());
Bundle[] bundles = bundle.getBundleContext().getBundles();
for (Bundle iBundle : bundles) {
try {
BundleWiring bundleWiring = Platform.getBundle(iBundle.getSymbolicName()).adapt(BundleWiring.class);
Collection<String> listResources = bundleWiring.listResources("META-INF/services", "org.junit.platform.engine.TestEngine", BundleWiring.LISTRESOURCES_LOCAL); //$NON-NLS-1$//$NON-NLS-2$
if (!listResources.isEmpty())
platformEngines.add(iBundle.getSymbolicName());
} catch (Exception e) {
// check the next bundle
}
}
Thread.currentThread().setContextClassLoader(getJUnit5Classloader(platformEngines));
defaultInit(args);
} finally {
Thread.currentThread().setContextClassLoader(currentTCCL);
}
return;
}
defaultInit(args);
}
private ClassLoader getJUnit5Classloader(List<String> platformEngine) {
List<Bundle> platformEngineBundles = new ArrayList<Bundle>();
for (Iterator<String> iterator = platformEngine.iterator(); iterator.hasNext();) {
String string = iterator.next();
Bundle bundle = Platform.getBundle(string);
platformEngineBundles.add(bundle);
}
return new MultiBundleClassLoader(platformEngineBundles);
}
private static boolean runAsJUnit5(String[] args) {
for (String string : args) {
if (string.equalsIgnoreCase("-runasjunit5")) { //$NON-NLS-1$
return true;
}
}
return false;
}
private static boolean isJUnit5(String[] args) {
if (runAsJUnit5(args) == true)
return true;
for (int i = 0; i < args.length; i++) {
if (args[i].equals("org.eclipse.jdt.internal.junit5.runner.JUnit5TestLoader")) //$NON-NLS-1$
return true;
}
return false;
}
public void readPluginArgs(String[] args) {
for (int i = 0; i < args.length; i++) {
if (isFlag(args, i, "-testpluginname")) //$NON-NLS-1$
setfTestPluginName(args[i + 1]);
if (isFlag(args, i, "-loaderpluginname")) //$NON-NLS-1$
fLoaderClassLoader = getClassLoader(args[i + 1]);
}
if (getfTestPluginName() == null)
throw new IllegalArgumentException("Parameter -testpluginnname not specified."); //$NON-NLS-1$
if (fLoaderClassLoader == null)
fLoaderClassLoader = getClass().getClassLoader();
}
@Override
protected Class<?> loadTestLoaderClass(String className) throws ClassNotFoundException {
return fLoaderClassLoader.loadClass(className);
}
private boolean isFlag(String[] args, int i, final String wantedFlag) {
String lowerCase = args[i].toLowerCase(Locale.ENGLISH);
return lowerCase.equals(wantedFlag) && i < args.length - 1;
}
public String getfTestPluginName() {
return fTestPluginName;
}
public void setfTestPluginName(String fTestPluginName) {
this.fTestPluginName = fTestPluginName;
}
}