DiscoveryTestSuite.java

/*******************************************************************************
 * Copyright (c) 2007, 2013 David Green 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:
 *     David Green - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.wikitext.tests;

import java.lang.reflect.Method;
import java.lang.reflect.Modifier;

import org.eclipse.core.runtime.Platform;
import org.eclipse.mylyn.wikitext.tests.ClassTraversal.Visitor;

import junit.framework.JUnit4TestAdapter;
import junit.framework.Test;
import junit.framework.TestSuite;

/**
 * a test suite that discovers tests by traversing the classpath looking for test classes that match specific criteria.
 * 
 * @author David Green
 */
@NoDiscovery
public class DiscoveryTestSuite extends TestSuite implements ClassFilter {

	public DiscoveryTestSuite(ClassFilter filter) {
		discoverTests(filter);
	}

	protected void discoverTests(final ClassFilter filter) {
		// find all tests that meet the right criteria for running in a headless environment
		new ClassTraversal().visitClasses(new Visitor() {
			public void visit(Class<?> clazz) {
				if (!filter(clazz) && !filter.filter(clazz)) {
					if (TestSuite.class.isAssignableFrom(clazz)) {
						try {
							Method suiteMethod = clazz.getMethod("suite");
							if (Modifier.isStatic(suiteMethod.getModifiers())
									&& Modifier.isPublic(suiteMethod.getModifiers())) {
								addTest((Test) suiteMethod.invoke(null));
							} else {
								throw new IllegalStateException(clazz.getName() + "#" + suiteMethod.getName());
							}
						} catch (NoSuchMethodException e) {
							try {
								addTest((Test) clazz.newInstance());
							} catch (InstantiationException e1) {
								throw new IllegalStateException(clazz.getName(), e1);
							} catch (IllegalAccessException e1) {
								throw new IllegalStateException(clazz.getName(), e1);
							}
						} catch (Throwable e) {
							throw new IllegalStateException(clazz.getName(), e);
						}
					} else {
						addTest(new JUnit4TestAdapter(clazz));
					}
				}
			}

		});
	}

	private boolean hasTestMethods(Class<?> clazz) {
		for (Class<?> c = clazz; c != null && c != Object.class; c = c.getSuperclass()) {
			Method[] methods = c.getDeclaredMethods();
			if (methods != null) {
				for (Method m : methods) {
					if (m.getAnnotation(org.junit.Test.class) != null) {
						return true;
					}
				}
			}
		}
		return false;
	}

	/**
	 * indicate if the eclipse runtime is active
	 */
	public static boolean inEclipseRuntime() {
		return Platform.isRunning();
	}

	public boolean filter(Class<?> clazz) {
		if (!Test.class.isAssignableFrom(clazz)) {
			if (!hasTestMethods(clazz)) {
				return true;
			}
		}
		if (DiscoveryTestSuite.class.isAssignableFrom(clazz)) {
			return true;
		}
		if (clazz.getAnnotation(NoDiscovery.class) != null) {
			return true;
		}
		int modifiers = clazz.getModifiers();
		if (Modifier.isAbstract(modifiers)) {
			return true;
		}
		if (!Modifier.isPublic(modifiers)) {
			return true;
		}
		return false;
	}
}