SWAMPy

✎ CARVE FLESH

EDITING: externallib_test.php

<?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_resource;

use core_external\external_api;
use mod_resource_external;

/**
 * External mod_resource functions unit tests
 *
 * @package    mod_resource
 * @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
 */
final class externallib_test extends \core_external\tests\externallib_testcase {
    /**
     * Test view_resource
     */
    public function test_view_resource(): void {
        global $DB;

$this->resetAfterTest(true);

$this->setAdminUser();
        // Setup test data.
        $course = $this->getDataGenerator()->create_course();
        $resource = $this->getDataGenerator()->create_module('resource', array('course' => $course->id));
        $context = \context_module::instance($resource->cmid);
        $cm = get_coursemodule_from_instance('resource', $resource->id);

// Test invalid instance id.
        try {
            mod_resource_external::view_resource(0);
            $this->fail('Exception expected due to invalid mod_resource 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_resource_external::view_resource($resource->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_resource_external::view_resource($resource->id);
        $result = external_api::clean_returnvalue(mod_resource_external::view_resource_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_resource\event\course_module_viewed', $event);
        $this->assertEquals($context, $event->get_context());
        $moodleurl = new \moodle_url('/mod/resource/view.php', array('id' => $cm->id));
        $this->assertEquals($moodleurl, $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/resource: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_resource_external::view_resource($resource->id);
            $this->fail('Exception expected due to missing capability.');
        } catch (\moodle_exception $e) {
            $this->assertEquals('requireloginerror', $e->errorcode);
        }

}

/**
     * Test test_mod_resource_get_resources_by_courses
     */
    public function test_mod_resource_get_resources_by_courses(): void {
        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);

self::setUser($student);

// First resource.
        $record = new \stdClass();
        $record->course = $course1->id;
        $resource1 = self::getDataGenerator()->create_module('resource', $record);

// Second resource.
        $record = new \stdClass();
        $record->course = $course2->id;
        $resource2 = self::getDataGenerator()->create_module('resource', $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);

$returndescription = mod_resource_external::get_resources_by_courses_returns();

// Create what we expect to be returned when querying the two courses.
        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'lang',
                                'contentfiles', 'tobemigrated', 'legacyfiles', 'legacyfileslast', 'display', 'displayoptions',
                                'filterfiles', 'revision', 'timemodified', 'section', 'visible', 'groupmode', 'groupingid',
                                'enableaitools', 'enabledaiactions');

// Add expected coursemodule and data.
        $resource1->coursemodule = $resource1->cmid;
        $resource1->introformat = 1;
        $resource1->contentformat = 1;
        $resource1->section = 0;
        $resource1->visible = true;
        $resource1->groupmode = 0;
        $resource1->groupingid = 0;
        $resource1->introfiles = [];
        $resource1->contentfiles = [];
        $resource1->lang = '';
        $resource1->enableaitools = null;
        $resource1->enabledaiactions = null;

$resource2->coursemodule = $resource2->cmid;
        $resource2->introformat = 1;
        $resource2->contentformat = 1;
        $resource2->section = 0;
        $resource2->visible = true;
        $resource2->groupmode = 0;
        $resource2->groupingid = 0;
        $resource2->introfiles = [];
        $resource2->contentfiles = [];
        $resource2->lang = '';
        $resource2->enableaitools = null;
        $resource2->enabledaiactions = null;

foreach ($expectedfields as $field) {
            $expected1[$field] = $resource1->{$field};
            $expected2[$field] = $resource2->{$field};
        }

$expectedresources = array($expected2, $expected1);

// Call the external function passing course ids.
        $result = mod_resource_external::get_resources_by_courses(array($course2->id, $course1->id));
        $result = external_api::clean_returnvalue($returndescription, $result);

// Remove the contentfiles (to be checked bellow).
        $result['resources'][0]['contentfiles'] = [];
        $result['resources'][1]['contentfiles'] = [];

// Now, check that we retrieve the same data we created.
        $this->assertEquals($expectedresources, $result['resources']);
        $this->assertCount(0, $result['warnings']);

// Call the external function without passing course id.
        $result = mod_resource_external::get_resources_by_courses();
        $result = external_api::clean_returnvalue($returndescription, $result);

// Remove the contentfiles (to be checked bellow).
        $result['resources'][0]['contentfiles'] = [];
        $result['resources'][1]['contentfiles'] = [];

// Check that without course ids we still get the correct data.
        $this->assertEquals($expectedresources, $result['resources']);
        $this->assertCount(0, $result['warnings']);

// Add a file to the intro.
        $fileintroname = "fileintro.txt";
        $filerecordinline = array(
            'contextid' => \context_module::instance($resource2->cmid)->id,
            'component' => 'mod_resource',
            'filearea'  => 'intro',
            'itemid'    => 0,
            'filepath'  => '/',
            'filename'  => $fileintroname,
        );
        $fs = get_file_storage();
        $timepost = time();
        $fs->create_file_from_string($filerecordinline, 'image contents (not really)');

$result = mod_resource_external::get_resources_by_courses(array($course2->id, $course1->id));
        $result = external_api::clean_returnvalue($returndescription, $result);

// Check that we receive correctly the files.
        $this->assertCount(1, $result['resources'][0]['introfiles']);
        $this->assertEquals($fileintroname, $result['resources'][0]['introfiles'][0]['filename']);
        $this->assertCount(1, $result['resources'][0]['contentfiles']);
        $this->assertCount(1, $result['resources'][1]['contentfiles']);
        // Test autogenerated resource.
        $this->assertEquals('resource2.txt', $result['resources'][0]['contentfiles'][0]['filename']);
        $this->assertEquals('resource1.txt', $result['resources'][1]['contentfiles'][0]['filename']);

// Unenrol user from second course.
        $enrol->unenrol_user($instance2, $student->id);
        array_shift($expectedresources);

// Remove the contentfiles (to be checked bellow).
        $result['resources'][0]['contentfiles'] = [];
        $this->assertEquals($expectedresources, $result['resources']);

// Call for the second course we unenrolled the user from, expected warning.
        $result = mod_resource_external::get_resources_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']);
    }
}

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 backup/	DIR	—	2026-02-11 01:44
📁 behat/	DIR	—	2026-02-11 01:44
📁 event/	DIR	—	2026-02-11 01:44
📁 fixtures/	DIR	—	2026-02-11 01:44
📁 generator/	DIR	—	2026-02-11 01:44
📁 search/	DIR	—	2026-02-11 01:44
📄 externallib_test.php	PHP	10.6 KB	2026-02-11 01:44	EDIT
📄 generator_test.php	PHP	5.4 KB	2026-02-11 01:44	EDIT
📄 lib_test.php	PHP	11.3 KB	2026-02-11 01:44	EDIT