org.openqa.selenium.phantomjs.PhantomJSDriverService Maven / Gradle / Ivy

* Each service created by this method will be configured to find and use a free port on the current system. * * @return A new ChromeDriverService using the default configuration. */ public static PhantomJSDriverService createDefaultService(Capabilities desiredCapabilities) { // Look for Proxy configuration within the Capabilities Proxy proxy = null; if (desiredCapabilities != null) { proxy = (Proxy) desiredCapabilities.getCapability(CapabilityType.PROXY); } // Find PhantomJS executable File phantomjsfile = findPhantomJS(desiredCapabilities, PHANTOMJS_DOC_LINK, PHANTOMJS_DOWNLOAD_LINK); // Find GhostDriver main JavaScript file File ghostDriverfile = findGhostDriver(desiredCapabilities, GHOSTDRIVER_DOC_LINK, GHOSTDRIVER_DOWNLOAD_LINK); // Build & return service return new Builder().usingPhantomJSExecutable(phantomjsfile) .usingGhostDriver(ghostDriverfile) .usingAnyFreePort() .withProxy(proxy) .build(); } /** * Same as {@link PhantomJSDriverService#createDefaultService(org.openqa.selenium.Capabilities)}. *

* In this case PhantomJS or GhostDriver can't be searched within the Capabilities, only System * Properties. * * @return A new ChromeDriverService using the default configuration. */ public static PhantomJSDriverService createDefaultService() { return createDefaultService(null); } /** * Looks into the Capabilities, the current $PATH and the System Properties for * {@link PhantomJSDriverService#PHANTOMJS_EXECUTABLE_PATH_PROPERTY}. *

* NOTE: If the Capability, the $PATH and the System Property are set, the Capability takes * priority over the System Property, that in turn takes priority over the $PATH. * * @param desiredCapabilities Capabilities in which we will look for the path to PhantomJS * @param docsLink The link to the PhantomJS documentation page * @param downloadLink The link to the PhantomJS download page * @return The driver executable as a {@link File} object * @throws IllegalStateException If the executable not found or cannot be executed */ protected static File findPhantomJS(Capabilities desiredCapabilities, String docsLink, String downloadLink) { String phantomjspath = null; if (desiredCapabilities != null && desiredCapabilities.getCapability(PHANTOMJS_EXECUTABLE_PATH_PROPERTY) != null) { phantomjspath = (String) desiredCapabilities.getCapability(PHANTOMJS_EXECUTABLE_PATH_PROPERTY); } else { phantomjspath = CommandLine.find(PHANTOMJS_DEFAULT_EXECUTABLE); phantomjspath = System.getProperty(PHANTOMJS_EXECUTABLE_PATH_PROPERTY, phantomjspath); } checkState(phantomjspath != null, "The path to the driver executable must be set by the %s capability/system property/PATH variable;" + " for more information, see %s. " + "The latest version can be downloaded from %s", PHANTOMJS_EXECUTABLE_PATH_PROPERTY, docsLink, downloadLink); File phantomjs = new File(phantomjspath); checkExecutable(phantomjs); return phantomjs; } /** * Find the GhostDriver main file (i.e. "main.js"). *

* Looks into the Capabilities and the System Properties for * {@link PhantomJSDriverService#PHANTOMJS_GHOSTDRIVER_PATH_PROPERTY}. *

* NOTE: If both the Capability and the System Property are set, the Capability takes priority. * * @param desiredCapabilities Capabilities in which we will look for the path to GhostDriver * @param docsLink The link to the GhostDriver documentation page * @param downloadLink The link to the GhostDriver download page * @return The driver executable as a {@link File} object * @throws IllegalStateException If the executable not found or cannot be executed */ protected static File findGhostDriver(Capabilities desiredCapabilities, String docsLink, String downloadLink) { // Recover path to GhostDriver from the System Properties or the Capabilities String ghostdriverpath = null; if (desiredCapabilities != null && (String) desiredCapabilities.getCapability(PHANTOMJS_GHOSTDRIVER_PATH_PROPERTY) != null) { ghostdriverpath = (String) desiredCapabilities.getCapability(PHANTOMJS_GHOSTDRIVER_PATH_PROPERTY); } else { ghostdriverpath = System.getProperty(PHANTOMJS_GHOSTDRIVER_PATH_PROPERTY, ghostdriverpath); } if (ghostdriverpath != null) { checkState(ghostdriverpath != null, "The path to the driver executable must be set by the '%s' capability/system property;" + " for more information, see %s. " + "The latest version can be downloaded from %s", PHANTOMJS_GHOSTDRIVER_PATH_PROPERTY, docsLink, downloadLink); // Check few things on the file before returning it File ghostdriver = new File(ghostdriverpath); checkState(ghostdriver.exists(), "The GhostDriver does not exist: %s", ghostdriver.getAbsolutePath()); checkState(ghostdriver.isFile(), "The GhostDriver is a directory: %s", ghostdriver.getAbsolutePath()); checkState(ghostdriver.canRead(), "The GhostDriver is not a readable file: %s", ghostdriver.getAbsolutePath()); return ghostdriver; } // This means that no GhostDriver System Property nor Capability was set return null; } /** * Builder used to configure new {@link PhantomJSDriverService} instances. */ public static class Builder { private int port = 0; private File phantomjs = null; private File ghostdriver = null; private ImmutableMap environment = ImmutableMap.of(); private File logFile; private Proxy proxy = null; /** * Sets which PhantomJS executable the builder will use. * * @param file The executable to use. * @return A self reference. */ public Builder usingPhantomJSExecutable(File file) { checkNotNull(file); checkExecutable(file); this.phantomjs = file; return this; } /** * Sets which GhostDriver the builder will use. * * @param file The GhostDriver's main.js to use. * @return A self reference. */ public Builder usingGhostDriver(File file) { this.ghostdriver = file; return this; } /** * Sets which port the service should listen on. A value of 0 indicates that any free port * may be used. * * @param port The port to use; must be non-negative. * @return A self reference. */ public Builder usingPort(int port) { checkArgument(port >= 0, "Invalid port number: %d", port); this.port = port; return this; } /** * Configures the service to listen on any available port. * * @return A self reference. */ public Builder usingAnyFreePort() { this.port = 0; return this; } /** * Defines the environment for the service. These settings will be inherited by every * browser session launched by the service. * * @param environment A map of the environment variables to launch the service with. * @return A self reference. */ public Builder withEnvironment(Map environment) { this.environment = ImmutableMap.copyOf(environment); return this; } /** * Configures the service to write log to the given file. * * @param logFile A file to write log to. * @return A self reference. */ public Builder withLogFile(File logFile) { this.logFile = logFile; return this; } /** * Configures the service to use a specific Proxy configuration. *