forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 1
/
autoloader.php
203 lines (184 loc) · 8.27 KB
/
autoloader.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<?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/>.
/**
* PHPUnit autoloader for Moodle.
*
* @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
*/
/**
* Class phpunit_autoloader.
*
* Please notice that phpunit testcases obey frankenstyle naming rules,
* that is full component prefix + _testcase postfix. The files are expected
* in tests directory inside each component. There are some extra tests
* directories which require both classname and file path.
*
* Examples:
*
* vendor/bin/phpunit core_component_testcase
* vendor/bin/phpunit lib/tests/component_test.php
* vendor/bin/phpunit core_component_testcase lib/tests/component_test.php
*
* @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
*/
class phpunit_autoloader implements \PHPUnit\Runner\TestSuiteLoader {
public function load(string $suiteClassName, string $suiteClassFile = ''): ReflectionClass {
global $CFG;
// Let's guess what user entered on the commandline...
if ($suiteClassFile) {
// This means they either entered the class+path or path only.
if (strpos($suiteClassName, '/') !== false) {
// Class names can not contain slashes,
// user entered only path without testcase class name.
return $this->guess_class_from_path($suiteClassFile);
}
if (strpos($suiteClassName, '\\') !== false and strpos($suiteClassFile, $suiteClassName.'.php') !== false) {
// This must be backslashed windows path.
return $this->guess_class_from_path($suiteClassFile);
}
}
if (class_exists($suiteClassName, false)) {
$class = new ReflectionClass($suiteClassName);
return $class;
}
if ($suiteClassFile) {
PHPUnit\Util\Fileloader::checkAndLoad($suiteClassFile);
if (class_exists($suiteClassName, false)) {
$class = new ReflectionClass($suiteClassName);
return $class;
}
throw new PHPUnit\Framework\Exception(
sprintf("Class '%s' could not be found in '%s'.", $suiteClassName, $suiteClassFile)
);
}
/*
* Try standard testcase naming rules based on frankenstyle component:
* 1/ test classes should use standard frankenstyle class names plus suffix "_testcase"
* 2/ test classes should be stored in files with suffix "_test"
*/
$parts = explode('_', $suiteClassName);
$suffix = end($parts);
$component = '';
if ($suffix === 'testcase') {
unset($parts[key($parts)]);
while($parts) {
if (!$component) {
$component = array_shift($parts);
} else {
$component = $component . '_' . array_shift($parts);
}
// Try standard plugin and core subsystem locations.
if ($fulldir = core_component::get_component_directory($component)) {
$testfile = implode('_', $parts);
$fullpath = "{$fulldir}/tests/{$testfile}_test.php";
if (is_readable($fullpath)) {
include_once($fullpath);
if (class_exists($suiteClassName, false)) {
$class = new ReflectionClass($suiteClassName);
return $class;
}
}
}
}
// The last option is testsuite directories in main phpunit.xml file.
$xmlfile = "$CFG->dirroot/phpunit.xml";
if (is_readable($xmlfile) and $xml = file_get_contents($xmlfile)) {
$dom = new DOMDocument();
$dom->loadXML($xml);
$nodes = $dom->getElementsByTagName('testsuite');
foreach ($nodes as $node) {
/** @var DOMNode $node */
$suitename = trim($node->attributes->getNamedItem('name')->nodeValue);
if (strpos($suitename, 'core') !== 0 or strpos($suitename, ' ') !== false) {
continue;
}
// This is a nasty hack: testsuit names are sometimes used as prefix for testcases
// in non-standard core subsystem locations.
if (strpos($suiteClassName, $suitename) !== 0) {
continue;
}
foreach ($node->childNodes as $dirnode) {
/** @var DOMNode $dirnode */
$dir = trim($dirnode->textContent);
if (!$dir) {
continue;
}
$dir = $CFG->dirroot.'/'.$dir;
$parts = explode('_', $suitename);
$prefix = '';
while ($parts) {
if ($prefix) {
$prefix = $prefix.'_'.array_shift($parts);
} else {
$prefix = array_shift($parts);
}
$filename = substr($suiteClassName, strlen($prefix)+1);
$filename = preg_replace('/testcase$/', 'test', $filename);
if (is_readable("$dir/$filename.php")) {
include_once("$dir/$filename.php");
if (class_exists($suiteClassName, false)) {
$class = new ReflectionClass($suiteClassName);
return $class;
}
}
}
}
}
}
}
throw new PHPUnit\Framework\Exception(
sprintf("Class '%s' could not be found in '%s'.", $suiteClassName, $suiteClassFile)
);
}
protected function guess_class_from_path($file) {
// Somebody is using just the file name, we need to look inside the file and guess the testcase
// class name. Let's throw fatal error if there are more testcases in one file.
$classes = get_declared_classes();
PHPUnit\Util\Fileloader::checkAndLoad($file);
$includePathFilename = stream_resolve_include_path($file);
$loadedClasses = array_diff(get_declared_classes(), $classes);
$candidates = array();
foreach ($loadedClasses as $loadedClass) {
$class = new ReflectionClass($loadedClass);
if ($class->isSubclassOf('PHPUnit\Framework\TestCase') and !$class->isAbstract()) {
if (realpath($includePathFilename) === realpath($class->getFileName())) {
$candidates[] = $loadedClass;
}
}
}
if (count($candidates) == 0) {
throw new PHPUnit\Framework\Exception(
sprintf("File '%s' does not contain any test cases.", $file)
);
}
if (count($candidates) > 1) {
throw new PHPUnit\Framework\Exception(
sprintf("File '%s' contains multiple test cases: ".implode(', ', $candidates), $file)
);
}
$classname = reset($candidates);
return new ReflectionClass($classname);
}
public function reload(ReflectionClass $aClass): ReflectionClass {
return $aClass;
}
}