mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-18 22:08:20 +01:00
Code Issues Projects Releases Wiki Activity

MDL-81456 core: Run tests modifying core_component in a separate process

Browse Source
This commit is contained in:
Andrew Nicols 2024-04-08 08:54:08 +08:00
parent fa2e11105a
commit d7e1f2cef7
No known key found for this signature in database
GPG Key ID: 6D1E3157C8CFBF14
2 changed files with 69 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
lib/phpunit/classes/advanced_testcase.php
View File

@ -768,4 +768,66 @@ abstract class advanced_testcase extends base_testcase {
return $clock;
}
/**
* Add a mocked plugintype to Moodle.
*
* A new plugintype name must be provided with a path to the plugintype's root.
*
* 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
*/
protected function add_mocked_plugintype(
string $plugintype,
string $path,
): void {
require_phpunit_isolation();
$mockedcomponent = new \ReflectionClass(\core_component::class);
$plugintypes = $mockedcomponent->getStaticPropertyValue('plugintypes');
if (array_key_exists($plugintype, $plugintypes)) {
throw new \coding_exception("The plugintype '{$plugintype}' already exists.");
}
$plugintypes[$plugintype] = $path;
$mockedcomponent->setStaticPropertyValue('plugintypes', $plugintypes);
$this->resetDebugging();
}
/**
* Add a mocked plugin to Moodle.
*
* A new plugin name must be provided with a path to the plugin's root.
* The plugin type must already exist (or have been mocked separately).
*
* 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 $pluginname The name of the plugin
* @param string $path The path to the plugin's root
*/
protected function add_mocked_plugin(
string $plugintype,
string $pluginname,
string $path,
): void {
require_phpunit_isolation();
$mockedcomponent = new \ReflectionClass(\core_component::class);
$plugins = $mockedcomponent->getStaticPropertyValue('plugins');
if (!array_key_exists($plugintype, $plugins)) {
$plugins[$plugintype] = [];
}
$plugins[$plugintype][$pluginname] = $path;
$mockedcomponent->setStaticPropertyValue('plugins', $plugins);
$this->resetDebugging();
}
}

51
lib/tests/hook/manager_test.php
View File

@ -303,42 +303,13 @@ final class manager_test extends \advanced_testcase {
/**
* Register a fake plugin called hooktest in the component manager.
*
* @return void
* Tests consuming this helpers must run in a separate process.
*/
protected function setup_hooktest_plugin(): void {
global $CFG;
$mockedcomponent = new \ReflectionClass(\core_component::class);
$mockedplugintypes = $mockedcomponent->getProperty('plugintypes');
$mockedplugintypes->setAccessible(true);
$plugintypes = $mockedplugintypes->getValue();
$plugintypes['fake'] = "{$CFG->dirroot}/lib/tests/fixtures/fakeplugins";
$mockedplugintypes->setValue(null, $plugintypes);
$mockedplugins = $mockedcomponent->getProperty('plugins');
$mockedplugins->setAccessible(true);
$plugins = $mockedplugins->getValue();
$plugins['fake'] = ['hooktest' => "{$CFG->dirroot}/lib/tests/fixtures/fakeplugins/hooktest"];
$mockedplugins->setValue(null, $plugins);
$this->resetDebugging();
}
/**
* Remove the fake plugin to avoid interference with other tests.
*
* @return void
*/
protected function remove_hooktest_plugin(): void {
$mockedcomponent = new \ReflectionClass(\core_component::class);
$mockedplugintypes = $mockedcomponent->getProperty('plugintypes');
$mockedplugintypes->setAccessible(true);
$plugintypes = $mockedplugintypes->getValue();
unset($plugintypes['fake']);
$mockedplugintypes->setValue(null, $plugintypes);
$mockedplugins = $mockedcomponent->getProperty('plugins');
$mockedplugins->setAccessible(true);
$plugins = $mockedplugins->getValue();
unset($plugins['fake']);
$mockedplugins->setValue(null, $plugins);
$this->add_mocked_plugintype('fake', "{$CFG->dirroot}/lib/tests/fixtures/fakeplugins");
$this->add_mocked_plugin('fake', 'hooktest', "{$CFG->dirroot}/lib/tests/fixtures/fakeplugins/hooktest");
}
/**
@ -348,8 +319,7 @@ final class manager_test extends \advanced_testcase {
*
* @covers ::get_hooks_deprecating_plugin_callback()
* @covers ::is_deprecating_hook_present()
* @return void
* @throws \coding_exception
* @runInSeparateProcess
*/
public function test_migrated_callback(): void {
$this->resetAfterTest(true);
@ -381,7 +351,6 @@ final class manager_test extends \advanced_testcase {
'Callback old_callback in fake_hooktest component should be migrated to new hook '.
'callback for fake_hooktest\hook\hook_replacing_callback'
);
$this->remove_hooktest_plugin();
}
/**
@ -391,8 +360,7 @@ final class manager_test extends \advanced_testcase {
*
* @covers ::get_hooks_deprecating_plugin_callback()
* @covers ::is_deprecating_hook_present()
* @return void
* @throws \coding_exception
* @runInSeparateProcess
*/
public function test_migrated_callback_with_replacement(): void {
$this->resetAfterTest(true);
@ -417,7 +385,6 @@ final class manager_test extends \advanced_testcase {
// Confirm the deprecated callback is not called, as expected.
$this->assertNull(component_callback('fake_hooktest', 'old_callback', [], null, true));
$this->assertDebuggingNotCalled();
$this->remove_hooktest_plugin();
}
/**
@ -427,8 +394,7 @@ final class manager_test extends \advanced_testcase {
*
* @covers ::get_hooks_deprecating_plugin_callback()
* @covers ::is_deprecating_hook_present()
* @return void
* @throws \coding_exception
* @runInSeparateProcess
*/
public function test_migrated_class_callback(): void {
$this->resetAfterTest(true);
@ -462,7 +428,6 @@ final class manager_test extends \advanced_testcase {
'Callback callbacks::old_class_callback in fake_hooktest component should be migrated to new hook '.
'callback for fake_hooktest\hook\hook_replacing_class_callback'
);
$this->remove_hooktest_plugin();
}
/**
@ -472,8 +437,7 @@ final class manager_test extends \advanced_testcase {
*
* @covers ::get_hooks_deprecating_plugin_callback()
* @covers ::is_deprecating_hook_present()
* @return void
* @throws \coding_exception
* @runInSeparateProcess
*/
public function test_migrated_class_callback_with_replacement(): void {
$this->resetAfterTest(true);
@ -503,7 +467,6 @@ final class manager_test extends \advanced_testcase {
// Confirm the deprecated class callback is not called, as expected.
$this->assertNull(component_class_callback('fake_hooktest\callbacks', 'old_class_callback', [], null, true));
$this->assertDebuggingNotCalled();
$this->remove_hooktest_plugin();
}
/**