| permalink | editLink | sidebar | title |
|---|---|---|---|
/helpers/Protractor |
false |
auto |
Protractor |
Extends Helper
Protractor helper is based on Protractor library and used for testing web applications.
Protractor requires Selenium Server and ChromeDriver/GeckoDriver to be installed.
To test non-Angular applications please make sure you have angular: false in configuration file.
This helper should be configured in codecept.json or codecept.conf.js
url- base url of website to be testedbrowser- browser in which perform testingangular: disable this option to run tests for non-Angular applications.driver- which protractor driver to use (local, direct, session, hosted, sauce, browserstack). By default set to 'hosted' which requires selenium server to be started.restart- restart browser between tests.smartWait: (optional) enables SmartWait; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000disableScreenshots- don't save screenshot on failurefullPageScreenshots- make full page screenshots on failure.uniqueScreenshotNames- option to prevent screenshot override if you have scenarios with the same name in different suiteskeepBrowserState- keep browser state between tests whenrestartset to false.seleniumAddress- Selenium address to connect (default: http://localhost:4444/wd/hub)rootElement- Root element of AngularJS application (default: body)getPageTimeout(optional) sets default timeout for a page to be loaded. 10000 by default.waitForTimeout: (optional) sets default wait time in ms for allwait*functions. 1000 by default.scriptsTimeout: (optional) timeout in milliseconds for each script run on the browser, 10000 by default.windowSize: (optional) default window size. Set tomaximizeor a dimension in the format640x480.manualStart- do not start browser before a test, start it manually inside a helper withthis.helpers["WebDriverIO"]._startBrowser()capabilities: {} - list of Desired Capabilitiesproxy: set proxy settings
other options are the same as in Protractor config.
{
"helpers": {
"Protractor" : {
"url": "http://localhost",
"browser": "chrome",
"smartWait": 5000,
"restart": false
}
}
}{
"helpers": {
"Protractor" : {
"url": "http://localhost",
"browser": "chrome",
"angular": false
}
}
}{
"helpers": {
"Protractor" : {
"url": "http://localhost",
"browser": "chrome",
"capabilities": {
"chromeOptions": {
"args": [ "--headless", "--disable-gpu", "--no-sandbox" ]
}
}
}
}
}Receive a WebDriverIO client from a custom helper by accessing browser property:
this.helpers['Protractor'].browserconfig
Get the window handle relative to the current handle. i.e. the next handle or the previous.
offsetNumber Offset from current handle index. i.e. offset < 0 will go to the previous handle and positive number will go to the next window handle in sequence.
Get elements by different locator types, including strict locator Should be used in custom helpers:
this.helpers['Protractor']._locate({name: 'password'}).then //...To use SmartWait and wait for element to appear on a page, add true as second arg:
this.helpers['Protractor']._locate({name: 'password'}, true).then //...locatorsmartWait
Find a checkbox by providing human readable text:
this.helpers['Protractor']._locateCheckable('I agree with terms and conditions').then // ...locator
Find a clickable element by providing human readable text:
this.helpers['Protractor']._locateClickable('Next page').then // ...locator
Find field elements by providing human readable text:
this.helpers['Protractor']._locateFields('Your email').then // ...locator
Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt. Don't confuse popups with modal windows, as created by various libraries. Appium: support only web testing
Enters Angular mode (switched on by default) Should be used after "amOutsideAngularApp"
Opens a web page in a browser. Requires relative or absolute url.
If url starts with /, opens a web page of a site defined in url config parameter.
I.amOnPage('/'); // opens main page of website
I.amOnPage('https://github.com'); // opens github
I.amOnPage('/login'); // opens a login pageurlstring url path or global url.
Switch to non-Angular mode, start using WebDriver instead of Protractor in this session
Appends text to a input field or textarea. Field is located by name, label, CSS or XPath
I.appendField('#myTextField', 'appended');field(string | object) located by label|name|CSS|XPath|strict locatorvaluestring text value to append.
Attaches a file to element located by label, name, CSS or XPath Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located). File will be uploaded to remote system (if tests are running remotely).
I.attachFile('Avatar', 'data/avatar.jpg');
I.attachFile('form input[name=avatar]', 'data/avatar.jpg');locator(string | object) field located by label|name|CSS|XPath|strict locator.pathToFilestring local file path relative to codecept.json config file.
Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
Selects a checkbox or radio button. Element is located by label or name or CSS or XPath.
The second parameter is a context (CSS or XPath locator) to narrow the search.
I.checkOption('#agree');
I.checkOption('I Agree to Terms and Conditions');
I.checkOption('agree', '//form');field(string | object) checkbox located by label | name | CSS | XPath | strict locator.context(string? | object) (optional,nullby default) element located by CSS | XPath | strict locator.
Clears a cookie by name, if none provided clears all cookies.
I.clearCookie();
I.clearCookie('test');cookiestring? (optional,nullby default) cookie name
Clears a <textarea> or text <input> element's value.
I.clearField('Email');
I.clearField('user[email]');
I.clearField('#email');Perform a click on a link or a button, given by a locator. If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. For images, the "alt" attribute and inner text of any parent links are searched.
The second parameter is a context (CSS or XPath locator) to narrow the search.
// simple link
I.click('Logout');
// button of form
I.click('Submit');
// CSS button
I.click('#form input[type=submit]');
// XPath
I.click('//form/*[@type=submit]');
// link in context
I.click('Logout', '#nav');
// using strict locator
I.click({css: 'nav a.login'});locator(string | object) clickable link or button located by text, or any element located by CSS|XPath|strict locator.context(string? | object) (optional,nullby default) element to search in CSS|XPath|Strict locator.
Close current tab
I.closeCurrentTab();Close all tabs except for the current one.
I.closeOtherTabs();Opposite to see. Checks that a text is not present on a page.
Use context parameter to narrow down the search.
I.dontSee('Login'); // assume we are already logged in.
I.dontSee('Login', '.nav'); // no login inside .nav elementtextstring which is not present.context(string | object)? (optional) element located by CSS|XPath|strict locator in which to perfrom search.
Verifies that the specified checkbox is not checked.
I.dontSeeCheckboxIsChecked('#agree'); // located by ID
I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
I.dontSeeCheckboxIsChecked('agree'); // located by nameChecks that cookie with given name does not exist.
I.dontSeeCookie('auth'); // no auth cookienamestring cookie name.
Checks that current url is not equal to provided one. If a relative url provided, a configured url will be prepended to it.
I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also okurlstring value to check.
Opposite to seeElement. Checks that element is not visible (or in DOM)
I.dontSeeElement('.modal'); // modal is not shownOpposite to seeElementInDOM. Checks that element is not on page.
I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or notChecks that current url does not contain a provided fragment.
urlstring value to check.
Checks that value of input field or textarea doesn't equal to given value
Opposite to seeInField.
I.dontSeeInField('email', 'user@user.com'); // field by name
I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSSfield(string | object) located by label|name|CSS|XPath|strict locator.valuestring value to check.
Checks that the current page does not contains the given string in its raw source code.
I.dontSeeInSource('<!--'); // no comments in sourcetextvaluestring to check.
Checks that title does not contain text.
I.dontSeeInTitle('Error');textstring value to check.
Performs a double-click on an element matched by link|button|label|CSS or XPath. Context can be specified as second parameter to narrow search.
I.doubleClick('Edit');
I.doubleClick('Edit', '.actions');
I.doubleClick({css: 'button.accept'});
I.doubleClick('.btn.edit');locator(string | object) clickable link or button located by text, or any element located by CSS|XPath|strict locator.context(string? | object) (optional,nullby default) element to search in CSS|XPath|Strict locator.
Drag an item to a destination element.
I.dragAndDrop('#dragHandle', '#container');srcElement(string | object) located by CSS|XPath|strict locator.destElement(string | object) located by CSS|XPath|strict locator.
Executes async script on page. Provided function should execute a passed callback (as first argument) to signal it is finished.
Example: In Vue.js to make components completely rendered we are waiting for nextTick.
I.executeAsyncScript(function(done) {
Vue.nextTick(done); // waiting for next tick
});By passing value to done() function you can return values.
Additional arguments can be passed as well, while done function is always last parameter in arguments list.
let val = await I.executeAsyncScript(function(url, done) {
// in browser context
$.ajax(url, { success: (data) => done(data); }
}, 'http://ajax.callback.url/');fn(string | function) function to be executed in browser context.args...any to be passed to function.
Returns Promise<any>
Executes sync script on a page. Pass arguments to function as additional parameters. Will return execution result to a test. In this case you should use async function and await to receive results.
Example with jQuery DatePicker:
// change date of jQuery DatePicker
I.executeScript(function() {
// now we are inside browser context
$('date').datetimepicker('setDate', new Date());
});Can return values. Don't forget to use await to get them.
let date = await I.executeScript(function(el) {
// only basic types can be returned
return $(el).datetimepicker('getDate').toString();
}, '#date'); // passing jquery selectorfn(string | function) function to be executed in browser context.args...any to be passed to function.
Returns Promise<any>
Fills a text field or textarea, after clearing its value, with the given string. Field is located by name, label, CSS, or XPath.
// by label
I.fillField('Email', 'hello@world.com');
// by name
I.fillField('password', secret('123456'));
// by CSS
I.fillField('form#login input[name=username]', 'John');
// or by strict locator
I.fillField({css: 'form#login input[name=username]'}, 'John');field(string | object) located by label|name|CSS|XPath|strict locator.valuestring text value to fill.
Retrieves an attribute from an element located by CSS or XPath and returns it to test.
An array as a result will be returned if there are more than one matched element.
Resumes test execution, so should be used inside async function with await operator.
let hint = await I.grabAttributeFrom('#tooltip', 'title');Returns Promise<string> attribute value
Get JS log from browser. Log buffer is reset after each request.
Resumes test execution, so should be used inside an async function with await operator.
let logs = await I.grabBrowserLogs();
console.log(JSON.stringify(logs))Returns Promise<Array<any>> all browser logs
Gets a cookie object by name.
If none provided gets all cookies.
Resumes test execution, so should be used inside async function with await operator.
let cookie = await I.grabCookie('auth');
assert(cookie.value, '123456');namestring? cookie name.
Returns Promise<string> attribute valueReturns cookie in JSON format.
Grab CSS property for given locator
Resumes test execution, so should be used inside an async function with await operator.
const value = await I.grabCssPropertyFrom('h3', 'font-weight');locator(string | object) element located by CSS|XPath|strict locator.cssPropertystring CSS property name.
Returns Promise<string> CSS value
Get current URL from browser. Resumes test execution, so should be used inside an async function.
let url = await I.grabCurrentUrl();
console.log(`Current URL is [${url}]`);Returns Promise<string> current URL
Retrieves the innerHTML from an element located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async function with await operator.
If more than one element is found - an array of HTMLs returned.
let postHTML = await I.grabHTMLFrom('#post');Returns Promise<string> HTML code for an element
Grab number of open tabs.
Resumes test execution, so should be used inside async function with await operator.
let tabs = await I.grabNumberOfOpenTabs();Returns Promise<number> number of open tabs
Grab number of visible elements by locator.
Resumes test execution, so should be used inside async function with await operator.
let numOfElements = await I.grabNumberOfVisibleElements('p');Returns Promise<number> number of visible elements
Retrieves a page scroll position and returns it to test.
Resumes test execution, so should be used inside an async function with await operator.
let { x, y } = await I.grabPageScrollPosition();Returns Promise<Object<string, any>> scroll position
Grab the text within the popup. If no popup is visible then it will return null
await I.grabPopupText();Retrieves page source and returns it to test.
Resumes test execution, so should be used inside async function with await operator.
let pageSource = await I.grabSource();Returns Promise<string> source code
Retrieves a text from an element located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async with await operator.
let pin = await I.grabTextFrom('#pin');If multiple elements found returns an array of texts.
Returns Promise<(string | Array<string>)> attribute value
Retrieves a page title and returns it to test.
Resumes test execution, so should be used inside async with await operator.
let title = await I.grabTitle();Retrieves a value from a form element located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async function with await operator.
let email = await I.grabValueFrom('input[name=email]');Returns Promise<string> attribute value
Injects Angular module.
I.haveModule('modName', function() {
angular.module('modName', []).value('foo', 'bar');
});modNamefn
Moves cursor to element matched by locator. Extra shift can be set with offsetX and offsetY options.
I.moveCursorTo('.tooltip');
I.moveCursorTo('#submit', 5,5);locator(string | object) located by CSS|XPath|strict locator.offsetXnumber (optional,0by default) X-axis offset.offsetYnumber (optional,0by default) Y-axis offset.
Moves to url
path
Open new tab and switch to it
I.openNewTab();Presses a key on a focused element. Special keys like 'Enter', 'Control', etc will be replaced with corresponding unicode. If modifier key is used (Control, Command, Alt, Shift) in array, it will be released afterwards.
I.pressKey('Enter');
I.pressKey(['Control','a']);Valid key names are:
'Add','Alt','ArrowDown'or'Down arrow','ArrowLeft'or'Left arrow','ArrowRight'or'Right arrow','ArrowUp'or'Up arrow','Backspace','Command','Control','Del','Divide','End','Enter','Equals','Escape','F1 to F12','Home','Insert','Meta','Multiply','Numpad 0'to'Numpad 9','Pagedown'or'PageDown','Pageup'or'PageUp','Pause','Semicolon','Shift','Space','Subtract','Tab'.
Reloads page
Reload the current page.
I.refreshPage();Removes mocked Angular module. If modName not specified - clears all mock modules.
I.resetModule(); // clears all
I.resetModule('modName');modName
Resize the current window to provided width and height.
First parameter can be set to maximize.
Performs right click on a clickable element matched by semantic locator, CSS or XPath.
// right click element with id el
I.rightClick('#el');
// right click link or button with text "Click me"
I.rightClick('Click me');
// right click button with text "Click me" inside .context
I.rightClick('Click me', '.context');locator(string | object) clickable element located by CSS|XPath|strict locator.context(string? | object) (optional,nullby default) element located by CSS|XPath|strict locator.
Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js). Filename is relative to output folder.
I.saveElementScreenshot(`#submit`,'debug.png');locator(string | object) element located by CSS|XPath|strict locator.fileNamestring file name to save.
Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
Filename is relative to output folder.
Optionally resize the window to the full available page scrollHeight and scrollWidth to capture the entire page by passing true in as the second argument.
I.saveScreenshot('debug.png');
I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshotfileNamestring file name to save.fullPageboolean (optional,falseby default) flag to enable fullscreen screenshot mode.
Scroll page to the bottom.
I.scrollPageToBottom();Scroll page to the top.
I.scrollPageToTop();Scrolls to element matched by locator. Extra shift can be set with offsetX and offsetY options.
I.scrollTo('footer');
I.scrollTo('#submit', 5, 5);locator(string | object) located by CSS|XPath|strict locator.offsetXnumber (optional,0by default) X-axis offset.offsetYnumber (optional,0by default) Y-axis offset.
Checks that a page contains a visible text. Use context parameter to narrow down the search.
I.see('Welcome'); // text welcome on a page
I.see('Welcome', '.content'); // text inside .content div
I.see('Register', {css: 'form.register'}); // use strict locatortextstring expected on page.context(string? | object) (optional,nullby default) element located by CSS|Xpath|strict locator in which to search for text.
Checks that all elements with given locator have given attributes.
I.seeAttributesOnElements('//form', { method: "post"});locator(string | object) located by CSS|XPath|strict locator.attributesobject attributes and their values to check.
Verifies that the specified checkbox is checked.
I.seeCheckboxIsChecked('Agree');
I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});Checks that cookie with given name exists.
I.seeCookie('Auth');namestring cookie name.
Checks that all elements with given locator have given CSS properties.
I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});locator(string | object) located by CSS|XPath|strict locator.cssPropertiesobject object with CSS properties and their values to check.
Checks that current url is equal to provided one. If a relative url provided, a configured url will be prepended to it. So both examples will work:
I.seeCurrentUrlEquals('/register');
I.seeCurrentUrlEquals('http://my.site.com/register');urlstring value to check.
Checks that a given Element is visible Element is located by CSS or XPath.
I.seeElement('#modal');Checks that a given Element is present in the DOM Element is located by CSS or XPath.
I.seeElementInDOM('#modal');Checks that current url contains a provided fragment.
I.seeInCurrentUrl('/register'); // we are on registration pageurlstring a fragment to check
Checks that the given input field or textarea equals to given value. For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
I.seeInField('Username', 'davert');
I.seeInField({css: 'form textarea'},'Type your comment here');
I.seeInField('form input[type=hidden]','hidden_value');
I.seeInField('#searchform input','Search');field(string | object) located by label|name|CSS|XPath|strict locator.valuestring value to check.
Checks that the active JavaScript popup, as created by window.alert|window.confirm|window.prompt, contains the
given string.
I.seeInPopup('Popup text');textstring value to check.
Checks that the current page contains the given string in its raw source code.
I.seeInSource('<h1>Green eggs & ham</h1>');textstring value to check.
Checks that title contains text.
I.seeInTitle('Home Page');textstring text value to check.
Asserts that an element appears a given number of times in the DOM. Element is located by label or name or CSS or XPath.
I.seeNumberOfElements('#submitBtn', 1);locator(string | object) element located by CSS|XPath|strict locator.numnumber number of elements.
Asserts that an element is visible a given number of times. Element is located by CSS or XPath.
I.seeNumberOfVisibleElements('.buttons', 3);locator(string | object) element located by CSS|XPath|strict locator.numnumber number of elements.
Checks that text is equal to provided one.
I.seeTextEquals('text', 'h1');textstring element value to check.context(string | object?) element located by CSS|XPath|strict locator.
Checks that title is equal to provided one.
I.seeTitleEquals('Test title.');text
Selects an option in a drop-down select. Field is searched by label | name | CSS | XPath. Option is selected by visible text or by value.
I.selectOption('Choose Plan', 'Monthly'); // select by label
I.selectOption('subscription', 'Monthly'); // match option by text
I.selectOption('subscription', '0'); // or by value
I.selectOption('//form/select[@name=account]','Premium');
I.selectOption('form select[name=account]', 'Premium');
I.selectOption({css: 'form select[name=account]'}, 'Premium');Provide an array for the second argument to select multiple options.
I.selectOption('Which OS do you use?', ['Android', 'iOS']);select(string | object) field located by label|name|CSS|XPath|strict locator.option(string | Array<any>) visible text or value of option.
Sets cookie(s).
Can be a single cookie object or an array of cookies:
I.setCookie({name: 'auth', value: true});
// as array
I.setCookie([
{name: 'auth', value: true},
{name: 'agree', value: true}
]);Switches frame or in case of null locator reverts to parent.
I.switchTo('iframe'); // switch to first iframe
I.switchTo(); // switch back to main pageSwitch focus to a particular tab by its number. It waits tabs loading and then switch tab
I.switchToNextTab();
I.switchToNextTab(2);num
Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
I.switchToPreviousTab();
I.switchToPreviousTab(2);num
Unselects a checkbox or radio button. Element is located by label or name or CSS or XPath.
The second parameter is a context (CSS or XPath locator) to narrow the search.
I.uncheckOption('#agree');
I.uncheckOption('I Agree to Terms and Conditions');
I.uncheckOption('agree', '//form');field(string | object) checkbox located by label | name | CSS | XPath | strict locator.context(string? | object) (optional,nullby default) element located by CSS | XPath | strict locator.
Pauses execution for a number of seconds.
I.wait(2); // wait 2 secssecnumber number of second to wait.
Waits for element to become clickable for number of seconds.
I.waitForClickable('#link');locatorsec
Waits for an element to become not attached to the DOM on a page (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitForDetached('#popup');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Waits for element to be present on page (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitForElement('.btn.continue');
I.waitForElement('.btn.continue', 5); // wait for 5 secslocator(string | object) element located by CSS|XPath|strict locator.secnumber? (optional,1by default) time in seconds to wait
Waits for element to become enabled (by default waits for 1sec). Element can be located by CSS or XPath.
locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional) time in seconds to wait, 1 by default.
Waits for a function to return true (waits for 1 sec by default). Running in browser context.
I.waitForFunction(fn[, [args[, timeout]])I.waitForFunction(() => window.requests == 0);
I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 secfn(string | function) to be executed in browser context.argsOrSec(Array<any> | number)? (optional,1by default) arguments for function or seconds.secnumber? (optional,1by default) time in seconds to wait
Waits for an element to be removed or become invisible on a page (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitForInvisible('#popup');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Waits for a text to appear (by default waits for 1sec). Element can be located by CSS or XPath. Narrow down search results by providing context.
I.waitForText('Thank you, form has been submitted');
I.waitForText('Thank you, form has been submitted', 5, '#modal');textstring to wait for.secnumber (optional,1by default) time in seconds to waitcontext(string | object)? (optional) element located by CSS|XPath|strict locator.
Waits for the specified value to be in value attribute.
I.waitForValue('//input', "GoodValue");field(string | object) input field.valuestring expected value.secnumber (optional,1by default) time in seconds to wait
Waits for an element to become visible on a page (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitForVisible('#popup');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
I.waitInUrl('/info', 2);Waits for a specified number of elements on the page.
I.waitNumberOfVisibleElements('a', 3);locator(string | object) element located by CSS|XPath|strict locator.numnumber number of elements.secnumber (optional,1by default) time in seconds to wait
Waits for an element to hide (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitToHide('#popup');locator(string | object) element located by CSS|XPath|strict locator.secnumber (optional,1by default) time in seconds to wait
Waits for a function to return true (waits for 1sec by default).
I.waitUntil(() => window.requests == 0);
I.waitUntil(() => window.requests == 0, 5);fn(function | string) function which is executed in browser context.secnumber (optional,1by default) time in seconds to waittimeoutMsgstring message to show in case of timeout fail.intervalnumber?
Waits for the entire URL to match the expected
I.waitUrlEquals('/info', 2);
I.waitUrlEquals('http://127.0.0.1:8000/info');just press button if no selector is given