Download the PHP package dobrosite/phpunit-psr-http-client without Composer

Инструменты для тестирования кода, использующего PSR-18

Это расширение для PHPUnit позволяет в интеграционных и функциональных (прикладных) тестах задавать ожидания для запросов, выполняемых с помощью клиентов HTTP, совместимых с PSR-18.

Пример:

Установка

composer require --dev dobrosite/phpunit-psr-http-client

Подключение

В тестовой конфигурации вашего приложения вам надо подменить используемую реализацию Psr\Http\Client\ClientInterface экземпляром DobroSite\PHPUnit\PSR18\TestHttpClient. Как это сделать, зависит от устройства вашего приложения, ниже даны примеры для популярных фреймворков.

Symfony

В конфигурацию тестового контейнера зависимостей (обычно — config/services_test.yaml) добавьте:

Теперь в тесты, унаследованные от Symfony\Bundle\FrameworkBundle\Test\KernelTestCase, добавьте примесь DobroSite\PHPUnit\PSR18\Symfony\TestHttpClientTrait:

Как это работает

Предположим, у вас есть класс Foo, обращающийся к стороннему API https://example.com/api. Для этого класс пользуется клиентом HTTP, совместимым с PSR-18:

В тестах в конструктор этого класса будет передан экземпляр TestHttpClient, который будет имитировать обмен данными с удалённым сервером без реального выполнения запросов.

Использование

Перед выполнением проверяемого действия надо настроить TestHttpClient — указать, какие запросы должен выполнить тестируемый код и какие ответы на них надо дать.

expectRequest

Для каждого ожидаемого запроса надо вызвать метод TestHttpClient::expectRequest(), принимающий два аргумента — $method и $uri — каждый из которых может быть как строкой, так и экземпляром PHPUnit\Framework\Constraint\Constraint. Если проверяемый код сделает запрос HTTP, метод или URI которого не соответствуют ожиданиям (или вообще не сделает запрос), тест провалится.

Ожидается запрос методом GET на URI https://some.service/some/resource.

Ожидается запрос любим методом на URI начинающийся с https://example.com/.

headers

Метод headers позволяет задать ожидания для заголовков запроса, который должен выполнить проверяемый код. Единственный аргумент метода должен содержать ассоциативный массив, ключи которого — имена заголовков (регистр не имеет значения), а значения — ожидаемые значения этих заголовков. В качестве значений можно использовать как строки, таки экземпляры Constraint.

body

Метод body задаёт ожидание для тела запроса. В аргументе $bodyConstraint метод может принимать:

• строку — будет интерпретирована как new IsEqual($bodyConstraint);
• массив — будет интерпретирован как new JsonMatches(json_encode($bodyConstraint));
• экземпляр Constraint.

willReturn

Метод willReturn позволяет задать ответ, который получит проверяемый код в ответ на ожидаемый запрос. У метода 3 аргумента.

• $body — тело ответа. Может быть:
  • экземпляром StreamInterface — будет возвращено как есть;
  • строкой или ресурсом — будет преобразовано к StreamInterface;
  • массивом — будет преобразовано в JSON;
  • null — в ответе не будет тела.
• $statusCode — код состояния HTTP;
• $headers — заголовки ответа. Ассоциативный массив «заголовок => значение». Регистр имён не имеет значения.

willThrowException

Выбросит переданное методу исключение.