1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 16:59:45 +01:00
psalm/tests/ReferenceConstraintTest.php

230 lines
7.2 KiB
PHP
Raw Normal View History

<?php
namespace Psalm\Tests;
class ReferenceConstraintTest extends TestCase
{
2018-11-06 03:57:36 +01:00
use Traits\InvalidCodeAnalysisTestTrait;
use Traits\ValidCodeAnalysisTestTrait;
/**
2019-03-01 21:55:20 +01:00
* @return iterable<string,array{string,assertions?:array<string,string>,error_levels?:string[]}>
*/
2018-11-06 03:57:36 +01:00
public function providerValidCodeParse()
{
return [
'functionParameterNoViolation' => [
'<?php
/** @return void */
function changeInt(int &$a) {
$a = 5;
2017-05-27 02:05:57 +02:00
}',
],
'dontAllowByRefVarToBeAltered' => [
'<?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' => [
'<?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());',
],
'makeByRefUseMixed' => [
'<?php
function s(?string $p): void {}
$var = 1;
$callback = function() use(&$var): void {
s($var);
};
$var = null;
$callback();',
'assertions' => [],
'error_levels' => ['MixedArgument'],
],
'assignByRefToMixed' => [
'<?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' => [],
'error_levels' => [
'MixedAssignment',
'MixedArrayAccess',
'MixedReturnStatement',
'MixedInferredReturnType',
'MixedOperand',
],
],
'paramOutRefineType' => [
'<?php
/**
* @param-out string $s
*/
function addFoo(?string &$s) : void {
if ($s === null) {
$s = "hello";
}
$s .= "foo";
}
addFoo($a);
echo strlen($a);',
],
'paramOutChangeType' => [
'<?php
/**
* @param-out int $s
*/
function addFoo(?string &$s) : void {
if ($s === null) {
$s = 5;
return;
}
$s = 4;
}
addFoo($a);',
'assertions' => [
'$a' => 'int',
],
],
'paramOutReturn' => [
'<?php
/**
* @param-out bool $s
*/
function foo(?bool &$s) : void {
$s = true;
}
$b = false;
foo($b);',
'assertions' => [
'$b' => 'bool',
],
],
'dontChangeThis' => [
'<?php
interface I {}
class C implements I {
public function foo() : self {
bar($this);
return $this;
}
}
function bar(I &$i) : void {}',
],
];
}
/**
2019-03-01 21:55:20 +01:00
* @return iterable<string,array{string,error_message:string,2?:string[],3?:bool,4?:string}>
*/
2018-11-06 03:57:36 +01:00
public function providerInvalidCodeParse()
{
return [
'functionParameterViolation' => [
'<?php
/** @return void */
function changeInt(int &$a) {
$a = "hello";
}',
2017-05-27 02:05:57 +02:00
'error_message' => 'ReferenceConstraintViolation',
],
'classMethodParameterViolation' => [
'<?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' => [
'<?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' => [
'<?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',
],
];
}
}