You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
236 lines
9.1 KiB
236 lines
9.1 KiB
2 years ago
|
<?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/>.
|
||
|
|
|
||
|
|
/**
|
||
|
|
* External mod_page functions unit tests
|
||
|
|
*
|
||
|
|
* @package mod_page
|
||
|
|
* @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
|
||
|
|
*/
|
||
|
|
|
||
|
|
defined('MOODLE_INTERNAL') || die();
|
||
|
|
|
||
|
|
global $CFG;
|
||
|
|
|
||
|
|
require_once($CFG->dirroot . '/webservice/tests/helpers.php');
|
||
|
|
|
||
|
|
/**
|
||
|
|
* External mod_page functions unit tests
|
||
|
|
*
|
||
|
|
* @package mod_page
|
||
|
|
* @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 mod_page_external_testcase extends externallib_advanced_testcase {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Test view_page
|
||
|
|
*/
|
||
|
|
public function test_view_page() {
|
||
|
|
global $DB;
|
||
|
|
|
||
|
|
$this->resetAfterTest(true);
|
||
|
|
|
||
|
|
// Setup test data.
|
||
|
|
$course = $this->getDataGenerator()->create_course();
|
||
|
|
$page = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
|
||
|
|
$context = context_module::instance($page->cmid);
|
||
|
|
$cm = get_coursemodule_from_instance('page', $page->id);
|
||
|
|
|
||
|
|
// Test invalid instance id.
|
||
|
|
try {
|
||
|
|
mod_page_external::view_page(0);
|
||
|
|
$this->fail('Exception expected due to invalid mod_page 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_page_external::view_page($page->id);
|
||
|
|
$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_page_external::view_page($page->id);
|
||
|
|
$result = external_api::clean_returnvalue(mod_page_external::view_page_returns(), $result);
|
||
|
|
|
||
|
|
$events = $sink->get_events();
|
||
|
|
$this->assertCount(1, $events);
|
||
|
|
$event = array_shift($events);
|
||
|
|
|
||
|
|
// Checking that the event contains the expected values.
|
||
|
|
$this->assertInstanceOf('\mod_page\event\course_module_viewed', $event);
|
||
|
|
$this->assertEquals($context, $event->get_context());
|
||
|
|
$moodlepage = new \moodle_url('/mod/page/view.php', array('id' => $cm->id));
|
||
|
|
$this->assertEquals($moodlepage, $event->get_url());
|
||
|
|
$this->assertEventContextNotUsed($event);
|
||
|
|
$this->assertNotEmpty($event->get_name());
|
||
|
|
|
||
|
|
// 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/page:view', CAP_PROHIBIT, $studentrole->id, $context->id);
|
||
|
|
// Empty all the caches that may be affected by this change.
|
||
|
|
accesslib_clear_all_caches_for_unit_testing();
|
||
|
|
course_modinfo::clear_instance_cache();
|
||
|
|
|
||
|
|
try {
|
||
|
|
mod_page_external::view_page($page->id);
|
||
|
|
$this->fail('Exception expected due to missing capability.');
|
||
|
|
} catch (moodle_exception $e) {
|
||
|
|
$this->assertEquals('requireloginerror', $e->errorcode);
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Test test_mod_page_get_pages_by_courses
|
||
|
|
*/
|
||
|
|
public function test_mod_page_get_pages_by_courses() {
|
||
|
|
global $DB;
|
||
|
|
|
||
|
|
$this->resetAfterTest(true);
|
||
|
|
|
||
|
|
$course1 = self::getDataGenerator()->create_course();
|
||
|
|
$course2 = self::getDataGenerator()->create_course();
|
||
|
|
|
||
|
|
$student = self::getDataGenerator()->create_user();
|
||
|
|
$studentrole = $DB->get_record('role', array('shortname' => 'student'));
|
||
|
|
$this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id);
|
||
|
|
|
||
|
|
// First page.
|
||
|
|
$record = new stdClass();
|
||
|
|
$record->course = $course1->id;
|
||
|
|
$page1 = self::getDataGenerator()->create_module('page', $record);
|
||
|
|
|
||
|
|
// Second page.
|
||
|
|
$record = new stdClass();
|
||
|
|
$record->course = $course2->id;
|
||
|
|
$page2 = self::getDataGenerator()->create_module('page', $record);
|
||
|
|
|
||
|
|
// Execute real Moodle enrolment as we'll call unenrol() method on the instance later.
|
||
|
|
$enrol = enrol_get_plugin('manual');
|
||
|
|
$enrolinstances = enrol_get_instances($course2->id, true);
|
||
|
|
foreach ($enrolinstances as $courseenrolinstance) {
|
||
|
|
if ($courseenrolinstance->enrol == "manual") {
|
||
|
|
$instance2 = $courseenrolinstance;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$enrol->enrol_user($instance2, $student->id, $studentrole->id);
|
||
|
|
|
||
|
|
self::setUser($student);
|
||
|
|
|
||
|
|
$returndescription = mod_page_external::get_pages_by_courses_returns();
|
||
|
|
|
||
|
|
// Create what we expect to be returned when querying the two courses.
|
||
|
|
$expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles',
|
||
|
|
'content', 'contentformat', 'contentfiles', 'legacyfiles', 'legacyfileslast', 'display',
|
||
|
|
'displayoptions', 'revision', 'timemodified', 'section', 'visible', 'groupmode', 'groupingid');
|
||
|
|
|
||
|
|
// Add expected coursemodule and data.
|
||
|
|
$page1->coursemodule = $page1->cmid;
|
||
|
|
$page1->introformat = 1;
|
||
|
|
$page1->contentformat = 1;
|
||
|
|
$page1->section = 0;
|
||
|
|
$page1->visible = true;
|
||
|
|
$page1->groupmode = 0;
|
||
|
|
$page1->groupingid = 0;
|
||
|
|
$page1->introfiles = [];
|
||
|
|
$page1->contentfiles = [];
|
||
|
|
|
||
|
|
$page2->coursemodule = $page2->cmid;
|
||
|
|
$page2->introformat = 1;
|
||
|
|
$page2->contentformat = 1;
|
||
|
|
$page2->section = 0;
|
||
|
|
$page2->visible = true;
|
||
|
|
$page2->groupmode = 0;
|
||
|
|
$page2->groupingid = 0;
|
||
|
|
$page2->introfiles = [];
|
||
|
|
$page2->contentfiles = [];
|
||
|
|
|
||
|
|
foreach ($expectedfields as $field) {
|
||
|
|
$expected1[$field] = $page1->{$field};
|
||
|
|
$expected2[$field] = $page2->{$field};
|
||
|
|
}
|
||
|
|
|
||
|
|
$expectedpages = array($expected2, $expected1);
|
||
|
|
|
||
|
|
// Call the external function passing course ids.
|
||
|
|
$result = mod_page_external::get_pages_by_courses(array($course2->id, $course1->id));
|
||
|
|
$result = external_api::clean_returnvalue($returndescription, $result);
|
||
|
|
|
||
|
|
$this->assertEquals($expectedpages, $result['pages']);
|
||
|
|
$this->assertCount(0, $result['warnings']);
|
||
|
|
|
||
|
|
// Call the external function without passing course id.
|
||
|
|
$result = mod_page_external::get_pages_by_courses();
|
||
|
|
$result = external_api::clean_returnvalue($returndescription, $result);
|
||
|
|
$this->assertEquals($expectedpages, $result['pages']);
|
||
|
|
$this->assertCount(0, $result['warnings']);
|
||
|
|
|
||
|
|
// Add a file to the intro.
|
||
|
|
$filename = "file.txt";
|
||
|
|
$filerecordinline = array(
|
||
|
|
'contextid' => context_module::instance($page2->cmid)->id,
|
||
|
|
'component' => 'mod_page',
|
||
|
|
'filearea' => 'intro',
|
||
|
|
'itemid' => 0,
|
||
|
|
'filepath' => '/',
|
||
|
|
'filename' => $filename,
|
||
|
|
);
|
||
|
|
$fs = get_file_storage();
|
||
|
|
$timepost = time();
|
||
|
|
$fs->create_file_from_string($filerecordinline, 'image contents (not really)');
|
||
|
|
|
||
|
|
$result = mod_page_external::get_pages_by_courses(array($course2->id, $course1->id));
|
||
|
|
$result = external_api::clean_returnvalue($returndescription, $result);
|
||
|
|
|
||
|
|
$this->assertCount(1, $result['pages'][0]['introfiles']);
|
||
|
|
$this->assertEquals($filename, $result['pages'][0]['introfiles'][0]['filename']);
|
||
|
|
|
||
|
|
// Unenrol user from second course.
|
||
|
|
$enrol->unenrol_user($instance2, $student->id);
|
||
|
|
array_shift($expectedpages);
|
||
|
|
|
||
|
|
// Call the external function without passing course id.
|
||
|
|
$result = mod_page_external::get_pages_by_courses();
|
||
|
|
$result = external_api::clean_returnvalue($returndescription, $result);
|
||
|
|
$this->assertEquals($expectedpages, $result['pages']);
|
||
|
|
|
||
|
|
// Call for the second course we unenrolled the user from, expected warning.
|
||
|
|
$result = mod_page_external::get_pages_by_courses(array($course2->id));
|
||
|
|
$this->assertCount(1, $result['warnings']);
|
||
|
|
$this->assertEquals('1', $result['warnings'][0]['warningcode']);
|
||
|
|
$this->assertEquals($course2->id, $result['warnings'][0]['itemid']);
|
||
|
|
}
|
||
|
|
}
|