browser.js
32.1 KB
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
"use strict";
var __extends = (this && this.__extends) || function (d, b) {
for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
var selenium_webdriver_1 = require("selenium-webdriver");
var url = require("url");
var debugger_1 = require("./debugger");
var element_1 = require("./element");
var expectedConditions_1 = require("./expectedConditions");
var locators_1 = require("./locators");
var logger_1 = require("./logger");
var plugins_1 = require("./plugins");
var clientSideScripts = require('./clientsidescripts');
// TODO: fix the typings for selenium-webdriver/lib/command
var Command = require('selenium-webdriver/lib/command').Command;
var CommandName = require('selenium-webdriver/lib/command').Name;
// jshint browser: true
var DEFER_LABEL = 'NG_DEFER_BOOTSTRAP!';
var DEFAULT_RESET_URL = 'data:text/html,<html></html>';
var DEFAULT_GET_PAGE_TIMEOUT = 10000;
var logger = new logger_1.Logger('protractor');
// TODO(cnishina): either remove for loop entirely since this does not export anything
// the user might need since everything is composed (with caveat that this could be a
// potential breaking change) or export the types with `export * from 'selenium-webdriver'`;
/*
* Mix in other webdriver functionality to be accessible via protractor.
*/
for (var foo in require('selenium-webdriver')) {
exports[foo] = require('selenium-webdriver')[foo];
}
// Explicitly define webdriver.WebDriver
// TODO: extend WebDriver from selenium-webdriver typings
var Webdriver = (function () {
function Webdriver() {
}
return Webdriver;
}());
exports.Webdriver = Webdriver;
/**
* Mix a function from one object onto another. The function will still be
* called in the context of the original object. Any arguments of type
* `ElementFinder` will be unwrapped to their underlying `WebElement` instance
*
* @private
* @param {Object} to
* @param {Object} from
* @param {string} fnName
* @param {function=} setupFn
*/
function ptorMixin(to, from, fnName, setupFn) {
to[fnName] = function () {
for (var i = 0; i < arguments.length; i++) {
if (arguments[i] instanceof element_1.ElementFinder) {
arguments[i] = arguments[i].getWebElement();
}
}
if (setupFn) {
setupFn();
}
return from[fnName].apply(from, arguments);
};
}
;
/**
* Build the helper 'element' function for a given instance of Browser.
*
* @private
* @param {Browser} browser A browser instance.
* @returns {function(webdriver.Locator): ElementFinder}
*/
function buildElementHelper(browser) {
var element = (function (locator) {
return new element_1.ElementArrayFinder(browser).all(locator).toElementFinder_();
});
element.all = function (locator) {
return new element_1.ElementArrayFinder(browser).all(locator);
};
return element;
}
;
/**
* @alias browser
* @constructor
* @extends {webdriver.WebDriver}
* @param {webdriver.WebDriver} webdriver
* @param {string=} opt_baseUrl A base URL to run get requests against.
* @param {string=} opt_rootElement Selector element that has an ng-app in
* scope.
* @param {boolean=} opt_untrackOutstandingTimeouts Whether Protractor should
* stop tracking outstanding $timeouts.
*/
var ProtractorBrowser = (function (_super) {
__extends(ProtractorBrowser, _super);
function ProtractorBrowser(webdriverInstance, opt_baseUrl, opt_rootElement, opt_untrackOutstandingTimeouts) {
var _this = _super.call(this) || this;
// These functions should delegate to the webdriver instance, but should
// wait for Angular to sync up before performing the action. This does not
// include functions which are overridden by protractor below.
var methodsToSync = ['getCurrentUrl', 'getPageSource', 'getTitle'];
// Mix all other driver functionality into Protractor.
Object.getOwnPropertyNames(selenium_webdriver_1.WebDriver.prototype).forEach(function (method) {
if (!_this[method] && typeof webdriverInstance[method] === 'function') {
if (methodsToSync.indexOf(method) !== -1) {
ptorMixin(_this, webdriverInstance, method, _this.waitForAngular.bind(_this));
}
else {
ptorMixin(_this, webdriverInstance, method);
}
}
});
_this.driver = webdriverInstance;
_this.element = buildElementHelper(_this);
_this.$ = element_1.build$(_this.element, selenium_webdriver_1.By);
_this.$$ = element_1.build$$(_this.element, selenium_webdriver_1.By);
_this.baseUrl = opt_baseUrl || '';
_this.rootEl = opt_rootElement || 'body';
_this.ignoreSynchronization = false;
_this.getPageTimeout = DEFAULT_GET_PAGE_TIMEOUT;
_this.params = {};
_this.ready = null;
_this.plugins_ = new plugins_1.Plugins({});
_this.resetUrl = DEFAULT_RESET_URL;
_this.ng12Hybrid = false;
_this.debugHelper = new debugger_1.DebugHelper(_this);
_this.driver.getCapabilities().then(function (caps) {
// Internet Explorer does not accept data URLs, which are the default
// reset URL for Protractor.
// Safari accepts data urls, but SafariDriver fails after one is used.
// PhantomJS produces a "Detected a page unload event" if we use data urls
var browserName = caps.get('browserName');
if (browserName === 'internet explorer' || browserName === 'safari' ||
browserName === 'phantomjs' || browserName === 'MicrosoftEdge') {
_this.resetUrl = 'about:blank';
}
});
_this.trackOutstandingTimeouts_ = !opt_untrackOutstandingTimeouts;
_this.mockModules_ = [];
_this.addBaseMockModules_();
// set up expected conditions
_this.ExpectedConditions = new expectedConditions_1.ProtractorExpectedConditions(_this);
return _this;
}
/**
* Get the processed configuration object that is currently being run. This
* will contain the specs and capabilities properties of the current runner
* instance.
*
* Set by the runner.
*
* @returns {webdriver.promise.Promise} A promise which resolves to the
* capabilities object.
*/
ProtractorBrowser.prototype.getProcessedConfig = function () {
return null;
};
/**
* Fork another instance of browser for use in interactive tests.
*
* Set by the runner.
*
* @param {boolean} opt_useSameUrl Whether to navigate to current url on
* creation
* @param {boolean} opt_copyMockModules Whether to apply same mock modules on
* creation
* @returns {Browser} A browser instance.
*/
ProtractorBrowser.prototype.forkNewDriverInstance = function (opt_useSameUrl, opt_copyMockModules) {
return null;
};
/**
* Restart the browser instance.
*
* Set by the runner.
*/
ProtractorBrowser.prototype.restart = function () {
return;
};
/**
* Instead of using a single root element, search through all angular apps
* available on the page when finding elements or waiting for stability.
* Only compatible with Angular2.
*/
ProtractorBrowser.prototype.useAllAngular2AppRoots = function () {
// The empty string is an invalid css selector, so we use it to easily
// signal to scripts to not find a root element.
this.rootEl = '';
};
/**
* The same as {@code webdriver.WebDriver.prototype.executeScript},
* but with a customized description for debugging.
*
* @private
* @param {!(string|Function)} script The script to execute.
* @param {string} description A description of the command for debugging.
* @param {...*} var_args The arguments to pass to the script.
* @returns {!webdriver.promise.Promise.<T>} A promise that will resolve to
* the scripts return value.
* @template T
*/
ProtractorBrowser.prototype.executeScriptWithDescription = function (script, description) {
var scriptArgs = [];
for (var _i = 2; _i < arguments.length; _i++) {
scriptArgs[_i - 2] = arguments[_i];
}
if (typeof script === 'function') {
script = 'return (' + script + ').apply(null, arguments);';
}
return this.driver.schedule(new Command(CommandName.EXECUTE_SCRIPT)
.setParameter('script', script)
.setParameter('args', scriptArgs), description);
};
/**
* The same as {@code webdriver.WebDriver.prototype.executeAsyncScript},
* but with a customized description for debugging.
*
* @private
* @param {!(string|Function)} script The script to execute.
* @param {string} description A description for debugging purposes.
* @param {...*} var_args The arguments to pass to the script.
* @returns {!webdriver.promise.Promise.<T>} A promise that will resolve to
* the
* scripts return value.
* @template T
*/
ProtractorBrowser.prototype.executeAsyncScript_ = function (script, description) {
var scriptArgs = [];
for (var _i = 2; _i < arguments.length; _i++) {
scriptArgs[_i - 2] = arguments[_i];
}
if (typeof script === 'function') {
script = 'return (' + script + ').apply(null, arguments);';
}
return this.driver.schedule(new Command(CommandName.EXECUTE_ASYNC_SCRIPT)
.setParameter('script', script)
.setParameter('args', scriptArgs), description);
};
/**
* Instruct webdriver to wait until Angular has finished rendering and has
* no outstanding $http or $timeout calls before continuing.
* Note that Protractor automatically applies this command before every
* WebDriver action.
*
* @param {string=} opt_description An optional description to be added
* to webdriver logs.
* @returns {!webdriver.promise.Promise} A promise that will resolve to the
* scripts return value.
*/
ProtractorBrowser.prototype.waitForAngular = function (opt_description) {
var _this = this;
var description = opt_description ? ' - ' + opt_description : '';
if (this.ignoreSynchronization) {
return this.driver.controlFlow().execute(function () {
return true;
}, 'Ignore Synchronization Protractor.waitForAngular()');
}
var runWaitForAngularScript = function () {
if (_this.plugins_.skipAngularStability()) {
return selenium_webdriver_1.promise.fulfilled();
}
else if (_this.rootEl) {
return _this.executeAsyncScript_(clientSideScripts.waitForAngular, 'Protractor.waitForAngular()' + description, _this.rootEl, _this.ng12Hybrid);
}
else {
return _this.executeAsyncScript_(clientSideScripts.waitForAllAngular2, 'Protractor.waitForAngular()' + description);
}
};
return runWaitForAngularScript()
.then(function (browserErr) {
if (browserErr) {
throw new Error('Error while waiting for Protractor to ' +
'sync with the page: ' + JSON.stringify(browserErr));
}
})
.then(function () {
return _this.driver.controlFlow()
.execute(function () {
return _this.plugins_.waitForPromise();
}, 'Plugins.waitForPromise()')
.then(function () {
return _this.driver.wait(function () {
return _this.plugins_.waitForCondition().then(function (results) {
return results.reduce(function (x, y) { return x && y; }, true);
});
}, _this.allScriptsTimeout, 'Plugins.waitForCondition()');
});
}, function (err) {
var timeout;
if (/asynchronous script timeout/.test(err.message)) {
// Timeout on Chrome
timeout = /-?[\d\.]*\ seconds/.exec(err.message);
}
else if (/Timed out waiting for async script/.test(err.message)) {
// Timeout on Firefox
timeout = /-?[\d\.]*ms/.exec(err.message);
}
else if (/Timed out waiting for an asynchronous script/.test(err.message)) {
// Timeout on Safari
timeout = /-?[\d\.]*\ ms/.exec(err.message);
}
if (timeout) {
var errMsg_1 = "Timed out waiting for asynchronous Angular tasks to finish after " +
(timeout + ". This may be because the current page is not an Angular ") +
"application. Please see the FAQ for more details: " +
"https://github.com/angular/protractor/blob/master/docs/timeouts.md#waiting-for-angular";
if (description.indexOf(' - Locator: ') == 0) {
errMsg_1 += '\nWhile waiting for element with locator' + description;
}
var pendingTimeoutsPromise = void 0;
if (_this.trackOutstandingTimeouts_) {
pendingTimeoutsPromise = _this.executeScriptWithDescription('return window.NG_PENDING_TIMEOUTS', 'Protractor.waitForAngular() - getting pending timeouts' + description);
}
else {
pendingTimeoutsPromise = selenium_webdriver_1.promise.fulfilled({});
}
var pendingHttpsPromise = _this.executeScriptWithDescription(clientSideScripts.getPendingHttpRequests, 'Protractor.waitForAngular() - getting pending https' + description, _this.rootEl);
return selenium_webdriver_1.promise.all([pendingTimeoutsPromise, pendingHttpsPromise])
.then(function (arr) {
var pendingTimeouts = arr[0] || [];
var pendingHttps = arr[1] || [];
var key, pendingTasks = [];
for (key in pendingTimeouts) {
if (pendingTimeouts.hasOwnProperty(key)) {
pendingTasks.push(' - $timeout: ' + pendingTimeouts[key]);
}
}
for (key in pendingHttps) {
pendingTasks.push(' - $http: ' + pendingHttps[key].url);
}
if (pendingTasks.length) {
errMsg_1 += '. \nThe following tasks were pending:\n';
errMsg_1 += pendingTasks.join('\n');
}
err.message = errMsg_1;
throw err;
}, function () {
err.message = errMsg_1;
throw err;
});
}
else {
throw err;
}
});
};
/**
* Waits for Angular to finish rendering before searching for elements.
* @see webdriver.WebDriver.findElement
* @returns {!webdriver.promise.Promise} A promise that will be resolved to
* the located {@link webdriver.WebElement}.
*/
ProtractorBrowser.prototype.findElement = function (locator) {
return this.element(locator).getWebElement();
};
/**
* Waits for Angular to finish rendering before searching for elements.
* @see webdriver.WebDriver.findElements
* @returns {!webdriver.promise.Promise} A promise that will be resolved to an
* array of the located {@link webdriver.WebElement}s.
*/
ProtractorBrowser.prototype.findElements = function (locator) {
return this.element.all(locator).getWebElements();
};
/**
* Tests if an element is present on the page.
* @see webdriver.WebDriver.isElementPresent
* @returns {!webdriver.promise.Promise} A promise that will resolve to whether
* the element is present on the page.
*/
ProtractorBrowser.prototype.isElementPresent = function (locatorOrElement) {
var element = (locatorOrElement.isPresent) ? locatorOrElement : this.element(locatorOrElement);
return element.isPresent();
};
/**
* Add a module to load before Angular whenever Protractor.get is called.
* Modules will be registered after existing modules already on the page,
* so any module registered here will override preexisting modules with the
* same name.
*
* @example
* browser.addMockModule('modName', function() {
* angular.module('modName', []).value('foo', 'bar');
* });
*
* @param {!string} name The name of the module to load or override.
* @param {!string|Function} script The JavaScript to load the module.
* Note that this will be executed in the browser context, so it cannot
* access variables from outside its scope.
* @param {...*} varArgs Any additional arguments will be provided to
* the script and may be referenced using the `arguments` object.
*/
ProtractorBrowser.prototype.addMockModule = function (name, script) {
var moduleArgs = [];
for (var _i = 2; _i < arguments.length; _i++) {
moduleArgs[_i - 2] = arguments[_i];
}
this.mockModules_.push({ name: name, script: script, args: moduleArgs });
};
/**
* Clear the list of registered mock modules.
*/
ProtractorBrowser.prototype.clearMockModules = function () {
this.mockModules_ = [];
this.addBaseMockModules_();
};
/**
* Remove a registered mock module.
*
* @example
* browser.removeMockModule('modName');
*
* @param {!string} name The name of the module to remove.
*/
ProtractorBrowser.prototype.removeMockModule = function (name) {
for (var i = 0; i < this.mockModules_.length; ++i) {
if (this.mockModules_[i].name == name) {
this.mockModules_.splice(i--, 1);
}
}
};
/**
* Get a list of the current mock modules.
*
* @returns {Array.<!string|Function>} The list of mock modules.
*/
ProtractorBrowser.prototype.getRegisteredMockModules = function () {
return this.mockModules_.map(function (module) { return module.script; });
};
;
/**
* Add the base mock modules used for all Protractor tests.
*
* @private
*/
ProtractorBrowser.prototype.addBaseMockModules_ = function () {
this.addMockModule('protractorBaseModule_', clientSideScripts.protractorBaseModuleFn, this.trackOutstandingTimeouts_);
};
/**
* @see webdriver.WebDriver.get
*
* Navigate to the given destination and loads mock modules before
* Angular. Assumes that the page being loaded uses Angular.
* If you need to access a page which does not have Angular on load, use
* the wrapped webdriver directly.
*
* @example
* browser.get('https://angularjs.org/');
* expect(browser.getCurrentUrl()).toBe('https://angularjs.org/');
*
* @param {string} destination Destination URL.
* @param {number=} opt_timeout Number of milliseconds to wait for Angular to
* start.
*/
ProtractorBrowser.prototype.get = function (destination, timeout) {
var _this = this;
if (timeout === void 0) { timeout = this.getPageTimeout; }
destination = this.baseUrl.indexOf('file://') === 0 ? this.baseUrl + destination :
url.resolve(this.baseUrl, destination);
var msg = function (str) {
return 'Protractor.get(' + destination + ') - ' + str;
};
if (this.ignoreSynchronization) {
this.driver.get(destination);
return this.driver.controlFlow().execute(function () { return _this.plugins_.onPageLoad(); }).then(function () { });
}
var deferred = selenium_webdriver_1.promise.defer();
this.driver.get(this.resetUrl).then(null, deferred.reject);
this.executeScriptWithDescription('window.name = "' + DEFER_LABEL + '" + window.name;' +
'window.location.replace("' + destination + '");', msg('reset url'))
.then(null, deferred.reject);
// We need to make sure the new url has loaded before
// we try to execute any asynchronous scripts.
this.driver
.wait(function () {
return _this
.executeScriptWithDescription('return window.location.href;', msg('get url'))
.then(function (url) {
return url !== _this.resetUrl;
}, function (err) {
if (err.code == 13) {
// Ignore the error, and continue trying. This is
// because IE driver sometimes (~1%) will throw an
// unknown error from this execution. See
// https://github.com/angular/protractor/issues/841
// This shouldn't mask errors because it will fail
// with the timeout anyway.
return false;
}
else {
throw err;
}
});
}, timeout, 'waiting for page to load for ' + timeout + 'ms')
.then(null, deferred.reject);
this.driver.controlFlow().execute(function () {
return _this.plugins_.onPageLoad();
});
// Make sure the page is an Angular page.
this.executeAsyncScript_(clientSideScripts.testForAngular, msg('test for angular'), Math.floor(timeout / 1000), this.ng12Hybrid)
.then(function (angularTestResult) {
var angularVersion = angularTestResult.ver;
if (!angularVersion) {
var message = angularTestResult.message;
logger.error("Could not find Angular on page " + destination + " : " + message);
throw new Error("Angular could not be found on the page " + destination + ". If this is not an " +
"Angular application, you may need to turn off waiting for Angular. Please " +
"see https://github.com/angular/protractor/blob/master/docs/timeouts.md#waiting-for-angular-on-page-load");
}
return angularVersion;
}, function (err) {
throw new Error('Error while running testForAngular: ' + err.message);
})
.then(loadMocks, deferred.reject);
var self = this;
function loadMocks(angularVersion) {
if (angularVersion === 1) {
// At this point, Angular will pause for us until angular.resumeBootstrap is called.
var moduleNames = [];
var _loop_1 = function (name_1, script, args) {
moduleNames.push(name_1);
var executeScriptArgs = [script, msg('add mock module ' + name_1)].concat(args);
self.executeScriptWithDescription.apply(self, executeScriptArgs)
.then(null, function (err) {
throw new Error('Error while running module script ' + name_1 + ': ' + err.message);
})
.then(null, deferred.reject);
};
for (var _i = 0, _a = self.mockModules_; _i < _a.length; _i++) {
var _b = _a[_i], name_1 = _b.name, script = _b.script, args = _b.args;
_loop_1(name_1, script, args);
}
self.executeScriptWithDescription('angular.resumeBootstrap(arguments[0]);', msg('resume bootstrap'), moduleNames)
.then(null, deferred.reject);
}
else {
// TODO: support mock modules in Angular2. For now, error if someone
// has tried to use one.
if (self.mockModules_.length > 1) {
deferred.reject('Trying to load mock modules on an Angular2 app ' +
'is not yet supported.');
}
}
}
this.driver.controlFlow().execute(function () {
return _this.plugins_.onPageStable().then(function () {
deferred.fulfill();
}, deferred.reject);
});
return deferred.promise;
};
/**
* @see webdriver.WebDriver.refresh
*
* Makes a full reload of the current page and loads mock modules before
* Angular. Assumes that the page being loaded uses Angular.
* If you need to access a page which does not have Angular on load, use
* the wrapped webdriver directly.
*
* @param {number=} opt_timeout Number of milliseconds to wait for Angular to start.
*/
ProtractorBrowser.prototype.refresh = function (opt_timeout) {
var _this = this;
if (this.ignoreSynchronization) {
return this.driver.navigate().refresh();
}
return this
.executeScriptWithDescription('return window.location.href', 'Protractor.refresh() - getUrl')
.then(function (href) {
return _this.get(href, opt_timeout);
});
};
/**
* Mixin navigation methods back into the navigation object so that
* they are invoked as before, i.e. driver.navigate().refresh()
*/
ProtractorBrowser.prototype.navigate = function () {
var nav = this.driver.navigate();
ptorMixin(nav, this, 'refresh');
return nav;
};
/**
* Browse to another page using in-page navigation.
*
* @example
* browser.get('http://angular.github.io/protractor/#/tutorial');
* browser.setLocation('api');
* expect(browser.getCurrentUrl())
* .toBe('http://angular.github.io/protractor/#/api');
*
* @param {string} url In page URL using the same syntax as $location.url()
* @returns {!webdriver.promise.Promise} A promise that will resolve once
* page has been changed.
*/
ProtractorBrowser.prototype.setLocation = function (url) {
this.waitForAngular();
return this
.executeScriptWithDescription(clientSideScripts.setLocation, 'Protractor.setLocation()', this.rootEl, url)
.then(function (browserErr) {
if (browserErr) {
throw 'Error while navigating to \'' + url + '\' : ' + JSON.stringify(browserErr);
}
});
};
/**
* Returns the current absolute url from AngularJS.
*
* @example
* browser.get('http://angular.github.io/protractor/#/api');
* expect(browser.getLocationAbsUrl())
* .toBe('http://angular.github.io/protractor/#/api');
* @returns {webdriver.promise.Promise<string>} The current absolute url from
* AngularJS.
*/
ProtractorBrowser.prototype.getLocationAbsUrl = function () {
this.waitForAngular();
return this.executeScriptWithDescription(clientSideScripts.getLocationAbsUrl, 'Protractor.getLocationAbsUrl()', this.rootEl);
};
/**
* Adds a task to the control flow to pause the test and inject helper
* functions
* into the browser, so that debugging may be done in the browser console.
*
* This should be used under node in debug mode, i.e. with
* protractor debug <configuration.js>
*
* @example
* While in the debugger, commands can be scheduled through webdriver by
* entering the repl:
* debug> repl
* > element(by.input('user')).sendKeys('Laura');
* > browser.debugger();
* Press Ctrl + c to leave debug repl
* debug> c
*
* This will run the sendKeys command as the next task, then re-enter the
* debugger.
*/
ProtractorBrowser.prototype.debugger = function () {
// jshint debug: true
this.driver.executeScript(clientSideScripts.installInBrowser);
selenium_webdriver_1.promise.controlFlow().execute(function () {
debugger;
}, 'add breakpoint to control flow');
};
/**
* Beta (unstable) enterRepl function for entering the repl loop from
* any point in the control flow. Use browser.enterRepl() in your test.
* Does not require changes to the command line (no need to add 'debug').
* Note, if you are wrapping your own instance of Protractor, you must
* expose globals 'browser' and 'protractor' for pause to work.
*
* @example
* element(by.id('foo')).click();
* browser.enterRepl();
* // Execution will stop before the next click action.
* element(by.id('bar')).click();
*
* @param {number=} opt_debugPort Optional port to use for the debugging
* process
*/
ProtractorBrowser.prototype.enterRepl = function (opt_debugPort) {
var debuggerClientPath = __dirname + '/debugger/clients/explorer.js';
var onStartFn = function () {
logger.info();
logger.info('------- Element Explorer -------');
logger.info('Starting WebDriver debugger in a child process. Element ' +
'Explorer is still beta, please report issues at ' +
'github.com/angular/protractor');
logger.info();
logger.info('Type <tab> to see a list of locator strategies.');
logger.info('Use the `list` helper function to find elements by strategy:');
logger.info(' e.g., list(by.binding(\'\')) gets all bindings.');
logger.info();
};
this.debugHelper.init(debuggerClientPath, onStartFn, opt_debugPort);
};
/**
* Beta (unstable) pause function for debugging webdriver tests. Use
* browser.pause() in your test to enter the protractor debugger from that
* point in the control flow.
* Does not require changes to the command line (no need to add 'debug').
* Note, if you are wrapping your own instance of Protractor, you must
* expose globals 'browser' and 'protractor' for pause to work.
*
* @example
* element(by.id('foo')).click();
* browser.pause();
* // Execution will stop before the next click action.
* element(by.id('bar')).click();
*
* @param {number=} opt_debugPort Optional port to use for the debugging
* process
*/
ProtractorBrowser.prototype.pause = function (opt_debugPort) {
if (this.debugHelper.isAttached()) {
logger.info('Encountered browser.pause(), but debugger already attached.');
return selenium_webdriver_1.promise.fulfilled(true);
}
var debuggerClientPath = __dirname + '/debugger/clients/wddebugger.js';
var onStartFn = function (firstTime) {
logger.info();
logger.info('Encountered browser.pause(). Attaching debugger...');
if (firstTime) {
logger.info();
logger.info('------- WebDriver Debugger -------');
logger.info('Starting WebDriver debugger in a child process. Pause is ' +
'still beta, please report issues at github.com/angular/protractor');
logger.info();
logger.info('press c to continue to the next webdriver command');
logger.info('press ^D to detach debugger and resume code execution');
logger.info('type "repl" to enter interactive mode');
logger.info('type "exit" to break out of interactive mode');
logger.info();
}
};
this.debugHelper.init(debuggerClientPath, onStartFn, opt_debugPort);
};
/**
* Create a new instance of Browser by wrapping a webdriver instance.
*
* @param {webdriver.WebDriver} webdriver The configured webdriver instance.
* @param {string=} baseUrl A URL to prepend to relative gets.
* @param {string=} rootElement The css selector for the element which is the
* root of the Angular app.
* @param {boolean=} untrackOutstandingTimeouts Whether Browser should
* stop tracking outstanding $timeouts.
* @returns {Browser} a new Browser instance
*/
ProtractorBrowser.wrapDriver = function (webdriver, baseUrl, rootElement, untrackOutstandingTimeouts) {
return new ProtractorBrowser(webdriver, baseUrl, rootElement, untrackOutstandingTimeouts);
};
return ProtractorBrowser;
}(Webdriver));
/**
* @type {ProtractorBy}
*/
ProtractorBrowser.By = new locators_1.ProtractorBy();
exports.ProtractorBrowser = ProtractorBrowser;