org.openqa.grid.selenium.GridLauncher Maven / Gradle / Ivy
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you 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 org.openqa.grid.selenium;
import com.google.common.collect.ImmutableMap;
import org.openqa.grid.common.CommandLineOptionHelper;
import org.openqa.grid.common.GridDocHelper;
import org.openqa.grid.common.GridRole;
import org.openqa.grid.common.RegistrationRequest;
import org.openqa.grid.common.exception.GridConfigurationException;
import org.openqa.grid.internal.utils.GridHubConfiguration;
import org.openqa.grid.internal.utils.SelfRegisteringRemote;
import org.openqa.grid.web.Hub;
import org.openqa.selenium.remote.server.log.LoggingOptions;
import org.openqa.selenium.remote.server.log.TerseFormatter;
import org.openqa.selenium.server.SeleniumServer;
import org.openqa.grid.shared.CliUtils;
import java.io.File;
import java.io.IOException;
import java.util.logging.ConsoleHandler;
import java.util.logging.FileHandler;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;
public class GridLauncher {
private static final Logger log = Logger.getLogger(GridLauncher.class.getName());
public interface GridItemLauncher {
void launch(String[] args, Logger log) throws Exception;
void printUsage();
}
private static ImmutableMap launchers
= new ImmutableMap.Builder()
.put(GridRole.NOT_GRID, new GridItemLauncher() {
@Override
public void launch(String[] args, Logger log) throws Exception {
log.info("Launching a standalone Selenium Server");
SeleniumServer.main(args);
log.info("Selenium Server is up and running");
}
@Override
public void printUsage() {
String separator = "\n-------------------------------\n";
SeleniumServer.usage(separator + "Running as a standalone server:" + separator);
}
})
.put(GridRole.HUB, new GridItemLauncher() {
@Override
public void launch(String[] args, Logger log) throws Exception {
log.info("Launching Selenium Grid hub");
GridHubConfiguration c = GridHubConfiguration.build(args);
Hub h = new Hub(c);
h.start();
log.info("Nodes should register to " + h.getRegistrationURL());
log.info("Selenium Grid hub is up and running");
}
@Override
public void printUsage() {
String separator = "\n-------------------------------\n";
GridDocHelper.printHubHelp(separator + "Running as a grid hub:" + separator, false);
}
})
.put(GridRole.NODE, new GridItemLauncher() {
@Override
public void launch(String[] args, Logger log) throws Exception {
log.info("Launching a Selenium Grid node");
RegistrationRequest c = RegistrationRequest.build(args);
SelfRegisteringRemote remote = new SelfRegisteringRemote(c);
remote.setRemoteServer(new SeleniumServer(c.getConfiguration()));
remote.startRemoteServer();
log.info("Selenium Grid node is up and ready to register to the hub");
remote.startRegistrationProcess();
}
@Override
public void printUsage() {
String separator = "\n-------------------------------\n";
GridDocHelper.printNodeHelp(separator + "Running as a grid node:" + separator, false);
}
})
.build();
public static void main(String[] args) throws Exception {
CommandLineOptionHelper helper = new CommandLineOptionHelper(args);
GridRole role = GridRole.find(args);
if (role == null) {
printInfoAboutRoles(helper);
return;
}
if (helper.isParamPresent("-help") || helper.isParamPresent("-h")) {
if (launchers.containsKey(role)) {
launchers.get(role).printUsage();
} else {
printInfoAboutRoles(helper);
}
return;
}
configureLogging(helper);
if (launchers.containsKey(role)) {
try {
launchers.get(role).launch(args, log);
} catch (Exception e) {
launchers.get(role).printUsage();
e.printStackTrace();
}
} else {
throw new GridConfigurationException("Unknown role: " + role);
}
}
private static void printInfoAboutRoles(CommandLineOptionHelper helper) {
if (helper.hasParamValue("-role")) {
CliUtils.printWrappedLine(
"",
"Error: the role '" + helper.getParamValue("-role") + "' does not match a recognized server role\n");
} else {
CliUtils.printWrappedLine(
"",
"Error: -role option needs to be followed by the value that defines role of this component in the grid\n");
}
System.out.println(
"Selenium server can run in one of the following roles:\n" +
" hub as a hub of a Selenium grid\n" +
" node as a node of a Selenium grid\n" +
" standalone as a standalone server not being a part of a grid\n" +
"\n" +
"If -role option is omitted the server runs standalone\n");
CliUtils.printWrappedLine(
"",
"To get help on the options available for a specific role run the server"
+ " with -help option and the corresponding -role option value");
}
private static void configureLogging(CommandLineOptionHelper helper) {
Level logLevel =
helper.isParamPresent("-debug")
? Level.FINE
: LoggingOptions.getDefaultLogLevel();
if (logLevel == null) {
logLevel = Level.INFO;
}
Logger.getLogger("").setLevel(logLevel);
Logger.getLogger("org.openqa.jetty").setLevel(Level.WARNING);
String logFilename =
helper.isParamPresent("-log")
? helper.getParamValue("-log")
: LoggingOptions.getDefaultLogOutFile();
if (logFilename != null) {
for (Handler handler : Logger.getLogger("").getHandlers()) {
if (handler instanceof ConsoleHandler) {
Logger.getLogger("").removeHandler(handler);
}
}
try {
Handler logFile = new FileHandler(new File(logFilename).getAbsolutePath(), true);
logFile.setFormatter(new TerseFormatter(true));
logFile.setLevel(logLevel);
Logger.getLogger("").addHandler(logFile);
} catch (IOException e) {
throw new RuntimeException(e);
}
} else {
boolean logLongForm = helper.isParamPresent("-logLongForm");
for (Handler handler : Logger.getLogger("").getHandlers()) {
if (handler instanceof ConsoleHandler) {
handler.setLevel(logLevel);
handler.setFormatter(new TerseFormatter(logLongForm));
}
}
}
}
}