Skip to content

Commit dbe8b74

Browse files
ruudkruudk
authored
TypeInferenceTestCase: allow asserting array offset certainty
1 parent b38c852 commit dbe8b74

9 files changed

+100
-22
lines changed

‎src/Rules/Debug/FileAssertRule.php

+9-11
Original file line numberDiff line numberDiff line change
@@ -171,15 +171,14 @@ private function processAssertVariableCertainty(array $args, Scope $scope): arra
171171
// @phpstan-ignore staticMethod.dynamicName
172172
$expectedCertaintyValue = TrinaryLogic::{$certainty->name->toString()}();
173173
$variable = $args[1]->value;
174-
if (!$variable instanceof Node\Expr\Variable) {
175-
return [
176-
RuleErrorBuilder::message('Invalid assertVariableCertainty call.')
177-
->nonIgnorable()
178-
->identifier('phpstan.unknownExpectation')
179-
->build(),
180-
];
181-
}
182-
if (!is_string($variable->name)) {
174+
if ($variable instanceof Node\Expr\Variable && is_string($variable->name)) {
175+
$actualCertaintyValue = $scope->hasVariableType($variable->name);
176+
$variableDescription = sprintf('variable $%s', $variable->name);
177+
} elseif ($variable instanceof Node\Expr\ArrayDimFetch && $variable->dim !== null) {
178+
$offset = $scope->getType($variable->dim);
179+
$actualCertaintyValue = $scope->getType($variable->var)->hasOffsetValueType($offset);
180+
$variableDescription = sprintf('offset %s', $offset->describe(VerbosityLevel::precise()));
181+
} else {
183182
return [
184183
RuleErrorBuilder::message('Invalid assertVariableCertainty call.')
185184
->nonIgnorable()
@@ -188,13 +187,12 @@ private function processAssertVariableCertainty(array $args, Scope $scope): arra
188187
];
189188
}
190189

191-
$actualCertaintyValue = $scope->hasVariableType($variable->name);
192190
if ($expectedCertaintyValue->equals($actualCertaintyValue)) {
193191
return [];
194192
}
195193

196194
return [
197-
RuleErrorBuilder::message(sprintf('Expected variable certainty %s, actual: %s', $expectedCertaintyValue->describe(), $actualCertaintyValue->describe()))
195+
RuleErrorBuilder::message(sprintf('Expected %s certainty %s, actual: %s', $variableDescription, $expectedCertaintyValue->describe(), $actualCertaintyValue->describe()))
198196
->nonIgnorable()
199197
->identifier('phpstan.variable')
200198
->build(),

‎src/Testing/TypeInferenceTestCase.php

+10-7
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public function assertFileAsserts(
135135
$variableName = $args[2];
136136
$this->assertTrue(
137137
$expectedCertainty->equals($actualCertainty),
138-
sprintf('Expected %s, actual certainty of variable $%s is %s in %s on line %d.', $expectedCertainty->describe(), $variableName, $actualCertainty->describe(), $file, $args[3]),
138+
sprintf('Expected %s, actual certainty of %s is %s in %s on line %d.', $expectedCertainty->describe(), $variableName, $actualCertainty->describe(), $file, $args[3]),
139139
);
140140
}
141141
}
@@ -216,15 +216,18 @@ public static function gatherAssertTypes(string $file): array
216216
// @phpstan-ignore staticMethod.dynamicName
217217
$expectedertaintyValue = TrinaryLogic::{$certainty->name->toString()}();
218218
$variable = $node->getArgs()[1]->value;
219-
if (!$variable instanceof Node\Expr\Variable) {
220-
self::fail(sprintf('ERROR: Invalid assertVariableCertainty call.'));
221-
}
222-
if (!is_string($variable->name)) {
219+
if ($variable instanceof Node\Expr\Variable && is_string($variable->name)) {
220+
$actualCertaintyValue = $scope->hasVariableType($variable->name);
221+
$variableDescription = sprintf('variable $%s', $variable->name);
222+
} elseif ($variable instanceof Node\Expr\ArrayDimFetch && $variable->dim !== null) {
223+
$offset = $scope->getType($variable->dim);
224+
$actualCertaintyValue = $scope->getType($variable->var)->hasOffsetValueType($offset);
225+
$variableDescription = sprintf('offset %s', $offset->describe(VerbosityLevel::precise()));
226+
} else {
223227
self::fail(sprintf('ERROR: Invalid assertVariableCertainty call.'));
224228
}
225229

226-
$actualCertaintyValue = $scope->hasVariableType($variable->name);
227-
$assert = ['variableCertainty', $file, $expectedertaintyValue, $actualCertaintyValue, $variable->name, $node->getStartLine()];
230+
$assert = ['variableCertainty', $file, $expectedertaintyValue, $actualCertaintyValue, $variableDescription, $node->getStartLine()];
228231
} else {
229232
$correctFunction = null;
230233

‎tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,7 @@ private function assertVariables(
906906
$this->assertTrue(
907907
$expectedCertainty->equals($certainty),
908908
sprintf(
909-
'Certainty of variable $%s is %s, expected %s',
909+
'Certainty of %s is %s, expected %s',
910910
$variableName,
911911
$certainty->describe(),
912912
$expectedCertainty->describe(),

‎tests/PHPStan/Analyser/NodeScopeResolverTest.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ public function testFile(string $file): void
255255
$variableName = $args[2];
256256

257257
if ($expectedCertainty->equals($actualCertainty) !== true) {
258-
$failures[] = sprintf("Certainty of variable \$%s on line %d:\nExpected: %s\nActual: %s\n", $variableName, $args[3], $expectedCertainty->describe(), $actualCertainty->describe());
258+
$failures[] = sprintf("Certainty of %s on line %d:\nExpected: %s\nActual: %s\n", $variableName, $args[3], $expectedCertainty->describe(), $actualCertainty->describe());
259259
}
260260
}
261261
}

‎tests/PHPStan/Analyser/nsrt/assert-variable-certainty-on-array.php

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace AssertVariableCertaintyOnArray;
6+
7+
use PHPStan\TrinaryLogic;
8+
use function PHPStan\Testing\assertVariableCertainty;
9+
10+
class Foo
11+
{
12+
/**
13+
* @param array{firstName: string, lastName?: string, sub: array{other: string}} $context
14+
*/
15+
public function __invoke(array $context) : void
16+
{
17+
assertVariableCertainty(TrinaryLogic::createYes(), $context['firstName']);
18+
assertVariableCertainty(TrinaryLogic::createYes(), $context['sub']);
19+
assertVariableCertainty(TrinaryLogic::createYes(), $context['sub']['other']);
20+
21+
assertVariableCertainty(TrinaryLogic::createMaybe(), $context['lastName']);
22+
assertVariableCertainty(TrinaryLogic::createMaybe(), $context['nonexistent']['somethingElse']);
23+
24+
assertVariableCertainty(TrinaryLogic::createNo(), $context['sub']['nonexistent']);
25+
assertVariableCertainty(TrinaryLogic::createNo(), $context['email']);
26+
}
27+
28+
}

‎tests/PHPStan/Rules/Debug/FileAssertRuleTest.php

+6-2
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,17 @@ public function testRule(): void
3232
37,
3333
],
3434
[
35-
'Expected variable certainty Yes, actual: No',
35+
'Expected variable $b certainty Yes, actual: No',
3636
45,
3737
],
3838
[
39-
'Expected variable certainty Maybe, actual: No',
39+
'Expected variable $b certainty Maybe, actual: No',
4040
46,
4141
],
42+
[
43+
"Expected offset 'firstName' certainty No, actual: Yes",
44+
65,
45+
],
4246
]);
4347
}
4448

‎tests/PHPStan/Rules/Debug/data/file-asserts.php

+19
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,23 @@ public function doBaz($a): void
4646
assertVariableCertainty(TrinaryLogic::createMaybe(), $b);
4747
}
4848

49+
/**
50+
* @param array{firstName: string, lastName?: string, sub: array{other: string}} $context
51+
*/
52+
public function arrayOffset(array $context) : void
53+
{
54+
assertVariableCertainty(TrinaryLogic::createYes(), $context['firstName']);
55+
assertVariableCertainty(TrinaryLogic::createYes(), $context['sub']);
56+
assertVariableCertainty(TrinaryLogic::createYes(), $context['sub']['other']);
57+
58+
assertVariableCertainty(TrinaryLogic::createMaybe(), $context['lastName']);
59+
assertVariableCertainty(TrinaryLogic::createMaybe(), $context['nonexistent']['somethingElse']);
60+
61+
assertVariableCertainty(TrinaryLogic::createNo(), $context['sub']['nonexistent']);
62+
assertVariableCertainty(TrinaryLogic::createNo(), $context['email']);
63+
64+
// Deliberate error:
65+
assertVariableCertainty(TrinaryLogic::createNo(), $context['firstName']);
66+
}
67+
4968
}

‎tests/PHPStan/Testing/TypeInferenceTestCaseTest.php

+11
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use PHPStan\File\FileHelper;
66
use PHPUnit\Framework\AssertionFailedError;
7+
use function array_values;
78
use function sprintf;
89

910
final class TypeInferenceTestCaseTest extends TypeInferenceTestCase
@@ -90,4 +91,14 @@ public function testFileAssertionFailedErrors(string $filePath, string $errorMes
9091
$this->gatherAssertTypes($filePath);
9192
}
9293

94+
public function testVariableOrOffsetDescription(): void
95+
{
96+
$filePath = __DIR__ . '/data/assert-certainty-variable-or-offset.php';
97+
98+
[$variableAssert, $offsetAssert] = array_values($this->gatherAssertTypes($filePath));
99+
100+
$this->assertSame('variable $context', $variableAssert[4]);
101+
$this->assertSame("offset 'email'", $offsetAssert[4]);
102+
}
103+
93104
}

‎tests/PHPStan/Testing/data/assert-certainty-variable-or-offset.php

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
namespace AssertCertaintyVariableOrOffset;
4+
5+
use PHPStan\TrinaryLogic;
6+
use function PHPStan\Testing\assertVariableCertainty;
7+
8+
/**
9+
* @param array{} $context
10+
*/
11+
function someMethod(array $context) : void
12+
{
13+
assertVariableCertainty(TrinaryLogic::createNo(), $context);
14+
assertVariableCertainty(TrinaryLogic::createYes(), $context['email']);
15+
}

0 commit comments

Comments
 (0)