Edit

mock

This is a beta feature. Please give us feedback and file an issue if certain scenarions don't work as expected!

Mock the response of a request. You can define a mock based on a matching glob and corresponding header and status code. Calling the mock method returns a stub object that you can use to modify the response of the web resource.

With the stub object you can then either return a custom response or have the request fail.

There are 3 ways to modify the response:

• return a custom JSON object (for stubbing API request)
• replace web resource with a local file (service a modifed JavaScript file) or
• redirect resource to a different url

Usage

browser.mock(url, { method, headers })

Parameters

Name	Type	Details
url	String	url to mock
filterOptions optional	MockFilterOptions	filter mock resource by additional options
filterOptions.method optional	String	filter resource by HTTP method
filterOptions.headers optional	Object	filter resource by specific request headers

Example

it('should mock network resources', () => {
    // via static string
    const userListMock = browser.mock('**' + '/users/list')
    // you can also specifying the mock even more by filtering resources
    // by headers or status code, e.g. mock only responses with specific
    // header set
    const strictMock = browser.mock('**', {
        // mock all json responses
        headers: { 'Content-Type': 'application/json' }
    })
})

it('should modify API responses', () => {
    const todoMock = browser.mock('**' + '/todos', {
        method: 'get'
    })

    // mock an endpoint with a fixed fixture
    mock.respond([{
        title: 'Injected Todo',
        order: null,
        completed: false,
        url: "http://todo-backend-express-knex.herokuapp.com/916"
    }])

    // respond with different status code or header
    mock.respond([{
        title: 'Injected Todo',
        order: null,
        completed: false,
        url: "http://todo-backend-express-knex.herokuapp.com/916"
    }], {
        statusCode: 404,
        headers: {
            'x-custom-header': 'foobar'
        }
    })
})

it('should modify text assets', () => {
    const scriptMock = browser.mock('**' + '/script.min.js')
    scriptMock.respond('./tests/fixtures/script.js')
})

it('should redirect web resources', () => {
    const headerMock = browser.mock('**' + '/header.png')
    headerMock.respond('https://media.giphy.com/media/F9hQLAVhWnL56/giphy.gif')

    const pageMock = browser.mock('https://google.com/')
    pageMock.respond('https://webdriver.io')
    browser.url('https://google.com')
    console.log(browser.getTitle()) // returns "WebdriverIO · Next-gen browser and mobile automation test framework for Node.js"
})