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: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559:
<?php
namespace Guzzle\Tests\Service\Command\LocationVisitor\Request;
use Guzzle\Service\Command\LocationVisitor\Request\XmlVisitor;
use Guzzle\Service\Client;
use Guzzle\Service\Description\Parameter;
use Guzzle\Service\Description\Operation;
use Guzzle\Http\Message\EntityEnclosingRequest;
class XmlVisitorTest extends AbstractVisitorTestCase
{
public function xmlProvider()
{
return array(
array(
array(
'data' => array(
'xmlRoot' => array(
'name' => 'test',
'namespaces' => 'http://foo.com'
)
),
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string'),
'Baz' => array('location' => 'xml', 'type' => 'string')
)
),
array('Foo' => 'test', 'Baz' => 'bar'),
'<test xmlns="http://foo.com"><Foo>test</Foo><Baz>bar</Baz></test>'
),
array(array('parameters' => array('Foo' => array('location' => 'xml', 'type' => 'string'))), array(), ''),
array(
array(
'data' => array(
'xmlRoot' => array(
'name' => 'test'
)
),
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string', 'data' => array('xmlAttribute' => true))
)
),
array('Foo' => 'test', 'Baz' => 'bar'),
'<test Foo="test"/>'
),
array(
array(
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string'),
'Baz' => array(
'type' => 'array',
'location' => 'xml',
'items' => array(
'type' => 'numeric',
'sentAs' => 'Bar'
)
)
)
),
array('Foo' => 'test', 'Baz' => array(1, 2)),
'<Request><Foo>test</Foo><Baz><Bar>1</Bar><Bar>2</Bar></Baz></Request>'
),
array(
array(
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string'),
'Baz' => array(
'type' => 'object',
'location' => 'xml',
'properties' => array(
'Bar' => array('type' => 'string'),
'Bam' => array()
)
)
)
),
array('Foo' => 'test', 'Baz' => array('Bar' => 'abc', 'Bam' => 'foo')),
'<Request><Foo>test</Foo><Baz><Bar>abc</Bar><Bam>foo</Bam></Baz></Request>'
),
array(
array(
'parameters' => array(
'Baz' => array(
'type' => 'array',
'location' => 'xml',
'items' => array(
'type' => 'object',
'sentAs' => 'Bar',
'properties' => array('A' => array(), 'B' => array())
)
)
)
),
array('Baz' => array(
array('A' => '1', 'B' => '2'),
array('A' => '3', 'B' => '4')
)),
'<Request><Baz><Bar><A>1</A><B>2</B></Bar><Bar><A>3</A><B>4</B></Bar></Baz></Request>'
),
array(
array(
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string'),
'Baz' => array(
'type' => 'object',
'location' => 'xml',
'properties' => array(
'Bar' => array('type' => 'string', 'data' => array('xmlAttribute' => true)),
'Bam' => array()
)
)
)
),
array('Foo' => 'test', 'Baz' => array('Bar' => 'abc', 'Bam' => 'foo')),
'<Request><Foo>test</Foo><Baz Bar="abc"><Bam>foo</Bam></Baz></Request>'
),
array(
array(
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string'),
'Baz' => array(
'type' => 'object',
'location' => 'xml',
'properties' => array(
'Bar' => array('type' => 'string', 'data' => array('xmlAttribute' => true)),
'Bam' => array()
)
)
)
),
array('Foo' => 'test', 'Baz' => array('Bam' => 'foo', 'Bar' => 'abc')),
'<Request><Foo>test</Foo><Baz Bar="abc"><Bam>foo</Bam></Baz></Request>'
),
array(
array(
'parameters' => array(
'Foo' => array(
'location' => 'xml',
'type' => 'string',
'data' => array(
'xmlNamespace' => 'http://foo.com'
)
)
)
),
array('Foo' => 'test'),
'<Request><Foo xmlns="http://foo.com">test</Foo></Request>'
),
array(
array(
'parameters' => array(
'Wrap' => array(
'type' => 'object',
'location' => 'xml',
'properties' => array(
'Foo' => array(
'type' => 'string',
'sentAs' => 'xsi:baz',
'data' => array(
'xmlNamespace' => 'http://foo.com',
'xmlAttribute' => true
)
)
)
),
)
),
array('Wrap' => array(
'Foo' => 'test'
)),
'<Request><Wrap xsi:baz="test" xmlns:xsi="http://foo.com"/></Request>'
),
array(
array(
'parameters' => array(
'Wrap' => array(
'type' => 'object',
'location' => 'xml',
'properties' => array(
'Foo' => array(
'type' => 'string',
'sentAs' => 'xsi:Foo',
'data' => array(
'xmlNamespace' => 'http://foobar.com'
)
)
)
),
)
),
array('Wrap' => array(
'Foo' => 'test'
)),
'<Request><Wrap><xsi:Foo xmlns:xsi="http://foobar.com">test</xsi:Foo></Wrap></Request>'
),
array(
array(
'parameters' => array(
'Foo' => array(
'location' => 'xml',
'type' => 'string',
'data' => array(
'xmlNamespace' => 'http://foo.com'
)
)
)
),
array('Foo' => '<h1>This is a title</h1>'),
'<Request><Foo xmlns="http://foo.com"><![CDATA[<h1>This is a title</h1>]]></Foo></Request>'
),
array(
array(
'parameters' => array(
'Bars' => array(
'type' => 'array',
'data' => array('xmlFlattened' => true),
'location' => 'xml',
'items' => array(
'type' => 'object',
'sentAs' => 'Bar',
'properties' => array(
'A' => array(),
'B' => array()
)
)
),
'Boos' => array(
'type' => 'array',
'data' => array('xmlFlattened' => true),
'location' => 'xml',
'items' => array(
'sentAs' => 'Boo',
'type' => 'string'
)
)
)
),
array(
'Bars' => array(
array('A' => '1', 'B' => '2'),
array('A' => '3', 'B' => '4')
),
'Boos' => array('test', '123')
),
'<Request><Bar><A>1</A><B>2</B></Bar><Bar><A>3</A><B>4</B></Bar><Boo>test</Boo><Boo>123</Boo></Request>'
),
array(
array(
'parameters' => array(
'Delete' => array(
'type' => 'object',
'location' => 'xml',
'properties' => array(
'Items' => array(
'type' => 'array',
'data' => array('xmlFlattened' => true),
'items' => array(
'type' => 'object',
'sentAs' => 'Item',
'properties' => array(
'A' => array(),
'B' => array()
)
)
)
)
)
)
),
array(
'Delete' => array(
'Items' => array(
array('A' => '1', 'B' => '2'),
array('A' => '3', 'B' => '4')
)
)
),
'<Request><Delete><Item><A>1</A><B>2</B></Item><Item><A>3</A><B>4</B></Item></Delete></Request>'
)
);
}
public function testSerializesXml(array $operation, array $input, $xml)
{
$operation = new Operation($operation);
$command = $this->getMockBuilder('Guzzle\Service\Command\OperationCommand')
->setConstructorArgs(array($input, $operation))
->getMockForAbstractClass();
$command->setClient(new Client('http://www.test.com/some/path.php'));
$request = $command->prepare();
if (!empty($input)) {
$this->assertEquals('application/xml', (string) $request->getHeader('Content-Type'));
} else {
$this->assertNull($request->getHeader('Content-Type'));
}
$body = str_replace(array("\n", "<?xml version=\"1.0\"?>"), '', (string) $request->getBody());
$this->assertEquals($xml, $body);
}
public function testAddsContentTypeAndTopLevelValues()
{
$operation = new Operation(array(
'data' => array(
'xmlRoot' => array(
'name' => 'test',
'namespaces' => array(
'xsi' => 'http://foo.com'
)
)
),
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string'),
'Baz' => array('location' => 'xml', 'type' => 'string')
)
));
$command = $this->getMockBuilder('Guzzle\Service\Command\OperationCommand')
->setConstructorArgs(array(array(
'Foo' => 'test',
'Baz' => 'bar'
), $operation))
->getMockForAbstractClass();
$command->setClient(new Client());
$request = $command->prepare();
$this->assertEquals('application/xml', (string) $request->getHeader('Content-Type'));
$this->assertEquals(
'<?xml version="1.0"?>' . "\n"
. '<test xmlns:xsi="http://foo.com"><Foo>test</Foo><Baz>bar</Baz></test>' . "\n",
(string) $request->getBody()
);
}
public function testCanChangeContentType()
{
$visitor = new XmlVisitor();
$visitor->setContentTypeHeader('application/foo');
$this->assertEquals('application/foo', $this->readAttribute($visitor, 'contentType'));
}
public function testCanAddArrayOfSimpleTypes()
{
$request = new EntityEnclosingRequest('POST', 'http://foo.com');
$visitor = new XmlVisitor();
$param = new Parameter(array(
'type' => 'object',
'location' => 'xml',
'name' => 'Out',
'properties' => array(
'Nodes' => array(
'required' => true,
'type' => 'array',
'min' => 1,
'items' => array('type' => 'string', 'sentAs' => 'Node')
)
)
));
$param->setParent(new Operation(array(
'data' => array(
'xmlRoot' => array(
'name' => 'Test',
'namespaces' => array(
'https://foo/'
)
)
)
)));
$value = array('Nodes' => array('foo', 'baz'));
$this->assertTrue($this->validator->validate($param, $value));
$visitor->visit($this->command, $request, $param, $value);
$visitor->after($this->command, $request);
$this->assertEquals(
"<?xml version=\"1.0\"?>\n"
. "<Test xmlns=\"https://foo/\"><Out><Nodes><Node>foo</Node><Node>baz</Node></Nodes></Out></Test>\n",
(string) $request->getBody()
);
}
public function testCanAddMultipleNamespacesToRoot()
{
$operation = new Operation(array(
'data' => array(
'xmlRoot' => array(
'name' => 'Hi',
'namespaces' => array(
'xsi' => 'http://foo.com',
'foo' => 'http://foobar.com'
)
)
),
'parameters' => array(
'Foo' => array('location' => 'xml', 'type' => 'string')
)
));
$command = $this->getMockBuilder('Guzzle\Service\Command\OperationCommand')
->setConstructorArgs(array(array(
'Foo' => 'test'
), $operation))
->getMockForAbstractClass();
$command->setClient(new Client());
$request = $command->prepare();
$this->assertEquals('application/xml', (string) $request->getHeader('Content-Type'));
$this->assertEquals(
'<?xml version="1.0"?>' . "\n"
. '<Hi xmlns:xsi="http://foo.com" xmlns:foo="http://foobar.com"><Foo>test</Foo></Hi>' . "\n",
(string) $request->getBody()
);
}
public function testValuesAreFiltered()
{
$operation = new Operation(array(
'parameters' => array(
'Foo' => array(
'location' => 'xml',
'type' => 'string',
'filters' => array('strtoupper')
),
'Bar' => array(
'location' => 'xml',
'type' => 'object',
'properties' => array(
'Baz' => array(
'filters' => array('strtoupper')
)
)
)
)
));
$command = $this->getMockBuilder('Guzzle\Service\Command\OperationCommand')
->setConstructorArgs(array(array(
'Foo' => 'test',
'Bar' => array(
'Baz' => 'abc'
)
), $operation))
->getMockForAbstractClass();
$command->setClient(new Client());
$request = $command->prepare();
$this->assertEquals(
'<?xml version="1.0"?>' . "\n"
. '<Request><Foo>TEST</Foo><Bar><Baz>ABC</Baz></Bar></Request>' . "\n",
(string) $request->getBody()
);
}
public function testSkipsNullValues()
{
$operation = new Operation(array(
'parameters' => array(
'Foo' => array(
'location' => 'xml',
'type' => 'string'
),
'Bar' => array(
'location' => 'xml',
'type' => 'object',
'properties' => array(
'Baz' => array(),
'Bam' => array(),
)
),
'Arr' => array(
'type' => 'array',
'items' => array(
'type' => 'string'
)
)
)
));
$command = $this->getMockBuilder('Guzzle\Service\Command\OperationCommand')
->setConstructorArgs(array(array(
'Foo' => null,
'Bar' => array(
'Bar' => null,
'Bam' => 'test'
),
'Arr' => array(null)
), $operation))
->getMockForAbstractClass();
$command->setClient(new Client());
$request = $command->prepare();
$this->assertEquals(
'<?xml version="1.0"?>' . "\n"
. '<Request><Bar><Bam>test</Bam></Bar></Request>' . "\n",
(string) $request->getBody()
);
}
public function testAllowsXmlEncoding()
{
$operation = new Operation(array(
'data' => array(
'xmlEncoding' => 'UTF-8'
),
'parameters' => array(
'Foo' => array('location' => 'xml')
)
));
$command = $this->getMockBuilder('Guzzle\Service\Command\OperationCommand')
->setConstructorArgs(array(array('Foo' => 'test'), $operation))
->getMockForAbstractClass();
$command->setClient(new Client());
$request = $command->prepare();
$this->assertEquals(
'<?xml version="1.0" encoding="UTF-8"?>' . "\n"
. '<Request><Foo>test</Foo></Request>' . "\n",
(string) $request->getBody()
);
}
public function testAllowsSendingXmlPayloadIfNoXmlParamsWereSet()
{
$operation = new Operation(array(
'httpMethod' => 'POST',
'data' => array('xmlAllowEmpty' => true),
'parameters' => array('Foo' => array('location' => 'xml'))
));
$command = $this->getMockBuilder('Guzzle\Service\Command\OperationCommand')
->setConstructorArgs(array(array(), $operation))
->getMockForAbstractClass();
$command->setClient(new Client('http://foo.com'));
$request = $command->prepare();
$this->assertEquals(
'<?xml version="1.0"?>' . "\n"
. '<Request/>' . "\n",
(string) $request->getBody()
);
}
}