BaseTestCase.php

<?php

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Geocoder\IntegrationTest;

use Http\Client\Curl\Client as HttplugClient;
use Http\Mock\Client as MockedHttpClient;
use Nyholm\Psr7\Response;
use PHPUnit\Framework\TestCase;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
abstract class BaseTestCase extends TestCase
{
    /**
     * @return string|null the directory where cached responses are stored
     */
    abstract protected function getCacheDir();

    /**
     * Get a real HTTP client. If a cache dir is set to a path it will use cached responses.
     */
    protected function getHttpClient(?string $apiKey = null): ClientInterface
    {
        if (null !== $cacheDir = $this->getCacheDir()) {
            return new CachedResponseClient(new HttplugClient(), $cacheDir, $apiKey);
        } else {
            return new HttplugClient();
        }
    }

    /**
     * Get a mocked HTTP client that never do calls over the internet. Use this is you want to control the response data.
     */
    protected function getMockedHttpClient(?string $body = null, int $statusCode = 200): ClientInterface
    {
        $client = new MockedHttpClient();
        $client->addResponse(new Response($statusCode, [], $body));

        return $client;
    }

    /**
     * Get a mocked HTTP client where you may do tests on the request.
     */
    protected function getMockedHttpClientCallback(callable $requestCallback): ClientInterface
    {
        $client = $this->getMockBuilder(ClientInterface::class)->getMock();

        $client
            ->expects($this->once())
            ->method('sendRequest')
            ->willReturnCallback(function (RequestInterface $request) use ($requestCallback) {
                $response = $requestCallback($request);

                if (!$response instanceof ResponseInterface) {
                    $response = new Response(200, [], (string) $response);
                }

                return $response;
            });

        return $client;
    }
}