mj/php-ovh
1
0
Fork 0
mirror of https://github.com/ovh/php-ovh.git synced 2023-11-05 03:20:26 +01:00
Code Issues Releases Wiki Activity

Added 100% Code Coverage

Browse Source 
Signed-off-by: Thierry Goettelmann <thierry@byscripts.info>
This commit is contained in:
Thierry Goettelmann 2015-08-06 15:15:19 +02:00
parent 47d3cd2ed7
commit 6ecf7c2773
2 changed files with 379 additions and 176 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

258
tests/ApiFunctionalTest.php
View File

@ -28,136 +28,220 @@
namespace Ovh\tests; namespace Ovh\tests;
use GuzzleHttp\Client; use GuzzleHttp\Client;
use GuzzleHttp\Subscriber\Mock;
use Ovh\Api; use Ovh\Api;
/** /**
* Functional tests of Api class * Functional tests of Api class
* *
* @package Ovh * @package Ovh
* @category Ovh * @category Ovh
* @author Vincent Cassé <vincent.casse@ovh.net> * @author Vincent Cassé <vincent.casse@ovh.net>
* @author Thierry Goettelmann <thierry@byscripts.info>
*/ */
class ApiFunctionalTest extends \PHPUnit_Framework_TestCase { class ApiFunctionalTest extends \PHPUnit_Framework_TestCase
{
/** /**
* Define id to create object * @var string
*/ */
protected function setUp() private $application_key;
/**
* @var string
*/
private $application_secret;
/**
* @var string
*/
private $consumer_key;
/**
* @var string
*/
private $endpoint;
/**
* @var string
*/
private $rangeIP;
/**
* @var string
*/
private $alternativeRangeIP;
/**
* @var Client
*/
private $client;
/**
* @var Api
*/
private $api;
/**
* Define id to create object
*/
protected function setUp()
{ {
$this->application_key = getenv('APP_KEY'); $this->application_key = getenv('APP_KEY');
$this->application_secret = getenv('APP_SECRET'); $this->application_secret = getenv('APP_SECRET');
$this->consumer_key = getenv('CONSUMER'); $this->consumer_key = getenv('CONSUMER');
$this->endpoint = getenv('ENDPOINT'); $this->endpoint = getenv('ENDPOINT');
$this->rangeIP = '127.0.0.20/32'; $this->rangeIP = '127.0.0.20/32';
$this->alternativeRangeIP = '127.0.0.30/32';
$this->client = new Client(); $this->client = new Client();
$this->api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client); $this->api = new Api(
$this->application_key,
$this->application_secret,
$this->endpoint,
$this->consumer_key,
$this->client
);
} }
/** /**
* Get private and protected method to unit test it * Get private and protected method to unit test it
*
* @param string $name
*
* @return \ReflectionMethod
*/ */
protected static function getPrivateMethod($name) protected static function getPrivateMethod($name)
{ {
$class = new \ReflectionClass('Ovh\Api'); $class = new \ReflectionClass('Ovh\Api');
$method = $class->getMethod($name); $method = $class->getMethod($name);
$method->setAccessible(true); $method->setAccessible(true);
return $method; return $method;
} }
/**
* Get private and protected property to unit test it
*
* @param string $name
*
* @return \ReflectionProperty
*/
protected static function getPrivateProperty($name) protected static function getPrivateProperty($name)
{ {
$class = new \ReflectionClass('Ovh\Api'); $class = new \ReflectionClass('Ovh\Api');
$property = $class->getProperty($name); $property = $class->getProperty($name);
$property->setAccessible(true); $property->setAccessible(true);
return $property; return $property;
} }
/** /**
* Test if result contains consumerKey and validationUrl * Test if result contains consumerKey and validationUrl
*/ */
public function testIfConsumerKeyIsReplace() public function testIfConsumerKeyIsReplace()
{ {
$property = self::getPrivateProperty('consumer_key'); $property = self::getPrivateProperty('consumer_key');
$accessRules = json_decode(' [ $accessRules = json_decode(' [
{ "method": "GET", "path": "/*" }, { "method": "GET", "path": "/*" },
{ "method": "POST", "path": "/*" }, { "method": "POST", "path": "/*" },
{ "method": "PUT", "path": "/*" }, { "method": "PUT", "path": "/*" },
{ "method": "DELETE", "path": "/*" } { "method": "DELETE", "path": "/*" }
] ') ; ] ');
$credentials = $this->api->requestCredentials($accessRules); $credentials = $this->api->requestCredentials($accessRules);
$consumer_key = $property->getValue($this->api); $consumer_key = $property->getValue($this->api);
$this->assertEquals( $consumer_key , $credentials["consumerKey"]); $this->assertEquals($consumer_key, $credentials["consumerKey"]);
$this->assertNotEquals( $consumer_key, $this->consumer_key ); $this->assertNotEquals($consumer_key, $this->consumer_key);
} }
/** /**
* Test if put request on me * Test if post request on me
*/ */
public function testPutRestrictionAccessIp() public function testPostRestrictionAccessIp()
{ {
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client); $this->assertNull(
$invoker = self::getPrivateMethod('rawCall'); $this->api->post('/me/accessRestriction/ip', ['ip' => $this->rangeIP, 'rule' => 'deny', 'warning' => true])
$params = new \StdClass(); );
$params->ip = $this->rangeIP;
$params->rule = "deny";
$params->warning = true;
$result = $invoker->invokeArgs($api, array('POST', '/me/accessRestriction/ip', $params)) ; $this->assertNull(
$this->assertNull( $result ); $this->api->post('/me/accessRestriction/ip', ['ip' => $this->alternativeRangeIP,
} 'rule' => 'deny',
'warning' => true,
])
);
}
/** /**
* Test if get request on /me * Test if get request on /me
*/ */
public function testGetRestrictionAccessIP() public function testGetRestrictionAccessIP()
{ {
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client); $result = $this->api->get('/me/accessRestriction/ip');
$invoker = self::getPrivateMethod('rawCall');
$result = $invoker->invokeArgs($api, array('GET', '/me/accessRestriction/ip')) ;
foreach ($result as $restrictionId) {
$restriction = $invoker->invokeArgs($api, array('GET', '/me/accessRestriction/ip/' . $restrictionId)) ;
if ($restriction["ip"] == $this->rangeIP) { $restrictionIps = [];
$this->assertTrue(true);
break;
}
}
}
/** foreach ($result as $restrictionId) {
* Test if delete request on /me $restriction = $this->api->get('/me/accessRestriction/ip/' . $restrictionId);
*/
public function testDeleteRestrictionAccessIP()
{
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client);
$invoker = self::getPrivateMethod('rawCall');
$result = $invoker->invokeArgs($api, array('GET', '/me/accessRestriction/ip')) ; $restrictionIps[] = $restriction['ip'];
foreach ($result as $restrictionId) { }
$restriction = $invoker->invokeArgs($api, array('GET', '/me/accessRestriction/ip/' . $restrictionId)) ;
if ($restriction["ip"] == $this->rangeIP) { $this->assertContains($this->rangeIP, $restrictionIps);
$result = $invoker->invokeArgs($api, array('DELETE', '/me/accessRestriction/ip/'. $restrictionId)) ; $this->assertContains($this->alternativeRangeIP, $restrictionIps);
$this->assertNull( $result ); }
break;
}
}
}
/** /**
* Test if request without authentication works * Test if delete request on /me
*/ */
public function testIfRequestWithoutAuthenticationWorks() public function testPutRestrictionAccessIP()
{ {
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, NULL, $this->client); $result = $this->api->get('/me/accessRestriction/ip');
$invoker = self::getPrivateMethod('rawCall');
$result = $invoker->invokeArgs($api, array('GET', '/xdsl/incidents')) ;
}
$restrictionId = array_pop($result);
$this->assertNull(
$this->api->put('/me/accessRestriction/ip/' . $restrictionId, ['rule' => 'accept', 'warning' => true])
);
$restriction = $this->api->get('/me/accessRestriction/ip/' . $restrictionId);
$this->assertEquals('accept', $restriction['rule']);
}
/**
* Test if delete request on /me
*/
public function testDeleteRestrictionAccessIP()
{
$result = $this->api->get('/me/accessRestriction/ip');
foreach ($result as $restrictionId) {
$restriction = $this->api->get('/me/accessRestriction/ip/' . $restrictionId);
if (in_array($restriction["ip"], [$this->rangeIP, $this->alternativeRangeIP])) {
$result = $this->api->delete('/me/accessRestriction/ip/' . $restrictionId);
$this->assertNull($result);
break;
}
}
}
/**
* Test if request without authentication works
*/
public function testIfRequestWithoutAuthenticationWorks()
{
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, null, $this->client);
$invoker = self::getPrivateMethod('rawCall');
$invoker->invokeArgs($api, ['GET', '/xdsl/incidents']);
}
/**
* Test Api::get
*/
public function testApiGetWithParameters()
{
$this->setExpectedException('\\GuzzleHttp\\Exception\\ClientException', '400');
$this->api->get('/me/accessRestriction/ip', ['foo' => 'bar']);
}
} }

297
tests/ApiTest.php
View File

@ -27,140 +27,259 @@
namespace Ovh\tests; namespace Ovh\tests;
use Ovh\Api;
use GuzzleHttp\Client; use GuzzleHttp\Client;
use GuzzleHttp\Subscriber\Mock; use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Response;
use Ovh\Api;
/** /**
* Test Api class * Test Api class
* *
* @package Ovh * @package Ovh
* @category Ovh * @category Ovh
* @author Vincent Cassé <vincent.casse@ovh.net> * @author Vincent Cassé <vincent.casse@ovh.net>
* @author Thierry Goettelmann <thierry@byscripts.info>
*/ */
class ApiTest extends \PHPUnit_Framework_TestCase { class ApiTest extends \PHPUnit_Framework_TestCase
{
/**
* @var Client
*/
private $client;
/** /**
* Define id to create object * @var string
*/ */
protected function setUp() private $application_key;
/**
* @var string
*/
private $consumer_key;
/**
* @var string
*/
private $endpoint;
/**
* @var string
*/
private $application_secret;
/**
* Define id to create object
*/
protected function setUp()
{ {
$this->application_key = 'app_key'; $this->application_key = 'app_key';
$this->application_secret = 'app_secret'; $this->application_secret = 'app_secret';
$this->consumer_key = 'consumer'; $this->consumer_key = 'consumer';
$this->endpoint = 'ovh-eu'; $this->endpoint = 'ovh-eu';
$this->client = new Client(); $this->client = new Client();
} }
/** /**
* Get private and protected method to unit test it * Get private and protected method to unit test it
*
* @param string $name
*
* @return \ReflectionMethod
*/ */
protected static function getPrivateMethod($name) protected static function getPrivateMethod($name)
{ {
$class = new \ReflectionClass('Ovh\Api'); $class = new \ReflectionClass('Ovh\Api');
$method = $class->getMethod($name); $method = $class->getMethod($name);
$method->setAccessible(true); $method->setAccessible(true);
return $method; return $method;
} }
/**
* Get private and protected property to unit test it
*
* @param string $name
*
* @return \ReflectionProperty
*/
protected static function getPrivateProperty($name) protected static function getPrivateProperty($name)
{ {
$class = new \ReflectionClass('Ovh\Api'); $class = new \ReflectionClass('Ovh\Api');
$property = $class->getProperty($name); $property = $class->getProperty($name);
$property->setAccessible(true); $property->setAccessible(true);
return $property; return $property;
} }
/** /**
* Test the compute of time delta * Test missing $application_key
*/ */
public function testTimeDeltaCompute() public function testMissingApplicationKey()
{ {
$delay = 10; $this->setExpectedException('\\Ovh\\Exceptions\\InvalidParameterException', 'Application key');
$mock = new Mock([ new Api(null, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client);
"HTTP/1.1 200 OK\r\n\r\n". (time()-$delay), }
]);
$this->client->getEmitter()->attach($mock);
$invoker = self::getPrivateMethod('calculateTimeDelta'); /**
$property = self::getPrivateProperty('time_delta'); * Test missing $application_secret
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client); */
$invoker->invokeArgs($api, array()) ; public function testMissingApplicationSecret()
{
$this->setExpectedException('\\Ovh\\Exceptions\\InvalidParameterException', 'Application secret');
new Api($this->application_key, null, $this->endpoint, $this->consumer_key, $this->client);
}
$time_delta = $property->getValue($api); /**
$this->assertNotNull($time_delta); * Test missing $api_endpoint
$this->assertEquals($time_delta, $delay * -1 ); */
} public function testMissingApiEndpoint()
{
$this->setExpectedException('\\Ovh\\Exceptions\\InvalidParameterException', 'Endpoint');
new Api($this->application_key, $this->application_secret, null, $this->consumer_key, $this->client);
}
/** /**
* Test if consumer key is replaced * Test bad $api_endpoint
*/ */
public function testIfConsumerKeyIsReplace() public function testBadApiEndpoint()
{ {
$delay = 10; $this->setExpectedException('\\Ovh\\Exceptions\\InvalidParameterException', 'Unknown');
$mock = new Mock([ new Api($this->application_key, $this->application_secret, 'i_am_invalid', $this->consumer_key, $this->client);
"HTTP/1.1 200 OK\r\n\r\n". '{"validationUrl":"https://api.ovh.com/login/?credentialToken=token","consumerKey":"consumer_remote","state":"pendingValidation"}' }
]);
$this->client->getEmitter()->attach($mock);
$property = self::getPrivateProperty('consumer_key'); /**
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client); * Test creating Client if none is provided
$accessRules = array( json_decode(' { "method": "GET", "path": "/*" } ') ); */
public function testClientCreation()
{
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key);
$credentials = $api->requestCredentials($accessRules); $this->assertInstanceOf('\\GuzzleHttp\\Client', $api->getHttpClient());
$consumer_key = $property->getValue($api); }
$this->assertEquals( $consumer_key , $credentials["consumerKey"]); /**
$this->assertNotEquals( $consumer_key, $this->consumer_key ); * Test the compute of time delta
} */
public function testTimeDeltaCompute()
{
$delay = 10;
/** $handlerStack = $this->client->getConfig('handler');
* Test invalid applicationKey $handlerStack->push(Middleware::mapResponse(function (Response $response) {
*/
public function testInvalidApplicationKey() $body = $response->getBody();
{ $body->write(time() - 10);
$this->setExpectedException(
'\GuzzleHttp\Exception\ClientException' return $response
->withStatus(200)
->withBody($body);
}));
$invoker = self::getPrivateMethod('calculateTimeDelta');
$property = self::getPrivateProperty('time_delta');
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client);
$invoker->invokeArgs($api, []);
$time_delta = $property->getValue($api);
$this->assertNotNull($time_delta);
$this->assertEquals($time_delta, $delay * -1);
}
/**
* Test if consumer key is replaced
*/
public function testIfConsumerKeyIsReplace()
{
$handlerStack = $this->client->getConfig('handler');
$handlerStack->push(Middleware::mapResponse(function (Response $response) {
$body = $response->getBody();
$body->write('{"validationUrl":"https://api.ovh.com/login/?credentialToken=token","consumerKey":"consumer_remote","state":"pendingValidation"}');
return $response
->withStatus(200)
->withBody($body);
}));
$property = self::getPrivateProperty('consumer_key');
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client);
$accessRules = [json_decode(' { "method": "GET", "path": "/*" } ')];
$credentials = $api->requestCredentials($accessRules);
$consumer_key = $property->getValue($api);
$this->assertEquals($consumer_key, $credentials["consumerKey"]);
$this->assertNotEquals($consumer_key, $this->consumer_key);
}
/**
* Test invalid applicationKey
*/
public function testInvalidApplicationKey()
{
$this->setExpectedException(
'\GuzzleHttp\Exception\ClientException'
); );
$delay = 10; $handlerStack = $this->client->getConfig('handler');
$mock = new Mock([ $handlerStack->push(Middleware::mapResponse(function (Response $response) {
"HTTP/1.1 401 Unauthorized\r\nContent-Type: application/json; charset=utf-8\r\nContent-Length: 37\r\n\r\n{\"message\":\"Invalid application key\"}"
]);
$this->client->getEmitter()->attach($mock);
$property = self::getPrivateProperty('consumer_key'); $body = $response->getBody();
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client); $body->write('{\"message\":\"Invalid application key\"}');
$accessRules = array( json_decode(' { "method": "GET", "path": "/*" } ') );
$credentials = $api->requestCredentials($accessRules); return $response
$consumer_key = $property->getValue($api); ->withStatus(401, 'POUET')
->withHeader('Content-Type', 'application/json; charset=utf-8')
->withHeader('Content-Length', 37)
->withBody($body);
}));
$this->assertEquals( $consumer_key , $credentials["consumerKey"]); $property = self::getPrivateProperty('consumer_key');
$this->assertNotEquals( $consumer_key, $this->consumer_key ); $api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client);
} $accessRules = [json_decode(' { "method": "GET", "path": "/*" } ')];
/** $credentials = $api->requestCredentials($accessRules);
* Test invalid rights $consumer_key = $property->getValue($api);
*/
public function testInvalidRight() $this->assertEquals($consumer_key, $credentials["consumerKey"]);
{ $this->assertNotEquals($consumer_key, $this->consumer_key);
$this->setExpectedException( }
'\GuzzleHttp\Exception\ClientException'
/**
* Test invalid rights
*/
public function testInvalidRight()
{
$this->setExpectedException(
'\GuzzleHttp\Exception\ClientException'
); );
$delay = 10; $handlerStack = $this->client->getConfig('handler');
$mock = new Mock([ $handlerStack->push(Middleware::mapResponse(function (Response $response) {
"HTTP/1.1 403 Forbidden\r\nContent-Type: application/json; charset=utf-8\r\nContent-Length: 37\r\n\r\n{\"message\":\"Invalid credentials\"}"
]);
$this->client->getEmitter()->attach($mock);
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client); $body = $response->getBody();
$body->write('{\"message\":\"Invalid credentials\"}');
$invoker = self::getPrivateMethod('rawCall'); return $response
$invoker->invokeArgs($api, array('GET', '/me')) ; ->withStatus(403)
} ->withHeader('Content-Type', 'application/json; charset=utf-8')
->withHeader('Content-Length', 37)
->withBody($body);
}));
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client);
$invoker = self::getPrivateMethod('rawCall');
$invoker->invokeArgs($api, ['GET', '/me']);
}
public function testGetConsumerKey()
{
$api = new Api($this->application_key, $this->application_secret, $this->endpoint, $this->consumer_key, $this->client);
$this->assertEquals($this->consumer_key, $api->getConsumerKey());
}
} }