nextcloud/tests/lib/Traits/ClientServiceTrait.php

121 lines
3.4 KiB
PHP

<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace Test\Traits;
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\Http\Client\IResponse;
trait ClientServiceTrait {
/** @var IClientService|\PHPUnit\Framework\MockObject\MockObject */
private $clientService;
/** @var IClient|\PHPUnit\Framework\MockObject\MockObject */
private $client;
private $expectedGetRequests = [];
private $expectedPostRequests = [];
/**
* Wrapper to be forward compatible to phpunit 5.4+
*
* @param string $originalClassName
* @return \PHPUnit\Framework\MockObject\MockObject
*/
abstract protected function createMock(string $originalClassName);
/**
* Returns a matcher that matches when the method is executed
* zero or more times.
*
* @return \PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount
*
* @since Method available since Release 3.0.0
*/
abstract public static function any();
protected function setUpClientServiceTrait() {
$this->clientService = $this->createMock(IClientService::class);
$this->client = $this->createMock(IClient::class);
$this->clientService->expects($this->any())
->method('newClient')
->willReturn($this->client);
$this->client->expects($this->any())
->method('get')
->willReturnCallback(function ($url) {
if (!isset($this->expectedGetRequests[$url])) {
throw new \Exception('unexpected request: ' . $url);
}
$result = $this->expectedGetRequests[$url];
if ($result instanceof \Exception) {
throw $result;
} else {
$response = $this->createMock(IResponse::class);
$response->expects($this->any())
->method('getBody')
->willReturn($result);
return $response;
}
});
$this->client->expects($this->any())
->method('post')
->willReturnCallback(function ($url) {
if (!isset($this->expectedPostRequests[$url])) {
throw new \Exception('unexpected request: ' . $url);
}
$result = $this->expectedPostRequests[$url];
if ($result instanceof \Exception) {
throw $result;
} else {
$response = $this->createMock(IResponse::class);
$response->expects($this->any())
->method('getBody')
->willReturn($result);
return $response;
}
});
}
/**
* @param string $url
* @param string|\Exception $result
*/
protected function expectGetRequest($url, $result) {
$this->expectedGetRequests[$url] = $result;
}
/**
* @param string $url
* @param string|\Exception $result
*/
protected function expectPostRequest($url, $result) {
$this->expectedPostRequests[$url] = $result;
}
/**
* @return IClientService|\PHPUnit\Framework\MockObject\MockObject
*/
protected function getClientService() {
return $this->clientService;
}
}