| 1441 |
ariadna |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - https://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <https://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
namespace tool_capability;
|
|
|
18 |
|
|
|
19 |
// phpcs:disable moodle.PHPUnit.TestCaseProvider.dataProviderSyntaxMethodNotFound
|
|
|
20 |
|
|
|
21 |
/**
|
|
|
22 |
* Detect common problems in capability definitions of plugins.
|
|
|
23 |
*
|
|
|
24 |
* @group plugin_checks
|
|
|
25 |
* @package tool_capability
|
|
|
26 |
* @copyright 2025 Petr Skoda
|
|
|
27 |
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
28 |
*/
|
|
|
29 |
final class plugin_checks_test extends \core\tests\plugin_checks_testcase {
|
|
|
30 |
/**
|
|
|
31 |
* Verify contents of plugin db/access.php file.
|
|
|
32 |
*
|
|
|
33 |
* @dataProvider all_plugins_provider
|
|
|
34 |
* @coversNothing
|
|
|
35 |
*
|
|
|
36 |
* @param string $component
|
|
|
37 |
* @param string $plugintype
|
|
|
38 |
* @param string $pluginname
|
|
|
39 |
* @param string $dir
|
|
|
40 |
*/
|
|
|
41 |
public function test_db_access_file(string $component, string $plugintype, string $pluginname, string $dir): void {
|
|
|
42 |
global $CFG;
|
|
|
43 |
|
|
|
44 |
$stringmanager = get_string_manager();
|
|
|
45 |
$corerolefile = "$CFG->dirroot/lang/en/role.php";
|
|
|
46 |
$langfile = "$dir/lang/en/$component.php";
|
|
|
47 |
|
|
|
48 |
$file = "$dir/db/access.php";
|
|
|
49 |
$capabilities = $this->fetch_array_from_file($file, 'capabilities');
|
|
|
50 |
if (!$capabilities) {
|
|
|
51 |
$this->expectNotToPerformAssertions();
|
|
|
52 |
return;
|
|
|
53 |
}
|
|
|
54 |
|
|
|
55 |
foreach ($capabilities as $capname => $capability) {
|
|
|
56 |
if ($plugintype === 'qbank' && str_starts_with($capname, 'moodle/question:')) {
|
|
|
57 |
// Question bank capabilities are irregular.
|
|
|
58 |
$strname = explode('/', $capname, 2)[1];
|
|
|
59 |
$this->assertTrue($stringmanager->string_exists($strname, 'core_role'),
|
|
|
60 |
"Missing capability name string '$strname' in $corerolefile");
|
|
|
61 |
continue;
|
|
|
62 |
}
|
|
|
63 |
$this->assertMatchesRegularExpression("|^$plugintype/$pluginname:[a-z0-9_]+$|", $capname);
|
|
|
64 |
$strname = substr($capname, strlen($plugintype) + 1);
|
|
|
65 |
$this->assertTrue($stringmanager->string_exists($strname, $component),
|
|
|
66 |
"Missing capability name string '$strname' in $langfile");
|
|
|
67 |
$this->assertSame($capname, clean_param($capname, PARAM_CAPABILITY));
|
|
|
68 |
}
|
|
|
69 |
}
|
|
|
70 |
}
|