ActionTest.php 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526
  1. <?php
  2. // Call Zend_Controller_ActionTest::main() if this source file is executed directly.
  3. if (!defined("PHPUnit_MAIN_METHOD")) {
  4. require_once dirname(__FILE__) . '/../../TestHelper.php';
  5. define("PHPUnit_MAIN_METHOD", "Zend_Controller_ActionTest::main");
  6. }
  7. require_once "PHPUnit/Framework/TestCase.php";
  8. require_once "PHPUnit/Framework/TestSuite.php";
  9. require_once 'Zend/Controller/Action.php';
  10. require_once 'Zend/Controller/Action/Helper/Redirector.php';
  11. require_once 'Zend/Controller/Action/Helper/ViewRenderer.php';
  12. require_once 'Zend/Controller/Request/Http.php';
  13. require_once 'Zend/Controller/Response/Cli.php';
  14. class Zend_Controller_ActionTest extends PHPUnit_Framework_TestCase
  15. {
  16. /**
  17. * Runs the test methods of this class.
  18. *
  19. * @access public
  20. * @static
  21. */
  22. public static function main()
  23. {
  24. require_once "PHPUnit/TextUI/TestRunner.php";
  25. $suite = new PHPUnit_Framework_TestSuite("Zend_Controller_ActionTest");
  26. $result = PHPUnit_TextUI_TestRunner::run($suite);
  27. }
  28. public function setUp()
  29. {
  30. $this->_controller = new Zend_Controller_ActionTest_TestController(
  31. new Zend_Controller_Request_Http(),
  32. new Zend_Controller_Response_Cli(),
  33. array(
  34. 'foo' => 'bar',
  35. 'bar' => 'baz'
  36. )
  37. );
  38. Zend_Controller_Front::getInstance()->resetInstance();
  39. Zend_Controller_Action_HelperBroker::resetHelpers();
  40. $redirector = $this->_controller->getHelper('redirector');
  41. $redirector->setExit(false);
  42. }
  43. public function tearDown()
  44. {
  45. unset($this->_controller);
  46. }
  47. public function testInit()
  48. {
  49. $this->assertEquals('bar', $this->_controller->initArgs['foo']);
  50. $this->assertEquals('baz', $this->_controller->initArgs['bar']);
  51. }
  52. public function testPreRun()
  53. {
  54. $this->_controller->preDispatch();
  55. $this->assertNotContains('Prerun ran', $this->_controller->getResponse()->getBody());
  56. $this->_controller->getRequest()->setParam('prerun', true);
  57. $this->_controller->preDispatch();
  58. $this->assertContains('Prerun ran', $this->_controller->getResponse()->getBody());
  59. }
  60. public function testPostRun()
  61. {
  62. $this->_controller->postDispatch();
  63. $this->assertNotContains('Postrun ran', $this->_controller->getResponse()->getBody());
  64. $this->_controller->getRequest()->setParam('postrun', true);
  65. $this->_controller->postDispatch();
  66. $this->assertContains('Postrun ran', $this->_controller->getResponse()->getBody());
  67. }
  68. public function testGetRequest()
  69. {
  70. $this->assertTrue($this->_controller->getRequest() instanceof Zend_Controller_Request_Abstract);
  71. }
  72. public function testGetResponse()
  73. {
  74. $this->assertTrue($this->_controller->getResponse() instanceof Zend_Controller_Response_Abstract);
  75. }
  76. public function testGetInvokeArgs()
  77. {
  78. $expected = array('foo' => 'bar', 'bar' => 'baz');
  79. $this->assertSame($expected, $this->_controller->getInvokeArgs());
  80. }
  81. public function testGetInvokeArg()
  82. {
  83. $this->assertSame('bar', $this->_controller->getInvokeArg('foo'));
  84. $this->assertSame('baz', $this->_controller->getInvokeArg('bar'));
  85. }
  86. public function testForwardActionOnly()
  87. {
  88. $this->_controller->forward('forwarded');
  89. $this->assertEquals('forwarded', $this->_controller->getRequest()->getActionName());
  90. $this->assertFalse($this->_controller->getRequest()->isDispatched());
  91. }
  92. public function testForwardActionKeepsController()
  93. {
  94. $request = $this->_controller->getRequest();
  95. $request->setControllerName('foo')
  96. ->setActionName('bar');
  97. $this->_controller->forward('forwarded');
  98. $this->assertEquals('forwarded', $request->getActionName());
  99. $this->assertEquals('foo', $request->getControllerName());
  100. $this->assertFalse($request->isDispatched());
  101. }
  102. public function testForwardActionAndController()
  103. {
  104. $request = $this->_controller->getRequest();
  105. $request->setControllerName('foo')
  106. ->setActionName('bar');
  107. $this->_controller->forward('forwarded', 'bar');
  108. $this->assertEquals('forwarded', $request->getActionName());
  109. $this->assertEquals('bar', $request->getControllerName());
  110. $this->assertFalse($request->isDispatched());
  111. }
  112. public function testForwardActionControllerAndModule()
  113. {
  114. $request = $this->_controller->getRequest();
  115. $request->setControllerName('foo')
  116. ->setActionName('bar')
  117. ->setModuleName('admin');
  118. $this->_controller->forward('forwarded', 'bar');
  119. $this->assertEquals('forwarded', $request->getActionName());
  120. $this->assertEquals('bar', $request->getControllerName());
  121. $this->assertEquals('admin', $request->getModuleName());
  122. $this->assertFalse($request->isDispatched());
  123. }
  124. public function testForwardCanSetParams()
  125. {
  126. $request = $this->_controller->getRequest();
  127. $request->setParams(array('admin' => 'batman'));
  128. $this->_controller->forward('forwarded', null, null, array('foo' => 'bar'));
  129. $this->assertEquals('forwarded', $request->getActionName());
  130. $received = $request->getParams();
  131. $this->assertTrue(isset($received['foo']));
  132. $this->assertEquals('bar', $received['foo']);
  133. $this->assertFalse($request->isDispatched());
  134. }
  135. public function testRun()
  136. {
  137. $response = $this->_controller->run();
  138. $body = $response->getBody();
  139. $this->assertContains('In the index action', $body, var_export($this->_controller->getRequest(), 1));
  140. $this->assertNotContains('Prerun ran', $body, $body);
  141. }
  142. public function testRun2()
  143. {
  144. $this->_controller->getRequest()->setActionName('bar');
  145. try {
  146. $response = $this->_controller->run();
  147. $this->fail('Should not be able to call bar as action');
  148. } catch (Exception $e) {
  149. //success!
  150. }
  151. }
  152. public function testRun3()
  153. {
  154. $this->_controller->getRequest()->setActionName('foo');
  155. $response = $this->_controller->run();
  156. $this->assertContains('In the foo action', $response->getBody());
  157. $this->assertNotContains('Prerun ran', $this->_controller->getResponse()->getBody());
  158. }
  159. public function testHasParam()
  160. {
  161. $request = $this->_controller->getRequest();
  162. $request->setParam('foo', 'bar');
  163. $request->setParam('baz', 'bal');
  164. $this->assertTrue($this->_controller->hasParam('foo'));
  165. $this->assertTrue($this->_controller->hasParam('baz'));
  166. }
  167. public function testSetParam()
  168. {
  169. $this->_controller->setParam('foo', 'bar');
  170. $params = $this->_controller->getParams();
  171. $this->assertTrue(isset($params['foo']));
  172. $this->assertEquals('bar', $params['foo']);
  173. }
  174. public function testGetParams()
  175. {
  176. $this->_controller->setParam('foo', 'bar');
  177. $this->_controller->setParam('bar', 'baz');
  178. $this->_controller->setParam('boo', 'bah');
  179. $params = $this->_controller->getParams();
  180. $this->assertEquals('bar', $params['foo']);
  181. $this->assertEquals('baz', $params['bar']);
  182. $this->assertEquals('bah', $params['boo']);
  183. }
  184. public function testRedirect()
  185. {
  186. $response = $this->_controller->getResponse();
  187. $response->headersSentThrowsException = false;
  188. $this->_controller->redirect('/baz/foo');
  189. $this->_controller->redirect('/foo/bar');
  190. $headers = $response->getHeaders();
  191. $found = 0;
  192. $url = '';
  193. foreach ($headers as $header) {
  194. if ('Location' == $header['name']) {
  195. ++$found;
  196. $url = $header['value'];
  197. break;
  198. }
  199. }
  200. $this->assertEquals(1, $found);
  201. $this->assertContains('/foo/bar', $url);
  202. }
  203. public function testInitView()
  204. {
  205. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  206. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  207. $controller = new ViewController(
  208. new Zend_Controller_Request_Http(),
  209. new Zend_Controller_Response_Cli()
  210. );
  211. $view = $controller->initView();
  212. $this->assertTrue($view instanceof Zend_View);
  213. $scriptPath = $view->getScriptPaths();
  214. $this->assertTrue(is_array($scriptPath));
  215. $this->assertEquals(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'views' . DIRECTORY_SEPARATOR . 'scripts' . DIRECTORY_SEPARATOR, $scriptPath[0]);
  216. }
  217. public function testRender()
  218. {
  219. $request = new Zend_Controller_Request_Http();
  220. $request->setControllerName('view')
  221. ->setActionName('index');
  222. $response = new Zend_Controller_Response_Cli();
  223. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  224. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  225. $controller = new ViewController($request, $response);
  226. $controller->indexAction();
  227. $this->assertContains('In the index action view', $response->getBody());
  228. }
  229. public function testRenderByName()
  230. {
  231. $request = new Zend_Controller_Request_Http();
  232. $request->setControllerName('view')
  233. ->setActionName('test');
  234. $response = new Zend_Controller_Response_Cli();
  235. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  236. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  237. $controller = new ViewController($request, $response);
  238. $controller->testAction();
  239. $this->assertContains('In the index action view', $response->getBody());
  240. }
  241. public function testRenderOutsideControllerSubdir()
  242. {
  243. $request = new Zend_Controller_Request_Http();
  244. $request->setControllerName('view')
  245. ->setActionName('site');
  246. $response = new Zend_Controller_Response_Cli();
  247. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  248. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  249. $controller = new ViewController($request, $response);
  250. $controller->siteAction();
  251. $this->assertContains('In the sitewide view', $response->getBody());
  252. }
  253. public function testRenderNamedSegment()
  254. {
  255. $request = new Zend_Controller_Request_Http();
  256. $request->setControllerName('view')
  257. ->setActionName('name');
  258. $response = new Zend_Controller_Response_Cli();
  259. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  260. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  261. $controller = new ViewController($request, $response);
  262. $controller->nameAction();
  263. $this->assertContains('In the name view', $response->getBody('name'));
  264. }
  265. public function testRenderNormalizesScriptName()
  266. {
  267. $request = new Zend_Controller_Request_Http();
  268. $request->setControllerName('foo.bar')
  269. ->setActionName('baz_bat');
  270. $response = new Zend_Controller_Response_Cli();
  271. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  272. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'FooBarController.php';
  273. $controller = new FooBarController($request, $response);
  274. $controller->bazBatAction();
  275. $this->assertContains('Inside foo-bar/baz-bat.phtml', $response->getBody());
  276. }
  277. public function testGetViewScript()
  278. {
  279. $request = new Zend_Controller_Request_Http();
  280. $request->setControllerName('view')
  281. ->setActionName('test');
  282. $response = new Zend_Controller_Response_Cli();
  283. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  284. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  285. $controller = new ViewController($request, $response);
  286. $script = $controller->getViewScript();
  287. $this->assertContains('view' . DIRECTORY_SEPARATOR . 'test.phtml', $script);
  288. $script = $controller->getViewScript('foo');
  289. $this->assertContains('view' . DIRECTORY_SEPARATOR . 'foo.phtml', $script);
  290. }
  291. public function testGetViewScriptDoesNotOverwriteNoControllerFlagWhenNullPassed()
  292. {
  293. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  294. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  295. $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  296. $request = new Zend_Controller_Request_Http();
  297. $request->setControllerName('view')
  298. ->setActionName('test');
  299. $response = new Zend_Controller_Response_Cli();
  300. $controller = new ViewController($request, $response);
  301. $this->assertSame($viewRenderer->getActionController(), $controller);
  302. $viewRenderer->setNoController(true);
  303. $this->assertTrue($viewRenderer->getNoController());
  304. $script = $controller->getViewScript();
  305. $this->assertTrue($viewRenderer->getNoController());
  306. }
  307. public function testRenderScript()
  308. {
  309. $request = new Zend_Controller_Request_Http();
  310. $request->setControllerName('view')
  311. ->setActionName('script');
  312. $response = new Zend_Controller_Response_Cli();
  313. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  314. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  315. $controller = new ViewController($request, $response);
  316. $controller->scriptAction();
  317. $this->assertContains('Inside custom/renderScript.php', $response->getBody());
  318. }
  319. public function testRenderScriptToNamedResponseSegment()
  320. {
  321. $request = new Zend_Controller_Request_Http();
  322. $request->setControllerName('view')
  323. ->setActionName('script-name');
  324. $response = new Zend_Controller_Response_Cli();
  325. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  326. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  327. $controller = new ViewController($request, $response);
  328. $controller->scriptNameAction();
  329. $this->assertContains('Inside custom/renderScript.php', $response->getBody('foo'));
  330. }
  331. public function testGetHelper()
  332. {
  333. $redirector = $this->_controller->getHelper('redirector');
  334. $this->assertTrue($redirector instanceof Zend_Controller_Action_Helper_Abstract);
  335. $this->assertTrue($redirector instanceof Zend_Controller_Action_Helper_Redirector);
  336. }
  337. public function testGetHelperCopy()
  338. {
  339. $redirector = $this->_controller->getHelper('redirector');
  340. $copy = $this->_controller->getHelperCopy('redirector');
  341. $this->assertNotSame($redirector, $copy);
  342. $this->assertTrue($copy instanceof Zend_Controller_Action_Helper_Redirector);
  343. }
  344. public function testViewInjectionUsingViewRenderer()
  345. {
  346. Zend_Controller_Action_HelperBroker::addHelper(new Zend_Controller_Action_Helper_ViewRenderer());
  347. $request = new Zend_Controller_Request_Http();
  348. $request->setControllerName('view')
  349. ->setActionName('script');
  350. $response = new Zend_Controller_Response_Cli();
  351. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  352. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  353. $controller = new ViewController($request, $response);
  354. $this->assertNotNull($controller->view);
  355. }
  356. public function testRenderUsingViewRenderer()
  357. {
  358. Zend_Controller_Action_HelperBroker::addHelper(new Zend_Controller_Action_Helper_ViewRenderer());
  359. $request = new Zend_Controller_Request_Http();
  360. $request->setControllerName('view')
  361. ->setActionName('script');
  362. $response = new Zend_Controller_Response_Cli();
  363. Zend_Controller_Front::getInstance()->setControllerDirectory(dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files');
  364. require_once dirname(__FILE__) . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'ViewController.php';
  365. $controller = new ViewController($request, $response);
  366. $controller->scriptAction();
  367. $this->assertContains('Inside custom/renderScript.php', $response->getBody());
  368. }
  369. public function testMissingActionExceptionsDifferFromMissingMethods()
  370. {
  371. try {
  372. $this->_controller->bogusAction();
  373. $this->fail('Invalid action should throw exception');
  374. } catch (Zend_Controller_Exception $e) {
  375. $this->assertRegexp('/^Action.*?(does not exist and was not trapped in __call\(\))$/', $e->getMessage());
  376. $this->assertContains('bogus', $e->getMessage());
  377. $this->assertNotContains('bogusAction', $e->getMessage());
  378. $this->assertEquals(404, $e->getCode());
  379. }
  380. try {
  381. $this->_controller->bogus();
  382. $this->fail('Invalid method should throw exception');
  383. } catch (Zend_Controller_Exception $e) {
  384. $this->assertRegexp('/^Method.*?(does not exist and was not trapped in __call\(\))$/', $e->getMessage());
  385. $this->assertContains('bogus', $e->getMessage());
  386. $this->assertEquals(500, $e->getCode());
  387. }
  388. }
  389. }
  390. class Zend_Controller_ActionTest_TestController extends Zend_Controller_Action
  391. {
  392. public $initArgs = array();
  393. public function init()
  394. {
  395. $this->initArgs['foo'] = $this->getInvokeArg('foo');
  396. $this->initArgs['bar'] = $this->getInvokeArg('bar');
  397. }
  398. public function preDispatch()
  399. {
  400. if (false !== ($param = $this->_getParam('prerun', false))) {
  401. $this->getResponse()->appendBody("Prerun ran\n");
  402. }
  403. }
  404. public function postDispatch()
  405. {
  406. if (false !== ($param = $this->_getParam('postrun', false))) {
  407. $this->getResponse()->appendBody("Postrun ran\n");
  408. }
  409. }
  410. public function noRouteAction()
  411. {
  412. return $this->indexAction();
  413. }
  414. public function indexAction()
  415. {
  416. $this->getResponse()->appendBody("In the index action\n");
  417. }
  418. public function fooAction()
  419. {
  420. $this->getResponse()->appendBody("In the foo action\n");
  421. }
  422. public function bar()
  423. {
  424. $this->getResponse()->setBody("Should never see this\n");
  425. }
  426. public function forward($action, $controller = null, $module = null, array $params = null)
  427. {
  428. $this->_forward($action, $controller, $module, $params);
  429. }
  430. public function hasParam($param)
  431. {
  432. return $this->_hasParam($param);
  433. }
  434. public function getParams()
  435. {
  436. return $this->_getAllParams();
  437. }
  438. public function setParam($key, $value)
  439. {
  440. $this->_setParam($key, $value);
  441. return $this;
  442. }
  443. public function redirect($url, $code = 302, $prependBase = true)
  444. {
  445. $this->_redirect($url, array('code' => $code, 'prependBase' => $prependBase));
  446. }
  447. }
  448. // Call Zend_Controller_ActionTest::main() if this source file is executed directly.
  449. if (PHPUnit_MAIN_METHOD == "Zend_Controller_ActionTest::main") {
  450. Zend_Controller_ActionTest::main();
  451. }