WebSVN – Moodle – Diff – /enrol/tests/enrollib_test.php

  * @package    core
  * @category   phpunit
  * @copyright  2012 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class enrollib_test extends advanced_testcase {
+final class enrollib_test extends advanced_testcase {
     public function test_enrol_get_all_users_courses(): void {
         global $DB, $CFG;
+        $this->resetAfterTest();
         // Use a mock incrementing clock to ensure deterministic and testable time values.
-        $this->resetAfterTest();
+        $clock = $this->mock_clock_with_incrementing(1750000000);
         $studentrole = $DB->get_record('role', array('shortname'=>'student'));
         $manual->enrol_user($maninstance1, $user4->id, $teacherrole->id, 0, 0, ENROL_USER_SUSPENDED);
         $manual->enrol_user($maninstance1, $admin->id, $studentrole->id);
         $manual->enrol_user($maninstance2, $user1->id);
         $manual->enrol_user($maninstance2, $user2->id);
-        $manual->enrol_user($maninstance2, $user3->id, 0, 1, time()+(60*60));
+        $manual->enrol_user($maninstance2, $user3->id, 0, 1, $clock->time() + HOURSECS);
         $manual->enrol_user($maninstance3, $user1->id);
         $manual->enrol_user($maninstance3, $user2->id);
+        $manual->enrol_user($maninstance3, $user3->id, 0, 1, $clock->time() - HOURSECS);
-        $manual->enrol_user($maninstance3, $user3->id, 0, 1, time()-(60*60));
+        $manual->enrol_user($maninstance3, $user4->id, 0, 0, 0, ENROL_USER_SUSPENDED);
         $manual->enrol_user($maninstance3, $user4->id, 0, 0, 0, ENROL_USER_SUSPENDED);
         $manual->enrol_user($maninstance4, $user5->id, 0, $clock->time());
         $courses = enrol_get_all_users_courses($user4->id, true);
         $this->assertCount(0, $courses);
+        $this->assertEquals(array(), array_keys($courses));
+        $courses = enrol_get_all_users_courses($user5->id, true);
+        $this->assertCount(1, $courses);
-        $this->assertEquals(array(), array_keys($courses));
+        $this->assertEquals([$course4->id], array_keys($courses));
         // Make sure sorting and columns work.
     /**
      * Data provider for test_enrol_course_delete_with_userid().
+     *
      * @return array
      */
-    public function enrol_course_delete_with_userid_provider() {
+    public static function enrol_course_delete_with_userid_provider(): array {
         return [
             'The teacher can un-enrol users in a course' =>
+                [
                     'excludedcapabilities' => [],
-                    'results' => [
+                    'expected' => [
                         // Whether certain enrolment related data still exists in the course after the deletion.
                         // When the user has the capabilities to un-enrol users and the enrolment plugins allow manual
                         // unenerolment than all course enrolment data should be removed.
                         'Manual course enrolment instance exists' => false,
                         'Self course enrolment instance exists' => false,
+                [
                     'excludedcapabilities' => [
                         // Exclude the following capabilities for the editing teacher.
                         'enrol/self:unenrol'
                     ],
-                    'results' => [
+                    'expected' => [
                         // When the user does not have the capabilities to un-enrol self enrolled users, the data
                         // related to this enrolment method should not be removed. Everything else should be removed.
                         'Manual course enrolment instance exists' => false,
                         'Self course enrolment instance exists' => true,
                         'User 1 course enrolment exists' => false,
                     'excludedcapabilities' => [
                         // Exclude the following capabilities for the editing teacher.
                         'enrol/manual:unenrol',
                         'enrol/self:unenrol'
                     ],
-                    'results' => [
+                    'expected' => [
                         // When the user does not have the capabilities to un-enrol self and manually enrolled users,
                         // the data related to these enrolment methods should not be removed.
                         'Manual course enrolment instance exists' => true,
                         'Self course enrolment instance exists' => true,
                         'User 1 course enrolment exists' => true,
     /**
      * Data provider for {@see test_enrol_get_my_courses_by_time}
+     *
      * @return array
      */
-    public function enrol_get_my_courses_by_time_provider(): array {
+    public static function enrol_get_my_courses_by_time_provider(): array {
         return [
             'No start or end time' =>
                 [null, null, true],
             'Start time now, no end time' =>
                 [0, null, true],
+    }
     /**
      * Test cases for the test_enrol_get_my_courses_sort_by_last_access test.
      */
-    public function get_enrol_get_my_courses_sort_by_last_access_test_cases() {
+    public static function get_enrol_get_my_courses_sort_by_last_access_test_cases(): array {
         $now = time();
         $enrolledcoursesdata = [
+    }
     /**
      * Test the get_enrolled_courses_by_timeline_classification function.
      *
-     * @dataProvider get_enrol_get_my_courses_sort_by_last_access_test_cases()
+     * @dataProvider get_enrol_get_my_courses_sort_by_last_access_test_cases
      * @param array $enrolledcoursesdata Courses to create and enrol the user in
      * @param array $unenrolledcoursesdata Courses to create nut not enrol the user in
      * @param string $sort Sort string for the enrol function
      * @param int $limit Maximum number of results
+    }
     /**
      * Test get_enrolled_with_capabilities_join cannotmatchanyrows attribute.
      *
-     * @dataProvider get_enrolled_with_capabilities_join_cannotmatchanyrows_data()
+     * @dataProvider get_enrolled_with_capabilities_join_cannotmatchanyrows_data
      * @param string $capability the tested capability
      * @param bool $useprohibit if the capability must be assigned to prohibit
      * @param int $expectedmatch expected cannotmatchanyrows value
      * @param int $expectedcount expceted count value
     /**
      * Data provider for test_get_enrolled_with_capabilities_join_cannotmatchanyrows
+     *
      * @return @array of testing scenarios
      */
-    public function get_enrolled_with_capabilities_join_cannotmatchanyrows_data() {
+    public static function get_enrolled_with_capabilities_join_cannotmatchanyrows_data(): array {
         return [
             'no prohibits, no capability' => [
                 'capability' => '',
                 'useprohibit' => false,
                 'expectedmatch' => 0,
     /**
      * Data provided for test_enrol_check_plugins_with_empty_config_value test.
      * @return array
      */
-    public function empty_config_data_provider(): array {
+    public static function empty_config_data_provider(): array {
         return [
             [0],
             ["0"],
             [false],
+    }
     /**
      * Test the behaviour of validate_enrol_plugin_data().
      *
-     * @covers ::validate_enrol_plugin_data
+     * @covers \enrol_plugin::validate_enrol_plugin_data
      */
     public function test_validate_enrol_plugin_data(): void {
         $this->resetAfterTest();
+    }
     /**
      * Test the behaviour of update_enrol_plugin_data().
      *
-     * @covers ::update_enrol_plugin_data
+     * @covers \enrol_plugin::update_enrol_plugin_data
      */
     public function test_update_enrol_plugin_data(): void {
         global $DB;
         $this->resetAfterTest();
         $expectedinstance->enrolperiod = 7200;
         $expectedinstance->enrolenddate = $expectedinstance->enrolstartdate + $expectedinstance->enrolperiod;
         $modifiedinstance = $manualplugin->update_enrol_plugin_data($course->id, $enrolmentdata, $instance);
         $this->assertEquals($expectedinstance, $modifiedinstance);
+    }
+    /**
+     * Test case for checking the email greetings in various user notification emails.
+     *
+     * @covers \enrol_plugin::send_course_welcome_message_to_user
+     */
+    public function test_email_greetings(): void {
+        global $DB;
+        $this->resetAfterTest();
+        // Create course.
+        $course = $this->getDataGenerator()->create_course([
+            'fullname' => 'Course 1',
+            'shortname' => 'C1',
+        ]);
+        // Create user.
+        $student = $this->getDataGenerator()->create_user();
+        // Get manual plugin.
+        $manualplugin = enrol_get_plugin('manual');
+        $maninstance = $DB->get_record(
+            'enrol',
+            ['courseid' => $course->id, 'enrol' => 'manual'],
+            '*',
+            MUST_EXIST,
+        );
+        $messagesink = $this->redirectMessages();
+        $manualplugin->send_course_welcome_message_to_user(
+            instance: $maninstance,
+            userid: $student->id,
+            sendoption: ENROL_SEND_EMAIL_FROM_NOREPLY,
+            message: '',
+        );
+        $messages = $messagesink->get_messages_by_component_and_type(
+            'moodle',
+            'enrolcoursewelcomemessage',
+        );
+        $this->assertNotEmpty($messages);
+        $message = reset($messages);
+        $this->assertStringContainsString('Hi ' . $student->firstname, quoted_printable_decode($message->fullmessage));
+    }
+}

Proyectos de Subversion Moodle

(root)/enrol/tests/enrollib_test.php – Rev 11 → 1441