/iti-note-rest-client-php/vendor/guzzle/guzzle/tests/Guzzle/Tests/Service/Command/CommandTest.php
PHP | 420 lines | 340 code | 50 blank | 30 comment | 0 complexity | 0f045d0ec3d207900d3f8a732f19d9fd MD5 | raw file
- <?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;
- /**
- * @covers Guzzle\Service\Command\AbstractCommand
- */
- 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());
- }
- /**
- * @expectedException RuntimeException
- */
- 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));
- // Returns the result of the command
- $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());
- // Make sure that the result was automatically set to a SimpleXMLElement
- $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());
- }
- /**
- * @expectedException \Guzzle\Common\Exception\RuntimeException
- */
- public function testConvertsInvalidJsonResponsesToArray()
- {
- $client = $this->getClient();
- $this->setMockResponse($client, array(
- new \Guzzle\Http\Message\Response(200, array(
- 'Content-Type' => 'application/json'
- ), '{ "key": "Hi!" }invalid'
- )
- ));
- $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);
- // Make sure that the result was not converted to XML
- $this->assertFalse($command->getResult() instanceof \SimpleXMLElement);
- }
- /**
- * @expectedException RuntimeException
- */
- public function testExecuteThrowsExceptionWhenNoClientIsSet()
- {
- $command = new MockCommand();
- $command->execute();
- }
- /**
- * @expectedException RuntimeException
- */
- 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);
- }
- /**
- * @expectedException \Guzzle\Common\Exception\InvalidArgumentException
- */
- 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);
- // Returns the result of the command
- $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'));
- }
- /**
- * @expectedException \Guzzle\Service\Exception\ValidationException
- * @expectedExceptionMessage [Foo] Baz
- */
- 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();
- }
- /**
- * @expectedException \Guzzle\Service\Exception\ValidationException
- * @expectedExceptionMessage Validation errors: [abc] must be of type string
- */
- 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 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'));
- }
- }