This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
/
WebDriverFactory.java
194 lines (171 loc) · 7.14 KB
/
WebDriverFactory.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
* Copyright 2010, Red Hat, Inc. and individual contributors as indicated by the
* @author tags. See the copyright.txt file in the distribution for a full
* listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This software is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this software; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
* site: http://www.fsf.org.
*/
package org.zanata.page;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriverService;
import org.openqa.selenium.firefox.FirefoxBinary;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.openqa.selenium.firefox.FirefoxProfile;
import org.openqa.selenium.htmlunit.HtmlUnitDriver;
import org.openqa.selenium.remote.Augmenter;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.remote.service.DriverService;
import org.openqa.selenium.support.events.EventFiringWebDriver;
import org.zanata.util.PropertiesHolder;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import lombok.extern.slf4j.Slf4j;
import org.zanata.util.TestEventForScreenshotListener;
import static org.zanata.util.Constants.chrome;
import static org.zanata.util.Constants.firefox;
import static org.zanata.util.Constants.webDriverType;
import static org.zanata.util.Constants.zanataInstance;
@Slf4j
public enum WebDriverFactory {
INSTANCE;
private volatile WebDriver driver = createDriver();
private DriverService driverService;
private TestEventForScreenshotListener eventListener;
public static String getScreenshotBaseDir() {
return PropertiesHolder.getProperty("webdriver.screenshot.dir");
}
public WebDriver getDriver() {
return driver;
}
public WebDriver createDriver() {
WebDriver driver = new EventFiringWebDriver(
new Augmenter().augment(createPlainDriver()));
driver.manage().timeouts().implicitlyWait(3, TimeUnit.SECONDS);
Runtime.getRuntime().addShutdownHook(new ShutdownHook());
return driver;
}
public String getHostUrl() {
return PropertiesHolder.getProperty(zanataInstance.value());
}
private WebDriver enableScreenshots() {
log.info("Enabling screenshot module...");
return EventFiringWebDriver.class.cast(driver).register(eventListener);
}
public void updateListenerTestName(String testName) {
if (eventListener == null && getScreenshotBaseDir() != null) {
eventListener = new TestEventForScreenshotListener(driver,
getScreenshotBaseDir());
driver = enableScreenshots();
}
eventListener.updateTestID(testName);
}
private WebDriver createPlainDriver() {
String driverType =
PropertiesHolder.getProperty(webDriverType.value(), "htmlUnit");
if (driverType.equalsIgnoreCase(chrome.value())) {
return configureChromeDriver();
} else if (driverType.equalsIgnoreCase(firefox.value())) {
return configureFirefoxDriver();
} else {
return configureHtmlDriver();
}
}
private WebDriver configureHtmlDriver() {
return new HtmlUnitDriver(true);
}
private WebDriver configureChromeDriver() {
driverService = new ChromeDriverService.Builder()
.usingDriverExecutable(
new File(PropertiesHolder
.getProperty("webdriver.chrome.driver")))
.usingAnyFreePort()
.withEnvironment(ImmutableMap.of("DISPLAY",
PropertiesHolder
.getProperty("webdriver.display")))
.withLogFile(
new File(PropertiesHolder
.getProperty("webdriver.log"))).build();
DesiredCapabilities capabilities = DesiredCapabilities.chrome();
capabilities.setCapability("chrome.binary", PropertiesHolder
.getProperty("webdriver.chrome.bin"));
capabilities.setCapability("chrome.switches", Arrays
.asList("--start-maximized"));
try {
driverService.start();
} catch (IOException e) {
throw new RuntimeException("fail to start chrome driver service");
}
return new RemoteWebDriver(driverService.getUrl(), capabilities);
}
private WebDriver configureFirefoxDriver() {
final String pathToFirefox =
Strings.emptyToNull(PropertiesHolder
.getProperty("firefox.path"));
FirefoxBinary firefoxBinary = null;
if (pathToFirefox != null) {
firefoxBinary = new FirefoxBinary(new File(pathToFirefox));
} else {
firefoxBinary = new FirefoxBinary();
}
/*
* TODO: Evaluate current timeout Timeout the connection in 30 seconds
* firefoxBinary.setTimeout(TimeUnit.SECONDS.toMillis(30));
*/
firefoxBinary.setEnvironmentProperty("DISPLAY",
PropertiesHolder.getProperty("webdriver.display"));
return new FirefoxDriver(firefoxBinary, makeFirefoxProfile());
}
private FirefoxProfile makeFirefoxProfile() {
if (!Strings.isNullOrEmpty(System
.getProperty("webdriver.firefox.profile"))) {
throw new RuntimeException("webdriver.firefox.profile is ignored");
// TODO - look at FirefoxDriver.getProfile().
}
final FirefoxProfile firefoxProfile = new FirefoxProfile();
/*
* TODO: Evaluate need for this Disable unnecessary connection to
* sb-ssl.google.com
* firefoxProfile.setPreference("browser.safebrowsing.malware.enabled",
* false);
*/
firefoxProfile.setAlwaysLoadNoFocusLib(true);
firefoxProfile.setEnableNativeEvents(true);
firefoxProfile.setAcceptUntrustedCertificates(true);
return firefoxProfile;
}
private class ShutdownHook extends Thread {
public void run() {
// If webdriver is running quit.
WebDriver driver = getDriver();
if (driver != null) {
try {
log.info("Quitting webdriver.");
driver.quit();
} catch (Throwable e) {
// Ignoring driver tear down errors.
}
}
if (driverService != null && driverService.isRunning()) {
driverService.stop();
}
}
}
}