Proyectos de Subversion Moodle

<?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/>.

/**

 * Unit tests for badges

 *

 * @package    core

 * @subpackage badges

 * @copyright  2013 onwards Totara Learning Solutions Ltd {@link http://www.totaralms.com/}

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 * @author     Yuliya Bozhko <yuliya.bozhko@totaralms.com>

 */

defined('MOODLE_INTERNAL') || die();

global $CFG;

require_once($CFG->libdir . '/badgeslib.php');

require_once($CFG->dirroot . '/badges/lib.php');

use core_badges\helper;

use core\task\manager;

class badgeslib_test extends advanced_testcase {

    protected $badgeid;

    protected $course;

    protected $user;

    protected $module;

    protected $coursebadge;

    protected $assertion;

    /** @var $assertion2 to define json format for Open badge version 2 */

    protected $assertion2;

    protected function setUp(): void {

        global $DB, $CFG;

        $this->resetAfterTest(true);

        $CFG->enablecompletion = true;

        $user = $this->getDataGenerator()->create_user();

        $fordb = new stdClass();

        $fordb->id = null;

        $fordb->name = "Test badge with 'apostrophe' and other friends (<>&@#)";

        $fordb->description = "Testing badges";

        $fordb->timecreated = time();

        $fordb->timemodified = time();

        $fordb->usercreated = $user->id;

        $fordb->usermodified = $user->id;

        $fordb->issuername = "Test issuer";

        $fordb->issuerurl = "http://issuer-url.domain.co.nz";

        $fordb->issuercontact = "issuer@example.com";

        $fordb->expiredate = null;

        $fordb->expireperiod = null;

        $fordb->type = BADGE_TYPE_SITE;

        $fordb->version = 1;

        $fordb->language = 'en';

        $fordb->courseid = null;

        $fordb->messagesubject = "Test message subject";

        $fordb->message = "Test message body";

        $fordb->attachment = 1;

        $fordb->notification = 0;

        $fordb->imageauthorname = "Image Author 1";

        $fordb->imageauthoremail = "author@example.com";

        $fordb->imageauthorurl = "http://author-url.example.com";

        $fordb->imagecaption = "Test caption image";

        $fordb->status = BADGE_STATUS_INACTIVE;

        $this->badgeid = $DB->insert_record('badge', $fordb, true);

        // Set the default Issuer (because OBv2 needs them).

        set_config('badges_defaultissuername', $fordb->issuername);

        set_config('badges_defaultissuercontact', $fordb->issuercontact);

        // Create a course with activity and auto completion tracking.

        $this->course = $this->getDataGenerator()->create_course(array('enablecompletion' => true));

        $this->user = $this->getDataGenerator()->create_user();

        $studentrole = $DB->get_record('role', array('shortname' => 'student'));

        $this->assertNotEmpty($studentrole);

        // Get manual enrolment plugin and enrol user.

        require_once($CFG->dirroot.'/enrol/manual/locallib.php');

        $manplugin = enrol_get_plugin('manual');

        $maninstance = $DB->get_record('enrol', array('courseid' => $this->course->id, 'enrol' => 'manual'), '*', MUST_EXIST);

        $manplugin->enrol_user($maninstance, $this->user->id, $studentrole->id);

        $this->assertEquals(1, $DB->count_records('user_enrolments'));

        $completionauto = array('completion' => COMPLETION_TRACKING_AUTOMATIC);

        $this->module = $this->getDataGenerator()->create_module('forum', array('course' => $this->course->id), $completionauto);

        // Build badge and criteria.

        $fordb->type = BADGE_TYPE_COURSE;

        $fordb->courseid = $this->course->id;

        $fordb->status = BADGE_STATUS_ACTIVE;

        $this->coursebadge = $DB->insert_record('badge', $fordb, true);

        // Insert Endorsement.

        $endorsement = new stdClass();

        $endorsement->badgeid = $this->coursebadge;

        $endorsement->issuername = "Issuer 123";

        $endorsement->issueremail = "issuer123@email.com";

        $endorsement->issuerurl = "https://example.org/issuer-123";

        $endorsement->dateissued = 1524567747;

        $endorsement->claimid = "https://example.org/robotics-badge.json";

        $endorsement->claimcomment = "Test endorser comment";

        $DB->insert_record('badge_endorsement', $endorsement, true);

        // Insert related badges.

        $badge = new badge($this->coursebadge);

        $clonedid = $badge->make_clone();

        $badgeclone = new badge($clonedid);

        $badgeclone->status = BADGE_STATUS_ACTIVE;

        $badgeclone->save();

        $relatebadge = new stdClass();

        $relatebadge->badgeid = $this->coursebadge;

        $relatebadge->relatedbadgeid = $clonedid;

        $relatebadge->relatedid = $DB->insert_record('badge_related', $relatebadge, true);

        // Insert a aligment.

        $alignment = new stdClass();

        $alignment->badgeid = $this->coursebadge;

        $alignment->targetname = 'CCSS.ELA-Literacy.RST.11-12.3';

        $alignment->targeturl = 'http://www.corestandards.org/ELA-Literacy/RST/11-12/3';

        $alignment->targetdescription = 'Test target description';

        $alignment->targetframework = 'CCSS.RST.11-12.3';

        $alignment->targetcode = 'CCSS.RST.11-12.3';

        $DB->insert_record('badge_alignment', $alignment, true);

        // Insert tags.

        core_tag_tag::set_item_tags('core_badges', 'badge', $badge->id, $badge->get_context(), ['tag1', 'tag2']);

        $this->assertion = new stdClass();

        $this->assertion->badge = '{"uid":"%s","recipient":{"identity":"%s","type":"email","hashed":true,"salt":"%s"},' .

            '"badge":"%s","verify":{"type":"hosted","url":"%s"},"issuedOn":"%d","evidence":"%s","tags":%s}';

        $this->assertion->class = '{"name":"%s","description":"%s","image":"%s","criteria":"%s","issuer":"%s","tags":%s}';

        $this->assertion->issuer = '{"name":"%s","url":"%s","email":"%s"}';

        // Format JSON-LD for Openbadge specification version 2.0.

        $this->assertion2 = new stdClass();

        $this->assertion2->badge = '{"recipient":{"identity":"%s","type":"email","hashed":true,"salt":"%s"},' .

            '"badge":{"name":"%s","description":"%s","image":"%s",' .

            '"criteria":{"id":"%s","narrative":"%s"},"issuer":{"name":"%s","url":"%s","email":"%s",' .

            '"@context":"https:\/\/w3id.org\/openbadges\/v2","id":"%s","type":"Issuer"},' .

            '"tags":%s,"@context":"https:\/\/w3id.org\/openbadges\/v2","id":"%s","type":"BadgeClass","version":"%s",' .

            '"@language":"en","related":[{"id":"%s","version":"%s","@language":"%s"}],"endorsement":"%s",' .

            '"alignments":[{"targetName":"%s","targetUrl":"%s","targetDescription":"%s","targetFramework":"%s",' .

            '"targetCode":"%s"}]},"verify":{"type":"hosted","url":"%s"},"issuedOn":"%s","evidence":"%s","tags":%s,' .

            '"@context":"https:\/\/w3id.org\/openbadges\/v2","type":"Assertion","id":"%s"}';

        $this->assertion2->class = '{"name":"%s","description":"%s","image":"%s",' .

            '"criteria":{"id":"%s","narrative":"%s"},"issuer":{"name":"%s","url":"%s","email":"%s",' .

            '"@context":"https:\/\/w3id.org\/openbadges\/v2","id":"%s","type":"Issuer"},' .

            '"tags":%s,"@context":"https:\/\/w3id.org\/openbadges\/v2","id":"%s","type":"BadgeClass","version":"%s",' .

            '"@language":"%s","related":[{"id":"%s","version":"%s","@language":"%s"}],"endorsement":"%s",' .

            '"alignments":[{"targetName":"%s","targetUrl":"%s","targetDescription":"%s","targetFramework":"%s",' .

            '"targetCode":"%s"}]}';

        $this->assertion2->issuer = '{"name":"%s","url":"%s","email":"%s",' .

            '"@context":"https:\/\/w3id.org\/openbadges\/v2","id":"%s","type":"Issuer"}';

    }

    public function test_create_badge(): void {

        $badge = new badge($this->badgeid);

        $this->assertInstanceOf('badge', $badge);

        $this->assertEquals($this->badgeid, $badge->id);

    }

    public function test_clone_badge(): void {

        $badge = new badge($this->badgeid);

        $newid = $badge->make_clone();

        $clonedbadge = new badge($newid);

        $this->assertEquals($badge->description, $clonedbadge->description);

        $this->assertEquals($badge->issuercontact, $clonedbadge->issuercontact);

        $this->assertEquals($badge->issuername, $clonedbadge->issuername);

        $this->assertEquals($badge->issuercontact, $clonedbadge->issuercontact);

        $this->assertEquals($badge->issuerurl, $clonedbadge->issuerurl);

        $this->assertEquals($badge->expiredate, $clonedbadge->expiredate);

        $this->assertEquals($badge->expireperiod, $clonedbadge->expireperiod);

        $this->assertEquals($badge->type, $clonedbadge->type);

        $this->assertEquals($badge->courseid, $clonedbadge->courseid);

        $this->assertEquals($badge->message, $clonedbadge->message);

        $this->assertEquals($badge->messagesubject, $clonedbadge->messagesubject);

        $this->assertEquals($badge->attachment, $clonedbadge->attachment);

        $this->assertEquals($badge->notification, $clonedbadge->notification);

        $this->assertEquals($badge->version, $clonedbadge->version);

        $this->assertEquals($badge->language, $clonedbadge->language);

        $this->assertEquals($badge->imagecaption, $clonedbadge->imagecaption);

        $this->assertEquals($badge->imageauthorname, $clonedbadge->imageauthorname);

        $this->assertEquals($badge->imageauthoremail, $clonedbadge->imageauthoremail);

        $this->assertEquals($badge->imageauthorurl, $clonedbadge->imageauthorurl);

    }

    public function test_badge_status(): void {

        $badge = new badge($this->badgeid);

        $old_status = $badge->status;

        $badge->set_status(BADGE_STATUS_ACTIVE);

        $this->assertNotEquals($old_status, $badge->status);

        $this->assertEquals(BADGE_STATUS_ACTIVE, $badge->status);

    }

    public function test_delete_badge(): void {

        $badge = new badge($this->badgeid);

        $badge->delete();

        // We don't actually delete badges. We archive them.

        $this->assertEquals(BADGE_STATUS_ARCHIVED, $badge->status);

    }

    /**

     * Really delete the badge.

     */

    public function test_delete_badge_for_real(): void {

        global $DB;

        $badge = new badge($this->badgeid);

        // Insert tags for the badge.

        core_tag_tag::set_item_tags('core_badges', 'badge', $badge->id, $badge->get_context(), ['tag1', 'tag2']);

        $newid1 = $badge->make_clone();

        $newid2 = $badge->make_clone();

        $newid3 = $badge->make_clone();

        // Insert related badges to badge 1.

        $badge->add_related_badges([$newid1, $newid2, $newid3]);

        // Another badge.

        $badge2 = new badge($newid2);

        // Make badge 1 related for badge 2.

        $badge2->add_related_badges([$this->badgeid]);

        // Confirm that the records about this badge about its relations have been removed as well.

        $relatedsql = 'badgeid = :badgeid OR relatedbadgeid = :relatedbadgeid';

        $relatedparams = array(

            'badgeid' => $this->badgeid,

            'relatedbadgeid' => $this->badgeid

        );

        // Badge 1 has 4 related records. 3 where it's the badgeid, 1 where it's the relatedbadgeid.

        $this->assertEquals(4, $DB->count_records_select('badge_related', $relatedsql, $relatedparams));

        // Badge has 2 tag instance records.

        $this->assertEquals(2, $DB->count_records('tag_instance', ['itemid' => $this->badgeid]));

        // Delete the badge for real.

        $badge->delete(false);

        // Confirm that the badge itself has been removed.

        $this->assertFalse($DB->record_exists('badge', ['id' => $this->badgeid]));

        // Confirm that the records about this badge about its relations have been removed as well.

        $this->assertFalse($DB->record_exists_select('badge_related', $relatedsql, $relatedparams));

        // Confirm that the tag instance of the badge has been removed.

        $this->assertFalse($DB->record_exists('tag_instance', ['itemid' => $this->badgeid]));

    }

    public function test_create_badge_criteria(): void {

        $badge = new badge($this->badgeid);

        $criteria_overall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteria_overall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ALL));

        $this->assertCount(1, $badge->get_criteria());

        $criteria_profile = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_PROFILE, 'badgeid' => $badge->id));

        $params = array('agg' => BADGE_CRITERIA_AGGREGATION_ALL, 'field_address' => 'address');

        $criteria_profile->save($params);

        $this->assertCount(2, $badge->get_criteria());

    }

    public function test_add_badge_criteria_description(): void {

        $criteriaoverall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $this->badgeid));

        $criteriaoverall->save(array(

                'agg' => BADGE_CRITERIA_AGGREGATION_ALL,

                'description' => 'Overall description',

                'descriptionformat' => FORMAT_HTML

        ));

        $criteriaprofile = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_PROFILE, 'badgeid' => $this->badgeid));

        $params = array(

                'agg' => BADGE_CRITERIA_AGGREGATION_ALL,

                'field_address' => 'address',

                'description' => 'Description',

                'descriptionformat' => FORMAT_HTML

        );

        $criteriaprofile->save($params);

        $badge = new badge($this->badgeid);

        $this->assertEquals('Overall description', $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->description);

        $this->assertEquals('Description', $badge->criteria[BADGE_CRITERIA_TYPE_PROFILE]->description);

    }

    public function test_delete_badge_criteria(): void {

        $criteria_overall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $this->badgeid));

        $criteria_overall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ALL));

        $badge = new badge($this->badgeid);

        $this->assertInstanceOf('award_criteria_overall', $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]);

        $badge->criteria[BADGE_CRITERIA_TYPE_OVERALL]->delete();

        $this->assertEmpty($badge->get_criteria());

    }

    public function test_badge_awards(): void {

        global $DB;

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->badgeid);

        $user1 = $this->getDataGenerator()->create_user();

        $sink = $this->redirectMessages();

        $DB->set_field_select('message_processors', 'enabled', 0, "name <> 'email'");

        set_user_preference('message_provider_moodle_badgerecipientnotice_enabled', 'email', $user1);

        $badge->issue($user1->id, false);

        $this->assertDebuggingCalled(); // Expect debugging while baking a badge via phpunit.

        $this->assertTrue($badge->is_issued($user1->id));

        $messages = $sink->get_messages();

        $sink->close();

        $this->assertCount(1, $messages);

        $message = array_pop($messages);

        // Check we have the expected data.

        $customdata = json_decode($message->customdata);

        $this->assertObjectHasProperty('notificationiconurl', $customdata);

        $this->assertObjectHasProperty('hash', $customdata);

        $user2 = $this->getDataGenerator()->create_user();

        $badge->issue($user2->id, true);

        $this->assertTrue($badge->is_issued($user2->id));

        $this->assertCount(2, $badge->get_awards());

    }

    /**

     * Test the {@link badges_get_user_badges()} function in lib/badgeslib.php

     */

    public function test_badges_get_user_badges(): void {

        global $DB;

        // Messaging is not compatible with transactions.

        $this->preventResetByRollback();

        $badges = array();

        $user1 = $this->getDataGenerator()->create_user();

        $user2 = $this->getDataGenerator()->create_user();

        // Record the current time, we need to be precise about a couple of things.

        $now = time();

        // Create 11 badges with which to test.

        for ($i = 1; $i <= 11; $i++) {

            // Mock up a badge.

            $badge = new stdClass();

            $badge->id = null;

            $badge->name = "Test badge $i";

            $badge->description = "Testing badges $i";

            $badge->timecreated = $now - 12;

            $badge->timemodified = $now - 12;

            $badge->usercreated = $user1->id;

            $badge->usermodified = $user1->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 $i";

            $badge->message = "Test message body for badge $i";

            $badge->attachment = 1;

            $badge->notification = 0;

            $badge->status = BADGE_STATUS_INACTIVE;

            $badge->version = "Version $i";

            $badge->language = "en";

            $badge->imagecaption = "Image caption $i";

            $badge->imageauthorname = "Image author's name $i";

            $badge->imageauthoremail = "author$i@example.com";

            $badge->imageauthorname = "Image author's name $i";

            $badgeid = $DB->insert_record('badge', $badge, true);

            $badges[$badgeid] = new badge($badgeid);

            $badges[$badgeid]->issue($user2->id, true);

            // Check it all actually worked.

            $this->assertCount(1, $badges[$badgeid]->get_awards());

            // Hack the database to adjust the time each badge was issued.

            // The alternative to this is sleep which is a no-no in unit tests.

            $DB->set_field('badge_issued', 'dateissued', $now - 11 + $i, array('userid' => $user2->id, 'badgeid' => $badgeid));

        }

        // Make sure the first user has no badges.

        $result = badges_get_user_badges($user1->id);

        $this->assertIsArray($result);

        $this->assertCount(0, $result);

        // Check that the second user has the expected 11 badges.

        $result = badges_get_user_badges($user2->id);

        $this->assertCount(11, $result);

        // Test pagination.

        // Ordering is by time issued desc, so things will come out with the last awarded badge first.

        $result = badges_get_user_badges($user2->id, 0, 0, 4);

        $this->assertCount(4, $result);

        $lastbadgeissued = reset($result);

        $this->assertSame('Test badge 11', $lastbadgeissued->name);

        // Page 2. Expecting 4 results again.

        $result = badges_get_user_badges($user2->id, 0, 1, 4);

        $this->assertCount(4, $result);

        $lastbadgeissued = reset($result);

        $this->assertSame('Test badge 7', $lastbadgeissued->name);

        // Page 3. Expecting just three results here.

        $result = badges_get_user_badges($user2->id, 0, 2, 4);

        $this->assertCount(3, $result);

        $lastbadgeissued = reset($result);

        $this->assertSame('Test badge 3', $lastbadgeissued->name);

        // Page 4.... there is no page 4.

        $result = badges_get_user_badges($user2->id, 0, 3, 4);

        $this->assertCount(0, $result);

        // Test search.

        $result = badges_get_user_badges($user2->id, 0, 0, 0, 'badge 1');

        $this->assertCount(3, $result);

        $lastbadgeissued = reset($result);

        $this->assertSame('Test badge 11', $lastbadgeissued->name);

        // The term Totara doesn't appear anywhere in the badges.

        $result = badges_get_user_badges($user2->id, 0, 0, 0, 'Totara');

        $this->assertCount(0, $result);

        // Issue a user with a course badge and verify its returned based on if

        // coursebadges are enabled or disabled.

        $sitebadgeid = key($badges);

        $badges[$sitebadgeid]->issue($this->user->id, true);

        $badge = new stdClass();

        $badge->id = null;

        $badge->name = "Test course badge";

        $badge->description = "Testing course badge";

        $badge->timecreated = $now;

        $badge->timemodified = $now;

        $badge->usercreated = $user1->id;

        $badge->usermodified = $user1->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_COURSE;

        $badge->courseid = $this->course->id;

        $badge->messagesubject = "Test message subject for course badge";

        $badge->message = "Test message body for course badge";

        $badge->attachment = 1;

        $badge->notification = 0;

        $badge->status = BADGE_STATUS_ACTIVE;

        $badge->version = "Version $i";

        $badge->language = "en";

        $badge->imagecaption = "Image caption";

        $badge->imageauthorname = "Image author's name";

        $badge->imageauthoremail = "author@example.com";

        $badge->imageauthorname = "Image author's name";

        $badgeid = $DB->insert_record('badge', $badge, true);

        $badges[$badgeid] = new badge($badgeid);

        $badges[$badgeid]->issue($this->user->id, true);

        // With coursebadges off, we should only get the site badge.

        set_config('badges_allowcoursebadges', false);

        $result = badges_get_user_badges($this->user->id);

        $this->assertCount(1, $result);

        // With it on, we should get both.

        set_config('badges_allowcoursebadges', true);

        $result = badges_get_user_badges($this->user->id);

        $this->assertCount(2, $result);

    }

    public function data_for_message_from_template() {

        return array(

            array(

                'This is a message with no variables',

                array(), // no params

                'This is a message with no variables'

            ),

            array(

                'This is a message with %amissing% variables',

                array(), // no params

                'This is a message with %amissing% variables'

            ),

            array(

                'This is a message with %one% variable',

                array('one' => 'a single'),

                'This is a message with a single variable'

            ),

            array(

                'This is a message with %one% %two% %three% variables',

                array('one' => 'more', 'two' => 'than', 'three' => 'one'),

                'This is a message with more than one variables'

            ),

            array(

                'This is a message with %three% %two% %one%',

                array('one' => 'variables', 'two' => 'ordered', 'three' => 'randomly'),

                'This is a message with randomly ordered variables'

            ),

            array(

                'This is a message with %repeated% %one% %repeated% of variables',

                array('one' => 'and', 'repeated' => 'lots'),

                'This is a message with lots and lots of variables'

            ),

        );

    }

    /**

     * @dataProvider data_for_message_from_template

     */

    public function test_badge_message_from_template($message, $params, $result): void {

        $this->assertEquals(badge_message_from_template($message, $params), $result);

    }

    /**

     * Test for working around the 61 tables join limit of mysql in award_criteria_activity in combination with the scheduled task.

     *

     * @covers \core_badges\badge::review_all_criteria

     */

    public function test_badge_activity_criteria_with_a_huge_number_of_coursemodules(): void {

        global $CFG;

        require_once($CFG->dirroot.'/completion/criteria/completion_criteria_activity.php');

        if (!PHPUNIT_LONGTEST) {

            $this->markTestSkipped('PHPUNIT_LONGTEST is not defined');

        }

        // Messaging is not compatible with transactions.

        $this->preventResetByRollback();

        // Create more than 61 modules to potentially trigger an mysql db error.

        $assigncount = 75;

        $assigns = [];

        for ($i = 1; $i <= $assigncount; $i++) {

            $assigns[] = $this->getDataGenerator()->create_module('assign', ['course' => $this->course->id], ['completion' => 1]);

        }

        $assigncmids = array_flip(array_map(fn ($assign) => $assign->cmid, $assigns));

        $criteriaactivityarray = array_fill_keys(array_keys($assigncmids), 1);

        // Set completion criteria.

        $criteriadata = (object) [

            'id' => $this->course->id,

            'criteria_activity' => $criteriaactivityarray,

        ];

        $criterion = new completion_criteria_activity();

        $criterion->update_config($criteriadata);

        $badge = new badge($this->coursebadge);

        $criteriaoverall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteriaoverall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY));

        $criteriaactivity = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_ACTIVITY, 'badgeid' => $badge->id]);

        $modulescrit = ['agg' => BADGE_CRITERIA_AGGREGATION_ALL];

        foreach ($assigns as $assign) {

            $modulescrit['module_' . $assign->cmid] = $assign->cmid;

        }

        $criteriaactivity->save($modulescrit);

        // Take one assign to complete it later.

        $assigntemp = array_shift($assigns);

        // Mark the user to complete the modules.

        foreach ($assigns as $assign) {

            $cmassign = get_coursemodule_from_id('assign', $assign->cmid);

            $completion = new \completion_info($this->course);

            $completion->update_state($cmassign, COMPLETION_COMPLETE, $this->user->id);

        }

        // Run the scheduled task to issue the badge. But the badge should not be issued.

        ob_start();

        $task = manager::get_scheduled_task('core\task\badges_cron_task');

        $task->execute();

        ob_end_clean();

        $this->assertFalse($badge->is_issued($this->user->id));

        // Now complete the last uncompleted module.

        $cmassign = get_coursemodule_from_id('assign', $assigntemp->cmid);

        $completion = new \completion_info($this->course);

        $completion->update_state($cmassign, COMPLETION_COMPLETE, $this->user->id);

        // Run the scheduled task to issue the badge. Now the badge schould be issued.

        ob_start();

        $task = manager::get_scheduled_task('core\task\badges_cron_task');

        $task->execute();

        ob_end_clean();

        $this->assertDebuggingCalled('Error baking badge image!');

        $this->assertTrue($badge->is_issued($this->user->id));

    }

    /**

     * Test badges observer when course module completion event id fired.

     */

    public function test_badges_observer_course_module_criteria_review(): void {

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->coursebadge);

        $this->assertFalse($badge->is_issued($this->user->id));

        $criteria_overall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteria_overall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY));

        $criteria_overall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_ACTIVITY, 'badgeid' => $badge->id));

        $criteria_overall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY, 'module_'.$this->module->cmid => $this->module->cmid));

        // Assert the badge will not be issued to the user as is.

        $badge = new badge($this->coursebadge);

        $badge->review_all_criteria();

        $this->assertFalse($badge->is_issued($this->user->id));

        // Set completion for forum activity.

        $c = new completion_info($this->course);

        $activities = $c->get_activities();

        $this->assertEquals(1, count($activities));

        $this->assertTrue(isset($activities[$this->module->cmid]));

        $this->assertEquals($activities[$this->module->cmid]->name, $this->module->name);

        $current = $c->get_data($activities[$this->module->cmid], false, $this->user->id);

        $current->completionstate = COMPLETION_COMPLETE;

        $current->timemodified = time();

        $sink = $this->redirectEmails();

        $c->internal_set_data($activities[$this->module->cmid], $current);

        $this->assertCount(1, $sink->get_messages());

        $sink->close();

        // Check if badge is awarded.

        $this->assertDebuggingCalled('Error baking badge image!');

        $this->assertTrue($badge->is_issued($this->user->id));

    }

    /**

     * Test badges observer when course_completed event is fired.

     */

    public function test_badges_observer_course_criteria_review(): void {

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->coursebadge);

        $this->assertFalse($badge->is_issued($this->user->id));

        $criteria_overall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteria_overall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY));

        $criteria_overall1 = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_COURSE, 'badgeid' => $badge->id));

        $criteria_overall1->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY, 'course_'.$this->course->id => $this->course->id));

        $ccompletion = new completion_completion(array('course' => $this->course->id, 'userid' => $this->user->id));

        // Assert the badge will not be issued to the user as is.

        $badge = new badge($this->coursebadge);

        $badge->review_all_criteria();

        $this->assertFalse($badge->is_issued($this->user->id));

        // Mark course as complete.

        $sink = $this->redirectMessages();

        $ccompletion->mark_complete();

        // Two messages are generated: One for the course completed and the other one for the badge awarded.

        $messages = $sink->get_messages();

        $this->assertCount(2, $messages);

        $this->assertEquals('badgerecipientnotice', $messages[0]->eventtype);

        $this->assertEquals('coursecompleted', $messages[1]->eventtype);

        $sink->close();

        // Check if badge is awarded.

        $this->assertDebuggingCalled('Error baking badge image!');

        $this->assertTrue($badge->is_issued($this->user->id));

    }

    /**

     * Test badges observer when user_updated event is fired.

     */

    public function test_badges_observer_profile_criteria_review(): void {

        global $CFG, $DB;

        require_once($CFG->dirroot.'/user/profile/lib.php');

        // Add a custom field of textarea type.

        $customprofileid = $this->getDataGenerator()->create_custom_profile_field(array(

            'shortname' => 'newfield', 'name' => 'Description of new field',

            'datatype' => 'textarea'))->id;

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->coursebadge);

        $criteria_overall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteria_overall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY));

        $criteria_overall1 = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_PROFILE, 'badgeid' => $badge->id));

        $criteria_overall1->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ALL, 'field_address' => 'address',

            'field_department' => 'department', 'field_' . $customprofileid => $customprofileid));

        // Assert the badge will not be issued to the user as is.

        $badge = new badge($this->coursebadge);

        $badge->review_all_criteria();

        $this->assertFalse($badge->is_issued($this->user->id));

        // Set the required fields and make sure the badge got issued.

        $this->user->address = 'Test address';

        $this->user->department = 'sillywalks';

        $sink = $this->redirectEmails();

        profile_save_data((object)array('id' => $this->user->id, 'profile_field_newfield' => 'X'));

        user_update_user($this->user, false);

        $this->assertCount(1, $sink->get_messages());

        $sink->close();

        // Check if badge is awarded.

        $this->assertDebuggingCalled('Error baking badge image!');

        $this->assertTrue($badge->is_issued($this->user->id));

    }

    /**

     * Test badges observer when cohort_member_added event is fired and user required to belong to any cohort.

     *

     * @covers \award_criteria_cohort

     */

    public function test_badges_observer_any_cohort_criteria_review(): void {

        global $CFG;

        require_once("$CFG->dirroot/cohort/lib.php");

        $cohort1 = $this->getDataGenerator()->create_cohort();

        $cohort2 = $this->getDataGenerator()->create_cohort();

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->badgeid);

        $this->assertFalse($badge->is_issued($this->user->id));

        $this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

        // Set up the badge criteria.

        $criteriaoverall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteriaoverall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY));

        $criteriaoverall1 = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_COHORT, 'badgeid' => $badge->id));

        $criteriaoverall1->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY,

            'cohort_cohorts' => array('0' => $cohort1->id, '1' => $cohort2->id)));

        $badge->set_status(BADGE_STATUS_ACTIVE);

        // Reload it to contain criteria.

        $badge = new badge($this->badgeid);

        $this->assertFalse($badge->is_issued($this->user->id));

        $this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

        // Add the user to the cohort.

        cohort_add_member($cohort2->id, $this->user->id);

        $this->assertDebuggingCalled();

        // Verify that the badge was awarded.

        $this->assertTrue($badge->is_issued($this->user->id));

        // As the badge has been awarded to user because core_badges_observer been called when the member has been added to the

        // cohort, there are no other users that can award this badge.

        $this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

    }

    /**

     * Test badges observer when user_updated event is fired.

     * @covers \award_criteria_courseset

     */

    public function test_badges_observer_courseset_criteria_review(): void {

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->coursebadge);

        $this->assertFalse($badge->is_issued($this->user->id));

        $additionalcourse = $this->getDataGenerator()->create_course(['enablecompletion' => true]);

        $this->getDataGenerator()->enrol_user($this->user->id, $additionalcourse->id);

        $criteriaoverall = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id]);

        $criteriaoverall->save(['agg' => BADGE_CRITERIA_AGGREGATION_ANY]);

        $criteriaoverall1 = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_COURSESET, 'badgeid' => $badge->id]);

        $criteriaoverall1->save(['agg' => BADGE_CRITERIA_AGGREGATION_ANY, 'course_' . $this->course->id => $this->course->id,

            'course_' . $additionalcourse->id => $additionalcourse->id]);

        $ccompletion = new completion_completion(['course' => $this->course->id, 'userid' => $this->user->id]);

        $ccompletion2 = new completion_completion(['course' => $additionalcourse->id, 'userid' => $this->user->id]);

        // Assert the badge will not be issued to the user as is.

        $badge = new badge($this->coursebadge);

        $badge->review_all_criteria();

        $this->assertFalse($badge->is_issued($this->user->id));

        // Mark course as complete.

        $sink = $this->redirectMessages();

        $ccompletion->mark_complete();

        $ccompletion2->mark_complete();

        // Thee messages are generated: Two for the course completed and the other one for the badge awarded.

        $messages = $sink->get_messages();

        $this->assertCount(3, $messages);

        $this->assertEquals('badgerecipientnotice', $messages[0]->eventtype);

        $this->assertEquals('coursecompleted', $messages[1]->eventtype);

        $sink->close();

        // Check if badge is awarded.

        $this->assertDebuggingCalled('Error baking badge image!');

        $this->assertTrue($badge->is_issued($this->user->id));

    }

    /**

     * Test the criteria review method for courseset

     * @covers \award_criteria_courseset::review

     */

    public function test_badges_courseset_criteria_review_empty_courseset(): void {

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->coursebadge);

        $this->assertFalse($badge->is_issued($this->user->id));

        $criteriaoverall = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id]);

        $criteriaoverall->save(['agg' => BADGE_CRITERIA_AGGREGATION_ANY]);

        $criteriaoverall1 = award_criteria::build(['criteriatype' => BADGE_CRITERIA_TYPE_COURSESET, 'badgeid' => $badge->id]);

        $criteriaoverall1->save();

        // Assert the badge will not be issued to the user as is.

        $badge = new badge($this->coursebadge);

        $badge->review_all_criteria();

        $this->assertFalse($badge->is_issued($this->user->id));

    }

    /**

     * Test badges observer when cohort_member_added event is fired and user required to belong to multiple (all) cohorts.

     *

     * @covers \award_criteria_cohort

     */

    public function test_badges_observer_all_cohort_criteria_review(): void {

        global $CFG;

        require_once("$CFG->dirroot/cohort/lib.php");

        $cohort1 = $this->getDataGenerator()->create_cohort();

        $cohort2 = $this->getDataGenerator()->create_cohort();

        $cohort3 = $this->getDataGenerator()->create_cohort();

        // Add user2 to cohort1 and cohort3.

        $user2 = $this->getDataGenerator()->create_user();

        cohort_add_member($cohort3->id, $user2->id);

        cohort_add_member($cohort1->id, $user2->id);

        // Add user3 to cohort1, cohort2 and cohort3.

        $user3 = $this->getDataGenerator()->create_user();

        cohort_add_member($cohort1->id, $user3->id);

        cohort_add_member($cohort2->id, $user3->id);

        cohort_add_member($cohort3->id, $user3->id);

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        // Cohort criteria are used in site badges.

        $badge = new badge($this->badgeid);

        $this->assertFalse($badge->is_issued($this->user->id));

        $this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

        // Set up the badge criteria.

        $criteriaoverall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteriaoverall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY));

        $criteriaoverall1 = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_COHORT, 'badgeid' => $badge->id));

        $criteriaoverall1->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ALL,

            'cohort_cohorts' => array('0' => $cohort1->id, '1' => $cohort2->id, '2' => $cohort3->id)));

        $badge->set_status(BADGE_STATUS_ACTIVE);

        // Reload it to contain criteria.

        $badge = new badge($this->badgeid);

        // Verify that the badge was not awarded yet (ALL cohorts are needed and review_all_criteria has to be called).

        $this->assertFalse($badge->is_issued($this->user->id));

        $this->assertFalse($badge->is_issued($user2->id));

        $this->assertFalse($badge->is_issued($user3->id));

        // Verify that after calling review_all_criteria, users with the criteria (user3) award the badge instantly.

        $this->assertSame(1, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

        $this->assertFalse($badge->is_issued($this->user->id));

        $this->assertFalse($badge->is_issued($user2->id));

        $this->assertTrue($badge->is_issued($user3->id));

        $this->assertDebuggingCalled();

        // Add the user to the cohort1.

        cohort_add_member($cohort1->id, $this->user->id);

        // Verify that the badge was not awarded yet (ALL cohorts are needed).

        $this->assertFalse($badge->is_issued($this->user->id));

        $this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

        // Add the user to the cohort3.

        cohort_add_member($cohort3->id, $this->user->id);

        // Verify that the badge was not awarded yet (ALL cohorts are needed).

        $this->assertFalse($badge->is_issued($this->user->id));

        $this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

        // Add user to cohort2.

        cohort_add_member($cohort2->id, $this->user->id);

        $this->assertDebuggingCalled();

        // Verify that the badge was awarded (ALL cohorts).

        $this->assertTrue($badge->is_issued($this->user->id));

        // As the badge has been awarded to user because core_badges_observer been called when the member has been added to the

        // cohort, there are no other users that can award this badge.

        $this->assertSame(0, $badge->review_all_criteria()); // Verify award_criteria_cohort->get_completed_criteria_sql().

    }

    /**

     * Test badges assertion generated when a badge is issued.

     */

    public function test_badges_assertion(): void {

        $this->preventResetByRollback(); // Messaging is not compatible with transactions.

        $badge = new badge($this->coursebadge);

        $this->assertFalse($badge->is_issued($this->user->id));

        $criteria_overall = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_OVERALL, 'badgeid' => $badge->id));

        $criteria_overall->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ANY));

        $criteria_overall1 = award_criteria::build(array('criteriatype' => BADGE_CRITERIA_TYPE_PROFILE, 'badgeid' => $badge->id));

        $criteria_overall1->save(array('agg' => BADGE_CRITERIA_AGGREGATION_ALL, 'field_address' => 'address'));

        $this->user->address = 'Test address';

        $sink = $this->redirectEmails();

        user_update_user($this->user, false);

        $this->assertCount(1, $sink->get_messages());

        $sink->close();

        // Check if badge is awarded.

        $this->assertDebuggingCalled('Error baking badge image!');

        $awards = $badge->get_awards();

        $this->assertCount(1, $awards);

        // Get assertion.

        $award = reset($awards);

        $assertion = new core_badges_assertion($award->uniquehash, OPEN_BADGES_V1);

        $testassertion = $this->assertion;

        // Make sure JSON strings have the same structure.

        $this->assertStringMatchesFormat($testassertion->badge, json_encode($assertion->get_badge_assertion()));

        $this->assertStringMatchesFormat($testassertion->class, json_encode($assertion->get_badge_class()));

        $this->assertStringMatchesFormat($testassertion->issuer, json_encode($assertion->get_issuer()));

        // Test Openbadge specification version 2.

        // Get assertion version 2.

        $award = reset($awards);

        $assertion2 = new core_badges_assertion($award->uniquehash, OPEN_BADGES_V2);

        $testassertion2 = $this->assertion2;

        // Make sure JSON strings have the same structure.

        $this->assertStringMatchesFormat($testassertion2->badge, json_encode($assertion2->get_badge_assertion()));

        $this->assertStringMatchesFormat($testassertion2->class, json_encode($assertion2->get_badge_class()));

        $this->assertStringMatchesFormat($testassertion2->issuer, json_encode($assertion2->get_issuer()));

        // Test Openbadge specification version 2.1. It has the same format as OBv2.0.

        // Get assertion version 2.1.

        $award = reset($awards);

        $assertion2 = new core_badges_assertion($award->uniquehash, OPEN_BADGES_V2P1);

        // Make sure JSON strings have the same structure.

        $this->assertStringMatchesFormat($testassertion2->badge, json_encode($assertion2->get_badge_assertion()));

        $this->assertStringMatchesFormat($testassertion2->class, json_encode($assertion2->get_badge_class()));

        $this->assertStringMatchesFormat($testassertion2->issuer, json_encode($assertion2->get_issuer()));

    }

    /**

     * Tests the core_badges_myprofile_navigation() function.

     */

    public function test_core_badges_myprofile_navigation(): void {

        // Set up the test.

        $tree = new \core_user\output\myprofile\tree();

        $this->setAdminUser();

        $badge = new badge($this->badgeid);

        $badge->issue($this->user->id, true);

        $iscurrentuser = true;

        $course = null;

        // Enable badges.

        set_config('enablebadges', true);

        // Check the node tree is correct.

        core_badges_myprofile_navigation($tree, $this->user, $iscurrentuser, $course);

        $reflector = new ReflectionObject($tree);

        $nodes = $reflector->getProperty('nodes');

        $this->assertArrayHasKey('localbadges', $nodes->getValue($tree));

    }

    /**

     * Tests the core_badges_myprofile_navigation() function with badges disabled..

     */

    public function test_core_badges_myprofile_navigation_badges_disabled(): void {

        // Set up the test.

        $tree = new \core_user\output\myprofile\tree();

        $this->setAdminUser();

        $badge = new badge($this->badgeid);

        $badge->issue($this->user->id, true);

        $iscurrentuser = false;

        $course = null;

        // Disable badges.

        set_config('enablebadges', false);

        // Check the node tree is correct.

        core_badges_myprofile_navigation($tree, $this->user, $iscurrentuser, $course);

        $reflector = new ReflectionObject($tree);

        $nodes = $reflector->getProperty('nodes');

        $this->assertArrayNotHasKey('localbadges', $nodes->getValue($tree));

    }

    /**

     * Tests the core_badges_myprofile_navigation() function with a course badge.