tests/org.eclipse.core.tests.harness/src/org/eclipse/core/tests/session/SessionTestSuite.java

/*******************************************************************************
 * Copyright (c) 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.tests.session;

import java.util.*;
import junit.framework.*;
import org.eclipse.core.tests.session.SetupManager.SetupException;

public class SessionTestSuite extends TestSuite {
	public static final String CORE_TEST_APPLICATION = "org.eclipse.pde.junit.runtime.coretestapplication"; //$NON-NLS-1$	
	public static final String UI_TEST_APPLICATION = "org.eclipse.pde.junit.runtime.uitestapplication"; //$NON-NLS-1$	
	protected String applicationId = CORE_TEST_APPLICATION;
	protected String pluginId;
	protected SessionTestRunner testRunner;
	private Set crashTests = new HashSet();

	public SessionTestSuite(String pluginId) {
		super();
		this.pluginId = pluginId;
	}

	public SessionTestSuite(String pluginId, Class theClass) {
		super(theClass);
		this.pluginId = pluginId;
	}

	public SessionTestSuite(String pluginId, Class theClass, String name) {
		super(theClass, name);
		this.pluginId = pluginId;
	}

	public SessionTestSuite(String pluginId, String name) {
		super(name);
		this.pluginId = pluginId;
	}

	public void addCrashTest(TestCase test) {
		crashTests.add(test);
		super.addTest(test);
	}

	protected void fillTestDescriptor(TestDescriptor test) throws SetupException {
		if (test.getApplicationId() == null)
			test.setApplicationId(applicationId);
		if (test.getPluginId() == null)
			test.setPluginId(pluginId);
		if (test.getSetup() == null)
			test.setSetup(getSetup());
		if (!test.isCrashTest() && crashTests.contains(test.getTest()))
			test.setCrashTest(true);
		test.setTestRunner(getTestRunner());
	}

	public String getApplicationId() {
		return applicationId;
	}

	protected Setup getSetup() throws SetupException {
		return SetupManager.getInstance().getDefaultSetup();
	}

	protected SessionTestRunner getTestRunner() {
		if (testRunner == null)
			testRunner = new SessionTestRunner();
		return testRunner;
	}

	protected void runSessionTest(TestDescriptor test, TestResult result) {
		try {
			fillTestDescriptor(test);
			test.run(result);
		} catch (SetupException e) {
			result.addError(test.getTest(), e.getCause());
		}
	}

	public void runTest(Test test, TestResult result) {
		if (test instanceof TestDescriptor)
			runSessionTest((TestDescriptor) test, result);
		else if (test instanceof TestCase)
			runSessionTest(new TestDescriptor((TestCase) test), result);
		else if (test instanceof TestSuite)
			// find and run the test cases that make up the suite
			runTestSuite((TestSuite) test, result);
		else
			// we don't support session tests for things that are not TestCases 
			// or TestSuites (e.g. TestDecorators) 
			test.run(result);
	}

	/*
	 * Traverses the test suite to find individual test cases to be run with the SessionTestRunner.
	 */
	protected void runTestSuite(TestSuite suite, TestResult result) {
		for (Enumeration e = suite.tests(); e.hasMoreElements();) {
			if (result.shouldStop())
				break;
			Test test = (Test) e.nextElement();
			runTest(test, result);
		}
	}

	public void setApplicationId(String applicationId) {
		this.applicationId = applicationId;
	}
}