-
-
Notifications
You must be signed in to change notification settings - Fork 55
/
NodeVisitorTest.php
255 lines (237 loc) · 11.7 KB
/
NodeVisitorTest.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
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
<?php
declare(strict_types=1);
namespace Icanhazstring\Composer\Test\Unused\Integration\Parser\PHP;
use Exception;
use Icanhazstring\Composer\Unused\Error\ErrorHandlerInterface;
use Icanhazstring\Composer\Unused\Parser\PHP\NodeVisitor;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\ClassConstStrategy;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\ExtendsParseStrategy;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\ImplementsParseStrategy;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\InstanceofStrategy;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\NewParseStrategy;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\ParseStrategyInterface;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\PhpExtensionStrategy;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\StaticParseStrategy;
use Icanhazstring\Composer\Unused\Parser\PHP\Strategy\UseParseStrategy;
use PhpParser\Node;
use PhpParser\NodeTraverser;
use PhpParser\ParserFactory;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Psr\Log\NullLogger;
use SplFileInfo;
use const ASSET_DIR;
class NodeVisitorTest extends TestCase
{
use ProphecyTrait;
/**
* @return array<string, array<string, mixed>>
*/
public function itShouldParseUsagesDataProvider(): array
{
return [
'StaticParseStrategyShouldReturnEmptyUsageOnVariableCall' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/StaticVariableCall.php',
'strategy' => new StaticParseStrategy()
],
'StaticParseStrategyShouldReturnEmptyUsageOnNonFQCall' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/StaticNonFullyQualifiedCall.php',
'strategy' => new StaticParseStrategy()
],
'StaticParseStrategyShouldReturnCorrectNamespaceOnFQCall' => [
'expectedUsedNamespaces' => [
'StaticFullyQualifiedCall'
],
'inputFile' => ASSET_DIR . '/TestFiles/StaticFullyQualifiedCall.php',
'strategy' => new StaticParseStrategy()
],
'NewParseStrategyShouldReturnEmptyUsageOnDynamicClassnameCall' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/NewInstantiateDynamicClass.php',
'strategy' => new NewParseStrategy()
],
'NewParseStrategyShouldReturnEmptyUsageOnNonFQCall' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/NewInstantiateNonFullyQualifiedCall.php',
'strategy' => new NewParseStrategy()
],
'NewParseStrategyShouldReturnCorrectNamespaceOnFQCall' => [
'expectedUsedNamespaces' => [
'NewInstantiateFullyQualifiedCall'
],
'inputFile' => ASSET_DIR . '/TestFiles/NewInstantiateFullyQualifiedCall.php',
'strategy' => new NewParseStrategy()
],
'UseParseStrategyShouldReturnSingleLineImportedNamespaces' => [
'expectedUsedNamespaces' => [
'Icanhazstring\Composer',
'Icanhazstring\Composer\Unused\Parser\PHP',
'Icanhazstring\Composer\Unused\Command'
],
'inputFile' => ASSET_DIR . '/TestFiles/UseSingleLineNoGroup.php',
'strategy' => new UseParseStrategy()
],
'UseParseStrategyShouldReturnMultiLineImportedNamespaces' => [
'expectedUsedNamespaces' => [
UseParseStrategy::class,
StaticParseStrategy::class,
NewParseStrategy::class
],
'inputFile' => ASSET_DIR . '/TestFiles/UseMultiLineGroup.php',
'strategy' => new UseParseStrategy()
],
'ClassConstStrategyShouldReturnCorrectNamespace' => [
'expectedUsedNamespaces' => [
UseParseStrategy::class,
StaticParseStrategy::class
],
'inputFile' => ASSET_DIR . '/TestFiles/ClassConst.php',
'strategy' => new ClassConstStrategy()
],
'NewParseStrategyShouldReturnQualifiedNamespace' => [
'expectedUsedNamespaces' => [
'TestFile\NewInstantiateQualifiedClass'
],
'inputFile' => ASSET_DIR . '/TestFiles/NewInstantiateQualifiedClass.php',
'strategy' => new NewParseStrategy()
],
'StaticParseStrategyShouldReturnQualifiedNamespace' => [
'expectedUsedNamespaces' => [
'TestFile\StaticQualifiedCall'
],
'inputFile' => ASSET_DIR . '/TestFiles/StaticQualifiedCall.php',
'strategy' => new StaticParseStrategy()
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---1' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithCustomInterfaceName.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---2' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithCustomInterface.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---3' => [
'expectedUsedNamespaces' => ['ext-json'],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithExtensionInterface.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---4' => [
'expectedUsedNamespaces' => ['ext-json'],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithExtensionInterfaceInUse.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---5' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithCustomConstant.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---6' => [
'expectedUsedNamespaces' => ['ext-json'],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithJsonConstant.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---7' => [
'expectedUsedNamespaces' => ['ext-json'],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithExtensionFunction.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---8' => [
'expectedUsedNamespaces' => [],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithCustomFunction.php',
'strategy' => new PhpExtensionStrategy(['json'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---9' => [
'expectedUsedNamespaces' => ['ext-zend-opcache'],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithZendOpcache.php',
'strategy' => new PhpExtensionStrategy(['Zend Opcache'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---10' => [
'expectedUsedNamespaces' => ['php'],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithCore.php',
'strategy' => new PhpExtensionStrategy(['Core'], new NullLogger())
],
'PhpExtensionParseStrategyShouldReturnQualifiedNamespace---11' => [
'expectedUsedNamespaces' => ['ext-ds'],
'inputFile' => ASSET_DIR . '/TestFiles/PhpExtensionStrategy/ClassWithDs.php',
'strategy' => new PhpExtensionStrategy(['ds'], new NullLogger())
],
'ClassExtendsFQN' => [
'expectedUseNamespaces' => ['A\B'],
'inputFile' => ASSET_DIR . '/TestFiles/ClassExtendsFQN.php',
'strategy' => new ExtendsParseStrategy()
],
'ClassImplements' => [
'expectedUseNamespaces' => [
'A\InterfaceA',
'B\InterfaceB'
],
'inputFile' => ASSET_DIR . '/TestFiles/ClassImplements.php',
'strategy' => new ImplementsParseStrategy()
],
'Instanceof' => [
'expectedUseNamespaces' => [
'Foo\Bar\Baz',
],
'inputFile' => ASSET_DIR . '/TestFiles/Instanceof.php',
'strategy' => new InstanceofStrategy(),
],
];
}
/**
* @test
* @param array<string> $expectedUsedNamespaces
* @param string $inputFile
* @param ParseStrategyInterface $strategy
* @dataProvider itShouldParseUsagesDataProvider
*/
public function itShouldParseUsages(
array $expectedUsedNamespaces,
string $inputFile,
ParseStrategyInterface $strategy
): void {
$parser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);
/** @var string $contents */
$contents = file_get_contents($inputFile);
/** @var Node[] $nodes */
$nodes = $parser->parse($contents);
$nodeVisitor = new NodeVisitor([$strategy], $this->prophesize(ErrorHandlerInterface::class)->reveal());
$fileInfo = new SplFileInfo($inputFile);
$nodeVisitor->setCurrentFile($fileInfo);
$traverser = new NodeTraverser();
$traverser->addVisitor($nodeVisitor);
$traverser->traverse($nodes);
$this->assertEquals($expectedUsedNamespaces, array_keys($nodeVisitor->getUsages()));
}
/**
* @test
*/
public function itShouldRaiseExceptionHandledByErrorHandler(): void
{
$parser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);
/** @var string $inputFile */
$inputFile = ASSET_DIR . '/TestFiles/UseSingleLineNoGroup.php';
/** @var string $contents */
$contents = file_get_contents($inputFile);
/** @var Node[] $nodes */
$nodes = $parser->parse($contents);
$exception = new Exception('');
$errorHandler = $this->prophesize(ErrorHandlerInterface::class);
$errorHandler->handle($exception)->shouldBeCalled();
$exceptionParseStrategy = $this->prophesize(UseParseStrategy::class);
/** @var Node $node */
$node = Argument::any();
$exceptionParseStrategy->meetsCriteria($node)->willReturn(true);
$exceptionParseStrategy->extractNamespaces($node)->willThrow($exception);
$nodeVisitor = new NodeVisitor([$exceptionParseStrategy->reveal()], $errorHandler->reveal());
$fileInfo = new SplFileInfo($inputFile);
$nodeVisitor->setCurrentFile($fileInfo);
$traverser = new NodeTraverser();
$traverser->addVisitor($nodeVisitor);
$traverser->traverse($nodes);
}
}