/
ie.js
400 lines (353 loc) · 12.1 KB
/
ie.js
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
// 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.
/**
* @fileoverview Defines a {@linkplain Driver WebDriver} client for Microsoft's
* Internet Explorer. Before using the IEDriver, you must download the latest
* [IEDriverServer](http://selenium-release.storage.googleapis.com/index.html)
* and place it on your
* [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29). You must also apply
* the system configuration outlined on the Selenium project
* [wiki](https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver)
*/
'use strict';
const fs = require('fs');
const util = require('util');
const http = require('./http');
const io = require('./io');
const portprober = require('./net/portprober');
const promise = require('./lib/promise');
const remote = require('./remote');
const webdriver = require('./lib/webdriver');
const {Browser, Capabilities, Capability} = require('./lib/capabilities');
const IEDRIVER_EXE = 'IEDriverServer.exe';
/**
* IEDriverServer logging levels.
* @enum {string}
*/
const Level = {
FATAL: 'FATAL',
ERROR: 'ERROR',
WARN: 'WARN',
INFO: 'INFO',
DEBUG: 'DEBUG',
TRACE: 'TRACE'
};
/**
* Option keys:
* https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities#ie-specific
* @enum {string}
*/
const Key = {
IGNORE_PROTECTED_MODE_SETTINGS: 'ignoreProtectedModeSettings',
IGNORE_ZOOM_SETTING: 'ignoreZoomSetting',
INITIAL_BROWSER_URL: 'initialBrowserUrl',
ENABLE_PERSISTENT_HOVER: 'enablePersistentHover',
ENABLE_ELEMENT_CACHE_CLEANUP: 'enableElementCacheCleanup',
REQUIRE_WINDOW_FOCUS: 'requireWindowFocus',
BROWSER_ATTACH_TIMEOUT: 'browserAttachTimeout',
FORCE_CREATE_PROCESS: 'ie.forceCreateProcessApi',
BROWSER_COMMAND_LINE_SWITCHES: 'ie.browserCommandLineSwitches',
USE_PER_PROCESS_PROXY: 'ie.usePerProcessProxy',
ENSURE_CLEAN_SESSION: 'ie.ensureCleanSession',
LOG_FILE: 'logFile',
LOG_LEVEL: 'logLevel',
HOST: 'host',
EXTRACT_PATH: 'extractPath',
SILENT: 'silent'
};
/**
* Class for managing IEDriver specific options.
*/
class Options extends Capabilities {
/**
* @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
* capabilities to initialize this instance from.
*/
constructor(other = undefined) {
super(other);
this.setBrowserName(Browser.IE);
}
/**
* Whether to disable the protected mode settings check when the session is
* created. Disbling this setting may lead to significant instability as the
* browser may become unresponsive/hang. Only "best effort" support is provided
* when using this capability.
*
* For more information, refer to the IEDriver's
* [required system configuration](http://goo.gl/eH0Yi3).
*
* @param {boolean} ignoreSettings Whether to ignore protected mode settings.
* @return {!Options} A self reference.
*/
introduceFlakinessByIgnoringProtectedModeSettings(ignoreSettings) {
this.set(Key.IGNORE_PROTECTED_MODE_SETTINGS, !!ignoreSettings);
return this;
}
/**
* Indicates whether to skip the check that the browser's zoom level is set to
* 100%.
*
* @param {boolean} ignore Whether to ignore the browser's zoom level settings.
* @return {!Options} A self reference.
*/
ignoreZoomSetting(ignore) {
this.set(Key.IGNORE_ZOOM_SETTING, !!ignore);
return this;
}
/**
* Sets the initial URL loaded when IE starts. This is intended to be used with
* {@link #ignoreProtectedModeSettings} to allow the user to initialize IE in
* the proper Protected Mode zone. Setting this option may cause browser
* instability or flaky and unresponsive code. Only "best effort" support is
* provided when using this option.
*
* @param {string} url The initial browser URL.
* @return {!Options} A self reference.
*/
initialBrowserUrl(url) {
this.set(Key.INITIAL_BROWSER_URL, url);
return this;
}
/**
* Configures whether to enable persistent mouse hovering (true by default).
* Persistent hovering is achieved by continuously firing mouse over events at
* the last location the mouse cursor has been moved to.
*
* @param {boolean} enable Whether to enable persistent hovering.
* @return {!Options} A self reference.
*/
enablePersistentHover(enable) {
this.set(Key.ENABLE_PERSISTENT_HOVER, !!enable);
return this;
}
/**
* Configures whether the driver should attempt to remove obsolete
* {@linkplain webdriver.WebElement WebElements} from its internal cache on
* page navigation (true by default). Disabling this option will cause the
* driver to run with a larger memory footprint.
*
* @param {boolean} enable Whether to enable element reference cleanup.
* @return {!Options} A self reference.
*/
enableElementCacheCleanup(enable) {
this.set(Key.ENABLE_ELEMENT_CACHE_CLEANUP, !!enable);
return this;
}
/**
* Configures whether to require the IE window to have input focus before
* performing any user interactions (i.e. mouse or keyboard events). This
* option is disabled by default, but delivers much more accurate interaction
* events when enabled.
*
* @param {boolean} require Whether to require window focus.
* @return {!Options} A self reference.
*/
requireWindowFocus(require) {
this.set(Key.REQUIRE_WINDOW_FOCUS, !!require);
return this;
}
/**
* Configures the timeout, in milliseconds, that the driver will attempt to
* located and attach to a newly opened instance of Internet Explorer. The
* default is zero, which indicates waiting indefinitely.
*
* @param {number} timeout How long to wait for IE.
* @return {!Options} A self reference.
*/
browserAttachTimeout(timeout) {
this.set(Key.BROWSER_ATTACH_TIMEOUT, Math.max(timeout, 0));
return this;
}
/**
* Configures whether to launch Internet Explorer using the CreateProcess API.
* If this option is not specified, IE is launched using IELaunchURL, if
* available. For IE 8 and above, this option requires the TabProcGrowth
* registry value to be set to 0.
*
* @param {boolean} force Whether to use the CreateProcess API.
* @return {!Options} A self reference.
*/
forceCreateProcessApi(force) {
this.set(Key.FORCE_CREATE_PROCESS, !!force);
return this;
}
/**
* Specifies command-line switches to use when launching Internet Explorer.
* This is only valid when used with {@link #forceCreateProcessApi}.
*
* @param {...(string|!Array.<string>)} args The arguments to add.
* @return {!Options} A self reference.
*/
addArguments(...args) {
let current = this.get(Key.BROWSER_COMMAND_LINE_SWITCHES) || [];
this.set(
Key.BROWSER_COMMAND_LINE_SWITCHES,
current.concat.apply(current, args));
return this;
}
/**
* Configures whether proxies should be configured on a per-process basis. If
* not set, setting a {@linkplain #setProxy proxy} will configure the system
* proxy. The default behavior is to use the system proxy.
*
* @param {boolean} enable Whether to enable per-process proxy settings.
* @return {!Options} A self reference.
*/
usePerProcessProxy(enable) {
this.set(Key.USE_PER_PROCESS_PROXY, !!enable);
return this;
}
/**
* Configures whether to clear the cache, cookies, history, and saved form data
* before starting the browser. _Using this capability will clear session data
* for all running instances of Internet Explorer, including those started
* manually._
*
* @param {boolean} cleanSession Whether to clear all session data on startup.
* @return {!Options} A self reference.
*/
ensureCleanSession(cleanSession) {
this.set(Key.ENSURE_CLEAN_SESSION, !!cleanSession);
return this;
}
/**
* Sets the path to the log file the driver should log to.
* @param {string} file The log file path.
* @return {!Options} A self reference.
*/
setLogFile(file) {
this.set(Key.LOG_FILE, file);
return this;
}
/**
* Sets the IEDriverServer's logging {@linkplain Level level}.
* @param {Level} level The logging level.
* @return {!Options} A self reference.
*/
setLogLevel(level) {
this.set(Key.LOG_LEVEL, level);
return this;
}
/**
* Sets the IP address of the driver's host adapter.
* @param {string} host The IP address to use.
* @return {!Options} A self reference.
*/
setHost(host) {
this.set(Key.HOST, host);
return this;
}
/**
* Sets the path of the temporary data directory to use.
* @param {string} path The log file path.
* @return {!Options} A self reference.
*/
setExtractPath(path) {
this.set(Key.EXTRACT_PATH, path);
return this;
}
/**
* Sets whether the driver should start in silent mode.
* @param {boolean} silent Whether to run in silent mode.
* @return {!Options} A self reference.
*/
silent(silent) {
this.set(Key.SILENT, silent);
return this;
}
}
/**
* _Synchronously_ attempts to locate the IE driver executable on the current
* system.
*
* @return {?string} the located executable, or `null`.
*/
function locateSynchronously() {
return process.platform === 'win32'
? io.findInPath(IEDRIVER_EXE, true) : null;
}
function createServiceFromCapabilities(capabilities) {
if (process.platform !== 'win32') {
throw Error(
'The IEDriver may only be used on Windows, but you appear to be on ' +
process.platform + '. Did you mean to run against a remote ' +
'WebDriver server?');
}
let exe = locateSynchronously();
if (!exe || !fs.existsSync(exe)) {
throw Error(
`${IEDRIVER_EXE} could not be found on the current PATH. Please ` +
`download the latest version of ${IEDRIVER_EXE} from ` +
'http://selenium-release.storage.googleapis.com/index.html and ' +
'ensure it can be found on your system PATH.');
}
var args = [];
if (capabilities.has(Key.HOST)) {
args.push('--host=' + capabilities.get(Key.HOST));
}
if (capabilities.has(Key.LOG_FILE)) {
args.push('--log-file=' + capabilities.get(Key.LOG_FILE));
}
if (capabilities.has(Key.LOG_LEVEL)) {
args.push('--log-level=' + capabilities.get(Key.LOG_LEVEL));
}
if (capabilities.has(Key.EXTRACT_PATH)) {
args.push('--extract-path=' + capabilities.get(Key.EXTRACT_PATH));
}
if (capabilities.get(Key.SILENT)) {
args.push('--silent');
}
var port = portprober.findFreePort();
return new remote.DriverService(exe, {
loopback: true,
port: port,
args: port.then(function(port) {
return args.concat('--port=' + port);
}),
stdio: 'ignore'
});
}
/**
* A WebDriver client for Microsoft's Internet Explorer.
*/
class Driver extends webdriver.WebDriver {
/**
* Creates a new session for Microsoft's Internet Explorer.
*
* @param {(Capabilities|Options)=} options The configuration options.
* @return {!Driver} A new driver instance.
*/
static createSession(options) {
options = options || new Options();
let service = createServiceFromCapabilities(options);
let client = service.start().then(url => new http.HttpClient(url));
let executor = new http.Executor(client);
return /** @type {!Driver} */(super.createSession(
executor, options, () => service.kill()));
}
/**
* This function is a no-op as file detectors are not supported by this
* implementation.
* @override
*/
setFileDetector() {}
}
// PUBLIC API
exports.Driver = Driver;
exports.Options = Options;
exports.Level = Level;
exports.locateSynchronously = locateSynchronously;