Повторное представление PHPUnit — начало работы с TDD в PHP

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

  { $input = '{"key":"value","key2":"value2","some-array":[1,2,3,4,5]}'; $output = [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], ]; $converter = new \SitePoint\Converter\Converter(); $this->assertEquals($output, $converter->convertString($input)); } public function testMoreComplexConversion() { $input = '{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}}'; $output = [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ]; $converter = new \SitePoint\Converter\Converter(); $this->assertEquals($output, $converter->convertString($input)); } public function testMostComplexConversion() { $input = '[{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}},{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}},{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}}]'; $output = [ [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ], [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ], [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ], ]; $converter = new \SitePoint\Converter\Converter(); $this->assertEquals($output, $converter->convertString($input)); } 

tests/SitePoint/Converter/ConverterTest.php

Мы сделали каждый тест немного более сложным, чем предыдущий, с последним, содержащим несколько объектов в массиве. Повторный запуск набора тестов показывает нам, что все в порядке …

… но что-то не так, не так ли? Здесь очень много повторений, и если мы когда-нибудь изменим API класса, нам придется внести изменения в 4 местах (пока). Преимущества DRY начинают проявляться даже в тестах. Ну, есть возможность помочь с этим.

Поставщики данных

Поставщики данных — это специальные функции в тестовых классах, которые имеют одну конкретную цель: предоставить набор данных для тестовой функции, чтобы вам не нужно было повторять ее логику для нескольких тестовых функций, как мы это делали. Это лучше всего объяснить на примере. Давайте сделаем рефакторинг нашего класса ConverterTest следующим образом:

 <?php namespace SitePoint\Converter; use PHPUnit\Framework\TestCase; class ConverterTest extends TestCase { public function conversionSuccessfulProvider() { return [ [ '{"key":"value","key2":"value2"}', [ 'key' => 'value', 'key2' => 'value2', ], ], [ '{"key":"value","key2":"value2","some-array":[1,2,3,4,5]}', [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], ], ], [ '{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}}', [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ], ], [ '[{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}},{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}},{"key":"value","key2":"value2","some-array":[1,2,3,4,5],"new-object":{"key":"value","key2":"value2"}}]', [ [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ], [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ], [ 'key' => 'value', 'key2' => 'value2', 'some-array' => [1, 2, 3, 4, 5], 'new-object' => [ 'key' => 'value', 'key2' => 'value2', ], ], ], ], ]; } /** * @param $input * @param $output * @dataProvider conversionSuccessfulProvider */ public function testStringConversionSuccess($input, $output) { $converter = new \SitePoint\Converter\Converter(); $this->assertEquals($output, $converter->convertString($input)); } } 

tests/SitePoint/Converter/ConverterTest.php

Сначала мы написали новый метод с именем conversionSuccessfulProvider . Это намекает на ожидание того, что все предоставленные случаи должны возвращать положительный результат, поскольку выходные данные и входные данные совпадают. Поставщики данных возвращают массивы (чтобы тестовая функция могла автоматически выполнять перебор элементов). Каждый элемент этого массива представляет собой отдельный тестовый пример — в нашем случае каждый элемент представляет собой массив с двумя элементами: первый является входным, а второй выводится, как и прежде.

Затем мы объединили тестовые функции в одну с более общим именем, что указывает на то, что ожидается: testStringConversionSuccess . Этот метод теста принимает два аргумента: вход и выход. Остальная логика идентична той, что была раньше. Кроме того, чтобы убедиться, что метод использует провайдер данных, мы объявляем провайдера в @dataProvider conversionSuccessfulProvider метода с помощью @dataProvider conversionSuccessfulProvider .

Это все, что нужно сделать — мы теперь получаем точно такой же результат.

Если мы теперь хотим добавить больше тестовых случаев, нам нужно только добавить больше пар ввода-вывода в провайдера. Не нужно придумывать новые имена методов или повторять логику. Удобно, правда?

Введение в покрытие кода

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

 <phpunit ...> <filter> <whitelist> <directory suffix=".php">src/</directory> </whitelist> </filter> <logging> <log type="tap" target="tests/build/report.tap"/> <log type="junit" target="tests/build/report.junit.xml"/> <log type="coverage-html" target="tests/build/coverage" charset="UTF-8" yui="true" highlight="true"/> <log type="coverage-text" target="tests/build/coverage.txt"/> <log type="coverage-clover" target="tests/build/logs/clover.xml"/> </logging> 

 sudo phpenmod xdebug