mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
417 lines
20 KiB
PHP
417 lines
20 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* core_component related tests.
|
|
*
|
|
* @package core
|
|
* @category phpunit
|
|
* @copyright 2013 Petr Skoda {@link http://skodak.org}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
|
|
/**
|
|
* Class core_component_testcase.
|
|
*/
|
|
class core_component_testcase extends advanced_testcase {
|
|
|
|
// To be changed if number of subsystems increases/decreases,
|
|
// this is defined here to annoy devs that try to add more without any thinking,
|
|
// always verify that it does not collide with any existing add-on modules and subplugins!!!
|
|
const SUBSYSTEMCOUNT = 62;
|
|
|
|
public function test_get_core_subsystems() {
|
|
global $CFG;
|
|
|
|
$subsystems = core_component::get_core_subsystems();
|
|
|
|
$this->assertCount(self::SUBSYSTEMCOUNT, $subsystems, 'Oh, somebody added or removed a core subsystem, think twice before doing that!');
|
|
|
|
// Make sure all paths are full/null, exist and are inside dirroot.
|
|
foreach ($subsystems as $subsystem => $fulldir) {
|
|
$this->assertFalse(strpos($subsystem, '_'), 'Core subsystems must be one work without underscores');
|
|
if ($fulldir === null) {
|
|
if ($subsystem === 'filepicker' or $subsystem === 'help') {
|
|
// Arrgghh, let's not introduce more subsystems for no real reason...
|
|
} else {
|
|
// Lang strings.
|
|
$this->assertFileExists("$CFG->dirroot/lang/en/$subsystem.php", 'Core subsystems without fulldir are usually used for lang strings.');
|
|
}
|
|
continue;
|
|
}
|
|
$this->assertFileExists($fulldir);
|
|
// Check that base uses realpath() separators and "/" in the subdirs.
|
|
$this->assertStringStartsWith($CFG->dirroot.'/', $fulldir);
|
|
$reldir = substr($fulldir, strlen($CFG->dirroot)+1);
|
|
$this->assertFalse(strpos($reldir, '\\'));
|
|
}
|
|
|
|
// Make sure all core language files are also subsystems!
|
|
$items = new DirectoryIterator("$CFG->dirroot/lang/en");
|
|
foreach ($items as $item) {
|
|
if ($item->isDot() or $item->isDir()) {
|
|
continue;
|
|
}
|
|
$file = $item->getFilename();
|
|
if ($file === 'moodle.php') {
|
|
// Do not add new lang strings unless really necessary!!!
|
|
continue;
|
|
}
|
|
|
|
if (substr($file, -4) !== '.php') {
|
|
continue;
|
|
}
|
|
$file = substr($file, 0, strlen($file)-4);
|
|
$this->assertArrayHasKey($file, $subsystems, 'All core lang files should be subsystems, think twice before adding anything!');
|
|
}
|
|
unset($item);
|
|
unset($items);
|
|
|
|
}
|
|
|
|
public function test_deprecated_get_core_subsystems() {
|
|
global $CFG;
|
|
|
|
$subsystems = core_component::get_core_subsystems();
|
|
|
|
$this->assertSame($subsystems, get_core_subsystems(true));
|
|
|
|
$realsubsystems = get_core_subsystems();
|
|
$this->assertDebuggingCalled();
|
|
$this->assertSame($realsubsystems, get_core_subsystems(false));
|
|
$this->assertDebuggingCalled();
|
|
|
|
$this->assertEquals(count($subsystems), count($realsubsystems));
|
|
|
|
foreach ($subsystems as $subsystem => $fulldir) {
|
|
$this->assertArrayHasKey($subsystem, $realsubsystems);
|
|
if ($fulldir === null) {
|
|
$this->assertNull($realsubsystems[$subsystem]);
|
|
continue;
|
|
}
|
|
$this->assertSame($fulldir, $CFG->dirroot.'/'.$realsubsystems[$subsystem]);
|
|
}
|
|
}
|
|
|
|
public function test_get_plugin_types() {
|
|
global $CFG;
|
|
|
|
$this->assertTrue(empty($CFG->themedir), 'Non-empty $CFG->themedir is not covered by any tests yet, you need to disable it.');
|
|
|
|
$plugintypes = core_component::get_plugin_types();
|
|
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$this->assertStringStartsWith("$CFG->dirroot/", $fulldir);
|
|
}
|
|
}
|
|
|
|
public function test_deprecated_get_plugin_types() {
|
|
global $CFG;
|
|
|
|
$plugintypes = core_component::get_plugin_types();
|
|
|
|
$this->assertSame($plugintypes, get_plugin_types());
|
|
$this->assertSame($plugintypes, get_plugin_types(true));
|
|
|
|
$realplugintypes = get_plugin_types(false);
|
|
$this->assertDebuggingCalled();
|
|
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$this->assertSame($fulldir, $CFG->dirroot.'/'.$realplugintypes[$plugintype]);
|
|
}
|
|
}
|
|
|
|
public function test_get_plugin_list() {
|
|
global $CFG;
|
|
|
|
$plugintypes = core_component::get_plugin_types();
|
|
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$plugins = core_component::get_plugin_list($plugintype);
|
|
foreach ($plugins as $pluginname => $plugindir) {
|
|
$this->assertStringStartsWith("$CFG->dirroot/", $plugindir);
|
|
}
|
|
if ($plugintype !== 'auth') {
|
|
// Let's crosscheck it with independent implementation (auth/db is an exception).
|
|
$reldir = substr($fulldir, strlen($CFG->dirroot)+1);
|
|
$dirs = get_list_of_plugins($reldir);
|
|
$dirs = array_values($dirs);
|
|
$this->assertDebuggingCalled();
|
|
$this->assertSame($dirs, array_keys($plugins));
|
|
}
|
|
}
|
|
}
|
|
|
|
public function test_deprecated_get_plugin_list() {
|
|
$plugintypes = core_component::get_plugin_types();
|
|
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$plugins = core_component::get_plugin_list($plugintype);
|
|
$this->assertSame($plugins, get_plugin_list($plugintype));
|
|
}
|
|
}
|
|
|
|
public function test_get_plugin_directory() {
|
|
$plugintypes = core_component::get_plugin_types();
|
|
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$plugins = core_component::get_plugin_list($plugintype);
|
|
foreach ($plugins as $pluginname => $plugindir) {
|
|
$this->assertSame($plugindir, core_component::get_plugin_directory($plugintype, $pluginname));
|
|
}
|
|
}
|
|
}
|
|
|
|
public function test_deprecated_get_plugin_directory() {
|
|
$plugintypes = core_component::get_plugin_types();
|
|
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$plugins = core_component::get_plugin_list($plugintype);
|
|
foreach ($plugins as $pluginname => $plugindir) {
|
|
$this->assertSame(core_component::get_plugin_directory($plugintype, $pluginname), get_plugin_directory($plugintype, $pluginname));
|
|
}
|
|
}
|
|
}
|
|
|
|
public function test_get_subsystem_directory() {
|
|
$subsystems = core_component::get_core_subsystems();
|
|
foreach ($subsystems as $subsystem => $fulldir) {
|
|
$this->assertSame($fulldir, core_component::get_subsystem_directory($subsystem));
|
|
}
|
|
}
|
|
|
|
public function test_is_valid_plugin_name() {
|
|
$this->assertTrue(core_component::is_valid_plugin_name('mod', 'example1'));
|
|
$this->assertTrue(core_component::is_valid_plugin_name('mod', 'feedback360'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', 'feedback_360'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', '2feedback'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', '1example'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', 'example.xx'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', '.example'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', '_example'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', 'example_'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', 'example_x1'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', 'example-x1'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('mod', 'role'));
|
|
|
|
$this->assertTrue(core_component::is_valid_plugin_name('tool', 'example1'));
|
|
$this->assertTrue(core_component::is_valid_plugin_name('tool', 'example_x1'));
|
|
$this->assertTrue(core_component::is_valid_plugin_name('tool', 'example_x1_xxx'));
|
|
$this->assertTrue(core_component::is_valid_plugin_name('tool', 'feedback360'));
|
|
$this->assertTrue(core_component::is_valid_plugin_name('tool', 'feed_back360'));
|
|
$this->assertTrue(core_component::is_valid_plugin_name('tool', 'role'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('tool', '1example'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('tool', 'example.xx'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('tool', 'example-xx'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('tool', '.example'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('tool', '_example'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('tool', 'example_'));
|
|
$this->assertFalse(core_component::is_valid_plugin_name('tool', 'example__x1'));
|
|
}
|
|
|
|
public function test_normalize_component() {
|
|
// Moodle core.
|
|
$this->assertSame(array('core', null), core_component::normalize_component('core'));
|
|
$this->assertSame(array('core', null), core_component::normalize_component('moodle'));
|
|
$this->assertSame(array('core', null), core_component::normalize_component(''));
|
|
|
|
// Moodle core subsystems.
|
|
$this->assertSame(array('core', 'admin'), core_component::normalize_component('admin'));
|
|
$this->assertSame(array('core', 'admin'), core_component::normalize_component('core_admin'));
|
|
$this->assertSame(array('core', 'admin'), core_component::normalize_component('moodle_admin'));
|
|
|
|
// Activity modules and their subplugins.
|
|
$this->assertSame(array('mod', 'workshop'), core_component::normalize_component('workshop'));
|
|
$this->assertSame(array('mod', 'workshop'), core_component::normalize_component('mod_workshop'));
|
|
$this->assertSame(array('workshopform', 'accumulative'), core_component::normalize_component('workshopform_accumulative'));
|
|
$this->assertSame(array('mod', 'quiz'), core_component::normalize_component('quiz'));
|
|
$this->assertSame(array('quiz', 'grading'), core_component::normalize_component('quiz_grading'));
|
|
$this->assertSame(array('mod', 'data'), core_component::normalize_component('data'));
|
|
$this->assertSame(array('datafield', 'checkbox'), core_component::normalize_component('datafield_checkbox'));
|
|
|
|
// Other plugin types.
|
|
$this->assertSame(array('auth', 'mnet'), core_component::normalize_component('auth_mnet'));
|
|
$this->assertSame(array('enrol', 'self'), core_component::normalize_component('enrol_self'));
|
|
$this->assertSame(array('block', 'html'), core_component::normalize_component('block_html'));
|
|
$this->assertSame(array('block', 'mnet_hosts'), core_component::normalize_component('block_mnet_hosts'));
|
|
$this->assertSame(array('local', 'amos'), core_component::normalize_component('local_amos'));
|
|
$this->assertSame(array('local', 'admin'), core_component::normalize_component('local_admin'));
|
|
|
|
// Unknown words without underscore are supposed to be activity modules.
|
|
$this->assertSame(array('mod', 'whothefuckwouldcomewithsuchastupidnameofcomponent'),
|
|
core_component::normalize_component('whothefuckwouldcomewithsuchastupidnameofcomponent'));
|
|
// Module names can not contain underscores, this must be a subplugin.
|
|
$this->assertSame(array('whothefuck', 'wouldcomewithsuchastupidnameofcomponent'),
|
|
core_component::normalize_component('whothefuck_wouldcomewithsuchastupidnameofcomponent'));
|
|
$this->assertSame(array('whothefuck', 'would_come_withsuchastupidnameofcomponent'),
|
|
core_component::normalize_component('whothefuck_would_come_withsuchastupidnameofcomponent'));
|
|
}
|
|
|
|
public function test_deprecated_normalize_component() {
|
|
// Moodle core.
|
|
$this->assertSame(array('core', null), normalize_component('core'));
|
|
$this->assertSame(array('core', null), normalize_component(''));
|
|
$this->assertSame(array('core', null), normalize_component('moodle'));
|
|
|
|
// Moodle core subsystems.
|
|
$this->assertSame(array('core', 'admin'), normalize_component('admin'));
|
|
$this->assertSame(array('core', 'admin'), normalize_component('core_admin'));
|
|
$this->assertSame(array('core', 'admin'), normalize_component('moodle_admin'));
|
|
|
|
// Activity modules and their subplugins.
|
|
$this->assertSame(array('mod', 'workshop'), normalize_component('workshop'));
|
|
$this->assertSame(array('mod', 'workshop'), normalize_component('mod_workshop'));
|
|
$this->assertSame(array('workshopform', 'accumulative'), normalize_component('workshopform_accumulative'));
|
|
$this->assertSame(array('mod', 'quiz'), normalize_component('quiz'));
|
|
$this->assertSame(array('quiz', 'grading'), normalize_component('quiz_grading'));
|
|
$this->assertSame(array('mod', 'data'), normalize_component('data'));
|
|
$this->assertSame(array('datafield', 'checkbox'), normalize_component('datafield_checkbox'));
|
|
|
|
// Other plugin types.
|
|
$this->assertSame(array('auth', 'mnet'), normalize_component('auth_mnet'));
|
|
$this->assertSame(array('enrol', 'self'), normalize_component('enrol_self'));
|
|
$this->assertSame(array('block', 'html'), normalize_component('block_html'));
|
|
$this->assertSame(array('block', 'mnet_hosts'), normalize_component('block_mnet_hosts'));
|
|
$this->assertSame(array('local', 'amos'), normalize_component('local_amos'));
|
|
$this->assertSame(array('local', 'admin'), normalize_component('local_admin'));
|
|
|
|
// Unknown words without underscore are supposed to be activity modules.
|
|
$this->assertSame(array('mod', 'whothefuckwouldcomewithsuchastupidnameofcomponent'),
|
|
normalize_component('whothefuckwouldcomewithsuchastupidnameofcomponent'));
|
|
// Module names can not contain underscores, this must be a subplugin.
|
|
$this->assertSame(array('whothefuck', 'wouldcomewithsuchastupidnameofcomponent'),
|
|
normalize_component('whothefuck_wouldcomewithsuchastupidnameofcomponent'));
|
|
$this->assertSame(array('whothefuck', 'would_come_withsuchastupidnameofcomponent'),
|
|
normalize_component('whothefuck_would_come_withsuchastupidnameofcomponent'));
|
|
}
|
|
|
|
public function test_get_component_directory() {
|
|
$plugintypes = core_component::get_plugin_types();
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$plugins = core_component::get_plugin_list($plugintype);
|
|
foreach ($plugins as $pluginname => $plugindir) {
|
|
$this->assertSame($plugindir, core_component::get_component_directory(($plugintype.'_'.$pluginname)));
|
|
}
|
|
}
|
|
|
|
$subsystems = core_component::get_core_subsystems();
|
|
foreach ($subsystems as $subsystem => $fulldir) {
|
|
$this->assertSame($fulldir, core_component::get_component_directory(('core_'.$subsystem)));
|
|
}
|
|
}
|
|
|
|
public function test_deprecated_get_component_directory() {
|
|
$plugintypes = core_component::get_plugin_types();
|
|
foreach ($plugintypes as $plugintype => $fulldir) {
|
|
$plugins = core_component::get_plugin_list($plugintype);
|
|
foreach ($plugins as $pluginname => $plugindir) {
|
|
$this->assertSame($plugindir, get_component_directory(($plugintype.'_'.$pluginname)));
|
|
}
|
|
}
|
|
|
|
$subsystems = core_component::get_core_subsystems();
|
|
foreach ($subsystems as $subsystem => $fulldir) {
|
|
$this->assertSame($fulldir, get_component_directory(('core_'.$subsystem)));
|
|
}
|
|
}
|
|
|
|
public function test_get_subtype_parent() {
|
|
global $CFG;
|
|
|
|
$this->assertNull(core_component::get_subtype_parent('mod'));
|
|
|
|
// Any plugin with more subtypes is ok here.
|
|
$this->assertFileExists("$CFG->dirroot/mod/assign/db/subplugins.php");
|
|
$this->assertSame('mod_assign', core_component::get_subtype_parent('assignsubmission'));
|
|
$this->assertSame('mod_assign', core_component::get_subtype_parent('assignfeedback'));
|
|
$this->assertNull(core_component::get_subtype_parent('assignxxxxx'));
|
|
}
|
|
|
|
public function test_get_subplugins() {
|
|
global $CFG;
|
|
|
|
// Any plugin with more subtypes is ok here.
|
|
$this->assertFileExists("$CFG->dirroot/mod/assign/db/subplugins.php");
|
|
|
|
$subplugins = core_component::get_subplugins('mod_assign');
|
|
$this->assertSame(array('assignsubmission', 'assignfeedback'), array_keys($subplugins));
|
|
|
|
$subs = core_component::get_plugin_list('assignsubmission');
|
|
$feeds = core_component::get_plugin_list('assignfeedback');
|
|
|
|
$this->assertSame(array_keys($subs), $subplugins['assignsubmission']);
|
|
$this->assertSame(array_keys($feeds), $subplugins['assignfeedback']);
|
|
|
|
// Any plugin without subtypes is ok here.
|
|
$this->assertFileExists("$CFG->dirroot/mod/choice");
|
|
$this->assertFileNotExists("$CFG->dirroot/mod/choice/db/subplugins.php");
|
|
|
|
$this->assertNull(core_component::get_subplugins('mod_choice'));
|
|
|
|
$this->assertNull(core_component::get_subplugins('xxxx_yyyy'));
|
|
}
|
|
|
|
public function test_get_plugin_types_with_subplugins() {
|
|
global $CFG;
|
|
|
|
$types = core_component::get_plugin_types_with_subplugins();
|
|
|
|
// Hardcode it here to detect if anybody hacks the code to include more subplugin types.
|
|
$expected = array(
|
|
'mod' => "$CFG->dirroot/mod",
|
|
'editor' => "$CFG->dirroot/lib/editor",
|
|
'tool' => "$CFG->dirroot/$CFG->admin/tool",
|
|
'local' => "$CFG->dirroot/local",
|
|
);
|
|
|
|
$this->assertSame($expected, $types);
|
|
|
|
}
|
|
|
|
public function test_get_plugin_list_with_file() {
|
|
$this->resetAfterTest(true);
|
|
|
|
// No extra reset here because core_component reset automatically.
|
|
|
|
$expected = array();
|
|
$reports = core_component::get_plugin_list('report');
|
|
foreach ($reports as $name => $fulldir) {
|
|
if (file_exists("$fulldir/lib.php")) {
|
|
$expected[] = $name;
|
|
}
|
|
}
|
|
|
|
// Test cold.
|
|
$list = core_component::get_plugin_list_with_file('report', 'lib.php', false);
|
|
$this->assertEquals($expected, array_keys($list));
|
|
|
|
// Test hot.
|
|
$list = core_component::get_plugin_list_with_file('report', 'lib.php', false);
|
|
$this->assertEquals($expected, array_keys($list));
|
|
|
|
// Test with include.
|
|
$list = core_component::get_plugin_list_with_file('report', 'lib.php', true);
|
|
$this->assertEquals($expected, array_keys($list));
|
|
|
|
// Test missing.
|
|
$list = core_component::get_plugin_list_with_file('report', 'idontexist.php', true);
|
|
$this->assertEquals(array(), array_keys($list));
|
|
}
|
|
}
|