WebSVN – Moodle – Diff – /admin/presets/tests/manager_test.php

  * @category   test
  * @copyright  2021 Sara Arjona (sara@moodle.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @coversDefaultClass \core_adminpresets\manager
  */
-class manager_test extends \advanced_testcase {
+final class manager_test extends \advanced_testcase {
     /**
      * Include required libraries.
      */
     public static function setUpBeforeClass(): void {
         global $CFG;
         require_once($CFG->libdir.'/adminlib.php');
+        parent::setUpBeforeClass();
+    }
     /**
      * Test the behaviour of protected get_site_settings method.
     /**
      * Data provider for test_export_preset().
+     *
      * @return array
      */
-    public function export_preset_provider(): array {
+    public static function export_preset_provider(): array {
         return [
             'Export settings and plugins, excluding sensible' => [
                 'includesensible' => false,
             ],
             'Export settings and plugins, including sensible' => [
      * @param bool $expecteddebugging Whether debugging message will be thrown or not.
      * @param string|null $expectedexception Expected exception class (if that's the case).
      * @param string|null $expectedpresetname Expected preset name.
      */
     public function test_import_preset(string $filecontents, bool $expectedpreset, bool $expectedsettings = false,
-            bool $expectedplugins = false, bool $expecteddebugging = false, string $expectedexception = null,
+            bool $expectedplugins = false, bool $expecteddebugging = false, ?string $expectedexception = null,
             string $expectedpresetname = 'Imported preset'): void {
         global $DB;
         $this->resetAfterTest();
         $currentadvitems = $DB->count_records('adminpresets_it_a');
         // Call the method to be tested.
         $manager = new manager();
+        try {
+            $invokable = self::get_invokable();
-        try {
+            set_error_handler($invokable, E_WARNING);
+            list($xml, $preset, $settingsfound, $pluginsfound) = $manager->import_preset($filecontents);
-            list($xml, $preset, $settingsfound, $pluginsfound) = $manager->import_preset($filecontents);
+            restore_error_handler();
         } catch (\exception $e) {
             if ($expectedexception) {
                 $this->assertInstanceOf($expectedexception, $e);
+            }
                         'block' => [
                             'html' => 0,
                             'activity_modules' => 1,
                         ],
                         'mod' => [
-                            'chat' => 0,
+                            'page' => 0,
                             'data' => 0,
                             'lesson' => 1,
                         ],
                     ];
                     foreach ($plugins as $plugin) {
     /**
      * Data provider for test_import_preset().
+     *
      * @return array
      */
-    public function import_preset_provider(): array {
+    public static function import_preset_provider(): array {
         return [
             'Import settings from an empty file' => [
                 'filecontents' => '',
                 'expectedpreset' => false,
             ],
             'Import settings and plugins from a valid XML file' => [
+                'filecontents' => file_get_contents(
-                'filecontents' => file_get_contents(__DIR__ . '/fixtures/import_settings_plugins.xml'),
+                    filename: self::get_fixture_path(__NAMESPACE__, 'import_settings_plugins.xml')
+                ),
                 'expectedpreset' => true,
                 'expectedsettings' => true,
                 'expectedplugins' => true,
             ],
             'Import only settings from a valid XML file' => [
+                'filecontents' => file_get_contents(
-                'filecontents' => file_get_contents(__DIR__ . '/fixtures/import_settings.xml'),
+                    filename: self::get_fixture_path(__NAMESPACE__, 'import_settings.xml')
+                ),
                 'expectedpreset' => true,
                 'expectedsettings' => true,
                 'expectedplugins' => false,
             ],
             'Import settings and plugins from a valid XML file with Starter name, which will be marked as non-core' => [
+                'filecontents' => file_get_contents(
-                'filecontents' => file_get_contents(__DIR__ . '/fixtures/import_starter_name.xml'),
+                    filename: self::get_fixture_path(__NAMESPACE__, 'import_starter_name.xml')
+                ),
                 'expectedpreset' => true,
                 'expectedsettings' => true,
                 'expectedplugins' => true,
                 'expecteddebugging' => false,
                 'expectedexception' => null,
                 'expectedpresetname' => 'Starter',
             ],
             'Import settings from an invalid XML file' => [
+                'filecontents' => file_get_contents(
-                'filecontents' => file_get_contents(__DIR__ . '/fixtures/invalid_xml_file.xml'),
+                    filename: self::get_fixture_path(__NAMESPACE__, 'invalid_xml_file.xml')
+                ),
                 'expectedpreset' => false,
                 'expectedsettings' => false,
                 'expectedplugins' => false,
                 'expecteddebugging' => false,
                 'expectedexception' => \Exception::class,
             ],
             'Import unexisting settings category' => [
+                'filecontents' => file_get_contents(
-                'filecontents' => file_get_contents(__DIR__ . '/fixtures/unexisting_category.xml'),
+                    filename: self::get_fixture_path(__NAMESPACE__, 'unexisting_category.xml')
+                ),
                 'expectedpreset' => false,
                 'expectedsettings' => false,
                 'expectedplugins' => false,
             ],
             'Import unexisting setting' => [
+                'filecontents' => file_get_contents(
-                'filecontents' => file_get_contents(__DIR__ . '/fixtures/unexisting_setting.xml'),
+                    filename: self::get_fixture_path(__NAMESPACE__, 'unexisting_setting.xml')
+                ),
                 'expectedpreset' => false,
                 'expectedsettings' => false,
                 'expectedplugins' => false,
                 'expecteddebugging' => true,
             ],
             'Import valid settings with one unexisting setting too' => [
+                'filecontents' => file_get_contents(
-                'filecontents' => file_get_contents(__DIR__ . '/fixtures/import_settings_with_unexisting_setting.xml'),
+                    filename: self::get_fixture_path(__NAMESPACE__, 'import_settings_with_unexisting_setting.xml'),
+                ),
                 'expectedpreset' => true,
                 'expectedsettings' => false,
                 'expectedplugins' => false,
                 'expecteddebugging' => true,
             ],
         ];
+    }
     /**
      * Test the behaviour of delete_preset() method when the preset id doesn't exist.
+     *
      * @covers ::delete_preset
         $this->assertArrayHasKey('glossary', $enabledplugins);
         // This plugin won't change (because it had the same value than before the preset was applied).
         $enabledplugins = \core\plugininfo\qtype::get_enabled_plugins();
         $this->assertArrayHasKey('truefalse', $enabledplugins);
+    }
+    /**
+     * Test apply_preset for a deprecated plugin type.
+     *
+     * @runInSeparateProcess
+     *
+     * @covers ::apply_preset
+     * @return void
+     */
+    public function test_apply_preset_deprecated_plugintype(): void {
+        global $CFG;
+        $this->resetAfterTest();
+        // Create a preset.
+        $generator = $this->getDataGenerator()->get_plugin_generator('core_adminpresets');
+        $presetid = $generator->create_preset();
+        // Add a mock plugin into the preset. This plugin will be mocked and deprecated below.
+        helper::add_plugin($presetid, 'fake', 'fullfeatured', true);
+        // Inject the mock plugin type + plugin, and deprecate it.
+        $this->add_mocked_plugintype('fake', "$CFG->libdir/tests/fixtures/fakeplugins/fake", true);
+        $this->add_mocked_plugin('fake', 'fullfeatured', $CFG->libdir . '/tests/fixtures/fakeplugins/fake/fullfeatured');
+        // Pre-flight check to ensure that the plugin is deprecated.
+        $pluginman = \core\plugin_manager::instance();
+        $plugininfo = $pluginman->get_plugin_info('fake_fullfeatured');
+        // Expected, unit-test-only debugging, since \core\plugin_manager isn't aware of the mock plugininfo class for this type.
+        $this->assertDebuggingCalled();
+        $this->assertTrue($plugininfo->is_deprecated());
+        // Finally, check apply_preset method, verifying the deprecated plugin is skipped.
+        $manager = new manager();
+        [$applied, $skipped] = $manager->apply_preset($presetid);
+        $this->assertdebuggingcalledcount(2); // Expected unit-test-only debugging, as above.
+        $this->assertContains('fake', array_column($skipped, 'plugin'));
+    }
+}

Proyectos de Subversion Moodle

(root)/admin/presets/tests/manager_test.php – Rev 1 → 1441