WebSVN – Moodle – Diff – /lib/tests/moodlelib_test.php

 // 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;
-use lang_string;
+use core\tests\fake_plugins_test_trait;
 /**
  * @author     T.J.Hunt@open.ac.uk
  * @author     nicolas@moodle.com
  */
 final class moodlelib_test extends \advanced_testcase {
+    use fake_plugins_test_trait;
     /**
      * Define a local decimal separator.
+     *
      * It is not possible to directly change the result of get_string in
     /**
      * Provider for long filenames and its expected result, with and without hash.
+     *
      * @return array of ($filename, $length, $expected, $includehash)
      */
-    public function shorten_filename_provider() {
+    public static function shorten_filename_provider(): array {
         $filename = 'sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium totam rem';
         $shortfilename = 'sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque';
         return [
     /**
      * Provider for long filenames and its expected result, with and without hash.
+     *
      * @return array of ($filename, $length, $expected, $includehash)
      */
-    public function shorten_filenames_provider() {
+    public static function shorten_filenames_provider(): array {
         $shortfilename = 'sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque';
         $longfilename = 'sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium totam rem';
         $extfilename = $longfilename.'.zip';
         $expected = 'sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium tot';
         $expectedwithhash = 'sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque l - 3bec1da8b8';
         set_user_preference('_test_long_user_preference', $longvalue);
         $this->assertEquals($longvalue, get_user_preferences('_test_long_user_preference'));
         $this->assertEquals($longvalue,
             $DB->get_field('user_preferences', 'value', array('userid' => $USER->id, 'name' => '_test_long_user_preference')));
-        // Test > 1333 char values, coding_exception expected.
+        // Larger preference values are allowed as of MDL-46739.
-        $longvalue = str_repeat('a', 1334);
-        try {
+        $longervalue = str_repeat('a', 1334);
-            set_user_preference('_test_long_user_preference', $longvalue);
+        set_user_preference('_test_long_user_preference', $longervalue);
-            $this->fail('Exception expected - longer than 1333 chars not allowed as preference value');
+        $this->assertEquals($longervalue, get_user_preferences('_test_long_user_preference'));
+        $this->assertEquals(
-        } catch (\moodle_exception $ex) {
+            $longervalue,
-            $this->assertInstanceOf('coding_exception', $ex);
+            $DB->get_field('user_preferences', 'value', ['userid' => $USER->id, 'name' => '_test_long_user_preference'])
         );
         // Test invalid params.
         try {
         // In PHP 8.2 exported class names are now fully qualified;
         // previously, the leading backslash was omitted.
         $leadingbackslash = (version_compare(PHP_VERSION, '8.2.0', '>=')) ? '\\' : '';
         $expected1 = <<<EOF
-{$leadingbackslash}lang_string::__set_state(array(
-   'identifier' => 'no',
+{$leadingbackslash}core\lang_string::__set_state(array(
    'component' => 'moodle',
-   'a' => NULL,
-   'lang' => NULL,
+   'a' => NULL,
    'string' => NULL,
+   'forcedstring' => false,
+   'identifier' => 'no',
-   'forcedstring' => false,
+   'lang' => NULL,
 ))
 EOF;
+     *
      * @return array
      */
     public static function update_internal_user_password_no_cache_provider(): array {
         return [
-            'Password is not empty' => ['cas', 'wonkawonka'],
+            'Password is not empty' => ['db', 'wonkawonka'],
             'Password is an empty string' => ['oauth2', ''],
             'Password is null' => ['oauth2', null],
         ];
+    }
     public function test_update_internal_user_password_update_no_cache(): void {
         $this->resetAfterTest();
         $user = $this->getDataGenerator()->create_user(array('password' => 'test'));
         $this->assertNotEquals(AUTH_PASSWORD_NOT_CACHED, $user->password);
-        $user->auth = 'cas'; // Change to a auth that does not store passwords.
+        $user->auth = 'db'; // Change to a auth that does not store passwords.
         $sink = $this->redirectEvents();
+    }
     /**
      * A data provider for testing email messageid
      */
-    public function generate_email_messageid_provider() {
+    public static function generate_email_messageid_provider(): array {
         return array(
             'nopath' => array(
                 'wwwroot' => 'http://www.example.com',
-                'ids' => array(
+                'msgids' => array(
                     'a-custom-id' => '<a-custom-id@www.example.com>',
                     'an-id-with-/-a-slash' => '<an-id-with-%2F-a-slash@www.example.com>',
                 ),
             ),
             'path' => array(
                 'wwwroot' => 'http://www.example.com/path/subdir',
-                'ids' => array(
+                'msgids' => array(
                     'a-custom-id' => '<a-custom-id/path/subdir@www.example.com>',
                     'an-id-with-/-a-slash' => '<an-id-with-%2F-a-slash/path/subdir@www.example.com>',
                 ),
             ),
+    }
     /**
      * A data provider for testing email diversion
      */
-    public function diverted_emails_provider() {
+    public static function diverted_emails_provider(): array {
         return array(
             'nodiverts' => array(
                 'divertallemailsto' => null,
                 'divertallemailsexcept' => null,
-                array(
+                'addresses' => array(
                     'foo@example.com',
                     'test@real.com',
                     'fred.jones@example.com',
                     'dev1@dev.com',
                     'fred@example.com',
                     'fred+verp@example.com',
                 ),
-                false,
+                'expected' => false,
             ),
             'alldiverts' => array(
                 'divertallemailsto' => 'somewhere@elsewhere.com',
                 'divertallemailsexcept' => null,
-                array(
+                'addresses' => array(
                     'foo@example.com',
                     'test@real.com',
                     'fred.jones@example.com',
                     'dev1@dev.com',
                     'fred@example.com',
                     'fred+verp@example.com',
                 ),
-                true,
+                'expected' => true,
             ),
             'alsodiverts' => array(
                 'divertallemailsto' => 'somewhere@elsewhere.com',
                 'divertallemailsexcept' => '@dev.com, fred(\+.*)?@example.com',
-                array(
+                'addresses' => array(
                     'foo@example.com',
                     'test@real.com',
                     'fred.jones@example.com',
                     'Fred.Jones@Example.com',
                 ),
-                true,
+                'expected' => true,
             ),
             'divertsexceptions' => array(
                 'divertallemailsto' => 'somewhere@elsewhere.com',
                 'divertallemailsexcept' => '@dev.com, fred(\+.*)?@example.com',
-                array(
+                'addresses' => array(
                     'dev1@dev.com',
                     'fred@example.com',
                     'Fred@Example.com',
                     'fred+verp@example.com',
                 ),
-                false,
+                'expected' => false,
             ),
             'divertsexceptionsnewline' => array(
                 'divertallemailsto' => 'somewhere@elsewhere.com',
                 'divertallemailsexcept' => "@dev.com\nfred(\+.*)?@example.com",
-                array(
+                'addresses' => array(
                     'dev1@dev.com',
                     'fred@example.com',
                     'fred+verp@example.com',
                 ),
-                false,
+                'expected' => false,
             ),
             'alsodivertsnewline' => array(
                 'divertallemailsto' => 'somewhere@elsewhere.com',
                 'divertallemailsexcept' => "@dev.com\nfred(\+.*)?@example.com",
-                array(
+                'addresses' => array(
                     'foo@example.com',
                     'test@real.com',
                     'fred.jones@example.com',
                 ),
-                true,
+                'expected' => true,
             ),
             'alsodivertsblankline' => array(
                 'divertallemailsto' => 'somewhere@elsewhere.com',
                 'divertallemailsexcept' => "@dev.com\n",
                 'addresses' => [
                     'lionel@example.com',
                 ],
-                true,
+                'expected' => true,
             ),
             'divertsexceptionblankline' => array(
                 'divertallemailsto' => 'somewhere@elsewhere.com',
                 'divertallemailsexcept' => "@example.com\n",
                 'addresses' => [
                     'lionel@example.com',
                 ],
-                false,
+                'expected' => false,
             ),
         );
+    }
     /**
      * Data provider for {@see test_email_to_user_attachment}
+     *
      * @return array
      */
-    public function email_to_user_attachment_provider(): array {
+    public static function email_to_user_attachment_provider(): array {
         global $CFG;
         // Return all paths that can be used to send attachments from.
         return [
     /**
      * Data provider for {@see test_count_words}.
+     *
      * @return array of test cases.
      */
-    public function count_words_testcases(): array {
+    public static function count_words_testcases(): array {
         // Copy-pasting example from MDL-64240.
         $copypasted = <<<EOT
 <p onclick="alert('boop');">Snoot is booped</p>
  <script>alert('Boop the snoot');</script>
  <img alt="Boop the Snoot." src="https://proxy.duckduckgo.com/iu/?u=http%3A%2F%2Fwww.geekfill.com%2Fwp-content%2Fuploads%2F2015%2F08%2FBoop-the-Snoot.jpg&f=1">
     /**
      * Data provider for {@see count_letters_testcases}.
+     *
      * @return array of test cases.
      */
-    public function count_letters_testcases(): array {
+    public static function count_letters_testcases(): array {
         return [
             [0, ''],
             [1, 'x'],
             [1, '&amp;'],
             [4, '<p>frog</p>'],
+    }
     /**
      * Data provider for private ips.
      */
-    public function data_private_ips() {
+    public static function data_private_ips(): array {
         return array(
             array('10.0.0.0'),
             array('172.16.0.0'),
             array('192.168.1.0'),
+    }
     /**
      * Data provider for public ips.
      */
-    public function data_public_ips() {
+    public static function data_public_ips(): array {
         return array(
             array('2400:cb00:2048:1::8d65:71b3'),
             array('2400:6180:0:d0::1b:2001'),
             array('141.101.113.179'),
     /**
      * Data provider for test_can_send_from_real_email_address.
+     *
      * @return array Returns an array of test data for the above function.
      */
-    public function data_can_send_from_real_email_address() {
+    public static function data_can_send_from_real_email_address(): array {
         return [
             // Test from email is in allowed domain.
             // Test that from display is set to show no one.
+            [
                 'email' => 'fromuser@example.com',
     /**
      * Data provider for data_email_is_not_allowed_for_allowemailaddresses.
+     *
      * @return array Returns an array of test data for the above function.
      */
-    public function data_email_is_not_allowed_for_allowemailaddresses() {
+    public static function data_email_is_not_allowed_for_allowemailaddresses(): array {
         return [
             // Test allowed domain empty list.
+            [
                 'email' => 'fromuser@example.com',
                 'config' => '',
     /**
      * Data provider for test_email_is_not_allowed_for_denyemailaddresses.
+     *
      * @return array Returns an array of test data for the above function.
      */
-    public function data_email_is_not_allowed_for_denyemailaddresses() {
+    public static function data_email_is_not_allowed_for_denyemailaddresses(): array {
         return [
             // Test denied domain empty list.
+            [
                 'email' => 'fromuser@example.com',
                 'config' => '',
     /**
      * Data provider with list of default values for user in component_class_callback tests.
+     *
      * @return array
      */
-    public function component_class_callback_default_provider() {
+    public static function component_class_callback_default_provider(): array {
         return [
             'null' => [null],
             'empty string' => [''],
             'string' => ['This is a string'],
             'int' => [12345],
     /**
      * Data provider with list of default values for user in component_class_callback tests.
+     *
      * @return array
      */
-    public function component_class_callback_data_provider() {
+    public static function component_class_callback_data_provider(): array {
         return [
             'empty string' => [''],
             'string' => ['This is a string'],
             'int' => [12345],
             'stdClass' => [(object) ['this is my content']],
     /**
      * Data provider with list of default values for user in component_class_callback tests.
+     *
      * @return array
      */
-    public function component_class_callback_multiple_params_provider() {
+    public static function component_class_callback_multiple_params_provider(): array {
         return [
             'empty array' => [
                 [],
 ,
             ],
     /**
      * Provides a set of callables and their human readable names.
+     *
      * @return array of (string)case => [(mixed)callable, (string|bool)expected description]
      */
-    public function callable_names_provider() {
+    public static function callable_names_provider(): array {
         return [
             'integer' => [
 ,
                 false,
             ],
             ],
             'static_method_of_literal_class' => [
                 ['my_foobar_class', 'my_foobar_method'],
                 'my_foobar_class::my_foobar_method',
             ],
-            'static_method_of_object' => [
-                [$this, 'my_foobar_method'],
-                'core\moodlelib_test::my_foobar_method',
-            ],
             'method_of_object' => [
                 [new lang_string('parentlanguage', 'core_langconfig'), 'my_foobar_method'],
-                'lang_string::my_foobar_method',
+                'core\lang_string::my_foobar_method',
             ],
             'function_as_literal' => [
                 'my_foobar_callback',
                 'my_foobar_callback',
             ],
             ],
         ];
+    }
+    /**
+     * Test that get_callable_name works with a static method on an instance.
+     */
+    public function test_get_callable_name_this(): void {
+        $this->assertSame('core\moodlelib_test::foo', get_callable_name([$this, 'foo']));
+    }
     /**
      * Data provider for \core_moodlelib_testcase::test_get_complete_user_data().
+     *
      * @return array
      */
-    public function user_data_provider() {
+    public static function user_data_provider(): array {
         return [
             'Fetch data using a valid username' => [
                 'username', 's1', true
             ],
+    }
     /**
      * Data provider for the test_get_time_interval_string() method.
      */
-    public function get_time_interval_string_provider() {
+    public static function get_time_interval_string_provider(): array {
         return [
             'Time is after the reference time by 1 minute, omitted format' => [
                 'time1' => 12345660,
                 'time2' => 12345600,
     /**
      * Provider for display_size
+     *
      * @return array of ($size, $expected)
      */
-    public function display_size_provider() {
+    public static function display_size_provider(): array {
         return [
             [0, '0 bytes'],
             [1, '1 bytes'],
     /**
      * Provider for display_size using fixed units.
+     *
      * @return array of ($size, $units, $expected)
      */
-    public function display_size_fixed_provider(): array {
+    public static function display_size_fixed_provider(): array {
         return [
             [0, 'KB', '0.0 KB'],
             [1, 'MB', '0.0 MB'],
             [777777777, 'GB', '0.7 GB'],
             [8888888888, 'PB', '0.0 PB'],
     /**
      * Provider for display_size using specified decimal places.
+     *
      * @return array of ($size, $decimalplaces, $units, $expected)
      */
-    public function display_size_dp_provider(): array {
+    public static function display_size_dp_provider(): array {
         return [
             [0, 1, 'KB', '0.0 KB'],
             [1, 6, 'MB', '0.000001 MB'],
             [777777777, 0, 'GB', '1 GB'],
             [777777777, 0, '', '742 MB'],
     /**
      * Data provider for get_list_of_plugins checks.
+     *
      * @return  array
      */
-    public function get_list_of_plugins_provider(): array {
+    public static function get_list_of_plugins_provider(): array {
         return [
             'Standard excludes' => [
                 ['amdd', 'class', 'local', 'test'],
+                [
                     '.' => [],
      * Test get_home_page() method.
+     *
      * @dataProvider get_home_page_provider
      * @param string $user Whether the user is logged, guest or not logged.
      * @param int $expected Expected value after calling the get_home_page method.
-     * @param int $defaulthomepage The $CFG->defaulthomepage setting value.
+     * @param int|string|null $defaulthomepage The $CFG->defaulthomepage setting value.
-     * @param int $enabledashboard Whether the dashboard should be enabled or not.
+     * @param int|null $enabledashboard Whether the dashboard should be enabled or not.
-     * @param int $userpreference User preference for the home page setting.
+     * @param int|string|null $userpreference User preference for the home page setting.
+     * $param int|null $allowguestmymoodle The $CFG->allowguestmymoodle setting value.
      * @covers ::get_home_page
      */
+    public function test_get_home_page(
+        string $user,
+        int $expected,
-    public function test_get_home_page(string $user, int $expected, ?int $defaulthomepage = null, ?int $enabledashboard = null,
+        int|string|null $defaulthomepage = null,
+        ?int $enabledashboard = null,
-            ?int $userpreference = null): void {
+        int|string|null $userpreference = null,
+        ?int $allowguestmymoodle = null,
+    ): void {
         global $CFG, $USER;
         $this->resetAfterTest();
             $CFG->defaulthomepage = $defaulthomepage;
+        }
         if (isset($enabledashboard)) {
             $CFG->enabledashboard = $enabledashboard;
+        }
+        if (isset($allowguestmymoodle)) {
+            $CFG->allowguestmymoodle = $allowguestmymoodle;
+        }
         if ($USER) {
             set_user_preferences(['user_home_page_preference' => $userpreference], $USER->id);
     /**
      * Data provider for get_home_page checks.
+     *
      * @return array
      */
-    public function get_home_page_provider(): array {
+    public static function get_home_page_provider(): array {
+        global $CFG;
         return [
             'No logged user' => [
                 'user' => 'nologged',
                 'expected' => HOMEPAGE_SITE,
             ],
+            'Guest user. Dashboard set as default home page and enabled for guests' => [
-            'Guest user' => [
+                'user' => 'guest',
+                'expected' => HOMEPAGE_MY,
+            ],
+            'Guest user. Dashboard set as default home page but disabled for guests' => [
                 'user' => 'guest',
                 'expected' => HOMEPAGE_SITE,
+                'defaulthomepage' => HOMEPAGE_MY,
+                'enabledashboard' => 1,
+                'userpreference' => null,
+                'allowguestmymoodle' => 0,
+            ],
+            'Guest user. My courses set as default home page' => [
+                'user' => 'guest',
+                'expected' => HOMEPAGE_SITE,
+                'defaulthomepage' => HOMEPAGE_MYCOURSES,
+            ],
+            'Guest user. User preference set as default page' => [
+                'user' => 'guest',
+                'expected' => HOMEPAGE_SITE,
+                'defaulthomepage' => HOMEPAGE_USER,
             ],
             'Logged user. Dashboard set as default home page and enabled' => [
                 'user' => 'logged',
                 'expected' => HOMEPAGE_MY,
-                'defaulthomepage' => HOMEPAGE_MY,
-                'enabledashboard' => 1,
             ],
             'Logged user. Dashboard set as default home page but disabled' => [
                 'user' => 'logged',
                 'expected' => HOMEPAGE_MYCOURSES,
                 'defaulthomepage' => HOMEPAGE_MY,
                 'user' => 'logged',
                 'expected' => HOMEPAGE_SITE,
                 'defaulthomepage' => HOMEPAGE_SITE,
                 'enabledashboard' => 0,
             ],
+            'Logged user. URL set as default home page.' => [
+                'user' => 'logged',
+                'expected' => HOMEPAGE_URL,
+                'defaulthomepage' => "/home",
+            ],
             'Logged user. User preference set as default page with dashboard enabled and user preference set to dashboard' => [
                 'user' => 'logged',
                 'expected' => HOMEPAGE_MY,
                 'defaulthomepage' => HOMEPAGE_USER,
                 'enabledashboard' => 1,
                 'expected' => HOMEPAGE_MYCOURSES,
                 'defaulthomepage' => HOMEPAGE_USER,
                 'enabledashboard' => 0,
                 'userpreference' => HOMEPAGE_MYCOURSES,
             ],
+            'Logged user. User preference set as default page with user preference set to URL.' => [
+                'user' => 'logged',
+                'expected' => HOMEPAGE_URL,
+                'defaulthomepage' => HOMEPAGE_USER,
+                'enabledashboard' => null,
+                'userpreference' => "/home",
+            ],
         ];
+    }
     /**
         $default = get_default_home_page();
         $this->assertEquals(HOMEPAGE_MYCOURSES, $default);
+    }
+    /**
+     * Test getting default home page for {@see HOMEPAGE_URL}
+     *
+     * @covers ::get_default_home_page_url
+     */
+    public function test_get_default_home_page_url(): void {
+        global $CFG;
+        $this->resetAfterTest();
+        $this->setAdminUser();
+        $this->assertNull(get_default_home_page_url());
+        // Site configuration.
+        $CFG->defaulthomepage = "/home";
+        $this->assertEquals("{$CFG->wwwroot}/home", get_default_home_page_url());
+        // Site configuration with invalid value.
+        $CFG->defaulthomepage = "home";
+        $this->assertNull(get_default_home_page_url());
+        // User preference.
+        $CFG->defaulthomepage = HOMEPAGE_USER;
+        $userpreference = "/about";
+        set_user_preference('user_home_page_preference', $userpreference);
+        $this->assertEquals("{$CFG->wwwroot}/about", get_default_home_page_url());
+        // User preference with invalid value.
+        set_user_preference('user_home_page_preference', "about");
+        $this->assertNull(get_default_home_page_url());
+    }
     /**
      * Tests the get_performance_info function with regard to locks.
+     *
      * @covers ::get_performance_info
      */
     /**
      * Provider for is_proxybypass
+     *
      * @return array of test cases.
      */
-    public function is_proxybypass_provider(): array {
+    public static function is_proxybypass_provider(): array {
         return [
             'Proxybypass contains the same IP as the beginning of the URL' => [
                 'http://192.168.5.5-fake-app-7f000101.nip.io',
+                '192.168.5.5,127.0.0.1',
+                false,
+            ],
+            'Proxybypass contains some extra whitespaces (test with hostname)' => [
+                'store.mydomain.com',
+                'store.mydomain.com , 192.168.5.5',
+                false,
+            ],
+            'Proxybypass contains some extra whitespaces (test with IP)' => [
+                '192.168.5.5',
-                '192.168.5.5, 127.0.0.1',
+                'store.mydomain.com , 192.168.5.5',
-                false
+                false,
             ],
             'Proxybypass contains the last part of the URL' => [
                 'http://192.168.5.5-fake-app-7f000101.nip.io',
                 'app-7f000101.nip.io',
-                false
+                false,
             ],
             'Proxybypass contains the last part of the URL 2' => [
                 'http://store.mydomain.com',
                 'mydomain.com',
-                false
+                false,
             ],
             'Proxybypass contains part of the url' => [
                 'http://myweb.com',
                 'store.myweb.com',
+                false,
+            ],
+            'Proxybypass with a wildcard contains part of the url' => [
+                'http://myweb.com',
+                '*.myweb.com',
-                false
+                false,
             ],
             'Different IPs used in proxybypass' => [
                 'http://192.168.5.5',
                 '192.168.5.3',
+                false,
+            ],
+            'Different partial IPs used in proxybypass' => [
+                'http://192.168.5.5',
+                '192.16',
+                false,
+            ],
+            'Different partial IPs used in proxybypass with ending dot' => [
+                'http://192.168.5.5',
+                '192.16.',
-                false
+                false,
             ],
             'Proxybypass and URL matchs' => [
                 'http://store.mydomain.com',
                 'store.mydomain.com',
+                true,
+            ],
+            'Proxybypass with a wildcard value covers any subdomain' => [
+                'http://store.mydomain.com',
+                '*.mydomain.com',
+                true,
+            ],
+            'Proxybypass with a wildcard value covers any higher level subdomain' => [
+                'http://another.store.mydomain.com',
+                '*.mydomain.com',
+                true,
+            ],
+            'Proxybypass with multiple domains' => [
+                'http://store.mydomain.com',
+                '127.0.0.1,*.mydomain.com',
-                true
+                true,
             ],
             'IP used in proxybypass' => [
                 'http://192.168.5.5',
                 '192.168.5.5',
+                true,
+            ],
+            'Partial IP used in proxybypass' => [
+                'http://192.168.5.5',
+                '192.168.',
-                true
+                true,
             ],
         ];
+    }
                 true,
                 ['one'],
             ],
         ];
+    }
+    /**
+     * Test case for checking the email greetings in various user notification emails.
+     *
+     * @dataProvider email_greetings_provider
+     * @param string $funcname The name of the function to call for sending the email.
+     * @param mixed $extra Any extra parameter required by the function.
+     * @covers ::send_password_change_info()
+     * @covers ::send_confirmation_email()
+     * @covers ::setnew_password_and_mail()
+     * @covers ::send_password_change_confirmation_email()
+     */
+    public function test_email_greetings($funcname, $extra): void {
+        $this->resetAfterTest();
+        $user = $this->getDataGenerator()->create_user();
+        $sink = $this->redirectEmails(); // Make sure we are redirecting emails.
+        $funcname($user, $extra);
+        $result = $sink->get_messages();
+        $sink->close();
+        // Test greetings.
+        $this->assertStringContainsString('Hi ' . $user->firstname, quoted_printable_decode($result[0]->body));
+    }
+    /**
+     * Data provider for test_email_greetings tests.
+     *
+     * @return array
+     */
+    public static function email_greetings_provider(): array {
+        $extrasendpasswordchangeconfirmationemail = new \stdClass();
+        $extrasendpasswordchangeconfirmationemail->token = '123';
+        return [
+            ['send_password_change_info', null],
+            ['send_confirmation_email', null],
+            ['setnew_password_and_mail', false],
+            ['send_password_change_confirmation_email', $extrasendpasswordchangeconfirmationemail],
+        ];
+    }
+    /**
+     * Test various moodlelib functions when dealing with a deprecated plugin type.
+     *
+     * @runInSeparateProcess
+     *
+     * @covers ::get_string_manager
+     * @covers ::component_callback_exists
+     * @covers ::component_callback
+     * @covers ::component_class_callback
+     * @covers ::get_plugins_with_function
+     * @covers ::get_plugin_list_with_function
+     * @return void
+     */
+    public function test_moodlelib_deprecated_plugintype(): void {
+        $this->resetAfterTest();
+        global $CFG;
+        // Inject the 'fake' plugin type and deprecate it.
+        // Note: this method of injection is required to ensure core_component fully builds all caches from the ground up,
+        // which is necessary to test things like class autoloading, required for class callbacks checks.
+        $this->add_full_mocked_plugintype(
+            plugintype: 'fake',
+            path: 'lib/tests/fixtures/fakeplugins/fake',
+        );
+        $this->deprecate_full_mocked_plugintype('fake');
+        // Verify strings can be fetched for deprecated plugins.
+        $stringman = get_string_manager();
+        $this->assertEquals('Fake full featured plugin', $stringman->get_string('pluginname', 'fake_fullfeatured'));
+        // Verify callbacks are NOT supported for deprecated plugins (falling back to using the default return).
+        $this->assertFalse(component_callback_exists('fake_fullfeatured', 'test_callback'));
+        $this->assertEquals('default', component_callback('fake_fullfeatured', 'test_callback', [], 'default'));
+        $this->assertEquals('cat', component_class_callback(\fake_fullfeatured\dummy::class, 'class_callback_test', [], 'cat'));
+        // Unset allversionshash to trigger a plugin functions rebuild, forcing it to pick up the injected mock plugin functions.
+        unset($CFG->allversionshash);
+        $plugins = get_plugins_with_function('test_callback');
+        $this->assertArrayNotHasKey('fake', $plugins);
+        $pluginlist = get_plugin_list_with_function('fake', 'test_callback');
+        $this->assertArrayNotHasKey('fake_fullfeatured', $pluginlist);
+    }
+    /**
+     * Test various moodlelib functions when dealing with a deleted plugin type.
+     *
+     * @runInSeparateProcess
+     *
+     * @covers ::get_string_manager
+     * @covers ::component_callback_exists
+     * @covers ::component_callback
+     * @covers ::component_class_callback
+     * @covers ::get_plugins_with_function
+     * @covers ::get_plugin_list_with_function
+     * @return void
+     */
+    public function test_moodlelib_deleted_plugintype(): void {
+        $this->resetAfterTest();
+        global $CFG;
+        // Inject the 'fake' plugin type and flag it as deleted.
+        // Note: this deep method of injection is required to ensure core_component fully builds all caches from the ground up,
+        // which is necessary to test things like class autoloading, required for class callbacks checks.
+        $this->add_full_mocked_plugintype(
+            plugintype: 'fake',
+            path: 'lib/tests/fixtures/fakeplugins/fake',
+        );
+        $this->delete_full_mocked_plugintype('fake');
+        // Verify no string support for deleted plugins.
+        $stringman = get_string_manager();
+        $this->assertEquals('[[pluginname]]', $stringman->get_string('pluginname', 'fake_fullfeatured'));
+        $this->assertDebuggingCalled();
+        // Verify callbacks are NOT supported for deleted plugins (falling back to using the default return).
+        $this->assertFalse(component_callback_exists('fake_fullfeatured', 'test_callback'));
+        $this->assertEquals('default', component_callback('fake_fullfeatured', 'test_callback', [], 'default'));
+        $this->assertEquals('default',
+            component_class_callback(\fake_fullfeatured\dummy::class, 'class_callback_test', [], 'default'));
+        // Unset allversionshash to trigger a plugin functions rebuild, forcing it to pick up the injected mock plugin functions.
+        unset($CFG->allversionshash);
+        $plugins = get_plugins_with_function('test_callback');
+        $this->assertArrayNotHasKey('fake', $plugins);
+        $pluginlist = get_plugin_list_with_function('fake', 'test_callback');
+        $this->assertArrayNotHasKey('fake_fullfeatured', $pluginlist);
+    }
+}

Proyectos de Subversion Moodle

(root)/lib/tests/moodlelib_test.php – Rev 11 → 1441