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

227 lines
6.9 KiB
PHP
Raw Normal View History

2017-01-12 03:37:53 +01:00
<?php
2023-10-19 13:12:06 +02:00
declare(strict_types=1);
2017-01-12 03:37:53 +01:00
namespace Psalm\Tests;
use Psalm\Context;
2019-03-23 19:27:54 +01:00
use Psalm\Internal\Analyzer\FileAnalyzer;
2021-12-03 20:11:20 +01:00
use Psalm\Internal\MethodIdentifier;
2017-01-12 03:37:53 +01:00
class MethodMutationTest extends TestCase
2017-01-12 03:37:53 +01:00
{
public function testControllerMutation(): void
2017-01-12 03:37:53 +01:00
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
$this->addFile(
'somefile.php',
2017-01-12 03:37:53 +01:00
'<?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;
}
2017-01-12 03:37:53 +01:00
}
class UserViewData {
/** @var string|null */
public $name;
}
2017-01-12 03:37:53 +01:00
class Response {
public function __construct (UserViewData $viewdata) {}
}
2017-01-12 03:37:53 +01:00
class UnauthorizedException extends Exception { }
2017-01-12 03:37:53 +01:00
class Controller {
/** @var UserViewData */
public $user_viewdata;
2017-01-12 03:37:53 +01:00
/** @var string|null */
public $title;
2017-01-12 03:37:53 +01:00
public function __construct() {
$this->user_viewdata = new UserViewData();
}
2017-01-12 03:37:53 +01:00
public function setUser(): void
{
$user_id = (int)$_GET["id"];
2017-01-12 03:37:53 +01:00
if (!$user_id) {
throw new UnauthorizedException("No user id supplied");
}
2017-01-12 03:37:53 +01:00
$user = User::loadUser($user_id);
2017-01-12 03:37:53 +01:00
if (!$user) {
throw new UnauthorizedException("User not found");
}
2017-01-12 03:37:53 +01:00
$this->user_viewdata->name = $user->name;
}
2017-01-12 03:37:53 +01:00
}
class FooController extends Controller {
public function barBar(): Response {
$this->setUser();
2017-01-12 03:37:53 +01:00
if (rand(0, 1)) {
$this->title = "hello";
}
2017-01-19 05:19:36 +01:00
return new Response($this->user_viewdata);
}
2022-12-18 17:15:15 +01:00
}',
2017-01-12 03:37:53 +01:00
);
2018-11-11 18:01:14 +01:00
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(
2021-12-03 20:11:20 +01:00
new MethodIdentifier('FooController', 'barbar'),
$method_context,
'somefile.php',
2022-12-18 17:15:15 +01:00
'somefile.php',
);
2017-01-12 03:37:53 +01:00
2017-05-27 02:05:57 +02:00
$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']);
2017-12-01 01:00:09 +01:00
$this->assertTrue($method_context->vars_possibly_in_scope['$this->title']);
2017-01-12 03:37:53 +01:00
}
public function testNotSettingUser(): void
{
$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();
}
2022-12-18 17:15:15 +01:00
}',
);
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(
2021-12-03 20:11:20 +01:00
new MethodIdentifier('FooController', 'barbar'),
$method_context,
'somefile.php',
2022-12-18 17:15:15 +01:00
'somefile.php',
);
$this->assertSame('User|null', (string)$method_context->vars_in_scope['$this->user']);
}
public function testParentControllerSet(): void
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
$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();
}
2022-12-18 17:15:15 +01:00
}',
);
2018-11-11 18:01:14 +01:00
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(
2021-12-03 20:11:20 +01:00
new MethodIdentifier('FooController', '__construct'),
$method_context,
'somefile.php',
2022-12-18 17:15:15 +01:00
'somefile.php',
);
2017-05-27 02:05:57 +02:00
$this->assertSame('Foo', (string)$method_context->vars_in_scope['$this->foo']);
}
public function testTraitMethod(): void
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
$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();
}
2022-12-18 17:15:15 +01:00
}',
);
2018-11-11 18:01:14 +01:00
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(
2021-12-03 20:11:20 +01:00
new MethodIdentifier('FooController', '__construct'),
$method_context,
'somefile.php',
2022-12-18 17:15:15 +01:00
'somefile.php',
);
$this->assertSame('Foo', (string)$method_context->vars_in_scope['$this->foo']);
}
2017-01-12 03:37:53 +01:00
}