|
|
@@ -1,878 +0,0 @@
|
|
|
-<?php
|
|
|
-declare(strict_types=1);
|
|
|
-
|
|
|
-/**
|
|
|
- * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
|
|
- * Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
|
|
|
- * @link https://cakephp.org CakePHP(tm) Project
|
|
|
- * @since 1.2.0
|
|
|
- * @license https://opensource.org/licenses/mit-license.php MIT License
|
|
|
- */
|
|
|
-namespace Cake\Test\TestCase\Controller\Component;
|
|
|
-
|
|
|
-use Cake\Controller\Component\RequestHandlerComponent;
|
|
|
-use Cake\Controller\ComponentRegistry;
|
|
|
-use Cake\Controller\Controller;
|
|
|
-use Cake\Event\Event;
|
|
|
-use Cake\Event\EventInterface;
|
|
|
-use Cake\Http\Exception\NotFoundException;
|
|
|
-use Cake\Http\Response;
|
|
|
-use Cake\Http\ServerRequest;
|
|
|
-use Cake\Routing\Router;
|
|
|
-use Cake\TestSuite\TestCase;
|
|
|
-use Cake\View\AjaxView;
|
|
|
-use Cake\View\JsonView;
|
|
|
-use Cake\View\XmlView;
|
|
|
-use TestApp\Controller\Component\RequestHandlerExtComponent;
|
|
|
-use TestApp\Controller\RequestHandlerTestController;
|
|
|
-use TestApp\View\AppView;
|
|
|
-
|
|
|
-/**
|
|
|
- * RequestHandlerComponentTest class
|
|
|
- */
|
|
|
-class RequestHandlerComponentTest extends TestCase
|
|
|
-{
|
|
|
- /**
|
|
|
- * @var \TestApp\Controller\RequestHandlerTestController
|
|
|
- */
|
|
|
- protected $Controller;
|
|
|
-
|
|
|
- /**
|
|
|
- * @var \TestApp\Controller\Component\RequestHandlerExtComponent
|
|
|
- */
|
|
|
- protected $RequestHandler;
|
|
|
-
|
|
|
- /**
|
|
|
- * @var \Cake\Http\ServerRequest
|
|
|
- */
|
|
|
- protected $request;
|
|
|
-
|
|
|
- /**
|
|
|
- * Backup of $_SERVER
|
|
|
- *
|
|
|
- * @var array
|
|
|
- */
|
|
|
- protected $server = [];
|
|
|
-
|
|
|
- /**
|
|
|
- * @var \Cake\Routing\RouteBuilder
|
|
|
- */
|
|
|
- protected $builder;
|
|
|
-
|
|
|
- /**
|
|
|
- * setUp method
|
|
|
- */
|
|
|
- public function setUp(): void
|
|
|
- {
|
|
|
- parent::setUp();
|
|
|
- $this->server = $_SERVER;
|
|
|
- static::setAppNamespace();
|
|
|
- $this->_init();
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * init method
|
|
|
- */
|
|
|
- protected function _init(): void
|
|
|
- {
|
|
|
- $request = new ServerRequest(['url' => 'controller_posts/index']);
|
|
|
- $response = new Response();
|
|
|
- $this->Controller = new RequestHandlerTestController($request, $response);
|
|
|
- $this->RequestHandler = $this->Controller->components()->load(RequestHandlerExtComponent::class);
|
|
|
- $this->request = $request;
|
|
|
-
|
|
|
- $this->builder = Router::createRouteBuilder('/');
|
|
|
- $this->builder->setExtensions('json');
|
|
|
- $this->builder->fallbacks('InflectedRoute');
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * tearDown method
|
|
|
- */
|
|
|
- public function tearDown(): void
|
|
|
- {
|
|
|
- parent::tearDown();
|
|
|
- Router::reload();
|
|
|
- $_SERVER = $this->server;
|
|
|
- unset($this->RequestHandler, $this->Controller);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that the constructor sets the config.
|
|
|
- */
|
|
|
- public function testConstructorConfig(): void
|
|
|
- {
|
|
|
- $config = [
|
|
|
- 'viewClassMap' => ['json' => 'MyPlugin.MyJson'],
|
|
|
- ];
|
|
|
- /** @var \Cake\Controller\Controller|\PHPUnit\Framework\MockObject\MockObject $controller */
|
|
|
- $controller = $this->getMockBuilder(Controller::class)
|
|
|
- ->onlyMethods(['redirect'])
|
|
|
- ->getMock();
|
|
|
- $collection = new ComponentRegistry($controller);
|
|
|
- $requestHandler = new RequestHandlerComponent($collection, $config);
|
|
|
- $this->assertEquals(['json' => 'MyPlugin.MyJson'], $requestHandler->getConfig('viewClassMap'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * testInitializeCallback method
|
|
|
- */
|
|
|
- public function testInitializeCallback(): void
|
|
|
- {
|
|
|
- $this->assertNull($this->RequestHandler->getExt());
|
|
|
- $this->Controller->setRequest($this->Controller->getRequest()->withParam('_ext', 'rss'));
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame('rss', $this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test that a mapped Accept-type header will set $this->ext correctly.
|
|
|
- */
|
|
|
- public function testInitializeContentTypeSettingExt(): void
|
|
|
- {
|
|
|
- Router::reload();
|
|
|
- $this->Controller->setRequest($this->request->withHeader('Accept', 'application/json'));
|
|
|
-
|
|
|
- $this->RequestHandler->setExt(null);
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame('json', $this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that RequestHandler sets $this->ext when jQuery sends its wonky-ish headers.
|
|
|
- */
|
|
|
- public function testInitializeContentTypeWithjQueryAccept(): void
|
|
|
- {
|
|
|
- Router::reload();
|
|
|
- $this->Controller->setRequest($this->request
|
|
|
- ->withHeader('Accept', 'application/json, application/javascript, */*; q=0.01')
|
|
|
- ->withHeader('X-Requested-With', 'XMLHttpRequest'));
|
|
|
- $this->RequestHandler->setExt(null);
|
|
|
- Router::extensions('json', false);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame('json', $this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that RequestHandler does not set extension to csv for text/plain mimetype
|
|
|
- */
|
|
|
- public function testInitializeContentTypeWithjQueryTextPlainAccept(): void
|
|
|
- {
|
|
|
- Router::reload();
|
|
|
- $this->Controller->setRequest($this->request->withHeader('Accept', 'text/plain, */*; q=0.01'));
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertNull($this->RequestHandler->ext);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that RequestHandler sets $this->ext when jQuery sends its wonky-ish headers
|
|
|
- * and the application is configured to handle multiple extensions
|
|
|
- */
|
|
|
- public function testInitializeContentTypeWithjQueryAcceptAndMultiplesExtensions(): void
|
|
|
- {
|
|
|
- Router::reload();
|
|
|
- $this->Controller->setRequest($this->request->withHeader('Accept', 'application/json, application/javascript, */*; q=0.01'));
|
|
|
- $this->RequestHandler->setExt(null);
|
|
|
- Router::extensions(['rss', 'json'], false);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame('json', $this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that RequestHandler does not set $this->ext when multiple accepts are sent.
|
|
|
- */
|
|
|
- public function testInitializeNoContentTypeWithSingleAccept(): void
|
|
|
- {
|
|
|
- Router::reload();
|
|
|
- $_SERVER['HTTP_ACCEPT'] = 'application/json, text/html, */*; q=0.01';
|
|
|
- $this->assertNull($this->RequestHandler->getExt());
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertNull($this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that ext is set to the first listed extension with multiple accepted
|
|
|
- * content types.
|
|
|
- * Having multiple types accepted with same weight, means the client lets the
|
|
|
- * server choose the returned content type.
|
|
|
- */
|
|
|
- public function testInitializeNoContentTypeWithMultipleAcceptedTypes(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'application/json, application/javascript, application/xml, */*; q=0.01'
|
|
|
- ));
|
|
|
- $this->RequestHandler->setExt(null);
|
|
|
- Router::extensions(['xml', 'json'], false);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame('xml', $this->RequestHandler->getExt());
|
|
|
-
|
|
|
- $this->RequestHandler->setExt(null);
|
|
|
- Router::extensions(['json', 'xml'], false);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame('json', $this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that ext is set to type with highest weight
|
|
|
- */
|
|
|
- public function testInitializeContentTypeWithMultipleAcceptedTypes(): void
|
|
|
- {
|
|
|
- Router::reload();
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'text/csv;q=1.0, application/json;q=0.8, application/xml;q=0.7'
|
|
|
- ));
|
|
|
- $this->RequestHandler->setExt(null);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame('json', $this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that ext is not set with confusing android accepts headers.
|
|
|
- */
|
|
|
- public function testInitializeAmbiguousAndroidAccepts(): void
|
|
|
- {
|
|
|
- Router::reload();
|
|
|
- $this->request = $this->request->withEnv(
|
|
|
- 'HTTP_ACCEPT',
|
|
|
- 'application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5'
|
|
|
- );
|
|
|
- $this->RequestHandler->setExt(null);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertNull($this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that the headers sent by firefox are not treated as XML requests.
|
|
|
- */
|
|
|
- public function testInititalizeFirefoxHeaderNotXml(): void
|
|
|
- {
|
|
|
- $_SERVER['HTTP_ACCEPT'] = 'text/html,application/xhtml+xml,application/xml;image/png,image/jpeg,image/*;q=0.9,*/*;q=0.8';
|
|
|
- Router::extensions(['xml', 'json'], false);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertNull($this->RequestHandler->getExt());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that a type mismatch doesn't incorrectly set the ext
|
|
|
- */
|
|
|
- public function testInitializeContentTypeAndExtensionMismatch(): void
|
|
|
- {
|
|
|
- $this->assertNull($this->RequestHandler->getExt());
|
|
|
- $extensions = Router::extensions();
|
|
|
- Router::extensions('xml', false);
|
|
|
-
|
|
|
- $request = new ServerRequest([
|
|
|
- 'environment' => ['HTTP_ACCEPT' => 'text/plain'],
|
|
|
- ]);
|
|
|
- $this->Controller->setRequest($request);
|
|
|
-
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertNull($this->RequestHandler->getExt());
|
|
|
-
|
|
|
- Router::extensions($extensions, false);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test that startup() throws deprecation warning if input data is available and request data is not populated.
|
|
|
- */
|
|
|
- public function testInitializeInputNoWarningEmptyJsonObject(): void
|
|
|
- {
|
|
|
- $request = new ServerRequest([
|
|
|
- 'input' => json_encode([]),
|
|
|
- ]);
|
|
|
- $this->Controller->setRequest($request->withMethod('POST'));
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->assertSame([], $request->getParsedBody());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * testViewClassMap
|
|
|
- */
|
|
|
- public function testViewClassMap(): void
|
|
|
- {
|
|
|
- $this->RequestHandler->setConfig(['viewClassMap' => ['json' => 'CustomJson']]);
|
|
|
- $result = $this->RequestHandler->getConfig('viewClassMap');
|
|
|
- $expected = [
|
|
|
- 'json' => 'CustomJson',
|
|
|
- 'xml' => 'Xml',
|
|
|
- 'ajax' => 'Ajax',
|
|
|
- ];
|
|
|
- $this->assertEquals($expected, $result);
|
|
|
- $this->RequestHandler->setConfig(['viewClassMap' => ['xls' => 'Excel.Excel']]);
|
|
|
- $result = $this->RequestHandler->getConfig('viewClassMap');
|
|
|
- $expected = [
|
|
|
- 'json' => 'CustomJson',
|
|
|
- 'xml' => 'Xml',
|
|
|
- 'ajax' => 'Ajax',
|
|
|
- 'xls' => 'Excel.Excel',
|
|
|
- ];
|
|
|
- $this->assertEquals($expected, $result);
|
|
|
-
|
|
|
- $this->RequestHandler->renderAs($this->Controller, 'json');
|
|
|
- $this->assertSame('TestApp\View\CustomJsonView', $this->Controller->viewBuilder()->getClassName());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Verify that isAjax is set on the request params for AJAX requests
|
|
|
- *
|
|
|
- * @triggers Controller.startup $this->Controller
|
|
|
- */
|
|
|
- public function testIsAjaxParams(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request->withHeader('X-Requested-With', 'XMLHttpRequest'));
|
|
|
- $event = new Event('Controller.startup', $this->Controller);
|
|
|
- $this->Controller->beforeFilter($event);
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $this->assertTrue($this->Controller->getRequest()->getAttribute('isAjax'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * testAutoAjaxLayout method
|
|
|
- *
|
|
|
- * @triggers Controller.startup $this->Controller
|
|
|
- */
|
|
|
- public function testAutoAjaxLayout(): void
|
|
|
- {
|
|
|
- $event = new Event('Controller.startup', $this->Controller);
|
|
|
- $this->Controller->setRequest($this->request->withHeader('X-Requested-With', 'XMLHttpRequest'));
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $this->RequestHandler->beforeRender($event);
|
|
|
-
|
|
|
- $view = $this->Controller->createView();
|
|
|
- $this->assertInstanceOf(AjaxView::class, $view);
|
|
|
- $this->assertSame('ajax', $view->getLayout());
|
|
|
- $this->assertSame((new Response(['type' => 'ajax']))->getType(), $view->getResponse()->getType());
|
|
|
-
|
|
|
- $this->_init();
|
|
|
- $this->Controller->setRequest($this->Controller->getRequest()->withParam('_ext', 'js'));
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $this->assertNotEquals(AjaxView::class, $this->Controller->viewBuilder()->getClassName());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return array
|
|
|
- */
|
|
|
- public function defaultExtensionsProvider(): array
|
|
|
- {
|
|
|
- return [['html'], ['htm']];
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Tests that the default extensions are using the default view.
|
|
|
- *
|
|
|
- * @param string $extension Extension to test.
|
|
|
- * @dataProvider defaultExtensionsProvider
|
|
|
- */
|
|
|
- public function testDefaultExtensions($extension): void
|
|
|
- {
|
|
|
- Router::extensions([$extension], false);
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withParam('_ext', $extension));
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->RequestHandler->beforeRender(new Event('Controller.beforeRender', $this->Controller));
|
|
|
-
|
|
|
- $this->assertSame($extension, $this->RequestHandler->getExt());
|
|
|
- $this->assertSame('text/html', $this->Controller->getResponse()->getType());
|
|
|
-
|
|
|
- $view = $this->Controller->createView();
|
|
|
- $this->assertInstanceOf(AppView::class, $view);
|
|
|
- $this->assertEmpty($view->getLayoutPath());
|
|
|
- $this->assertEmpty($view->getSubDir());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Tests that the default extensions can be overwritten by the accept header.
|
|
|
- *
|
|
|
- * @param string $extension Extension to test.
|
|
|
- * @dataProvider defaultExtensionsProvider
|
|
|
- */
|
|
|
- public function testDefaultExtensionsOverwrittenByAcceptHeader($extension): void
|
|
|
- {
|
|
|
- Router::extensions([$extension], false);
|
|
|
-
|
|
|
- $request = $this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'application/xml'
|
|
|
- );
|
|
|
- $this->Controller->setRequest($request->withParam('_ext', $extension));
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
- $this->RequestHandler->beforeRender(new Event('Controller.beforeRender', $this->Controller));
|
|
|
-
|
|
|
- $this->assertSame('xml', $this->RequestHandler->getExt());
|
|
|
- $this->assertSame('application/xml', $this->Controller->getResponse()->getType());
|
|
|
-
|
|
|
- $view = $this->Controller->createView();
|
|
|
- $this->assertInstanceOf(XmlView::class, $view);
|
|
|
- $this->assertSame('xml', $view->getLayoutPath());
|
|
|
- $this->assertSame('xml', $view->getSubDir());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test custom JsonView class is loaded and correct.
|
|
|
- *
|
|
|
- * @triggers Controller.startup $this->Controller
|
|
|
- */
|
|
|
- public function testJsonViewLoaded(): void
|
|
|
- {
|
|
|
- Router::extensions(['json', 'xml', 'ajax'], false);
|
|
|
- $this->Controller->setRequest($this->Controller->getRequest()->withParam('_ext', 'json'));
|
|
|
- $event = new Event('Controller.startup', $this->Controller);
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $this->RequestHandler->beforeRender($event);
|
|
|
- $view = $this->Controller->createView();
|
|
|
- $this->assertInstanceOf(JsonView::class, $view);
|
|
|
- $this->assertSame('json', $view->getLayoutPath());
|
|
|
- $this->assertSame('json', $view->getSubDir());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test custom XmlView class is loaded and correct.
|
|
|
- *
|
|
|
- * @triggers Controller.startup $this->Controller
|
|
|
- */
|
|
|
- public function testXmlViewLoaded(): void
|
|
|
- {
|
|
|
- Router::extensions(['json', 'xml', 'ajax'], false);
|
|
|
- $this->Controller->setRequest($this->Controller->getRequest()->withParam('_ext', 'xml'));
|
|
|
- $event = new Event('Controller.startup', $this->Controller);
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $this->RequestHandler->beforeRender($event);
|
|
|
- $view = $this->Controller->createView();
|
|
|
- $this->assertInstanceOf(XmlView::class, $view);
|
|
|
- $this->assertSame('xml', $view->getLayoutPath());
|
|
|
- $this->assertSame('xml', $view->getSubDir());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test custom AjaxView class is loaded and correct.
|
|
|
- *
|
|
|
- * @triggers Controller.startup $this->Controller
|
|
|
- */
|
|
|
- public function testAjaxViewLoaded(): void
|
|
|
- {
|
|
|
- Router::extensions(['json', 'xml', 'ajax'], false);
|
|
|
- $this->Controller->setRequest($this->Controller->getRequest()->withParam('_ext', 'ajax'));
|
|
|
- $event = new Event('Controller.startup', $this->Controller);
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $this->RequestHandler->beforeRender($event);
|
|
|
- $view = $this->Controller->createView();
|
|
|
- $this->assertInstanceOf(AjaxView::class, $view);
|
|
|
- $this->assertSame('ajax', $view->getLayout());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test configured extension but no view class set.
|
|
|
- *
|
|
|
- * @triggers Controller.beforeRender $this->Controller
|
|
|
- */
|
|
|
- public function testNoViewClassExtension(): void
|
|
|
- {
|
|
|
- Router::extensions(['json', 'xml', 'ajax', 'csv'], false);
|
|
|
- $this->Controller->setRequest($this->Controller->getRequest()->withParam('_ext', 'csv'));
|
|
|
- $event = new Event('Controller.startup', $this->Controller);
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $this->Controller->getEventManager()->on('Controller.beforeRender', function () {
|
|
|
- return $this->Controller->getResponse();
|
|
|
- });
|
|
|
- $this->Controller->render();
|
|
|
- $this->assertSame('RequestHandlerTest' . DS . 'csv', $this->Controller->viewBuilder()->getTemplatePath());
|
|
|
- $this->assertSame('csv', $this->Controller->viewBuilder()->getLayoutPath());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Tests that configured extensions that have no configured mimetype do not silently fallback to HTML.
|
|
|
- */
|
|
|
- public function testUnrecognizedExtensionFailure(): void
|
|
|
- {
|
|
|
- $this->expectException(NotFoundException::class);
|
|
|
- $this->expectExceptionMessage('Invoked extension not recognized/configured: foo');
|
|
|
-
|
|
|
- Router::extensions(['json', 'foo'], false);
|
|
|
- $this->Controller->setRequest($this->Controller->getRequest()->withParam('_ext', 'foo'));
|
|
|
- $event = new Event('Controller.startup', $this->Controller);
|
|
|
- $this->RequestHandler->startup($event);
|
|
|
- $this->Controller->getEventManager()->on('Controller.beforeRender', function () {
|
|
|
- return $this->Controller->getResponse();
|
|
|
- });
|
|
|
- $this->Controller->render();
|
|
|
- $this->assertSame('RequestHandlerTest' . DS . 'csv', $this->Controller->viewBuilder()->getTemplatePath());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * testRenderAs method
|
|
|
- */
|
|
|
- public function testRenderAs(): void
|
|
|
- {
|
|
|
- $this->RequestHandler->renderAs($this->Controller, 'rss');
|
|
|
-
|
|
|
- $this->Controller->viewBuilder()->setTemplatePath('request_handler_test\\rss');
|
|
|
- $this->RequestHandler->renderAs($this->Controller, 'js');
|
|
|
- $this->assertSame('request_handler_test' . DS . 'js', $this->Controller->viewBuilder()->getTemplatePath());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test that attachment headers work with renderAs
|
|
|
- */
|
|
|
- public function testRenderAsWithAttachment(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request->withHeader('Accept', 'application/xml;q=1.0'));
|
|
|
-
|
|
|
- $this->RequestHandler->renderAs($this->Controller, 'xml', ['attachment' => 'myfile.xml']);
|
|
|
- $this->assertSame(XmlView::class, $this->Controller->viewBuilder()->getClassName());
|
|
|
- $this->assertSame('application/xml', $this->Controller->getResponse()->getType());
|
|
|
- $this->assertSame('UTF-8', $this->Controller->getResponse()->getCharset());
|
|
|
- $this->assertStringContainsString('myfile.xml', $this->Controller->getResponse()->getHeaderLine('Content-Disposition'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test that respondAs works as expected.
|
|
|
- */
|
|
|
- public function testRespondAs(): void
|
|
|
- {
|
|
|
- $result = $this->RequestHandler->respondAs('json');
|
|
|
- $this->assertTrue($result);
|
|
|
- $this->assertSame('application/json', $this->Controller->getResponse()->getType());
|
|
|
-
|
|
|
- $result = $this->RequestHandler->respondAs('text/xml');
|
|
|
- $this->assertTrue($result);
|
|
|
- $this->assertSame('text/xml', $this->Controller->getResponse()->getType());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test that attachment headers work with respondAs
|
|
|
- */
|
|
|
- public function testRespondAsWithAttachment(): void
|
|
|
- {
|
|
|
- $result = $this->RequestHandler->respondAs('xml', ['attachment' => 'myfile.xml']);
|
|
|
- $this->assertTrue($result);
|
|
|
- $response = $this->Controller->getResponse();
|
|
|
- $this->assertStringContainsString('myfile.xml', $response->getHeaderLine('Content-Disposition'));
|
|
|
- $this->assertStringContainsString('application/xml', $response->getType());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test that calling renderAs() more than once continues to work.
|
|
|
- *
|
|
|
- * @link #6466
|
|
|
- */
|
|
|
- public function testRenderAsCalledTwice(): void
|
|
|
- {
|
|
|
- $this->Controller->getEventManager()->on('Controller.beforeRender', function (EventInterface $e) {
|
|
|
- return $e->getSubject()->getResponse();
|
|
|
- });
|
|
|
- $this->Controller->render();
|
|
|
-
|
|
|
- $this->RequestHandler->renderAs($this->Controller, 'print');
|
|
|
- $this->assertSame('RequestHandlerTest' . DS . 'print', $this->Controller->viewBuilder()->getTemplatePath());
|
|
|
- $this->assertSame('print', $this->Controller->viewBuilder()->getLayoutPath());
|
|
|
-
|
|
|
- $this->RequestHandler->renderAs($this->Controller, 'js');
|
|
|
- $this->assertSame('RequestHandlerTest' . DS . 'js', $this->Controller->viewBuilder()->getTemplatePath());
|
|
|
- $this->assertSame('js', $this->Controller->viewBuilder()->getLayoutPath());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * testRequestContentTypes method
|
|
|
- */
|
|
|
- public function testRequestContentTypes(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request->withEnv('REQUEST_METHOD', 'GET'));
|
|
|
- $this->assertNull($this->RequestHandler->requestedWith());
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withEnv('REQUEST_METHOD', 'POST')
|
|
|
- ->withEnv('CONTENT_TYPE', 'application/json'));
|
|
|
- $this->assertSame('json', $this->RequestHandler->requestedWith());
|
|
|
-
|
|
|
- $result = $this->RequestHandler->requestedWith(['json', 'xml']);
|
|
|
- $this->assertSame('json', $result);
|
|
|
-
|
|
|
- $result = $this->RequestHandler->requestedWith(['rss', 'atom']);
|
|
|
- $this->assertFalse($result);
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request
|
|
|
- ->withEnv('REQUEST_METHOD', 'PATCH')
|
|
|
- ->withEnv('CONTENT_TYPE', 'application/json'));
|
|
|
- $this->assertSame('json', $this->RequestHandler->requestedWith());
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request
|
|
|
- ->withEnv('REQUEST_METHOD', 'DELETE')
|
|
|
- ->withEnv('CONTENT_TYPE', 'application/json'));
|
|
|
- $this->assertSame('json', $this->RequestHandler->requestedWith());
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request
|
|
|
- ->withEnv('REQUEST_METHOD', 'POST')
|
|
|
- ->withEnv('CONTENT_TYPE', 'application/json'));
|
|
|
- $result = $this->RequestHandler->requestedWith(['json', 'xml']);
|
|
|
- $this->assertSame('json', $result);
|
|
|
-
|
|
|
- $result = $this->RequestHandler->requestedWith(['rss', 'atom']);
|
|
|
- $this->assertFalse($result);
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'text/xml,application/xml,application/xhtml+xml,text/html,text/plain,image/png,*/*'
|
|
|
- ));
|
|
|
- $this->assertTrue($this->RequestHandler->prefers('xml'));
|
|
|
- $this->assertFalse($this->RequestHandler->prefers('atom'));
|
|
|
- $this->assertFalse($this->RequestHandler->prefers('rss'));
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'application/atom+xml,text/xml,application/xml,application/xhtml+xml,text/html,text/plain,image/png,*/*'
|
|
|
- ));
|
|
|
- $this->assertTrue($this->RequestHandler->prefers('atom'));
|
|
|
- $this->assertFalse($this->RequestHandler->prefers('rss'));
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'application/rss+xml,text/xml,application/xml,application/xhtml+xml,text/html,text/plain,image/png,*/*'
|
|
|
- ));
|
|
|
- $this->assertFalse($this->RequestHandler->prefers('atom'));
|
|
|
- $this->assertTrue($this->RequestHandler->prefers('rss'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test that map alias converts aliases to content types.
|
|
|
- */
|
|
|
- public function testMapAlias(): void
|
|
|
- {
|
|
|
- $result = $this->RequestHandler->mapAlias('xml');
|
|
|
- $this->assertSame('application/xml', $result);
|
|
|
-
|
|
|
- $result = $this->RequestHandler->mapAlias('text/html');
|
|
|
- $this->assertNull($result);
|
|
|
-
|
|
|
- $result = $this->RequestHandler->mapAlias('wap');
|
|
|
- $this->assertSame('text/vnd.wap.wml', $result);
|
|
|
-
|
|
|
- $result = $this->RequestHandler->mapAlias(['xml', 'js', 'json']);
|
|
|
- $expected = ['application/xml', 'application/javascript', 'application/json'];
|
|
|
- $this->assertEquals($expected, $result);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test accepts() on the component
|
|
|
- */
|
|
|
- public function testAccepts(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5'
|
|
|
- ));
|
|
|
- $this->assertTrue($this->RequestHandler->accepts(['js', 'xml', 'html']));
|
|
|
- $this->assertFalse($this->RequestHandler->accepts(['gif', 'jpeg', 'foo']));
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withHeader('Accept', '*/*;q=0.5'));
|
|
|
- $this->assertFalse($this->RequestHandler->accepts('rss'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test accepts and prefers methods.
|
|
|
- */
|
|
|
- public function testPrefers(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'text/xml,application/xml,application/xhtml+xml,text/html,text/plain,image/png,*/*'
|
|
|
- ));
|
|
|
- $this->assertNotEquals('rss', $this->RequestHandler->prefers());
|
|
|
-
|
|
|
- $this->RequestHandler->setExt('rss');
|
|
|
- $this->assertSame('rss', $this->RequestHandler->prefers());
|
|
|
- $this->assertFalse($this->RequestHandler->prefers('xml'));
|
|
|
- $this->assertSame('xml', $this->RequestHandler->prefers(['js', 'xml', 'xhtml']));
|
|
|
- $this->assertFalse($this->RequestHandler->prefers(['red', 'blue']));
|
|
|
- $this->assertSame('xhtml', $this->RequestHandler->prefers(['js', 'json', 'xhtml']));
|
|
|
- $this->assertTrue($this->RequestHandler->prefers(['rss']), 'Should return true if input matches ext.');
|
|
|
- $this->assertFalse($this->RequestHandler->prefers(['html']), 'No match with ext, return false.');
|
|
|
-
|
|
|
- $this->_init();
|
|
|
- $this->Controller->setRequest($this->request->withHeader(
|
|
|
- 'Accept',
|
|
|
- 'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5'
|
|
|
- ));
|
|
|
- $this->assertSame('xml', $this->RequestHandler->prefers());
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withHeader('Accept', '*/*;q=0.5'));
|
|
|
- $this->assertSame('html', $this->RequestHandler->prefers());
|
|
|
- $this->assertFalse($this->RequestHandler->prefers('rss'));
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withEnv('HTTP_ACCEPT', ''));
|
|
|
- $this->RequestHandler->setExt('json');
|
|
|
- $this->assertFalse($this->RequestHandler->prefers('xml'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test checkNotModified method
|
|
|
- *
|
|
|
- * @triggers Controller.beforeRender $this->Controller
|
|
|
- */
|
|
|
- public function testCheckNotModifiedByEtagStar(): void
|
|
|
- {
|
|
|
- $response = new Response();
|
|
|
- $response = $response->withEtag('something')
|
|
|
- ->withHeader('Content-Type', 'text/plain')
|
|
|
- ->withStringBody('keeper');
|
|
|
- $this->Controller->setResponse($response);
|
|
|
- $this->Controller->setRequest($this->request->withHeader('If-None-Match', '*'));
|
|
|
-
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $requestHandler = new RequestHandlerComponent($this->Controller->components());
|
|
|
- $requestHandler->beforeRender($event);
|
|
|
- $this->assertTrue($event->isStopped());
|
|
|
- $this->assertSame(304, $this->Controller->getResponse()->getStatusCode());
|
|
|
- $this->assertSame('', (string)$this->Controller->getResponse()->getBody());
|
|
|
- $this->assertFalse($this->Controller->getResponse()->hasHeader('Content-Type'), 'header should not be removed.');
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test checkNotModified method
|
|
|
- *
|
|
|
- * @triggers Controller.beforeRender
|
|
|
- */
|
|
|
- public function testCheckNotModifiedByEtagExact(): void
|
|
|
- {
|
|
|
- $response = new Response();
|
|
|
- $response = $response->withEtag('something', true)
|
|
|
- ->withHeader('Content-Type', 'text/plain')
|
|
|
- ->withStringBody('keeper');
|
|
|
- $this->Controller->setResponse($response);
|
|
|
-
|
|
|
- $this->Controller->setRequest($this->request->withHeader('If-None-Match', 'W/"something", "other"'));
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
-
|
|
|
- $requestHandler = new RequestHandlerComponent($this->Controller->components());
|
|
|
- $requestHandler->beforeRender($event);
|
|
|
- $this->assertTrue($event->isStopped());
|
|
|
- $this->assertSame(304, $this->Controller->getResponse()->getStatusCode());
|
|
|
- $this->assertSame('', (string)$this->Controller->getResponse()->getBody());
|
|
|
- $this->assertFalse($this->Controller->getResponse()->hasHeader('Content-Type'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test checkNotModified method
|
|
|
- *
|
|
|
- * @triggers Controller.beforeRender $this->Controller
|
|
|
- */
|
|
|
- public function testCheckNotModifiedByEtagAndTime(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request
|
|
|
- ->withHeader('If-None-Match', 'W/"something", "other"')
|
|
|
- ->withHeader('If-Modified-Since', '2012-01-01 00:00:00'));
|
|
|
-
|
|
|
- $response = new Response();
|
|
|
- $response = $response->withEtag('something', true)
|
|
|
- ->withHeader('Content-type', 'text/plain')
|
|
|
- ->withStringBody('should be removed')
|
|
|
- ->withModified('2012-01-01 00:00:00');
|
|
|
- $this->Controller->setResponse($response);
|
|
|
-
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $requestHandler = new RequestHandlerComponent($this->Controller->components());
|
|
|
- $requestHandler->beforeRender($event);
|
|
|
- $this->assertTrue($event->isStopped());
|
|
|
-
|
|
|
- $this->assertSame(304, $this->Controller->getResponse()->getStatusCode());
|
|
|
- $this->assertSame('', (string)$this->Controller->getResponse()->getBody());
|
|
|
- $this->assertFalse($this->Controller->getResponse()->hasHeader('Content-type'));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test checkNotModified method
|
|
|
- *
|
|
|
- * @triggers Controller.beforeRender $this->Controller
|
|
|
- */
|
|
|
- public function testCheckNotModifiedNoInfo(): void
|
|
|
- {
|
|
|
- $response = new Response();
|
|
|
- $this->Controller->setResponse($response);
|
|
|
-
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $requestHandler = new RequestHandlerComponent($this->Controller->components());
|
|
|
- $requestHandler->beforeRender($event);
|
|
|
- $this->assertSame(200, $response->getStatusCode());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test default options in construction
|
|
|
- */
|
|
|
- public function testConstructDefaultOptions(): void
|
|
|
- {
|
|
|
- $requestHandler = new RequestHandlerComponent($this->Controller->components());
|
|
|
- $viewClass = $requestHandler->getConfig('viewClassMap');
|
|
|
- $expected = [
|
|
|
- 'json' => 'Json',
|
|
|
- 'xml' => 'Xml',
|
|
|
- 'ajax' => 'Ajax',
|
|
|
- ];
|
|
|
- $this->assertEquals($expected, $viewClass);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Test options in constructor replace defaults
|
|
|
- */
|
|
|
- public function testConstructReplaceOptions(): void
|
|
|
- {
|
|
|
- $requestHandler = new RequestHandlerComponent(
|
|
|
- $this->Controller->components(),
|
|
|
- [
|
|
|
- 'viewClassMap' => ['json' => 'Json'],
|
|
|
- 'inputTypeMap' => ['json' => ['json_decode', true]],
|
|
|
- ]
|
|
|
- );
|
|
|
- $viewClass = $requestHandler->getConfig('viewClassMap');
|
|
|
- $expected = [
|
|
|
- 'json' => 'Json',
|
|
|
- ];
|
|
|
- $this->assertEquals($expected, $viewClass);
|
|
|
-
|
|
|
- $inputs = $requestHandler->getConfig('inputTypeMap');
|
|
|
- $this->assertArrayHasKey('json', $inputs);
|
|
|
- $this->assertCount(1, $inputs);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * test beforeRender() doesn't override response type set in controller action
|
|
|
- */
|
|
|
- public function testBeforeRender(): void
|
|
|
- {
|
|
|
- $this->Controller->set_response_type();
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $this->RequestHandler->beforeRender($event);
|
|
|
- $this->assertSame('text/plain', $this->Controller->getResponse()->getType());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * tests beforeRender automatically uses renderAs when a supported extension is found
|
|
|
- */
|
|
|
- public function testBeforeRenderAutoRenderAs(): void
|
|
|
- {
|
|
|
- $this->Controller->setRequest($this->request->withParam('_ext', 'csv'));
|
|
|
- $this->RequestHandler->startup(new Event('Controller.startup', $this->Controller));
|
|
|
-
|
|
|
- $event = new Event('Controller.beforeRender', $this->Controller);
|
|
|
- $this->RequestHandler->beforeRender($event);
|
|
|
- $this->assertSame('text/csv', $this->Controller->getResponse()->getType());
|
|
|
- }
|
|
|
-}
|