Skip to content

Commit 56edee8

Browse files
marcoscoelhomarcoscoelho
authored
feat: PHPUnit 10.4 support (#63)
Fixes #61
1 parent 33a99c1 commit 56edee8

File tree

3 files changed

+232
-3
lines changed

3 files changed

+232
-3
lines changed

‎.github/workflows/tests.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ jobs:
2222
- '7.1'
2323
- '7.0'
2424
phpunit-version:
25+
- '10.4.0'
26+
- '10.3.0'
27+
- '10.2.0'
2528
- '10.1.0'
2629
- '10.0.0'
2730
- '9.6.0'
@@ -143,6 +146,12 @@ jobs:
143146
phpunit-version: '6.0.0'
144147

145148
# PHP 8.0 Exclusions
149+
- php-version: '8.0'
150+
phpunit-version: '10.4.0'
151+
- php-version: '8.0'
152+
phpunit-version: '10.3.0'
153+
- php-version: '8.0'
154+
phpunit-version: '10.2.0'
146155
- php-version: '8.0'
147156
phpunit-version: '10.1.0'
148157
- php-version: '8.0'
@@ -189,6 +198,12 @@ jobs:
189198
phpunit-version: '6.0.0'
190199

191200
# PHP 7.4 Exclusions
201+
- php-version: '7.4'
202+
phpunit-version: '10.4.0'
203+
- php-version: '7.4'
204+
phpunit-version: '10.3.0'
205+
- php-version: '7.4'
206+
phpunit-version: '10.2.0'
192207
- php-version: '7.4'
193208
phpunit-version: '10.1.0'
194209
- php-version: '7.4'
@@ -221,12 +236,24 @@ jobs:
221236
phpunit-version: '6.0.0'
222237

223238
# PHP 7.3 Exclusions
239+
- php-version: '7.3'
240+
phpunit-version: '10.4.0'
241+
- php-version: '7.3'
242+
phpunit-version: '10.3.0'
243+
- php-version: '7.3'
244+
phpunit-version: '10.2.0'
224245
- php-version: '7.3'
225246
phpunit-version: '10.1.0'
226247
- php-version: '7.3'
227248
phpunit-version: '10.0.0'
228249

229250
# PHP 7.2 Exclusions
251+
- php-version: '7.2'
252+
phpunit-version: '10.4.0'
253+
- php-version: '7.2'
254+
phpunit-version: '10.3.0'
255+
- php-version: '7.2'
256+
phpunit-version: '10.2.0'
230257
- php-version: '7.2'
231258
phpunit-version: '10.1.0'
232259
- php-version: '7.2'
@@ -247,6 +274,12 @@ jobs:
247274
phpunit-version: '9.0.0'
248275

249276
# PHP 7.1 Exclusions
277+
- php-version: '7.1'
278+
phpunit-version: '10.4.0'
279+
- php-version: '7.1'
280+
phpunit-version: '10.3.0'
281+
- php-version: '7.1'
282+
phpunit-version: '10.2.0'
250283
- php-version: '7.1'
251284
phpunit-version: '10.1.0'
252285
- php-version: '7.1'
@@ -279,6 +312,12 @@ jobs:
279312
phpunit-version: '8.0.0'
280313

281314
# PHP 7.0 Exclusions
315+
- php-version: '7.0'
316+
phpunit-version: '10.4.0'
317+
- php-version: '7.0'
318+
phpunit-version: '10.3.0'
319+
- php-version: '7.0'
320+
phpunit-version: '10.2.0'
282321
- php-version: '7.0'
283322
phpunit-version: '10.1.0'
284323
- php-version: '7.0'

‎classes/DefaultArgumentRemoverReturnTypes100.php‎

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
use phpmock\generator\MockFunctionGenerator;
66
use PHPUnit\Framework\MockObject\Invocation;
77
use PHPUnit\Framework\MockObject\Rule\InvocationOrder;
8+
use ReflectionClass;
89

910
/**
1011
* Removes default arguments from the invocation.
@@ -37,7 +38,7 @@ public function matches(Invocation $invocation) : bool
3738
$invocation,
3839
$iClass ? Invocation::class : Invocation\StaticInvocation::class
3940
);
40-
} else {
41+
} elseif (!$this->shouldRemoveDefaultArgumentsWithReflection($invocation)) {
4142
MockFunctionGenerator::removeDefaultArguments($invocation->parameters);
4243
}
4344

@@ -72,10 +73,62 @@ public function toString() : string
7273
*/
7374
private function removeDefaultArguments(Invocation $invocation, string $class)
7475
{
76+
if ($this->shouldRemoveDefaultArgumentsWithReflection($invocation)) {
77+
return;
78+
}
79+
7580
$remover = function () {
7681
MockFunctionGenerator::removeDefaultArguments($this->parameters);
7782
};
7883

7984
$remover->bindTo($invocation, $class)();
8085
}
86+
87+
/**
88+
* Alternative to remove default arguments from StaticInvocation or its children (hack)
89+
*
90+
* @SuppressWarnings(PHPMD.StaticAccess)
91+
*/
92+
public static function removeDefaultArgumentsWithReflection(Invocation $invocation): Invocation
93+
{
94+
if (!(new self())->shouldRemoveDefaultArgumentsWithReflection($invocation)) {
95+
return $invocation;
96+
}
97+
98+
$reflection = new ReflectionClass($invocation);
99+
100+
$reflectionReturnType = $reflection->getProperty('returnType');
101+
$reflectionReturnType->setAccessible(true);
102+
103+
$reflectionIsOptional = $reflection->getProperty('isReturnTypeNullable');
104+
$reflectionIsOptional->setAccessible(true);
105+
106+
$reflectionIsProxied = $reflection->getProperty('proxiedCall');
107+
$reflectionIsProxied->setAccessible(true);
108+
109+
$returnType = $reflectionReturnType->getValue($invocation);
110+
$proxiedCall = $reflectionIsProxied->getValue($invocation);
111+
112+
if ($reflectionIsOptional->getValue($invocation)) {
113+
$returnType = '?' . $returnType;
114+
}
115+
116+
$parameters = $invocation->parameters();
117+
MockFunctionGenerator::removeDefaultArguments($parameters);
118+
119+
return new Invocation(
120+
$invocation->className(),
121+
$invocation->methodName(),
122+
$parameters,
123+
$returnType,
124+
$invocation->object(),
125+
false,
126+
$proxiedCall
127+
);
128+
}
129+
130+
protected function shouldRemoveDefaultArgumentsWithReflection(Invocation $invocation)
131+
{
132+
return method_exists($invocation, 'parameters');
133+
}
81134
}

‎classes/PHPMock.php‎

Lines changed: 139 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
namespace phpmock\phpunit;
44

5+
use DirectoryIterator;
56
use phpmock\integration\MockDelegateFunctionBuilder;
67
use phpmock\MockBuilder;
78
use phpmock\Deactivatable;
89
use PHPUnit\Event\Facade;
910
use PHPUnit\Framework\MockObject\MockObject;
11+
use ReflectionClass;
1012
use ReflectionProperty;
13+
use SebastianBergmann\Template\Template;
1114

1215
/**
1316
* Adds building a function mock functionality into \PHPUnit\Framework\TestCase.
@@ -38,6 +41,13 @@
3841
*/
3942
trait PHPMock
4043
{
44+
public static $templatesPath = '/tmp';
45+
46+
private $phpunitVersionClass = '\\PHPUnit\\Runner\\Version';
47+
private $openInvocation = 'new \\PHPUnit\\Framework\\MockObject\\Invocation(';
48+
private $openWrapper = '\\phpmock\\phpunit\\DefaultArgumentRemover::removeDefaultArgumentsWithReflection(';
49+
private $closeFunc = ')';
50+
4151
/**
4252
* Returns the enabled function mock.
4353
*
@@ -50,6 +60,8 @@ trait PHPMock
5060
*/
5161
public function getFunctionMock($namespace, $name)
5262
{
63+
$this->prepareCustomTemplates();
64+
5365
$delegateBuilder = new MockDelegateFunctionBuilder();
5466
$delegateBuilder->build($name);
5567

@@ -70,8 +82,7 @@ public function getFunctionMock($namespace, $name)
7082

7183
$this->registerForTearDown($functionMock);
7284

73-
$proxy = new MockObjectProxy($mock);
74-
return $proxy;
85+
return new MockObjectProxy($mock);
7586
}
7687

7788
private function addMatcher($mock, $name)
@@ -145,4 +156,130 @@ public static function defineFunctionMock($namespace, $name)
145156
->build()
146157
->define();
147158
}
159+
160+
/**
161+
* Adds a wrapper method to the Invocable object instance that makes it
162+
* possible to remove optional parameters when it is declared read-only.
163+
*
164+
* @return void
165+
*
166+
* @SuppressWarnings(PHPMD.StaticAccess)
167+
* @SuppressWarnings(PHPMD.IfStatementAssignment)
168+
*/
169+
private function prepareCustomTemplates()
170+
{
171+
if (!($this->shouldPrepareCustomTemplates() &&
172+
is_dir(static::$templatesPath) &&
173+
($phpunitTemplatesDir = $this->getPhpunitTemplatesDir())
174+
)) {
175+
return;
176+
}
177+
178+
$templatesDir = realpath(static::$templatesPath);
179+
$directoryIterator = new DirectoryIterator($phpunitTemplatesDir);
180+
181+
$templates = [];
182+
183+
$prefix = 'phpmock-phpunit-' . $this->getPhpUnitVersion() . '-';
184+
185+
foreach ($directoryIterator as $fileinfo) {
186+
if ($fileinfo->getExtension() !== 'tpl') {
187+
continue;
188+
}
189+
190+
$filename = $fileinfo->getFilename();
191+
$customTemplateFile = $templatesDir . DIRECTORY_SEPARATOR . $prefix . $filename;
192+
$templateFile = $phpunitTemplatesDir . DIRECTORY_SEPARATOR . $filename;
193+
194+
$this->createCustomTemplateFile($templateFile, $customTemplateFile);
195+
196+
if (file_exists($customTemplateFile)) {
197+
$templates[$templateFile] = new Template($customTemplateFile);
198+
}
199+
}
200+
201+
$mockMethodClasses = [
202+
'PHPUnit\\Framework\\MockObject\\Generator\\MockMethod',
203+
'PHPUnit\\Framework\\MockObject\\MockMethod',
204+
];
205+
206+
foreach ($mockMethodClasses as $mockMethodClass) {
207+
if (class_exists($mockMethodClass)) {
208+
$reflection = new ReflectionClass($mockMethodClass);
209+
210+
$reflectionTemplates = $reflection->getProperty('templates');
211+
$reflectionTemplates->setAccessible(true);
212+
213+
$reflectionTemplates->setValue($templates);
214+
215+
break;
216+
}
217+
}
218+
}
219+
220+
private function shouldPrepareCustomTemplates()
221+
{
222+
return class_exists($this->phpunitVersionClass)
223+
&& version_compare($this->getPhpUnitVersion(), '10.0.0') >= 0;
224+
}
225+
226+
private function getPhpUnitVersion()
227+
{
228+
return call_user_func([$this->phpunitVersionClass, 'id']);
229+
}
230+
231+
/**
232+
* Detects the PHPUnit templates dir
233+
*
234+
* @return string|null
235+
*/
236+
private function getPhpunitTemplatesDir()
237+
{
238+
$phpunitLocations = [
239+
__DIR__ . '/../../',
240+
__DIR__ . '/../vendor/',
241+
];
242+
243+
$phpunitRelativePath = '/phpunit/phpunit/src/Framework/MockObject/Generator';
244+
245+
foreach ($phpunitLocations as $prefix) {
246+
$possibleDirs = [
247+
$prefix . $phpunitRelativePath . '/templates',
248+
$prefix . $phpunitRelativePath,
249+
];
250+
251+
foreach ($possibleDirs as $dir) {
252+
if (is_dir($dir)) {
253+
return realpath($dir);
254+
}
255+
}
256+
}
257+
}
258+
259+
/**
260+
* Clones original template with the wrapper
261+
*
262+
* @param string $templateFile Template filename
263+
* @param string $customTemplateFile Custom template filename
264+
*
265+
* @return void
266+
*
267+
* @SuppressWarnings(PHPMD.IfStatementAssignment)
268+
*/
269+
private function createCustomTemplateFile(string $templateFile, string $customTemplateFile)
270+
{
271+
$template = file_get_contents($templateFile);
272+
273+
if (($start = strpos($template, $this->openInvocation)) !== false &&
274+
($end = strpos($template, $this->closeFunc, $start)) !== false
275+
) {
276+
$template = substr_replace($template, $this->closeFunc, $end, 0);
277+
$template = substr_replace($template, $this->openWrapper, $start, 0);
278+
279+
if ($file = fopen($customTemplateFile, 'w+')) {
280+
fputs($file, $template);
281+
fclose($file);
282+
}
283+
}
284+
}
148285
}

0 commit comments

Comments
 (0)