jcchavezs / httptest
Installs: 7 570
Dependents: 7
Suggesters: 0
Security: 0
Stars: 9
Watchers: 2
Forks: 1
Open Issues: 2
Requires
- ext-pcntl: *
- react/http: 0.8.*
Requires (Dev)
- php: >=5.4||^7.0
- phpunit/phpunit: ^4.8.36
- squizlabs/php_codesniffer: ^3.0@dev
This package is auto-updated.
Last update: 2024-10-04 20:44:36 UTC
README
Library for for HTTP integration tests.
HttpTest is strongly inspired on the httptest go library
Description
When testing functions that include HTTP calls, developers often create a wrapper class around cURL
functions and mock that class in order to unit test it. This technique unit tests the class but it is
also important to test the actual HTTP call which requires an HTTP server listening to those calls. This
library provides such a server and allow developers to do assertions both in the client and server side.
Installation
composer require --dev jcchavezs/httptest
Usage
Test a cURL
HTTP request:
<?php namespace HttpTest\Tests\Integration; use HttpTest\HttpTestServer; use PHPUnit_Framework_TestCase; use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ResponseInterface; final class TestServerTest extends PHPUnit_Framework_TestCase { const TEST_BODY = 'test_body'; const TEST_STATUS_CODE = 202; public function testHttpSuccess() { $t = $this; $server = HttpTestServer::create( function (RequestInterface $request, ResponseInterface &$response) use ($t) { /* Assert the HTTP call includes the expected values */ $t->assertEquals('POST', $request->getMethod()); $t->assertEquals('application/json', $request->getHeader('Content-Type')[0]); $t->assertEquals(self::TEST_BODY, (string) $request->getBody()); $response = $response->withStatus(self::TEST_STATUS_CODE); } ); $server->start(); $handle = curl_init($server->getUrl()); curl_setopt($handle, CURLOPT_POST, 1); curl_setopt($handle, CURLOPT_POSTFIELDS, self::TEST_BODY); curl_setopt($handle, CURLOPT_HTTPHEADER, [ 'Content-Type: application/json', 'Content-Length: ' . strlen(self::TEST_BODY), ]); if (curl_exec($handle) === true) { $statusCode = curl_getinfo($handle, CURLINFO_HTTP_CODE); curl_close($handle); // Assert client behaviour based on the server response $this->assertEquals(self::TEST_STATUS_CODE, $statusCode); } else { // Stop the server before as `$this->fail(...)` throws an exception // In a try/catch block, this should be in the finally block $server->stop(); $this->fail(curl_error($handle)); } $server->stop(); } }
Important: httptest-php
uses pcntl_fork
to run the server in a separated thread. Consider this
when writing the test and more important, stop the server as soon as you are done with calls because
objects are copied from the parent process to the child process and that could end up in having in the
assertions having actual value multiplied by 2 when counting calls to external resources (e.g. writing
log entries to a file can have double of expected lines if server is stopped after the write).
Tests
composer test