[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  namespace core_search\external;
  18  
  19  use core_external\external_api;
  20  
  21  defined('MOODLE_INTERNAL') || die();
  22  
  23  global $CFG;
  24  require_once($CFG->dirroot . '/webservice/tests/helpers.php');
  25  
  26  /**
  27   * Tests for the get_results external function.
  28   *
  29   * @package    core_search
  30   * @category   test
  31   * @copyright  2023 Juan Leyva (juan@moodle.com)
  32   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   * @coversDefaultClass \core_search\external\get_results
  34   */
  35  class get_results_test extends \externallib_advanced_testcase {
  36  
  37      public function setUp(): void {
  38          $this->resetAfterTest();
  39      }
  40  
  41      /**
  42       * test external api
  43       * @covers ::execute
  44       * @return void
  45       */
  46      public function test_external_get_results(): void {
  47  
  48          set_config('enableglobalsearch', true);
  49          set_config('searchengine', 'simpledb');
  50  
  51          $this->setAdminUser();
  52  
  53          // Test search not returning anything (nothing in the index yet).
  54          $return = external_api::clean_returnvalue(get_results::execute_returns(), get_results::execute('one'));
  55          $this->assertEquals(0, $return['totalcount']);
  56  
  57          // Create an index of searchable things.
  58          $generator = $this->getDataGenerator();
  59          $course = $generator->create_course(['fullname' => 'SearchTest course']);
  60          $anothercourse = $generator->create_course(['fullname' => 'Another']);
  61          $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
  62          $studentothercourse = $this->getDataGenerator()->create_and_enrol($anothercourse, 'student');
  63          $page = $generator->create_module('page', ['course' => $course->id, 'name' => 'SearchTest page']);
  64          $forum = $generator->create_module('forum', ['course' => $course->id]);
  65  
  66          $fgenerator = $generator->get_plugin_generator('mod_forum');
  67  
  68          for ($i = 0; $i < 15; $i++) {
  69              $fgenerator->create_discussion(
  70                  [
  71                      'course' => $course->id,
  72                      'forum' => $forum->id,
  73                      'userid' => $student->id,
  74                  ]
  75              );
  76          }
  77  
  78          $search = \core_search\manager::instance();
  79          $search->index();
  80  
  81          // Basic search, by text.
  82          $return = external_api::clean_returnvalue(get_results::execute_returns(), get_results::execute('page'));
  83          $this->assertEquals(1, $return['totalcount']);
  84          $this->assertEquals('activity', $return['results'][0]['areaname']);
  85          $this->assertEquals($page->name, $return['results'][0]['title']);
  86  
  87          // Basic search, by name containing text.
  88          $return = external_api::clean_returnvalue(get_results::execute_returns(), get_results::execute('SearchTest'));
  89          $this->assertEquals(2, $return['totalcount']);
  90  
  91          // Test pagination.
  92          $return = external_api::clean_returnvalue(get_results::execute_returns(), get_results::execute('discussion', [], 0));
  93          $this->assertCount(10, $return['results']);  // The first 10 posts of a total of 15 for the second page.
  94          $this->assertEquals(15, $return['totalcount']);
  95  
  96          $return = external_api::clean_returnvalue(get_results::execute_returns(), get_results::execute('discussion', [], 1));
  97          $this->assertCount(5, $return['results']);  // The last 5 posts of a total of 15 for the second page.
  98          $this->assertEquals(15, $return['totalcount']);
  99  
 100          // Test some filters.
 101          $return = external_api::clean_returnvalue(get_results::execute_returns(),
 102              get_results::execute('discussion', ['title' => 'Discussion 11']));
 103          $this->assertEquals(1, $return['totalcount']);
 104  
 105          // No discussions created in the future.
 106          $return = external_api::clean_returnvalue(get_results::execute_returns(),
 107              get_results::execute('discussion', ['timestart' => time() + DAYSECS]));
 108          $this->assertEquals(0, $return['totalcount']);
 109  
 110          // Basic permissions check.
 111          $this->setUser($studentothercourse);
 112          $return = external_api::clean_returnvalue(get_results::execute_returns(), get_results::execute('discussion', [], 1));
 113          $this->assertCount(0, $return['results']);  // I should not see other courses discussions.
 114      }
 115  }