ManualTearDownGuiceBerry.java

/*
 * Copyright (C) 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.guiceberry.junit3;

import com.google.common.testing.TearDown;
import com.google.guiceberry.DefaultEnvSelector;
import com.google.guiceberry.GuiceBerry;
import com.google.guiceberry.GuiceBerry.GuiceBerryWrapper;
import com.google.guiceberry.GuiceBerryEnvSelector;
import com.google.guiceberry.TestDescription;
import com.google.inject.Module;

import junit.framework.TestCase;

/**
 * {@link GuiceBerry} adapter for vanilla JUnit3 tests (i.e. {@link TestCase}s
 * that do not extend {@code TearDownTestCase}).
 *
 * @see AutoTearDownGuiceBerry
 * 
 * @author Luiz-Otavio "Z" Zorzella
 */
public class ManualTearDownGuiceBerry {

  /**
   * Calls {@link #setUp(TestCase, GuiceBerryEnvSelector)} passing a
   * {@link DefaultEnvSelector#of} the given {@code envClass}.
   *
   * <p>A canonical test will call this method in the its setUp method, and will
   * pass {@code this} as the testCase argument. It will then store the return
   * value to run it at its tearDown. See
   * {@link junit3.tutorial_0_basic.Example0HelloWorldTest#setUp()}.
   */
  public static TearDown setUp(
      TestCase testCase, 
      Class<? extends Module> envClass) {
    return setUp(testCase, DefaultEnvSelector.of(envClass));
  }
  
  /**
   * Sets up the {@code testCase} with the given {@code guiceBerryEnvSelector}
   * and returns a {@link TearDown} whose {@link TearDown#tearDown()} method
   * must be manually called (thus the "manual" moniker).
   *
   * @see #setUp(TestCase, Class)
   */
  public static TearDown setUp(
      TestCase testCase, 
      GuiceBerryEnvSelector guiceBerryEnvSelector) {
    final GuiceBerryWrapper setUpAndTearDown =
      GuiceBerry.INSTANCE.buildWrapper(buildTestDescription(testCase, testCase.getName()), 
          guiceBerryEnvSelector);
    setUpAndTearDown.runBeforeTest();
    return new TearDown() {
      
      public void tearDown() throws Exception {
        setUpAndTearDown.runAfterTest();
      }
    };
  }

  static TestDescription buildTestDescription(TestCase testCase, String methodName) {
    String testCaseName = testCase.getClass().getName();
    return new TestDescription(testCase, testCaseName + "." + methodName);
  }
}