Skip to content

Commit f7553d6

Browse files
VincentLangletVincentLanglet
authored
Add support for createMockForIntersectionOfInterfaces
1 parent 45bc1ad commit f7553d6

6 files changed

Lines changed: 212 additions & 0 deletions

File tree

‎extension.neon‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ services:
4747
class: PHPStan\Type\PHPUnit\MockBuilderDynamicReturnTypeExtension
4848
tags:
4949
- phpstan.broker.dynamicMethodReturnTypeExtension
50+
-
51+
class: PHPStan\Type\PHPUnit\MockForIntersectionDynamicReturnTypeExtension
52+
tags:
53+
- phpstan.broker.dynamicMethodReturnTypeExtension
54+
- phpstan.broker.dynamicStaticMethodReturnTypeExtension
5055
-
5156
class: PHPStan\Rules\PHPUnit\CoversHelper
5257
-

‎src/Type/PHPUnit/MockForIntersectionDynamicReturnTypeExtension.php‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\PHPUnit;
4+
5+
use PhpParser\Node\Arg;
6+
use PhpParser\Node\Expr\MethodCall;
7+
use PhpParser\Node\Expr\StaticCall;
8+
use PHPStan\Analyser\Scope;
9+
use PHPStan\Reflection\MethodReflection;
10+
use PHPStan\Type\DynamicMethodReturnTypeExtension;
11+
use PHPStan\Type\DynamicStaticMethodReturnTypeExtension;
12+
use PHPStan\Type\ObjectType;
13+
use PHPStan\Type\Type;
14+
use PHPStan\Type\TypeCombinator;
15+
use PHPUnit\Framework\MockObject\MockObject;
16+
use PHPUnit\Framework\MockObject\Stub;
17+
use PHPUnit\Framework\TestCase;
18+
use function count;
19+
20+
class MockForIntersectionDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension, DynamicStaticMethodReturnTypeExtension
21+
{
22+
23+
public function getClass(): string
24+
{
25+
return TestCase::class;
26+
}
27+
28+
public function isMethodSupported(MethodReflection $methodReflection): bool
29+
{
30+
return $methodReflection->getName() === 'createMockForIntersectionOfInterfaces';
31+
}
32+
33+
public function isStaticMethodSupported(MethodReflection $methodReflection): bool
34+
{
35+
return $methodReflection->getName() === 'createStubForIntersectionOfInterfaces';
36+
}
37+
38+
public function getTypeFromStaticMethodCall(MethodReflection $methodReflection, StaticCall $methodCall, Scope $scope): ?Type
39+
{
40+
return $this->getTypeFromCall($methodReflection, $methodCall->getArgs(), $scope);
41+
}
42+
43+
public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type
44+
{
45+
return $this->getTypeFromCall($methodReflection, $methodCall->getArgs(), $scope);
46+
}
47+
48+
/**
49+
* @param array<Arg> $args
50+
*/
51+
private function getTypeFromCall(MethodReflection $methodReflection, array $args, Scope $scope): ?Type
52+
{
53+
if (!isset($args[0])) {
54+
return null;
55+
}
56+
57+
$interfaces = $scope->getType($args[0]->value);
58+
$constantArrays = $interfaces->getConstantArrays();
59+
if (count($constantArrays) !== 1) {
60+
return null;
61+
}
62+
63+
$constantArray = $constantArrays[0];
64+
if (count($constantArray->getOptionalKeys()) > 0) {
65+
return null;
66+
}
67+
68+
$result = [];
69+
if ($methodReflection->getName() === 'createMockForIntersectionOfInterfaces') {
70+
$result[] = new ObjectType(MockObject::class);
71+
} else {
72+
$result[] = new ObjectType(Stub::class);
73+
}
74+
75+
foreach ($constantArray->getValueTypes() as $valueType) {
76+
if (!$valueType->isClassString()->yes()) {
77+
return null;
78+
}
79+
80+
$values = $valueType->getConstantScalarValues();
81+
if (count($values) !== 1) {
82+
return null;
83+
}
84+
85+
$result[] = new ObjectType((string) $values[0]);
86+
}
87+
88+
return TypeCombinator::intersect(...$result);
89+
}
90+
91+
}

‎tests/Rules/PHPUnit/MockMethodCallRuleTest.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
use PHPStan\Rules\Rule;
66
use PHPStan\Testing\RuleTestCase;
7+
use PHPUnit\Framework\TestCase;
8+
use function method_exists;
79
use const PHP_VERSION_ID;
810

911
/**
@@ -34,6 +36,17 @@ public function testRule(): void
3436
],
3537
];
3638

39+
if (method_exists(TestCase::class, 'createMockForIntersectionOfInterfaces')) { // @phpstan-ignore function.alreadyNarrowedType
40+
$expectedErrors[] = [
41+
'Trying to mock an undefined method bazMethod() on class MockMethodCall\FooInterface&MockMethodCall\BarInterface.',
42+
49,
43+
];
44+
$expectedErrors[] = [
45+
'Trying to mock an undefined method bazMethod() on class MockMethodCall\FooInterface&MockMethodCall\BarInterface.',
46+
57,
47+
];
48+
}
49+
3750
$this->analyse([__DIR__ . '/data/mock-method-call.php'], $expectedErrors);
3851
}
3952

‎tests/Rules/PHPUnit/data/mock-method-call.php‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,22 @@ public function testMockObject(\PHPUnit\Framework\MockObject\MockObject $mock)
4141
$mock->method('doFoo');
4242
}
4343

44+
public function testMockForIntersection()
45+
{
46+
$mock = $this->createMockForIntersectionOfInterfaces([FooInterface::class, BarInterface::class]);
47+
$mock->method('fooMethod');
48+
$mock->method('barMethod');
49+
$mock->method('bazMethod');
50+
}
51+
52+
public function testStubForIntersection()
53+
{
54+
$stub = static::createStubForIntersectionOfInterfaces([FooInterface::class, BarInterface::class]);
55+
$stub->method('fooMethod');
56+
$stub->method('barMethod');
57+
$stub->method('bazMethod');
58+
}
59+
4460
}
4561

4662
class Bar {
@@ -71,3 +87,11 @@ public function testMockFinalClass()
7187
}
7288

7389
}
90+
91+
interface FooInterface {
92+
public function fooMethod(): int;
93+
}
94+
95+
interface BarInterface {
96+
public function barMethod(): string;
97+
}

‎tests/Type/PHPUnit/MockForIntersectionDynamicReturnTypeExtensionTest.php‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\PHPUnit;
4+
5+
use PHPStan\Testing\TypeInferenceTestCase;
6+
use PHPUnit\Framework\Attributes\DataProvider;
7+
use PHPUnit\Framework\TestCase;
8+
use function method_exists;
9+
10+
class MockForIntersectionDynamicReturnTypeExtensionTest extends TypeInferenceTestCase
11+
{
12+
13+
/** @return mixed[] */
14+
public static function dataFileAsserts(): iterable
15+
{
16+
if (method_exists(TestCase::class, 'createMockForIntersectionOfInterfaces')) { // @phpstan-ignore function.alreadyNarrowedType
17+
yield from self::gatherAssertTypes(__DIR__ . '/data/mock-for-intersection.php');
18+
}
19+
20+
return [];
21+
}
22+
23+
/**
24+
* @dataProvider dataFileAsserts
25+
* @param mixed ...$args
26+
*/
27+
#[DataProvider('dataFileAsserts')]
28+
public function testFileAsserts(
29+
string $assertType,
30+
string $file,
31+
...$args
32+
): void
33+
{
34+
$this->assertFileAsserts($assertType, $file, ...$args);
35+
}
36+
37+
public static function getAdditionalConfigFiles(): array
38+
{
39+
return [__DIR__ . '/../../../extension.neon'];
40+
}
41+
42+
}

‎tests/Type/PHPUnit/data/mock-for-intersection.php‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?php
2+
3+
namespace MockForIntersection;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
use function PHPStan\Testing\assertType;
8+
9+
class Foo extends TestCase
10+
{
11+
12+
public function testFoo(bool $bool): void
13+
{
14+
assertType(
15+
'MockForIntersection\BarInterface&MockForIntersection\FooInterface&PHPUnit\Framework\MockObject\MockObject',
16+
$this->createMockForIntersectionOfInterfaces([FooInterface::class, BarInterface::class]),
17+
);
18+
assertType(
19+
'MockForIntersection\BarInterface&MockForIntersection\FooInterface&PHPUnit\Framework\MockObject\Stub',
20+
self::createStubForIntersectionOfInterfaces([FooInterface::class, BarInterface::class]),
21+
);
22+
23+
24+
assertType(
25+
'PHPUnit\Framework\MockObject\MockObject',
26+
$this->createMockForIntersectionOfInterfaces($bool ? [FooInterface::class, BarInterface::class] : [FooInterface::class]),
27+
);
28+
assertType(
29+
'PHPUnit\Framework\MockObject\MockObject',
30+
$this->createMockForIntersectionOfInterfaces($bool ? [FooInterface::class] : [BarInterface::class]),
31+
);
32+
}
33+
34+
}
35+
36+
interface FooInterface {}
37+
interface BarInterface {}

0 commit comments

Comments
 (0)