silverstripe-framework/tests/php/Control/RequestHandlingTest.php

375 lines
16 KiB
PHP
Raw Normal View History

<?php
2016-10-14 03:30:05 +02:00
namespace SilverStripe\Control\Tests;
use SilverStripe\Admin\LeftAndMain;
use SilverStripe\Control\Controller;
2018-09-27 00:43:56 +02:00
use SilverStripe\Control\Director;
use SilverStripe\Control\RequestHandler;
2016-10-14 03:30:05 +02:00
use SilverStripe\Control\Tests\RequestHandlingTest\AllowedController;
use SilverStripe\Control\Tests\RequestHandlingTest\ControllerFormWithAllowedActions;
use SilverStripe\Control\Tests\RequestHandlingTest\FieldController;
use SilverStripe\Control\Tests\RequestHandlingTest\FormActionController;
use SilverStripe\Control\Tests\RequestHandlingTest\TestController;
use SilverStripe\Dev\FunctionalTest;
2018-09-27 00:43:56 +02:00
use SilverStripe\ErrorPage\ErrorPageControllerExtension;
use SilverStripe\Forms\Form;
2016-09-09 08:43:05 +02:00
use SilverStripe\Security\SecurityToken;
/**
2016-09-09 08:43:05 +02:00
* Tests for RequestHandler and HTTPRequest.
2014-08-15 08:53:05 +02:00
* We've set up a simple URL handling model based on
*/
class RequestHandlingTest extends FunctionalTest
{
protected static $fixture_file = null;
2018-09-27 00:43:56 +02:00
protected static $illegal_extensions = [
// Suppress CMS error page handling
2018-09-27 00:43:56 +02:00
Controller::class => [
ErrorPageControllerExtension::class,
2018-09-27 00:43:56 +02:00
],
Form::class => [
ErrorPageControllerExtension::class,
2018-09-27 00:43:56 +02:00
],
LeftAndMain::class => [
ErrorPageControllerExtension::class,
2018-09-27 00:43:56 +02:00
],
];
protected static $extra_controllers = [
TestController::class,
AllowedController::class,
ControllerFormWithAllowedActions::class,
FieldController::class,
2018-09-27 00:43:56 +02:00
FormActionController::class,
];
public function getExtraRoutes()
{
$routes = parent::getExtraRoutes();
return array_merge(
$routes,
[
// If we don't request any variables, then the whole URL will get shifted off.
// This is fine, but it means that the controller will have to parse the Action from the URL itself.
'testGoodBase1' => TestController::class,
// The double-slash indicates how much of the URL should be shifted off the stack.
// This is important for dealing with nested request handlers appropriately.
'testGoodBase2//$Action/$ID/$OtherID' => TestController::class,
// By default, the entire URL will be shifted off. This creates a bit of
// backward-incompatability, but makes the URL rules much more explicit.
'testBadBase/$Action/$ID/$OtherID' => TestController::class,
// Rules with an extension always default to the index() action
'testBaseWithExtension/virtualfile.xml' => TestController::class,
// Without the extension, the methodname should be matched
'testBaseWithExtension//$Action/$ID/$OtherID' => TestController::class,
// Test nested base
'testParentBase/testChildBase//$Action/$ID/$OtherID' => TestController::class,
]
);
}
public function testConstructedWithNullRequest()
{
$r = new RequestHandler();
$this->assertInstanceOf('SilverStripe\\Control\\NullHTTPRequest', $r->getRequest());
}
public function testRequestHandlerChainingAllParams()
{
$this->markTestIncomplete();
}
public function testMethodCallingOnController()
{
/* Calling a controller works just like it always has */
$response = Director::test("testGoodBase1");
$this->assertEquals("This is the controller", $response->getBody());
/* ID and OtherID are extracted from the URL and passed in $request->params. */
$response = Director::test("testGoodBase1/method/1/2");
$this->assertEquals("This is a method on the controller: 1, 2", $response->getBody());
/* In addition, these values are available in $controller->urlParams. This is mainly for backward
* compatibility. */
$response = Director::test("testGoodBase1/legacymethod/3/4");
2018-09-27 00:43:56 +02:00
$this->assertEquals(
"\$this->urlParams can be used, for backward compatibility: 3, 4",
$response->getBody()
);
}
public function testPostRequests()
{
/* The HTTP Request handler can trigger special behaviour for GET and POST. */
2018-09-27 00:43:56 +02:00
$response = Director::test("testGoodBase1/TestForm", ["MyField" => 3], null, "POST");
$this->assertEquals("Form posted", $response->getBody());
$response = Director::test("testGoodBase1/TestForm");
$this->assertEquals("Get request on form", $response->getBody());
}
public function testRequestHandlerChaining()
{
/* Request handlers can be chained, from Director to Controller to Form to FormField. Here, we can make a get
request on a FormField. */
$response = Director::test("testGoodBase1/TestForm/fields/MyField");
$this->assertEquals("MyField requested", $response->getBody());
/* We can also make a POST request on a form field, which could be used for in-place editing, for example. */
2018-09-27 00:43:56 +02:00
$response = Director::test("testGoodBase1/TestForm/fields/MyField", ["MyField" => 5]);
$this->assertEquals("MyField posted, update to 5", $response->getBody());
}
public function testBaseUrlPrefixed()
{
$this->withBaseFolder(
'/silverstripe',
2018-09-27 00:43:56 +02:00
function () {
$this->assertEquals(
'MyField requested',
Director::test('/silverstripe/testGoodBase1/TestForm/fields/MyField')->getBody()
);
$this->assertEquals(
'MyField posted, update to 5',
2018-09-27 00:43:56 +02:00
Director::test(
'/silverstripe/testGoodBase1/TestForm/fields/MyField',
['MyField' => 5]
)->getBody()
);
}
);
}
public function testBadBase()
{
/* We no longer support using hacky attempting to handle URL parsing with broken rules */
$response = Director::test("testBadBase/method/1/2");
$this->assertNotEquals("This is a method on the controller: 1, 2", $response->getBody());
2018-09-27 00:43:56 +02:00
$response = Director::test("testBadBase/TestForm", ["MyField" => 3], null, "POST");
$this->assertNotEquals("Form posted", $response->getBody());
$response = Director::test("testBadBase/TestForm/fields/MyField");
$this->assertNotEquals("MyField requested", $response->getBody());
}
public function testBaseWithExtension()
{
/* Rules with an extension always default to the index() action */
$response = Director::test("testBaseWithExtension/virtualfile.xml");
$this->assertEquals("This is the controller", $response->getBody());
/* Without the extension, the methodname should be matched */
$response = Director::test("testBaseWithExtension/virtualfile");
$this->assertEquals("This is the virtualfile method", $response->getBody());
}
public function testNestedBase()
{
/* Nested base should leave out the two parts and correctly map arguments */
$response = Director::test("testParentBase/testChildBase/method/1/2");
$this->assertEquals("This is a method on the controller: 1, 2", $response->getBody());
}
public function testInheritedUrlHandlers()
{
/* $url_handlers can be defined on any class, and */
$response = Director::test("testGoodBase1/TestForm/fields/SubclassedField/something");
$this->assertEquals("customSomething", $response->getBody());
/* However, if the subclass' url_handlers don't match, then the parent class' url_handlers will be used */
$response = Director::test("testGoodBase1/TestForm/fields/SubclassedField");
$this->assertEquals("SubclassedField requested", $response->getBody());
}
public function testDisallowedExtendedActions()
{
/* Actions on an extension are allowed because they specifically provided appropriate allowed_actions items */
$response = Director::test("testGoodBase1/otherExtendedMethod");
$this->assertEquals("otherExtendedMethod", $response->getBody());
/* The failoverMethod action wasn't explicitly listed and so isnt' allowed */
$response = Director::test("testGoodBase1/failoverMethod");
$this->assertEquals(404, $response->getStatusCode());
/* However, on RequestHandlingTest_AllowedController it has been explicitly allowed */
$response = Director::test("AllowedController/failoverMethod");
$this->assertEquals("failoverMethod", $response->getBody());
/* The action on the extension is allowed when explicitly allowed on extension,
even if its not mentioned in controller */
$response = Director::test("AllowedController/extendedMethod");
$this->assertEquals(200, $response->getStatusCode());
/* This action has been blocked by an argument to a method */
$response = Director::test('AllowedController/blockMethod');
$this->assertEquals(403, $response->getStatusCode());
/* Whereas this one has been allowed by a method without an argument */
$response = Director::test('AllowedController/allowMethod');
$this->assertEquals('allowMethod', $response->getBody());
}
public function testHTTPException()
{
$exception = Director::test('TestController/throwexception');
$this->assertEquals(400, $exception->getStatusCode());
$this->assertEquals('This request was invalid.', $exception->getBody());
$responseException = (Director::test('TestController/throwresponseexception'));
$this->assertEquals(500, $responseException->getStatusCode());
$this->assertEquals('There was an internal server error.', $responseException->getBody());
}
public function testHTTPError()
{
RequestHandlingTest\ControllerExtension::$called_error = false;
RequestHandlingTest\ControllerExtension::$called_404_error = false;
$response = Director::test('TestController/throwhttperror');
$this->assertEquals(404, $response->getStatusCode());
$this->assertEquals('This page does not exist.', $response->getBody());
// Confirm that RequestHandlingTest\ControllerExtension::onBeforeHTTPError() called
$this->assertTrue(RequestHandlingTest\ControllerExtension::$called_error);
// Confirm that RequestHandlingTest\ControllerExtension::onBeforeHTTPError404() called
$this->assertTrue(RequestHandlingTest\ControllerExtension::$called_404_error);
}
public function testMethodsOnParentClassesOfRequestHandlerDeclined()
{
$response = Director::test('testGoodBase1/getIterator');
$this->assertEquals(404, $response->getStatusCode());
}
public function testFormActionsCanBypassAllowedActions()
{
SecurityToken::enable();
$response = $this->get('FormActionController');
$this->assertEquals(200, $response->getStatusCode());
$tokenEls = $this->cssParser()->getBySelector('#Form_Form_SecurityID');
$securityId = (string)$tokenEls[0]['value'];
2018-09-27 00:43:56 +02:00
$data = ['action_formaction' => 1];
$response = $this->post('FormActionController/Form', $data);
$this->assertEquals(
400,
$response->getStatusCode(),
'Should fail: Invocation through POST form handler, not contained in $allowed_actions, without CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = ['action_disallowedcontrollermethod' => 1, 'SecurityID' => $securityId];
$response = $this->post('FormActionController/Form', $data);
$this->assertEquals(
403,
$response->getStatusCode(),
'Should fail: Invocation through POST form handler, controller action instead of form action,'
2018-01-16 19:39:30 +01:00
. ' not contained in $allowed_actions, with CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = ['action_formaction' => 1, 'SecurityID' => $securityId];
$response = $this->post('FormActionController/Form', $data);
$this->assertEquals(200, $response->getStatusCode());
$this->assertEquals(
'formaction',
$response->getBody(),
'Should pass: Invocation through POST form handler, not contained in $allowed_actions, with CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = ['action_controlleraction' => 1, 'SecurityID' => $securityId];
$response = $this->post('FormActionController/Form', $data);
$this->assertEquals(
200,
$response->getStatusCode(),
'Should pass: Invocation through POST form handler, controller action instead of form action, contained in'
2018-09-27 00:43:56 +02:00
. ' $allowed_actions, with CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = ['action_formactionInAllowedActions' => 1];
$response = $this->post('FormActionController/Form', $data);
$this->assertEquals(
400,
$response->getStatusCode(),
'Should fail: Invocation through POST form handler, contained in $allowed_actions, without CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = ['action_formactionInAllowedActions' => 1, 'SecurityID' => $securityId];
$response = $this->post('FormActionController/Form', $data);
$this->assertEquals(
200,
$response->getStatusCode(),
'Should pass: Invocation through POST form handler, contained in $allowed_actions, with CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = [];
$response = $this->post('FormActionController/formaction', $data);
$this->assertEquals(
404,
$response->getStatusCode(),
'Should fail: Invocation through POST URL, not contained in $allowed_actions, without CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = [];
$response = $this->post('FormActionController/formactionInAllowedActions', $data);
$this->assertEquals(
200,
$response->getStatusCode(),
'Should pass: Invocation of form action through POST URL, contained in $allowed_actions, without CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = ['SecurityID' => $securityId];
$response = $this->post('FormActionController/formactionInAllowedActions', $data);
$this->assertEquals(
200,
$response->getStatusCode(),
'Should pass: Invocation of form action through POST URL, contained in $allowed_actions, with CSRF token'
);
2018-09-27 00:43:56 +02:00
$data = []; // CSRF protection doesnt kick in for direct requests
$response = $this->post('FormActionController/formactionInAllowedActions', $data);
$this->assertEquals(
200,
$response->getStatusCode(),
'Should pass: Invocation of form action through POST URL, contained in $allowed_actions, without CSRF token'
);
SecurityToken::disable();
}
public function testAllowedActionsEnforcedOnForm()
{
2018-09-27 00:43:56 +02:00
$data = ['action_allowedformaction' => 1];
$response = $this->post('ControllerFormWithAllowedActions/Form', $data);
$this->assertEquals(200, $response->getStatusCode());
$this->assertEquals('allowedformaction', $response->getBody());
2018-09-27 00:43:56 +02:00
$data = ['action_disallowedformaction' => 1];
$response = $this->post('ControllerFormWithAllowedActions/Form', $data);
$this->assertEquals(403, $response->getStatusCode());
// Note: Looks for a specific 403 thrown by Form->httpSubmission(), not RequestHandler->handleRequest()
$this->assertStringContainsString('not allowed on form', $response->getBody());
}
public function testActionHandlingOnField()
{
2018-09-27 00:43:56 +02:00
$data = ['action_actionOnField' => 1];
$response = $this->post('FieldController/TestForm', $data);
$this->assertEquals(200, $response->getStatusCode());
$this->assertEquals('Test method on MyField', $response->getBody());
2018-09-27 00:43:56 +02:00
$data = ['action_actionNotAllowedOnField' => 1];
$response = $this->post('FieldController/TestForm', $data);
$this->assertEquals(404, $response->getStatusCode());
}
}