* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org) * * Licensed under The MIT License * For full copyright and license information, please see the LICENSE.txt * Redistributions of files must retain the above copyright notice * * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org) * @link http://book.cakephp.org/2.0/en/development/testing.html CakePHP(tm) Tests * @package Cake.Test.Case.Utility * @since CakePHP(tm) v 1.2.0.5432 * @license http://www.opensource.org/licenses/mit-license.php MIT License */ App::uses('Xml', 'Utility'); App::uses('CakeTestModel', 'TestSuite/Fixture'); /** * Article class * * @package Cake.Test.Case.Utility */ class XmlArticle extends CakeTestModel { /** * name property * * @var string */ public $name = 'Article'; /** * belongsTo property * * @var array */ public $belongsTo = array( 'User' => array( 'className' => 'XmlUser', 'foreignKey' => 'user_id' ) ); } /** * User class * * @package Cake.Test.Case.Utility */ class XmlUser extends CakeTestModel { /** * name property * * @var string */ public $name = 'User'; /** * hasMany property * * @var array */ public $hasMany = array( 'Article' => array( 'className' => 'XmlArticle' ) ); } /** * XmlTest class * * @package Cake.Test.Case.Utility */ class XmlTest extends CakeTestCase { /** * autoFixtures property * * @var boolean */ public $autoFixtures = false; /** * fixtures property * @var array */ public $fixtures = array( 'core.article', 'core.user' ); /** * setUp method * * @return void */ public function setUp() { parent::setUp(); $this->_appEncoding = Configure::read('App.encoding'); Configure::write('App.encoding', 'UTF-8'); } /** * tearDown method * * @return void */ public function tearDown() { parent::tearDown(); Configure::write('App.encoding', $this->_appEncoding); } /** * testBuild method * * @return void */ public function testBuild() { $xml = 'value'; $obj = Xml::build($xml); $this->assertTrue($obj instanceof SimpleXMLElement); $this->assertEquals('tag', (string)$obj->getName()); $this->assertEquals('value', (string)$obj); $xml = 'value'; $this->assertEquals($obj, Xml::build($xml)); $obj = Xml::build($xml, array('return' => 'domdocument')); $this->assertTrue($obj instanceof DOMDocument); $this->assertEquals('tag', $obj->firstChild->nodeName); $this->assertEquals('value', $obj->firstChild->nodeValue); $xml = CAKE . 'Test' . DS . 'Fixture' . DS . 'sample.xml'; $obj = Xml::build($xml); $this->assertEquals('tags', $obj->getName()); $this->assertEquals(2, count($obj)); $this->assertEquals(Xml::build($xml), Xml::build(file_get_contents($xml))); $obj = Xml::build($xml, array('return' => 'domdocument')); $this->assertEquals('tags', $obj->firstChild->nodeName); $this->assertEquals( Xml::build($xml, array('return' => 'domdocument')), Xml::build(file_get_contents($xml), array('return' => 'domdocument')) ); $this->assertEquals( Xml::build($xml, array('return' => 'simplexml')), Xml::build($xml, 'simplexml') ); $xml = array('tag' => 'value'); $obj = Xml::build($xml); $this->assertEquals('tag', $obj->getName()); $this->assertEquals('value', (string)$obj); $obj = Xml::build($xml, array('return' => 'domdocument')); $this->assertEquals('tag', $obj->firstChild->nodeName); $this->assertEquals('value', $obj->firstChild->nodeValue); $obj = Xml::build($xml, array('return' => 'domdocument', 'encoding' => null)); $this->assertNotRegExp('/encoding/', $obj->saveXML()); } /** * data provider function for testBuildInvalidData * * @return array */ public static function invalidDataProvider() { return array( array(null), array(false), array(''), array('http://localhost/notthere.xml'), ); } /** * testBuildInvalidData * * @dataProvider invalidDataProvider * @expectedException XmlException * @return void */ public function testBuildInvalidData($value) { Xml::build($value); } /** * Test that building SimpleXmlElement with invalid XML causes the right exception. * * @expectedException XmlException * @return void */ public function testBuildInvalidDataSimpleXml() { $input = ' 'simplexml')); } /** * test build with a single empty tag * * return void */ public function testBuildEmptyTag() { try { Xml::build(''); $this->fail('No exception'); } catch (Exception $e) { $this->assertTrue(true, 'An exception was raised'); } } /** * testFromArray method * * @return void */ public function testFromArray() { $xml = array('tag' => 'value'); $obj = Xml::fromArray($xml); $this->assertEquals('tag', $obj->getName()); $this->assertEquals('value', (string)$obj); $xml = array('tag' => null); $obj = Xml::fromArray($xml); $this->assertEquals('tag', $obj->getName()); $this->assertEquals('', (string)$obj); $xml = array('tag' => array('@' => 'value')); $obj = Xml::fromArray($xml); $this->assertEquals('tag', $obj->getName()); $this->assertEquals('value', (string)$obj); $xml = array( 'tags' => array( 'tag' => array( array( 'id' => '1', 'name' => 'defect' ), array( 'id' => '2', 'name' => 'enhancement' ) ) ) ); $obj = Xml::fromArray($xml, 'attributes'); $this->assertTrue($obj instanceof SimpleXMLElement); $this->assertEquals('tags', $obj->getName()); $this->assertEquals(2, count($obj)); $xmlText = << XML; $this->assertXmlStringEqualsXmlString($xmlText, $obj->asXML()); $obj = Xml::fromArray($xml); $this->assertTrue($obj instanceof SimpleXMLElement); $this->assertEquals('tags', $obj->getName()); $this->assertEquals(2, count($obj)); $xmlText = << 1 defect 2 enhancement XML; $this->assertXmlStringEqualsXmlString($xmlText, $obj->asXML()); $xml = array( 'tags' => array( ) ); $obj = Xml::fromArray($xml); $this->assertEquals('tags', $obj->getName()); $this->assertEquals('', (string)$obj); $xml = array( 'tags' => array( 'bool' => true, 'int' => 1, 'float' => 10.2, 'string' => 'ok', 'null' => null, 'array' => array() ) ); $obj = Xml::fromArray($xml, 'tags'); $this->assertEquals(6, count($obj)); $this->assertSame((string)$obj->bool, '1'); $this->assertSame((string)$obj->int, '1'); $this->assertSame((string)$obj->float, '10.2'); $this->assertSame((string)$obj->string, 'ok'); $this->assertSame((string)$obj->null, ''); $this->assertSame((string)$obj->array, ''); $xml = array( 'tags' => array( 'tag' => array( array( '@id' => '1', 'name' => 'defect' ), array( '@id' => '2', 'name' => 'enhancement' ) ) ) ); $obj = Xml::fromArray($xml, 'tags'); $xmlText = << defect enhancement XML; $this->assertXmlStringEqualsXmlString($xmlText, $obj->asXML()); $xml = array( 'tags' => array( 'tag' => array( array( '@id' => '1', 'name' => 'defect', '@' => 'Tag 1' ), array( '@id' => '2', 'name' => 'enhancement' ), ), '@' => 'All tags' ) ); $obj = Xml::fromArray($xml, 'tags'); $xmlText = << All tagsTag 1defectenhancement XML; $this->assertXmlStringEqualsXmlString($xmlText, $obj->asXML()); $xml = array( 'tags' => array( 'tag' => array( 'id' => 1, '@' => 'defect' ) ) ); $obj = Xml::fromArray($xml, 'attributes'); $xmlText = '<' . '?xml version="1.0" encoding="UTF-8"?>defect'; $this->assertXmlStringEqualsXmlString($xmlText, $obj->asXML()); $xml = array( 'tag' => array( '@' => 0, '@test' => 'A test' ) ); $obj = Xml::fromArray($xml); $xmlText = << 0 XML; $this->assertXmlStringEqualsXmlString($xmlText, $obj->asXML()); } /** * Test non-sequential keys in list types. * * @return void */ public function testFromArrayNonSequentialKeys() { $xmlArray = array( 'Event' => array( array( 'id' => '235', 'Attribute' => array( 0 => array( 'id' => '9646', ), 2 => array( 'id' => '9647', ) ) ) ) ); $obj = Xml::fromArray($xmlArray); $expected = << 235 9646 9647 XML; $this->assertXmlStringEqualsXmlString($expected, $obj->asXML()); } /** * testFromArrayPretty method * * @return void */ public function testFromArrayPretty() { $xml = array( 'tags' => array( 'tag' => array( array( 'id' => '1', 'name' => 'defect' ), array( 'id' => '2', 'name' => 'enhancement' ) ) ) ); $expected = << 1defect2enhancement XML; $xmlResponse = Xml::fromArray($xml, array('pretty' => false)); $this->assertTextEquals($expected, $xmlResponse->asXML()); $expected = << 1 defect 2 enhancement XML; $xmlResponse = Xml::fromArray($xml, array('pretty' => true)); $this->assertTextEquals($expected, $xmlResponse->asXML()); $xml = array( 'tags' => array( 'tag' => array( array( 'id' => '1', 'name' => 'defect' ), array( 'id' => '2', 'name' => 'enhancement' ) ) ) ); $expected = << XML; $xmlResponse = Xml::fromArray($xml, array('pretty' => false, 'format' => 'attributes')); $this->assertTextEquals($expected, $xmlResponse->asXML()); $expected = << XML; $xmlResponse = Xml::fromArray($xml, array('pretty' => true, 'format' => 'attributes')); $this->assertTextEquals($expected, $xmlResponse->asXML()); } /** * data provider for fromArray() failures * * @return array */ public static function invalidArrayDataProvider() { return array( array(''), array(null), array(false), array(array()), array(array('numeric key as root')), array(array('item1' => '', 'item2' => '')), array(array('items' => array('item1', 'item2'))), array(array( 'tags' => array( 'tag' => array( array( array( 'string' ) ) ) ) )), array(array( 'tags' => array( '@tag' => array( array( '@id' => '1', 'name' => 'defect' ), array( '@id' => '2', 'name' => 'enhancement' ) ) ) )), array(new DateTime()) ); } /** * testFromArrayFail method * * @dataProvider invalidArrayDataProvider */ public function testFromArrayFail($value) { try { Xml::fromArray($value); $this->fail('No exception.'); } catch (Exception $e) { $this->assertTrue(true, 'Caught exception.'); } } /** * Test that there are not unterminated errors when building xml * * @return void */ public function testFromArrayUnterminatedError() { $data = array( 'product_ID' => 'GENERT-DL', 'deeplink' => 'http://example.com/deep', 'image_URL' => 'http://example.com/image', 'thumbnail_image_URL' => 'http://example.com/thumb', 'brand' => 'Malte Lange & Co', 'availability' => 'in stock', 'authors' => array( 'author' => array('Malte Lange & Co') ) ); $xml = Xml::fromArray(array('products' => $data), 'tags'); $expected = << GENERT-DL http://example.com/deep http://example.com/image http://example.com/thumb Malte Lange & Co in stock Malte Lange & Co XML; $this->assertXmlStringEqualsXmlString($expected, $xml->asXML()); } /** * testToArray method * * @return void */ public function testToArray() { $xml = 'name'; $obj = Xml::build($xml); $this->assertEquals(array('tag' => 'name'), Xml::toArray($obj)); $xml = CAKE . 'Test' . DS . 'Fixture' . DS . 'sample.xml'; $obj = Xml::build($xml); $expected = array( 'tags' => array( 'tag' => array( array( '@id' => '1', 'name' => 'defect' ), array( '@id' => '2', 'name' => 'enhancement' ) ) ) ); $this->assertEquals($expected, Xml::toArray($obj)); $array = array( 'tags' => array( 'tag' => array( array( 'id' => '1', 'name' => 'defect' ), array( 'id' => '2', 'name' => 'enhancement' ) ) ) ); $this->assertEquals(Xml::toArray(Xml::fromArray($array, 'tags')), $array); $expected = array( 'tags' => array( 'tag' => array( array( '@id' => '1', '@name' => 'defect' ), array( '@id' => '2', '@name' => 'enhancement' ) ) ) ); $this->assertEquals($expected, Xml::toArray(Xml::fromArray($array, 'attributes'))); $this->assertEquals($expected, Xml::toArray(Xml::fromArray($array, array('return' => 'domdocument', 'format' => 'attributes')))); $this->assertEquals(Xml::toArray(Xml::fromArray($array)), $array); $this->assertEquals(Xml::toArray(Xml::fromArray($array, array('return' => 'domdocument'))), $array); $array = array( 'tags' => array( 'tag' => array( 'id' => '1', 'posts' => array( array('id' => '1'), array('id' => '2') ) ), 'tagOther' => array( 'subtag' => array( 'id' => '1' ) ) ) ); $expected = array( 'tags' => array( 'tag' => array( '@id' => '1', 'posts' => array( array('@id' => '1'), array('@id' => '2') ) ), 'tagOther' => array( 'subtag' => array( '@id' => '1' ) ) ) ); $this->assertEquals($expected, Xml::toArray(Xml::fromArray($array, 'attributes'))); $this->assertEquals($expected, Xml::toArray(Xml::fromArray($array, array('format' => 'attributes', 'return' => 'domdocument')))); $xml = << defect XML; $obj = Xml::build($xml); $expected = array( 'root' => array( 'tag' => array( '@id' => 1, '@' => 'defect' ) ) ); $this->assertEquals($expected, Xml::toArray($obj)); $xml = <<
ApplesBananas
CakePHPMIT
The book is on the table.
XML; $obj = Xml::build($xml); $expected = array( 'root' => array( 'table' => array( array('tr' => array('td' => array('Apples', 'Bananas'))), array('name' => 'CakePHP', 'license' => 'MIT'), 'The book is on the table.' ) ) ); $this->assertEquals($expected, Xml::toArray($obj)); $xml = << defect 1 XML; $obj = Xml::build($xml); $expected = array( 'root' => array( 'tag' => 'defect', 'cake:bug' => 1 ) ); $this->assertEquals($expected, Xml::toArray($obj)); $xml = '0'; $obj = Xml::build($xml); $expected = array( 'tag' => array( '@type' => 'myType', '@' => 0 ) ); $this->assertEquals($expected, Xml::toArray($obj)); } /** * testRss * * @return void */ public function testRss() { $rss = file_get_contents(CAKE . 'Test' . DS . 'Fixture' . DS . 'rss.xml'); $rssAsArray = Xml::toArray(Xml::build($rss)); $this->assertEquals('2.0', $rssAsArray['rss']['@version']); $this->assertEquals(2, count($rssAsArray['rss']['channel']['item'])); $atomLink = array('@href' => 'http://bakery.cakephp.org/articles/rss', '@rel' => 'self', '@type' => 'application/rss+xml'); $this->assertEquals($rssAsArray['rss']['channel']['atom:link'], $atomLink); $this->assertEquals('http://bakery.cakephp.org/', $rssAsArray['rss']['channel']['link']); $expected = array( 'title' => 'Alertpay automated sales via IPN', 'link' => 'http://bakery.cakephp.org/articles/view/alertpay-automated-sales-via-ipn', 'description' => 'I\'m going to show you how I implemented a payment module via the Alertpay payment processor.', 'pubDate' => 'Tue, 31 Aug 2010 01:42:00 -0500', 'guid' => 'http://bakery.cakephp.org/articles/view/alertpay-automated-sales-via-ipn' ); $this->assertSame($rssAsArray['rss']['channel']['item'][1], $expected); $rss = array( 'rss' => array( 'xmlns:atom' => 'http://www.w3.org/2005/Atom', '@version' => '2.0', 'channel' => array( 'atom:link' => array( '@href' => 'http://bakery.cakephp.org/articles/rss', '@rel' => 'self', '@type' => 'application/rss+xml' ), 'title' => 'The Bakery: ', 'link' => 'http://bakery.cakephp.org/', 'description' => 'Recent Articles at The Bakery.', 'pubDate' => 'Sun, 12 Sep 2010 04:18:26 -0500', 'item' => array( array( 'title' => 'CakePHP 1.3.4 released', 'link' => 'http://bakery.cakephp.org/articles/view/cakephp-1-3-4-released' ), array( 'title' => 'Wizard Component 1.2 Tutorial', 'link' => 'http://bakery.cakephp.org/articles/view/wizard-component-1-2-tutorial' ) ) ) ) ); $rssAsSimpleXML = Xml::fromArray($rss); $xmlText = << The Bakery: http://bakery.cakephp.org/ Recent Articles at The Bakery. Sun, 12 Sep 2010 04:18:26 -0500 CakePHP 1.3.4 released http://bakery.cakephp.org/articles/view/cakephp-1-3-4-released Wizard Component 1.2 Tutorial http://bakery.cakephp.org/articles/view/wizard-component-1-2-tutorial XML; $this->assertXmlStringEqualsXmlString($xmlText, $rssAsSimpleXML->asXML()); } /** * testXmlRpc * * @return void */ public function testXmlRpc() { $xml = Xml::build('test'); $expected = array( 'methodCall' => array( 'methodName' => 'test', 'params' => '' ) ); $this->assertSame(Xml::toArray($xml), $expected); $xml = Xml::build('test12Egypt0-31'); $expected = array( 'methodCall' => array( 'methodName' => 'test', 'params' => array( 'param' => array( 'value' => array( 'array' => array( 'data' => array( 'value' => array( array('int' => '12'), array('string' => 'Egypt'), array('boolean' => '0'), array('int' => '-31') ) ) ) ) ) ) ) ); $this->assertSame(Xml::toArray($xml), $expected); $xmlText = << 1 testing XML; $xml = Xml::build($xmlText); $expected = array( 'methodResponse' => array( 'params' => array( 'param' => array( 'value' => array( 'array' => array( 'data' => array( 'value' => array( array('int' => '1'), array('string' => 'testing') ) ) ) ) ) ) ) ); $this->assertSame(Xml::toArray($xml), $expected); $xml = Xml::fromArray($expected, 'tags'); $this->assertXmlStringEqualsXmlString($xmlText, $xml->asXML()); } /** * testSoap * * @return void */ public function testSoap() { $xmlRequest = Xml::build(CAKE . 'Test' . DS . 'Fixture' . DS . 'soap_request.xml'); $expected = array( 'Envelope' => array( '@soap:encodingStyle' => 'http://www.w3.org/2001/12/soap-encoding', 'soap:Body' => array( 'm:GetStockPrice' => array( 'm:StockName' => 'IBM' ) ) ) ); $this->assertEquals($expected, Xml::toArray($xmlRequest)); $xmlResponse = Xml::build(CAKE . 'Test' . DS . 'Fixture' . DS . 'soap_response.xml'); $expected = array( 'Envelope' => array( '@soap:encodingStyle' => 'http://www.w3.org/2001/12/soap-encoding', 'soap:Body' => array( 'm:GetStockPriceResponse' => array( 'm:Price' => '34.5' ) ) ) ); $this->assertEquals($expected, Xml::toArray($xmlResponse)); $xml = array( 'soap:Envelope' => array( 'xmlns:soap' => 'http://www.w3.org/2001/12/soap-envelope', '@soap:encodingStyle' => 'http://www.w3.org/2001/12/soap-encoding', 'soap:Body' => array( 'xmlns:m' => 'http://www.example.org/stock', 'm:GetStockPrice' => array( 'm:StockName' => 'IBM' ) ) ) ); $xmlRequest = Xml::fromArray($xml, array('encoding' => null)); $xmlText = << IBM XML; $this->assertXmlStringEqualsXmlString($xmlText, $xmlRequest->asXML()); } /** * testNamespace * * @return void */ public function testNamespace() { $xml = << good bad Tag without ns XML; $xmlResponse = Xml::build($xml); $expected = array( 'root' => array( 'ns:tag' => array( '@id' => '1', 'child' => 'good', 'otherchild' => 'bad' ), 'tag' => 'Tag without ns' ) ); $this->assertEquals($expected, Xml::toArray($xmlResponse)); $xmlResponse = Xml::build('1'); $expected = array( 'root' => array( 'ns:tag' => array( '@id' => '1' ), 'tag' => array( 'id' => '1' ) ) ); $this->assertEquals($expected, Xml::toArray($xmlResponse)); $xmlResponse = Xml::build('1'); $expected = array( 'root' => array( 'ns:attr' => '1' ) ); $this->assertEquals($expected, Xml::toArray($xmlResponse)); $xmlResponse = Xml::build('1'); $this->assertEquals($expected, Xml::toArray($xmlResponse)); $xml = array( 'root' => array( 'ns:attr' => array( 'xmlns:ns' => 'http://cakephp.org', '@' => 1 ) ) ); $expected = '<' . '?xml version="1.0" encoding="UTF-8"?>1'; $xmlResponse = Xml::fromArray($xml); $this->assertEquals(str_replace(array("\r", "\n"), '', $xmlResponse->asXML()), $expected); $xml = array( 'root' => array( 'tag' => array( 'xmlns:pref' => 'http://cakephp.org', 'pref:item' => array( 'item 1', 'item 2' ) ) ) ); $expected = << item 1 item 2 XML; $xmlResponse = Xml::fromArray($xml); $this->assertXmlStringEqualsXmlString($expected, $xmlResponse->asXML()); $xml = array( 'root' => array( 'tag' => array( 'xmlns:' => 'http://cakephp.org' ) ) ); $expected = '<' . '?xml version="1.0" encoding="UTF-8"?>'; $xmlResponse = Xml::fromArray($xml); $this->assertXmlStringEqualsXmlString($expected, $xmlResponse->asXML()); $xml = array( 'root' => array( 'xmlns:' => 'http://cakephp.org' ) ); $expected = '<' . '?xml version="1.0" encoding="UTF-8"?>'; $xmlResponse = Xml::fromArray($xml); $this->assertXmlStringEqualsXmlString($expected, $xmlResponse->asXML()); $xml = array( 'root' => array( 'xmlns:ns' => 'http://cakephp.org' ) ); $expected = '<' . '?xml version="1.0" encoding="UTF-8"?>'; $xmlResponse = Xml::fromArray($xml); $this->assertXmlStringEqualsXmlString($expected, $xmlResponse->asXML()); } /** * test that CDATA blocks don't get screwed up by SimpleXml * * @return void */ public function testCdata() { $xml = '<' . '?xml version="1.0" encoding="UTF-8"?>' . ''; $result = Xml::build($xml); $this->assertEquals(' Mark ', (string)$result->name); } /** * data provider for toArray() failures * * @return array */ public static function invalidToArrayDataProvider() { return array( array(new DateTime()), array(array()) ); } /** * testToArrayFail method * * @dataProvider invalidToArrayDataProvider * @expectedException XmlException */ public function testToArrayFail($value) { Xml::toArray($value); } /** * testWithModel method * * @return void */ public function testWithModel() { $this->loadFixtures('User', 'Article'); $user = new XmlUser(); $data = $user->read(null, 1); $obj = Xml::build(compact('data')); $expected = << 1mariano5f4dcc3b5aa765d61d8327deb882cf99 2007-03-17 01:16:232007-03-17 01:18:31
11First ArticleFirst Article Body Y2007-03-18 10:39:232007-03-18 10:41:31
31Third ArticleThird Article Body Y2007-03-18 10:43:232007-03-18 10:45:31
XML; $this->assertXmlStringEqualsXmlString($expected, $obj->asXML()); //multiple model results - without a records key it would fatal error $data = $user->find('all', array('limit' => 2)); $data = array('records' => $data); $obj = Xml::build(compact('data')); $expected = << 1mariano5f4dcc3b5aa765d61d8327deb882cf99 2007-03-17 01:16:232007-03-17 01:18:31
11First ArticleFirst Article Body Y2007-03-18 10:39:232007-03-18 10:41:31
31Third ArticleThird Article Body Y2007-03-18 10:43:232007-03-18 10:45:31
2nate5f4dcc3b5aa765d61d8327deb882cf99 2007-03-17 01:18:232007-03-17 01:20:31
XML; $obj->asXML(); $this->assertXmlStringEqualsXmlString($expected, $obj->asXML()); } /** * Test ampersand in text elements. * * @return void */ public function testAmpInText() { $data = array( 'outer' => array( 'inner' => array('name' => 'mark & mark') ) ); $obj = Xml::build($data); $result = $obj->asXml(); $this->assertContains('mark & mark', $result); } /** * Test that entity loading is disabled by default. * * @return void */ public function testNoEntityLoading() { $file = CAKE . 'VERSION.txt'; $xml = <<]> &payload; XML; try { $result = Xml::build($xml); $this->assertEquals('', (string)$result->xxe); } catch (Exception $e) { $this->assertTrue(true, 'A warning was raised meaning external entities were not loaded'); } } }