url
Команда url
загружает URL в браузере. Если в конфигурации указан baseUrl, он будет добавлен к параметру url с использованием метода url.resolve() из Node.js. Вызов browser.url('...')
с тем же URL, что и в последний раз, вызовет перезагрузку страницы. Однако, если URL содержит хэш, браузер не запустит новую навигацию, и пользователю необходимо обновить страницу, чтобы запустить новую.
Команда возвращает объект WebdriverIO.Request
, который содержит информацию о запросе и данных ответа при загрузке страницы:
interface WebdriverIO.Request {
id?: string
url: string
timestamp: number
navigation?: string
redirectChain?: string[],
headers: Record<string, string>
cookies?: NetworkCookie[]
\/**
* Error message if request failed
*\/
error?: string
response?: {
fromCache: boolean
headers: Record<string, string>
mimeType: string
status: number
},
/**
* List of all requests that were made due to the main request.
* Note: the list may be incomplete and does not contain request that were
* made after the command has finished.
*
* The property will be undefined if the request is not a document request
* that was initiated by the browser.
*\/
children?: Request[]
}
Команда поддерживает следующие опции:
wait
Желаемое состояние запрашиваемого ресурса перед завершением команды. Поддерживает следующие состояния:
none
: без ожидания после выполнения запроса страницы и получения ответаinteractive
: ожидание до тех пор, пока страница не станет интерактивнойcomplete
: ожидание до полной загрузки DOM-дерева страницыnetworkIdle
: ожидание до тех пор, пока не останется ожидающих сетевых запросов
headers
Заголовки, которые будут отправлены с запросом.
По умолчанию: {}
auth
Учетные данные для базовой аутентификации.
Примечание: это перезапишет существующий заголовок Authorization
, если он предоставлен в опции headers
.
timeout
Если задано числовое значение, команда будет ждать указанное количество миллисекунд для загрузки всех ответов страницы перед возвратом.
Примечание: чтобы это имело эффект, требуется установить опцию wait
в значение networkIdle
.
По умолчанию: 5000
Использование
browser.url(url, { wait, timeout, onBeforeLoad, auth, headers })
Параметры
Имя | Тип | Подробности |
---|---|---|
url необязательно | string | URL для навигации |
options необязательно | UrlOptions | опции навигации |
options.wait необязательно | 'none', 'interactive', 'networkIdle', 'complete' | Желаемое состояние запрашиваемого ресурса перед завершением команды. По умолчанию: 'complete' |
options.timeout необязательно | number | Если задано числовое значение, команда будет ждать указанное количество миллисекунд для загрузки всех ответов страницы перед возвратом. По умолчанию: 5000 |
options.onBeforeLoad необязательно | Function | Функция, которая вызывается до того, как ваша страница загрузит все свои ресурсы. Она позволяет легко изменить окружение, например, переопределить Web API, которые использует ваше приложение. |
options.auth необязательно | {user: string, pass: string} | учетные данные для базовой аутентификации |
options.headers необязательно | Record<string, string> | заголовки, которые будут отправлены с запросом |
Примеры
// navigate to a new URL
const request = await browser.url('https://webdriver.io');
// log url
console.log(request.url); // outputs: "https://webdriver.io"
console.log(request.response?.status); // outputs: 200
console.log(request.response?.headers); // outputs: { 'content-type': 'text/html; charset=UTF-8' }
// With a base URL of http://example.com/site, the following url parameters resolve as such:
// When providing a scheme:
// https://webdriver.io
await browser.url('https://webdriver.io');
// When not starting with a slash, the URL resolves relative to the baseUrl
// http://example.com/site/relative
await browser.url('relative');
// When starting with a slash, the URL resolves relative to the root path of the baseUrl
// http://example.com/rootRelative
await browser.url('/rootRelative');
// navigate to a URL with basic authentication
await browser.url('https://the-internet.herokuapp.com/basic_auth', {
auth: {
user
pass
}
});
await expect($('p=Congratulations! You must have the proper credentials.').toBeDisplayed();
// navigate to a URL and mock the battery API
await browser.url('https://pazguille.github.io/demo-battery-api/', {
onBeforeLoad (win) {
// mock "navigator.battery" property
// returning mock charge object
win.navigator.getBattery = () => Promise.resolve({
level: 0.5,
charging: false,
chargingTime: Infinity,
dischargingTime: 3600, // seconds
})
}
})
// now we can assert actual text - we are charged at 50%
await expect($('.battery-percentage')).toHaveText('50%')
// and has enough juice for 1 hour
await expect($('.battery-remaining')).toHaveText('01:00)
Возвращает
- <WebdriverIO.Request>
returns
: объект запроса загрузки страницы с информацией о данных запроса и ответа