[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 view_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\view_results
  34   */
  35  class view_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_view_results(): void {
  47  
  48          set_config('enableglobalsearch', true);
  49  
  50          $this->setAdminUser();
  51          // Trigger and capture the event.
  52          $sink = $this->redirectEvents();
  53  
  54          $result = view_results::execute('forum post', ['title' => 'My progress'], 1);
  55          $result = external_api::clean_returnvalue(view_results::execute_returns(), $result);
  56          $this->assertEmpty($result['warnings']);
  57          $this->assertTrue($result['status']);
  58  
  59          $events = $sink->get_events();
  60          $this->assertCount(1, $events);
  61          $event = array_shift($events);
  62          $sink->close();
  63  
  64          // Checking that the event contains the expected values.
  65          $this->assertInstanceOf('core\event\search_results_viewed', $event);
  66          $this->assertEventContextNotUsed($event);
  67          $this->assertNotEmpty($event->get_name());
  68          $this->assertEquals('forum post', $event->get_data()['other']['q']);
  69          $this->assertEquals('My progress', $event->get_data()['other']['title']);
  70          $this->assertEquals(1, $event->get_data()['other']['page']);
  71      }
  72  }