ServerTest.php 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878
  1. <?php
  2. /**
  3. * Zend Framework
  4. *
  5. * LICENSE
  6. *
  7. * This source file is subject to the new BSD license that is bundled
  8. * with this package in the file LICENSE.txt.
  9. * It is also available through the world-wide-web at this URL:
  10. * http://framework.zend.com/license/new-bsd
  11. * If you did not receive a copy of the license and are unable to
  12. * obtain it through the world-wide-web, please send an email
  13. * to license@zend.com so we can send you a copy immediately.
  14. *
  15. * @category Zend
  16. * @package Zend_Rest
  17. * @subpackage UnitTests
  18. * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19. * @license http://framework.zend.com/license/new-bsd New BSD License
  20. * @version $Id$
  21. */
  22. // Call Zend_Rest_ServerTest::main() if this source file is executed directly.
  23. if (!defined("PHPUnit_MAIN_METHOD")) {
  24. define("PHPUnit_MAIN_METHOD", "Zend_Rest_ServerTest::main");
  25. }
  26. require_once dirname(__FILE__) . '/../../TestHelper.php';
  27. /**
  28. * Zend_Rest_Server
  29. */
  30. require_once 'Zend/Rest/Server.php';
  31. /**
  32. * Test cases for Zend_Rest_Server
  33. *
  34. * @category Zend
  35. * @package Zend_Rest
  36. * @subpackage UnitTests
  37. * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  38. * @license http://framework.zend.com/license/new-bsd New BSD License
  39. * @group Zend_Rest
  40. * @group Zend_Rest_Server
  41. */
  42. class Zend_Rest_ServerTest extends PHPUnit_Framework_TestCase
  43. {
  44. /**
  45. * Runs the test methods of this class.
  46. *
  47. * @return void
  48. */
  49. public static function main()
  50. {
  51. require_once "PHPUnit/TextUI/TestRunner.php";
  52. $suite = new PHPUnit_Framework_TestSuite("Zend_Rest_ServerTest");
  53. $result = PHPUnit_TextUI_TestRunner::run($suite);
  54. }
  55. public function setUp()
  56. {
  57. if (isset($this->request)) {
  58. $_REQUEST = $this->request;
  59. } else {
  60. $this->request = $_REQUEST;
  61. }
  62. }
  63. public function testAddFunctionSimple()
  64. {
  65. $server = new Zend_Rest_Server();
  66. $server->addFunction('Zend_Rest_Server_TestFunc');
  67. $funcs = $server->getFunctions();
  68. $this->assertTrue(isset($funcs['Zend_Rest_Server_TestFunc']), "Function not registered.");
  69. }
  70. public function testSetClass()
  71. {
  72. $server = new Zend_Rest_Server();
  73. $server->setClass('Zend_Rest_Server_Test');
  74. $funcs = $server->getFunctions();
  75. $this->assertTrue(isset($funcs['testFunc']), "Class Not Registered. testFunc not found");
  76. $this->assertTrue(isset($funcs['testFunc2']), "Class Not Registered. testFunc2 not found");
  77. $this->assertTrue(isset($funcs['testFunc3']), "Class Not Registered. testFunc3 not found");
  78. }
  79. public function testHandleNamedArgFunction()
  80. {
  81. $server = new Zend_Rest_Server();
  82. $server->addFunction('Zend_Rest_Server_TestFunc');
  83. ob_start();
  84. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc', 'who' => 'Davey'));
  85. $result = ob_get_clean();
  86. $this->assertContains('<Zend_Rest_Server_TestFunc generator="zend" version="1.0"><response>Hello Davey</response><status>success</status></Zend_Rest_Server_TestFunc>', $result, "Bad Result");
  87. }
  88. public function testHandleFunctionNoArgs()
  89. {
  90. $server = new Zend_Rest_Server();
  91. $server->addFunction('Zend_Rest_Server_TestFunc2');
  92. ob_start();
  93. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc2'));
  94. $result = ob_get_clean();
  95. $this->assertContains('<Zend_Rest_Server_TestFunc2 generator="zend" version="1.0"><response>Hello World</response><status>success</status></Zend_Rest_Server_TestFunc2>', $result, "Bad Result");
  96. }
  97. public function testHandleFunctionNoArgsRaisesFaultResponse()
  98. {
  99. $server = new Zend_Rest_Server();
  100. $server->returnResponse(true);
  101. $server->addFunction('Zend_Rest_Server_TestFunc');
  102. $result = $server->handle(array('method' => 'Zend_Rest_Server_TestFunc'));
  103. $this->assertContains('failed', $result);
  104. }
  105. public function testHandleFunctionNoArgsUsingRequest()
  106. {
  107. $_REQUEST = array(
  108. 'method' => 'Zend_Rest_Server_TestFunc2'
  109. );
  110. $server = new Zend_Rest_Server();
  111. $server->addFunction('Zend_Rest_Server_TestFunc2');
  112. ob_start();
  113. $server->handle();
  114. $result = ob_get_clean();
  115. $this->assertContains('<Zend_Rest_Server_TestFunc2 generator="zend" version="1.0"><response>Hello World</response><status>success</status></Zend_Rest_Server_TestFunc2>', $result, "Bad Result");
  116. }
  117. public function testHandleAnonymousArgFunction()
  118. {
  119. $server = new Zend_Rest_Server();
  120. $server->addFunction('Zend_Rest_Server_TestFunc');
  121. ob_start();
  122. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc', 'arg1' => 'Davey'));
  123. $result = ob_get_clean();
  124. $this->assertContains('<Zend_Rest_Server_TestFunc generator="zend" version="1.0"><response>Hello Davey</response><status>success</status></Zend_Rest_Server_TestFunc>', $result, "Bad Result");
  125. }
  126. public function testHandleMultipleFunction()
  127. {
  128. $server = new Zend_Rest_Server();
  129. $server->addFunction('Zend_Rest_Server_TestFunc2');
  130. $server->addFunction('Zend_Rest_Server_TestFunc');
  131. ob_start();
  132. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc2'));
  133. $result = ob_get_clean();
  134. $this->assertContains('<Zend_Rest_Server_TestFunc2 generator="zend" version="1.0"><response>Hello World</response><status>success</status></Zend_Rest_Server_TestFunc2>', $result, "Bad Result");
  135. ob_start();
  136. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc', 'arg1' => 'Davey'));
  137. $result = ob_get_clean();
  138. $this->assertContains('<Zend_Rest_Server_TestFunc generator="zend" version="1.0"><response>Hello Davey</response><status>success</status></Zend_Rest_Server_TestFunc>', $result, "Bad Result");
  139. }
  140. public function testHandleMethodNoArgs()
  141. {
  142. $server = new Zend_Rest_Server();
  143. $server->setClass('Zend_Rest_Server_Test');
  144. ob_start();
  145. $server->handle(array('method' => 'testFunc'));
  146. $result = ob_get_clean();
  147. $this->assertContains('<Zend_Rest_Server_Test generator="zend" version="1.0"><testFunc><response>Hello World</response><status>success</status></testFunc></Zend_Rest_Server_Test>', $result, 'Bad Result');
  148. }
  149. public function testHandleMethodOfClassWithConstructor()
  150. {
  151. $server = new Zend_Rest_Server();
  152. $server->setClass('Zend_Rest_Server_Test2', '', array('testing args'));
  153. ob_start();
  154. $server->handle(array('method' => 'test2Func1'));
  155. $result = ob_get_clean();
  156. $this->assertContains("testing args", $result, "Bad Result");
  157. }
  158. public function testHandleAnonymousArgMethod()
  159. {
  160. $server = new Zend_Rest_Server();
  161. $server->setClass('Zend_Rest_Server_Test');
  162. ob_start();
  163. $server->handle(array('method' => 'testFunc2', 'arg1' => "Davey"));
  164. $result = ob_get_clean();
  165. $this->assertContains('<Zend_Rest_Server_Test generator="zend" version="1.0"><testFunc2><response>Hello Davey</response><status>success</status></testFunc2></Zend_Rest_Server_Test>', $result, 'Bad Result');
  166. }
  167. public function testHandleNamedArgMethod()
  168. {
  169. $server = new Zend_Rest_Server();
  170. $server->setClass('Zend_Rest_Server_Test');
  171. ob_start();
  172. $server->handle(array('method' => 'testFunc3', 'who' => "Davey", 'when' => 'today'));
  173. $result = ob_get_clean();
  174. $this->assertContains('<Zend_Rest_Server_Test generator="zend" version="1.0"><testFunc3><response>Hello Davey, How are you today</response><status>success</status></testFunc3></Zend_Rest_Server_Test>', $result, 'Bad Result');
  175. }
  176. public function testHandleStaticNoArgs()
  177. {
  178. $server = new Zend_Rest_Server();
  179. $server->setClass('Zend_Rest_Server_Test');
  180. ob_start();
  181. $server->handle(array('method' => 'testFunc4'));
  182. $result = ob_get_clean();
  183. $this->assertContains('<Zend_Rest_Server_Test generator="zend" version="1.0"><testFunc4><response>Hello World</response><status>success</status></testFunc4></Zend_Rest_Server_Test>', $result, var_export($result, 1));
  184. }
  185. public function testHandleAnonymousArgStatic()
  186. {
  187. $server = new Zend_Rest_Server();
  188. $server->setClass('Zend_Rest_Server_Test');
  189. ob_start();
  190. $server->handle(array('method' => 'testFunc5', 'arg1' => "Davey"));
  191. $result = ob_get_clean();
  192. $this->assertContains('<Zend_Rest_Server_Test generator="zend" version="1.0"><testFunc5><response>Hello Davey</response><status>success</status></testFunc5></Zend_Rest_Server_Test>', $result, 'Bad Result');
  193. }
  194. public function testHandleNamedArgStatic()
  195. {
  196. $server = new Zend_Rest_Server();
  197. $server->setClass('Zend_Rest_Server_Test');
  198. ob_start();
  199. $server->handle(array('method' => 'testFunc6', 'who' => "Davey", 'when' => 'today'));
  200. $result = ob_get_clean();
  201. $this->assertContains('<Zend_Rest_Server_Test generator="zend" version="1.0"><testFunc6><response>Hello Davey, How are you today</response><status>success</status></testFunc6></Zend_Rest_Server_Test>', $result, 'Bad Result');
  202. }
  203. public function testHandleMultipleAnonymousArgs()
  204. {
  205. $server = new Zend_Rest_Server();
  206. $server->addFunction('Zend_Rest_Server_TestFunc9');
  207. ob_start();
  208. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc9', 'arg1' => "Hello", 'arg2' => "Davey"));
  209. $result = ob_get_clean();
  210. $this->assertContains('<Zend_Rest_Server_TestFunc9 generator="zend" version="1.0"><response>Hello Davey</response><status>success</status></Zend_Rest_Server_TestFunc9>', $result, "Bad Result");
  211. }
  212. public function testHandleReturnFalse()
  213. {
  214. $server = new Zend_Rest_Server();
  215. $server->addFunction('Zend_Rest_Server_TestFunc3');
  216. ob_start();
  217. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc3'));
  218. $result = ob_get_clean();
  219. $this->assertContains('<Zend_Rest_Server_TestFunc3 generator="zend" version="1.0"><response>0</response><status>success</status></Zend_Rest_Server_TestFunc3>', $result, 'Bas Response');
  220. }
  221. public function testHandleReturnTrue()
  222. {
  223. $server = new Zend_Rest_Server();
  224. $server->addFunction('Zend_Rest_Server_TestFunc4');
  225. ob_start();
  226. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc4'));
  227. $result = ob_get_clean();
  228. $this->assertContains('<Zend_Rest_Server_TestFunc4 generator="zend" version="1.0"><response>1</response><status>success</status></Zend_Rest_Server_TestFunc4>', $result, 'Bas Response');
  229. }
  230. public function testHandleReturnInteger()
  231. {
  232. $server = new Zend_Rest_Server();
  233. $server->addFunction('Zend_Rest_Server_TestFunc5');
  234. ob_start();
  235. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc5'));
  236. $result = ob_get_clean();
  237. $this->assertContains('<Zend_Rest_Server_TestFunc5 generator="zend" version="1.0"><response>123</response><status>success</status></Zend_Rest_Server_TestFunc5>', $result, 'Bas Response');
  238. }
  239. public function testHandleReturnString()
  240. {
  241. $server = new Zend_Rest_Server();
  242. $server->addFunction('Zend_Rest_Server_TestFunc6');
  243. ob_start();
  244. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc6'));
  245. $result = ob_get_clean();
  246. $this->assertContains('<Zend_Rest_Server_TestFunc6 generator="zend" version="1.0"><response>string</response><status>success</status></Zend_Rest_Server_TestFunc6>', $result, 'Bas Response');
  247. }
  248. public function testHandleReturnArray()
  249. {
  250. $server = new Zend_Rest_Server();
  251. $server->addFunction('Zend_Rest_Server_TestFunc7');
  252. ob_start();
  253. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc7'));
  254. $result = ob_get_clean();
  255. $this->assertContains('<Zend_Rest_Server_TestFunc7 generator="zend" version="1.0"><foo>bar</foo><baz>1</baz><key_1>0</key_1><bat>123</bat><status>success</status></Zend_Rest_Server_TestFunc7>', $result, $result);
  256. }
  257. public function testHandleReturnNestedArray()
  258. {
  259. $server = new Zend_Rest_Server();
  260. $server->addFunction('Zend_Rest_Server_TestFunc12');
  261. ob_start();
  262. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc12'));
  263. $result = ob_get_clean();
  264. $this->assertContains('Zend_Rest_Server_TestFunc12', $result, $result);
  265. $this->assertContains('<foo><baz>1</baz>', $result, $result);
  266. $this->assertContains('<bat>123</bat></foo><bar>baz</bar>', $result, $result);
  267. $this->assertContains('</bar><status>success</status', $result, $result);
  268. }
  269. public function testHandleMethodReturnObject()
  270. {
  271. $server = new Zend_Rest_Server();
  272. $server->setClass('Zend_Rest_Server_Test2');
  273. ob_start();
  274. $server->handle(array('method' => 'test2Struct'));
  275. $result = ob_get_clean();
  276. $this->assertContains('<Zend_Rest_Server_Test2', $result, $result);
  277. $this->assertContains('<test2Struct', $result, $result);
  278. $this->assertContains('<foo><baz>1</baz>', $result, $result);
  279. $this->assertContains('<bat>123</bat></foo><bar>baz</bar>', $result, $result);
  280. $this->assertContains('</bar><status>success</status', $result, $result);
  281. }
  282. public function testHandleReturnObject()
  283. {
  284. $server = new Zend_Rest_Server();
  285. $server->addFunction('Zend_Rest_Server_TestFunc8');
  286. ob_start();
  287. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc8'));
  288. $result = ob_get_clean();
  289. $this->assertContains('<Zend_Rest_Server_TestFunc8 generator="zend" version="1.0"><foo>bar</foo><baz>1</baz><bat>123</bat><qux>0</qux><status>success</status></Zend_Rest_Server_TestFunc8>', $result, $result);
  290. }
  291. public function testHandleReturnSimpleXml()
  292. {
  293. $server = new Zend_Rest_Server();
  294. $server->setClass('Zend_Rest_Server_Test2');
  295. ob_start();
  296. $server->handle(array('method' => 'test2Xml'));
  297. $result = ob_get_clean();
  298. $this->assertContains("<foo>bar</foo>", $result, "Bad Result");
  299. }
  300. public function testHandleReturnDomDocument()
  301. {
  302. $server = new Zend_Rest_Server();
  303. $server->setClass('Zend_Rest_Server_Test2');
  304. ob_start();
  305. $server->handle(array('method' => 'test2DomDocument'));
  306. $result = ob_get_clean();
  307. $this->assertContains("<foo>bar</foo>", $result, "Bad Result");
  308. }
  309. public function testHandleReturnDomElement()
  310. {
  311. $server = new Zend_Rest_Server();
  312. $server->setClass('Zend_Rest_Server_Test2');
  313. ob_start();
  314. $server->handle(array('method' => 'test2DomElement'));
  315. $result = ob_get_clean();
  316. $this->assertContains("<foo>bar</foo>", $result, "Bad Result");
  317. }
  318. /**
  319. * @group ZF-3751
  320. */
  321. public function testHandleInvalidMethod()
  322. {
  323. $server = new Zend_Rest_Server();
  324. $server->setClass('Zend_Rest_Server_Test2');
  325. $server->returnResponse(true);
  326. $response = $server->handle(array('method' => 'test3DomElement'));
  327. $this->assertContains('<status>failed</status>', $response);
  328. $this->assertNotContains('<message>An unknown error occured. Please try again.</message>', $response);
  329. }
  330. public function testFault()
  331. {
  332. $e = new Exception('testing fault');
  333. $server = new Zend_Rest_Server();
  334. $fault = $server->fault($e);
  335. $this->assertTrue($fault instanceof DOMDocument);
  336. $sx = simplexml_import_dom($fault);
  337. $this->assertTrue(isset($sx->response));
  338. $this->assertTrue(isset($sx->response->message));
  339. $this->assertContains('testing fault', (string) $sx->response->message);
  340. }
  341. public function testFaultWithoutException()
  342. {
  343. $server = new Zend_Rest_Server();
  344. $fault = $server->fault('testing fault');
  345. $this->assertTrue($fault instanceof DOMDocument);
  346. $sx = simplexml_import_dom($fault);
  347. $this->assertTrue(isset($sx->response));
  348. $this->assertTrue(isset($sx->response->message));
  349. $this->assertContains('An unknown error occured. Please try again.', (string) $sx->response->message);
  350. }
  351. public function testHandleException()
  352. {
  353. $server = new Zend_Rest_Server();
  354. $server->addFunction('Zend_Rest_Server_TestFunc11');
  355. ob_start();
  356. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc11'));
  357. $result = ob_get_clean();
  358. $this->assertContains("<Zend_Rest_Server_TestFunc11", $result);
  359. $this->assertContains("<message>testing rest server faults</message>", $result);
  360. }
  361. public function testHandleClassMethodException()
  362. {
  363. $server = new Zend_Rest_Server();
  364. $server->setClass('Zend_Rest_Server_Test2');
  365. ob_start();
  366. $server->handle(array('method' => 'test2ThrowException'));
  367. $result = ob_get_clean();
  368. $this->assertContains("<Zend_Rest_Server_Test2", $result);
  369. $this->assertContains("<test2ThrowException>", $result);
  370. $this->assertContains("<message>testing class method exception</message>", $result);
  371. }
  372. public function testHandleVoid()
  373. {
  374. $server = new Zend_Rest_Server();
  375. $server->addFunction('Zend_Rest_Server_TestFunc10');
  376. ob_start();
  377. $server->handle(array('method' => 'Zend_Rest_Server_TestFunc10'));
  378. $result = ob_get_clean();
  379. $this->assertContains('<Zend_Rest_Server_TestFunc10 generator="zend" version="1.0"><response/><status>success</status></Zend_Rest_Server_TestFunc10>', $result, $result);
  380. }
  381. public function testGetHeaders()
  382. {
  383. $server = new Zend_Rest_Server();
  384. $server->setClass('Zend_Rest_Server_Test2');
  385. ob_start();
  386. $server->handle(array('method' => 'test2ThrowException'));
  387. $result = ob_get_clean();
  388. $headers = $server->getHeaders();
  389. $this->assertContains('HTTP/1.0 400 Bad Request', $headers);
  390. }
  391. public function testReturnResponse()
  392. {
  393. $server = new Zend_Rest_Server();
  394. $this->assertFalse($server->returnResponse());
  395. $server->returnResponse(true);
  396. $this->assertTrue($server->returnResponse());
  397. }
  398. public function testReturnResponseForcesHandleToReturnResponse()
  399. {
  400. $server = new Zend_Rest_Server();
  401. $server->returnResponse(true);
  402. $server->setClass('Zend_Rest_Server_Test2');
  403. ob_start();
  404. $response = $server->handle(array('method' => 'test2Xml'));
  405. $result = ob_get_clean();
  406. $this->assertTrue(empty($result));
  407. $this->assertContains('<foo>bar</foo>', $response);
  408. }
  409. public function testGeneratedXmlEncodesScalarAmpersands()
  410. {
  411. $server = new Zend_Rest_Server();
  412. $server->returnResponse(true);
  413. $server->setClass('Zend_Rest_Server_Test');
  414. ob_start();
  415. $response = $server->handle(array('method' => 'testScalarEncoding'));
  416. $result = ob_get_clean();
  417. $this->assertTrue(empty($result));
  418. $this->assertContains('This string has chars &amp; ampersands', $response);
  419. }
  420. public function testGeneratedXmlEncodesStructAmpersands()
  421. {
  422. $server = new Zend_Rest_Server();
  423. $server->returnResponse(true);
  424. $server->setClass('Zend_Rest_Server_Test');
  425. ob_start();
  426. $response = $server->handle(array('method' => 'testStructEncoding'));
  427. $result = ob_get_clean();
  428. $this->assertTrue(empty($result));
  429. $this->assertContains('bar &amp; baz', $response);
  430. }
  431. public function testGeneratedXmlEncodesFaultAmpersands()
  432. {
  433. $server = new Zend_Rest_Server();
  434. $server->returnResponse(true);
  435. $server->setClass('Zend_Rest_Server_Test');
  436. ob_start();
  437. $response = $server->handle(array('method' => 'testExceptionsEncoding'));
  438. $result = ob_get_clean();
  439. $this->assertTrue(empty($result));
  440. $this->assertContains('testing class method exception &amp; encoding', $response);
  441. }
  442. /**
  443. * @see ZF-1992
  444. * @group ZF-1992
  445. */
  446. public function testDefaultEncodingShouldBeUtf8()
  447. {
  448. $server = new Zend_Rest_Server();
  449. $this->assertEquals('UTF-8', $server->getEncoding());
  450. }
  451. /**
  452. * @see ZF-1992
  453. * @group ZF-1992
  454. */
  455. public function testEncodingShouldBeMutableViaAccessors()
  456. {
  457. $server = new Zend_Rest_Server();
  458. $this->assertEquals('UTF-8', $server->getEncoding());
  459. $server->setEncoding('ISO-8859-1');
  460. $this->assertEquals('ISO-8859-1', $server->getEncoding());
  461. }
  462. /**
  463. * @see ZF-2279
  464. * @group ZF-2279
  465. */
  466. public function testNamesOfArgumentsShouldDetermineArgumentOrder()
  467. {
  468. $server = new Zend_Rest_Server();
  469. $server->setClass('Zend_Rest_Server_Test');
  470. ob_start();
  471. $server->handle(array('method' => 'testFunc6', 'arg2' => 'today', 'arg1' => "Davey"));
  472. $result = ob_get_clean();
  473. $this->assertContains('<Zend_Rest_Server_Test generator="zend" version="1.0"><testFunc6><response>Hello Davey, How are you today</response><status>success</status></testFunc6></Zend_Rest_Server_Test>', $result, var_export($result, 1));
  474. }
  475. /**
  476. * @see ZF-1949
  477. * @group ZF-1949
  478. */
  479. public function testMissingArgumentsShouldResultInFaultResponse()
  480. {
  481. $server = new Zend_Rest_Server();
  482. $server->setClass('Zend_Rest_Server_Test');
  483. ob_start();
  484. $server->handle(array('method' => 'testFunc6', 'arg1' => "Davey"));
  485. $result = ob_get_clean();
  486. $this->assertRegexp('#<message>Invalid Method Call to(.*?)(Requires).*?(given).*?(</message>)#', $result);
  487. $this->assertContains('<status>failed</status>', $result);
  488. }
  489. /**
  490. * @see ZF-1949
  491. * @group ZF-1949
  492. */
  493. public function testMissingArgumentsWithDefaultsShouldNotResultInFaultResponse()
  494. {
  495. $server = new Zend_Rest_Server();
  496. $server->setClass('Zend_Rest_Server_Test');
  497. ob_start();
  498. $server->handle(array('method' => 'testFunc7', 'arg1' => "Davey"));
  499. $result = ob_get_clean();
  500. $this->assertContains('<status>success</status>', $result, var_export($result, 1));
  501. $this->assertContains('<response>Hello today, How are you Davey</response>', $result, var_export($result, 1));
  502. }
  503. /**
  504. * @group ZF-3751
  505. */
  506. public function testCallingUnknownMethodDoesNotThrowUnknownButSpecificErrorExceptionMessage()
  507. {
  508. $server = new Zend_Rest_Server();
  509. $server->setClass('Zend_Rest_Server_Test2');
  510. $server->returnResponse(true);
  511. $response = $server->handle(array('method' => 'testCallingInvalidMethod'));
  512. $this->assertContains('<status>failed</status>', $response);
  513. $this->assertNotContains('<message>An unknown error occured. Please try again.</message>', $response);
  514. }
  515. /**
  516. * @group ZF-3751
  517. */
  518. public function testCallingNoMethodDoesNotThrowUnknownButSpecificErrorExceptionMessage()
  519. {
  520. $server = new Zend_Rest_Server();
  521. $server->setClass('Zend_Rest_Server_Test2');
  522. $server->returnResponse(true);
  523. $response = $server->handle();
  524. $this->assertContains('<status>failed</status>', $response);
  525. $this->assertNotContains('<message>An unknown error occured. Please try again.</message>', $response);
  526. }
  527. }
  528. /* Test Functions */
  529. /**
  530. * Test Function
  531. *
  532. * @param string $arg
  533. * @return string
  534. */
  535. function Zend_Rest_Server_TestFunc($who)
  536. {
  537. return "Hello $who";
  538. }
  539. /**
  540. * Test Function 2
  541. */
  542. function Zend_Rest_Server_TestFunc2()
  543. {
  544. return "Hello World";
  545. }
  546. /**
  547. * Return false
  548. *
  549. * @return bool
  550. */
  551. function Zend_Rest_Server_TestFunc3()
  552. {
  553. return false;
  554. }
  555. /**
  556. * Return true
  557. *
  558. * @return bool
  559. */
  560. function Zend_Rest_Server_TestFunc4()
  561. {
  562. return true;
  563. }
  564. /**
  565. * Return integer
  566. *
  567. * @return int
  568. */
  569. function Zend_Rest_Server_TestFunc5()
  570. {
  571. return 123;
  572. }
  573. /**
  574. * Return string
  575. *
  576. * @return string
  577. */
  578. function Zend_Rest_Server_TestFunc6()
  579. {
  580. return "string";
  581. }
  582. /**
  583. * Return array
  584. *
  585. * @return array
  586. */
  587. function Zend_Rest_Server_TestFunc7()
  588. {
  589. return array('foo' => 'bar', 'baz' => true, 1 => false, 'bat' => 123);
  590. }
  591. /**
  592. * Return Object
  593. *
  594. * @return StdClass
  595. */
  596. function Zend_Rest_Server_TestFunc8()
  597. {
  598. $return = (object) array('foo' => 'bar', 'baz' => true, 'bat' => 123, 'qux' => false);
  599. return $return;
  600. }
  601. /**
  602. * Multiple Args
  603. *
  604. * @param string $foo
  605. * @param string $bar
  606. * @return string
  607. */
  608. function Zend_Rest_Server_TestFunc9($foo, $bar)
  609. {
  610. return "$foo $bar";
  611. }
  612. /**
  613. * Void arguments
  614. *
  615. * @return void
  616. */
  617. function Zend_Rest_Server_TestFunc10()
  618. {
  619. // returns nothing
  620. }
  621. /**
  622. * throws exception
  623. *
  624. * @return void
  625. * @throws Exception
  626. */
  627. function Zend_Rest_Server_TestFunc11()
  628. {
  629. throw new Exception('testing rest server faults');
  630. }
  631. /**
  632. * Return nested array
  633. *
  634. * @return struct
  635. */
  636. function Zend_Rest_Server_TestFunc12()
  637. {
  638. return array('foo' => array('baz' => true, 1 => false, 'bat' => 123), 'bar' => 'baz');
  639. }
  640. /**
  641. * Test Class
  642. */
  643. class Zend_Rest_Server_Test
  644. {
  645. /**
  646. * Test Function
  647. */
  648. public function testFunc()
  649. {
  650. return "Hello World";
  651. }
  652. /**
  653. * Test Function 2
  654. *
  655. * @param string $who Some Arg
  656. */
  657. public function testFunc2($who)
  658. {
  659. return "Hello $who";
  660. }
  661. /**
  662. * Test Function 3
  663. *
  664. * @param string $who Some Arg
  665. * @param int $when Some Arg2
  666. */
  667. public function testFunc3($who, $when)
  668. {
  669. return "Hello $who, How are you $when";
  670. }
  671. /**
  672. * Test Function 4
  673. */
  674. public static function testFunc4()
  675. {
  676. return "Hello World";
  677. }
  678. /**
  679. * Test Function 5
  680. *
  681. * @param string $who Some Arg
  682. */
  683. public static function testFunc5($who)
  684. {
  685. return "Hello $who";
  686. }
  687. /**
  688. * Test Function 6
  689. *
  690. * @param string $who Some Arg
  691. * @param int $when Some Arg2
  692. */
  693. public static function testFunc6($who, $when)
  694. {
  695. return "Hello $who, How are you $when";
  696. }
  697. /**
  698. * Test Function 7
  699. *
  700. * @param string $who Some Arg
  701. * @param int $when Some Arg2
  702. */
  703. public static function testFunc7($who, $when = 'today')
  704. {
  705. return "Hello $who, How are you $when";
  706. }
  707. /**
  708. * Test scalar encoding
  709. *
  710. * @return string
  711. */
  712. public function testScalarEncoding()
  713. {
  714. return 'This string has chars & ampersands';
  715. }
  716. /**
  717. * Test structs encode correctly
  718. *
  719. * @return struct
  720. */
  721. public function testStructEncoding()
  722. {
  723. return array(
  724. 'foo' => 'bar & baz'
  725. );
  726. }
  727. /**
  728. * Test exceptions encode correctly
  729. *
  730. * @return void
  731. */
  732. public function testExceptionsEncoding()
  733. {
  734. throw new Exception('testing class method exception & encoding');
  735. }
  736. }
  737. class Zend_Rest_Server_Test2
  738. {
  739. public function __construct($arg1 = 'unset')
  740. {
  741. $this->arg1 = $arg1;
  742. }
  743. public function test2Func1()
  744. {
  745. return $this->arg1;
  746. }
  747. public function test2Xml()
  748. {
  749. $sx = new SimpleXMLElement('<root><foo>bar</foo></root>');
  750. return $sx;
  751. }
  752. public function test2DomDocument()
  753. {
  754. $dom = new DOMDocument('1.0', 'UTF-8');
  755. $root = $dom->createElement('root');
  756. $dom->appendChild($root);
  757. $foo = $dom->createElement('foo', 'bar');
  758. $root->appendChild($foo);
  759. return $dom;
  760. }
  761. public function test2DomElement()
  762. {
  763. $dom = new DOMDocument('1.0', 'UTF-8');
  764. $root = $dom->createElement('root');
  765. $dom->appendChild($root);
  766. $foo = $dom->createElement('foo', 'bar');
  767. $root->appendChild($foo);
  768. return $foo;
  769. }
  770. public function test2ThrowException()
  771. {
  772. throw new Exception('testing class method exception');
  773. }
  774. public function test2Struct()
  775. {
  776. $o = new stdClass();
  777. $o->foo = array('baz' => true, 1 => false, 'bat' => 123);
  778. $o->bar = 'baz';
  779. return $o;
  780. }
  781. }
  782. class Zend_Rest_TestException extends Exception { }
  783. // Call Zend_Rest_ServerTest::main() if this source file is executed directly.
  784. if (PHPUnit_MAIN_METHOD == "Zend_Rest_ServerTest::main") {
  785. Zend_Rest_ServerTest::main();
  786. }