GuiceBerryModule.java

/*
 * Copyright (C) 2008 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;

import com.google.common.testing.TearDown;
import com.google.common.testing.TearDownAccepter;
import com.google.common.testing.TearDownStack;
import com.google.guiceberry.GuiceBerryUniverse;
import com.google.guiceberry.TestScope;
import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.google.inject.Scope;

/**
 * This Module provides the basic bindings required by GuiceBerry, namely
 * {@link TestId}, {@link TearDownAccepter} and the {@link TestScoped} scope.
 * Without these bindings, GuiceBerry will fail to set up. Therefore, this
 * module is required to be installed by all GuiceBerry Envs (see
 * {@link GuiceBerryEnvSelector}).
 *
 * @author Luiz-Otavio "Z" Zorzella
 */
//NOTE TO DEVELOPERS: when adding a binding here, make sure it's also declared
// in GuiceBerryUniverse.REQUIRED_BINDINGS.
public class GuiceBerryModule extends AbstractModule {
    
  final GuiceBerryUniverse universe;
  
  public GuiceBerryModule() {
    this(GuiceBerryUniverse.INSTANCE);
  }
  
  /**
   * Builds a new instance of a {@link TestScope}.
   */
  // TODO: this will be unnecessary once this issue is fixed:
  // http://code.google.com/p/google-guice/issues/detail?id=687
  public Scope buildTestScope() {
    return new TestScope(universe);
  }
  
  protected GuiceBerryModule(GuiceBerryUniverse universe) {
    this.universe = universe;
  }
  
  @Override
  protected void configure() {
    TestScope testScope = new TestScope(universe);
    bind(TestScope.class).toInstance(testScope);
    bindScope(TestScoped.class, testScope);
    bind(TearDownAccepter.class).to(ToTearDown.class);
  }

  @Provides
  @TestScoped
  ToTearDown getToTearDown() {
    return new ToTearDown() {
      TearDownStack delegate = new TearDownStack();
      
      public void addTearDown(TearDown tearDown) {
        delegate.addTearDown(tearDown);
      }
    
      public void runTearDown() {
        delegate.runTearDown();
      }
    };
  }
  
  @Provides
  @TestScoped
  TestId getTestId() {
    return universe.currentTestDescriptionThreadLocal.get().getTestId();
  }
  
  interface ToTearDown extends TearDownAccepter {
    void runTearDown();
  }
  
  @Override
  public boolean equals(Object obj) {
    if ((obj == null) || (!(obj instanceof GuiceBerryModule))) {
      return false;
    }
    GuiceBerryModule that = (GuiceBerryModule)obj;
    return this.universe == that.universe;
  }
  
  @Override
  public int hashCode() {
    return this.universe.hashCode();
  }
}