| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://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 <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
namespace core;
|
|
|
18 |
|
|
|
19 |
use core\attribute\deprecated;
|
|
|
20 |
use core\attribute\deprecated_with_reference;
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Tests for \core\attribute\sdeprecated and \core\deprecation.
|
|
|
24 |
*
|
|
|
25 |
* @package core
|
|
|
26 |
* @category test
|
|
|
27 |
* @copyright 2024 Andrew Lyons <andrew@nicols.co.uk>
|
|
|
28 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
29 |
* @covers \core\attribute\deprecated
|
|
|
30 |
* @covers \core\attribute\deprecated_with_reference
|
|
|
31 |
* @covers \core\deprecation
|
|
|
32 |
*/
|
| 1441 |
ariadna |
33 |
final class deprecation_test extends \advanced_testcase {
|
| 1 |
efrain |
34 |
/**
|
|
|
35 |
* @dataProvider emit_provider
|
|
|
36 |
*/
|
|
|
37 |
public function test_emit(
|
|
|
38 |
array $args,
|
|
|
39 |
bool $expectdebugging,
|
|
|
40 |
bool $expectexception,
|
|
|
41 |
): void {
|
|
|
42 |
if ($expectexception) {
|
|
|
43 |
$this->expectException(\coding_exception::class);
|
|
|
44 |
}
|
|
|
45 |
|
|
|
46 |
$attribute = new deprecated(
|
|
|
47 |
...$args,
|
|
|
48 |
replacement: 'Test replacement',
|
|
|
49 |
);
|
|
|
50 |
|
|
|
51 |
$rc = new \ReflectionClass(deprecation::class);
|
|
|
52 |
$method = $rc->getMethod('emit_deprecation_notice');
|
|
|
53 |
$method->invoke(null, $attribute);
|
|
|
54 |
|
|
|
55 |
if ($expectdebugging) {
|
|
|
56 |
$this->assertdebuggingcalledcount(1);
|
|
|
57 |
}
|
|
|
58 |
}
|
|
|
59 |
|
|
|
60 |
public static function emit_provider(): array {
|
|
|
61 |
return [
|
|
|
62 |
[
|
|
|
63 |
[
|
|
|
64 |
'final' => false,
|
|
|
65 |
'emit' => false,
|
|
|
66 |
],
|
|
|
67 |
false,
|
|
|
68 |
false,
|
|
|
69 |
],
|
|
|
70 |
[
|
|
|
71 |
[
|
|
|
72 |
'final' => false,
|
|
|
73 |
'emit' => true,
|
|
|
74 |
],
|
|
|
75 |
true,
|
|
|
76 |
false,
|
|
|
77 |
],
|
|
|
78 |
[
|
|
|
79 |
[
|
|
|
80 |
'final' => true,
|
|
|
81 |
'emit' => false,
|
|
|
82 |
],
|
|
|
83 |
false,
|
|
|
84 |
false,
|
|
|
85 |
],
|
|
|
86 |
[
|
|
|
87 |
[
|
|
|
88 |
'final' => true,
|
|
|
89 |
'emit' => true,
|
|
|
90 |
],
|
|
|
91 |
false,
|
|
|
92 |
true,
|
|
|
93 |
],
|
|
|
94 |
];
|
|
|
95 |
}
|
|
|
96 |
|
|
|
97 |
/**
|
|
|
98 |
* @dataProvider get_deprecation_string_provider
|
|
|
99 |
*/
|
|
|
100 |
public function test_get_deprecation_string(
|
|
|
101 |
?string $replacement,
|
|
|
102 |
?string $since,
|
|
|
103 |
?string $reason,
|
|
|
104 |
?string $mdl,
|
|
|
105 |
string $expected,
|
|
|
106 |
): void {
|
|
|
107 |
$attribute = new deprecated_with_reference(
|
|
|
108 |
owner: 'Test description',
|
|
|
109 |
replacement: $replacement,
|
|
|
110 |
since: $since,
|
|
|
111 |
reason: $reason,
|
|
|
112 |
mdl: $mdl,
|
|
|
113 |
final: false,
|
|
|
114 |
emit: true,
|
|
|
115 |
);
|
|
|
116 |
|
|
|
117 |
$this->assertEquals(
|
|
|
118 |
$expected,
|
|
|
119 |
deprecation::get_deprecation_string($attribute),
|
|
|
120 |
);
|
|
|
121 |
|
|
|
122 |
$rc = new \ReflectionClass(deprecation::class);
|
|
|
123 |
$method = $rc->getMethod('emit_deprecation_notice');
|
|
|
124 |
$method->invoke(null, $attribute);
|
|
|
125 |
|
|
|
126 |
$this->assertDebuggingCalled($expected);
|
|
|
127 |
}
|
|
|
128 |
|
|
|
129 |
public static function get_deprecation_string_provider(): array {
|
|
|
130 |
return [
|
|
|
131 |
[
|
|
|
132 |
'Test replacement',
|
|
|
133 |
null,
|
|
|
134 |
null,
|
|
|
135 |
null,
|
|
|
136 |
'Deprecation: Test description has been deprecated. Use Test replacement instead.',
|
|
|
137 |
],
|
|
|
138 |
[
|
|
|
139 |
'Test replacement',
|
|
|
140 |
'4.1',
|
|
|
141 |
null,
|
|
|
142 |
null,
|
|
|
143 |
'Deprecation: Test description has been deprecated since 4.1. Use Test replacement instead.',
|
|
|
144 |
],
|
|
|
145 |
[
|
|
|
146 |
'Test replacement',
|
|
|
147 |
null,
|
|
|
148 |
'Test reason',
|
|
|
149 |
null,
|
|
|
150 |
'Deprecation: Test description has been deprecated. Test reason. Use Test replacement instead.',
|
|
|
151 |
],
|
|
|
152 |
[
|
|
|
153 |
'Test replacement',
|
|
|
154 |
null,
|
|
|
155 |
null,
|
|
|
156 |
null,
|
|
|
157 |
'Deprecation: Test description has been deprecated. Use Test replacement instead.',
|
|
|
158 |
],
|
|
|
159 |
[
|
|
|
160 |
'Test replacement',
|
|
|
161 |
null,
|
|
|
162 |
null,
|
|
|
163 |
'https://docs.moodle.org/311/en/Deprecated',
|
|
|
164 |
'Deprecation: Test description has been deprecated. Use Test replacement instead. See https://docs.moodle.org/311/en/Deprecated for more information.',
|
|
|
165 |
],
|
|
|
166 |
[
|
|
|
167 |
'Test replacement',
|
|
|
168 |
'4.1',
|
|
|
169 |
'Test reason',
|
|
|
170 |
'https://docs.moodle.org/311/en/Deprecated',
|
|
|
171 |
'Deprecation: Test description has been deprecated since 4.1. Test reason. Use Test replacement instead. See https://docs.moodle.org/311/en/Deprecated for more information.',
|
|
|
172 |
],
|
|
|
173 |
[
|
|
|
174 |
null,
|
|
|
175 |
null,
|
|
|
176 |
'Test reason',
|
|
|
177 |
null,
|
|
|
178 |
'Deprecation: Test description has been deprecated. Test reason.',
|
|
|
179 |
],
|
|
|
180 |
[
|
|
|
181 |
null,
|
|
|
182 |
null,
|
|
|
183 |
null,
|
|
|
184 |
'MDL-80677',
|
|
|
185 |
'Deprecation: Test description has been deprecated. See MDL-80677 for more information.',
|
|
|
186 |
],
|
|
|
187 |
];
|
|
|
188 |
}
|
|
|
189 |
|
| 1441 |
ariadna |
190 |
public function test_deprecated_missing_constuctor_parameters(): void {
|
| 1 |
efrain |
191 |
$this->expectException(\coding_exception::class);
|
| 1441 |
ariadna |
192 |
$this->expectExceptionMessage('A deprecated item must provide either a replacement, reason, or an issue number.');
|
|
|
193 |
new deprecated();
|
| 1 |
efrain |
194 |
}
|
|
|
195 |
|
|
|
196 |
/**
|
|
|
197 |
* @dataProvider from_provider
|
|
|
198 |
*/
|
|
|
199 |
public function test_from($reference, bool $isdeprecated): void {
|
|
|
200 |
$attribute = deprecation::from($reference);
|
|
|
201 |
if ($isdeprecated) {
|
|
|
202 |
$this->assertInstanceOf(deprecated::class, $attribute);
|
|
|
203 |
$this->assertTrue(deprecation::is_deprecated($reference));
|
|
|
204 |
$this->assertDebuggingNotCalled();
|
|
|
205 |
|
|
|
206 |
deprecation::emit_deprecation_if_present($reference);
|
|
|
207 |
$this->assertDebuggingCalled(deprecation::get_deprecation_string($attribute));
|
| 1441 |
ariadna |
208 |
|
|
|
209 |
deprecation::emit_deprecation($reference);
|
|
|
210 |
$this->assertDebuggingCalled(deprecation::get_deprecation_string($attribute));
|
| 1 |
efrain |
211 |
} else {
|
|
|
212 |
$this->assertNull($attribute);
|
|
|
213 |
$this->assertFalse(deprecation::is_deprecated($reference));
|
|
|
214 |
deprecation::emit_deprecation_if_present($reference);
|
|
|
215 |
$this->assertDebuggingNotCalled();
|
| 1441 |
ariadna |
216 |
|
|
|
217 |
deprecation::emit_deprecation($reference);
|
|
|
218 |
$this->assertDebuggingCalled("Deprecation notice requested but object is not deprecated.");
|
| 1 |
efrain |
219 |
}
|
|
|
220 |
}
|
|
|
221 |
|
|
|
222 |
public function test_from_object(): void {
|
|
|
223 |
require_once(dirname(__FILE__) . '/fixtures/deprecated_fixtures.php');
|
|
|
224 |
|
|
|
225 |
$this->assertNull(deprecation::from(new \core\fixtures\not_deprecated_class()));
|
|
|
226 |
$this->assertInstanceOf(deprecated::class, deprecation::from([new \core\fixtures\deprecated_class()]));
|
|
|
227 |
}
|
|
|
228 |
|
|
|
229 |
public static function from_provider(): array {
|
|
|
230 |
require_once(dirname(__FILE__) . '/fixtures/deprecated_fixtures.php');
|
|
|
231 |
return [
|
|
|
232 |
// Classes.
|
|
|
233 |
[\core\fixtures\deprecated_class::class, true],
|
|
|
234 |
[\core\fixtures\deprecated_interface::class, true],
|
|
|
235 |
[\core\fixtures\deprecated_trait::class, true],
|
|
|
236 |
[[\core\fixtures\deprecated_class::class], true],
|
|
|
237 |
[[\core\fixtures\deprecated_interface::class], true],
|
|
|
238 |
[[\core\fixtures\deprecated_trait::class], true],
|
|
|
239 |
|
|
|
240 |
[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class, false],
|
|
|
241 |
[[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class], false],
|
|
|
242 |
|
|
|
243 |
[\core\fixtures\not_deprecated_class::class, false],
|
|
|
244 |
[\core\fixtures\not_deprecated_interface::class, false],
|
|
|
245 |
[\core\fixtures\not_deprecated_trait::class, false],
|
|
|
246 |
[[\core\fixtures\not_deprecated_class::class], false],
|
|
|
247 |
[[\core\fixtures\not_deprecated_interface::class], false],
|
|
|
248 |
[[\core\fixtures\not_deprecated_trait::class], false],
|
|
|
249 |
|
|
|
250 |
// Class properties in a deprecated class.
|
|
|
251 |
[\core\fixtures\deprecated_class::class . '::deprecatedproperty', true],
|
|
|
252 |
[[\core\fixtures\deprecated_class::class, 'deprecatedproperty'], true],
|
|
|
253 |
[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class . '::deprecatedproperty', true],
|
|
|
254 |
[[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class, 'deprecatedproperty'], true],
|
|
|
255 |
[\core\fixtures\not_deprecated_class_using_not_deprecated_trait_features::class . '::deprecatedproperty', true],
|
|
|
256 |
[[\core\fixtures\not_deprecated_class_using_not_deprecated_trait_features::class, 'deprecatedproperty'], true],
|
|
|
257 |
|
|
|
258 |
[\core\fixtures\deprecated_class::class . '::notdeprecatedproperty', true],
|
|
|
259 |
[[\core\fixtures\deprecated_class::class, 'notdeprecatedproperty'], true],
|
|
|
260 |
[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class . '::notdeprecatedproperty', true],
|
|
|
261 |
[[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class, 'notdeprecatedproperty'], true],
|
|
|
262 |
[\core\fixtures\not_deprecated_class_using_not_deprecated_trait_features::class . '::notdeprecatedproperty', false],
|
|
|
263 |
[[\core\fixtures\not_deprecated_class_using_not_deprecated_trait_features::class, 'notdeprecatedproperty'], false],
|
|
|
264 |
|
|
|
265 |
// Class constants in a deprecated class.
|
|
|
266 |
[\core\fixtures\deprecated_class::class . '::DEPRECATED_CONST', true],
|
|
|
267 |
[[\core\fixtures\deprecated_class::class, 'DEPRECATED_CONST'], true],
|
|
|
268 |
|
|
|
269 |
[\core\fixtures\deprecated_class::class . '::NOT_DEPRECATED_CONST', true],
|
|
|
270 |
[[\core\fixtures\deprecated_class::class, 'NOT_DEPRECATED_CONST'], true],
|
|
|
271 |
|
|
|
272 |
// Class methods in a deprecated class.
|
|
|
273 |
[\core\fixtures\deprecated_class::class . '::deprecated_method', true],
|
|
|
274 |
[[\core\fixtures\deprecated_class::class, 'deprecated_method'], true],
|
|
|
275 |
|
|
|
276 |
[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class . '::deprecated_method', true],
|
|
|
277 |
[[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class, 'deprecated_method'], true],
|
|
|
278 |
[\core\fixtures\not_deprecated_class_using_not_deprecated_trait_features::class . '::deprecated_method', true],
|
|
|
279 |
[[\core\fixtures\not_deprecated_class_using_not_deprecated_trait_features::class, 'deprecated_method'], true],
|
|
|
280 |
|
|
|
281 |
[\core\fixtures\deprecated_class::class . '::not_deprecated_method', true],
|
|
|
282 |
[[\core\fixtures\deprecated_class::class, 'not_deprecated_method'], true],
|
|
|
283 |
|
|
|
284 |
[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class . '::not_deprecated_method', true],
|
|
|
285 |
[[\core\fixtures\not_deprecated_class_using_deprecated_trait_features::class, 'not_deprecated_method'], true],
|
|
|
286 |
[\core\fixtures\not_deprecated_class_implementing_deprecated_interface::class . '::not_deprecated_method', true],
|
|
|
287 |
[[\core\fixtures\not_deprecated_class_implementing_deprecated_interface::class, 'not_deprecated_method'], true],
|
|
|
288 |
|
|
|
289 |
// Class properties in a not-deprecated class.
|
|
|
290 |
[\core\fixtures\not_deprecated_class::class . '::deprecatedproperty', true],
|
|
|
291 |
[[\core\fixtures\not_deprecated_class::class, 'deprecatedproperty'], true],
|
|
|
292 |
|
|
|
293 |
[\core\fixtures\not_deprecated_class::class . '::notdeprecatedproperty', false],
|
|
|
294 |
[[\core\fixtures\not_deprecated_class::class, 'notdeprecatedproperty'], false],
|
|
|
295 |
|
|
|
296 |
// Class constants in a not-deprecated class.
|
|
|
297 |
[\core\fixtures\not_deprecated_class::class . '::DEPRECATED_CONST', true],
|
|
|
298 |
[[\core\fixtures\not_deprecated_class::class, 'DEPRECATED_CONST'], true],
|
|
|
299 |
|
|
|
300 |
[\core\fixtures\not_deprecated_class::class . '::NOT_DEPRECATED_CONST', false],
|
|
|
301 |
[[\core\fixtures\not_deprecated_class::class, 'NOT_DEPRECATED_CONST'], false],
|
|
|
302 |
|
|
|
303 |
[\core\fixtures\not_deprecated_interface::class . '::DEPRECATED_CONST', true],
|
|
|
304 |
[[\core\fixtures\not_deprecated_interface::class, 'DEPRECATED_CONST'], true],
|
|
|
305 |
|
|
|
306 |
[\core\fixtures\not_deprecated_interface::class . '::NOT_DEPRECATED_CONST', false],
|
|
|
307 |
[[\core\fixtures\not_deprecated_interface::class, 'NOT_DEPRECATED_CONST'], false],
|
|
|
308 |
|
|
|
309 |
// Class methods in a not-deprecated class.
|
|
|
310 |
[\core\fixtures\not_deprecated_class::class . '::deprecated_method', true],
|
|
|
311 |
[[\core\fixtures\not_deprecated_class::class, 'deprecated_method'], true],
|
|
|
312 |
|
|
|
313 |
[\core\fixtures\not_deprecated_class::class . '::not_deprecated_method', false],
|
|
|
314 |
[[\core\fixtures\not_deprecated_class::class, 'not_deprecated_method'], false],
|
|
|
315 |
|
|
|
316 |
// Non-existent class.
|
|
|
317 |
['non_existent_class', false],
|
|
|
318 |
[['non_existent_class'], false],
|
|
|
319 |
|
|
|
320 |
// Non-existent feature in an existent class.
|
|
|
321 |
[[\core\fixtures\not_deprecated_class::class, 'no_such_method'], false],
|
|
|
322 |
|
|
|
323 |
// Not-deprecated class.
|
|
|
324 |
[\core\fixtures\not_deprecated_class::class, false],
|
|
|
325 |
|
|
|
326 |
// Deprecated global function.
|
|
|
327 |
['core\fixtures\deprecated_function', true],
|
|
|
328 |
['core\fixtures\not_deprecated_function', false],
|
|
|
329 |
|
|
|
330 |
// Empty array.
|
|
|
331 |
[[], false],
|
|
|
332 |
];
|
|
|
333 |
}
|
|
|
334 |
|
|
|
335 |
/**
|
|
|
336 |
* @dataProvider deprecated_ownership_provider
|
|
|
337 |
*/
|
|
|
338 |
public function test_deprecated_class(
|
|
|
339 |
array $reference,
|
|
|
340 |
string $expectedowner,
|
|
|
341 |
): void {
|
|
|
342 |
require_once(dirname(__FILE__) . '/fixtures/deprecated_fixtures.php');
|
|
|
343 |
|
|
|
344 |
// All attributes for any part of a deprecated class should belong to the deprecated class.
|
|
|
345 |
$this->assertEquals(
|
|
|
346 |
$expectedowner,
|
|
|
347 |
deprecation::from($reference)->owner,
|
|
|
348 |
);
|
|
|
349 |
}
|
|
|
350 |
|
|
|
351 |
public static function deprecated_ownership_provider(): array {
|
|
|
352 |
return [
|
|
|
353 |
// Any part of a deprecated class will emit the deprecation for the class as a whole.
|
|
|
354 |
[
|
|
|
355 |
[\core\fixtures\deprecated_class::class],
|
|
|
356 |
\core\fixtures\deprecated_class::class,
|
|
|
357 |
],
|
|
|
358 |
[
|
|
|
359 |
[\core\fixtures\deprecated_class::class, 'deprecatedproperty'],
|
|
|
360 |
\core\fixtures\deprecated_class::class,
|
|
|
361 |
],
|
|
|
362 |
[
|
|
|
363 |
[\core\fixtures\deprecated_class::class, 'notdeprecatedproperty'],
|
|
|
364 |
\core\fixtures\deprecated_class::class,
|
|
|
365 |
],
|
|
|
366 |
[
|
|
|
367 |
[\core\fixtures\deprecated_class::class, 'deprecated_method'],
|
|
|
368 |
\core\fixtures\deprecated_class::class,
|
|
|
369 |
],
|
|
|
370 |
[
|
|
|
371 |
[\core\fixtures\deprecated_class::class, 'not_deprecated_method'],
|
|
|
372 |
\core\fixtures\deprecated_class::class,
|
|
|
373 |
],
|
|
|
374 |
[
|
|
|
375 |
[\core\fixtures\deprecated_class::class, 'DEPRECATED_CONST'],
|
|
|
376 |
\core\fixtures\deprecated_class::class,
|
|
|
377 |
],
|
|
|
378 |
[
|
|
|
379 |
[\core\fixtures\deprecated_class::class, 'NOT_DEPRECATED_CONST'],
|
|
|
380 |
\core\fixtures\deprecated_class::class,
|
|
|
381 |
],
|
|
|
382 |
|
|
|
383 |
// A non-deprecated class will emit just for that feature.
|
|
|
384 |
[
|
|
|
385 |
[\core\fixtures\not_deprecated_class::class, 'deprecatedproperty'],
|
|
|
386 |
\core\fixtures\not_deprecated_class::class . '::deprecatedproperty',
|
|
|
387 |
],
|
|
|
388 |
[
|
|
|
389 |
[\core\fixtures\not_deprecated_class::class, 'deprecated_method'],
|
|
|
390 |
\core\fixtures\not_deprecated_class::class . '::deprecated_method',
|
|
|
391 |
],
|
|
|
392 |
[
|
|
|
393 |
[\core\fixtures\not_deprecated_class::class, 'DEPRECATED_CONST'],
|
|
|
394 |
\core\fixtures\not_deprecated_class::class . '::DEPRECATED_CONST',
|
|
|
395 |
],
|
|
|
396 |
];
|
|
|
397 |
}
|
|
|
398 |
}
|