/*
* Copyright 2009 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.jstestdriver;
import static com.google.inject.multibindings.Multibinder.newSetBinder;
import java.io.File;
import java.io.PrintStream;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Preconditions;
import com.google.gson.JsonArray;
import com.google.inject.AbstractModule;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.google.inject.TypeLiteral;
import com.google.inject.assistedinject.FactoryProvider;
import com.google.inject.multibindings.Multibinder;
import com.google.inject.name.Names;
import com.google.jstestdriver.action.ConfigureGatewayAction;
import com.google.jstestdriver.annotations.BrowserCount;
import com.google.jstestdriver.browser.BrowserControl;
import com.google.jstestdriver.browser.BrowserControl.BrowserControlFactory;
import com.google.jstestdriver.browser.BrowserRunner;
import com.google.jstestdriver.config.DefaultConfiguration;
import com.google.jstestdriver.guice.BrowserActionProvider;
import com.google.jstestdriver.guice.FlagsModule;
import com.google.jstestdriver.hooks.ServerListener;
import com.google.jstestdriver.hooks.TestListener;
import com.google.jstestdriver.model.BasePaths;
import com.google.jstestdriver.output.MultiTestResultListener;
/**
* Guice module for configuring JsTestDriver.
*
* @author corysmith
*
*/
public class JsTestDriverModule extends AbstractModule {
private static final Logger logger =
LoggerFactory.getLogger(JsTestDriverModule.class);
private final Flags flags;
private final Set<FileInfo> fileSet;
private final String serverAddress;
private final String captureAddress;
private final PrintStream outputStream;
private final BasePaths basePaths;
private final long testSuiteTimeout;
private final List<FileInfo> tests;
private final List<FileInfo> plugins;
private final JsonArray gatewayConfig;
public JsTestDriverModule(Flags flags,
Set<FileInfo> fileSet,
String serverAddress,
String captureAddress,
PrintStream outputStream,
File basePath) {
this(flags,
fileSet,
serverAddress,
captureAddress,
outputStream,
new BasePaths(basePath),
DefaultConfiguration.DEFAULT_TEST_TIMEOUT,
Collections.<FileInfo>emptyList(),
Collections.<FileInfo>emptyList(),
new JsonArray());
}
public JsTestDriverModule(Flags flags,
Set<FileInfo> fileSet,
String serverAddress,
String captureAddress,
PrintStream outputStream,
BasePaths basePaths,
long testSuiteTimeout,
List<FileInfo> tests,
List<FileInfo> plugins,
JsonArray gatewayConfig) {
this.flags = flags;
this.fileSet = fileSet;
this.serverAddress = serverAddress;
this.captureAddress = captureAddress;
this.outputStream = outputStream;
this.basePaths = basePaths;
this.testSuiteTimeout = testSuiteTimeout;
this.tests = tests;
this.plugins = plugins;
this.gatewayConfig = gatewayConfig;
}
@Override
protected void configure() {
if (logger.isDebugEnabled()) {
logger.debug("Configured with:\n"
+ "flags:{}\n"
+ "Files:{}\n"
+ "server:{}\n"
+ "captureAddress:{}\n"
+ "outputStream:{}\n"
+ "basePath:{}\n"
+ "testSuiteTimeout:{}\n"
+ "tests:{}\n"
+ "plugins:{}\n"
+ "gateway:{}", new Object[]{
flags,
fileSet,
serverAddress,
captureAddress,
outputStream,
basePaths,
testSuiteTimeout,
tests,
plugins,
gatewayConfig
});
}
bind(PrintStream.class)
.annotatedWith(Names.named("outputStream")).toInstance(outputStream);
Preconditions.checkArgument(serverAddress != null
&& serverAddress.length() > 0
&& serverAddress.startsWith("http"),
"The server address cannot be empty, null, or missing the protocol:" + serverAddress);
bind(String.class)
.annotatedWith(Names.named("server")).toInstance(serverAddress);
bind(String.class)
.annotatedWith(Names.named("captureAddress")).toInstance(captureAddress);
bind(new TypeLiteral<Set<FileInfo>>() {}).annotatedWith(Names.named("originalFileSet"))
.toInstance(fileSet);
bind(new TypeLiteral<List<Action>>(){}).toProvider(ActionListProvider.class);
bind(new TypeLiteral<List<BrowserAction>>(){}).toProvider(BrowserActionProvider.class);
bind(ExecutorService.class).toInstance(Executors.newScheduledThreadPool(10));
bind(FailureAccumulator.class).in(Singleton.class);
bind(Long.class).annotatedWith(Names.named("testSuiteTimeout")).toInstance(testSuiteTimeout);
bind(BasePaths.class).toInstance(basePaths);
install(new FlagsModule(flags));
install(new ActionFactoryModule());
for (BrowserRunner runner : flags.getBrowser()) {
Multibinder.newSetBinder(binder(),
BrowserRunner.class).addBinding().toInstance(runner);
}
bind(Time.class).to(TimeImpl.class);
bind(new TypeLiteral<Set<FileInfo>>() {}).annotatedWith(Names.named("fileSet"))
.toProvider(FileSetProvider.class).in(Singleton.class);
bind(new TypeLiteral<List<FileInfo>>() {}).annotatedWith(Names.named("tests"))
.toInstance(tests);
bind(new TypeLiteral<List<FileInfo>>() {}).annotatedWith(Names.named("plugins"))
.toInstance(plugins);
bind(Integer.class).annotatedWith(BrowserCount.class).
toProvider(BrowserCountProvider.class).in(Singleton.class);
bind(JsonArray.class).annotatedWith(Names.named("gateway")).toInstance(
gatewayConfig);
Multibinder.newSetBinder(binder(), ServerListener.class);
bind(ConfigureGatewayAction.Factory.class).toProvider(
FactoryProvider.newFactory(ConfigureGatewayAction.Factory.class,
ConfigureGatewayAction.class));
bind(JsTestDriverServer.Factory.class).toProvider(
FactoryProvider.newFactory(JsTestDriverServer.Factory.class, JsTestDriverServerImpl.class));
bind(BrowserControlFactory.class).toProvider(
FactoryProvider.newFactory(BrowserControlFactory.class, BrowserControl.class));
bind(TestListener.class).to(MultiTestResultListener.class);
newSetBinder(binder(),
ResponseStreamFactory.class).addBinding().to(DefaultResponseStreamFactory.class);
}
/**
* Provides the number of browsers. Needed by any code that is aware of the threading model for
* running tests in multiple browsers.
*
* @author alexeagle@google.com (Alex Eagle)
*/
public static class BrowserCountProvider implements Provider<Integer> {
private final JsTestDriverClient client;
@Inject
public BrowserCountProvider(JsTestDriverClient client) {
this.client = client;
}
@Override
public synchronized Integer get() {
try {
return client.listBrowsers().size();
} catch (Exception e) {
throw new RuntimeException("Cannot inject the browser count until the server has started." +
" Try injecting a Provider of it instead.", e);
}
}
}
}