1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446:
<?php
namespace Guzzle\Tests\Service\Command;
use Guzzle\Plugin\Mock\MockPlugin;
use Guzzle\Http\EntityBody;
use Guzzle\Http\Message\Response;
use Guzzle\Service\Client;
use Guzzle\Service\Command\AbstractCommand;
use Guzzle\Service\Description\Operation;
use Guzzle\Service\Description\Parameter;
use Guzzle\Service\Description\SchemaValidator;
use Guzzle\Service\Description\ServiceDescription;
use Guzzle\Tests\Service\Mock\Command\MockCommand;
use Guzzle\Tests\Service\Mock\Command\Sub\Sub;
class CommandTest extends AbstractCommandTest
{
public function testConstructorAddsDefaultParams()
{
$command = new MockCommand();
$this->assertEquals('123', $command->get('test'));
$this->assertFalse($command->isPrepared());
$this->assertFalse($command->isExecuted());
}
public function testDeterminesShortName()
{
$api = new Operation(array('name' => 'foobar'));
$command = new MockCommand(array(), $api);
$this->assertEquals('foobar', $command->getName());
$command = new MockCommand();
$this->assertEquals('mock_command', $command->getName());
$command = new Sub();
$this->assertEquals('sub.sub', $command->getName());
}
public function testGetRequestThrowsExceptionBeforePreparation()
{
$command = new MockCommand();
$command->getRequest();
}
public function testGetResponseExecutesCommandsWhenNeeded()
{
$response = new Response(200);
$client = $this->getClient();
$this->setMockResponse($client, array($response));
$command = new MockCommand();
$command->setClient($client);
$this->assertSame($response, $command->getResponse());
$this->assertSame($response, $command->getResponse());
}
public function testGetResultExecutesCommandsWhenNeeded()
{
$response = new Response(200);
$client = $this->getClient();
$this->setMockResponse($client, array($response));
$command = new MockCommand();
$command->setClient($client);
$this->assertSame($response, $command->getResult());
$this->assertSame($response, $command->getResult());
}
public function testSetClient()
{
$command = new MockCommand();
$client = $this->getClient();
$command->setClient($client);
$this->assertEquals($client, $command->getClient());
unset($client);
unset($command);
$command = new MockCommand();
$client = $this->getClient();
$command->setClient($client)->prepare();
$this->assertEquals($client, $command->getClient());
$this->assertTrue($command->isPrepared());
}
public function testExecute()
{
$client = $this->getClient();
$response = new Response(200, array(
'Content-Type' => 'application/xml'
), '<xml><data>123</data></xml>');
$this->setMockResponse($client, array($response));
$command = new MockCommand();
$this->assertSame($command, $command->setClient($client));
$this->assertInstanceOf('SimpleXMLElement', $command->execute());
$this->assertTrue($command->isPrepared());
$this->assertTrue($command->isExecuted());
$this->assertSame($response, $command->getResponse());
$this->assertInstanceOf('Guzzle\\Http\\Message\\Request', $command->getRequest());
$this->assertInstanceOf('SimpleXMLElement', $command->getResult());
$this->assertEquals('123', (string) $command->getResult()->data);
}
public function testConvertsJsonResponsesToArray()
{
$client = $this->getClient();
$this->setMockResponse($client, array(
new \Guzzle\Http\Message\Response(200, array(
'Content-Type' => 'application/json'
), '{ "key": "Hi!" }'
)
));
$command = new MockCommand();
$command->setClient($client);
$command->execute();
$this->assertEquals(array(
'key' => 'Hi!'
), $command->getResult());
}
public function testConvertsInvalidJsonResponsesToArray()
{
$json = '{ "key": "Hi!" }invalid';
if (json_decode($json) && JSON_ERROR_NONE === json_last_error()) {
$this->markTestSkipped('php-pecl-json library regression issues');
}
$client = $this->getClient();
$this->setMockResponse($client, array(
new \Guzzle\Http\Message\Response(200, array(
'Content-Type' => 'application/json'
), $json
)
));
$command = new MockCommand();
$command->setClient($client);
$command->execute();
}
public function testProcessResponseIsNotXml()
{
$client = $this->getClient();
$this->setMockResponse($client, array(
new Response(200, array(
'Content-Type' => 'application/octet-stream'
), 'abc,def,ghi')
));
$command = new MockCommand();
$client->execute($command);
$this->assertFalse($command->getResult() instanceof \SimpleXMLElement);
}
public function testExecuteThrowsExceptionWhenNoClientIsSet()
{
$command = new MockCommand();
$command->execute();
}
public function testPrepareThrowsExceptionWhenNoClientIsSet()
{
$command = new MockCommand();
$command->prepare();
}
public function testCommandsAllowsCustomRequestHeaders()
{
$command = new MockCommand();
$command->getRequestHeaders()->set('test', '123');
$this->assertInstanceOf('Guzzle\Common\Collection', $command->getRequestHeaders());
$this->assertEquals('123', $command->getRequestHeaders()->get('test'));
$command->setClient($this->getClient())->prepare();
$this->assertEquals('123', (string) $command->getRequest()->getHeader('test'));
}
public function testCommandsAllowsCustomRequestHeadersAsArray()
{
$command = new MockCommand(array(AbstractCommand::HEADERS_OPTION => array('Foo' => 'Bar')));
$this->assertInstanceOf('Guzzle\Common\Collection', $command->getRequestHeaders());
$this->assertEquals('Bar', $command->getRequestHeaders()->get('Foo'));
}
private function getOperation()
{
return new Operation(array(
'name' => 'foobar',
'httpMethod' => 'POST',
'class' => 'Guzzle\\Tests\\Service\\Mock\\Command\\MockCommand',
'parameters' => array(
'test' => array(
'default' => '123',
'type' => 'string'
)
)));
}
public function testCommandsUsesOperation()
{
$api = $this->getOperation();
$command = new MockCommand(array(), $api);
$this->assertSame($api, $command->getOperation());
$command->setClient($this->getClient())->prepare();
$this->assertEquals('123', $command->get('test'));
$this->assertSame($api, $command->getOperation($api));
}
public function testCloneMakesNewRequest()
{
$client = $this->getClient();
$command = new MockCommand(array(), $this->getOperation());
$command->setClient($client);
$command->prepare();
$this->assertTrue($command->isPrepared());
$command2 = clone $command;
$this->assertFalse($command2->isPrepared());
}
public function testHasOnCompleteMethod()
{
$that = $this;
$called = 0;
$testFunction = function($command) use (&$called, $that) {
$called++;
$that->assertInstanceOf('Guzzle\Service\Command\CommandInterface', $command);
};
$client = $this->getClient();
$command = new MockCommand(array(
'command.on_complete' => $testFunction
), $this->getOperation());
$command->setClient($client);
$command->prepare()->setResponse(new Response(200), true);
$command->execute();
$this->assertEquals(1, $called);
}
public function testOnCompleteMustBeCallable()
{
$client = $this->getClient();
$command = new MockCommand();
$command->setOnComplete('foo');
}
public function testCanSetResultManually()
{
$client = $this->getClient();
$client->getEventDispatcher()->addSubscriber(new MockPlugin(array(
new Response(200)
)));
$command = new MockCommand();
$client->execute($command);
$command->setResult('foo!');
$this->assertEquals('foo!', $command->getResult());
}
public function testCanInitConfig()
{
$command = $this->getMockBuilder('Guzzle\\Service\\Command\\AbstractCommand')
->setConstructorArgs(array(array(
'foo' => 'bar'
), new Operation(array(
'parameters' => array(
'baz' => new Parameter(array(
'default' => 'baaar'
))
)
))))
->getMockForAbstractClass();
$this->assertEquals('bar', $command['foo']);
$this->assertEquals('baaar', $command['baz']);
}
public function testAddsCurlOptionsToRequestsWhenPreparing()
{
$command = new MockCommand(array(
'foo' => 'bar',
'curl.options' => array('CURLOPT_PROXYPORT' => 8080)
));
$client = new Client();
$command->setClient($client);
$request = $command->prepare();
$this->assertEquals(8080, $request->getCurlOptions()->get(CURLOPT_PROXYPORT));
}
public function testIsInvokable()
{
$client = $this->getClient();
$response = new Response(200);
$this->setMockResponse($client, array($response));
$command = new MockCommand();
$command->setClient($client);
$this->assertSame($response, $command());
}
public function testCreatesDefaultOperation()
{
$command = $this->getMockBuilder('Guzzle\Service\Command\AbstractCommand')->getMockForAbstractClass();
$this->assertInstanceOf('Guzzle\Service\Description\Operation', $command->getOperation());
}
public function testAllowsValidatorToBeInjected()
{
$command = $this->getMockBuilder('Guzzle\Service\Command\AbstractCommand')->getMockForAbstractClass();
$v = new SchemaValidator();
$command->setValidator($v);
$this->assertSame($v, $this->readAttribute($command, 'validator'));
}
public function testCanDisableValidation()
{
$command = new MockCommand();
$command->setClient(new \Guzzle\Service\Client());
$v = $this->getMockBuilder('Guzzle\Service\Description\SchemaValidator')
->setMethods(array('validate'))
->getMock();
$v->expects($this->never())->method('validate');
$command->setValidator($v);
$command->set(AbstractCommand::DISABLE_VALIDATION, true);
$command->prepare();
}
public function testValidatorDoesNotUpdateNonDefaultValues()
{
$command = new MockCommand(array('test' => 123, 'foo' => 'bar'));
$command->setClient(new \Guzzle\Service\Client());
$command->prepare();
$this->assertEquals(123, $command->get('test'));
$this->assertEquals('bar', $command->get('foo'));
}
public function testValidatorUpdatesDefaultValues()
{
$command = new MockCommand();
$command->setClient(new \Guzzle\Service\Client());
$command->prepare();
$this->assertEquals(123, $command->get('test'));
$this->assertEquals('abc', $command->get('_internal'));
}
public function testValidatesCommandBeforeSending()
{
$command = new MockCommand();
$command->setClient(new \Guzzle\Service\Client());
$v = $this->getMockBuilder('Guzzle\Service\Description\SchemaValidator')
->setMethods(array('validate', 'getErrors'))
->getMock();
$v->expects($this->any())->method('validate')->will($this->returnValue(false));
$v->expects($this->any())->method('getErrors')->will($this->returnValue(array('[Foo] Baz', '[Bar] Boo')));
$command->setValidator($v);
$command->prepare();
}
public function testValidatesAdditionalParameters()
{
$description = ServiceDescription::factory(array(
'operations' => array(
'foo' => array(
'parameters' => array(
'baz' => array('type' => 'integer')
),
'additionalParameters' => array(
'type' => 'string'
)
)
)
));
$client = new Client();
$client->setDescription($description);
$command = $client->getCommand('foo', array(
'abc' => false,
'command.headers' => array('foo' => 'bar')
));
$command->prepare();
}
public function testCanAccessValidationErrorsFromCommand()
{
$validationErrors = array('[Foo] Baz', '[Bar] Boo');
$command = new MockCommand();
$command->setClient(new \Guzzle\Service\Client());
$this->assertFalse($command->getValidationErrors());
$v = $this->getMockBuilder('Guzzle\Service\Description\SchemaValidator')
->setMethods(array('validate', 'getErrors'))
->getMock();
$v->expects($this->any())->method('getErrors')->will($this->returnValue($validationErrors));
$command->setValidator($v);
$this->assertEquals($validationErrors, $command->getValidationErrors());
}
public function testCanChangeResponseBody()
{
$body = EntityBody::factory();
$command = new MockCommand();
$command->setClient(new \Guzzle\Service\Client());
$command->set(AbstractCommand::RESPONSE_BODY, $body);
$request = $command->prepare();
$this->assertSame($body, $this->readAttribute($request, 'responseBody'));
}
}