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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
<?php
namespace Doctrine\Tests\Common\Annotations;
use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\DocParser;
use Doctrine\Common\Annotations\Reader;
use Doctrine\Tests\Common\Annotations\Fixtures\Annotation\SingleUseAnnotation;
use Doctrine\Tests\Common\Annotations\Fixtures\ClassWithFullPathUseStatement;
use Doctrine\Tests\Common\Annotations\Fixtures\ClassWithImportedIgnoredAnnotation;
use Doctrine\Tests\Common\Annotations\Fixtures\ClassWithPHPCodeSnifferAnnotation;
use Doctrine\Tests\Common\Annotations\Fixtures\ClassWithPhpCsSuppressAnnotation;
use Doctrine\Tests\Common\Annotations\Fixtures\ClassWithPHPStanGenericsAnnotations;
use Doctrine\Tests\Common\Annotations\Fixtures\IgnoredNamespaces\AnnotatedAtClassLevel;
use Doctrine\Tests\Common\Annotations\Fixtures\IgnoredNamespaces\AnnotatedAtMethodLevel;
use Doctrine\Tests\Common\Annotations\Fixtures\IgnoredNamespaces\AnnotatedAtPropertyLevel;
use Doctrine\Tests\Common\Annotations\Fixtures\IgnoredNamespaces\AnnotatedWithAlias;
use InvalidArgumentException;
use LogicException;
use ReflectionClass;
use function class_exists;
use function spl_autoload_register;
use function spl_autoload_unregister;
class AnnotationReaderTest extends AbstractReaderTest
{
/**
* @return AnnotationReader
*/
protected function getReader(?DocParser $parser = null): Reader
{
return new AnnotationReader($parser);
}
public function testMethodAnnotationFromTrait(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(Fixtures\ClassUsesTrait::class);
$annotations = $reader->getMethodAnnotations($ref->getMethod('someMethod'));
self::assertInstanceOf(Bar\Autoload::class, $annotations[0]);
$annotations = $reader->getMethodAnnotations($ref->getMethod('traitMethod'));
self::assertInstanceOf(Fixtures\Annotation\Autoload::class, $annotations[0]);
}
public function testMethodAnnotationFromOverwrittenTrait(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(Fixtures\ClassOverwritesTrait::class);
$annotations = $reader->getMethodAnnotations($ref->getMethod('traitMethod'));
self::assertInstanceOf(Bar2\Autoload::class, $annotations[0]);
}
public function testPropertyAnnotationFromTrait(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(Fixtures\ClassUsesTrait::class);
$annotations = $reader->getPropertyAnnotations($ref->getProperty('aProperty'));
self::assertInstanceOf(Bar\Autoload::class, $annotations[0]);
$annotations = $reader->getPropertyAnnotations($ref->getProperty('traitProperty'));
self::assertInstanceOf(Fixtures\Annotation\Autoload::class, $annotations[0]);
}
public function testOmitNotRegisteredAnnotation(): void
{
$parser = new DocParser();
$parser->setIgnoreNotImportedAnnotations(true);
$reader = $this->getReader($parser);
$ref = new ReflectionClass(Fixtures\ClassWithNotRegisteredAnnotationUsed::class);
$annotations = $reader->getMethodAnnotations($ref->getMethod('methodWithNotRegisteredAnnotation'));
self::assertEquals([], $annotations);
}
public function testClassAnnotationSupportsSelfAccessorForConstants(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(Fixtures\ClassWithAnnotationWithSelfConstantReference::class);
$annotations = $reader->getClassAnnotations($ref);
self::assertCount(1, $annotations);
$annotation = $annotations[0];
self::assertInstanceOf(Fixtures\AnnotationWithConstants::class, $annotation);
self::assertEquals(
$annotation->value,
Fixtures\ClassWithAnnotationWithSelfConstantReference::VALUE_FOR_CLASS
);
}
public function testPropertyAnnotationSupportsSelfAccessorForConstants(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(Fixtures\ClassWithAnnotationWithSelfConstantReference::class);
$classProperty = $ref->getProperty('classProperty');
$classAnnotation = $reader->getPropertyAnnotation($classProperty, Fixtures\AnnotationWithConstants::class);
self::assertNotNull($classAnnotation);
self::assertEquals(
$classAnnotation->value,
Fixtures\ClassWithAnnotationWithSelfConstantReference::VALUE_FOR_CLASS
);
$traitProperty = $ref->getProperty('traitProperty');
$traitAnnotation = $reader->getPropertyAnnotation($traitProperty, Fixtures\AnnotationWithConstants::class);
self::assertNotNull($traitAnnotation);
self::assertEquals(
$traitAnnotation->value,
Fixtures\ClassWithAnnotationWithSelfConstantReference::VALUE_FOR_TRAIT
);
}
public function testMethodAnnotationSupportsSelfAccessorForConstants(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(Fixtures\ClassWithAnnotationWithSelfConstantReference::class);
$classMethod = $ref->getMethod('classMethod');
$classAnnotation = $reader->getMethodAnnotation($classMethod, Fixtures\AnnotationWithConstants::class);
self::assertNotNull($classAnnotation);
self::assertEquals(
$classAnnotation->value,
Fixtures\ClassWithAnnotationWithSelfConstantReference::VALUE_FOR_CLASS
);
$traitMethod = $ref->getMethod('traitMethod');
$traitAnnotation = $reader->getMethodAnnotation($traitMethod, Fixtures\AnnotationWithConstants::class);
self::assertNotNull($traitAnnotation);
self::assertEquals(
$traitAnnotation->value,
Fixtures\ClassWithAnnotationWithSelfConstantReference::VALUE_FOR_TRAIT
);
}
/**
* @group 45
* @runInSeparateProcess
*/
public function testClassAnnotationIsIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(AnnotatedAtClassLevel::class);
$reader::addGlobalIgnoredNamespace('SomeClassAnnotationNamespace');
self::assertEmpty($reader->getClassAnnotations($ref));
}
/**
* @group 45
* @runInSeparateProcess
*/
public function testMethodAnnotationIsIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(AnnotatedAtMethodLevel::class);
$reader::addGlobalIgnoredNamespace('SomeMethodAnnotationNamespace');
self::assertEmpty($reader->getMethodAnnotations($ref->getMethod('test')));
}
/**
* @group 45
* @runInSeparateProcess
*/
public function testPropertyAnnotationIsIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(AnnotatedAtPropertyLevel::class);
$reader::addGlobalIgnoredNamespace('SomePropertyAnnotationNamespace');
self::assertEmpty($reader->getPropertyAnnotations($ref->getProperty('property')));
}
/**
* @group 244
* @runInSeparateProcess
*/
public function testAnnotationWithAliasIsIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(AnnotatedWithAlias::class);
$reader::addGlobalIgnoredNamespace('SomePropertyAnnotationNamespace');
self::assertEmpty($reader->getPropertyAnnotations($ref->getProperty('property')));
}
public function testClassWithFullPathUseStatement(): void
{
if (class_exists(SingleUseAnnotation::class, false)) {
throw new LogicException(
'The SingleUseAnnotation must not be used in other tests for this test to be useful.' .
'If the class is already loaded then the code path that finds the class to load is not used and ' .
'this test becomes useless.'
);
}
$reader = $this->getReader();
$ref = new ReflectionClass(ClassWithFullPathUseStatement::class);
$annotations = $reader->getClassAnnotations($ref);
self::assertInstanceOf(SingleUseAnnotation::class, $annotations[0]);
}
public function testPhpCsSuppressAnnotationIsIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(ClassWithPhpCsSuppressAnnotation::class);
self::assertEmpty($reader->getMethodAnnotations($ref->getMethod('foo')));
}
public function testGloballyIgnoredAnnotationNotIgnored(): void
{
$reader = $this->getReader();
$class = new ReflectionClass(Fixtures\ClassDDC1660::class);
$testLoader = static function (string $className): bool {
if ($className === 'since') {
throw new InvalidArgumentException(
'Globally ignored annotation names should never be passed to an autoloader.'
);
}
return false;
};
spl_autoload_register($testLoader, true, true);
try {
self::assertEmpty($reader->getClassAnnotations($class));
} finally {
spl_autoload_unregister($testLoader);
}
}
public function testPHPCodeSnifferAnnotationsAreIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(ClassWithPHPCodeSnifferAnnotation::class);
self::assertEmpty($reader->getClassAnnotations($ref));
}
public function testPHPStanGenericsAnnotationsAreIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(ClassWithPHPStanGenericsAnnotations::class);
self::assertEmpty($reader->getClassAnnotations($ref));
self::assertEmpty($reader->getPropertyAnnotations($ref->getProperty('bar')));
self::assertEmpty($reader->getMethodAnnotations($ref->getMethod('foo')));
$this->expectException('\Doctrine\Common\Annotations\AnnotationException');
$this->expectExceptionMessage(
'[Semantical Error] The annotation "@Template" in method' .
' Doctrine\Tests\Common\Annotations\Fixtures\ClassWithPHPStanGenericsAnnotations' .
'::twigTemplateFunctionName() was never imported.'
);
self::assertEmpty($reader->getMethodAnnotations($ref->getMethod('twigTemplateFunctionName')));
}
public function testImportedIgnoredAnnotationIsStillIgnored(): void
{
$reader = $this->getReader();
$ref = new ReflectionClass(ClassWithImportedIgnoredAnnotation::class);
self::assertEmpty($reader->getMethodAnnotations($ref->getMethod('something')));
}
}
|
