WebSVN – Moodle – Diff – /lib/phpunit/classes/advanced_testcase.php

 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 use core\di;
+use core\hook;
+use core\http_client;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
+use PHPUnit\Framework\Attributes\After;
-use core\hook;
+use PHPUnit\Framework\Attributes\Before;
 /**
  * Advanced PHPUnit test case customised for Moodle.
      * Constructs a test case with the given name.
+     *
      * Note: use setUp() or setUpBeforeClass() in your test cases.
+     *
      * @param string $name
-     * @param array  $data
-     * @param string $dataName
      */
-    final public function __construct($name = null, array $data = [], $dataname = '') {
+    final public function __construct(string $name) {
-        parent::__construct($name, $data, $dataname);
+        parent::__construct($name);
-        $this->setBackupGlobals(false);
-        $this->setBackupStaticAttributes(false);
+        $this->setBackupGlobals(false);
         $this->setPreserveGlobalState(false);
-    }
-    /**
+    }
-     * Runs the bare test sequence.
-     */
+    #[Before]
-    final public function runBare(): void {
+    final public function setup_test_environment(): void {
         global $CFG, $DB;
         if (phpunit_util::$lastdbwrites != $DB->perf_get_writes()) {
             // This happens when previous test does not reset, we can not use transactions.
             $this->testdbtransaction = null;
         } else if ($DB->get_dbfamily() === 'postgres' || $DB->get_dbfamily() === 'mssql') {
-            // Database must allow rollback of DDL, so no mysql here.
-            $this->testdbtransaction = $DB->start_delegated_transaction();
+            // Database must allow rollback of DDL, so no mysql here.
-        }
-        try {
-            $this->setCurrentTimeStart();
-            parent::runBare();
-        } catch (Exception $ex) {
-            $e = $ex;
+            $this->testdbtransaction = $DB->start_delegated_transaction();
-        } catch (Throwable $ex) {
-            // Engine errors in PHP7 throw exceptions of type Throwable (this "catch" will be ignored in PHP5).
-            $e = $ex;
+        }
+        $this->setCurrentTimeStart();
-        } finally {
+    }
-            // Reset global state after test and test failure.
-            $CFG = phpunit_util::get_global_backup('CFG');
+    #[After]
-            $DB = phpunit_util::get_global_backup('DB');
+    final public function teardown_test_environment(): void {
-            // We need to reset the autoloader.
+        global $CFG, $DB;
-            \core_component::reset();
-        }
         // Reset global state after test and test failure.
-        if (isset($e)) {
+        $CFG = phpunit_util::get_global_backup('CFG');
-            // Cleanup after failed expectation.
+        $DB = phpunit_util::get_global_backup('DB');
             self::resetAllData();
+            }
+        }
+    }
-    /**
-     * @deprecated since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.
-     */
-    protected function createXMLDataSet() {
-        throw new coding_exception(__FUNCTION__ . '() is deprecated. Please use dataset_from_files() instead.');
-    }
-    /**
-     * @deprecated since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.
-     */
-    protected function createCsvDataSet() {
-        throw new coding_exception(__FUNCTION__ . '() is deprecated. Please use dataset_from_files() instead.');
-    }
-    /**
-     * @deprecated since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.
-     */
-    protected function createArrayDataSet() {
-        throw new coding_exception(__FUNCTION__ . '() is deprecated. Please use dataset_from_array() instead.');
-    }
-    /**
-     * @deprecated since Moodle 3.10 - See MDL-67673 and MDL-64600 for more info.
-     */
-    protected function loadDataSet() {
-        throw new coding_exception(__FUNCTION__ . '() is deprecated. Please use dataset->to_database() instead.');
-    }
     /**
      * Creates a new dataset from CVS/XML files.
+     *
      * This method accepts an array of full paths to CSV or XML files to be loaded
      * into the dataset. For CSV files, the name of the table which the file belongs
      * @since Moodle 3.10
+     *
      * @param array $files full paths to CSV or XML files to load.
      * @return phpunit_dataset
      */
-    protected function dataset_from_files(array $files) {
+    protected static function dataset_from_files(array $files) {
         // We ignore $delimiter, $enclosure and $escape, use the default ones in your fixtures.
         $dataset = new phpunit_dataset();
         $dataset->from_files($files);
         return $dataset;
+    }
      * @param string $content contents (CSV or XML) to load.
      * @param string $type format of the content to be loaded (csv or xml).
      * @param string $table name of the table which the file belongs to (only for CSV files).
      * @return phpunit_dataset
      */
-    protected function dataset_from_string(string $content, string $type, ?string $table = null) {
+    protected static function dataset_from_string(string $content, string $type, ?string $table = null) {
         $dataset = new phpunit_dataset();
         $dataset->from_string($content, $type, $table);
         return $dataset;
+    }
      * @since Moodle 3.10
+     *
      * @param array $data array of tables, see {@see phpunit_dataset::from_array()} for supported formats.
      * @return phpunit_dataset
      */
-    protected function dataset_from_array(array $data) {
+    protected static function dataset_from_array(array $data) {
         $dataset = new phpunit_dataset();
         $dataset->from_array($data);
         return $dataset;
+    }
+     *
      * @param string $path
      * @param bool $https true if https required
      * @return string url
      */
-    public function getExternalTestFileUrl($path, $https = false) {
+    public static function getExternalTestFileUrl(
+        string $path,
+        bool $https = false,
+    ): string {
         $path = ltrim($path, '/');
         if ($path) {
-            $path = '/' . $path;
+            $path = "/{$path}";
+        }
         if ($https) {
             if (defined('TEST_EXTERNAL_FILES_HTTPS_URL')) {
                 if (!TEST_EXTERNAL_FILES_HTTPS_URL) {
-                    $this->markTestSkipped('Tests using external https test files are disabled');
+                    self::markTestSkipped('Tests using external https test files are disabled');
+                }
                 return TEST_EXTERNAL_FILES_HTTPS_URL . $path;
+            }
-            return 'https://download.moodle.org/unittest' . $path;
+            return "https://download.moodle.org/unittest{$path}";
+        }
         if (defined('TEST_EXTERNAL_FILES_HTTP_URL')) {
             if (!TEST_EXTERNAL_FILES_HTTP_URL) {
-                $this->markTestSkipped('Tests using external http test files are disabled');
+                self::markTestSkipped('Tests using external http test files are disabled');
+            }
             return TEST_EXTERNAL_FILES_HTTP_URL . $path;
         }
-        return 'http://download.moodle.org/unittest' . $path;
+        return "http://download.moodle.org/unittest{$path}";
+    }
     /**
         if (!empty($matchuserid)) {
             $params['userid'] = $matchuserid;
         }
-        $lock = $this->createMock(\core\lock\lock::class);
+        $lock = $this->createStub(\core\lock\lock::class);
-        $cronlock = $this->createMock(\core\lock\lock::class);
+        $cronlock = $this->createStub(\core\lock\lock::class);
         $tasks = $DB->get_recordset('task_adhoc', $params);
      * Please note that tests calling this method must be run in separate isolation mode.
      * Please avoid using this if at all possible.
+     *
      * @param string $plugintype The name of the plugintype
      * @param string $path The path to the plugintype's root
+     * @param bool $deprecated whether to add the plugintype as a deprecated plugin type.
      */
     protected function add_mocked_plugintype(
         string $plugintype,
         string $path,
+        bool $deprecated = false,
     ): void {
         require_phpunit_isolation();
+        $mockedcomponent = new \ReflectionClass(\core_component::class);
-        $mockedcomponent = new \ReflectionClass(\core_component::class);
+        $propertyname = $deprecated ? 'deprecatedplugintypes' : 'plugintypes';
-        $plugintypes = $mockedcomponent->getStaticPropertyValue('plugintypes');
+        $plugintypes = $mockedcomponent->getStaticPropertyValue($propertyname);
         if (array_key_exists($plugintype, $plugintypes)) {
             throw new \coding_exception("The plugintype '{$plugintype}' already exists.");
         }
         $plugintypes[$plugintype] = $path;
-        $mockedcomponent->setStaticPropertyValue('plugintypes', $plugintypes);
+        $mockedcomponent->setStaticPropertyValue($propertyname, $plugintypes);
         $mockedcomponent->setStaticPropertyValue('plugins', $plugins);
         $this->resetDebugging();
+    }
     /**
-     * Convenience method to load a fixture from a component's fixture directory.
+     * Convenience method to get the path to a fixture.
+     *
      * @param string $component
      * @param string $path
      * @throws coding_exception
      */
-    protected static function load_fixture(
+    protected static function get_fixture_path(
         string $component,
         string $path,
-    ): void {
+    ): string {
-        $fullpath = sprintf(
+        return sprintf(
             "%s/tests/fixtures/%s",
             \core_component::get_component_directory($component),
             $path,
-        );
-        if (!file_exists($fullpath)) {
-            throw new \coding_exception("Fixture file not found: $fullpath");
+        );
+    }
+    /**
+     * Convenience method to load a fixture from a component's fixture directory.
+     *
+     * @param string $component
+     * @param string $path
+     * @throws coding_exception
+     */
+    protected static function load_fixture(
+        string $component,
         string $path,
     ): void {
         global $ADMIN;
         global $CFG;
         global $DB;
         global $PAGE;
         global $SESSION;
         global $COURSE;
         global $SITE;
+        $fullpath = static::get_fixture_path($component, $path);
+        if (!file_exists($fullpath)) {
+            throw new \coding_exception("Fixture file not found: $fullpath");
+        }
         require_once($fullpath);
+    }
+    /**
+     * Get a mocked HTTP Client, inserting it into the Dependency Injector.
+     *
+     * @param array|null $history An array which will contain the Request/Response history of the HTTP client
+     * @return array Containing the client, the mock, and the history
+     */
+    protected function get_mocked_http_client(
+        ?array &$history = null,
+    ): array {
+        $mock = new MockHandler([]);
+        $handlerstack = HandlerStack::create($mock);
+        if ($history !== null) {
+            $historymiddleware = Middleware::history($history);
+            $handlerstack->push($historymiddleware);
+        }
+        $client = new http_client(['handler' => $handlerstack]);
+        di::set(http_client::class, $client);
+        return [
+            'client' => $client,
+            'mock' => $mock,
+            'handlerstack' => $handlerstack,
+        ];
+    }
+    /**
+     * Get a copy of the mocked string manager.
+     *
+     * @return \core\tests\mocking_string_manager
+     */
+    protected function get_mocked_string_manager(): \core\tests\mocking_string_manager {
+        global $CFG;
+        $this->resetAfterTest();
+        $CFG->config_php_settings['customstringmanager'] = \core\tests\mocking_string_manager::class;
+        return get_string_manager(true);
+    }

Proyectos de Subversion Moodle

(root)/lib/phpunit/classes/advanced_testcase.php – Rev 11 → 1441