uispectestcase.java

基于Junit的 功能和单元测试的的测试工具。只支持Swing.

package org.uispec4j;

import junit.framework.TestCase;
import org.uispec4j.assertion.Assertion;
import org.uispec4j.assertion.UISpecAssert;
import org.uispec4j.interception.toolkit.UISpecDisplay;

/**
 * UISpec4J-enabled TestCase class.<p>
 * Test cases derived from this class automatically set up the instanciation mechanism. They can
 * also access the application main window by defining an adapter, i.e. a class implementing
 * the {@link UISpecAdapter} class.<br>
 * The adapter can be set from the test {@link #setUp()} or any test method using the
 * {@link #setAdapter(UISpecAdapter)} method.
 * The adapter can also be registered by setting the <code>uispec4j.adapter</code> property as follows:
 * <pre><code>
 * uispec4j.adapter=samples.addressbook.test.Adapter
 * </code></pre>
 */
public abstract class UISpecTestCase extends TestCase {

  static final String ADAPTER_CLASS_PROPERTY = "uispec4j.adapter";
  static final String PROPERTY_NOT_DEFINED;

  private UISpecAdapter adapter;

  static {
    PROPERTY_NOT_DEFINED =
      "Adapter class not defined - the '" + ADAPTER_CLASS_PROPERTY +
      "' property must refer to a class implementing the UISpecAdapter interface";
    UISpec4J.init();
  }

  protected UISpecTestCase() {
  }

  protected UISpecTestCase(String testName) {
    super(testName);
  }

  public void setAdapter(UISpecAdapter adapter) {
    this.adapter = adapter;
  }

  /**
   * Initializes the resources needed by the test case.<br>
   * NB: If you provide your own implementation, do not forget to call this one first.
   */
  protected void setUp() throws Exception {
    super.setUp();
    UISpecDisplay.instance().reset();
  }

  /**
   * Checks whether an unexpected exception had occurred, and releases the test resources.
   */
  protected void tearDown() throws Exception {
    UISpecDisplay.instance().rethrowIfNeeded();
    UISpecDisplay.instance().reset();
    super.tearDown();
  }

  private void retrieveAdapter() throws AdapterNotFoundException {
    String adapterClassName = System.getProperty(ADAPTER_CLASS_PROPERTY);
    if (adapterClassName == null) {
      throw new AdapterNotFoundException();
    }
    try {
      adapter = (UISpecAdapter)Class.forName(adapterClassName).newInstance();
    }
    catch (Exception e) {
      throw new AdapterNotFoundException(adapterClassName, e);
    }
  }

  /**
   * Returns the Window created by the adapter.
   *
   * @throws AdapterNotFoundException if the <code>uispec4j.adapter</code> property does not refer
   *                                  to a valid adapter
   */
  public Window getMainWindow() throws AdapterNotFoundException {
    return getAdapter().getMainWindow();
  }

  /**
   * Checks the given assertion.
   *
   * @see UISpecAssert#assertTrue(Assertion)
   */
  public void assertTrue(Assertion assertion) {
    UISpecAssert.assertTrue(assertion);
  }

  /**
   * Waits for at most 'waitTimeLimit' ms until the assertion is true.
   *
   * @see UISpecAssert#waitUntil(Assertion, long)
   */
  public void waitUntil(Assertion assertion, long waitTimeLimit) {
    UISpecAssert.waitUntil(assertion, waitTimeLimit);
  }

  /**
   * Checks that the given assertion fails.
   *
   * @see UISpecAssert#assertFalse(Assertion)
   */
  public void assertFalse(Assertion assertion) {
    UISpecAssert.assertFalse(assertion);
  }

  /**
   * Checks the given assertion.
   * If it fails an AssertionFailedError is thrown with the given message.
   *
   * @see UISpecAssert#assertTrue(String, Assertion)
   */
  public void assertTrue(String message, Assertion assertion) {
    UISpecAssert.assertTrue(message, assertion);
  }

  /**
   * Waits for at most 'waitTimeLimit' ms until the assertion is true.
   * If it fails an AssertionFailedError is thrown with the given message.
   *
   * @see UISpecAssert#waitUntil(String, Assertion, long)
   */
  public void waitUntil(String message, Assertion assertion, long waitTimeLimit) {
    UISpecAssert.waitUntil(message, assertion, waitTimeLimit);
  }

  /**
   * Checks that the given assertion fails.
   * If it succeeds an AssertionFailedError is thrown with the given message.
   *
   * @see UISpecAssert#assertFalse(String, Assertion)
   */
  public void assertFalse(String message, Assertion assertion) {
    UISpecAssert.assertFalse(message, assertion);
  }

  /**
   * Returns a negation of the given assertion.
   *
   * @see UISpecAssert#not(Assertion)
   */
  public Assertion not(Assertion assertion) {
    return UISpecAssert.not(assertion);
  }

  /**
   * Returns the intersection of two assertions.
   *
   * @see UISpecAssert#and(Assertion[])
   */
  public Assertion and(Assertion assertion1, Assertion assertion2) {
    return UISpecAssert.and(new Assertion[]{assertion1, assertion2});
  }

  /**
   * Returns the intersection of two assertions.
   *
   * @see UISpecAssert#and(Assertion[])
   */
  public Assertion and(Assertion[] assertions) {
    return UISpecAssert.and(assertions);
  }

  /**
   * Returns the union of two assertions.
   */
  public Assertion or(Assertion assertion1, Assertion assertion2) {
    return UISpecAssert.or(new Assertion[]{assertion1, assertion2});
  }

  /**
   * Returns the union of two assertions.
   *
   * @see UISpecAssert#or(Assertion[])
   */
  public Assertion or(Assertion[] assertions) {
    return UISpecAssert.or(assertions);
  }

  /**
   * Checks that the given assertion equals the expected parameter.
   *
   * @see UISpecAssert#assertEquals(boolean, Assertion)
   */
  public void assertEquals(boolean expected, Assertion assertion) {
    UISpecAssert.assertEquals(expected, assertion);
  }

  /**
   * Checks that the given assertion equals the expected parameter.
   * If it fails an AssertionFailedError is thrown with the given message.
   *
   * @see UISpecAssert#assertEquals(String, boolean, Assertion)
   */
  public void assertEquals(String message, boolean expected, Assertion assertion) {
    UISpecAssert.assertEquals(message, expected, assertion);
  }

  private UISpecAdapter getAdapter() throws AdapterNotFoundException {
    if (adapter == null) {
      retrieveAdapter();
    }
    return adapter;
  }

  static class AdapterNotFoundException extends RuntimeException {
    public AdapterNotFoundException() {
      super(PROPERTY_NOT_DEFINED);
    }

    public AdapterNotFoundException(String adapterClassName, Exception e) {
      super("Adapter class '" + adapterClassName + "' not found", e);
    }
  }
}