Трассировка выполнения

Одной из важнейших задач при автоматизированном тестировании является анализ и отладка процесса выполнения скриптов. Особенно это важно, когда приложение работает в браузере и тесты взаимодействуют с его элементами. В Puppeteer существует несколько инструментов для отслеживания шагов тестов, их результатов и ошибок. Эффективное использование трассировки позволяет разработчикам быстро находить и устранять проблемы, улучшая стабильность и качество тестирования.

Включение трассировки выполнения

Для того чтобы начать трассировать выполнение тестов с использованием Puppeteer, необходимо включить режим трассировки. Puppeteer предоставляет удобный способ для включения подробного логирования через библиотеку debug, которая является частью самого Puppeteer. Для этого нужно в терминале перед запуском тестов указать переменную окружения, которая будет активировать вывод отладочных сообщений: 

DEBUG=puppeteer:* node test.js

Этот метод позволяет выводить подробную информацию о внутренних процессах работы Puppeteer, включая взаимодействие с браузером, запросы и ответы от серверов, а также выполнение команд в контексте страниц.

Отслеживание сетевых запросов

Трассировка сетевых запросов может быть крайне полезной, особенно если тестируемая страница зависит от асинхронных данных или API. Puppeteer позволяет перехватывать и логировать сетевые запросы с помощью события request. Для этого можно использовать следующий код: 

const browser = await puppeteer.launch();
const page = await browser.newPage();

page.on(&
  console.log('Request made: ', request.url());
});

await page.goto('https://example.com');
await browser.close();

Этот пример выводит URL всех запросов, сделанных на странице. Трассировка сетевых запросов позволяет отслеживать работу внешних сервисов и помогает выявлять проблемы с загрузкой данных, например, с медленными API или неправильными ответами от сервера.

Логирование действий с элементами страницы

Отслеживание действий с элементами страницы помогает понять, что происходит в процессе выполнения тестов, особенно если тесты взаимодействуют с большим количеством DOM-элементов. Для этого можно использовать методы page.click(), page.type() и другие, добавляя логирование перед каждым действием: 

await page.click('#submit-button');
console.log('Clicked on the submit button');

Такие логи помогут понять последовательность выполнения тестов и проанализировать, на каком шаге возникает ошибка. Иногда, при работе с динамическими элементами, можно столкнуться с ситуацией, когда элемент не доступен для взаимодействия. В таких случаях полезно будет зафиксировать, был ли элемент найден и доступен для взаимодействия.

Логирование ошибок

Для более детального отслеживания ошибок важно добавлять обработку исключений на каждый шаг теста. В Puppeteer можно обрабатывать ошибки как на уровне самого браузера, так и на уровне конкретных операций на странице.

Пример обработки ошибок при взаимодействии с элементами: 

try {
  await page.click('#non-existent-button');
} catch (error) {
  console.error('Error occurred while clicking the button: ', error);
}

Этот подход позволяет не только фиксировать ошибку, но и дать точное описание того, что именно не получилось выполнить. Такой метод также полезен для того, чтобы исключить возможные ошибки из-за отсутствия элементов на странице или неправильных локаторов.

Использование пауз и тайм-аутов

При выполнении автоматизированных тестов важно учитывать, что некоторые элементы на странице могут загружаться асинхронно. Чтобы правильно организовать взаимодействие с ними, часто необходимо делать паузы или задавать тайм-ауты. Puppeteer позволяет управлять временем ожидания через методы waitForSelector(), waitForTimeout() и другие: 

await page.waitForSelector('#button', { timeout: 5000 });
console.log('Button appeared on the page');

Кроме того, полезно отслеживать время загрузки страниц, запросов или выполнения определенных операций, чтобы определить, где происходят задержки. Для этого можно добавить таймера: 

const startTime = Date.now();
await page.goto('https://example.com');
const endTime = Date.now();
console.log(`Page loaded in ${endTime - startTime}ms`);

Снимки экрана и видео

Еще один эффективный способ трассировки выполнения — это создание снимков экрана или запись видео в процессе выполнения тестов. Puppeteer предоставляет простые методы для этих целей.

Создание снимков экрана: 

await page.screenshot({ path: 'screenshot.png' });

Запись видео: 

const videoStream = await page.video().start();
await page.goto('https://example.com');
await videoStream.stop();

Такие средства позволяют визуализировать процесс выполнения тестов, а также анализировать страницы, на которых произошли ошибки или баги.

Интеграция с логированием и внешними сервисами

Иногда важно отправлять трассировочную информацию в лог-файлы или использовать внешние сервисы для хранения и анализа этих данных. Это особенно актуально при запуске тестов в CI/CD-средах. Для этого можно использовать библиотеки логирования, такие как winston или log4js. Важно интегрировать эти инструменты в тестовый процесс для автоматического сбора и хранения логов.

Пример интеграции с winston: 

const winston = require('winston');

const logger = winston.createLogger({
  transports: [
    new winston.transports.File({ filename: 'combined.log' }),
    new winston.transports.Console()
  ]
});

logger.info('Starting the Puppeteer test');
await page.goto('https://example.com');
logger.info('Page loaded successfully');

Таким образом, все логи тестов будут записываться как в консоль, так и в файл, что полезно для последующего анализа.

Анализ трассировочных данных

Когда тесты не проходят, а ошибка связана с асинхронными процессами или нестабильной работой браузера, важность трассировки становится очевидной. Сбор всех данных о запросах, действиях с элементами и состоянии страницы позволяет не только понять, на каком этапе произошла ошибка, но и найти причины её возникновения.

Анализ трассировочных данных обычно включает в себя проверку последовательности действий, проверки на отсутствие элементов или ошибок в консоли, а также времени выполнения операций. С помощью таких данных можно выявлять узкие места в производительности, проблемы с рендерингом элементов и неправильные ответы от серверов.

Заключение

Трассировка выполнения в Puppeteer — это мощный инструмент для улучшения качества автоматизированных тестов. С помощью логирования, мониторинга сетевых запросов, отслеживания ошибок и времени выполнения можно значительно упростить процесс отладки и повысить надежность тестов. Правильная настройка трассировки помогает не только в случае ошибок, но и в процессе оптимизации тестов и выявления возможных проблем на ранних этапах разработки.

Оглавление