See Release Notes
Long Term Support Release
<?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/>. /** * Badges external functions tests. * * @package core_badges * @category external * @copyright 2016 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 3.1 */ namespace core_badges\external; use core_badges_external;> use core_external\external_api; use externallib_advanced_testcase; > use core_external\external_settings;defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); require_once($CFG->libdir . '/badgeslib.php'); /** * Badges external functions tests * * @package core_badges * @category external * @copyright 2016 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 3.1 */ class external_test extends externallib_advanced_testcase { /** @var stdClass $course */ private $course; /** @var stdClass $student */ private $student; /** @var stdClass $teacher */ private $teacher; /** * Set up for every test */ public function setUp(): void { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Setup test data. $this->course = $this->getDataGenerator()->create_course(); // Create users and enrolments. $this->student = $this->getDataGenerator()->create_and_enrol($this->course, 'student'); $this->teacher = $this->getDataGenerator()->create_and_enrol($this->course, 'editingteacher'); // Mock up a site badge. $now = time(); $badge = new \stdClass(); $badge->id = null; $badge->name = "Test badge site"; $badge->description = "Testing badges site"; $badge->timecreated = $now - 12; $badge->timemodified = $now - 12; $badge->usercreated = $this->teacher->id; $badge->usermodified = $this->teacher->id; $badge->issuername = "Test issuer"; $badge->issuerurl = "http://issuer-url.domain.co.nz"; $badge->issuercontact = "issuer@example.com"; $badge->expiredate = null; $badge->expireperiod = null; $badge->type = BADGE_TYPE_SITE; $badge->courseid = null; $badge->messagesubject = "Test message subject for badge"; $badge->message = "Test message body for badge"; $badge->attachment = 1; $badge->notification = 0; $badge->status = BADGE_STATUS_ACTIVE; $badge->version = '1'; $badge->language = 'en'; $badge->imageauthorname = 'Image author'; $badge->imageauthoremail = 'imageauthor@example.com'; $badge->imageauthorurl = 'http://image-author-url.domain.co.nz'; $badge->imagecaption = 'Caption'; $badgeid = $DB->insert_record('badge', $badge, true); $badge = new \badge($badgeid); $badge->issue($this->student->id, true); // Hack the database to adjust the time each badge was issued. $DB->set_field('badge_issued', 'dateissued', $now - 11, array('userid' => $this->student->id, 'badgeid' => $badgeid)); // Add an endorsement for the badge. $endorsement = new \stdClass(); $endorsement->badgeid = $badgeid; $endorsement->issuername = 'Issuer name'; $endorsement->issuerurl = 'http://endorsement-issuer-url.domain.co.nz'; $endorsement->issueremail = 'endorsementissuer@example.com'; $endorsement->claimid = 'http://claim-url.domain.co.nz'; $endorsement->claimcomment = 'Claim comment'; $endorsement->dateissued = $now; $badge->save_endorsement($endorsement); // Add 2 alignments. $alignment = new \stdClass(); $alignment->badgeid = $badgeid; $alignment->targetname = 'Alignment 1'; $alignment->targeturl = 'http://a1-target-url.domain.co.nz'; $alignment->targetdescription = 'A1 target description'; $alignment->targetframework = 'A1 framework'; $alignment->targetcode = 'A1 code'; $badge->save_alignment($alignment); $alignment->targetname = 'Alignment 2'; $alignment->targeturl = 'http://a2-target-url.domain.co.nz'; $alignment->targetdescription = 'A2 target description'; $alignment->targetframework = 'A2 framework'; $alignment->targetcode = 'A2 code'; $badge->save_alignment($alignment); // Now a course badge. $badge->id = null; $badge->name = "Test badge course"; $badge->description = "Testing badges course"; $badge->type = BADGE_TYPE_COURSE; $badge->courseid = $this->course->id; $coursebadgeid = $DB->insert_record('badge', $badge, true); $badge = new \badge($coursebadgeid); $badge->issue($this->student->id, true); // Hack the database to adjust the time each badge was issued. $DB->set_field('badge_issued', 'dateissued', $now - 10, array('userid' => $this->student->id, 'badgeid' => $coursebadgeid)); // Make the site badge a related badge. $badge->add_related_badges(array($badgeid)); } /** * Test get user badges. * These is a basic test since the badges_get_my_user_badges used by the external function already has unit tests. */ public function test_get_my_user_badges() { $this->setUser($this->student); $badges = (array) badges_get_user_badges($this->student->id); $expectedbadges = array(); $coursebadge = null; foreach ($badges as $badge) { $context = ($badge->type == BADGE_TYPE_SITE) ? \context_system::instance() : \context_course::instance($badge->courseid); $badge->badgeurl = \moodle_url::make_webservice_pluginfile_url($context->id, 'badges', 'badgeimage', $badge->id, '/', 'f3')->out(false); // Get the endorsement, alignments and related badges. $badgeinstance = new \badge($badge->id); $endorsement = $badgeinstance->get_endorsement(); $alignments = $badgeinstance->get_alignments(); $relatedbadges = $badgeinstance->get_related_badges(); $badge->alignment = array(); $badge->relatedbadges = array(); if ($endorsement) { $badge->endorsement = (array) $endorsement; } if (!empty($alignments)) { foreach ($alignments as $alignment) { // Students cannot see some fields of the alignments. unset($alignment->targetname); unset($alignment->targeturl); unset($alignment->targetdescription); unset($alignment->targetframework); unset($alignment->targetcode); $badge->alignment[] = (array) $alignment; } } if (!empty($relatedbadges)) { foreach ($relatedbadges as $relatedbadge) { // Students cannot see some fields of the related badges. unset($relatedbadge->version); unset($relatedbadge->language); unset($relatedbadge->type); $badge->relatedbadges[] = (array) $relatedbadge; } } $expectedbadges[] = (array) $badge; if (isset($badge->courseid)) { // Save the course badge to be able to compare it in our tests. $coursebadge = (array) $badge; } } $result = core_badges_external::get_user_badges();< $result = \external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);> $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);$this->assertEquals($expectedbadges, $result['badges']); // Pagination and filtering. $result = core_badges_external::get_user_badges(0, $this->course->id, 0, 1, '', true);< $result = \external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);> $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);$this->assertCount(1, $result['badges']); $this->assertEquals($coursebadge, $result['badges'][0]); } /** * Test get user badges. */ public function test_get_other_user_badges() { $this->setUser($this->teacher); $result = core_badges_external::get_user_badges($this->student->id);< $result = \external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);> $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);$this->assertCount(2, $result['badges']); // Check that we don't have permissions for view the complete information for site badges. foreach ($result['badges'] as $badge) { if (isset($badge['type']) and $badge['type'] == BADGE_TYPE_COURSE) { $this->assertTrue(isset($badge['message'])); // Check that we have permissions to see all the data in alignments and related badges. foreach ($badge['alignment'] as $alignment) { $this->assertTrue(isset($alignment['targetdescription'])); } foreach ($badge['relatedbadges'] as $relatedbadge) { $this->assertTrue(isset($relatedbadge['type'])); } } else { $this->assertFalse(isset($badge['message'])); } } } /** * Test get_user_badges where issuername contains text to be filtered */ public function test_get_user_badges_filter_issuername(): void { global $DB; filter_set_global_state('multilang', TEXTFILTER_ON); filter_set_applies_to_strings('multilang', true);< \external_settings::get_instance()->set_filter(true);> external_settings::get_instance()->set_filter(true);// Update issuer name of test badge. $issuername = '<span class="multilang" lang="en">Issuer (en)</span><span class="multilang" lang="es">Issuer (es)</span>'; $DB->set_field('badge', 'issuername', $issuername, ['name' => 'Test badge site']); // Retrieve student badges. $result = core_badges_external::get_user_badges($this->student->id);< $result = \external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);> $result = external_api::clean_returnvalue(core_badges_external::get_user_badges_returns(), $result);// Site badge will be last, because it has the earlier issued date. $badge = end($result['badges']); $this->assertEquals('Issuer (en)', $badge['issuername']); } }