assertView
Обзор
Используйте команду assertView, чтобы снять скриншот элемента для определенного состояния теста и сравнить его с эталонным.
Использование
await browser.$(selector).assertView(state, options);
Команда assertView использует waitForExist (с
waitTimeout и waitInterval), чтобы дождаться появления элемента перед снятием скриншота.
assertView автоматически ждет загрузки статики (шрифтов, изображений и т.д.) с помощью команды waitForStaticToLoad.
Параметры команды
| Имя | Тип | Описание |
| state | string | Обязательный параметр. Название состояния теста. Должно быть уникальным в пределах одного теста. |
| options | AssertViewOpts | Настройки команды assertView. |
state
Обязательный параметр. Задает название состояния теста. Название должно быть уникальным в пределах одного теста.
options
Задает настройки команды assertView:
| Опция | Тип | Описание |
| ignoreElements | string | string[] | Элементы (задаются как селекторы), которые будут проигнорированы при сравнении скриншотов. Игнор реализуется с помощью закраски перечисленных элементов черным цветом. Если по любому из селекторов найдено несколько элементов, будут проигнорированы все найденные элементы. |
| tolerance | number | Чувствительность к разнице в цветах, по умолчанию 3.0. Подробнее. |
| antialiasingTolerance | number | Чувствительность к антиалиасингу, по умолчанию 4. Подробнее. |
| allowViewportOverflow | boolean | По умолчанию Testplane выводит предупреждение, если элемент не удалось снять целиком. Эта опция отключает предупреждение. Используйте ее вместе с |
| captureElementFromTop | boolean | По умолчанию Testplane может проскроллить страницу к элементу перед снятием скриншота, если элемент изначально не виден. Если отключить эту опцию и элемент изначально не виден, Testplane выбросит ошибку. |
| compositeImage | boolean | По умолчанию Testplane снимает элемент целиком: делает несколько скриншотов, скроллит элемент и затем склеивает изображения. Если отключить эту опцию, будет снята только та часть элемента, которая видна на первом скриншоте. |
| screenshotDelay | number | Задержка в миллисекундах перед снятием скриншота. Может пригодиться, чтобы дождаться исчезновения скроллбара перед снятием скриншота. |
| disableAnimation | boolean | Отключение анимаций и переходов при снятии скриншота. По умолчанию |
| ignoreDiffPixelCount | number | `${number}%` | Процент пикселей, которые нужно игнорировать при диффе. Удобно для игнорирования очень маленьких диффов. По умолчанию |
| waitForStaticToLoadTimeout | number | По умолчанию Если указать |
| disableHover | "always" | "never" | "when-scrolling-needed" | По умолчанию Testplane отключает hover-эффекты, если для полного скриншота элемента нужен скролл. Доступно начиная с версии |
| cropMargins | { top?: number, right?: number, bottom?: number, left?: number } | Задает отступы, на которые нужно обрезать скриншот. Удобно, например, чтобы обрезать скроллбары на Android-эмуляторах. Доступно начиная с версии |
| selectorToScroll | string | Устарело. Начиная с Testplane 9, элемент для скролла определяется автоматически. Ручная настройка влияет на то, какой элемент Testplane будет скроллить при снятии скриншота. |
Примеры использования
example.js
it("should assert view", async ({ browser }) => {
await browser.url("some/url");
const elem = await browser.$(".button");
await elem.assertView("plain");
await elem.click();
await elem.assertView("clicked");
});
История
| Версия | Изменения |
|---|---|
| v9.0.0 | Крупное обновление логики работы |
| v8.32.0 | Добавлена опция waitForStaticToLoadTimeout. |
| v8.2.0 | Добавлена опция ignoreDiffPixelCount. |
| v8.0.0 | Значение disableAnimation по умолчанию изменилось на true. |