Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
<?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/>.

namespace mod_book;

> use core_external\external_api;
use externallib_advanced_testcase; use mod_book_external; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * External mod_book functions unit tests * * @package mod_book * @category external * @copyright 2015 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 3.0 */ class externallib_test extends externallib_advanced_testcase { /** * Test view_book */ public function test_view_book() { global $DB; $this->resetAfterTest(true); $this->setAdminUser(); // Setup test data. $course = $this->getDataGenerator()->create_course(); $book = $this->getDataGenerator()->create_module('book', array('course' => $course->id)); $bookgenerator = $this->getDataGenerator()->get_plugin_generator('mod_book'); $chapter = $bookgenerator->create_chapter(array('bookid' => $book->id)); $chapterhidden = $bookgenerator->create_chapter(array('bookid' => $book->id, 'hidden' => 1)); $context = \context_module::instance($book->cmid); $cm = get_coursemodule_from_instance('book', $book->id); // Test invalid instance id. try { mod_book_external::view_book(0); $this->fail('Exception expected due to invalid mod_book instance id.'); } catch (\moodle_exception $e) { $this->assertEquals('invalidrecord', $e->errorcode); } // Test not-enrolled user. $user = self::getDataGenerator()->create_user(); $this->setUser($user); try { mod_book_external::view_book($book->id, 0); $this->fail('Exception expected due to not enrolled user.'); } catch (\moodle_exception $e) { $this->assertEquals('requireloginerror', $e->errorcode); } // Test user with full capabilities. $studentrole = $DB->get_record('role', array('shortname' => 'student')); $this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id); // Trigger and capture the event. $sink = $this->redirectEvents(); $result = mod_book_external::view_book($book->id, 0);
< $result = \external_api::clean_returnvalue(mod_book_external::view_book_returns(), $result);
> $result = external_api::clean_returnvalue(mod_book_external::view_book_returns(), $result);
$events = $sink->get_events(); $this->assertCount(2, $events); $event = array_shift($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\mod_book\event\course_module_viewed', $event); $this->assertEquals($context, $event->get_context()); $moodleurl = new \moodle_url('/mod/book/view.php', array('id' => $cm->id)); $this->assertEquals($moodleurl, $event->get_url()); $this->assertEventContextNotUsed($event); $this->assertNotEmpty($event->get_name()); $event = array_shift($events); $this->assertInstanceOf('\mod_book\event\chapter_viewed', $event); $this->assertEquals($chapter->id, $event->objectid); $result = mod_book_external::view_book($book->id, $chapter->id);
< $result = \external_api::clean_returnvalue(mod_book_external::view_book_returns(), $result);
> $result = external_api::clean_returnvalue(mod_book_external::view_book_returns(), $result);
$events = $sink->get_events(); // We expect a total of 3 events. $this->assertCount(3, $events); // Try to view a hidden chapter. try { mod_book_external::view_book($book->id, $chapterhidden->id); $this->fail('Exception expected due to missing capability.'); } catch (\moodle_exception $e) { $this->assertEquals('errorchapter', $e->errorcode); } // Test user with no capabilities. // We need a explicit prohibit since this capability is only defined in authenticated user and guest roles. assign_capability('mod/book:read', CAP_PROHIBIT, $studentrole->id, $context->id); accesslib_clear_all_caches_for_unit_testing(); try { mod_book_external::view_book($book->id, 0); $this->fail('Exception expected due to missing capability.'); } catch (\moodle_exception $e) { $this->assertEquals('nopermissions', $e->errorcode); } } /** * Test get_books_by_courses */ public function test_get_books_by_courses() { global $DB, $USER; $this->resetAfterTest(true); $this->setAdminUser(); $course1 = self::getDataGenerator()->create_course(); $bookoptions1 = array( 'course' => $course1->id, 'name' => 'First Book' ); $book1 = self::getDataGenerator()->create_module('book', $bookoptions1); $course2 = self::getDataGenerator()->create_course(); $bookoptions2 = array( 'course' => $course2->id, 'name' => 'Second Book' ); $book2 = self::getDataGenerator()->create_module('book', $bookoptions2); $student1 = $this->getDataGenerator()->create_user(); $studentrole = $DB->get_record('role', array('shortname' => 'student')); // Enroll Student1 in Course1. self::getDataGenerator()->enrol_user($student1->id, $course1->id, $studentrole->id); $this->setUser($student1); $books = mod_book_external::get_books_by_courses(); // We need to execute the return values cleaning process to simulate the web service server.
< $books = \external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
> $books = external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
$this->assertCount(1, $books['books']); $this->assertEquals('First Book', $books['books'][0]['name']); // We see 10 fields.
< $this->assertCount(10, $books['books'][0]);
> $this->assertCount(11, $books['books'][0]);
// As Student you cannot see some book properties like 'section'. $this->assertFalse(isset($books['books'][0]['section'])); // Student1 is not enrolled in course2. The webservice will return a warning! $books = mod_book_external::get_books_by_courses(array($course2->id)); // We need to execute the return values cleaning process to simulate the web service server.
< $books = \external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
> $books = external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
$this->assertCount(0, $books['books']); $this->assertEquals(1, $books['warnings'][0]['warningcode']); // Now as admin. $this->setAdminUser(); // As Admin we can see this book. $books = mod_book_external::get_books_by_courses(array($course2->id)); // We need to execute the return values cleaning process to simulate the web service server.
< $books = \external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
> $books = external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
$this->assertCount(1, $books['books']); $this->assertEquals('Second Book', $books['books'][0]['name']); // We see 17 fields.
< $this->assertCount(17, $books['books'][0]);
> $this->assertCount(18, $books['books'][0]);
// As an Admin you can see some book properties like 'section'. $this->assertEquals(0, $books['books'][0]['section']); // Enrol student in the second course. self::getDataGenerator()->enrol_user($student1->id, $course2->id, $studentrole->id); $this->setUser($student1); $books = mod_book_external::get_books_by_courses();
< $books = \external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
> $books = external_api::clean_returnvalue(mod_book_external::get_books_by_courses_returns(), $books);
$this->assertCount(2, $books['books']); } }