Gemini – утилита для регрессионного тестирования отображения веб-страниц.
В отличие от других подобных инструментов, Gemini позволяет проверять отдельные блоки, а не всю страницу целиком. Эта возможность делает тесты более надежными и позволяет эффективно реагировать на изменения любой части веб-страницы.
Gemini создан в Яндексе и используется разработчиками библиотек блоков.
Для начала работы необходимо:
GraphicsMagickПод MacOS X можно воспользоваться Homebrew для установки :
brew install graphicsmagick- selenium-grid (локально или удаленно) для тестирования на всех браузерах.
- phantomjs
Когда все зависимости будут настроены, необходимо установить npm-пакет:
npm install -g geminiКонфигурационный файл Gemini .gemini.yml находится в корне проекта.
Пример:
rootUrl: http://site.example.com
gridUrl: http://selenium-grid.example.com:4444/wd/hub
browsers:
- chrome
- phantomjs
- name: opera
version: '12.06'
- name: firefox
version: '28.0'
- name: firefox
version: '27.0'Поля конфигурационного файла:
-
rootUrl- корневой адрес вашего веб-сайта. Целевые адреса ваших тестов будут назначены относительно корневого URL. -
gridUrl- адрес Selenium Grid для создания скриншотов. Параметр обязателен, если тесты запускаются в каких-либо бразуерах кромеphantomjs. -
browsers- список браузеров, используемых для тестирования. Все браузеры должны быть доступны в Silenium Grid. Каждый браузер должен в обязательном порядке иметь ключname. Ключversionопционален. Есть возможность использовать несколько версий одного и того же браузера (только в том случае, если эти версии доступны в вашем экземпляре сетки). Если версия не указана, будет использована любая доступная версия браузера с указанным именем.- browser nameэто сокращенный вариант записи- name: browser name -
screenshotsDir- каталог для хранения файлов со снимками экрана, указанный относительно директории конфигурационного файла. По умолчанию –gemini/screens.
Для блока, который будет тестироваться, необходимо написать один или несколько наборов тестов. Каждый набор должен содержать несколько состояний, которые нужно проверить. Для каждого состояния необходимо указать последовательность действий, приводящую блок к данному состоянию.
Наборы тестов определяются методом gemini.suite. Например:
var gemini = require('gemini');
gemini.suite('button', function(suite) {
suite
.setUrl('/path/to/page')
.setCaptureElements('.button')
.before(function(actions, find) {
this.button = find('.buttons');
})
.capture('plain')
.capture('hovered', function(actions, find) {
actions.mouseMove(this.button);
})
.capture('pressed', function(actions, find) {
actions.mouseDown(this.button);
})
.capture('clicked', function(actions, find) {
actions.mouseUp(this.button);
});
});Аргументы gemini.suite:
name- название нового тестового набора, которое отображается в отчетах и именах снимков экрана.callback(suite)- функция обратног B5D3 о вызова. Используется для настройки тестового набора. Получает экземпляр класса SuiteBuilder, описанного ниже.
Все методы можно связать в цепочку:
-
setUrl(url)- указывает адрес веб-страницы, с которой необходимо сделать снимок. Адрес задается относительно поляrootUrlконфигурационного файла. -
setCaptureElements('selector1', 'selector2', ...})- указывает CSS-селекторы элементов для определения региона веб-страницы, с которой необходимо сделать снимок.Захватываемая для снимка область экрана определяется минимальным прямоугольником, который включает в себя все необходимые элементы и их размеры
box-shadow.Может также принять массив:
suite.setCaptureElements(['.selector1', '.selector2']);
Все тесты из набора будут неуспешными, если хотя бы один из элементов не будет найден.
-
skip([browser])- пропустить все тесты и вложенные наборы для всех браузеров; только для перечисленных браузеров; или только для указанных версий браузеров.skip()- пропустить тесты и вложенные наборы для всех браузеров;skip(browserName)илиskip({name: browserName})- пропустить тесты для всех версий указанного браузера;skip({name: browserName, version: browserVersion})- пропустить тесты только для указанной версии браузера;skip([browser1, browser2, ...])- пропустить тесты для нескольких браузеров или версий.
Все браузеры из последующих вызовов
skip()добавляются в список пропускаемых:suite.skip({name: 'browser1', version: '1.0'}) .skip('browser2');
то же самое, что и:
suite.skip([ {name: 'browser1', version: '1.0'}, 'browser2' ]);
-
capture(stateName, callback(actions, find))- определяет новое состояние снимка. Опциональная функция обратного вызова описывает последовательность действий, которая приводит страницу к данному состоянию. Новый цикл действий, приводящий к новому состоянию, всегда начинается от предыдущего и выполняется последовательно в порядке объявления, без перезагрузок браузера между этапами выполнения.Функция обратного вызова принимает два аргумента:
actions- объект, методы которого можно связать в цепочку. Используется для определения выполнения ряда действий.find(selector)- данная функция используется для поиска элемента, чтобы начать с ним работу. Поиск является отложенным и выполняется только при первом обращении к данному элементу. Поиск будет выполнен один раз для каждого вызоваfind. Если вам необходимо выполнить несколько действий над одним и тем же элементом, сохраните результат в переменную:
.capture('name', function(actions, find) { var button = find('.button'); actions.mouseDown(button) .mouseUp(button); });
-
before(callback(actions, find))- используйте данную функцию для выполнения кода до первого состояния. Данные аргументы функции обратного вызова одинаковы и для функции обратного вызоваcapture. Контекст является общим для обратного вызоваbeforeи всех других обратных вызовов состояния набора. Потому можно использовать этот прием для поиска нужного элемента один раз для всего набора и результат будет всегда актуален.suite.before(function(actions, find) { this.button = find('.buttons'); }) .capture('hovered', function(actions, find) { actions.mouseMove(this.button); }) .capture('pressed', function(actions, find) { actions.mouseDown(this.button); })
Наборы могут быть вложенными. В этом случае внутренний набор наследует от внешнего url и captureElements.
Эти свойства могут быть переопределены во внутренних наборах, не оказывая влияния на внешние.
Каждый новый набор вызывает перезагрузку браузера, даже если адрес страницу не изменился.
```javascript
var gemini = require('gemini');
gemin.suite('parent', function(parent) {
parent.setUrl('/some/path')
.setCaptureElements('.selector1', '.selector2');
.capture('state');
gemini.suite('first child', function(child) {
//данный набор фиксирует один и тот же элемент на разных страницах
child.setUrl('/other/path')
.capture('other state');
});
gemini.suite('second child', function(child) {
//данный набор фиксирует разные элементы на одной и той же странице
child.setCaptureElements('.next-selector'})
.capture('third state', function(actions, elements) {
// ...
})
gemini.suite('grandchild', function(grandchild) {
//child suites can have own childs
grandchild.capture('fourth state');
});
});
gemini.suite('third child', function(child) {
//this child uses completely different URL and set
//of elements
child.setUrl('/some/another/path')
.setCaptureElements('.different-selector');
.capture('fifth state');
});
});
```При вызове методов аргумента actions обратного вызова, у вас есть возможность запрограммировать ряд шагов, которые приведут блок в необходимое состояние. Все вызовы можно объединить в цепочку. Таким образом каждый последующий шаг будет выполняться после завершения предыдущего. В списке, представленном ниже, element может бы как CSS-селектором, так и результатом вызова find.
-
click(element)- клик мышью по центру элемента; -
doubleClick(element)- двойной клик мышью по центру элемента; -
mouseDown(element, [button])- нажатие кнопкой мыши на центр элемента; Возможные значения кнопки: 0 - левая, 1 - средняя, 2 - правая. По умолчанию используется левая кнопка. -
mouseUp(element)- отпускание кнопки мыши; -
mouseMove(element, [offset])- наведение мышью на элемент. Смещение задается относительно центра элемента. По умолчанию{x: 0, y: 0}; -
dragAndDrop(element, dragTo)- перетаскиваниеelementв другойdragTo-элемент. -
executeJS(function(window))- запуск указанной функции в браузере. Аргументом функции является объект браузераwindow:actions.executeJS(function(window) { window.alert('Hello!'); });
Обратите внимание, что функция выполняется в контексте браузера, поэтому любые ссылки на внешний контекст обратного вызова работать не будут.
wait(milliseconds)- ожидание указанного времени до выполнения следующего действия. Если действие является последним в списке, откладывает скриншот на этот период времени.sendKeys([element], keys)- отправляет серию нажатий на клавиатуру к указанному или к активному в данный момент элементу страницы.
Вы можете отправить специальную клавишу, используя один из предусмотренных констант, а именно:
```javascript
actions.sendKeys(gemini.ARROW_DOWN);
```Полный список специальных ключей:
`NULL`, `CANCEL`, `HELP`, `BACK_SPACE`, `TAB`, `CLEAR`, `RETURN`, `ENTER`, `SHIFT`, `LEFT_SHIFT `, `CONTROL`,
`LEFT_CONTROL`, `ALT`, `LEFT_ALT`, `PAUSE`, `ESCAPE`, `SPACE`, `PAGE_UP`, `PAGE_DOWN`, `END`, `HOME`, `LEFT`,
`ARROW_LEFT`, `UP`, `ARROW_UP`, `RIGHT`, `ARROW_RIGHT`, `DOWN,`, `ARROW_DOWN`, `INSERT`, `DELETE`, `SEMICOLON`,
`EQUALS`, `NUMPAD0`, `NUMPAD1`, `NUMPAD2`, `NUMPAD3`, `NUMPAD4`, `NUMPAD5`, `NUMPAD6`, `NUMPAD7`, `NUMPAD8`,
`NUMPAD9`, `MULTIPLY`, `ADD`, `SEPARATOR`, `SUBTRACT`, `DECIMAL`, `DIVIDE`, `F1`, `F2`, `F3`, `F4`, `F5`,
`F6`, `F7`, `F8`, `F9`, `F10`, `F11`, `F12`, `COMMAND`, `META`, `ZENKAKU_HANKAKU`.Вам необходимо установить и запустить selenium-server если вы хотите выполнять тесты на реальных браузерах.
Без selenium-server вы можете использовать только phantomjs. Для этого запустите phantomjs в режиме веб-драйвера перед тем как начать использовать gemini:
phantomjs --webdriver=4444Как только у вас появится несколько наборов, необходимо будет сделать снимок эталонного изображения:
gemini gather [paths to suites]Если не указан ни один путь, каждый .js-файл из директории
gemini будет прочитан.
По умолчанию конфигурация загружается из файла .gemini.yml текущей директории.
Чтобы указать другой файл конфигурации используйте --config или -c опции.
Для сравнения вашего эталонного изображения с текущим состоянием блока используйте следующую команду:
gemini test [paths to suites]Пути и конфигурация обрабатываются таким же образом, как в команду gather.
Каждое состояние, отличающееся от эталонного изображения, будет считаться неуспешно пройденным тестом.
По умолчанию вам будут видны только имена состояний. Для получения большей информации вы можете использовать HTML-отчеты:
gemini test --reporter html [paths to suites]
Таким образом будет создан HTML-файл в директории gemini-report, в котором будет отображаться эталонное и текущее изображение, а также разница между ними для каждого состояния в каждом браузере.