Файл конфигурации
Файл конфигурации содержит всю необходимую информацию для запуска вашего набора тестов. Это модуль NodeJS, который экспортирует JSON.
Вот пример конфигурации со всеми поддерживаемыми свойствами и дополнительной информацией:
export const config = {
// ==================================
// Где должны быть запущены ваши тесты
// ==================================
//
runner: 'local',
//
// =====================
// Конфигурации сервера
// =====================
// Адрес хоста запущенного сервера Selenium. Эта информация обычно устаревшая, так как
// WebdriverIO автоматически подключается к localhost. Также, если вы используете один из
// поддерживаемых облачных сервисов, к ак Sauce Labs, Browserstack, Testing Bot или LambdaTest, вам также не
// нужно определять информацию о хосте и порте (потому что WebdriverIO может определить это
// из вашей информации о пользователе и ключе). Однако, если вы используете приватный бэкенд Selenium,
// вам следует определить здесь `hostname`, `port`, и `path`.
//
hostname: 'localhost',
port: 4444,
path: '/',
// Protocol: http | https
// protocol: 'http',
//
// =================
// Поставщики услуг
// =================
// WebdriverIO поддерживает Sauce Labs, Browserstack, Testing Bot и LambdaTest. (Другие облачные провайдеры
// тоже должны работать.) Эти сервисы определяют конкретные значения `user` и `key` (или ключ доступа),
// которые вы должны указать здесь для подключения к этим сервисам.
//
user: 'webdriverio',
key: 'xxxxxxxxxxxxxxxx-xxxxxx-xxxxx-xxxxxxxxx',
// Если вы запускаете тесты на Sauce Labs, вы можете указать регион, в котором хотите запускать тесты
// через свойство `region`. Доступные короткие обозначения для регионов: `us` (по умолчанию) и `eu`.
// Эти регионы используются для VM облака Sauce Labs и облака реальных устройств Sauce Labs.
// Если вы не укажете регион, по умолчанию используется `us`.
region: 'us',
//
// Sauce Labs предоставляет [предложение headless](https://saucelabs.com/products/web-testing/sauce-headless-testing),
// которое позволяет запускать тесты Chrome и Firefox в режиме headless.
//
headless: false,
//
// ==================
// Указание тестовых файлов
// ==================
// Определяет, какие тестовые спецификации должны запускаться. Шаблон относится к директории
// файла конфигурации, который запускается.
//
// Спецификации определяются как массив файлов спецификаций (опционально с использованием подстановочных знаков,
// которые будут расширены). Тест для каждого файла спецификации будет запущен в отдельном
// рабочем процессе. Чтобы группа файлов спецификаций запускалась в одном и том же рабочем
// процессе, заключите их в массив внутри массива specs.
//
// Путь к файлам спецификаций будет разрешен относительно директории
// файла конфигурации, если он не абсолютный.
//
specs: [
'test/spec/**',
['group/spec/**']
],
// Шаблоны для исключения.
exclude: [
'test/spec/multibrowser/**',
'test/spec/mobile/**'
],
//
// ============
// Capabilities
// ============
// Определите ваши capabilities здесь. WebdriverIO может запускать несколько capabilities одновременно.
// В зависимости от количества capabilities, WebdriverIO запускает несколько тестовых
// сессий. В рамках ваших `capabilities` вы можете переопределить опции `spec` и `exclude`,
// чтобы группировать определенные спецификации для определенного capability.
//
// Сначала вы можете определить, сколько экземпляров должно быть запущено одновременно. Допустим,
// у вас есть 3 разных capabilities (Chrome, Firefox и Safari), и вы
// установили `maxInstances` на 1. wdio создаст 3 процесса.
//
// Таким образом, если у вас 10 файлов спецификаций и вы установили `maxInstances` на 10, все файлы спецификаций
// будут тестироваться одновременно, и будет создано 30 процессов.
//
// Свойство определяет, сколько capabilities из одного и того же теста должны запускать тесты.
//
maxInstances: 10,
//
// Или установите лимит для запуска тестов с определенным capability.
maxInstancesPerCapability: 10,
//
// Вставляет глобальные переменные WebdriverIO (например, `browser`, `$` и `$$`) в глобальное окружение.
// Если установить в `false`, вы должны импортировать их из `@wdio/globals`. Примечание: WebdriverIO не
// обрабатывает внедрение глобальных переменных, специфичных для тестового фреймворка.
//
injectGlobals: true,
//
// Если у вас возникают проблемы с получением всех важных capabilities вместе, проверьте
// конфигуратор платформы Sauce Labs - отличный инструмент для настройки ваших capabilities:
// https://docs.saucelabs.com/basics/platform-configurator
//
capabilities: [{
browserName: 'chrome',
'goog:chromeOptions': {
// для запуска chrome в режиме headless требуются следующие флаги
// (см. https://developers.google.com/web/updates/2017/04/headless-chrome)
// args: ['--headless', '--disable-gpu'],
}
//
// Параметр для игнорирования некоторых или всех флагов по умолчанию
// - если значение true: игнорировать все флаги DevTools 'по умолчанию' и аргументы Puppeteer 'по умолчанию'
// - если значение является массивом: DevTools фильтрует указанные аргументы по умолчанию
// 'wdio:devtoolsOptions': {
// ignoreDefaultArgs: true,
// ignoreDefaultArgs: ['--disable-sync', '--disable-extensions'],
// }
}, {
// maxInstances может быть переопределен для каждого capability. Так, если у вас есть внутренняя сетка Selenium
// только с 5 доступными экземплярами firefox, вы можете убедиться, что одновременно
// запускается не более 5 экземпляров.
'wdio:maxInstances': 5,
browserName: 'firefox',
'wdio:specs': [
'test/ffOnly/*'
],
'moz:firefoxOptions': {
// флаг для активации режима Firefox headless (см. https://github.com/mozilla/geckodriver/blob/master/README.md#firefox-capabilities для более подробной ин формации о moz:firefoxOptions)
// args: ['-headless']
},
// Если указан outputDir, WebdriverIO может захватывать логи сессии драйвера
// можно настроить, какие типы логов исключать.
excludeDriverLogs: ['*'], // передайте '*', чтобы исключить все логи сессии драйвера
excludeDriverLogs: ['bugreport', 'server'],
//
// Параметр для игнорирования некоторых или всех аргументов Puppeteer по умолчанию
// ignoreDefaultArgs: ['-foreground'], // установите значение в true, чтобы игнорировать все аргументы по умолчанию
}],
//
// Дополнительный список аргументов node для использования при запуске дочерних процессов
execArgv: [],
//
// ===================
// Конфигурации тестов
// ===================
// Определите все опции, которые имеют отношение к экземпляру WebdriverIO здесь
//
// Уровень подробности логирования: trace | debug | info | warn | error | silent
logLevel: 'info',
//
// Установить конкретные уровни логирования для каждого логгера
// используйте уровень 'silent' для отключения логгера
logLevels: {
webdriver: 'info',
'@wdio/appium-service': 'info'
},
//
// Установить директорию для хранения всех логов
outputDir: __dirname,
//
// Если вы хотите запускать тесты только до определенного количества неудачных тестов, используйте
// bail (по умолчанию 0 - не прерывать, запускать все тесты).
bail: 0,
//
// Установите базовый URL, чтобы сократить вызовы команды `url()`. Если ваш параметр `url` н ачинается
// с `/`, `baseUrl` добавляется в начало, не включая часть пути из `baseUrl`.
//
// Если ваш параметр `url` начинается без схемы или `/` (например, `some/path`), `baseUrl`
// добавляется непосредственно в начало.
baseUrl: 'http://localhost:8080',
//
// Тайм-аут по умолчанию для всех команд waitForXXX.
waitforTimeout: 1000,
//
// Добавьте файлы для отслеживания (например, код приложения или объекты страниц) при запуске команды `wdio`
// с флагом `--watch`. Поддерживаются шаблоны.
filesToWatch: [
// например, перезапуск тестов при изменении кода приложения
// './app/**/*.js'
],
//
// Фреймворк, с которым вы хотите запускать спецификации.
// Поддерживаются следующие: 'mocha', 'jasmine' и 'cucumber'
// См. также: https://webdriver.io/docs/frameworks.html
//
// Убедитесь, что у вас установлен пакет адаптера wdio для конкретного фреймворка перед запуском тестов.
framework: 'mocha',
//
// Количество повторных попыток для всего файла спецификации при его полном сбое
specFileRetries: 1,
// Задержка в секундах между попытками повторного запуска файла спецификации
specFileRetriesDelay: 0,
// Должны ли повторные попытки файлов спецификаций повторяться немедленно или быть отложены в конец очереди
specFileRetriesDeferred: false,
//
// Репортер тестов для stdout.
// Единственный, поддерживаемый по умолчанию, - 'dot'
// См. также: https://webdriver.io/docs/dot-reporter.html и щелкните "Reporters" в левой колонке
reporters: [
'dot',
['allure', {
//
// Если вы используете репортер "allure", вы должны определить директорию, в которой
// WebdriverIO должен сохранять все отчеты allure.
outputDir: './'
}]
],
//
// Опции, передаваемые в Mocha.
// См. полный список на: http://mochajs.org
mochaOpts: {
ui: 'bdd'
},
//
// Опции, передаваемые в Jasmine.
// См. также: https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-jasmine-framework#jasmineopts-options
jasmineOpts: {
//
// Тайм-аут Jasmine по умолчанию
defaultTimeoutInterval: 5000,
//
// Фреймворк Jasmine позволяет перехватывать каждое утверждение для логирования состояния приложения
// или веб-сайта в зависимости от результата. Например, очень удобно делать скриншот каждый раз,
// когда утверждение не выполняется.
expectationResultHandler: function(passed, assertion) {
// сделать что-то
},
//
// Использовать специфичную для Jasmine функциональность grep
grep: null,
invertGrep: null
},
//
// Если вы используете Cucumber, вам нужно указать, где находятся ваши определения шагов.
// См. также: https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework#cucumberopts-options
cucumberOpts: {
require: [], // <string[]> (file/dir) требовать файлы перед выполнением функций
backtrace: false, // <boolean> показывать полную трассировку для ошибок
compiler: [], // <string[]> ("extension:module") требовать файлы с данным РАСШИРЕНИЕМ после требования МОДУЛЯ (повторяемо)
dryRun: false, // <boolean> вызывать форматировщики без выполнения шагов
failFast: false, // <boolean> прервать выполнение при первой ошибке
snippets: true, // <boolean> скрыть фрагменты определения шагов для ожидающих шагов
source: true, // <boolean> скрыть URI источников
strict: false, // <boolean> завершить с ошибкой, если есть какие-либо неопределенные или ожидающие шаги
tagExpression: '', // <string> (выражение) выполнять только функции или сценарии с тегами, соответствующими выражению
timeout: 20000, // <number> тайм-аут для определений шагов
ignoreUndefinedDefinitions: false, // <boolean> Включите эту конфигурацию, чтобы рассматривать неопределенные определения как предупреждения.
scenarioLevelReporter: false // Включите это, чтобы webdriver.io вел себя так, как будто сценарии, а не шаги, являются тестами.
},
// Укажите пользовательский путь к tsconfig - WDIO использует `tsx` для компиляции файлов TypeScript
// Ваш TSConfig автоматически определяется из текущего рабочего каталога
// но вы можете указать пользовательский путь здесь или установив переменную окружения TSX_TSCONFIG_PATH
// См. документацию `tsx`: https://tsx.is/dev-api/node-cli#custom-tsconfig-json-path
tsConfigPath: 'path/to/tsconfig.json',
//
// =====
// Хуки
// =====
// WebdriverIO предоставляет несколько хуков, которые вы можете использовать для вмешательства в процесс тестирования,
// чтобы улучшить его и создавать вокруг него сервисы. Вы можете применить к нему одну функцию или массив
// методов. Если один из них возвращает обещание, WebdriverIO будет ждать, пока это обещание будет
// выполнено, чтобы продолжить.
//
/**
* Выполняется один раз перед запуском всех воркеров.
* @param {object} config объект конфигурации wdio
* @param {Array.<Object>} capabilities список деталей возможностей
*/
onPrepare: function (config, capabilities) {
},
/**
* Выполняется перед созданием рабочего процесса и может использоваться для инициализации определенного сервиса
* для этого рабочего процесса, а также для изменения среды выполнения асинхронным образом.
* @param {string} cid идентификатор возможности (например, 0-0)
* @param {object} caps объект, содержащий возможности для сессии, которая будет создана в рабочем процессе
* @param {object} specs спецификации для запуска в рабочем процессе
* @param {object} args объект, который будет объединен с основной конфигурацией после инициализации рабочего процесса
* @param {object} execArgv список строковых аргументов, переданных рабочему процессу
*/
onWorkerStart: function (cid, caps, specs, args, execArgv) {
},
/**
* Выполняется после завершения рабочего процесса.
* @param {string} cid идентификатор возможности (например, 0-0)
* @param {number} exitCode 0 - успех, 1 - сбой
* @param {object} specs спецификации для запуска в рабочем процессе
* @param {number} retries количество использованных повторных попыток
*/
onWorkerEnd: function (cid, exitCode, specs, retries) {
},
/**
* Выполняется перед инициализацией сессии webdriver и тестового фреймворка. Это позволяет
* манипулировать конфигурациями в зависимости от возможности или спецификации.
* @param {object} config объект конфигурации wdio
* @param {Array.<Object>} capabilities список деталей возможностей
* @param {Array.<String>} specs Список путей к файлам спецификаций, которые должны быть запущены
*/
beforeSession: function (config, capabilities, specs) {
},
/**
* Выполняется перед началом выполнения теста. В этот момент вы имеете доступ ко всем глобальным
* переменным, таким как `browser`. Это идеальное место для определения пользовательских команд.
* @param {Array.<Object>} capabilities список деталей возможностей
* @param {Array.<String>} specs Список путей к файлам спецификаций, которые должны быть запущены
* @param {object} browser экземпляр созданной сессии браузера/устройства
*/
before: function (capabilities, specs, browser) {
},
/**
* Выполняется перед началом набора тестов (только в Mocha/Jasmine).
* @param {object} suite детали набора тестов
*/
beforeSuite: function (suite) {
},
/**
* Этот хук выполняется _перед_ каждым хуком внутри набора.
* (Например, это выполняется перед вызовом `before`, `beforeEach`, `after`, `afterEach` в Mocha.). В Cucumber `context` - это объект World.
*
*/
beforeHook: function (test, context, hookName) {
},
/**
* Хук, который выполняется _после_ каждого хука внутри набора.
* (Например, это выполняется после вызова `before`, `beforeEach`, `after`, `afterEach` в Mocha.). В Cucumber `context` - это объект World.
*/
afterHook: function (test, context, { error, result, duration, passed, retries }, hookName) {
},
/**
* Функция, выполняемая перед тестом (только в Mocha/Jasmine)
* @param {object} test объект теста
* @param {object} context объект области, с которым был выполнен тест
*/
beforeTest: function (test, context) {
},
/**
* Выполняется перед выполнением команды WebdriverIO.
* @param {string} commandName имя команды хука
* @param {Array} args аргументы, которые получила бы команда
*/
beforeCommand: function (commandName, args) {
},
/**
* Выполняется после выполнения команды WebdriverIO
* @param {string} commandName имя команды хука
* @param {Array} args аргументы, которые получила бы команда
* @param {number} result 0 - успех команды, 1 - ошибка команды
* @param {object} error объект ошибки, если есть
*/
afterCommand: function (commandName, args, result, error) {
},
/**
* Функция, выполняемая после теста (только в Mocha/Jasmine)
* @param {object} test объект теста
* @param {object} context объект области, с которым был выполнен тест
* @param {Error} result.error объект ошибки в случае сбоя теста, иначе `undefined`
* @param {*} result.result возвращаемый объект функции теста
* @param {number} result.duration продолжительность теста
* @param {boolean} result.passed true, если тест пройден, иначе false
* @param {object} result.retries информация о повторных попытках, связанных со спецификацией, например, `{ attempts: 0, limit: 0 }`
*/
afterTest: function (test, context, { error, result, duration, passed, retries }) {
},
/**
* Хук, который выполняется после завершения набора (только в Mocha/Jasmine).
* @param {object} suite детали набора
*/
afterSuite: function (suite) {
},
/**
* Выполняется после завершения всех тестов. У вас все еще есть доступ ко всем глобальным переменным из
* теста.
* @param {number} result 0 - тест пройден, 1 - тест не пройден
* @param {Array.<Object>} capabilities список деталей возможностей
* @param {Array.<String>} specs Список путей к файлам спецификаций, которые были запущены
*/
after: function (result, capabilities, specs) {
},
/**
* Выполняется сразу после завершения сессии webdriver.
* @param {object} config объект конфигурации wdio
* @param {Array.<Object>} capabilities список деталей возможностей
* @param {Array.<String>} specs Список путей к файлам спецификаций, которые были запущены
*/
afterSession: function (config, capabilities, specs) {
},
/**
* Выполняется после завершения работы всех рабочих процессов и перед завершением процесса.
* Ошибка, выброшенная в хуке `onComplete`, приведет к сбою запуска теста.
* @param {object} exitCode 0 - успех, 1 - сбой
* @param {object} config объект конфигурации wdio
* @param {Array.<Object>} capabilities список деталей возможностей
* @param {<Object>} results объект, содержащий результаты тестов
*/
onComplete: function (exitCode, config, capabilities, results) {
},
/**
* Выполняется при обновлении.
* @param {string} oldSessionId ID сессии старой сессии
* @param {string} newSessionId ID сессии новой сессии
*/
onReload: function(oldSessionId, newSessionId) {
},
/**
* Хуки Cucumber
*
* Выполняется перед функцией Cucumber.
* @param {string} uri путь к файлу функции
* @param {GherkinDocument.IFeature} feature объект функции Cucumber
*/
beforeFeature: function (uri, feature) {
},
/**
*
* Выполняется перед сценарием Cucumber.
* @param {ITestCaseHookParameter} world объект world, содержащий информацию о pickle и шаге теста
* @param {object} context объект World Cucumber
*/
beforeScenario: function (world, context) {
},
/**
*
* Выполняется перед шагом Cucumber.
* @param {Pickle.IPickleStep} step данные шага
* @param {IPickle} scenario pickle сценария
* @param {object} context объект World Cucumber
*/
beforeStep: function (step, scenario, context) {
},
/**
*
* Выполняется после шага Cucumber.
* @param {Pickle.IPickleStep} step данные шага
* @param {IPickle} scenario pickle сценария
* @param {object} result объект результатов, содержащий результаты сценария
* @param {boolean} result.passed true, если сценарий пройден
* @param {string} result.error стек ошибок, если сценарий не пройден
* @param {number} result.duration продолжительность сценария в миллисекундах
* @param {object} context объект World Cucumber
*/
afterStep: function (step, scenario, result, context) {
},
/**
*
* Выполняется после сценария Cucumber.
* @param {ITestCaseHookParameter} world объект world, содержащий информацию о pickle и шаге теста
* @param {object} result объект результатов, содержащий результаты сценария `{passed: boolean, error: string, duration: number}`
* @param {boolean} result.passed true, если сценарий пройден
* @param {string} result.error стек ошибок, если сценарий не пройден
* @param {number} result.duration продолжительность сценария в миллисекундах
* @param {object} context объект World Cucumber
*/
afterScenario: function (world, result, context) {
},
/**
*
* Выполняется после функции Cucumber.
* @param {string} uri путь к файлу функции
* @param {GherkinDocument.IFeature} feature объект функции Cucumber
*/
afterFeature: function (uri, feature) {
},
/**
* Выполняется перед тем, как библиотека утверждений WebdriverIO делает утверждение.
* @param commandName имя команды
* @param args аргументы, которые получила бы команда
*/
beforeAssertion: function (params) {
},
/**
* Выполняется после выполнения команды WebdriverIO
* @param commandName имя команды
* @param args аргументы, которые получила бы команда
* @param result результат команды
* @param error ошибка в случае, если что-то пошло не так
*/
afterAssertion: function (params) {
}
}
Вы также можете найти файл со всеми возможными опциями и вариациями в папке с примерами.
