Какую главную задачу должны решать тесты? Этот вопрос невероятно важен. Ответ на него дает понимание того, как правильно писать тесты и как писать их не нужно.
Представьте, что вы написали функцию capitalize($text), которая делает заглавной первую букву переданной строки:
<?php
capitalize('hello'); // 'Hello'
Вот один из вариантов ее реализации:
<?php
namespace StringUtils;
function capitalize($text)
{
$firstSymbol = strtoupper($text[0]);
$restSubstring = substr($text, 1);
return "{$firstSymbol}{$restSubstring}";
}
Что мы делаем после создания функции? Проверяем, как она работает. Например, открываем REPL и вызываем функцию с разными аргументами:
php -a
Interactive shell
php > echo capitalize('hello');
'Hello'
> echo capitalize('how are you?');
> 'How are you?'
Таким нехитрым способом убеждаемся, что функция работает. По крайней мере для тех аргументов, которые мы передали в нее. Если во время проверки заметили ошибки, то исправляем функцию и повторяем все заново.
Фактически, весь этот процесс — это и есть тестирование, но не автоматическое, а ручное. Задача такого тестирования — убедиться, что код работает, как надо. В этом случае нам без разницы, как конкретно реализована эта функция.
Теперь мы можем ответить на главный вопрос, заданный в начале урока:
Тесты проверяют, что код или приложение работает корректно. Они не заботятся о том, как конкретно написан код, который они проверяют.
Что такое автоматические тесты
Все, что требуется от автоматических тестов — повторить проверки, которые мы выполняли при ручном тестировании. Для этого достаточно старого доброго if и исключений.
Даже если вы не знакомы с исключениями, ничего страшного. В этом курсе достаточно знать две вещи: для чего они нам нужны и какой у них синтаксис.
До сих пор в курсах Хекслета вы встречались с ошибками, которые возникают непроизвольно: вызов несуществующей функции, обращение к несуществующей переменной и так далее. Но ошибки можно порождать самостоятельно с помощью исключений, что необходимо для нашей ситуации. Исключения создаются такой конструкцией:
<?php
// Дословно: выбросить новую ошибку
// Исключения бросают
throw new Exception('Описание исключения');
// Код после этого выражения не выполнится, а сам скрипт завершится с ошибкой
print_r('nothing');
Пример теста:
<?php
if (capitalize('hello') !== 'Hello') { // Если результат функции не равен ожидаемому значению,
// то мы выбрасываем исключение и завершаем выполнение теста
throw new Exception('Функция работает неверно!');
}
Из примера выше видно, что тесты — это точно такой же код, как и любой другой. Он работает в том же окружении и подчиняется тем же правилам — например, стандартам кодирования. А еще он может содержать ошибки. Но это не значит, что надо писать тесты на тесты. Если бы мы стремились избавиться от всех ошибок, стоимость разработки стала бы неоправданно высокой. Обнаруженные ошибки в тестах исправляются, и жизнь продолжается дальше ;)
Как правило, тесты складывают в специальную директорию в корне проекта. Обычно она называется tests, хотя встречаются и другие варианты:
bin
└── php-package
src/
└── User.php
tests/
└── UserTest.php
Структура этой директории зависит от того, на основе какого фреймворка пишутся тесты. В простых случаях она отражает структуру исходного кода. Если предположить, что наша функция capitalize($text) определена в файле src/StringUtils.php, то ее тест лучше поместить в файл tests/StringUtilsTest.php. Слово Test в имени модуля с тестами используется только для более явного обозначения цели файла.
Теперь при любых изменениях, затрагивающих эту функцию, важно не забывать запускать тесты:
php tests/StringUtilsTest.php
# Если все хорошо, код молча выполнится
# Если есть ошибка, то будет выведено сообщение об ошибке
Как пишутся тесты
Тесты — это не магия. Разработчикам нужно самостоятельно импортировать тестируемые функции, вызывать их с необходимыми аргументами и проверять, что функции возвращают ожидаемые значения.
Для примера представим, что у нас поменялась сигнатура функции — входные или выходные параметры, ее имя. В таком случае придется переписывать тесты. Рассмотрим, что будет, если сигнатура осталась той же, но поменялись внутренности функции:
<?php
function capitalize($text)
{
$firstSymbol = mb_strtoupper($text[0]);
$restSubstring = mb_substr($text, 1);
return "{$firstSymbol}{$restSubstring}";
}
Тогда тесты должны продолжать работать без изменений. Хорошие тесты ничего не знают про внутреннее устройство проверяемого кода. Это делает их более универсальными и надежными.
Количество проверок
Невозможно написать тесты, которые гарантируют стопроцентную работоспособность кода. Для этого пришлось бы реализовать проверки всех возможных аргументов, что физически невозможно. С другой стороны, без тестов вообще нет никаких гарантий, что код будет работать.
При написании тестов нужно ориентироваться на разнообразие входных данных. У любой функции есть один или несколько основных сценариев использования. Например, в случае capitalize() — это любое слово. Достаточно написать ровно одну проверку, которая покрывает этот сценарий. Дальше нужно смотреть на пограничные случаи. Это ситуации, в которых код может повести себя по-особенному:
- Работа с пустой строкой
- Обработка
null - Деление на ноль (потому что в большинстве языков оно вызывает ошибку)
- Специфические ситуации для конкретных алгоритмов
Для capitalize() пограничным случаем будет пустая строка:
<?php
if (capitalize('') !== '') {
throw new Exception('Функция работает неверно!');
}
Добавив тест на пустую строку, мы увидим, что вызов функции capitalize() завершается с ошибкой. Внутри нее идет обращение к первому индексу строки без проверки его существования. Посмотрим на исправленную версию кода:
<?php
function capitalize($text)
{
if ($text === '') {
return '';
}
$firstSymbol = mb_strtoupper($text[0]);
$restSubstring = mb_substr($text, 1);
return "{$firstSymbol}{$restSubstring}";
}
Обычно пограничные случаи требуют отдельной обработки и наличия условных конструкций. Тесты должны строиться так, чтобы они затрагивали каждую такую конструкцию. Но не забывайте, что условные конструкции могут порождать хитрые связи.
Например, функция из двух независимых условных блоков может выполниться:
- Так, что не выполнился ни один условный блок
- Так, что выполнился только первый условный блок
- Так, что выполнился только второй условный блок
- Так, что выполнились оба условных блока
Комбинация всех возможных вариантов поведения функции называется цикломатической сложностью. Это число показывает все возможные пути выполнения программы внутри функции. Цикломатическая сложность — хороший ориентир для понимания того, сколько и какие тесты нужно написать.
Иногда пограничные случаи не связаны с условными конструкциями. Особенно часто такие ситуации встречаются там, где есть вычисления границ слов или массивов. Такой код может работать в большинстве ситуаций, но только в некоторых может давать сбой:
<?php
// В этой функции мы забыли отнять единицу от длины
// Этот код сработает, если в массиве нет элементов или последний элемент null
// В остальных случаях он вернет неверное значение
function last($elements)
{
return $elements[count($elements)];
}
Проверка входных данных
Отдельно рассмотрим ошибки типов входных данных. Например, в функцию capitalize() можно передать число вместо строки. Как она должна себя вести в таком случае? Нужно ли писать такой тест?
Есть еще один интересный вопрос. Нужно ли внутри capitalize() обрабатывать такие ситуации? Ответ — не нужно. Иначе код превратится в мусорку, а пользы от этого мало. Все равно должны быть тесты, которые проверяют, что система работает в целом, а они обычно выявляют проблемы кода на более нижних уровнях.
Ответственность за передачу правильных данных в функцию capitalize() лежит не на самой функции, а на коде, который вызывает ее. Если он хорошо протестирован, то подобная ошибка либо обнаружится, либо вообще не возникнет.
Даже если ошибка обрабатывается внутри функции, не надо пытаться написать тесты, покрывающие каждую ошибку. Это выливается в огромное число тестов, которые требуют поддержки и времени на написание. Нужно уметь вовремя остановиться и двигаться дальше, к покрытию другого кода.
Собирая все вместе
В конечном итоге мы получили такую структуру директорий:
src/
└── StringUtils.php
tests/
└──StringUtilsTest.php
Содержимое теста:
<?php
if (StringUtils\capitalize('hello') !== 'Hello') {
throw new \Exception('Функция работает неверно!');
}
if (StringUtils\capitalize('') !== '') {
throw new \Exception('Функция работает неверно!');
}
echo 'Все тесты пройдены!';
Запуск:
php tests/StringUtilsTest.php
https://replit.com/@hexlet/php-testing-goal-capitalize
Если все написано правильно, то запуск тестов завершится с выводом строки Все тесты пройдены!. Если в тестах или в коде есть ошибка, то сработает исключение, и мы увидим сообщение, указывающее на это.
Самостоятельная работа
- Воспроизведите структуру, получившуюся в конце урока
- Запустите тесты и убедитесь, что они работают
- Попробуйте сломать тесты
- Добавьте код на GitHub
Остались вопросы? Задайте их в разделе «Обсуждение»
Вам ответят команда поддержки Хекслета или другие студенты
Для полного доступа к курсу нужен базовый план
Базовый план откроет полный доступ ко всем курсам, упражнениям и урокам Хекслета, проектам и пожизненный доступ к теории пройденных уроков. Подписку можно отменить в любой момент.
