lib/tests/analysers_test.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Unit tests for core analysers.
  19  *
  20  * @package   core
  21  * @category  test
  22  * @copyright 2017 David Monllaó {@link http://www.davidmonllao.com}
  23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 require_once(__DIR__ . '/../../analytics/tests/fixtures/test_target_shortname.php');
  29 require_once(__DIR__ . '/../../lib/enrollib.php');
  30
  31 /**
  32  * Unit tests for core analysers.
  33  *
  34  * @package   core
  35  * @category  test
  36  * @copyright 2017 David Monllaó {@link http://www.davidmonllao.com}
  37  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38  */
  39 class core_analytics_analysers_testcase extends advanced_testcase {
  40
  41     /**
  42      * test_courses_analyser
  43      *
  44      * @return void
  45      */
  46     public function test_courses_analyser() {
  47         $this->resetAfterTest(true);
  48
  49         $course = $this->getDataGenerator()->create_course();
  50         $coursecontext = \context_course::instance($course->id);
  51
  52         $target = new test_target_shortname();
  53         $analyser = new \core\analytics\analyser\courses(1, $target, [], [], []);
  54         $analysable = new \core_analytics\course($course);
  55
  56         $this->assertInstanceOf('\core_analytics\course', $analyser->get_sample_analysable($course->id));
  57
  58         $this->assertInstanceOf('\context_course', $analyser->sample_access_context($course->id));
  59
  60         // Just 1 sample per course.
  61         $class = new ReflectionClass('\core\analytics\analyser\courses');
  62         $method = $class->getMethod('get_all_samples');
  63         $method->setAccessible(true);
  64         list($sampleids, $samplesdata) = $method->invoke($analyser, $analysable);
  65         $this->assertCount(1, $sampleids);
  66         $sampleid = reset($sampleids);
  67         $this->assertEquals($course->id, $sampleid);
  68         $this->assertEquals($course->fullname, $samplesdata[$sampleid]['course']->fullname);
  69         $this->assertEquals($coursecontext, $samplesdata[$sampleid]['context']);
  70
  71         // To compare it later.
  72         $prevsampledata = $samplesdata[$sampleid];
  73         list($sampleids, $samplesdata) = $analyser->get_samples(array($sampleid));
  74         $this->assertEquals($prevsampledata['context'], $samplesdata[$sampleid]['context']);
  75         $this->assertEquals($prevsampledata['course']->shortname, $samplesdata[$sampleid]['course']->shortname);
  76     }
  77
  78     /**
  79      * test_site_courses_analyser
  80      *
  81      * @return void
  82      */
  83     public function test_site_courses_analyser() {
  84         $this->resetAfterTest(true);
  85
  86         $course1 = $this->getDataGenerator()->create_course();
  87         $course2 = $this->getDataGenerator()->create_course();
  88         $course3 = $this->getDataGenerator()->create_course();
  89         $course1context = \context_course::instance($course1->id);
  90
  91         $target = new test_target_shortname();
  92         $analyser = new \core\analytics\analyser\site_courses(1, $target, [], [], []);
  93         $analysable = new \core_analytics\site();
  94
  95         $this->assertInstanceOf('\core_analytics\site', $analyser->get_sample_analysable($course1->id));
  96         $this->assertInstanceOf('\core_analytics\site', $analyser->get_sample_analysable($course2->id));
  97
  98         $this->assertInstanceOf('\context_system', $analyser->sample_access_context($course1->id));
  99         $this->assertInstanceOf('\context_system', $analyser->sample_access_context($course3->id));
 100
 101         $class = new ReflectionClass('\core\analytics\analyser\site_courses');
 102         $method = $class->getMethod('get_all_samples');
 103         $method->setAccessible(true);
 104         list($sampleids, $samplesdata) = $method->invoke($analyser, $analysable);
 105         $this->assertCount(3, $sampleids);
 106
 107         // Use course1 it does not really matter.
 108         $this->assertArrayHasKey($course1->id, $sampleids);
 109         $sampleid = $course1->id;
 110         $this->assertEquals($course1->id, $sampleid);
 111         $this->assertEquals($course1->fullname, $samplesdata[$sampleid]['course']->fullname);
 112         $this->assertEquals($course1context, $samplesdata[$sampleid]['context']);
 113
 114         // To compare it later.
 115         $prevsampledata = $samplesdata[$sampleid];
 116         list($sampleids, $samplesdata) = $analyser->get_samples(array($sampleid));
 117         $this->assertEquals($prevsampledata['context'], $samplesdata[$sampleid]['context']);
 118         $this->assertEquals($prevsampledata['course']->shortname, $samplesdata[$sampleid]['course']->shortname);
 119     }
 120
 121     /**
 122      * test_site_courses_analyser
 123      *
 124      * @return void
 125      */
 126     public function test_student_enrolments_analyser() {
 127         global $DB;
 128
 129         $this->resetAfterTest(true);
 130
 131         $course = $this->getDataGenerator()->create_course();
 132         $coursecontext = \context_course::instance($course->id);
 133
 134         $user1 = $this->getDataGenerator()->create_user();
 135         $user2 = $this->getDataGenerator()->create_user();
 136         $user3 = $this->getDataGenerator()->create_user();
 137
 138         // Checking that suspended users are also included.
 139         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
 140         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student', 'manual', 0, 0, ENROL_USER_SUSPENDED);
 141         $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'editingteacher');
 142         $enrol = $DB->get_record('enrol', array('courseid' => $course->id, 'enrol' => 'manual'));
 143         $ue1 = $DB->get_record('user_enrolments', array('userid' => $user1->id, 'enrolid' => $enrol->id));
 144         $ue2 = $DB->get_record('user_enrolments', array('userid' => $user2->id, 'enrolid' => $enrol->id));
 145
 146         $target = new test_target_shortname();
 147         $analyser = new \core\analytics\analyser\student_enrolments(1, $target, [], [], []);
 148         $analysable = new \core_analytics\course($course);
 149
 150         $this->assertInstanceOf('\core_analytics\course', $analyser->get_sample_analysable($ue1->id));
 151         $this->assertInstanceOf('\context_course', $analyser->sample_access_context($ue1->id));
 152
 153         $class = new ReflectionClass('\core\analytics\analyser\student_enrolments');
 154         $method = $class->getMethod('get_all_samples');
 155         $method->setAccessible(true);
 156         list($sampleids, $samplesdata) = $method->invoke($analyser, $analysable);
 157         // Only students.
 158         $this->assertCount(2, $sampleids);
 159
 160         $this->assertArrayHasKey($ue1->id, $sampleids);
 161         $this->assertArrayHasKey($ue2->id, $sampleids);
 162
 163         // Shouldn't matter which one we select.
 164         $sampleid = $ue1->id;
 165         $this->assertEquals($ue1, $samplesdata[$sampleid]['user_enrolments']);
 166         $this->assertEquals($course->fullname, $samplesdata[$sampleid]['course']->fullname);
 167         $this->assertEquals($coursecontext, $samplesdata[$sampleid]['context']);
 168         $this->assertEquals($user1->firstname, $samplesdata[$sampleid]['user']->firstname);
 169
 170         // To compare it later.
 171         $prevsampledata = $samplesdata[$sampleid];
 172         list($sampleids, $samplesdata) = $analyser->get_samples(array($sampleid));
 173         $this->assertEquals($prevsampledata['user_enrolments'], $samplesdata[$sampleid]['user_enrolments']);
 174         $this->assertEquals($prevsampledata['context'], $samplesdata[$sampleid]['context']);
 175         $this->assertEquals($prevsampledata['course']->shortname, $samplesdata[$sampleid]['course']->shortname);
 176         $this->assertEquals($prevsampledata['user']->firstname, $samplesdata[$sampleid]['user']->firstname);
 177     }
 178 }