forked from phpstan/phpstan-src
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathPHPStanTestCase.php
More file actions
196 lines (167 loc) · 5.6 KB
/
Copy pathPHPStanTestCase.php
File metadata and controls
196 lines (167 loc) · 5.6 KB
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
<?php declare(strict_types = 1);
namespace PHPStan\Testing;
use PHPStan\Analyser\DirectScopeFactory;
use PHPStan\Analyser\MutatingScope;
use PHPStan\Analyser\NodeScopeResolver;
use PHPStan\Analyser\ScopeFactory;
use PHPStan\Analyser\TypeSpecifier;
use PHPStan\BetterReflection\Reflector\ClassReflector;
use PHPStan\BetterReflection\Reflector\ConstantReflector;
use PHPStan\BetterReflection\Reflector\FunctionReflector;
use PHPStan\Broker\Broker;
use PHPStan\DependencyInjection\Container;
use PHPStan\DependencyInjection\ContainerFactory;
use PHPStan\DependencyInjection\Reflection\ClassReflectionExtensionRegistryProvider;
use PHPStan\DependencyInjection\Type\DynamicReturnTypeExtensionRegistryProvider;
use PHPStan\DependencyInjection\Type\OperatorTypeSpecifyingExtensionRegistryProvider;
use PHPStan\File\FileHelper;
use PHPStan\Parser\CachedParser;
use PHPStan\PhpDoc\TypeNodeResolver;
use PHPStan\PhpDoc\TypeStringResolver;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Rules\Properties\PropertyReflectionFinder;
use PHPStan\Type\TypeAliasResolver;
/** @api */
abstract class PHPStanTestCase extends \PHPUnit\Framework\TestCase
{
/** @var bool */
public static $useStaticReflectionProvider = false;
/** @var array<string, Container> */
private static array $containers = [];
/** @api */
public static function getContainer(): Container
{
$additionalConfigFiles = static::getAdditionalConfigFiles();
$additionalConfigFiles[] = __DIR__ . '/TestCase.neon';
if (self::$useStaticReflectionProvider) {
$additionalConfigFiles[] = __DIR__ . '/TestCase-staticReflection.neon';
}
$cacheKey = sha1(implode("\n", $additionalConfigFiles));
if (!isset(self::$containers[$cacheKey])) {
$tmpDir = sys_get_temp_dir() . '/phpstan-tests';
if (!@mkdir($tmpDir, 0777) && !is_dir($tmpDir)) {
self::fail(sprintf('Cannot create temp directory %s', $tmpDir));
}
$rootDir = __DIR__ . '/../..';
$fileHelper = new FileHelper($rootDir);
$rootDir = $fileHelper->normalizePath($rootDir, '/');
$containerFactory = new ContainerFactory($rootDir);
$container = $containerFactory->create($tmpDir, array_merge([
$containerFactory->getConfigDirectory() . '/config.level8.neon',
], $additionalConfigFiles), []);
self::$containers[$cacheKey] = $container;
foreach ($container->getParameter('bootstrapFiles') as $bootstrapFile) {
(static function (string $file) use ($container): void {
require_once $file;
})($bootstrapFile);
}
}
return self::$containers[$cacheKey];
}
/**
* @return string[]
*/
public static function getAdditionalConfigFiles(): array
{
return [];
}
public function getParser(): \PHPStan\Parser\Parser
{
/** @var \PHPStan\Parser\Parser $parser */
$parser = self::getContainer()->getByType(CachedParser::class);
return $parser;
}
/**
* @api
* @deprecated Use createReflectionProvider() instead
*/
public function createBroker(): Broker
{
return self::getContainer()->getByType(Broker::class);
}
/** @api */
public function createReflectionProvider(): ReflectionProvider
{
return self::getContainer()->getByType(ReflectionProvider::class);
}
/**
* @return array{ClassReflector, FunctionReflector, ConstantReflector}
*/
public static function getReflectors(): array
{
return [
self::getContainer()->getService('betterReflectionClassReflector'),
self::getContainer()->getService('betterReflectionFunctionReflector'),
self::getContainer()->getService('betterReflectionConstantReflector'),
];
}
public function getClassReflectionExtensionRegistryProvider(): ClassReflectionExtensionRegistryProvider
{
return self::getContainer()->getByType(ClassReflectionExtensionRegistryProvider::class);
}
public function createScopeFactory(ReflectionProvider $reflectionProvider, TypeSpecifier $typeSpecifier): ScopeFactory
{
$container = self::getContainer();
return new DirectScopeFactory(
MutatingScope::class,
$reflectionProvider,
$container->getByType(DynamicReturnTypeExtensionRegistryProvider::class),
$container->getByType(OperatorTypeSpecifyingExtensionRegistryProvider::class),
new \PhpParser\PrettyPrinter\Standard(),
$typeSpecifier,
new PropertyReflectionFinder(),
$this->getParser(),
self::getContainer()->getByType(NodeScopeResolver::class),
$this->shouldTreatPhpDocTypesAsCertain(),
$container
);
}
/**
* @param array<string, string> $globalTypeAliases
*/
public function createTypeAliasResolver(array $globalTypeAliases, ReflectionProvider $reflectionProvider): TypeAliasResolver
{
$container = self::getContainer();
return new TypeAliasResolver(
$globalTypeAliases,
$container->getByType(TypeStringResolver::class),
$container->getByType(TypeNodeResolver::class),
$reflectionProvider
);
}
protected function shouldTreatPhpDocTypesAsCertain(): bool
{
return true;
}
public function getFileHelper(): FileHelper
{
return self::getContainer()->getByType(FileHelper::class);
}
/**
* Provides a DIRECTORY_SEPARATOR agnostic assertion helper, to compare file paths.
*
* @param string $expected
* @param string $actual
* @param string $message
*/
protected function assertSamePaths(string $expected, string $actual, string $message = ''): void
{
$expected = $this->getFileHelper()->normalizePath($expected);
$actual = $this->getFileHelper()->normalizePath($actual);
$this->assertSame($expected, $actual, $message);
}
protected function skipIfNotOnWindows(): void
{
if (DIRECTORY_SEPARATOR === '\\') {
return;
}
self::markTestSkipped();
}
protected function skipIfNotOnUnix(): void
{
if (DIRECTORY_SEPARATOR === '/') {
return;
}
self::markTestSkipped();
}
}