AbstractWorkspaceBasedBuildFileTest.java

/**********************************************************************
 * Copyright (c) 2005-2009 ant4eclipse project team.
 *
 * 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:
 *     Nils Hartmann, Daniel Kasmeroglu, Gerd Wuetherich
 **********************************************************************/
package org.ant4eclipse.platform.test;

import org.ant4eclipse.lib.core.service.ServiceRegistry;
import org.ant4eclipse.lib.core.service.ServiceRegistryAccess;
import org.ant4eclipse.lib.core.util.Utilities;
import org.ant4eclipse.testframework.TestDirectory;
import org.apache.tools.ant.BuildFileTest;
import org.apache.tools.ant.Project;

import java.io.File;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import junit.framework.ComparisonFailure;

/**
 * Baseclass for all buildfile-based tests in the platform layer
 * 
 * @author Nils Hartmann (nils@nilshartmann.net)
 */
public abstract class AbstractWorkspaceBasedBuildFileTest extends BuildFileTest {

  private TestDirectory _testWorkspace;

  /**
   * {@inheritDoc}
   */
  @Override
  public String getError() {
    try {
      return super.getError();
    } catch (NullPointerException ex) {
      /** @see #getOutput() */
      return "";
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String getOutput() {
    // we're catching the 'NullPointerException' here as the original method calls the
    // helper method 'cleanedBuffer' in order to alter the buffer. unfortunately the
    // buffer itself get's only initialised shortly before the first target is being
    // executed, so this method causes this error and it's only purpose is the handling
    // of cr characters. if we wouldn't catch this, a failure in one of these methods
    // would cover other errors.
    try {
      return super.getOutput();
    } catch (NullPointerException ex) {
      return "";
    }
  }

  /**
   * Creates the Test Environment before execution of a test case
   */
  @Override
  public void setUp() throws Exception {
    this._testWorkspace = new TestDirectory();
  }

  /**
   * Disposes the test environment and resets the {@link ServiceRegistry}
   */
  @Override
  protected void tearDown() throws Exception {
    super.tearDown();
    this._testWorkspace.dispose();
    if (ServiceRegistryAccess.isConfigured()) {
      ServiceRegistryAccess.reset();
    }
  }

  /**
   * Returns the name of the build file for a test case.
   * 
   * <p>
   * The build file must stay in the same folder as the test class
   * 
   * @param unqualifiedName
   *          The name of the build file without folders
   * @return The name of the build file
   */
  private String getProjectBuildFile(String unqualifiedName) {
    return getClass().getPackage().getName().replace('.', '/') + "/" + unqualifiedName;
  }

  /**
   * @todo [17-Dec-2009:KASI] Why do we need that ? Is the text checked anywhere ?
   */
  @Override
  protected void runTest() throws Throwable {
    try {
      super.runTest();
    } catch (ComparisonFailure f) {
      throw f;
    } catch (Throwable t) {
      System.err.println(getName() + " throws exception (" + t + "). Output:");
      System.err.println(getError());
      throw t;
    }
  }

  /**
   * Copies the given build.xml-file from the classpath to the testenvironment's root directory and configures the ant
   * project
   * 
   * <p>
   * This methods sets the build project property <tt>workspaceDir</tt> to the workspace directory
   * 
   * @param unqualifiedBuildFileName
   *          the unqualified name of the build file, that must be accessible from classpath
   * @throws Exception
   * @see {@link #configureProject(String)}
   */
  protected void setupBuildFile(String unqualifiedBuildFileName) throws Exception {
    setupBuildFile(unqualifiedBuildFileName, Project.MSG_DEBUG);
  }

  /**
   * Copies the given build.xml-file from the classpath to the testenvironment's root directory and configures the ant
   * project
   * 
   * <p>
   * This methods sets the build project property <tt>workspaceDir</tt> to the workspace directory
   * 
   * @param unqualifiedBuildFileName
   *          the unqualified name of the build file, that must be accessible from classpath
   * @param priority
   *          the ant priority used for the logs.
   * @throws Exception
   * @see {@link #configureProject(String)}
   */
  protected void setupBuildFile(String unqualifiedBuildFileName, int priority) throws Exception {
    String qualifiedBuildFileName = getProjectBuildFile(unqualifiedBuildFileName);
    StringBuffer buffer = Utilities.readTextContent("/" + qualifiedBuildFileName, Utilities.ENCODING, true);
    String buildFileContent = buffer.toString();
    File buildFile = this._testWorkspace.createFile(unqualifiedBuildFileName, buildFileContent);
    configureProject(buildFile.getAbsolutePath(), priority);
    getProject().setProperty("workspaceDir", this._testWorkspace.getRootDir().getAbsolutePath());
  }

  /**
   * Returns a {@link TestDirectory} for this test case.
   * 
   * @return
   */
  protected TestDirectory getTestWorkspace() {
    return this._testWorkspace;
  }

  public File getTestWorkspaceDirectory() {
    return this._testWorkspace.getRootDir();
  }

  public void expectLogMatches(String target, String regExp) {

    executeTarget(target);

    String realLog = getLog();

    Pattern patter = Pattern.compile(regExp);
    Matcher matcher = patter.matcher(target);

    assertTrue("expecting log to match \"" + regExp + "\" log was \"" + realLog + "\"", matcher.matches());
  }

}