tests/org.eclipse.gmf.tests/src/org/eclipse/gmf/tests/ConfiguredTestCase.java

/*
 * Copyright (c) 2005, 2008 Borland Software Corporation
 * 
 * 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:
 *    Artem Tikhomirov (Borland) - initial API and implementation
 */
package org.eclipse.gmf.tests;

import org.eclipse.gmf.tests.setup.SessionSetup;

import junit.framework.TestCase;

/**
 * @author artem
 *
 */
public abstract class ConfiguredTestCase extends TestCase implements NeedsSetup {

	private SessionSetup mySessionSetup;

	/**
	 * subclasses may initialize this field prior to calling super.setUp()
	 * so that if no SessionSetup was configured explicitly, this default 
	 * would be used.
	 */
	protected SessionSetup myDefaultSetup;

	protected ConfiguredTestCase(String name) {
		super(name);
	}

	public final void configure(SessionSetup sessionSetup) {
		assertNotNull(sessionSetup);
		mySessionSetup = sessionSetup;
		mySessionSetup.oneUp();
	}

	protected final SessionSetup getSetup() {
		return mySessionSetup;
	}

	protected void setUp() throws Exception {
		super.setUp();
		if (mySessionSetup == null && myDefaultSetup != null) {
			// subject to enabled/disabled state dictated from AllTests 
			configure(myDefaultSetup);
		}
		assertNotNull("Test " + getName() + " needs session setup", mySessionSetup);
	}

	protected void tearDown() throws Exception {
		mySessionSetup.oneDown();
		super.tearDown();
	}
}