silverstripe / silverstripe-ckan-registry

tests/Service/APIClientTest.php

<?php

namespace SilverStripe\CKANRegistry\Tests\Service;

use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Response;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
use SilverStripe\CKANRegistry\Model\Resource;
use SilverStripe\CKANRegistry\Service\APIClient;
use SilverStripe\Dev\SapphireTest;

class APIClientTest extends SapphireTest
{
    /**
     * @var Client
     */
    protected $guzzleClient;

    /**
     * @var Response
     */
    protected $response;

    /**
     * @var StreamInterface
     */
    protected $mockBody;

    /**
     * @var Resource
     */
    protected $resource;

    protected function setUp()
    {
        parent::setUp();

        $this->guzzleClient = $this->createMock(Client::class);

It seems like $this->createMock(GuzzleHttp\Client::class) of type PHPUnit_Framework_MockObject_MockObject is incompatible with the declared type GuzzleHttp\Client of property $guzzleClient.

        $this->response = $this->createMock(Response::class);

It seems like $this->createMock(GuzzleHttp\Psr7\Response::class) of type PHPUnit_Framework_MockObject_MockObject is incompatible with the declared type GuzzleHttp\Psr7\Response of property $response.

        $this->mockBody = $this->createMock(StreamInterface::class);

It seems like $this->createMock(Psr\Http\Message\StreamInterface::class) of type PHPUnit_Framework_MockObject_MockObject is incompatible with the declared type Psr\Http\Message\StreamInterface of property $mockBody.

        $this->resource = new Resource();
    }

    /**
     * @expectedException RuntimeException
     * @expectedExceptionMessage CKAN API is not available. Error code 123
     */
    public function testExceptionThrownOnInvalidHttpStatusCode()
    {
        $this->guzzleClient->expects($this->once())->method('send')->willReturn($this->response);

The method method() does not exist on GuzzleHttp\Promise\PromiseInterface.

        $this->response->expects($this->once())->method('getStatusCode')->willReturn(123);

The method expects() does not exist on GuzzleHttp\Psr7\Response.

        $client = new APIClient();
        $client->setGuzzleClient($this->guzzleClient);
        $client->getData($this->resource);
    }

    /**
     * @expectedException RuntimeException
     * @expectedExceptionMessage CKAN API returns an invalid response: Content-Type is not JSON
     */
    public function testExceptionThrownOnNonJsonResponse()
    {
        $this->guzzleClient->expects($this->once())->method('send')->willReturn($this->response);
        $this->response->expects($this->once())->method('getStatusCode')->willReturn(200);
        $this->response->expects($this->once())->method('getHeader')->with('Content-Type')->willReturn(['junk']);

        $client = new APIClient();
        $client->setGuzzleClient($this->guzzleClient);
        $client->getData($this->resource);
    }

    /**
     * @expectedException RuntimeException
     * @expectedExceptionMessage CKAN API returns an invalid response: Responded as invalid
     */
    public function testExceptionThrownOnUnsuccessfulResponse()
    {
        $this->guzzleClient->expects($this->once())->method('send')->willReturn($this->response);
        $this->response->expects($this->once())->method('getStatusCode')->willReturn(200);
        $this->response->expects($this->once())->method('getHeader')->willReturn(['application/json']);
        $this->response->expects($this->once())->method('getBody')->willReturn($this->mockBody);
        $this->mockBody->expects($this->once())->method('getContents')->willReturn('{

The method expects() does not exist on Psr\Http\Message\StreamInterface. It seems like you code against a sub-type of said class. However, the method does not exist in GuzzleHttp\Psr7\BufferStream or GuzzleHttp\Psr7\PumpStream or GuzzleHttp\Psr7\AppendStream or GuzzleHttp\Psr7\Stream or GuzzleHttp\Psr7\FnStream. Are you sure you never get one of those?

            "success": false
        }');

        $client = new APIClient();
        $client->setGuzzleClient($this->guzzleClient);
        $client->getData($this->resource);
    }

    public function testReturnsResponseData()
    {
        $this->guzzleClient->expects($this->once())->method('send')->willReturn($this->response);
        $this->response->expects($this->once())->method('getStatusCode')->willReturn(200);
        $this->response->expects($this->once())->method('getHeader')->willReturn(['application/json']);
        $this->response->expects($this->once())->method('getBody')->willReturn($this->mockBody);
        $this->mockBody->expects($this->once())->method('getContents')->willReturn('{
            "success": true,
            "data": "test"
        }');

        $client = new APIClient();
        $client->setGuzzleClient($this->guzzleClient);
        $result = $client->getData($this->resource);

        $this->assertSame('test', $result['data'], 'Raw response body should be returned');
    }
}