[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_top_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_top_results
  34   */
  35  class get_top_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_top_results(): void {
  47  
  48          set_config('enableglobalsearch', true);
  49          set_config('searchenablecategories', true); // Required for top search.
  50          set_config('searchmaxtopresults', 5); // Change default.
  51          set_config('searchengine', 'simpledb');
  52  
  53          $this->setAdminUser();
  54  
  55          // Create an index of searchable things.
  56          $generator = $this->getDataGenerator();
  57          $course = $generator->create_course(['fullname' => 'SearchTest course']);
  58          $student = $this->getDataGenerator()->create_and_enrol($course, 'student');
  59          $forum = $generator->create_module('forum', ['course' => $course->id]);
  60          $fgenerator = $generator->get_plugin_generator('mod_forum');
  61  
  62          for ($i = 0; $i < 15; $i++) {
  63              $fgenerator->create_discussion(
  64                  [
  65                      'course' => $course->id,
  66                      'forum' => $forum->id,
  67                      'userid' => $student->id,
  68                  ]
  69              );
  70          }
  71  
  72          $search = \core_search\manager::instance();
  73          $search->index();
  74  
  75          // Test top results.
  76          $return = external_api::clean_returnvalue(get_top_results::execute_returns(), get_top_results::execute('discussion', []));
  77          $this->assertCount(5, $return['results']);  // We get the 5 top results according to searchmaxtopresults setting value.
  78  
  79          set_config('searchmaxtopresults', 3); // Change to 3 top.
  80          $return = external_api::clean_returnvalue(get_top_results::execute_returns(), get_top_results::execute('discussion', []));
  81          $this->assertCount(3, $return['results']);
  82  
  83          // Test some filters.
  84          $return = external_api::clean_returnvalue(get_top_results::execute_returns(),
  85              get_top_results::execute('discussion', ['title' => 'Discussion 11']));
  86          $this->assertCount(1, $return['results']);
  87  
  88          set_config('searchenablecategories', false);    // Disable top search.
  89          $return = external_api::clean_returnvalue(get_top_results::execute_returns(), get_top_results::execute('discussion', []));
  90          $this->assertCount(0, $return['results']);
  91      }
  92  }