-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
/
ChromeDriverService.java
295 lines (260 loc) · 9.65 KB
/
ChromeDriverService.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package org.openqa.selenium.chrome;
import com.google.auto.service.AutoService;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.remote.service.DriverService;
import java.io.File;
import java.io.IOException;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import static java.util.Collections.unmodifiableList;
import static org.openqa.selenium.remote.Browser.CHROME;
/**
* Manages the life and death of a ChromeDriver server.
*/
public class ChromeDriverService extends DriverService {
/**
* System property that defines the location of the chromedriver executable that will be used by
* the {@link #createDefaultService() default service}.
*/
public static final String CHROME_DRIVER_EXE_PROPERTY = "webdriver.chrome.driver";
/**
* System property that defines the location of the log that will be written by
* the {@link #createDefaultService() default service}.
*/
public static final String CHROME_DRIVER_LOG_PROPERTY = "webdriver.chrome.logfile";
/**
* Boolean system property that defines whether chromedriver should append to existing log file.
*/
public static final String CHROME_DRIVER_APPEND_LOG_PROPERTY =
"webdriver.chrome.appendLog";
/**
* Boolean system property that defines whether the chromedriver executable should be started
* with verbose logging.
*/
public static final String CHROME_DRIVER_VERBOSE_LOG_PROPERTY =
"webdriver.chrome.verboseLogging";
/**
* Boolean system property that defines whether the chromedriver executable should be started
* in silent mode.
*/
public static final String CHROME_DRIVER_SILENT_OUTPUT_PROPERTY =
"webdriver.chrome.silentOutput";
/**
* System property that defines comma-separated list of remote IPv4 addresses which are
* allowed to connect to ChromeDriver.
*/
public static final String CHROME_DRIVER_WHITELISTED_IPS_PROPERTY =
"webdriver.chrome.whitelistedIps";
/**
* System property that defines whether the chromedriver executable should check for build
* version compatibility between chromedriver and the browser.
*/
public static final String CHROME_DRIVER_DISABLE_BUILD_CHECK =
"webdriver.chrome.disableBuildCheck";
/**
* @param executable The chromedriver executable.
* @param port Which port to start the ChromeDriver on.
* @param args The arguments to the launched server.
* @param environment The environment for the launched server.
* @throws IOException If an I/O error occurs.
*/
public ChromeDriverService(
File executable,
int port,
List<String> args,
Map<String, String> environment) throws IOException {
super(executable, port, DEFAULT_TIMEOUT, args, environment);
}
/**
* @param executable The chromedriver executable.
* @param port Which port to start the ChromeDriver on.
* @param timeout Timeout waiting for driver server to start.
* @param args The arguments to the launched server.
* @param environment The environment for the launched server.
* @throws IOException If an I/O error occurs.
*/
public ChromeDriverService(
File executable,
int port,
Duration timeout,
List<String> args,
Map<String, String> environment) throws IOException {
super(executable, port, timeout, args, environment);
}
/**
* Configures and returns a new {@link ChromeDriverService} using the default configuration. In
* this configuration, the service will use the chromedriver executable identified by the
* {@link #CHROME_DRIVER_EXE_PROPERTY} system property. Each service created by this method will
* be configured to use a free port on the current system.
*
* @return A new ChromeDriverService using the default configuration.
*/
public static ChromeDriverService createDefaultService() {
return new Builder().build();
}
/**
* Configures and returns a new {@link ChromeDriverService} using the supplied configuration. In
* this configuration, the service will use the chromedriver executable identified by the
* {@link #CHROME_DRIVER_EXE_PROPERTY} system property. Each service created by this method will
* be configured to use a free port on the current system.
*
* @return A new ChromeDriverService using the supplied configuration from {@link ChromeOptions}.
*/
public static ChromeDriverService createServiceWithConfig(ChromeOptions options) {
return new Builder()
.withLogLevel(options.getLogLevel())
.build();
}
/**
* Builder used to configure new {@link ChromeDriverService} instances.
*/
@AutoService(DriverService.Builder.class)
public static class Builder extends DriverService.Builder<
ChromeDriverService, ChromeDriverService.Builder> {
private final boolean disableBuildCheck = Boolean.getBoolean(CHROME_DRIVER_DISABLE_BUILD_CHECK);
private boolean appendLog = Boolean.getBoolean(CHROME_DRIVER_APPEND_LOG_PROPERTY);
private boolean verbose = Boolean.getBoolean(CHROME_DRIVER_VERBOSE_LOG_PROPERTY);
private boolean silent = Boolean.getBoolean(CHROME_DRIVER_SILENT_OUTPUT_PROPERTY);
private String whitelistedIps = System.getProperty(CHROME_DRIVER_WHITELISTED_IPS_PROPERTY);
private ChromeDriverLogLevel logLevel = null;
@Override
public int score(Capabilities capabilities) {
int score = 0;
if (CHROME.is(capabilities.getBrowserName())) {
score++;
}
if (capabilities.getCapability(ChromeOptions.CAPABILITY) != null) {
score++;
}
return score;
}
/**
* Configures the driver server appending to log file.
*
* @param appendLog True for appending to log file, false otherwise.
* @return A self reference.
*/
public Builder withAppendLog(boolean appendLog) {
this.appendLog = appendLog;
return this;
}
/**
* Configures the driver server verbosity.
*
* @param verbose True for verbose output, false otherwise.
* @return A self reference.
*/
@SuppressWarnings("UnusedReturnValue")
public Builder withVerbose(boolean verbose) {
this.verbose = verbose;
return this;
}
/**
* Configures the driver server verbosity.
*
* @param logLevel {@link ChromeDriverLogLevel} for desired log level output.
* @return A self reference.
*/
public Builder withLogLevel(ChromeDriverLogLevel logLevel) {
this.logLevel = logLevel;
return this;
}
/**
* Configures the driver server for silent output.
*
* @param silent True for silent output, false otherwise.
* @return A self reference.
*/
public Builder withSilent(boolean silent) {
this.silent = silent;
return this;
}
/**
* Configures the comma-separated list of remote IPv4 addresses which are allowed to connect
* to the driver server.
*
* @param whitelistedIps Comma-separated list of remote IPv4 addresses.
* @return A self reference.
*/
public Builder withWhitelistedIps(String whitelistedIps) {
this.whitelistedIps = whitelistedIps;
return this;
}
@Override
protected File findDefaultExecutable() {
return findExecutable(
"chromedriver", CHROME_DRIVER_EXE_PROPERTY,
"https://chromedriver.chromium.org/",
"https://chromedriver.chromium.org/downloads");
}
@Override
protected List<String> createArgs() {
if (getLogFile() == null) {
String logFilePath = System.getProperty(CHROME_DRIVER_LOG_PROPERTY);
if (logFilePath != null) {
withLogFile(new File(logFilePath));
}
}
if (logLevel != null) {
withLogLevel(logLevel);
withVerbose(false);
}
if (verbose) {
withLogLevel(ChromeDriverLogLevel.ALL);
}
List<String> args = new ArrayList<>();
args.add(String.format("--port=%d", getPort()));
if (getLogFile() != null) {
args.add(String.format("--log-path=%s", getLogFile().getAbsolutePath()));
}
if (appendLog) {
args.add("--append-log");
}
if (logLevel != null) {
args.add(String.format("--log-level=%s", logLevel.toString().toUpperCase()));
}
if (silent) {
args.add("--silent");
}
if (whitelistedIps != null) {
args.add(String.format("--whitelisted-ips=%s", whitelistedIps));
}
if (disableBuildCheck) {
args.add("--disable-build-check");
}
return unmodifiableList(args);
}
@Override
protected ChromeDriverService createDriverService(
File exe,
int port,
Duration timeout,
List<String> args,
Map<String, String> environment) {
try {
return new ChromeDriverService(exe, port, timeout, args, environment);
} catch (IOException e) {
throw new WebDriverException(e);
}
}
}
}