silverstripe-framework/tests/dev/DevAdminControllerTest.php

<?php

use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Control\Director;
use SilverStripe\Control\Controller;



/**
 * Note: the running of this test is handled by the thing it's testing (DevelopmentAdmin controller).
 *
 * @package framework
 * @package tests
 */
class DevAdminControllerTest extends FunctionalTest {

	public function setUp(){
		parent::setUp();

		Config::inst()->update('SilverStripe\\Dev\\DevelopmentAdmin', 'registered_controllers', array(
			'x1' => array(
				'controller' => 'DevAdminControllerTest_Controller1',
				'links' => array(
					'x1' => 'x1 link description',
					'x1/y1' => 'x1/y1 link description'
				)
			),
			'x2' => array(
				'controller' => 'DevAdminControllerTest_Controller2', // intentionally not a class that exists
				'links' => array(
					'x2' => 'x2 link description'
				)
			)
		));
	}


	public function testGoodRegisteredControllerOutput(){
		// Check for the controller running from the registered url above
		// (we use contains rather than equals because sometimes you get Warning: You probably want to define an entry in $_FILE_TO_URL_MAPPING)
		$this->assertContains(DevAdminControllerTest_Controller1::OK_MSG, $this->getCapture('/dev/x1'));
		$this->assertContains(DevAdminControllerTest_Controller1::OK_MSG, $this->getCapture('/dev/x1/y1'));
	}

	public function testGoodRegisteredControllerStatus(){
		// Check response code is 200/OK
		$this->assertEquals(false, $this->getAndCheckForError('/dev/x1'));
		$this->assertEquals(false, $this->getAndCheckForError('/dev/x1/y1'));

		// Check response code is 500/ some sort of error
		$this->assertEquals(true, $this->getAndCheckForError('/dev/x2'));
	}



	protected function getCapture($url){
		$this->logInWithPermission('ADMIN');

		ob_start();
		$this->get($url);
		$r = ob_get_contents();
		ob_end_clean();

		return $r;
	}

	protected function getAndCheckForError($url){
		$this->logInWithPermission('ADMIN');

		if(Director::is_cli()){
			// when in CLI the admin controller throws exceptions
			ob_start();
			try{
				$this->get($url);
			}catch(Exception $e){
				ob_end_clean();
				return true;
			}

			ob_end_clean();
			return false;

		}else{
			// when in http the admin controller sets a response header
			ob_start();
			$resp = $this->get($url);
			ob_end_clean();
			return $resp->isError();
		}
	}

}

class DevAdminControllerTest_Controller1 extends Controller {

	const OK_MSG = 'DevAdminControllerTest_Controller1 TEST OK';

	private static $url_handlers = array(
		'' => 'index',
		'y1' => 'y1Action'
	);

	private static $allowed_actions = array(
		'index',
		'y1Action',
	);


	public function index(){
		echo self::OK_MSG;
	}

	public function y1Action(){
		echo self::OK_MSG;
	}

}