. /** * Tests for the parts of ../filterlib.php that involve loading the configuration * from, and saving the configuration to, the database. * * @package core_filter * @category phpunit * @copyright 2009 Tim Hunt * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->libdir . '/filterlib.php'); /** * Test filters. */ class core_filterlib_testcase extends advanced_testcase { private $syscontext; private $childcontext; private $childcontext2; private $catcontext; private $coursecontext; private $course; private $activity1context; private $activity2context; protected function setUp() { global $DB; parent::setUp(); $this->resetAfterTest(); $DB->delete_records('filter_active', array()); $DB->delete_records('filter_config', array()); } private function assert_only_one_filter_globally($filter, $state) { global $DB; $recs = $DB->get_records('filter_active'); $this->assertCount(1, $recs); $rec = reset($recs); unset($rec->id); $expectedrec = new stdClass(); $expectedrec->filter = $filter; $expectedrec->contextid = context_system::instance()->id; $expectedrec->active = $state; $expectedrec->sortorder = 1; $this->assertEquals($expectedrec, $rec); } private function assert_global_sort_order($filters) { global $DB; $sortedfilters = $DB->get_records_menu('filter_active', array('contextid' => context_system::instance()->id), 'sortorder', 'sortorder,filter'); $testarray = array(); $index = 1; foreach ($filters as $filter) { $testarray[$index++] = $filter; } $this->assertEquals($testarray, $sortedfilters); } public function test_set_filter_globally_on() { // Setup fixture. // Exercise SUT. filter_set_global_state('name', TEXTFILTER_ON); // Validate. $this->assert_only_one_filter_globally('name', TEXTFILTER_ON); } public function test_set_filter_globally_off() { // Setup fixture. // Exercise SUT. filter_set_global_state('name', TEXTFILTER_OFF); // Validate. $this->assert_only_one_filter_globally('name', TEXTFILTER_OFF); } public function test_set_filter_globally_disabled() { // Setup fixture. // Exercise SUT. filter_set_global_state('name', TEXTFILTER_DISABLED); // Validate. $this->assert_only_one_filter_globally('name', TEXTFILTER_DISABLED); } /** * @expectedException coding_exception */ public function test_global_config_exception_on_invalid_state() { filter_set_global_state('name', 0); } public function test_auto_sort_order() { // Setup fixture. // Exercise SUT. filter_set_global_state('one', TEXTFILTER_DISABLED); filter_set_global_state('two', TEXTFILTER_DISABLED); // Validate. $this->assert_global_sort_order(array('one', 'two')); } public function test_auto_sort_order_enabled() { // Setup fixture. // Exercise SUT. filter_set_global_state('one', TEXTFILTER_ON); filter_set_global_state('two', TEXTFILTER_OFF); // Validate. $this->assert_global_sort_order(array('one', 'two')); } public function test_update_existing_dont_duplicate() { // Setup fixture. // Exercise SUT. filter_set_global_state('name', TEXTFILTER_ON); filter_set_global_state('name', TEXTFILTER_OFF); // Validate. $this->assert_only_one_filter_globally('name', TEXTFILTER_OFF); } public function test_update_reorder_down() { // Setup fixture. filter_set_global_state('one', TEXTFILTER_ON); filter_set_global_state('two', TEXTFILTER_ON); filter_set_global_state('three', TEXTFILTER_ON); // Exercise SUT. filter_set_global_state('two', TEXTFILTER_ON, -1); // Validate. $this->assert_global_sort_order(array('two', 'one', 'three')); } public function test_update_reorder_up() { // Setup fixture. filter_set_global_state('one', TEXTFILTER_ON); filter_set_global_state('two', TEXTFILTER_ON); filter_set_global_state('three', TEXTFILTER_ON); filter_set_global_state('four', TEXTFILTER_ON); // Exercise SUT. filter_set_global_state('two', TEXTFILTER_ON, 1); // Validate. $this->assert_global_sort_order(array('one', 'three', 'two', 'four')); } public function test_auto_sort_order_change_to_enabled() { // Setup fixture. filter_set_global_state('one', TEXTFILTER_ON); filter_set_global_state('two', TEXTFILTER_DISABLED); filter_set_global_state('three', TEXTFILTER_DISABLED); // Exercise SUT. filter_set_global_state('three', TEXTFILTER_ON); // Validate. $this->assert_global_sort_order(array('one', 'three', 'two')); } public function test_auto_sort_order_change_to_disabled() { // Setup fixture. filter_set_global_state('one', TEXTFILTER_ON); filter_set_global_state('two', TEXTFILTER_ON); filter_set_global_state('three', TEXTFILTER_DISABLED); // Exercise SUT. filter_set_global_state('one', TEXTFILTER_DISABLED); // Validate. $this->assert_global_sort_order(array('two', 'one', 'three')); } public function test_filter_get_global_states() { // Setup fixture. filter_set_global_state('one', TEXTFILTER_ON); filter_set_global_state('two', TEXTFILTER_OFF); filter_set_global_state('three', TEXTFILTER_DISABLED); // Exercise SUT. $filters = filter_get_global_states(); // Validate. $this->assertEquals(array( 'one' => (object) array('filter' => 'one', 'active' => TEXTFILTER_ON, 'sortorder' => 1), 'two' => (object) array('filter' => 'two', 'active' => TEXTFILTER_OFF, 'sortorder' => 2), 'three' => (object) array('filter' => 'three', 'active' => TEXTFILTER_DISABLED, 'sortorder' => 3) ), $filters); } private function assert_only_one_local_setting($filter, $contextid, $state) { global $DB; $recs = $DB->get_records('filter_active'); $this->assertEquals(1, count($recs), 'More than one record returned %s.'); $rec = reset($recs); unset($rec->id); unset($rec->sortorder); $expectedrec = new stdClass(); $expectedrec->filter = $filter; $expectedrec->contextid = $contextid; $expectedrec->active = $state; $this->assertEquals($expectedrec, $rec); } private function assert_no_local_setting() { global $DB; $this->assertEquals(0, $DB->count_records('filter_active')); } public function test_local_on() { // Exercise SUT. filter_set_local_state('name', 123, TEXTFILTER_ON); // Validate. $this->assert_only_one_local_setting('name', 123, TEXTFILTER_ON); } public function test_local_off() { // Exercise SUT. filter_set_local_state('name', 123, TEXTFILTER_OFF); // Validate. $this->assert_only_one_local_setting('name', 123, TEXTFILTER_OFF); } public function test_local_inherit() { // Exercise SUT. filter_set_local_state('name', 123, TEXTFILTER_INHERIT); // Validate. $this->assert_no_local_setting(); } /** * @expectedException coding_exception */ public function test_local_invalid_state_throws_exception() { // Exercise SUT. filter_set_local_state('name', 123, -9999); } /** * @expectedException coding_exception */ public function test_throws_exception_when_setting_global() { // Exercise SUT. filter_set_local_state('name', context_system::instance()->id, TEXTFILTER_INHERIT); } public function test_local_inherit_deletes_existing() { // Setup fixture. filter_set_local_state('name', 123, TEXTFILTER_INHERIT); // Exercise SUT. filter_set_local_state('name', 123, TEXTFILTER_INHERIT); // Validate. $this->assert_no_local_setting(); } private function assert_only_one_config($filter, $context, $name, $value) { global $DB; $recs = $DB->get_records('filter_config'); $this->assertEquals(1, count($recs), 'More than one record returned %s.'); $rec = reset($recs); unset($rec->id); $expectedrec = new stdClass(); $expectedrec->filter = $filter; $expectedrec->contextid = $context; $expectedrec->name = $name; $expectedrec->value = $value; $this->assertEquals($expectedrec, $rec); } public function test_set_new_config() { // Exercise SUT. filter_set_local_config('name', 123, 'settingname', 'An arbitrary value'); // Validate. $this->assert_only_one_config('name', 123, 'settingname', 'An arbitrary value'); } public function test_update_existing_config() { // Setup fixture. filter_set_local_config('name', 123, 'settingname', 'An arbitrary value'); // Exercise SUT. filter_set_local_config('name', 123, 'settingname', 'A changed value'); // Validate. $this->assert_only_one_config('name', 123, 'settingname', 'A changed value'); } public function test_filter_get_local_config() { // Setup fixture. filter_set_local_config('name', 123, 'setting1', 'An arbitrary value'); filter_set_local_config('name', 123, 'setting2', 'Another arbitrary value'); filter_set_local_config('name', 122, 'settingname', 'Value from another context'); filter_set_local_config('other', 123, 'settingname', 'Someone else\'s value'); // Exercise SUT. $config = filter_get_local_config('name', 123); // Validate. $this->assertEquals(array('setting1' => 'An arbitrary value', 'setting2' => 'Another arbitrary value'), $config); } protected function setup_available_in_context_tests() { $course = $this->getDataGenerator()->create_course(array('category'=>1)); $this->childcontext = context_coursecat::instance(1); $this->childcontext2 = context_course::instance($course->id); $this->syscontext = context_system::instance(); } private function assert_filter_list($expectedfilters, $filters) { $this->setup_available_in_context_tests(); $this->assertEquals($expectedfilters, array_keys($filters), '', 0, 10, true); } public function test_globally_on_is_returned() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); // Exercise SUT. $filters = filter_get_active_in_context($this->syscontext); // Validate. $this->assert_filter_list(array('name'), $filters); // Check no config returned correctly. $this->assertEquals(array(), $filters['name']); } public function test_globally_off_not_returned() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_OFF); // Exercise SUT. $filters = filter_get_active_in_context($this->childcontext2); // Validate. $this->assert_filter_list(array(), $filters); } public function test_globally_off_overridden() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_OFF); filter_set_local_state('name', $this->childcontext->id, TEXTFILTER_ON); // Exercise SUT. $filters = filter_get_active_in_context($this->childcontext2); // Validate. $this->assert_filter_list(array('name'), $filters); } public function test_globally_on_overridden() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_state('name', $this->childcontext->id, TEXTFILTER_OFF); // Exercise SUT. $filters = filter_get_active_in_context($this->childcontext2); // Validate. $this->assert_filter_list(array(), $filters); } public function test_globally_disabled_not_overridden() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_DISABLED); filter_set_local_state('name', $this->childcontext->id, TEXTFILTER_ON); // Exercise SUT. $filters = filter_get_active_in_context($this->syscontext); // Validate. $this->assert_filter_list(array(), $filters); } public function test_single_config_returned() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_config('name', $this->childcontext->id, 'settingname', 'A value'); // Exercise SUT. $filters = filter_get_active_in_context($this->childcontext); // Validate. $this->assertEquals(array('settingname' => 'A value'), $filters['name']); } public function test_multi_config_returned() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_config('name', $this->childcontext->id, 'settingname', 'A value'); filter_set_local_config('name', $this->childcontext->id, 'anothersettingname', 'Another value'); // Exercise SUT. $filters = filter_get_active_in_context($this->childcontext); // Validate. $this->assertEquals(array('settingname' => 'A value', 'anothersettingname' => 'Another value'), $filters['name']); } public function test_config_from_other_context_not_returned() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_config('name', $this->childcontext->id, 'settingname', 'A value'); filter_set_local_config('name', $this->childcontext2->id, 'anothersettingname', 'Another value'); // Exercise SUT. $filters = filter_get_active_in_context($this->childcontext2); // Validate. $this->assertEquals(array('anothersettingname' => 'Another value'), $filters['name']); } public function test_config_from_other_filter_not_returned() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_config('name', $this->childcontext->id, 'settingname', 'A value'); filter_set_local_config('other', $this->childcontext->id, 'anothersettingname', 'Another value'); // Exercise SUT. $filters = filter_get_active_in_context($this->childcontext); // Validate. $this->assertEquals(array('settingname' => 'A value'), $filters['name']); } protected function assert_one_available_filter($filter, $localstate, $inheritedstate, $filters) { $this->setup_available_in_context_tests(); $this->assertEquals(1, count($filters), 'More than one record returned %s.'); $rec = $filters[$filter]; unset($rec->id); $expectedrec = new stdClass(); $expectedrec->filter = $filter; $expectedrec->localstate = $localstate; $expectedrec->inheritedstate = $inheritedstate; $this->assertEquals($expectedrec, $rec); } public function test_available_in_context_localoverride() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_state('name', $this->childcontext->id, TEXTFILTER_OFF); // Exercise SUT. $filters = filter_get_available_in_context($this->childcontext); // Validate. $this->assert_one_available_filter('name', TEXTFILTER_OFF, TEXTFILTER_ON, $filters); } public function test_available_in_context_nolocaloverride() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_state('name', $this->childcontext->id, TEXTFILTER_OFF); // Exercise SUT. $filters = filter_get_available_in_context($this->childcontext2); // Validate. $this->assert_one_available_filter('name', TEXTFILTER_INHERIT, TEXTFILTER_OFF, $filters); } public function test_available_in_context_disabled_not_returned() { $this->setup_available_in_context_tests(); // Setup fixture. filter_set_global_state('name', TEXTFILTER_DISABLED); filter_set_local_state('name', $this->childcontext->id, TEXTFILTER_ON); // Exercise SUT. $filters = filter_get_available_in_context($this->childcontext); // Validate. $this->assertEquals(array(), $filters); } /** * @expectedException coding_exception */ public function test_available_in_context_exception_with_syscontext() { $this->setup_available_in_context_tests(); // Exercise SUT. filter_get_available_in_context($this->syscontext); } protected function setup_preload_activities_test() { $this->syscontext = context_system::instance(); $this->catcontext = context_coursecat::instance(1); $this->course = $this->getDataGenerator()->create_course(array('category'=>1)); $this->coursecontext = context_course::instance($this->course->id); $page1 = $this->getDataGenerator()->create_module('page', array('course'=>$this->course->id)); $this->activity1context = context_module::instance($page1->cmid); $page2 = $this->getDataGenerator()->create_module('page', array('course'=>$this->course->id)); $this->activity2context = context_module::instance($page2->cmid); } private function assert_matches($modinfo) { global $FILTERLIB_PRIVATE, $DB; // Use preload cache... $FILTERLIB_PRIVATE = new stdClass(); filter_preload_activities($modinfo); // Get data and check no queries are made. $before = $DB->perf_get_reads(); $plfilters1 = filter_get_active_in_context($this->activity1context); $plfilters2 = filter_get_active_in_context($this->activity2context); $after = $DB->perf_get_reads(); $this->assertEquals($before, $after); // Repeat without cache and check it makes queries now. $FILTERLIB_PRIVATE = new stdClass; $before = $DB->perf_get_reads(); $filters1 = filter_get_active_in_context($this->activity1context); $filters2 = filter_get_active_in_context($this->activity2context); $after = $DB->perf_get_reads(); $this->assertTrue($after > $before); // Check they match. $this->assertEquals($plfilters1, $filters1); $this->assertEquals($plfilters2, $filters2); } public function test_preload() { $this->setup_preload_activities_test(); // Get course and modinfo. $modinfo = new course_modinfo($this->course, 2); // Note: All the tests in this function check that the result from the // preloaded cache is the same as the result from calling the standard // function without preloading. // Initially, check with no filters enabled. $this->assert_matches($modinfo); // Enable filter globally, check. filter_set_global_state('name', TEXTFILTER_ON); $this->assert_matches($modinfo); // Disable for activity 2. filter_set_local_state('name', $this->activity2context->id, TEXTFILTER_OFF); $this->assert_matches($modinfo); // Disable at category. filter_set_local_state('name', $this->catcontext->id, TEXTFILTER_OFF); $this->assert_matches($modinfo); // Enable for activity 1. filter_set_local_state('name', $this->activity1context->id, TEXTFILTER_ON); $this->assert_matches($modinfo); // Disable globally. filter_set_global_state('name', TEXTFILTER_DISABLED); $this->assert_matches($modinfo); // Add another 2 filters. filter_set_global_state('frog', TEXTFILTER_ON); filter_set_global_state('zombie', TEXTFILTER_ON); $this->assert_matches($modinfo); // Disable random one of these in each context. filter_set_local_state('zombie', $this->activity1context->id, TEXTFILTER_OFF); filter_set_local_state('frog', $this->activity2context->id, TEXTFILTER_OFF); $this->assert_matches($modinfo); // Now do some filter options. filter_set_local_config('name', $this->activity1context->id, 'a', 'x'); filter_set_local_config('zombie', $this->activity1context->id, 'a', 'y'); filter_set_local_config('frog', $this->activity1context->id, 'a', 'z'); // These last two don't do anything as they are not at final level but I // thought it would be good to have that verified in test. filter_set_local_config('frog', $this->coursecontext->id, 'q', 'x'); filter_set_local_config('frog', $this->catcontext->id, 'q', 'z'); $this->assert_matches($modinfo); } public function test_filter_delete_all_for_filter() { global $DB; // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_global_state('other', TEXTFILTER_ON); filter_set_local_config('name', context_system::instance()->id, 'settingname', 'A value'); filter_set_local_config('other', context_system::instance()->id, 'settingname', 'Other value'); set_config('configname', 'A config value', 'filter_name'); set_config('configname', 'Other config value', 'filter_other'); // Exercise SUT. filter_delete_all_for_filter('name'); // Validate. $this->assertEquals(1, $DB->count_records('filter_active')); $this->assertTrue($DB->record_exists('filter_active', array('filter' => 'other'))); $this->assertEquals(1, $DB->count_records('filter_config')); $this->assertTrue($DB->record_exists('filter_config', array('filter' => 'other'))); $expectedconfig = new stdClass; $expectedconfig->configname = 'Other config value'; $this->assertEquals($expectedconfig, get_config('filter_other')); $this->assertEquals(get_config('filter_name'), new stdClass()); } public function test_filter_delete_all_for_context() { global $DB; // Setup fixture. filter_set_global_state('name', TEXTFILTER_ON); filter_set_local_state('name', 123, TEXTFILTER_OFF); filter_set_local_config('name', 123, 'settingname', 'A value'); filter_set_local_config('other', 123, 'settingname', 'Other value'); filter_set_local_config('other', 122, 'settingname', 'Other value'); // Exercise SUT. filter_delete_all_for_context(123); // Validate. $this->assertEquals(1, $DB->count_records('filter_active')); $this->assertTrue($DB->record_exists('filter_active', array('contextid' => context_system::instance()->id))); $this->assertEquals(1, $DB->count_records('filter_config')); $this->assertTrue($DB->record_exists('filter_config', array('filter' => 'other'))); } public function test_set() { global $CFG; $this->assertFileExists("$CFG->dirroot/filter/emailprotect"); // Any standard filter. $this->assertFileExists("$CFG->dirroot/filter/tidy"); // Any standard filter. $this->assertFileNotExists("$CFG->dirroot/filter/grgrggr"); // Any non-existent filter // Setup fixture. set_config('filterall', 0); set_config('stringfilters', ''); // Exercise SUT. filter_set_applies_to_strings('tidy', true); // Validate. $this->assertEquals('tidy', $CFG->stringfilters); $this->assertEquals(1, $CFG->filterall); filter_set_applies_to_strings('grgrggr', true); $this->assertEquals('tidy', $CFG->stringfilters); $this->assertEquals(1, $CFG->filterall); filter_set_applies_to_strings('emailprotect', true); $this->assertEquals('tidy,emailprotect', $CFG->stringfilters); $this->assertEquals(1, $CFG->filterall); } public function test_unset_to_empty() { global $CFG; $this->assertFileExists("$CFG->dirroot/filter/tidy"); // Any standard filter. // Setup fixture. set_config('filterall', 1); set_config('stringfilters', 'tidy'); // Exercise SUT. filter_set_applies_to_strings('tidy', false); // Validate. $this->assertEquals('', $CFG->stringfilters); $this->assertEquals('', $CFG->filterall); } public function test_unset_multi() { global $CFG; $this->assertFileExists("$CFG->dirroot/filter/emailprotect"); // Any standard filter. $this->assertFileExists("$CFG->dirroot/filter/tidy"); // Any standard filter. $this->assertFileExists("$CFG->dirroot/filter/multilang"); // Any standard filter. // Setup fixture. set_config('filterall', 1); set_config('stringfilters', 'emailprotect,tidy,multilang'); // Exercise SUT. filter_set_applies_to_strings('tidy', false); // Validate. $this->assertEquals('emailprotect,multilang', $CFG->stringfilters); $this->assertEquals(1, $CFG->filterall); } public function test_filter_manager_instance() { set_config('perfdebug', 7); filter_manager::reset_caches(); $filterman = filter_manager::instance(); $this->assertInstanceOf('filter_manager', $filterman); $this->assertNotInstanceOf('performance_measuring_filter_manager', $filterman); set_config('perfdebug', 15); filter_manager::reset_caches(); $filterman = filter_manager::instance(); $this->assertInstanceOf('filter_manager', $filterman); $this->assertInstanceOf('performance_measuring_filter_manager', $filterman); } }