Неполные и пропущенные тесты

Неполные тесты

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

1
public function testSomething()
2
{
3
}

Проблема с пустыми тестовыми методами состоит в том, что фреймворком PHPUnit они интерпретируется как успешно пройденные. Это ошибочное толкование приводит к тому, что отчёты о покрытии становятся бесполезными — вы не сможете увидеть, действительно ли тест прошёл, либо он просто ещё не реализован. Вызов $this->fail() в нереализованном тестовом методе также не поможет, поскольку тогда тест будет интерпретироваться как не пройденный. Это было бы так же неверно, как и считать нереализованный тест как пройденный.

Если мы думаем об успешном тестировании как о зелёном свете, а о непройденном тесте как о красном цвете, то нам нужен дополнительный жёлтый цвет для обозначения теста как неполного или ещё не реализованного. PHPUnit\Framework\IncompleteTest — это интерфейс для обозначения исключения, выбрасываемого тестовым методом как результат на то, что данный тестовый метод неполный или в данный момент ещё не реализован.PHPUnit\Framework\IncompleteTestError — стандартная реализация этого интерфейса.

Пример 7.1 показывает тестовый класс SampleTest, содержащий один тестовый метод testSomething(). Вызывая удобный метод markTestIncomplete() (который автоматически вызывает исключение PHPUnit\Framework\IncompleteTestError) в тестовом методе, мы отмечаем, что данный тест является неполным.

Пример 7.1 Маркировка теста как неполного

1
<?php
2
use PHPUnit\Framework\TestCase;
3

4
class SampleTest extends TestCase
5
{
6
    public function testSomething()
7
    {
8
        // Необязательно: протестируйте здесь что-нибудь, если хотите.
9
        $this->assertTrue(true, 'This should already work.');
10

11
        // Остановиться тут и отметить, что тест неполный.
12
        $this->markTestIncomplete(
13
          'Этот тест ещё не реализован.'
14
        );
15
    }
16
}

Неполный тест обозначается I в выводе исполнителя тестов командной строки PHPUnit, как показано в следующем примере:

1
$ phpunit --verbose SampleTest
2
PHPUnit |version|.0 by Sebastian Bergmann and contributors.
3

4
I
5

6
Time: 0 seconds, Memory: 3.95Mb
7

8
There was 1 incomplete test:
9

10
1) SampleTest::testSomething
11
Этот тест ещё не реализован.
12

13
/home/sb/SampleTest.php:12
14
OK, but incomplete or skipped tests!
15
Tests: 1, Assertions: 1, Incomplete: 1.

Таблица 7.1 показывает API для маркировки тестов как неполных.

Пропущенные тесты

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

Пример 7.2 демонстрирует тестовый класс DatabaseTest, содержащий один тестовый метод testConnection(). В шаблонном методе setUp() тестового класса мы проверяем, доступно ли расширение MySQLi, и используем метод markTestSkipped() для пропуска этого теста в противном случае.

Пример 7.2 Пропуск теста

1
<?php
2
use PHPUnit\Framework\TestCase;
3

4
class DatabaseTest extends TestCase
5
{
6
    protected function setUp()
7
    {
8
        if (!extension_loaded('mysqli')) {
9
            $this->markTestSkipped(
10
              'Расширение MySQLi недоступно.'
11
            );
12
        }
13
    }
14

15
    public function testConnection()
16
    {
17
        // ...
18
    }
19
}

Пропущенный тест обозначается S в выводе исполнителя тестов командной строки PHPUnit, как показано в следующем примере:

1
$ phpunit --verbose DatabaseTest
2
PHPUnit |version|.0 by Sebastian Bergmann and contributors.
3

4
S
5

6
Time: 0 seconds, Memory: 3.95Mb
7

8
There was 1 skipped test:
9

10
1) DatabaseTest::testConnection
11
Расширение MySQLi недоступно.
12

13
/home/sb/DatabaseTest.php:9
14
OK, but incomplete or skipped tests!
15
Tests: 1, Assertions: 0, Skipped: 1.

Таблица 7.2 показывает API пропущенных тестов.

Пропуск тестов с помощью @requires

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

Таблица 7.3 Возможные примеры использования @requires

Пример 7.3 Пропуск тестового класса с использованием @requires

1
<?php
2
use PHPUnit\Framework\TestCase;
3

4
/**
5
 * @requires extension mysqli
6
 */
7
class DatabaseTest extends TestCase
8
{
9
    /**
10
     * @requires PHP 5.3
11
     */
12
    public function testConnection()
13
    {
14
        // Тест требует расширения mysqli и PHP >= 5.3
15
    }
16

17
    // ... Все остальные тесты требует расширения mysqli
18
}

Если вы используете синтаксис, который не компилируется с определённой версией PHP, посмотрите на версии, от которых зависят тестовые классы в XML-конфигурации (см Набор тестов)

https://phpunit.readthedocs.io/ru/latest/incomplete-and-skipped-tests.html