com.github.nscuro.wdm.binary.BinaryManager Maven / Gradle / Ivy
Show all versions of webdriver-manager Show documentation
package com.github.nscuro.wdm.binary;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.nscuro.wdm.Architecture;
import com.github.nscuro.wdm.Browser;
import com.github.nscuro.wdm.Os;
import com.github.nscuro.wdm.binary.chrome.ChromeDriverBinaryDownloader;
import com.github.nscuro.wdm.binary.edge.MicrosoftWebDriverBinaryDownloader;
import com.github.nscuro.wdm.binary.firefox.GeckoDriverBinaryDownloader;
import com.github.nscuro.wdm.binary.github.GitHubReleasesService;
import com.github.nscuro.wdm.binary.opera.OperaChromiumDriverBinaryDownloader;
import org.apache.http.client.HttpClient;
import org.apache.http.impl.client.HttpClients;
import javax.annotation.Nonnull;
import java.io.File;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;
public interface BinaryManager {
/**
* Get a webdriver binary for the given {@link Browser}, version, {@link Os} and {@link Architecture}
*
* When a binary for the given requirements is found locally,
* it will not be downloaded again.
*
* @param browser The browser to download the binary for
* @param version The version of the binary (not the browser version)
* @param os The operating system the binary must be compatible with
* @param architecture The architecture the binary must be compatible with
* @return A {@link File} handle of the downloaded binary
* @throws IOException When downloading the binary failed
*/
@Nonnull
File getBinary(final Browser browser, final String version, final Os os, final Architecture architecture) throws IOException;
/**
* Get a webdriver binary for the given {@link Browser} and version.
*
* This assumes that a binary for the current {@link Os} and {@link Architecture} is requested.
*
* When a binary for the given requirements is found locally,
* it will not be downloaded again.
*
* @param browser The browser to download the binary for
* @param version The version of the binary (not the browser version)
* @return A {@link File} handle of the downloaded binary
* @throws IOException When downloading the binary failed
* @see #getBinary(Browser, String, Os, Architecture)
*/
@Nonnull
default File getBinary(final Browser browser, final String version) throws IOException {
return getBinary(browser, version, Os.getCurrent(), Architecture.getCurrent());
}
/**
* Get the latest webdriver binary for the given {@link Browser}, {@link Os} and {@link Architecture}.
*
* When a binary for the given requirements is found locally,
* it will not be downloaded again.
*
* @param browser The browser to download the binary for
* @param os The operating system the binary must be compatible with
* @param architecture The architecture the binary must be compatible with
* @return A {@link File} handle of the downloaded binary
* @throws IOException When downloading the binary failed
* @see #getBinary(Browser, String, Os, Architecture)
*/
@Nonnull
default File getBinary(final Browser browser, final Os os, final Architecture architecture) throws IOException {
return getBinary(browser, "latest", os, architecture);
}
/**
* Get the latest webdriver binary for a given {@link Browser}.
*
* This assumes that a binary for the current {@link Os} and {@link Architecture} is requested.
*
* When a binary for the given requirements is found locally,
* it will not be downloaded again.
*
* @param browser The browser to download the binary for
* @return A {@link File} handle of the downloaded binary
* @throws IOException When downloading the binary failed
* @see #getBinary(Browser, String, Os, Architecture)
*/
@Nonnull
default File getBinary(final Browser browser) throws IOException {
return getBinary(browser, "latest");
}
/**
* Register a given binary file as the webdriver binary to use for a given {@link Browser}.
*
* @param binaryFile The binary file to register
* @param browser The {@link Browser} to register the binary for
*/
void registerBinary(final File binaryFile, final Browser browser);
/**
* Delete all downloaded binary files.
*/
void cleanUp();
static BinaryManager createDefault() {
return builder()
.defaultHttpClient()
.addDefaultBinaryDownloaders()
.build();
}
static Builder.HttpClientStep builder() {
return Builder::new;
}
final class Builder {
@FunctionalInterface
public interface HttpClientStep {
/**
* Provide a custom {@link HttpClient} to use for the binary downloaders.
*
* @param httpClient The http client to use
* @return A {@link Builder} instance
*/
Builder httpClient(final HttpClient httpClient);
/**
* Use a default {@link HttpClient} that has been tested with
* built-in binary downloaders and should work for the vast majority of users.
*
* @return A {@link Builder} instance
*/
default Builder defaultHttpClient() {
final HttpClient httpClient = HttpClients.custom()
.setUserAgent("Mozilla/5.0")
.disableAuthCaching()
.disableCookieManagement()
.build();
return httpClient(httpClient);
}
}
private final HttpClient httpClient;
private final GitHubReleasesService gitHubReleasesService;
private Set binaryDownloaders;
private Builder(final HttpClient httpClient) {
this.httpClient = httpClient;
this.gitHubReleasesService = GitHubReleasesService.create(httpClient, new ObjectMapper());
binaryDownloaders = new HashSet<>();
}
/**
* Add the {@link ChromeDriverBinaryDownloader}.
*
* @return A {@link Builder} instance
*/
public Builder addChromeDriverBinaryDownloader() {
binaryDownloaders.add(new ChromeDriverBinaryDownloader(httpClient));
return this;
}
/**
* Add the {@link GeckoDriverBinaryDownloader}.
*
* @return A {@link Builder} instance
*/
public Builder addGeckoDriverBinaryDownloader() {
binaryDownloaders.add(new GeckoDriverBinaryDownloader(gitHubReleasesService));
return this;
}
/**
* Add the {@link OperaChromiumDriverBinaryDownloader}.
*
* @return A {@link Builder} instance
*/
public Builder addOperaChromiumDriverBinaryDownloader() {
binaryDownloaders.add(new OperaChromiumDriverBinaryDownloader(gitHubReleasesService));
return this;
}
/**
* Add the {@link MicrosoftWebDriverBinaryDownloader}.
*
* @return A {@link Builder} instance
*/
public Builder addMicrosoftWebDriverBinaryDownloader() {
binaryDownloaders.add(new MicrosoftWebDriverBinaryDownloader(httpClient));
return this;
}
/**
* Add a custom {@link BinaryDownloader}.
*
* @param binaryDownloader The binary downloader to add
* @return A {@link Builder} instance
*/
public Builder addBinaryDownloader(final BinaryDownloader binaryDownloader) {
binaryDownloaders.add(binaryDownloader);
return this;
}
/**
* Add all default {@link BinaryDownloader}s.
*
* This includes:
*
* - {@link ChromeDriverBinaryDownloader}
* - {@link GeckoDriverBinaryDownloader}
* - {@link OperaChromiumDriverBinaryDownloader}
* - {@link MicrosoftWebDriverBinaryDownloader}
*
*
* @return A {@link Builder} instance
*/
public Builder addDefaultBinaryDownloaders() {
return this
.addChromeDriverBinaryDownloader()
.addGeckoDriverBinaryDownloader()
.addOperaChromiumDriverBinaryDownloader()
.addMicrosoftWebDriverBinaryDownloader();
}
public BinaryManager build() {
return new BinaryManagerImpl(binaryDownloaders);
}
}
}