Php testing - пишем тесты на PHP Unit

Опубликовано 2021.08.22

Написание тестов - очень важная часть любого проекта. Если проект большой и сложный-тесты не раз вас спасут.

В чём смысл.

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

Пример.

Есть бизнес требование "по трём входящим числам найти наибольшее, наименьшее и их сумму".

Решение:

class Values {
    function getMax($a, $b, $c) {
        return max([$a, $b, $c]);
    }
 
    function getMin($a, $b, $c) {
        return min([$a, $b, $c]);
    }
 
    function getSum($a, $b, $c) {
        return array_sum([$a, $b, $c]);
    }
}

Вроде бы всё очевидно и код полностью рабочий. Проверьте сами:

$values = new Values();
echo $values->getMin(5, 45, 2) . '<br />';
echo $values->getMax(55, 122, -7) . '<br />';
echo $values->getSum(5, 45, 0) . '<br />';

Для того чтобы запустить unit test - нужно добавить его библиотеку в composer.json:

{
  "name": "root/project",
  "description": "description",
  "minimum-stability": "stable",
  "license": "proprietary",
  "authors": [
    {
      "name": "admin",
      "email": "email@example.com"
    }
  ],
  "require": {
      "phpunit/phpunit": "5.4.*"
  }
}

Далее делаем composer install

Тест для таких функций будет выглядеть вот так, поместим его в файл ValuesTest.php:

include_once "../vendor/autoload.php";
include_once "../file.php"; // в этом файле хранится класс Values
 
use PHPUnit\Framework\TestCase;
 
class ValuesTest extends TestCase
{
    /**
     * @dataProvider additionMaxProvider
     */
    public function testGetMax($a, $b, $c, $max)
    {
        $values = new Values();
        $result_max = $values->getMax($a, $b, $c);
        $this->assertEquals($result_max, $max);
    }
 
    /**
     * @dataProvider additionMinProvider
     */
    public function testGetMin($a, $b, $c, $min)
    {
        $values = new Values();
        $result_min = $values->getMin($a, $b, $c);
        $this->assertEquals($result_min, $min);
    }
 
    /**
     * @dataProvider additionSumProvider
     */
    public function testGetSum($a, $b, $c, $sum)
    {
        $values = new Values();
        $result_sum = $values->getSum($a, $b, $c);
        $this->assertEquals($result_sum, $sum);
    }
 
    // Ниже функции, которые вернут аргументы для методов тестирования.
    // По их названиям вы поймёте что к чему. 
    // Первые три числа в каждом массиве - это аргументы, а последний - это правильный результат
 
    public function additionMaxProvider()
    {
        return [
            [2, 1, 5, 5],
            [0, 1, 1, 1],
            [0, 0, 0, 0],
            [1, -61, 3, 3]
        ];
    }
 
    public function additionMinProvider()
    {
        return [
            [2, 1, 5, 1],
            [0, 1, 1, 0],
            [0, 0, 0, 0],
            [1, -61, 3, -61]
        ];
    }
 
    public function additionSumProvider()
    {
        return [
            [2, 1, 5, 8],
            [0, 1, 1, 2],
            [0, 0, 0, 0],
            [1, -61, 3, -57]
        ];
    }
}

Попробуем запустить тесты. Переходим в папку с файлом ValuesTest.php и пишем команду:

phpunit ValuesTest.php

Если вы всё сделали верно - результат будет таким:

PHPUnit 5.4.8 by Sebastian Bergmann and contributors.
 
............     12 / 12 (100%)
 
Time: 52 ms, Memory: 4.00MB
 
OK (12 tests, 12 assertions)

12 тестов - это по 4 прогона с разными данными на 3 теста.

А теперь представьте такие ситуации:

$values = new Values();
echo $values->getMin(5, 45, "car") . '<br />';
echo $values->getMin(5, [55, 4], 2) . '<br />';

Ошибки не будет, так как php умеет приводить типы к нужному. Результат будет "car" и 2.

Но мы всё же обработаем такие ситуации, так как согласно бизнес логике мы обрабатываем только числа.

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

Добавим метод checkArguments для валидации. Вынесем её в четвёртый метод и будем вызывать в наших трёх.

class Values {
    function checkArguments($a, $b, $c) {
        foreach([$a, $b, $c] as $val) {
            if (!is_int($val)) {
                throw new Exception('Arguments is not integers');
            }
        }
    }
 
    function getMax($a, $b, $c) {
        $this->checkArguments($a, $b, $c);
        return max([$a, $b, $c]);
    }
 
    function getMin($a, $b, $c) {
        $this->checkArguments($a, $b, $c);
        return min([$a, $b, $c]);
    }
 
    function getSum($a, $b, $c) {
        $this->checkArguments($a, $b, $c);
        return array_sum([$a, $b, $c]);
    }
}

Проверяем.

Я получил ошибку:

PHP Fatal error:  Uncaught Exception: Arguments is not integers in /var/www/project/file.php:7

Как видим - всё работает. Добавим проверку в тестах.

Создадим методы для формирования некорректных данных:

public function additionMaxProviderNegative()
{
    return [
        [2, 1, "car"],
        [0, 10.11, 1],
        [0, [], 0],
        [1, '', '']
    ];
}
 
public function additionMinProviderNegative()
{
    return [
        [2, 1, "car"],
        [0, 10.11, 1],
        [0, [], 0],
        [1, '', '']
    ];
}
 
public function additionSumProviderNegative()
{
    return [
        [2, 1, "car"],
        [0, 10.11, 1],
        [0, [], 0],
        [1, '', '']
    ];
}

Теперь создадим 3 новых метода для негативных сценариев. Просто добавим им аннотацию @expectedException Exception

Это означает, что для успешного прохождения теста в нём должно быть выброшено исключение типа Exception.

/**
* @dataProvider additionMaxProviderNegative
* @expectedException Exception
*/
public function testGetMaxNegative($a, $b, $c)
{
    $values = new Values();
    $values->getMax($a, $b, $c);
}
 
/**
* @dataProvider additionMinProviderNegative
* @expectedException Exception
*/
public function testGetMinNegative($a, $b, $c)
{
    $values = new Values();
    $values->getMin($a, $b, $c);
}
 
/**
* @dataProvider additionSumProviderNegative
* @expectedException Exception
*/
public function testGetSumNegative($a, $b, $c)
{
    $values = new Values();
    $values->getSum($a, $b, $c);
}

Запускаем тесты и видим, что как позитивные, так и негативные сценарии работают:

PHPUnit 5.4.8 by Sebastian Bergmann and contributors.
 
........................         24 / 24 (100%)
 
Time: 44 ms, Memory: 4.00MB
 
OK (24 tests, 24 assertions)

Теперь пробуйте закомментировать exception в методе checkArguments и убедитесь, что тесты упадут.

Полный класс теста:

include_once "../vendor/autoload.php";
include_once "../file.php";
 
use PHPUnit\Framework\TestCase;
 
class ValuesTest extends TestCase
{
    /**
     * @dataProvider additionMaxProvider
     */
    public function testGetMax($a, $b, $c, $max)
    {
        $values = new Values();
        $result_max = $values->getMax($a, $b, $c);
        $this->assertEquals($result_max, $max);
    }
 
    /**
     * @dataProvider additionMinProvider
     */
    public function testGetMin($a, $b, $c, $min)
    {
        $values = new Values();
        $result_min = $values->getMin($a, $b, $c);
        $this->assertEquals($result_min, $min);
    }
 
    /**
     * @dataProvider additionSumProvider
     */
    public function testGetSum($a, $b, $c, $sum)
    {
        $values = new Values();
        $result_sum = $values->getSum($a, $b, $c);
        $this->assertEquals($result_sum, $sum);
    }
    /**
     * @dataProvider additionMaxProviderNegative
     * @expectedException Exception
     */
    public function testGetMaxNegative($a, $b, $c)
    {
        $values = new Values();
        $values->getMax($a, $b, $c);
    }
 
    /**
     * @dataProvider additionMinProviderNegative
     * @expectedException Exception
     */
    public function testGetMinNegative($a, $b, $c)
    {
        $values = new Values();
        $values->getMin($a, $b, $c);
    }
 
    /**
     * @dataProvider additionSumProviderNegative
     * @expectedException Exception
     */
    public function testGetSumNegative($a, $b, $c)
    {
        $values = new Values();
        $values->getSum($a, $b, $c);
    }
 
    public function additionMaxProvider()
    {
        return [
            [2, 1, 5, 5],
            [0, 1, 1, 1],
            [0, 0, 0, 0],
            [1, -61, 3, 3]
        ];
    }
 
    public function additionMinProvider()
    {
        return [
            [2, 1, 5, 1],
            [0, 1, 1, 0],
            [0, 0, 0, 0],
            [1, -61, 3, -61]
        ];
    }
 
    public function additionSumProvider()
    {
        return [
            [2, 1, 5, 8],
            [0, 1, 1, 2],
            [0, 0, 0, 0],
            [1, -61, 3, -57]
        ];
    }
 
    public function additionMaxProviderNegative()
    {
        return [
            [2, 1, "car"],
            [0, 10.11, 1],
            [0, [], 0],
            [1, '', '']
        ];
    }
 
    public function additionMinProviderNegative()
    {
        return [
            [2, 1, "car"],
            [0, 10.11, 1],
            [0, [], 0],
            [1, '', '']
        ];
    }
 
    public function additionSumProviderNegative()
    {
        return [
            [2, 1, "car"],
            [0, 10.11, 1],
            [0, [], 0],
            [1, '', '']
        ];
    }
}