org.dstadler.commons.selenium.ChromeDriverUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-dost Show documentation
Show all versions of commons-dost Show documentation
Common utilities I find useful in many of my projects.
package org.dstadler.commons.selenium;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.exec.CommandLine;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.SystemUtils;
import org.dstadler.commons.exec.ExecutionHelper;
import org.dstadler.commons.logging.jdk.LoggerFactory;
import org.dstadler.commons.util.SuppressForbidden;
import org.dstadler.commons.zip.ZipUtils;
/**
* Utility for downloading the matching version of the
* Selenium ChromeDriver for the locally installed version
* of Chrome.
*
* When using Selenium, it uses the ChromeDriver to talk to
* the locally installed Chrome browser.
*
* Usually you need to manually download the matching version
* of the chrome-driver binary and put it in place.
*
* This class automates this by determining the local version
* of the chrome-browser (by execution it with "--version") and
* then looking for the matching version of chrome-driver on
* this page
*/
public class ChromeDriverUtils {
private static final Logger log = LoggerFactory.make();
public static final String PROPERTY_CHROME_DRIVER = "webdriver.chrome.driver";
public static final String VERSION_JSON =
"https://googlechromelabs.github.io/chrome-for-testing/known-good-versions-with-downloads.json";
// "https://googlechromelabs.github.io/chrome-for-testing/last-known-good-versions-with-downloads.json";
/**
* Check which version of chrome is installed and based on its version
* try to fetch the matching chromedriver and configure it via system
* properties.
*
* @throws java.io.IOException If fetching data or storing data in files fails.
*/
public static void configureMatchingChromeDriver() throws IOException {
configureMatchingChromeDriver(getGoogleChromeVersion());
}
/**
* For a given major version of chrome, try to fetch the matching chromedriver
* and configure it via system properties.
*
* @param chromeVersion The version of chrome, e.g. "100" or "101.0.4951.54"
* @throws java.io.IOException If fetching data or storing data in files fails.
*/
public static void configureMatchingChromeDriver(String chromeVersion) throws IOException {
checkState(StringUtils.isNotBlank(chromeVersion), "Need a version of chrome to configure, but had '" +
chromeVersion + "'");
// See https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection
//
// https://chromedriver.storage.googleapis.com/LATEST_RELEASE_91.0.4472.77
// 91.0.4472.19
// https://chromedriver.storage.googleapis.com/index.html?path=91.0.4472.19/
// https://chromedriver.storage.googleapis.com/91.0.4472.19/chromedriver_linux64.zip
// https://chromedriver.storage.googleapis.com/91.0.4472.19/chromedriver_win32.zip
String versionUrl = getVersionUrl(chromeVersion);
String driverVersion = null;
String downloadUrl;
try {
try {
driverVersion = IOUtils.toString(new URL(versionUrl), StandardCharsets.UTF_8);
checkState(StringUtils.isNotBlank(driverVersion),
"Did not find a chrome-driver-version for " + chromeVersion + " at " + versionUrl);
downloadUrl = "https://chromedriver.storage.googleapis.com/" + driverVersion + "/chromedriver_" +
(SystemUtils.IS_OS_WINDOWS ? "win32.zip" : "linux64.zip");
} catch (FileNotFoundException e) {
// try to fetch versions via a JSON file if the old way fails to find the version
String versionJson = IOUtils.toString(new URL(VERSION_JSON), StandardCharsets.UTF_8);
// match the latest build with that version
// https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing/115.0.5790.170/linux64/chromedriver-linux64.zip
// https://storage.googleapis.com/chrome-for-testing-public/121.0.6167.0/linux64/chromedriver-linux64.zip
Matcher matcher = Pattern.
compile( "https://(edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing|storage.googleapis.com/chrome-for-testing-public)/(" + chromeVersion + "[0-9.]+)/linux64/chromedriver-linux64.zip").
matcher(versionJson);
// iterate over all matches to use the latest versions
String url = null;
while (matcher.find()) {
driverVersion = matcher.group(2);
url = matcher.group(1);
}
if (driverVersion == null) {
throw new IOException("Failed for " + VERSION_JSON + " and " + versionJson + ", previous exception: " + e);
}
checkState(StringUtils.isNotBlank(driverVersion),
"Did not find a chrome-driver-version for " + chromeVersion + " at " + versionUrl);
downloadUrl = "https://" + url + "/" + driverVersion +
(SystemUtils.IS_OS_WINDOWS ?
"/win64/chromedriver-win64.zip" :
"/linux64/chromedriver-linux64.zip");
}
} catch (IOException e) {
throw new IOException("Failed for " + versionUrl, e);
}
File chromeDriverFile = new File("chromedriver-" + driverVersion +
(SystemUtils.IS_OS_WINDOWS ? ".exe" : ""));
// download the driver if not available locally yet
if (!chromeDriverFile.exists()) {
log.info("Downloading matching chromedriver from " + downloadUrl +
" and extracting to " + chromeDriverFile);
File fileZip = File.createTempFile("chromedriver", ".zip");
try {
FileUtils.copyURLToFile(new URL(downloadUrl), fileZip);
// unzip the driver-files to the local directory
ZipUtils.extractZip(fileZip, new File("."));
// rename them to the proper version-name
try {
FileUtils.moveFile(new File("chromedriver" +
(SystemUtils.IS_OS_WINDOWS ? ".exe" : "")), chromeDriverFile);
} catch (FileNotFoundException e) {
// try 2nd location in newer downloads
FileUtils.moveFile(new File(SystemUtils.IS_OS_WINDOWS ?
"chromedriver-win64/chromedriver.exe" :
"chromedriver-linux64/chromedriver"), chromeDriverFile);
}
} finally {
FileUtils.delete(fileZip);
FileUtils.deleteDirectory(new File("chromedriver-win64"));
FileUtils.deleteDirectory(new File("chromedriver-linux64"));
}
}
// make sure the binary is executable
if (!chromeDriverFile.canExecute()) {
if (!chromeDriverFile.setExecutable(true)) {
throw new IOException("Could not make binary " + chromeDriverFile + " executable.");
}
}
log.info("Using chromedriver from " + chromeDriverFile.getAbsolutePath());
System.setProperty(PROPERTY_CHROME_DRIVER, chromeDriverFile.getAbsolutePath());
}
protected static String getVersionUrl(String chromeVersion) {
return "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_" + chromeVersion;
}
/**
* Call 'google-chrome-stable --version' and parse the output to
* get the current available version of the Chrome browser.
*
* @return A string with the full version of the locally installed Chrome
* browser, e.g. '91.0.4472.77'
* @throws java.io.IOException If executing chrome fails.
*/
protected static String getGoogleChromeVersion() throws IOException {
ByteArrayOutputStream out = new ByteArrayOutputStream();
// Google Chrome 91.0.4472.77
String version;
if (SystemUtils.IS_OS_WINDOWS) {
CommandLine cmdLine = new CommandLine("reg");
cmdLine.addArgument("query");
cmdLine.addArgument("\"HKEY_CURRENT_USER\\Software\\Google\\Chrome\\BLBeacon\"");
cmdLine.addArgument("/v");
cmdLine.addArgument("version");
ExecutionHelper.getCommandResultIntoStream(cmdLine, new File("."), 0, 10_000, out);
// cut out the leading text
version = out.toString().replace("HKEY_CURRENT_USER\\Software\\Google\\Chrome\\BLBeacon", "").
replace("version", "").
replace("REG_SZ", "").
trim();
} else {
CommandLine cmdLine = new CommandLine("google-chrome-stable");
cmdLine.addArgument("--version");
try {
ExecutionHelper.getCommandResultIntoStream(cmdLine, new File("."), 0, 10_000, out);
// cut out the leading text
version = StringUtils.removeStart(out.toString(), "Google Chrome ").trim();
} finally {
out.close();
log.info("Having result from calling '" + cmdLine + "': " + out.toString(StandardCharsets.UTF_8).trim());
}
}
if (version.isBlank()) {
throw new RuntimeException("Received empty version for Google Chrome, cannot determine version. "
+ "Had: '" + version + "' and '" + out + "'");
}
// cut off the trailing patch-level
try {
version = version.substring(0, version.lastIndexOf('.'));
} catch (RuntimeException e) {
throw new RuntimeException("Failed for '" + out + "'", e);
}
log.info("Found Google Chrome version '" + version + "' from running with --version: '" + out.toString().trim() + "'");
return version;
}
/**
* Clean up any system property or otherwise held information.
*/
@SuppressForbidden(reason = "This is provided on purpose here")
protected static void cleanUp() {
System.clearProperty(PROPERTY_CHROME_DRIVER);
}
private static void checkState(boolean expression, Object errorMessage) {
if (!expression) {
throw new IllegalStateException(String.valueOf(errorMessage));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy