WebSVN – Moodle – Diff – /privacy/tests/privacy/provider_test.php

  * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 namespace core_privacy\privacy;
-defined('MOODLE_INTERNAL') || die();
 use core_privacy\manager;
 use core_privacy\local\metadata\collection;
 use core_privacy\local\metadata\types\type;
-use core_privacy\local\metadata\types\database_table;
-use core_privacy\local\metadata\types\external_location;
-use core_privacy\local\metadata\types\plugin_type_link;
+use core_privacy\local\metadata\types\database_table;
+use core_privacy\local\metadata\types\subsystem_link;
-use core_privacy\local\metadata\types\subsystem_link;
-use core_privacy\local\metadata\types\user_preference;
+// phpcs:disable moodle.PHPUnit.TestCaseProvider.dataProviderSyntaxMethodNotFound
 /**
  * Unit tests for all Privacy Providers.
+ *
  * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class provider_test extends \advanced_testcase {
+final class provider_test extends \core\tests\plugin_checks_testcase {
     /**
      * Returns a list of frankenstyle names of core components (plugins and subsystems).
+     *
      * @return array the array of frankenstyle component names with the relevant class name.
      */
-    public function get_component_list() {
+    public static function get_component_list(): array {
         $components = ['core' => [
             'component' => 'core',
-            'classname' => manager::get_provider_classname_for_component('core')
+            'classname' => manager::get_provider_classname_for_component('core'),
         ]];
         // Get all plugins.
         $plugintypes = \core_component::get_plugin_types();
+    }
     /**
      * Test that the specified null_provider works as expected.
+     *
      * @group        plugin_checks
      * @dataProvider null_provider_provider
      * @param   string  $component The name of the component.
      * @param   string  $classname The name of the class for privacy
      */
     public function test_null_provider($component, $classname): void {
         $reason = $classname::get_reason();
         $this->assertIsString($reason);
         $this->assertIsString(get_string($reason, $component));
-        $this->assertDebuggingNotCalled();
+        $this->assertIsString(get_string($reason, $component));
+    }
     /**
      * Data provider for the null_provider tests.
      *
      * @return array
      */
-    public function null_provider_provider() {
+    public static function null_provider_provider(): array {
-        return array_filter($this->get_component_list(), function($component) {
+        return array_filter(self::get_component_list(), function($component): bool {
-                return static::component_implements(
+            return static::component_implements(
-                    $component['classname'],
+                $component['classname'],
-                    \core_privacy\local\metadata\null_provider::class
+                \core_privacy\local\metadata\null_provider::class
-                );
+            );
         });
+    }
     /**
-    /**
+     * Test that the specified metadata_provider works as expected.
      * Test that the specified metadata_provider works as expected.
      * @group        plugin_checks
      * @dataProvider metadata_provider_provider
                 // Summary is optional, but when provided must be a valid string identifier.
                 $this->assertIsString($summary);
                 // Check that the string is also correctly defined.
-                $this->assertIsString(get_string($summary, $component));
-                $this->assertDebuggingNotCalled();
+                $this->assertIsString(get_string($summary, $component));
+            }
             if ($fields = $item->get_privacy_fields()) {
                 // Privacy fields are optional, but when provided must be a valid string identifier.
                 foreach ($fields as $field => $identifier) {
                     $this->assertIsString($field);
                     $this->assertIsString($identifier);
                     // Check that the string is also correctly defined.
-                    $this->assertIsString(get_string($identifier, $component));
+                    // Check that the string is also correctly defined.
-                    $this->assertDebuggingNotCalled();
+                    $this->assertIsString(get_string($identifier, $component));
+                }
+            }
+        }
+    }
     /**
-    /**
+     * Test that all providers implement some form of compliant provider.
      * Test that all providers implement some form of compliant provider.
      * @group        plugin_checks
      * @dataProvider get_component_list
+    }
     /**
      * Ensure that providers do not throw an error when processing a deleted user.
-     *
-     * @dataProvider    is_user_data_provider
+     *
-     * @param   string  $component
-     */
-    public function test_component_understands_deleted_users($component): void {
-        $this->resetAfterTest();
-        // Create a user.
-        $user = $this->getDataGenerator()->create_user();
-        // Delete the user and their context.
-        delete_user($user);
-        $usercontext = \context_user::instance($user->id);
-        $usercontext->delete();
-        $contextlist = manager::component_class_callback($component, \core_privacy\local\request\core_user_data_provider::class,
-                'get_contexts_for_userid', [$user->id]);
-        $this->assertInstanceOf(\core_privacy\local\request\contextlist::class, $contextlist);
-    }
-    /**
-     * Ensure that providers do not throw an error when processing a deleted user.
      * @group           plugin_checks
      * @dataProvider    is_user_data_provider
      * @param   string  $component
      */
     public function test_userdata_provider_implements_userlist($component): void {
     /**
      * Data provider for the metadata\provider tests.
+     *
      * @return array
      */
-    public function metadata_provider_provider() {
+    public static function metadata_provider_provider(): array {
-        return array_filter($this->get_component_list(), function($component) {
+        return array_filter(self::get_component_list(), function($component): bool {
-                return static::component_implements(
+            return static::component_implements(
-                    $component['classname'],
+                $component['classname'],
-                    \core_privacy\local\metadata\provider::class
+                \core_privacy\local\metadata\provider::class
-                );
+            );
         });
+    }
     /**
      * List of providers which implement the core_user_data_provider.
+     *
      * @return array
      */
+    public static function is_user_data_provider(): array {
+        return array_map(
-    public function is_user_data_provider() {
+            fn ($data) => ['component' => $data['component']],
-        return array_filter($this->get_component_list(), function($component) {
+            array_filter(self::get_component_list(), function($component): bool {
                 return static::component_implements(
                     $component['classname'],
                     \core_privacy\local\request\core_user_data_provider::class
+                );
-                );
+            }),
-        });
+        );
+    }
     /**
         return $userfields;
+    }
     /**
+     * Test that all tables with user fields are covered by metadata providers
+     *
+     * @group        plugin_checks
+     * @dataProvider get_component_list
+     * @coversNothing
+     * @param string $component frankenstyle component name, e.g. 'mod_assign'
-     * Test that all tables with user fields are covered by metadata providers
+     * @param string $classname the fully qualified provider classname
      */
-    public function test_table_coverage(): void {
+    public function test_table_coverage(string $component, string $classname): void {
         global $DB;
-        $dbman = $DB->get_manager();
+        $dbman = $DB->get_manager(); // Load DDL classes.
         $tables = [];
-        foreach ($dbman->get_install_xml_files() as $filename) {
+        $filename = \core_component::get_component_directory($component) . '/db/install.xml';
-            $xmldbfile = new \xmldb_file($filename);
+        if (!file_exists($filename)) {
-            if (!$xmldbfile->loadXMLStructure()) {
+            $this->expectNotToPerformAssertions();
-                continue;
+            return;
-            }
+        }
+        $xmldbfile = new \xmldb_file($filename);
+        $this->assertTrue($xmldbfile->loadXMLStructure());;
-            $structure = $xmldbfile->getStructure();
+        $structure = $xmldbfile->getStructure();
-            $tablelist = $structure->getTables();
+        $tablelist = $structure->getTables();
-            foreach ($tablelist as $table) {
-                if ($fields = $this->get_userid_fields($table)) {
+        foreach ($tablelist as $table) {
-                    $tables[$table->getName()] = '  - ' . $table->getName() . ' (' . join(', ', $fields) . ')';
+            if ($fields = $this->get_userid_fields($table)) {
-                }
+                $tables[$table->getName()] = '  - ' . $table->getName() . ' (' . join(', ', $fields) . ')';
+            }
+        }
-        $componentlist = $this->metadata_provider_provider();
+        $componentlist = self::metadata_provider_provider();
         foreach ($componentlist as $componentarray) {

Proyectos de Subversion Moodle

(root)/privacy/tests/privacy/provider_test.php – Rev 11 → 1441