Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.almis.awe.testing.extensions.SeleniumExtension Maven / Gradle / Ivy
package com.almis.awe.testing.extensions;
import com.almis.awe.testing.config.AweTestConfigProperties;
import com.almis.awe.testing.model.SeleniumModel;
import com.almis.awe.testing.recorder.SeleniumRecorderFactory;
import com.almis.awe.testing.utilities.TextUtilities;
import com.automation.remarks.video.recorder.IVideoRecorder;
import com.automation.remarks.video.recorder.VideoRecorder;
import io.github.bonigarcia.wdm.WebDriverManager;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.junit.jupiter.api.extension.*;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.Point;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.chrome.ChromeOptions;
import org.openqa.selenium.edge.EdgeDriver;
import org.openqa.selenium.edge.EdgeOptions;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.firefox.FirefoxDriverLogLevel;
import org.openqa.selenium.firefox.FirefoxOptions;
import org.openqa.selenium.firefox.FirefoxProfile;
import org.openqa.selenium.ie.InternetExplorerDriver;
import org.openqa.selenium.remote.CapabilityType;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.safari.SafariOptions;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.file.Paths;
import java.text.SimpleDateFormat;
import java.util.*;
/**
* Utilities suite for selenium testing
*/
@Slf4j
public class SeleniumExtension implements AfterAllCallback, BeforeEachCallback, AfterEachCallback, TestInstancePostProcessor {
public static final String VIDEO_SCREEN_SIZE = "video.screen.size";
public static final String WD_HUB = "/wd/hub";
private final SeleniumModel seleniumModel = new SeleniumModel();
private WebDriver driver;
private WebDriverManager webDriverManager;
private IVideoRecorder recorder;
/**
* Clean driver after a test suite
*/
@Override
public void afterAll(ExtensionContext extensionContext) {
if (driver != null) {
log.info("Disposing web driver...");
driver.quit();
driver = null;
log.info("Web driver disposed");
}
if (webDriverManager != null) {
log.info("Disposing web driver manager...");
webDriverManager.quit();
log.info("Web driver manager disposed");
}
}
/**
* Initialize test driver
*
* @param extensionContext Extension context
* @throws MalformedURLException Malformed URL
*/
private void initializeDriver(ExtensionContext extensionContext) throws MalformedURLException {
// Setup window size
AweTestConfigProperties properties = seleniumModel.getProperties();
String windowSize = "--window-size=" + properties.getBrowserWidth() + "," + properties.getBrowserHeight();
log.info("Selected browser is {}, window size: {}x{}", properties.getBrowser(), properties.getBrowserWidth(), properties.getBrowserHeight());
log.debug("{}", seleniumModel);
// Setup firefox options
FirefoxProfile firefoxProfile = new FirefoxProfile();
firefoxProfile.setPreference("network.proxy.no_proxies_on", "localhost, 127.0.0.1");
// Set profile to accept untrusted certificates
firefoxProfile.setAcceptUntrustedCertificates(true);
// Set profile to not assume certificate issuer is untrusted
firefoxProfile.setAssumeUntrustedCertificateIssuer(false);
//Set download location and file types
firefoxProfile.setPreference("browser.download.folderList",2);
firefoxProfile.setPreference("browser.download.manager.showWhenStarting", false);
firefoxProfile.setPreference("browser.helperApps.neverAsk.saveToDisk","text/csv,application/pdf,application/csv,application/vnd.ms-excel");
firefoxProfile.setPreference("browser.download.start_downloads_in_tmp_dir", true);
// Set to false so popup not displayed when download finished.
firefoxProfile.setPreference("browser.download.manager.showAlertOnComplete", false);
firefoxProfile.setPreference("browser.download.panel.shown", false);
firefoxProfile.setPreference("browser.download.useToolkitUI", true);
// Set this to true to disable the pdf opening
firefoxProfile.setPreference("pdfjs.disabled", true);
FirefoxOptions firefoxOptions = new FirefoxOptions()
.setProfile(firefoxProfile)
.addArguments(windowSize)
.setLogLevel(FirefoxDriverLogLevel.ERROR);
// Setup chrome options
ChromeOptions chromeOptions = new ChromeOptions()
.addArguments("start-maximized")
.addArguments("--no-sandbox")
.addArguments("--disable-dev-shm-usage")
.addArguments("--disable-gpu")
.addArguments("--remote-allow-origins=*")
.addArguments(windowSize);
// Setup edge options
EdgeOptions edgeOptions = new EdgeOptions();
edgeOptions.setCapability(CapabilityType.ACCEPT_INSECURE_CERTS, true);
Map map = new HashMap<>();
map.put("args", Arrays.asList("--no-sandbox", "--disable-dev-shm-usage", "--disable-gpu", "--whitelisted-ips=", "--allowed-origins='*'"));
edgeOptions.setCapability("ms:edgeOptions", map);
// Set video folder property
System.setProperty("video.folder", properties.getScreenshotPath());
System.setProperty("video.file.extension", properties.getVideoFormat().getVideoExtension());
System.setProperty(VIDEO_SCREEN_SIZE, String.format("%dx%d", properties.getBrowserWidth(), properties.getBrowserHeight()));
// Define browser web driver container
switch (properties.getBrowser()) {
case HEADLESS_FIREFOX:
firefoxOptions.addArguments("--headless");
driver = getFirefoxDriver(firefoxOptions);
break;
case HEADLESS_CHROME:
chromeOptions.setHeadless(true);
driver = getChromeDriver(chromeOptions);
break;
case REMOTE_FIREFOX:
webDriverManager = WebDriverManager.firefoxdriver();
driver = getDockerDriver(webDriverManager, seleniumModel, extensionContext.getDisplayName(), firefoxOptions);
break;
case REMOTE_CHROME:
webDriverManager = WebDriverManager.chromedriver();
driver = getDockerDriver(webDriverManager, seleniumModel, extensionContext.getDisplayName(), chromeOptions);
break;
case SERVICE_FIREFOX:
driver = getRemoteDriver(seleniumModel, firefoxOptions, WD_HUB);
break;
case SERVICE_CHROME:
driver = getRemoteDriver(seleniumModel, chromeOptions, "");
break;
case SERVICE_EDGE:
driver = getRemoteDriver(seleniumModel, edgeOptions, WD_HUB);
break;
case SERVICE_OPERA:
chromeOptions.setBinary(new File("/path/to/opera"));
driver = getRemoteDriver(seleniumModel, chromeOptions, "");
break;
case SERVICE_SAFARI:
driver = getRemoteDriver(seleniumModel, new SafariOptions(), WD_HUB);
break;
case OPERA:
WebDriverManager.operadriver().setup();
// The Opera driver does not support w3c syntax, so we recommend using chromedriver to work with Opera
chromeOptions.setBinary(new File("/path/to/opera"));
driver = new ChromeDriver(chromeOptions);
break;
case EDGE:
WebDriverManager.edgedriver().setup();
driver = new EdgeDriver(edgeOptions);
break;
case IE:
WebDriverManager.iedriver().setup();
driver = new InternetExplorerDriver();
break;
case FIREFOX:
driver = getFirefoxDriver(firefoxOptions);
break;
case CHROME:
default:
driver = getChromeDriver(chromeOptions);
break;
}
// Set dimension if defined
driver.manage().window().setSize(new Dimension(
properties.getBrowserWidth(),
properties.getBrowserHeight()));
// Set selenium model
seleniumModel
.setDriver(driver)
.setWebDriverManager(webDriverManager);
}
private WebDriver getChromeDriver(ChromeOptions options) {
WebDriverManager.chromedriver().setup();
return new ChromeDriver(options);
}
private WebDriver getFirefoxDriver(FirefoxOptions options) {
WebDriverManager.chromedriver().setup();
return new FirefoxDriver(options);
}
private WebDriver getDockerDriver(WebDriverManager driverManager, SeleniumModel model, String name, Capabilities capabilities) {
final AweTestConfigProperties properties = model.getProperties();
driverManager
.browserInDocker().enableRecording().dockerRecordingOutput(Paths.get(properties.getScreenshotPath()))
.dockerRecordingPrefix(name + "-")
.capabilities(capabilities)
.dockerScreenResolution(properties.getBrowserWidth() + "x" + properties.getBrowserHeight() + "x24");
properties.setRemoteBrowser(true);
properties.setAllowedRecording(false);
return driverManager.create();
}
private RemoteWebDriver getRemoteDriver(SeleniumModel model, Capabilities capabilities, String browserHubPath) throws MalformedURLException {
final AweTestConfigProperties properties = model.getProperties();
System.setProperty("isDocker", properties.getRecorderUrl() == null ? "browser" : "browserRecorder");
URL url = new URL(String.format("http://%s:%d%s", properties.getBrowserHost(), properties.getBrowserPort(), browserHubPath));
log.info("{} URL is {}", properties.getBrowser(), url);
RemoteWebDriver webDriver = new RemoteWebDriver(url, capabilities, false);
Point position = new Point(0, 0);
Dimension dimension = new Dimension(properties.getBrowserWidth(), properties.getBrowserHeight());
webDriver.manage().window().setPosition(position);
webDriver.manage().window().setSize(dimension);
System.setProperty("ffmpeg.display", String.format("%s:%d+%d,%d", Optional.ofNullable(properties.getBrowserContainer())
.filter(StringUtils::isNotBlank)
.orElse(properties.getBrowserHost()), properties.getBrowserDisplay(), position.x, position.y));
System.setProperty("video.recorder.url", properties.getRecorderUrl());
properties.setRemoteBrowser(true);
return webDriver;
}
@Override
public void beforeEach(ExtensionContext extensionContext) throws Exception {
// If driver has been initialized, return
if (driver == null) {
initializeDriver(extensionContext);
}
// Set test title
seleniumModel.setTestTitle(extensionContext.getDisplayName());
// Check recording
if (seleniumModel.getProperties().isAllowedRecording()) {
this.recorder = SeleniumRecorderFactory.getRecorder(VideoRecorder.conf().recorderType());
this.recorder.start();
}
}
@Override
public void afterEach(ExtensionContext extensionContext) {
boolean testFailed = extensionContext.getExecutionException().isPresent();
if (seleniumModel.getProperties().isAllowedRecording()) {
log.debug("Storing video recording...");
String fileName = String.format("%s-%s-%s%s-%s",
extensionContext.getParent().orElse(extensionContext).getDisplayName(),
new SimpleDateFormat("dd-MM-yyyy_hh-mm-ss").format(new Date()),
testFailed ? "[ERR0R]-" : "",
TextUtilities.sanitizeMessage(seleniumModel.getCurrentOption()),
TextUtilities.sanitizeMessage(seleniumModel.getTestTitle()));
File result = this.recorder.stopAndSave(fileName);
if (testFailed || "ALL".equalsIgnoreCase(seleniumModel.getProperties().getVideoSave().toString())) {
log.info("{}Video recording stored at {}", testFailed ? "Test failed. " : "", result.getAbsolutePath());
} else {
// Remove video file if test not failed
result.deleteOnExit();
}
}
}
@Override
public void postProcessTestInstance(Object testInstance, ExtensionContext extensionContext) throws Exception {
testInstance.getClass()
.getMethod("setSeleniumModel", SeleniumModel.class)
.invoke(testInstance, seleniumModel);
}
}
