testplane-global-hook.md

@testplane/global-hook

Обзор

Используйте плагин @testplane/global-hook, чтобы вынести общую логику из своих тестов в специальные обработчки для beforeEach и afterEach хуков.

Часто, перед тем как запустить очередной testplane-тест, нужно выполнить определенную подготовительную работу, например:

• очистить все cookies;
• почистить localStorage;
• инициализировать какую-либо переменную теста.

Чтобы не прописывать эти действия в каждом тесте, вы можете описать их в настройках плагина в виде функции для хука beforeEach.

Аналогично, после завершения основных проверок в testplane-тесте, вы можете захотеть всегда проверять наличие ошибок в клиентском коде, срабатывание нужных метрик и т. п.

Чтобы не прописывать эти действия в каждом тесте, вы можете описать их в настройках плагина в виде функции для хука afterEach.

Установка

npm install -D @testplane/global-hook

Настройка

Необходимо подключить плагин в разделе plugins конфига testplane:

module.exports = {
    plugins: {
        '@testplane/global-hook': {
            beforeEach: async ({browser}) => {
                await browser.deleteCookie(); // Например, мы хотим всегда очищать cookies перед запуском теста
            },
            afterEach: async ({browser}) => {
                await browser.execute(() => {
                    try {
                        localStorage.clear(); // И всегда очищать за собой localStorage после завершения теста
                    } catch (e) { }
                });
            }
        },

        // другие плагины гермионы...
    },

    // другие настройки гермионы...
};

Расшифровка параметров конфигурации

Параметр	Тип	По умолчанию	Описание
enabled	Boolean	true	Включить / отключить плагин.
beforeEach	Function	null	Асинхронная функция-обработчик, которая будет выполняться перед запуском каждого теста.
afterEach	Function	null	Асинхронная функция-обработчик, которая будет выполняться после завершения каждого теста.

Полезные ссылки

• Исходники плагина @testplane/global-hook
• Команда browser.deleteCookie
• Команда browser.execute
• Команда browser.executeAsync