cakephp/tests/TestCase/Routing/RequestActionTraitTest.php

<?php
/**
 * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
 * @link          http://cakephp.org CakePHP(tm) Project
 * @since         3.0.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Routing;

use Cake\Core\App;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Routing\DispatcherFactory;
use Cake\Routing\RequestActionTrait;
use Cake\Routing\Router;
use Cake\TestSuite\TestCase;
use Cake\Utility\Security;

/**
 */
class RequestActionTraitTest extends TestCase {

/**
 * fixtures
 *
 * @var string
 */
	public $fixtures = array('core.posts', 'core.test_plugin_comments', 'core.comments');

/**
 * Setup
 *
 * @return void
 */
	public function setUp() {
		parent::setUp();
		Configure::write('App.namespace', 'TestApp');
		Security::salt('not-the-default');
		DispatcherFactory::add('Routing');
		DispatcherFactory::add('ControllerFactory');
		$this->object = $this->getObjectForTrait('Cake\Routing\RequestActionTrait');
		Router::connect('/request_action/:action/*', ['controller' => 'RequestAction']);
		Router::connect('/tests_apps/:action/*', ['controller' => 'TestsApps']);
	}

/**
 * teardown
 *
 * @return void
 */
	public function tearDown() {
		parent::tearDown();
		DispatcherFactory::clear();
		Router::reload();
	}

/**
 * testRequestAction method
 *
 * @return void
 */
	public function testRequestAction() {
		$this->assertNull(Router::getRequest(), 'request stack should be empty.');

		$result = $this->object->requestAction('');
		$this->assertFalse($result);

		$result = $this->object->requestAction('/request_action/test_request_action');
		$expected = 'This is a test';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(Configure::read('App.fullBaseUrl') . '/request_action/test_request_action');
		$expected = 'This is a test';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction('/request_action/another_ra_test/2/5');
		$expected = 7;
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction('/tests_apps/index', array('return'));
		$expected = 'This is the TestsAppsController index view ';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction('/tests_apps/some_method');
		$expected = 5;
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction('/request_action/paginate_request_action');
		$this->assertNull($result);

		$result = $this->object->requestAction('/request_action/normal_request_action');
		$expected = 'Hello World';
		$this->assertEquals($expected, $result);

		$this->assertNull(Router::getRequest(), 'requests were not popped off the stack, this will break url generation');
	}

/**
 * test requestAction() and plugins.
 *
 * @return void
 */
	public function testRequestActionPlugins() {
		Plugin::load('TestPlugin');
		Router::reload();
		Router::connect('/test_plugin/tests/:action/*', ['controller' => 'Tests', 'plugin' => 'TestPlugin']);

		$result = $this->object->requestAction('/test_plugin/tests/index', array('return'));
		$expected = 'test plugin index';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction('/test_plugin/tests/index/some_param', array('return'));
		$expected = 'test plugin index';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(
			array('controller' => 'Tests', 'action' => 'index', 'plugin' => 'TestPlugin'), array('return')
		);
		$expected = 'test plugin index';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction('/test_plugin/tests/some_method');
		$expected = 25;
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(
			array('controller' => 'Tests', 'action' => 'some_method', 'plugin' => 'TestPlugin')
		);
		$expected = 25;
		$this->assertEquals($expected, $result);
	}

/**
 * test requestAction() with arrays.
 *
 * @return void
 */
	public function testRequestActionArray() {
		Plugin::load(array('TestPlugin'));

		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'test_request_action')
		);
		$expected = 'This is a test';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'another_ra_test'),
			array('pass' => array('5', '7'))
		);
		$expected = 12;
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(
			array('controller' => 'TestsApps', 'action' => 'index'), array('return')
		);
		$expected = 'This is the TestsAppsController index view ';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(array('controller' => 'TestsApps', 'action' => 'some_method'));
		$expected = 5;
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'normal_request_action')
		);
		$expected = 'Hello World';
		$this->assertEquals($expected, $result);

		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'paginate_request_action')
		);
		$this->assertNull($result);

		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'paginate_request_action'),
			array('pass' => array(5))
		);
		$this->assertNull($result);
	}

/**
 * Test that requestAction() does not forward the 0 => return value.
 *
 * @return void
 */
	public function testRequestActionRemoveReturnParam() {
		$result = $this->object->requestAction(
			'/request_action/param_check', array('return')
		);
		$this->assertEquals('', $result, 'Return key was found');
	}

/**
 * Test that requestAction() is populating $this->params properly
 *
 * @return void
 */
	public function testRequestActionParamParseAndPass() {
		$result = $this->object->requestAction('/request_action/params_pass');
		$result = json_decode($result, true);
		$this->assertEquals('request_action/params_pass', $result['url']);
		$this->assertEquals('RequestAction', $result['params']['controller']);
		$this->assertEquals('params_pass', $result['params']['action']);
		$this->assertNull($result['params']['plugin']);
	}

/**
 * test that requestAction does not fish data out of the POST
 * superglobal.
 *
 * @return void
 */
	public function testRequestActionNoPostPassing() {
		$_POST = array(
			'item' => 'value'
		);
		$result = $this->object->requestAction(array('controller' => 'RequestAction', 'action' => 'post_pass'));
		$result = json_decode($result, true);
		$this->assertEmpty($result);

		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'post_pass'),
			array('post' => $_POST)
		);
		$result = json_decode($result, true);
		$this->assertEquals($_POST, $result);
	}

/**
 * test that requestAction() can get query data from the query string and
 * query option.
 *
 * @return void
 */
	public function testRequestActionWithQueryString() {
		$query = ['page' => 1, 'sort' => 'title'];
		$result = $this->object->requestAction(
			['controller' => 'RequestAction', 'action' => 'query_pass'],
			['query' => $query]
		);
		$result = json_decode($result, true);
		$this->assertEquals($query, $result);

		$result = $this->object->requestAction([
			'controller' => 'RequestAction',
			'action' => 'query_pass',
			'?' => $query
		]);
		$result = json_decode($result, true);
		$this->assertEquals($query, $result);

		$result = $this->object->requestAction(
			'/request_action/query_pass?page=3&sort=body'
		);
		$result = json_decode($result, true);
		$expected = ['page' => 3, 'sort' => 'body'];
		$this->assertEquals($expected, $result);
	}

/**
 * Test requestAction with post data.
 *
 * @return void
 */
	public function testRequestActionPostWithData() {
		$data = array(
			'Post' => array('id' => 2)
		);
		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'post_pass'),
			array('post' => $data)
		);
		$result = json_decode($result, true);
		$this->assertEquals($data, $result);

		$result = $this->object->requestAction(
			'/request_action/post_pass',
			array('post' => $data)
		);
		$result = json_decode($result, true);
		$this->assertEquals($data, $result);
	}

/**
 * Test that requestAction handles get parameters correctly.
 *
 * @return void
 */
	public function testRequestActionGetParameters() {
		$result = $this->object->requestAction(
			'/request_action/params_pass?get=value&limit=5'
		);
		$result = json_decode($result, true);
		$this->assertEquals('value', $result['query']['get']);

		$result = $this->object->requestAction(
			array('controller' => 'RequestAction', 'action' => 'params_pass'),
			array('query' => array('get' => 'value', 'limit' => 5))
		);
		$result = json_decode($result, true);
		$this->assertEquals('value', $result['query']['get']);
	}

/**
 * Test that environment overrides can be set.
 *
 * @return void
 */
	public function testRequestActionEnvironment() {
		$result = $this->object->requestAction('/request_action/params_pass');
		$result = json_decode($result, true);
		$this->assertEquals('', $result['contentType'], 'Original content type not found.');

		$result = $this->object->requestAction(
			'/request_action/params_pass',
			['environment' => ['CONTENT_TYPE' => 'application/json']]
		);
		$result = json_decode($result, true);
		$this->assertEquals('application/json', $result['contentType']);
	}

/**
 * Tests that it is possible to transmit the session for the request
 *
 * @return void
 */
	public function testRequestActionSession() {
		$result = $this->object->requestAction('/request_action/session_test');
		$this->assertNull($result);

		$session = $this->getMock('Cake\Network\Session');
		$session->expects($this->once())
			->method('read')
			->with('foo')
			->will($this->returnValue('bar'));
		$result = $this->object->requestAction(
			'/request_action/session_test',
			['session' => $session]
		);
		$this->assertEquals('bar', $result);
	}

}