1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-14 02:07:37 +01:00
psalm/tests/ReadonlyPropertyTest.php

328 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;
use const DIRECTORY_SEPARATOR;
class ReadonlyPropertyTest extends TestCase
{
2021-12-04 21:55:53 +01:00
use InvalidCodeAnalysisTestTrait;
use ValidCodeAnalysisTestTrait;
public function providerValidCodeParse(): iterable
{
return [
2021-07-21 19:29:07 +02:00
'docblockReadonlyPropertySetInConstructor' => [
'code' => '<?php
class A {
/**
* @readonly
*/
public string $bar;
public function __construct() {
$this->bar = "hello";
}
}
2022-12-18 17:15:15 +01:00
echo (new A)->bar;',
],
2021-07-21 19:29:07 +02:00
'readonlyPropertySetInConstructor' => [
'code' => '<?php
2021-07-21 19:29:07 +02:00
class A {
public readonly string $bar;
public function __construct() {
$this->bar = "hello";
}
}
echo (new A)->bar;',
'assertions' => [],
'ignored_issues' => [],
2022-12-18 17:15:15 +01:00
'php_version' => '8.1',
2021-07-21 19:29:07 +02:00
],
'docblockReadonlyWithPrivateMutationsAllowedPropertySetInAnotherMethod' => [
'code' => '<?php
class A {
/**
* @readonly
* @psalm-allow-private-mutation
*/
public ?string $bar = null;
public function setBar(string $s) : void {
$this->bar = $s;
}
}
2022-12-18 17:15:15 +01:00
echo (new A)->bar;',
],
'readonlyPublicPropertySetInAnotherMethod' => [
'code' => '<?php
class A {
/**
* @psalm-readonly-allow-private-mutation
*/
public ?string $bar = null;
public function setBar(string $s) : void {
$this->bar = $s;
}
}
2022-12-18 17:15:15 +01:00
echo (new A)->bar;',
],
'docblockReadonlyWithPrivateMutationsAllowedConstructorPropertySetInAnotherMethod' => [
2022-10-16 13:59:15 +02:00
'code' => '<?php
class A {
public function __construct(
/**
* @readonly
* @psalm-allow-private-mutation
*/
public ?string $bar = null,
) {}
public function setBar(string $s) : void {
$this->bar = $s;
}
}
2022-12-18 17:15:15 +01:00
echo (new A)->bar;',
],
'readonlyPublicConstructorPropertySetInAnotherMethod' => [
2022-10-16 13:59:15 +02:00
'code' => '<?php
class A {
public function __construct(
/**
* @psalm-readonly-allow-private-mutation
*/
public ?string $bar = null,
) {}
public function setBar(string $s) : void {
$this->bar = $s;
}
}
2022-12-18 17:15:15 +01:00
echo (new A)->bar;',
],
'readonlyPropertySetChildClass' => [
'code' => '<?php
abstract class A {
/**
* @readonly
*/
public string $bar;
}
class B extends A {
public function __construct() {
$this->bar = "hello";
}
}
2022-12-18 17:15:15 +01:00
echo (new B)->bar;',
],
];
}
public function providerInvalidCodeParse(): iterable
{
return [
'readonlyPropertySetInConstructorAndAlsoAnotherMethodInsideClass' => [
'code' => '<?php
class A {
/**
* @readonly
*/
public string $bar;
public function __construct() {
$this->bar = "hello";
}
public function setBar() : void {
$this->bar = "goodbye";
}
}',
'error_message' => 'InaccessibleProperty',
],
'readonlyPropertySetInConstructorAndAlsoAnotherMethodInSublass' => [
'code' => '<?php
class A {
/**
* @readonly
*/
public string $bar;
public function __construct() {
$this->bar = "hello";
}
}
class B extends A {
public function setBar() : void {
$this->bar = "hello";
}
}',
'error_message' => 'InaccessibleProperty',
],
2021-07-21 19:29:07 +02:00
'docblockReadonlyPropertySetInConstructorAndAlsoOutsideClass' => [
'code' => '<?php
class A {
/**
* @readonly
*/
public string $bar;
public function __construct() {
$this->bar = "hello";
}
}
$a = new A();
$a->bar = "goodbye";',
2021-07-21 19:29:07 +02:00
'error_message' => 'InaccessibleProperty - src' . DIRECTORY_SEPARATOR . 'somefile.php:14:21',
],
'readonlyPropertySetInConstructorAndAlsoOutsideClass' => [
'code' => '<?php
2021-07-21 19:29:07 +02:00
class A {
public readonly string $bar;
public function __construct() {
$this->bar = "hello";
}
}
$a = new A();
$a->bar = "goodbye";',
'error_message' => 'InaccessibleProperty - src' . DIRECTORY_SEPARATOR . 'somefile.php:11:21',
'ignored_issues' => [],
'php_version' => '8.1',
],
'readonlyPropertySetInConstructorAndAlsoOutsideClassWithAllowPrivate' => [
'code' => '<?php
class A {
/**
* @readonly
* @psalm-allow-private-mutation
*/
public string $bar;
public function __construct() {
$this->bar = "hello";
}
public function setAgain() : void {
$this->bar = "hello";
}
}
$a = new A();
$a->bar = "goodbye";',
'error_message' => 'InaccessibleProperty - src' . DIRECTORY_SEPARATOR . 'somefile.php:19:21',
],
'readonlyPublicPropertySetInConstructorAndAlsoOutsideClass' => [
'code' => '<?php
class A {
/**
* @psalm-readonly-allow-private-mutation
*/
public string $bar;
public function __construct() {
$this->bar = "hello";
}
public function setAgain() : void {
$this->bar = "hello";
}
}
$a = new A();
$a->bar = "goodbye";',
'error_message' => 'InaccessibleProperty - src' . DIRECTORY_SEPARATOR . 'somefile.php:18:21',
],
'readonlyPropertyAssignOperator' => [
'code' => '<?php
class Test {
/** @readonly */
public int $prop;
public function __construct(int $prop) {
// Legal initialization.
$this->prop = $prop;
}
}
$test = new Test(5);
$test->prop += 1;',
2022-12-18 17:15:15 +01:00
'error_message' => 'InaccessibleProperty',
],
2021-07-21 19:29:07 +02:00
'readonlyPropertyWithDefault' => [
'code' => '<?php
2021-07-21 19:29:07 +02:00
class A {
public readonly string $s = "a";
}',
'error_message' => 'InvalidPropertyAssignment',
'ignored_issues' => [],
'php_version' => '8.1',
2021-07-21 19:29:07 +02:00
],
'readonlyPromotedPropertyAssignOperator' => [
'code' => '<?php
class A {
public function __construct(public readonly string $bar) {
}
}
$a = new A("hello");
$a->bar = "goodbye";',
'error_message' => 'InaccessibleProperty - src' . DIRECTORY_SEPARATOR . 'somefile.php:8:21',
'ignored_issues' => [],
'php_version' => '8.1',
],
'readonlyPromotedPropertyAccess' => [
'code' => '<?php
class A {
public function __construct(private readonly string $bar) {
}
}
$a = new A("hello");
$b = $a->bar;',
'error_message' => 'InaccessibleProperty - src' . DIRECTORY_SEPARATOR . 'somefile.php:8:26',
'ignored_issues' => [],
'php_version' => '8.1',
],
2022-01-16 09:29:16 +01:00
'readonlyPhpDocPromotedPropertyAssignOperator' => [
2022-01-18 23:07:35 +01:00
'code' => '<?php
2022-01-16 09:29:16 +01:00
final class A
{
public function __construct(
/**
* @psalm-readonly
*/
private string $string,
) {
}
private function mutateString(): void
{
$this->string = "";
}
}',
'error_message' => 'InaccessibleProperty',
2022-01-18 23:07:35 +01:00
'ignored_issues' => [],
'php_version' => '8.1',
2022-01-16 09:29:16 +01:00
],
];
}
}