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

MDL-71036 phpunit: xml config - deprecate whitelist from coverage

Browse Source 
Following the changes in the schema, from "whitelists" to "includes",
we are deprecating these two properties from phpunit_coverage_info:

- whitelistfolders => includelistfolders
- whitelistfiles   => includelistfiles

They will continue working over the deprecation period but the init/util
scripts will throw some warnings about them being deprecated for 3.11 and
the way to replace them.

Standard 2y deprecation applies with final removed to happen @ MDL-71067
This commit is contained in:
Eloy Lafuente (stronk7) 2021-02-28 23:37:35 +01:00
parent 83a35142f6
commit a148fd8602
1 changed files with 47 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
lib/phpunit/classes/coverage_info.php
View File

@ -33,40 +33,71 @@ defined('MOODLE_INTERNAL') || die();
*/ */
class phpunit_coverage_info { class phpunit_coverage_info {
/** @var array The list of folders relative to the plugin root to whitelist in coverage generation. */ /**
* @var array The list of folders relative to the plugin root to whitelist in coverage generation.
* @deprecated since Moodle 3.11 MDL-70745 - please don't use this property any more.
* @todo MDL-71067 - remove in Moodle 4.3
*/
protected $whitelistfolders = []; protected $whitelistfolders = [];
/** @var array The list of files relative to the plugin root to whitelist in coverage generation. */ /**
* @var array The list of files relative to the plugin root to whitelist in coverage generation.
* @deprecated since Moodle 3.11 MDL-70745 - please don't use this property any more.
* @todo MDL-71067 - remove in Moodle 4.3
*/
protected $whitelistfiles = []; protected $whitelistfiles = [];
/** @var array The list of folders relative to the plugin root to excludelist in coverage generation. */ /** @var array The list of folders relative to the plugin root to include in coverage generation. */
protected $includelistfolders = [];
/** @var array The list of files relative to the plugin root to include in coverage generation. */
protected $includelistfiles = [];
/** @var array The list of folders relative to the plugin root to exclude from coverage generation. */
protected $excludelistfolders = []; protected $excludelistfolders = [];
/** @var array The list of files relative to the plugin root to excludelist in coverage generation. */ /** @var array The list of files relative to the plugin root to exclude from coverage generation. */
protected $excludelistfiles = []; protected $excludelistfiles = [];
/** /**
* Get the formatted XML list of files and folders to whitelist. * Get the formatted XML list of files and folders to include.
* *
* @param string $plugindir The root of the plugin, relative to the dataroot. * @param string $plugindir The root of the plugin, relative to the dataroot.
* @return array * @return array
*/ */
final public function get_whitelists(string $plugindir) : array { final public function get_includelists(string $plugindir) : array {
$filters = []; $coverages = [];
if (!empty($plugindir)) { if (!empty($plugindir)) {
$plugindir .= "/"; $plugindir .= "/";
// TODO: MDL-71067 - remove this whole block once these properties deprecation period ends.
if (!empty($this->whitelistfolders) || !empty($this->whitelistfiles)) {
// Warning if the deprecated (whitelist) properties are found.
echo "Warning: \$whitelistfolders and \$whitelistfiles in " .
"coverage.php files are deprecated since Moodle 3.11. " .
"Please, replace them with \$includelistfolders and " .
"\$includelistfiles in {$plugindir}tests/coverage.php\n";
foreach ($this->whitelistfolders as $folder) {
$coverages[] = html_writer::tag('directory', "{$plugindir}{$folder}", ['suffix' => '.php']);
}
foreach ($this->whitelistfiles as $file) {
$coverages[] = html_writer::tag('file', "{$plugindir}{$file}");
}
}
} }
foreach ($this->whitelistfolders as $folder) { foreach ($this->includelistfolders as $folder) {
$filters[] = html_writer::tag('directory', "{$plugindir}{$folder}", ['suffix' => '.php']); $coverages[] = html_writer::tag('directory', "{$plugindir}{$folder}", ['suffix' => '.php']);
} }
foreach ($this->whitelistfiles as $file) { foreach ($this->includelistfiles as $file) {
$filters[] = html_writer::tag('file', "{$plugindir}{$file}"); $coverages[] = html_writer::tag('file', "{$plugindir}{$file}");
} }
return $filters; return $coverages;
} }
/** /**
@ -76,20 +107,20 @@ class phpunit_coverage_info {
* @return array * @return array
*/ */
final public function get_excludelists(string $plugindir) : array { final public function get_excludelists(string $plugindir) : array {
$filters = []; $coverages = [];
if (!empty($plugindir)) { if (!empty($plugindir)) {
$plugindir .= "/"; $plugindir .= "/";
} }
foreach ($this->excludelistfolders as $folder) { foreach ($this->excludelistfolders as $folder) {
$filters[] = html_writer::tag('directory', "{$plugindir}{$folder}", ['suffix' => '.php']); $coverages[] = html_writer::tag('directory', "{$plugindir}{$folder}", ['suffix' => '.php']);
} }
foreach ($this->excludelistfiles as $file) { foreach ($this->excludelistfiles as $file) {
$filters[] = html_writer::tag('file', "{$plugindir}{$file}"); $coverages[] = html_writer::tag('file', "{$plugindir}{$file}");
} }
return $filters; return $coverages;
} }
} }