1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-13 09:47:29 +01:00
psalm/tests/ReferenceConstraintTest.php

336 lines
11 KiB
PHP
Raw Normal View History

<?php
namespace Psalm\Tests;
2021-12-04 21:55:53 +01:00
use Psalm\Tests\Traits\InvalidCodeAnalysisTestTrait;
use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;
class ReferenceConstraintTest extends TestCase
{
2021-12-04 21:55:53 +01:00
use InvalidCodeAnalysisTestTrait;
use ValidCodeAnalysisTestTrait;
public function providerValidCodeParse(): iterable
{
return [
'functionParameterNoViolation' => [
'code' => '<?php
/** @return void */
function changeInt(int &$a) {
$a = 5;
2017-05-27 02:05:57 +02:00
}',
],
'dontAllowByRefVarToBeAltered' => [
'code' => '<?php
/**
* @param ?string $str
* @psalm-suppress PossiblyNullArgument
*/
2018-01-11 21:50:45 +01:00
function nullable_ref_modifier(&$str): void {
if (strlen($str) > 5) {
$str = null;
}
}',
],
'trackFunctionReturnRefs' => [
'code' => '<?php
class A {
/** @var string */
public $foo = "bar";
public function &getString() : string {
return $this->foo;
}
}
function useString(string &$s) : void {}
$a = new A();
useString($a->getString());',
],
'assignByRefToMixed' => [
'code' => '<?php
function testRef() : array {
$result = [];
foreach ([1, 2, 1] as $v) {
$x = &$result;
if (!isset($x[$v])) {
$x[$v] = 0;
}
$x[$v] ++;
}
return $result;
}',
'assertions' => [],
'ignored_issues' => [
'MixedAssignment',
'MixedArrayAccess',
'MixedReturnStatement',
'MixedInferredReturnType',
'MixedOperand',
],
],
'paramOutRefineType' => [
'code' => '<?php
/**
* @param-out string $s
*/
function addFoo(?string &$s) : void {
if ($s === null) {
$s = "hello";
}
$s .= "foo";
}
addFoo($a);
echo strlen($a);',
],
'paramOutChangeType' => [
'code' => '<?php
/**
* @param-out int $s
*/
function addFoo(?string &$s) : void {
if ($s === null) {
$s = 5;
return;
}
$s = 4;
}
addFoo($a);',
'assertions' => [
'$a' => 'int',
],
],
'paramOutReturn' => [
'code' => '<?php
/**
* @param-out bool $s
*/
function foo(?bool &$s) : void {
$s = true;
}
$b = false;
foo($b);',
'assertions' => [
'$b' => 'bool',
],
],
'dontChangeThis' => [
'code' => '<?php
interface I {}
class C implements I {
public function foo() : self {
bar($this);
return $this;
}
}
function bar(I &$i) : void {}',
],
2020-06-15 20:44:55 +02:00
'notEmptyArrayAccess' => [
'code' => '<?php
2020-06-15 20:44:55 +02:00
/**
* @param mixed $value
* @param-out int $value
*/
function addValue(&$value) : void {
$value = 5;
}
$foo = [];
2022-12-18 17:15:15 +01:00
addValue($foo["a"]);',
2020-06-15 20:44:55 +02:00
],
'paramOutArrayDefaultNullWithThrow' => [
'code' => '<?php
/**
* @param-out array{errors: int}|null $info
*/
function idnToAsci(?array &$info = null): void {
if (rand(0, 1)) {
$info = null;
}
throw new \UnexpectedValueException();
2022-12-18 17:15:15 +01:00
}',
],
'specificArrayWalkBehavior' => [
'code' => '<?php
function withArrayWalk(array &$val): void {
array_walk($val, /** @param mixed $arg */ function (&$arg): void {});
}
function withArrayWalkRecursive(array &$val): void {
array_walk_recursive($val, /** @param mixed $arg */ function (&$arg): void {});
2022-12-18 17:15:15 +01:00
}',
],
'investigateByrefArg' => [
'code' => '<?php
class A {}
function takesNullableObj(?A &$a): bool { return true; }
$a = null;
if (takesNullableObj($a) === false) {
return;
} else {}
if ($a) {}',
],
2023-10-23 09:21:04 +02:00
'PHP80-paramOutChangeTypeWithNamedArgument' => [
'code' => '<?php
/**
* @param-out int $s
*/
function addFoo(bool $five = true, ?string &$s = null) : void {
if ($five) {
$s = 5;
return;
}
$s = 4;
}
addFoo(s: $a);',
'assertions' => [
'$a' => 'int',
],
],
];
}
public function providerInvalidCodeParse(): iterable
{
return [
'functionParameterViolation' => [
'code' => '<?php
/** @return void */
function changeInt(int &$a) {
$a = "hello";
}',
2017-05-27 02:05:57 +02:00
'error_message' => 'ReferenceConstraintViolation',
],
'classMethodParameterViolation' => [
'code' => '<?php
class A {
/** @var int */
private $foo;
public function __construct(int &$foo) {
$this->foo = &$foo;
$foo = "hello";
}
}
$bar = 5;
$a = new A($bar); // $bar is constrained to an int
$bar = null; // ReferenceConstraintViolation issue emitted',
2017-05-27 02:05:57 +02:00
'error_message' => 'ReferenceConstraintViolation',
],
'classMethodParameterViolationInPostAssignment' => [
'code' => '<?php
class A {
/** @var int */
private $foo;
public function __construct(int &$foo) {
$this->foo = &$foo;
}
}
$bar = 5;
$a = new A($bar);
$bar = null;',
2017-05-27 02:05:57 +02:00
'error_message' => 'ReferenceConstraintViolation',
],
'contradictoryReferenceConstraints' => [
'code' => '<?php
class A {
/** @var int */
private $foo;
public function __construct(int &$foo) {
$this->foo = &$foo;
}
}
class B {
/** @var string */
private $bar;
public function __construct(string &$bar) {
$this->bar = &$bar;
}
}
if (rand(0, 1)) {
$v = 5;
$c = (new A($v)); // $v is constrained to an int
} else {
$v = "hello";
$c = (new B($v)); // $v is constrained to a string
}
$v = 8;',
2017-05-27 02:05:57 +02:00
'error_message' => 'ConflictingReferenceConstraint',
],
'invalidDocblockForBadAnnotation' => [
'code' => '<?php
/**
* @param-out array<a(),bool> $ar
*/
function foo(array &$ar) : void {}',
'error_message' => 'InvalidDocblock',
],
'preventTernaryPassedByReference' => [
'code' => '<?php
/**
* @param string $p
*/
function b(&$p): string {
return $p;
}
function main(bool $a, string $b, string $c): void {
b($a ? $b : $c);
}',
'error_message' => 'InvalidPassByReference',
],
'SKIPPED-referenceToTypedArrayConstrainsAssignment' => [
'code' => '<?php
class Foo
{
/** @var list<int> */
public array $arr = [];
public function __construct()
{
assert(isset($this->arr[0]));
$int = &$this->arr[0];
$int = (string) $int;
}
}
',
'error_message' => 'ReferenceConstraintViolation',
],
'SKIPPED-referenceToTypedArrayConstrainsAssignmentWithNullReferenceInitialization' => [
'code' => '<?php
class Foo
{
/** @var list<int> */
public array $arr = [];
public function __construct()
{
$int = &$this->arr[0]; // If $this->arr[0] isn\'t set, this will set it to null.
}
}
',
'error_message' => 'PossiblyInvalidPropertyAssignmentValue',
],
];
}
}