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

namespace core_completion;

/**

 * Test completion API.

 *

 * @package core_completion

 * @category test

 * @copyright 2017 Mark Nelson <markn@moodle.com>

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

 * @covers \core_completion\api

 */

final class api_test extends \advanced_testcase {

    /**

     * Test setup.

     */

    public function setUp(): void {

        parent::setUp();

        $this->resetAfterTest();

    }

    public function test_update_completion_date_event(): void {

        global $CFG, $DB;

        $this->setAdminUser();

        // Create a course.

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

        // Create an assign activity.

        $time = time();

        $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));

        // Create the completion event.

        $CFG->enablecompletion = true;

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time);

        // Check that there is now an event in the database.

        $events = $DB->get_records('event');

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

        // Get the event.

        $event = reset($events);

        // Confirm the event is correct.

        $this->assertEquals('assign', $event->modulename);

        $this->assertEquals($assign->id, $event->instance);

        $this->assertEquals(CALENDAR_EVENT_TYPE_ACTION, $event->type);

        $this->assertEquals(\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED, $event->eventtype);

        $this->assertEquals($time, $event->timestart);

        $this->assertEquals($time, $event->timesort);

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

        // Delete the module.

        course_delete_module($assign->cmid);

        // Check we don't get a failure when called on a deleted module.

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', null, $time);

    }

    public function test_update_completion_date_event_update(): void {

        global $CFG, $DB;

        $this->setAdminUser();

        // Create a course.

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

        // Create an assign activity.

        $time = time();

        $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));

        // Create the event.

        $CFG->enablecompletion = true;

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time);

        // Call it again, but this time with a different time.

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time + DAYSECS);

        // Check that there is still only one event in the database.

        $events = $DB->get_records('event');

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

        // Get the event.

        $event = reset($events);

        // Confirm that the event has been updated.

        $this->assertEquals('assign', $event->modulename);

        $this->assertEquals($assign->id, $event->instance);

        $this->assertEquals(CALENDAR_EVENT_TYPE_ACTION, $event->type);

        $this->assertEquals(\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED, $event->eventtype);

        $this->assertEquals($time + DAYSECS, $event->timestart);

        $this->assertEquals($time + DAYSECS, $event->timesort);

    }

    public function test_update_completion_date_event_delete(): void {

        global $CFG, $DB;

        $this->setAdminUser();

        // Create a course.

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

        // Create an assign activity.

        $time = time();

        $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));

        // Create the event.

        $CFG->enablecompletion = true;

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time);

        // Call it again, but the time specified as null.

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, null);

        // Check that there is no event in the database.

        $this->assertEquals(0, $DB->count_records('event'));

    }

    public function test_update_completion_date_event_completion_disabled(): void {

        global $CFG, $DB;

        $this->setAdminUser();

        // Create a course.

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

        // Create an assign activity.

        $time = time();

        $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));

        // Try and create the completion event with completion disabled.

        $CFG->enablecompletion = false;

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time);

        // Check that there is no event in the database.

        $this->assertEquals(0, $DB->count_records('event'));

    }

    public function test_update_completion_date_event_update_completion_disabled(): void {

        global $CFG, $DB;

        $this->setAdminUser();

        // Create a course.

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

        // Create an assign activity.

        $time = time();

        $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));

        // Create the completion event.

        $CFG->enablecompletion = true;

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time);

        // Disable completion.

        $CFG->enablecompletion = false;

        // Try and update the completion date.

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time + DAYSECS);

        // Check that there is an event in the database.

        $events = $DB->get_records('event');

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

        // Get the event.

        $event = reset($events);

        // Confirm the event has not changed.

        $this->assertEquals('assign', $event->modulename);

        $this->assertEquals($assign->id, $event->instance);

        $this->assertEquals(CALENDAR_EVENT_TYPE_ACTION, $event->type);

        $this->assertEquals(\core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED, $event->eventtype);

        $this->assertEquals($time, $event->timestart);

        $this->assertEquals($time, $event->timesort);

    }

    public function test_update_completion_date_event_delete_completion_disabled(): void {

        global $CFG, $DB;

        $this->setAdminUser();

        // Create a course.

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

        // Create an assign activity.

        $time = time();

        $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id));

        // Create the completion event.

        $CFG->enablecompletion = true;

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, $time);

        // Disable completion.

        $CFG->enablecompletion = false;

        // Should still be able to delete completion events even when completion is disabled.

        \core_completion\api::update_completion_date_event($assign->cmid, 'assign', $assign, null);

        // Check that there is now no event in the database.

        $this->assertEquals(0, $DB->count_records('event'));

    }

    /**

     * Test for mark_course_completions_activity_criteria().

     */

    public function test_mark_course_completions_activity_criteria(): void {

        global $DB, $CFG;

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

        $this->resetAfterTest(true);

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

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

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

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

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

        $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));

        $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);

        $this->getDataGenerator()->enrol_user($student1->id, $course->id, $studentrole->id);

        $this->getDataGenerator()->enrol_user($student2->id, $course->id, $studentrole->id);

        $data = $this->getDataGenerator()->create_module('data', array('course' => $course->id),

            array('completion' => 1));

        $cmdata = get_coursemodule_from_id('data', $data->cmid);

        $cm = get_coursemodule_from_instance('data', $data->id);

        $c = new \completion_info($course);

        // Add activity completion criteria.

        $criteriadata = new \stdClass();

        $criteriadata->id = $course->id;

        $criteriadata->criteria_activity = array();

        // Some activities.

        $criteriadata->criteria_activity[$cmdata->id] = 1;

        $criterion = new \completion_criteria_activity();

        $criterion->update_config($criteriadata);

        $this->setUser($teacher);

        // Mark activity complete for both users.

        $completion = new \stdClass();

        $completion->coursemoduleid = $cm->id;

        $completion->completionstate = COMPLETION_COMPLETE;

        $completion->timemodified = time();

        $completion->viewed = COMPLETION_NOT_VIEWED;

        $completion->overrideby = null;

        $completion->id = 0;

        $completion->userid = $student1->id;

        $c->internal_set_data($cm, $completion, true);

        $completion->id = 0;

        $completion->userid = $student2->id;

        $c->internal_set_data($cm, $completion, true);

        // Run instant course completions for student1. Only student1 will be marked as completed a course.

        $userdata = ['userid' => $student1->id, 'courseid' => $course->id];

        $actual = $DB->get_records('course_completions');

        $this->assertEmpty($actual);

        $coursecompletionid = \core_completion\api::mark_course_completions_activity_criteria($userdata);

        $actual = $DB->get_records('course_completions');

        $this->assertEquals(reset($actual)->id, $coursecompletionid);

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

        $this->assertEquals($student1->id, reset($actual)->userid);

        // Run course completions cron. Both students will be marked as completed a course.

        $coursecompletionid = \core_completion\api::mark_course_completions_activity_criteria();

        $this->assertEquals(0, $coursecompletionid);

        $actual = $DB->get_records('course_completions');

        $students = [$student1->id, $student2->id];

        $this->assertEquals(2, count($actual));

        $this->assertContains(reset($actual)->userid, $students);

        $this->assertContains(end($actual)->userid, $students);

    }

    /**

     * Test for mark_course_completions_activity_criteria() with different completionpassgrade settings.

     */

    public function test_mark_course_completions_activity_criteria_completion_states(): void {

        global $DB, $CFG;

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

        $this->resetAfterTest(true);

        $courses[] = $this->getDataGenerator()->create_course(['shortname' => 'completionpassgradenotset',

            'enablecompletion' => 1]);

        $courses[] = $this->getDataGenerator()->create_course(['shortname' => 'completionpassgradeset',

            'enablecompletion' => 1]);

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

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

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

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

        $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));

        foreach ($courses as $course) {

            $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);

            $this->getDataGenerator()->enrol_user($student1->id, $course->id, $studentrole->id);

            $this->getDataGenerator()->enrol_user($student2->id, $course->id, $studentrole->id);

            $completioncriteria = [

                'completionusegrade' => 1,

                'gradepass' => 50

            ];

            if ($course->shortname == 'completionpassgradeset') {

                $completioncriteria['completionpassgrade'] = 1;

            }

            /** @var \mod_assign_generator $assigngenerator */

            $assigngenerator = $this->getDataGenerator()->get_plugin_generator('mod_assign');

            $assign = $assigngenerator->create_instance([

                    'course' => $course->id,

                    'completion' => COMPLETION_ENABLED,

                ] + $completioncriteria);

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

            $cm = get_coursemodule_from_instance('assign', $assign->id);

            $c = new \completion_info($course);

            // Add activity completion criteria.

            $criteriadata = new \stdClass();

            $criteriadata->id = $course->id;

            $criteriadata->criteria_activity = array();

            // Some activities.

            $criteriadata->criteria_activity[$cmassing->id] = 1;

            $criterion = new \completion_criteria_activity();

            $criterion->update_config($criteriadata);

            $this->setUser($teacher);

            // Mark user completions.

            $completion = new \stdClass();

            $completion->coursemoduleid = $cm->id;

            $completion->timemodified = time();

            $completion->viewed = COMPLETION_NOT_VIEWED;

            $completion->overrideby = null;

            // Student1 achieved passgrade.

            $completion->id = 0;

            $completion->completionstate = COMPLETION_COMPLETE_PASS;

            $completion->userid = $student1->id;

            $c->internal_set_data($cm, $completion, true);

            // Student2 has not achieved passgrade.

            $completion->id = 0;

            $completion->completionstate = COMPLETION_COMPLETE_FAIL;

            $completion->userid = $student2->id;

            $c->internal_set_data($cm, $completion, true);

            $actual = $DB->get_records('course_completions', ['course' => $course->id]);

            $this->assertEmpty($actual);

            // Run course completions cron.

            $coursecompletionid = \core_completion\api::mark_course_completions_activity_criteria();

            $this->assertEquals(0, $coursecompletionid);

            $actual = $DB->get_records('course_completions', ['course' => $course->id]);

            if ($course->shortname == 'completionpassgradeset') {

                // Only student1 has completed a course.

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

                $this->assertEquals($student1->id, reset($actual)->userid);

            } else {

                // Both students completed a course.

                $students = [$student1->id, $student2->id];

                $this->assertEquals(2, count($actual));

                $this->assertContains(reset($actual)->userid, $students);

                $this->assertContains(end($actual)->userid, $students);

            }

        }

    }

}