123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272 |
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * Search manager unit tests.
- *
- * @package core_search
- * @category phpunit
- * @copyright 2015 David Monllao {@link http://www.davidmonllao.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- defined('MOODLE_INTERNAL') || die();
- require_once(__DIR__ . '/fixtures/testable_core_search.php');
- require_once(__DIR__ . '/fixtures/mock_search_area.php');
- /**
- * Unit tests for search manager.
- *
- * @package core_search
- * @category phpunit
- * @copyright 2015 David Monllao {@link http://www.davidmonllao.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class search_manager_testcase extends advanced_testcase {
- protected $forumpostareaid = null;
- protected $mycoursesareaid = null;
- public function setUp() {
- $this->forumpostareaid = \core_search\manager::generate_areaid('mod_forum', 'post');
- $this->mycoursesareaid = \core_search\manager::generate_areaid('core_course', 'mycourse');
- }
- public function test_search_enabled() {
- $this->resetAfterTest();
- // Disabled by default.
- $this->assertFalse(\core_search\manager::is_global_search_enabled());
- set_config('enableglobalsearch', true);
- $this->assertTrue(\core_search\manager::is_global_search_enabled());
- set_config('enableglobalsearch', false);
- $this->assertFalse(\core_search\manager::is_global_search_enabled());
- }
- public function test_search_areas() {
- global $CFG;
- $this->resetAfterTest();
- set_config('enableglobalsearch', true);
- $fakeareaid = \core_search\manager::generate_areaid('mod_unexisting', 'chihuaquita');
- $searcharea = \core_search\manager::get_search_area($this->forumpostareaid);
- $this->assertInstanceOf('\core_search\base', $searcharea);
- $this->assertFalse(\core_search\manager::get_search_area($fakeareaid));
- $this->assertArrayHasKey($this->forumpostareaid, \core_search\manager::get_search_areas_list());
- $this->assertArrayNotHasKey($fakeareaid, \core_search\manager::get_search_areas_list());
- // Enabled by default once global search is enabled.
- $this->assertArrayHasKey($this->forumpostareaid, \core_search\manager::get_search_areas_list(true));
- list($componentname, $varname) = $searcharea->get_config_var_name();
- set_config($varname . '_enabled', 0, $componentname);
- \core_search\manager::clear_static();
- $this->assertArrayNotHasKey('mod_forum', \core_search\manager::get_search_areas_list(true));
- set_config($varname . '_enabled', 1, $componentname);
- // Although the result is wrong, we want to check that \core_search\manager::get_search_areas_list returns cached results.
- $this->assertArrayNotHasKey($this->forumpostareaid, \core_search\manager::get_search_areas_list(true));
- // Now we check the real result.
- \core_search\manager::clear_static();
- $this->assertArrayHasKey($this->forumpostareaid, \core_search\manager::get_search_areas_list(true));
- }
- public function test_search_config() {
- $this->resetAfterTest();
- $search = testable_core_search::instance();
- // We should test both plugin types and core subsystems. No core subsystems available yet.
- $searcharea = $search->get_search_area($this->forumpostareaid);
- list($componentname, $varname) = $searcharea->get_config_var_name();
- // Just with a couple of vars should be enough.
- $start = time() - 100;
- $end = time();
- set_config($varname . '_indexingstart', $start, $componentname);
- set_config($varname . '_indexingend', $end, $componentname);
- $configs = $search->get_areas_config(array($this->forumpostareaid => $searcharea));
- $this->assertEquals($start, $configs[$this->forumpostareaid]->indexingstart);
- $this->assertEquals($end, $configs[$this->forumpostareaid]->indexingend);
- try {
- $fakeareaid = \core_search\manager::generate_areaid('mod_unexisting', 'chihuaquita');
- $search->reset_config($fakeareaid);
- $this->fail('An exception should be triggered if the provided search area does not exist.');
- } catch (moodle_exception $ex) {
- $this->assertContains($fakeareaid . ' search area is not available.', $ex->getMessage());
- }
- // We clean it all but enabled components.
- $search->reset_config($this->forumpostareaid);
- $config = $searcharea->get_config();
- $this->assertEquals(1, $config[$varname . '_enabled']);
- $this->assertEquals(0, $config[$varname . '_indexingstart']);
- $this->assertEquals(0, $config[$varname . '_indexingend']);
- $this->assertEquals(0, $config[$varname . '_lastindexrun']);
- // No caching.
- $configs = $search->get_areas_config(array($this->forumpostareaid => $searcharea));
- $this->assertEquals(0, $configs[$this->forumpostareaid]->indexingstart);
- $this->assertEquals(0, $configs[$this->forumpostareaid]->indexingend);
- set_config($varname . '_indexingstart', $start, $componentname);
- set_config($varname . '_indexingend', $end, $componentname);
- // All components config should be reset.
- $search->reset_config();
- $this->assertEquals(0, get_config($componentname, $varname . '_indexingstart'));
- $this->assertEquals(0, get_config($componentname, $varname . '_indexingend'));
- $this->assertEquals(0, get_config($componentname, $varname . '_lastindexrun'));
- // No caching.
- $configs = $search->get_areas_config(array($this->forumpostareaid => $searcharea));
- $this->assertEquals(0, $configs[$this->forumpostareaid]->indexingstart);
- $this->assertEquals(0, $configs[$this->forumpostareaid]->indexingend);
- }
- /**
- * Adding this test here as get_areas_user_accesses process is the same, results just depend on the context level.
- *
- * @return void
- */
- public function test_search_user_accesses() {
- global $DB;
- $this->resetAfterTest();
- $frontpage = $DB->get_record('course', array('id' => SITEID));
- $course1 = $this->getDataGenerator()->create_course();
- $course1ctx = context_course::instance($course1->id);
- $course2 = $this->getDataGenerator()->create_course();
- $course2ctx = context_course::instance($course2->id);
- $teacher = $this->getDataGenerator()->create_user();
- $teacherctx = context_user::instance($teacher->id);
- $student = $this->getDataGenerator()->create_user();
- $studentctx = context_user::instance($student->id);
- $noaccess = $this->getDataGenerator()->create_user();
- $noaccessctx = context_user::instance($noaccess->id);
- $this->getDataGenerator()->enrol_user($teacher->id, $course1->id, 'teacher');
- $this->getDataGenerator()->enrol_user($student->id, $course1->id, 'student');
- $frontpageforum = $this->getDataGenerator()->create_module('forum', array('course' => $frontpage->id));
- $forum1 = $this->getDataGenerator()->create_module('forum', array('course' => $course1->id));
- $forum2 = $this->getDataGenerator()->create_module('forum', array('course' => $course1->id));
- $forum3 = $this->getDataGenerator()->create_module('forum', array('course' => $course2->id));
- $frontpageforumcontext = context_module::instance($frontpageforum->cmid);
- $context1 = context_module::instance($forum1->cmid);
- $context2 = context_module::instance($forum2->cmid);
- $context3 = context_module::instance($forum3->cmid);
- $search = testable_core_search::instance();
- $mockareaid = \core_search\manager::generate_areaid('core_mocksearch', 'mock_search_area');
- $search->add_core_search_areas();
- $search->add_search_area($mockareaid, new core_mocksearch\search\mock_search_area());
- $this->setAdminUser();
- $this->assertTrue($search->get_areas_user_accesses());
- $sitectx = \context_course::instance(SITEID);
- $systemctxid = \context_system::instance()->id;
- // Can access the frontpage ones.
- $this->setUser($noaccess);
- $contexts = $search->get_areas_user_accesses();
- $this->assertEquals(array($frontpageforumcontext->id => $frontpageforumcontext->id), $contexts[$this->forumpostareaid]);
- $this->assertEquals(array($sitectx->id => $sitectx->id), $contexts[$this->mycoursesareaid]);
- $mockctxs = array($noaccessctx->id => $noaccessctx->id, $systemctxid => $systemctxid);
- $this->assertEquals($mockctxs, $contexts[$mockareaid]);
- $this->setUser($teacher);
- $contexts = $search->get_areas_user_accesses();
- $frontpageandcourse1 = array($frontpageforumcontext->id => $frontpageforumcontext->id, $context1->id => $context1->id,
- $context2->id => $context2->id);
- $this->assertEquals($frontpageandcourse1, $contexts[$this->forumpostareaid]);
- $this->assertEquals(array($sitectx->id => $sitectx->id, $course1ctx->id => $course1ctx->id),
- $contexts[$this->mycoursesareaid]);
- $mockctxs = array($teacherctx->id => $teacherctx->id, $systemctxid => $systemctxid);
- $this->assertEquals($mockctxs, $contexts[$mockareaid]);
- $this->setUser($student);
- $contexts = $search->get_areas_user_accesses();
- $this->assertEquals($frontpageandcourse1, $contexts[$this->forumpostareaid]);
- $this->assertEquals(array($sitectx->id => $sitectx->id, $course1ctx->id => $course1ctx->id),
- $contexts[$this->mycoursesareaid]);
- $mockctxs = array($studentctx->id => $studentctx->id, $systemctxid => $systemctxid);
- $this->assertEquals($mockctxs, $contexts[$mockareaid]);
- // Hide the activity.
- set_coursemodule_visible($forum2->cmid, 0);
- $contexts = $search->get_areas_user_accesses();
- $this->assertEquals(array($frontpageforumcontext->id => $frontpageforumcontext->id, $context1->id => $context1->id),
- $contexts[$this->forumpostareaid]);
- // Now test course limited searches.
- set_coursemodule_visible($forum2->cmid, 1);
- $this->getDataGenerator()->enrol_user($student->id, $course2->id, 'student');
- $contexts = $search->get_areas_user_accesses();
- $allcontexts = array($frontpageforumcontext->id => $frontpageforumcontext->id, $context1->id => $context1->id,
- $context2->id => $context2->id, $context3->id => $context3->id);
- $this->assertEquals($allcontexts, $contexts[$this->forumpostareaid]);
- $this->assertEquals(array($sitectx->id => $sitectx->id, $course1ctx->id => $course1ctx->id,
- $course2ctx->id => $course2ctx->id), $contexts[$this->mycoursesareaid]);
- $contexts = $search->get_areas_user_accesses(array($course1->id, $course2->id));
- $allcontexts = array($context1->id => $context1->id, $context2->id => $context2->id, $context3->id => $context3->id);
- $this->assertEquals($allcontexts, $contexts[$this->forumpostareaid]);
- $this->assertEquals(array($course1ctx->id => $course1ctx->id,
- $course2ctx->id => $course2ctx->id), $contexts[$this->mycoursesareaid]);
- $contexts = $search->get_areas_user_accesses(array($course2->id));
- $allcontexts = array($context3->id => $context3->id);
- $this->assertEquals($allcontexts, $contexts[$this->forumpostareaid]);
- $this->assertEquals(array($course2ctx->id => $course2ctx->id), $contexts[$this->mycoursesareaid]);
- $contexts = $search->get_areas_user_accesses(array($course1->id));
- $allcontexts = array($context1->id => $context1->id, $context2->id => $context2->id);
- $this->assertEquals($allcontexts, $contexts[$this->forumpostareaid]);
- $this->assertEquals(array($course1ctx->id => $course1ctx->id), $contexts[$this->mycoursesareaid]);
- }
- /**
- * test_is_search_area
- *
- * @return void
- */
- public function test_is_search_area() {
- $this->assertFalse(testable_core_search::is_search_area('\asd\asd'));
- $this->assertFalse(testable_core_search::is_search_area('\mod_forum\search\posta'));
- $this->assertFalse(testable_core_search::is_search_area('\core_search\base_mod'));
- $this->assertTrue(testable_core_search::is_search_area('\mod_forum\search\post'));
- $this->assertTrue(testable_core_search::is_search_area('\\mod_forum\\search\\post'));
- $this->assertTrue(testable_core_search::is_search_area('mod_forum\\search\\post'));
- }
- }
|