Expect

When you're writing tests, you often need to check that values meet certain conditions. expect gives you access to a number of "matchers" that let you validate different things on the browser, an element or mock object.

Default Options

These default options below are connected to the waitforTimeout and waitforInterval options set in the config.

Only set the options below if you want to wait for specific timeouts for your assertions.

{

wait: 2000, // ms to wait for expectation to succeed

interval: 100, // interval between attempts

}

Set options like this:

before () {

require('expect-webdriverio').setOptions({ wait: 5000 })

},

Matcher Options

Every matcher can take several options that allows you to modify the assertion:

Command Options

Name	Type	Details
wait	number	time in ms to wait for expectation to succeed. Default: 3000
interval	number	interval between attempts. Default: 100
message	string	user message to prepend before assertion error

String Options

This options can be applied in addition to the command options when strings are being asserted.

Name	Type	Details
ignoreCase	boolean	apply toLowerCase to both actual and expected values
trim	boolean	apply trim to actual value
containing	boolean	expect actual value to contain expected value, otherwise strict equal.
asString	boolean	might be helpful to force converting property value to string

Number Options

This options can be applied in addition to the command options when numbers are being asserted.

Name	Type	Details
eq	number	equals
lte	number	less then equals
gte	number	greater than or equals

Browser Matchers

toHaveUrl

Checks if browser is on a specific page.

Usage

browser.url('https://webdriver.io/')

expect(browser).toHaveUrl('https://webdriver.io')

toHaveUrlContaining

Checks if browser is on a page URL that contains a value.

Usage

browser.url('https://webdriver.io/')

expect(browser).toHaveUrlContaining('webdriver')

toHaveTitle

Checks if website has a specific title.

Usage

browser.url('https://webdriver.io/')

expect(browser).toHaveTitle('WebdriverIO · Next-gen browser and mobile automation test framework for Node.js')

toHaveTitleContaining

Checks if website has a specific title that contains a value.

Usage

browser.url('https://webdriver.io/')

expect(browser).toHaveTitleContaining('WebdriverIO')

Element Matchers

toBeDisplayed

Calls isDisplayed on given element.

Usage

const elem = $('#someElem')

expect(elem).toBeDisplayed()

toBeVisible

Same as toBeDisplayed.

Usage

const elem = $('#someElem')

expect(elem).toBeVisible()

toExist

Calls isExisting on given element.

Usage

const elem = $('#someElem')

expect(elem).toExist()

toBePresent

Same as toExist.

Usage

const elem = $('#someElem')

expect(elem).toBePresent()

toBeExisting

Same as toExist.

Usage

const elem = $('#someElem')

expect(elem).toBeExisting()

toBeFocused

Checks if element has focus. This assertion only works in a web context.

Usage

const elem = $('#someElem')

expect(elem).toBeFocused()

toHaveAttribute

Checks if an element has a certain attribute with a specific value.

Usage

const myInput = $('input')

expect(myInput).toHaveAttribute('class', 'form-control')

toHaveAttr

Same as toHaveAttribute.

Usage

const myInput = $('input')

expect(myInput).toHaveAttr('class', 'form-control')

toHaveAttributeContaining

Checks if an element has a certain attribute that contains a value.

Usage

const myInput = $('input')

expect(myInput).toHaveAttributeContaining('class', 'form')

toHaveAttrContaining

Same as toHaveAttributeContaining.

Usage

const myInput = $('input')

expect(myInput).toHaveAttrContaining('class', 'form')

toHaveElementClass

Checks if an element has a certain class name.

Usage

const myInput = $('input')

expect(myInput).toHaveElementClass('form-control', { message: 'Not a form control!', })

toHaveElementClassContaining

Checks if an element has a certain class name that contains provided value.

Usage

const myInput = $('input')

expect(myInput).toHaveElementClassContaining('form')

toHaveElementProperty

Checks if an element has a certain property.

Usage

const elem = $('#elem')

expect(elem).toHaveElementProperty('height', 23)

expect(elem).not.toHaveElementProperty('height', 0)

toHaveValue

Checks if an input element has a certain value.

Usage

const myInput = $('input')

expect(myInput).toHaveValue('user', { ignoreCase: true })

toHaveValueContaining

Checks if an input element contains a certain value.

Usage

const myInput = $('input')

expect(myInput).toHaveValueContaining('us')

toBeClickable

Checks if an element can be clicked by calling isClickable on the element.

Usage

const elem = $('#elem')

expect(elem).toBeClickable()

toBeDisabled

Checks if an element is disabled by calling isEnabled on the element.

Usage

const elem = $('#elem')

expect(elem).toBeDisabled()

// same as

expect(elem).not.toBeEnabled()

toBeEnabled

Checks if an element is enabled by calling isEnabled on the element.

Usage

const elem = $('#elem')

expect(elem).toBeEnabled()

// same as

expect(elem).not.toBeDisabled()

toBeSelected

Checks if an element is enabled by calling isSelected on the element.

Usage

const elem = $('#elem')

expect(elem).toBeSelected()

toBeChecked

Same as toBeSelected.

Usage

const elem = $('#elem')

expect(elem).toBeChecked()

toHaveHref

Checks if link element has a specific link target.

Usage

const link = $('a')

expect(link).toHaveHref('https://webdriver.io')

toHaveLink

Same as toHaveHref.

Usage

const link = $('a')

expect(link).toHaveLink('https://webdriver.io')

toHaveHrefContaining

Checks if link element contains a specific link target.

Usage

const link = $('a')

expect(link).toHaveHrefContaining('webdriver.io')

toHaveLinkContaining

Same as toHaveHrefContaining.

Usage

const link = $('a')

expect(link).toHaveLinkContaining('webdriver.io')

toHaveId

Checks if element has a specific id attribute.

Usage

const elem = $('#elem')

expect(elem).toHaveId('elem')

toHaveText

Checks if element has a specific text. Can also be called with an array as parameter in the case where the element can have different texts.

Usage

browser.url('https://webdriver.io/')

const elem = $('.tagline')

expect(elem).toHaveText('Next-gen browser and mobile automation test framework for Node.js')

expect(elem).toHaveText(['Next-gen browser and mobile automation test framework for Node.js', 'Adding helper functions'])

toHaveTextContaining

Checks if element contains a specific text. Can also be called with an array as parameter in the case where the element can have different texts.

Usage

browser.url('https://webdriver.io/')

const elem = $('.tagline')

expect(elem).toHaveTextContaining('browser and mobile automation test framework')

expect(elem).toHaveTextContaining(['browser and mobile automation test framework', 'helper functions'])

toBeDisplayedInViewport

Checks if an element is within the viewport by calling isDisplayedInViewport on the element.

Usage

const elem = $('#elem')

expect(elem).toBeDisplayedInViewport()

toBeVisibleInViewport

Same as toBeDisplayedInViewport.

Usage

const elem = $('#elem')

expect(elem).toBeVisibleInViewport()

toHaveChildren

Checks amount of the fetched element's children by calling element.$('./*') command.

Usage

const list = $('ul')

expect(list).toHaveChildren() // the list has at least one item

// same as

expect(list).toHaveChildren({ gte: 1 })

expect(list).toHaveChildren(3) // the list has 3 items

// same as

expect(list).toHaveChildren({ eq: 3 })

toBeElementsArrayOfSize

Checks amount of fetched elements using $$ command.

Usage

const listItems = $$('ul>li')

expect(listItems).toBeElementsArrayOfSize(5) // 5 items in the list

expect(listItems).toBeElementsArrayOfSize({ lte: 10 })

// same as

assert.ok(listItems.length <= 10)

Network Matchers

toBeRequested

Checks that mock was called

Usage

const mock = browser.mock('**/api/todo*')

expect(mock).toBeRequested()

toBeRequestedTimes

Checks that mock was called for the expected amount of times

Usage

const mock = browser.mock('**/api/todo*')

expect(mock).toBeRequestedTimes(2) // expect(mock).toBeRequestedTimes({ eq: 2 })

expect(mock).toBeRequestedTimes({ gte: 5, lte: 10 }) // request called at least 5 times but less than 11

toBeRequestedWith

Checks that mock was called according to the expected options.

Most of the options supports expect/jasmine partial matchers like expect.objectContaining

Usage

const mock = browser.mock('**/api/todo*', { method: 'POST' })

expect(mock).toBeRequestedWith({

url: 'http://localhost:8080/api/todo', // [optional] string | function | custom matcher

method: 'POST', // [optional] string | array

statusCode: 200, // [optional] number | array

requestHeaders: { Authorization: 'foo' }, // [optional] object | function | custom matcher

responseHeaders: { Authorization: 'bar' }, // [optional] object | function | custom matcher

postData: { title: 'foo', description: 'bar' }, // [optional] object | function | custom matcher

response: { success: true }, // [optional] object | function | custom matcher

})

expect(mock).toBeRequestedWith({

url: expect.stringMatching(/.*\/api\/.*/i),

method: ['POST', 'PUT'], // either POST or PUT

statusCode: [401, 403], // either 401 or 403

requestHeaders: headers => headers.Authorization.startsWith('Bearer '),

postData: expect.objectContaining({ released: true, title: expect.stringContaining('foobar') }),

response: r => Array.isArray(r) && r.data.items.length === 20

})

Default Matchers

In addition to the expect-webdriverio matchers you can use builtin Jest's expect assertions or expect/expectAsync for Jasmine.