silverstripe-cms/tests/model/ErrorPageTest.php

<?php

use SilverStripe\ORM\Versioning\Versioned;
use SilverStripe\CMS\Model\ErrorPage;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Assets\Tests\Storage\AssetStoreTest\TestAssetStore;




/**
 * @package cms
 * @subpackage tests
 */
class ErrorPageTest extends FunctionalTest {

	protected static $fixture_file = 'ErrorPageTest.yml';

	/**
	 * Location of temporary cached files
	 *
	 * @var string
	 */
	protected $tmpAssetsPath = '';

	public function setUp() {
		parent::setUp();
		// Set temporary asset backend store
		TestAssetStore::activate('ErrorPageTest');
		Config::inst()->update('SilverStripe\\CMS\\Model\\ErrorPage', 'enable_static_file', true);
		Config::inst()->update('SilverStripe\\Control\\Director', 'environment_type', 'live');
		$this->logInWithPermission('ADMIN');
	}

	public function tearDown() {
		TestAssetStore::reset();
		parent::tearDown();
	}

	public function test404ErrorPage() {
		$page = $this->objFromFixture('SilverStripe\\CMS\\Model\\ErrorPage', '404');
		// ensure that the errorpage exists as a physical file
		$page->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);

		$response = $this->get('nonexistent-page');

		/* We have body text from the error page */
		$this->assertNotNull($response->getBody(), 'We have body text from the error page');

		/* Status code of the HTTPResponse for error page is "404" */
		$this->assertEquals($response->getStatusCode(), '404', 'Status code of the HTTPResponse for error page is "404"');

		/* Status message of the HTTPResponse for error page is "Not Found" */
		$this->assertEquals($response->getStatusDescription(), 'Not Found', 'Status message of the HTTResponse for error page is "Not found"');
	}

	public function testBehaviourOfShowInMenuAndShowInSearchFlags() {
		$page = $this->objFromFixture('SilverStripe\\CMS\\Model\\ErrorPage', '404');

		/* Don't show the error page in the menus */
		$this->assertEquals($page->ShowInMenus, 0, 'Don\'t show the error page in the menus');

		/* Don't show the error page in the search */
		$this->assertEquals($page->ShowInSearch, 0, 'Don\'t show the error page in search');
	}

	public function testBehaviourOf403() {
		$page = $this->objFromFixture('SilverStripe\\CMS\\Model\\ErrorPage', '403');
		$page->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);

		$response = $this->get($page->RelativeLink());

		$this->assertEquals($response->getStatusCode(), '403');
		$this->assertNotNull($response->getBody(), 'We have body text from the error page');
	}

	public function testSecurityError() {
		// Generate 404 page
		$page = $this->objFromFixture('SilverStripe\\CMS\\Model\\ErrorPage', '404');
		$page->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);

		// Test invalid action
		$response = $this->get('Security/nosuchaction');
		$this->assertEquals($response->getStatusCode(), '404');
		$this->assertNotNull($response->getBody());
		$this->assertContains('text/html', $response->getHeader('Content-Type'));
	}

	public function testStaticCaching() {
		// Test new error code does not have static content
		$this->assertEmpty(ErrorPage::get_content_for_errorcode('401'));
		$expectedErrorPagePath = TestAssetStore::base_path() . '/error-401.html';
		$this->assertFileNotExists($expectedErrorPagePath, 'Error page is not automatically cached');

		// Write new 401 page
		$page = new ErrorPage();
		$page->Title = '401 Error';
		$page->ErrorCode = 401;
		$page->Title = 'Unauthorised';
		$page->write();
		$page->publishRecursive();

		// Static cache should now exist
		$this->assertNotEmpty(ErrorPage::get_content_for_errorcode('401'));
		$expectedErrorPagePath = TestAssetStore::base_path() . '/error-401.html';
		$this->assertFileExists($expectedErrorPagePath, 'Error page is cached');
	}

	/**
	 * Test fallback to file generation API with enable_static_file disabled
	 */
	public function testGeneratedFile() {
		Config::inst()->update('SilverStripe\\CMS\\Model\\ErrorPage', 'enable_static_file', false);
		$this->logInWithPermission('ADMIN');

		$page = new ErrorPage();
		$page->ErrorCode = 405;
		$page->Title = 'Method Not Allowed';
		$page->write();
		$page->publishRecursive();

		// Dynamic content is available
		$response = ErrorPage::response_for('405');
		$this->assertNotEmpty($response);
		$this->assertNotEmpty($response->getBody());
		$this->assertEquals(405, (int)$response->getStatusCode());

		// Static content is not available
		$this->assertEmpty(ErrorPage::get_content_for_errorcode('405'));
		$expectedErrorPagePath = TestAssetStore::base_path() . '/error-405.html';
		$this->assertFileNotExists($expectedErrorPagePath, 'Error page is not cached in static location');
	}
}