1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 16:59:45 +01:00
psalm/tests/MethodMutationTest.php
lhchavez 216f991b0c Normalize stringified type names (#2239)
This change makes stringified types more normalized. Concretely it sorts
all union types, reconciled types, and sorts the keys within object-like
types.
2019-10-17 01:14:33 -04:00

235 lines
6.8 KiB
PHP

<?php
namespace Psalm\Tests;
use Psalm\Context;
use Psalm\Internal\Analyzer\FileAnalyzer;
class MethodMutationTest extends TestCase
{
/**
* @return void
*/
public function testControllerMutation()
{
$this->addFile(
'somefile.php',
'<?php
class User {
/** @var string */
public $name;
/**
* @param string $name
*/
protected function __construct($name) {
$this->name = $name;
}
/** @return User|null */
public static function loadUser(int $id) {
if ($id === 3) {
$user = new User("bob");
return $user;
}
return null;
}
}
class UserViewData {
/** @var string|null */
public $name;
}
class Response {
public function __construct (UserViewData $viewdata) {}
}
class UnauthorizedException extends Exception { }
class Controller {
/** @var UserViewData */
public $user_viewdata;
/** @var string|null */
public $title;
public function __construct() {
$this->user_viewdata = new UserViewData();
}
public function setUser(): void
{
$user_id = (int)$_GET["id"];
if (!$user_id) {
throw new UnauthorizedException("No user id supplied");
}
$user = User::loadUser($user_id);
if (!$user) {
throw new UnauthorizedException("User not found");
}
$this->user_viewdata->name = $user->name;
}
}
class FooController extends Controller {
public function barBar(): Response {
$this->setUser();
if (rand(0, 1)) {
$this->title = "hello";
}
return new Response($this->user_viewdata);
}
}'
);
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
$this->project_analyzer->getCodebase()->scanFiles();
$method_context = new Context();
$method_context->collect_mutations = true;
$this->project_analyzer->getMethodMutations(
'FooController::barBar',
$method_context,
'somefile.php',
'somefile.php'
);
$this->assertSame('UserViewData', (string)$method_context->vars_in_scope['$this->user_viewdata']);
$this->assertSame('string', (string)$method_context->vars_in_scope['$this->user_viewdata->name']);
$this->assertTrue($method_context->vars_possibly_in_scope['$this->title']);
}
/**
* @return void
*/
public function testNotSettingUser()
{
$this->addFile(
'somefile.php',
'<?php
class User {}
class FooController {
/** @var User|null */
public $user;
public function doThingWithUser(): array
{
if (!$this->user) {
return [];
}
return ["hello"];
}
public function barBar(): void {
$this->user = rand(0, 1) ? new User() : null;
$this->doThingWithUser();
}
}'
);
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
$this->project_analyzer->getCodebase()->scanFiles();
$method_context = new Context();
$method_context->collect_mutations = true;
$this->project_analyzer->getMethodMutations(
'FooController::barBar',
$method_context,
'somefile.php',
'somefile.php'
);
$this->assertSame('User|null', (string)$method_context->vars_in_scope['$this->user']);
}
/**
* @return void
*/
public function testParentControllerSet()
{
$this->addFile(
'somefile.php',
'<?php
class Foo { }
class Controller {
/** @var Foo|null */
public $foo;
public function __construct() {
$this->foo = new Foo();
}
}
class FooController extends Controller {
public function __construct() {
parent::__construct();
}
}'
);
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
$this->project_analyzer->getCodebase()->scanFiles();
$method_context = new Context();
$method_context->collect_mutations = true;
$this->project_analyzer->getMethodMutations(
'FooController::__construct',
$method_context,
'somefile.php',
'somefile.php'
);
$this->assertSame('Foo', (string)$method_context->vars_in_scope['$this->foo']);
}
/**
* @return void
*/
public function testTraitMethod()
{
$this->addFile(
'somefile.php',
'<?php
class Foo { }
trait T {
private function setFoo(): void {
$this->foo = new Foo();
}
}
class FooController {
use T;
/** @var Foo|null */
public $foo;
public function __construct() {
$this->setFoo();
}
}'
);
new FileAnalyzer($this->project_analyzer, 'somefile.php', 'somefile.php');
$this->project_analyzer->getCodebase()->scanFiles();
$method_context = new Context();
$method_context->collect_mutations = true;
$this->project_analyzer->getMethodMutations(
'FooController::__construct',
$method_context,
'somefile.php',
'somefile.php'
);
$this->assertSame('Foo', (string)$method_context->vars_in_scope['$this->foo']);
}
}