Презентация к 7 уроку курса по разработке пакетов на языке R

1. Разработка юнит тестов
к функциям вашего пакета
Основы тестирования с помощью testthat
Алексей Селезнёв

2. Мой telegram канал

3. Неформальный процесс тестирования пакета
1. Добавляете в пакет новую функцию
2. Загружаете весь функционал пакета с помощью devtools::load_all()
3. В ручном режиме тестируете новую функцию в консоли
4. В случае ошибки вносите изменения и повторяете итерацию

4. ВЕРНУВШИСЬ К КОДУ ПАКЕТА
СПУСТЯ НЕСКОЛЬКО
МЕСЯЦЕВ ДЛЯ ДОБАВЛЕНИЯ
НОВОГО ФУНКЦИОНАЛА ВЫ
ВРЯД ЛИ ВСПОМНИТЕ ВСЕ
ПРЕДЫДУЩИЕ ТЕСТЫ

5. И МОЖЕТЕ НАРУИШИТЬ ЕГО
РАБОТАЮЩИЙ ФУНКИОНАЛ
ВНЕДРИВ КАКИЕ ТО
ДОРАБОТКИ

6. Рабочий процесс тестирования
• С помощью функции usethis::use_testthat(3) настройте ваш пакет для тестирования
• При запуске будет создан каталог tests/testthat/
• В поле Suggests файла DESCRIPTION будет добавлен пакет testthat
• Создастся файл tests/testthat.R, который отвечает за запуск ваших тестов
• Создание функций и тестов к ним осуществляется двумя функциями
• usethis::use_r() – создаёт файл будущей функции в каталоге R/
• usethis::use_test() – создаёт файл test-function_name.R с тестами для функции в каталоге
tests/testthat/
• Запуск тестов осуществляется функцией devtools::test()

7. Организация тестов
• Файл содержит несколько связанных тестов.
• Тест объединяет несколько ожиданий для проверки выходных данных простой функции,
диапазона возможностей для одного параметра более сложной функции или тесно
связанныx нескольких функций. Тест создается с помощью test_that(desc, code), где:
• desc - краткое описание теста. Отчет о сбое теста включает это описание, поэтому вам нужно краткое
изложение цели теста, например, конкретного поведения.
• code – код теста, который зачастую состоит из ожиданий
• Ожидание — это атом тестирования. Он описывает ожидаемый результат вычисления:
имеет ли он правильное значение и правильный класс? Выдает ли он ошибку, когда
должен? Функции ожиданий имеют префикс expect_*()

8. Ожидания
• expect_equal(), expect_identical() - Возвращает ли код ожидаемое значение?
• expect_type(), expect_s3_class(), expect_s4_class() - Возвращает ли код объект,
унаследованный от ожидаемого базового типа, класса S3 или класса S4?
• expect_error(), expect_warning(), expect_message(), expect_condition() - Выдает ли код
ошибку, предупреждение, сообщение или другое условие?
• expect_length() - Возвращает ли код вектор указанной длины?
• expect_lt(), expect_lte(), expect_gt(), expect_gte() - Возвращает ли код число больше/меньше
ожидаемого значения?
• expect_named() - Возвращает ли код вектор с (заданными) именами?
• …

9. Snapshot тесты
• Snapshot тесты запоминают вывод, который был в консоли при первом его выполнении, и в
будущем сравнивают текущий вывод полученный при запуске тестов, с зафиксированным
при первом запуске значениям.
• Snapshot тесты работают только в пакетном (не интерактивном) режиме работы, т.е. их
можно запустить командой devtools::test().
• При первом запуске создаётся папка tests/testthat/_snaps/ в которую и будут собираться
снимки вывода результата работы функции в виде .md файлов.
• При каждом следующем запуске теста, вывод работы функции будет сравниваться с
созданным ранее эталоном.

10. Управление Snapshot тестами
• Команда testthat::snapshot_review() запускает Shiny приложение для локального просмотра
отличия в выводе функции, по сравнению с эталоном.
• Команда testthat::snapshot_accept() позволяет обновить эталонный снимок теста.

11. СПАСИБО ЗА ВНИМАНИЕ