Интеграционное тестирование

Baserow включает в себя набор интеграционных тестов в папке e2e-tests. Набор тестов использует инструмент тестирования Playwright для запуска UI-тестов на работающем экземпляре Baserow с использованием одного или нескольких браузеров.

Когда и что тестировать интеграционно

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

1. Сложные многосервисные UX-потоки, такие как дублирование базы данных
2. Сложный фронтенд-код, который сложно тестировать с помощью юнит-тестов
3. Граница сериализации между фронтенд-клиентом и бэкенд-API
4. Критические функции, которые часто случайно ломаются или функции, которые часто ломаются в других браузерах, и мы этого не замечаем.

Установка и запуск локально

Для локального запуска набора интеграционных тестов вам потребуется Node.js. С помощью nvm, его можно установить следующей командой:

nvm install v<version>

Замените <version> на поддерживаемую версию Node.js, указанную в baserow/docs/installation/supported.md.

Для запуска интеграционных тестов:

# Запустите ваш локальный окружение, которое будет тестироваться
$ ./dev.sh
$ cd e2e-tests
# Следующий скрипт устанавливает пакет интеграционных тестов, ждет, пока ваше локальное окружение станет здоровым,
# а затем запускает тесты.
$ ./run-e2e-tests-locally.sh 
# После этого вы можете вручную перезапускать тесты с помощью различных команд:
yarn test # без графического интерфейса
yarn test-headed
yarn test-ui # запускает режим с графическим интерфейсом. Лучший способ отладки ваших тестов.
yarn codegen # Помогает генерировать тесты прямо в браузере. Используйте его как источник вдохновения;
             # скелет можно использовать, но часть сгенерированного кода может быть некорректной.
             # Внесите необходимые изменения после использования.

yarn test и yarn test-* запустят все тесты в Chrome.

Конфигурация

Помимо конфигурации Playwright, определенной в e2e-tests/playwright.config.ts, вы можете установить переменные окружения для целевого экземпляра Baserow на любом URL с помощью PUBLIC_WEB_FRONTEND_URL и PUBLIC_BACKEND_URL. Вы также можете использовать файл e2e-tests/.env для этого, см. e2e-tests/.env-example.