.
/**
* Unit tests for (some of) ../outputlib.php.
*
* @package moodlecore
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later (5)
*/
if (!defined('MOODLE_INTERNAL')) {
die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
}
require_once($CFG->libdir . '/outputlib.php');
/**
* Subclass of renderer_factory_base for testing. Implement abstract method and
* count calls, so we can test caching behaviour.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class testable_renderer_factory extends renderer_factory_base {
public $createcalls = array();
public function __construct() {
parent::__construct(null);
}
public function get_renderer($module, $page, $subtype=null) {
if (!in_array(array($module, $subtype), $this->createcalls)) {
$this->createcalls[] = array($module, $subtype);
}
return new core_renderer($page);
}
public function standard_renderer_class_for_plugin($module, $subtype=null) {
return parent::standard_renderer_class_for_plugin($module, $subtype);
}
}
/**
* Renderer class for testing.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_test_renderer extends core_renderer {
public function __construct($containerstack, $page) {
parent::__construct($containerstack, $page, null);
}
public function greeting($name = 'world') {
return '
';
}
public function box_end() {
return $this->containerstack->pop('box');
}
}
/**
* Renderer class for testing subrendering feature
*
* @copyright 2009 David Mudrak
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_test_subtype_renderer extends core_renderer {
public function __construct($containerstack, $page) {
parent::__construct($containerstack, $page, null);
}
public function signature($user = 'Administrator') {
return '
Best regards, ' . $user . '
';
}
}
/**
* Unit tests for the requriement_base base class.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class renderer_factory_base_test extends UnitTestCase {
public static $includecoverage = array('lib/outputlib.php');
public function test_get_calls_create() {
// Set up.
$factory = new testable_renderer_factory();
// Exercise SUT.
$renderer = $factory->get_renderer('modulename', new moodle_page);
$subrenderer = $factory->get_renderer('modulename', new moodle_page, 'subtype');
$cached = $factory->get_renderer('modulename', new moodle_page);
// Verify outcome
$this->assertEqual(array(array('modulename', null), array('modulename', 'subtype')), $factory->createcalls);
}
public function test_standard_renderer_class_for_plugin_core() {
// Set up.
$factory = new testable_renderer_factory();
// Exercise SUT.
$classname = $factory->standard_renderer_class_for_plugin('core');
// Verify outcome
$this->assertEqual('core_renderer', $classname);
}
public function test_standard_renderer_class_for_plugin_test() {
// Set up.
$factory = new testable_renderer_factory();
// Exercise SUT.
$classname = $factory->standard_renderer_class_for_plugin('mod_test');
// Verify outcome
$this->assertEqual('mod_test_renderer', $classname);
}
public function test_standard_renderer_class_for_plugin_test_with_subtype() {
// Set up.
$factory = new testable_renderer_factory();
// Exercise SUT.
$classname = $factory->standard_renderer_class_for_plugin('mod_test', 'subtype');
// Verify outcome
$this->assertEqual('mod_test_subtype_renderer', $classname);
}
public function test_standard_renderer_class_for_plugin_unknown() {
// Set up.
$factory = new testable_renderer_factory();
$this->expectException();
// Exercise SUT.
$classname = $factory->standard_renderer_class_for_plugin('something_that_does_not_exist');
}
}
/**
* Unit tests for the standard_renderer_factory class.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class standard_renderer_factory_test extends UnitTestCase {
public static $includecoverage = array('lib/outputrenderers.php', 'lib/outputcomponents.php');
protected $factory;
public function setUp() {
parent::setUp();
$this->factory = new standard_renderer_factory(null, null);
}
public function tearDown() {
$this->factory = null;
parent::tearDown();
}
public function test_get_core_renderer() {
$renderer = $this->factory->get_renderer('core', new moodle_page);
$this->assertIsA($renderer, 'core_renderer');
}
public function test_get_test_renderer() {
$renderer = $this->factory->get_renderer('mod_test', new moodle_page);
$this->assertIsA($renderer, 'mod_test_renderer');
}
public function test_get_test_subtype_renderer() {
$renderer = $this->factory->get_renderer('mod_test', new moodle_page, 'subtype');
$this->assertIsA($renderer, 'mod_test_subtype_renderer');
}
}
/**
* Test-specific subclass that implements a getter for $prefixes.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class testable_theme_overridden_renderer_factory extends theme_overridden_renderer_factory {
public static $includecoverage = array('lib/outputlib.php');
public function get_prefixes() {
return $this->prefixes;
}
}
/**
* Unit tests for the theme_overridden_renderer_factory class.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/*class theme_overridden_renderer_factory_test extends UnitTestCase { // TODO: MDL-21138 rewrite theme unit tests
public static $includecoverage = array('lib/outputlib.php');
protected $originalcfgthemedir;
protected $workspace;
protected $page;
protected $foldertocleanup = null;
public function setUp() {
global $CFG;
parent::setUp();
$this->originalcfgthemedir = $CFG->themedir;
$this->workspace = 'temp/theme_overridden_renderer_factory_fixtures';
make_upload_directory($this->workspace);
$CFG->themedir = $CFG->dataroot . '/' . $this->workspace;
$this->foldertocleanup = $CFG->themedir;
$this->page = new stdClass;
}
public function tearDown() {
global $CFG;
if (!empty($this->foldertocleanup)) {
fulldelete($this->foldertocleanup);
$this->foldertocleanup = null;
}
$CFG->themedir = $this->originalcfgthemedir;
parent::tearDown();
}
protected function make_theme($name) {
global $CFG;
$theme = new stdClass;
$theme->name = $name;
$theme->dir = $CFG->themedir . '/' . $name;
make_upload_directory($this->workspace . '/' . $name);
return $theme;
}
protected function write_renderers_file($theme, $code) {
$filename = $theme->dir . '/lib.php';
file_put_contents($filename, "make_theme('mytheme');
$this->write_renderers_file($theme, '');
// Exercise SUT.
$factory = new testable_theme_overridden_renderer_factory($theme, $this->page);
// Verify outcome
$this->assertEqual(array('mytheme_'), $factory->get_prefixes());
}
public function test_constructor_theme_without_renderes() {
// Set up.
$theme = $this->make_theme('mytheme');
// Exercise SUT.
$factory = new testable_theme_overridden_renderer_factory($theme, $this->page);
// Verify outcome
$this->assertEqual(array(), $factory->get_prefixes());
}
public function test_constructor_theme_with_parent() {
// Set up.
$theme = $this->make_theme('mytheme');
$theme->parent = 'parenttheme';
$parenttheme = $this->make_theme('parenttheme');
$this->write_renderers_file($parenttheme, '');
// Exercise SUT.
$factory = new testable_theme_overridden_renderer_factory($theme, $this->page);
// Verify outcome
$this->assertEqual(array('parenttheme_'), $factory->get_prefixes());
}
public function test_get_renderer_not_overridden() {
// Set up.
$theme = $this->make_theme('mytheme');
$this->write_renderers_file($theme, '');
$factory = new testable_theme_overridden_renderer_factory($theme, $this->page);
// Exercise SUT.
$renderer = $factory->get_renderer('mod_test', new moodle_page);
$subrenderer = $factory->get_renderer('mod_test', new moodle_page, 'subtype');
// Verify outcome
$this->assertIsA($renderer, 'mod_test_renderer');
$this->assertIsA($subrenderer, 'mod_test_subtype_renderer');
}
public function test_get_renderer_overridden() {
// Set up - be very careful because the class under test uses require-once. Pick a unique theme name.
$theme = $this->make_theme('testrenderertheme');
$this->write_renderers_file($theme, '
class testrenderertheme_mod_test_renderer extends mod_test_renderer {
}');
$factory = new testable_theme_overridden_renderer_factory($theme, $this->page);
// Exercise SUT.
$renderer = $factory->get_renderer('mod_test', new moodle_page);
$subrenderer = $factory->get_renderer('mod_test', new moodle_page, 'subtype');
// Verify outcome
$this->assertIsA($renderer, 'testrenderertheme_mod_test_renderer');
$this->assertIsA($subrenderer, 'mod_test_subtype_renderer');
}
public function test_get_renderer_overridden_in_parent() {
// Set up.
$theme = $this->make_theme('childtheme');
$theme->parent = 'parentrenderertheme';
$parenttheme = $this->make_theme('parentrenderertheme');
$this->write_renderers_file($theme, '');
$this->write_renderers_file($parenttheme, '
class parentrenderertheme_core_renderer extends core_renderer {
}');
$factory = new testable_theme_overridden_renderer_factory($theme, $this->page);
// Exercise SUT.
$renderer = $factory->get_renderer('core', new moodle_page);
// Verify outcome
$this->assertIsA($renderer, 'parentrenderertheme_core_renderer');
}
public function test_get_renderer_overridden_in_both() {
// Set up.
$theme = $this->make_theme('ctheme');
$theme->parent = 'ptheme';
$parenttheme = $this->make_theme('ptheme');
$this->write_renderers_file($theme, '
class ctheme_core_renderer extends core_renderer {
}');
$this->write_renderers_file($parenttheme, '
class ptheme_core_renderer extends core_renderer {
}');
$factory = new testable_theme_overridden_renderer_factory($theme, $this->page);
// Exercise SUT.
$renderer = $factory->get_renderer('core', new moodle_page);
// Verify outcome
$this->assertIsA($renderer, 'ctheme_core_renderer');
}
}*/
/**
* Unit tests for the xhtml_container_stack class.
*
* These tests assume that developer debug mode is on, which, at the time of
* writing, is true. admin/report/unittest/index.php forces it on.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class xhtml_container_stack_test extends UnitTestCase {
public static $includecoverage = array('lib/outputlib.php');
protected function start_capture() {
ob_start();
}
protected function end_capture() {
$result = ob_get_contents();
ob_end_clean();
return $result;
}
public function test_push_then_pop() {
// Set up.
$stack = new xhtml_container_stack();
// Exercise SUT.
$this->start_capture();
$stack->push('testtype', '
');
$html = $stack->pop('testtype');
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $html);
$this->assertEqual('', $errors);
}
public function test_mismatched_pop_prints_warning() {
// Set up.
$stack = new xhtml_container_stack();
$stack->push('testtype', '');
// Exercise SUT.
$this->start_capture();
$html = $stack->pop('mismatch');
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $html);
$this->assertNotEqual('', $errors);
}
public function test_pop_when_empty_prints_warning() {
// Set up.
$stack = new xhtml_container_stack();
// Exercise SUT.
$this->start_capture();
$html = $stack->pop('testtype');
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $html);
$this->assertNotEqual('', $errors);
}
public function test_correct_nesting() {
// Set up.
$stack = new xhtml_container_stack();
// Exercise SUT.
$this->start_capture();
$stack->push('testdiv', '');
$stack->push('testp', '');
$html2 = $stack->pop('testp');
$html1 = $stack->pop('testdiv');
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $html2);
$this->assertEqual('', $html1);
$this->assertEqual('', $errors);
}
public function test_pop_all_but_last() {
// Set up.
$stack = new xhtml_container_stack();
$stack->push('test1', '');
$stack->push('test2', '');
$stack->push('test3', '');
// Exercise SUT.
$this->start_capture();
$html = $stack->pop_all_but_last();
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $html);
$this->assertEqual('', $errors);
// Tear down.
$stack->discard();
}
public function test_pop_all_but_last_only_one() {
// Set up.
$stack = new xhtml_container_stack();
$stack->push('test1', '');
// Exercise SUT.
$this->start_capture();
$html = $stack->pop_all_but_last();
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $html);
$this->assertEqual('', $errors);
// Tear down.
$stack->discard();
}
public function test_pop_all_but_last_empty() {
// Set up.
$stack = new xhtml_container_stack();
// Exercise SUT.
$this->start_capture();
$html = $stack->pop_all_but_last();
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $html);
$this->assertEqual('', $errors);
}
public function test_destruct() {
// Set up.
$stack = new xhtml_container_stack();
$stack->push('test1', '');
// Exercise SUT.
$this->start_capture();
$stack = null;
$errors = $this->end_capture();
// Verify outcome
$this->assertPattern('/<\/somethingdistinctive>/', $errors);
}
public function test_destruct_empty() {
// Set up.
$stack = new xhtml_container_stack();
// Exercise SUT.
$this->start_capture();
$stack = null;
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $errors);
}
public function test_discard() {
// Set up.
$stack = new xhtml_container_stack();
$stack->push('test1', '');
$stack->discard();
// Exercise SUT.
$this->start_capture();
$stack = null;
$errors = $this->end_capture();
// Verify outcome
$this->assertEqual('', $errors);
}
}
/**
* Unit tests for the core_renderer class.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_renderer_test extends UnitTestCase {
public static $includecoverage = array('lib/outputrenderers.php', 'lib/outputcomponents.php');
protected $renderer;
public function setUp() {
parent::setUp();
$this->renderer = new core_renderer(new moodle_page);
}
public function test_select_simple() {
$select = html_select::make(array(10 => 'ten', 'c2' => 'two'), 'mymenu');
$html = $this->renderer->select($select);
$this->assert(new ContainsTagWithAttributes('select', array('class' => 'menumymenu select', 'name' => 'mymenu', 'id' => 'menumymenu')), $html);
$this->assert(new ContainsTagWithContents('option', 'ten'), $html);
$this->assert(new ContainsTagWithAttribute('option', 'value', '10'), $html);
$this->assert(new ContainsTagWithContents('option', 'two'), $html);
$this->assert(new ContainsTagWithAttribute('option', 'value', 'c2'), $html);
}
public function test_select_with_label() {
$select = html_select::make(array(10 => 'ten', 'c2' => 'two'), 'mymenu');
$select->set_label('Cool menu');
$html = $this->renderer->select($select);
$this->assert(new ContainsTagWithAttribute('label', 'for', $select->id), $html);
$this->assert(new ContainsTagWithContents('label', 'Cool menu'), $html);
}
public function test_select_yesno() {
$select = html_select::make_yes_no('question', 1);
$html = $this->renderer->select($select);
$this->assert(new ContainsTagWithAttributes('select', array('class' => 'menuquestion select', 'name' => 'question', 'id' => 'menuquestion')), $html);
$this->assert(new ContainsTagWithContents('option', get_string('choosedots')), $html);
$this->assert(new ContainsTagWithContents('option', get_string('yes')), $html);
$this->assert(new ContainsTagWithContents('option', get_string('no')), $html);
$this->assert(new ContainsTagWithAttributes('option', array('value' => '1', 'selected' => 'selected')), $html);
}
public function test_error_text() {
$html = $this->renderer->error_text('message');
$this->assert(new ContainsTagWithContents('span', 'message'), $html);
$this->assert(new ContainsTagWithAttribute('span', 'class', 'error'), $html);
}
public function test_error_text_blank() {
$html = $this->renderer->error_text('');
$this->assertEqual('', $html);
}
public function test_link_to_popup_empty_link() {
// Empty link object: link MUST have a text value
$link = new html_link();
$popupaction = new popup_action('click', 'http://test.com', 'my_popup');
$link->add_action($popupaction);
$this->expectException();
$html = $this->renderer->link_to_popup($link);
}
public function test_link_to_popup() {
$link = new html_link();
$link->text = 'Click here';
$link->url = 'http://test.com';
$link->title = 'Popup window';
$popupaction = new popup_action('click', 'http://test.com', 'my_popup');
$link->add_action($popupaction);
$html = $this->renderer->link_to_popup($link);
$expectedattributes = array('title' => 'Popup window', 'href' => 'http://test.com');
$this->assert(new ContainsTagWithAttributes('a', $expectedattributes), $html);
$this->assert(new ContainsTagWithContents('a', 'Click here'), $html);
// Try a different url for the link than for the popup
$link->url = 'http://otheraddress.com';
$html = $this->renderer->link_to_popup($link);
$this->assert(new ContainsTagWithAttribute('a', 'title', 'Popup window'), $html);
$this->assert(new ContainsTagWithAttribute('a', 'href', 'http://otheraddress.com'), $html);
$this->assert(new ContainsTagWithContents('a', 'Click here'), $html);
// Give it a moodle_url object instead of a string
$link->url = new moodle_url('http://otheraddress.com');
$html = $this->renderer->link_to_popup($link);
$this->assert(new ContainsTagWithAttribute('a', 'title', 'Popup window'), $html);
$this->assert(new ContainsTagWithAttribute('a', 'href', 'http://otheraddress.com'), $html);
$this->assert(new ContainsTagWithContents('a', 'Click here'), $html);
}
public function test_button() {
global $CFG;
$originalform = new html_form();
$originalform->button->text = 'Click Here';
$originalform->url = '/index.php';
$form = clone($originalform);
$html = $this->renderer->button($form);
$this->assert(new ContainsTagWithAttribute('div', 'class', 'singlebutton'), $html);
$this->assert(new ContainsTagWithAttributes('form', array('method' => 'post', 'action' => $CFG->wwwroot . '/index.php')), $html);
$this->assert(new ContainsTagWithAttributes('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey())), $html);
$this->assert(new ContainsTagWithAttributes('input', array('value' => 'Click Here', 'type' => 'submit')), $html);
$form = clone($originalform);
$form->button->confirmmessage = 'Are you sure?';
$html = $this->renderer->button($form);
$this->assert(new ContainsTagWithAttribute('div', 'class', 'singlebutton'), $html);
$this->assert(new ContainsTagWithAttributes('form', array('method' => 'post', 'action' => $CFG->wwwroot . '/index.php')), $html);
$this->assert(new ContainsTagWithAttribute('input', 'type', 'submit'), $html);
$form = clone($originalform);
$form->url = new moodle_url($form->url, array('var1' => 'value1', 'var2' => 'value2'));
$html = $this->renderer->button($form);
$this->assert(new ContainsTagWithAttributes('input', array('name' => 'var1', 'type' => 'hidden', 'value' => 'value1')), $html);
}
public function test_link() {
$link = new html_link();
$link->url = 'http://test.com';
$link->text = 'Resource 1';
$html = $this->renderer->link($link);
$this->assert(new ContainsTagWithAttribute('a', 'href', 'http://test.com'), $html);
$this->assert(new ContainsTagWithContents('a', 'Resource 1'), $html);
// Add a title
$link->title = 'Link to resource 1';
$html = $this->renderer->link($link);
$this->assert(new ContainsTagWithAttributes('a', array('title' => 'Link to resource 1', 'href' => 'http://test.com')), $html);
$this->assert(new ContainsTagWithContents('a', 'Resource 1'), $html);
// Use a moodle_url object instead of string
$link->url = new moodle_url($link->url);
$html = $this->renderer->link($link);
$this->assert(new ContainsTagWithAttributes('a', array('title' => 'Link to resource 1', 'href' => 'http://test.com')), $html);
$this->assert(new ContainsTagWithContents('a', 'Resource 1'), $html);
// Add a few classes to the link object
$link->add_classes('cool blue');
$html = $this->renderer->link($link);
$this->assert(new ContainsTagWithAttributes('a', array('title' => 'Link to resource 1', 'class' => 'cool blue', 'href' => 'http://test.com')), $html);
$this->assert(new ContainsTagWithContents('a', 'Resource 1'), $html);
// Simple use of link() without a html_link object
$html = $this->renderer->link($link->url->out(), $link->text);
$expected_html = '