|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Jasny\PHPUnit\Util; |
|
6
|
|
|
|
|
7
|
|
|
/** |
|
8
|
|
|
* Error handler for expected warnings and notices. |
|
9
|
|
|
*/ |
|
10
|
|
|
final class ExpectedWarnings |
|
11
|
|
|
{ |
|
12
|
|
|
private const TYPES = [ |
|
13
|
|
|
\E_NOTICE => 'notice', |
|
14
|
|
|
\E_USER_NOTICE => 'notice', |
|
15
|
|
|
\E_STRICT => 'notice', |
|
16
|
|
|
\E_WARNING => 'warning', |
|
17
|
|
|
\E_USER_WARNING => 'warning', |
|
18
|
|
|
\E_DEPRECATED => 'deprecation', |
|
19
|
|
|
\E_USER_DEPRECATED => 'deprecation', |
|
20
|
|
|
]; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* @var bool |
|
24
|
|
|
*/ |
|
25
|
|
|
private $registered = false; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* @var callable |
|
29
|
|
|
*/ |
|
30
|
|
|
private $oldErrorHandler; |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* @var array |
|
34
|
|
|
*/ |
|
35
|
|
|
private $expected = []; |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* Destructor. Automatically unregister. |
|
39
|
|
|
*/ |
|
40
|
|
|
public function __destruct() |
|
41
|
|
|
{ |
|
42
|
|
|
$this->unregister(); |
|
43
|
8 |
|
} |
|
44
|
|
|
|
|
45
|
8 |
|
/** |
|
46
|
|
|
* Add an expected error. |
|
47
|
|
|
*/ |
|
48
|
|
|
public function add(string $type, string $message = ''): void |
|
49
|
|
|
{ |
|
50
|
|
|
$this->expected[] = ['type' => $type, 'message' => $message, 'triggered' => false]; |
|
51
|
5 |
|
} |
|
52
|
|
|
|
|
53
|
5 |
|
/** |
|
54
|
|
|
* Add an expected error with regexp message. |
|
55
|
|
|
*/ |
|
56
|
|
|
public function addRegExp(string $type, string $regexp): void |
|
57
|
|
|
{ |
|
58
|
|
|
$this->expected[] = ['type' => $type, 'regexp' => $regexp, 'triggered' => false]; |
|
59
|
10 |
|
} |
|
60
|
|
|
|
|
61
|
10 |
|
/** |
|
62
|
1 |
|
* Check if all expected error matches given error. |
|
63
|
|
|
*/ |
|
64
|
|
|
private function expectedMatches(array $expected, string $type, string $message): bool |
|
65
|
10 |
|
{ |
|
66
|
7 |
|
if ($expected['type'] !== $type || $expected['triggered']) { |
|
67
|
10 |
|
return false; |
|
68
|
|
|
} |
|
69
|
|
|
|
|
70
|
|
|
return isset($expected['message']) // either 'message' or 'regexp' is set |
|
71
|
|
|
? ($expected['message'] === '' || strpos($expected['message'], $message) !== false) |
|
72
|
|
|
: (bool)preg_match($expected['regexp'], $message); |
|
73
|
|
|
} |
|
74
|
10 |
|
|
|
75
|
|
|
/** |
|
76
|
10 |
|
* Mark an error as triggered. |
|
77
|
10 |
|
* Returns false if there's no expected error that matches. |
|
78
|
9 |
|
*/ |
|
79
|
9 |
|
private function markTriggered(string $type, string $message): bool |
|
80
|
|
|
{ |
|
81
|
|
|
foreach ($this->expected as &$expected) { |
|
82
|
|
|
if ($this->expectedMatches($expected, $type, $message)) { |
|
83
|
1 |
|
$expected['triggered'] = true; |
|
84
|
|
|
return true; |
|
85
|
|
|
} |
|
86
|
|
|
} |
|
87
|
|
|
|
|
88
|
|
|
return false; |
|
89
|
14 |
|
} |
|
90
|
|
|
|
|
91
|
14 |
|
/** |
|
92
|
11 |
|
* Get all expected errors that weren't triggered. |
|
93
|
|
|
*/ |
|
94
|
|
|
public function getNotTriggered(): array |
|
95
|
|
|
{ |
|
96
|
|
|
return array_filter($this->expected, function (array $expected): bool { |
|
97
|
|
|
return !$expected['triggered']; |
|
98
|
|
|
}); |
|
99
|
10 |
|
} |
|
100
|
|
|
|
|
101
|
10 |
|
/** |
|
102
|
9 |
|
* Invoke the error handler. |
|
103
|
|
|
*/ |
|
104
|
|
|
public function __invoke(int $errorNumber, string $errorString, string $errorFile, int $errorLine): ?bool |
|
105
|
1 |
|
{ |
|
106
|
|
|
if (isset(self::TYPES[$errorNumber]) && $this->markTriggered(self::TYPES[$errorNumber], $errorString)) { |
|
107
|
|
|
return true; |
|
108
|
|
|
} |
|
109
|
|
|
|
|
110
|
|
|
return ($this->oldErrorHandler)($errorNumber, $errorString, $errorFile, $errorLine); |
|
111
|
14 |
|
} |
|
112
|
|
|
|
|
113
|
14 |
|
/** |
|
114
|
|
|
* Register as error handler. |
|
115
|
|
|
*/ |
|
116
|
|
|
public function register(): void |
|
117
|
14 |
|
{ |
|
118
|
14 |
|
if ($this->registered) { |
|
119
|
|
|
return; // @codeCoverageIgnore |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
$this->oldErrorHandler = \set_error_handler($this); |
|
123
|
|
|
$this->registered = true; |
|
124
|
12 |
|
} |
|
125
|
|
|
|
|
126
|
12 |
|
/** |
|
127
|
|
|
* Restore old error handler. |
|
128
|
|
|
*/ |
|
129
|
|
|
public function unregister(): void |
|
130
|
12 |
|
{ |
|
131
|
|
|
if (!$this->registered) { |
|
132
|
12 |
|
return; // @codeCoverageIgnore |
|
133
|
12 |
|
} |
|
134
|
|
|
|
|
135
|
|
|
\restore_error_handler(); |
|
136
|
|
|
|
|
137
|
|
|
$this->registered = false; |
|
138
|
|
|
unset($this->oldErrorHandler); |
|
139
|
3 |
|
} |
|
140
|
|
|
|
|
141
|
3 |
|
/** |
|
142
|
1 |
|
* @internal |
|
143
|
|
|
*/ |
|
144
|
|
|
public static function describeExpected(array $expected): string |
|
145
|
2 |
|
{ |
|
146
|
1 |
|
if (isset($expected['regexp'])) { |
|
147
|
2 |
|
return \sprintf('%s with message matching "%s"', $expected['type'], $expected['regexp']); |
|
148
|
|
|
} |
|
149
|
|
|
|
|
150
|
|
|
return $expected['message'] === '' |
|
151
|
|
|
? $expected['type'] |
|
152
|
|
|
: \sprintf('%s with message "%s"', $expected['type'], $expected['message']); |
|
153
|
|
|
} |
|
154
|
|
|
} |
|
155
|
|
|
|
jasny /
phpunit-extension
