psalm/tests/CheckTypeTest.php

<?php

namespace Psalm\Tests;

use Psalm\Tests\Traits\InvalidCodeAnalysisTestTrait;
use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;

class CheckTypeTest extends TestCase
{
    use InvalidCodeAnalysisTestTrait;
    use ValidCodeAnalysisTestTrait;

    public function providerValidCodeParse(): iterable
    {
        yield 'allowSubtype' => [
            'code' => '<?php
                /** @psalm-check-type $foo = int */
                $foo = 1;
            ',
        ];
        yield 'allowNamespace' => [
            'code' => '<?php

                namespace X;

                final class A {}

                $_a = new A();
                /** @psalm-check-type-exact $_a = A */',
        ];
        yield 'allowImport' => [
            'code' => '<?php

                namespace X;

                use \stdClass;

                $_a = new stdClass();
                /** @psalm-check-type-exact $_a = \stdClass */',
        ];
        yield 'allowType' => [
            'code' => '<?php
                namespace X;

                /** @psalm-type A = int|string */

                $_a = 1;
                /** @psalm-check-type $_a = A */',
        ];
    }

    public function providerInvalidCodeParse(): iterable
    {
        yield 'checkType' => [
            'code' => '<?php
                $foo = 1;
                /** @psalm-check-type $foo = 2 */;
            ',
            'error_message' => 'CheckType',
        ];
        yield 'checkTypeExact' => [
            'code' => '<?php
                /** @psalm-check-type-exact $foo = int */
                $foo = 1;
            ',
            'error_message' => 'CheckType',
        ];
        yield 'checkMultipleTypesFirstCorrect' => [
            'code' => '<?php
                $foo = 1;
                $bar = 2;
                /**
                 * @psalm-check-type $foo = 1
                 * @psalm-check-type $bar = 3
                 */;
            ',
            'error_message' => 'CheckType',
        ];
        yield 'possiblyUnset' => [
            'code' => '<?php
                try {
                    $foo = 1;
                } catch (Exception $_) {
                }
                /** @psalm-check-type $foo = 1 */;
            ',
            'error_message' => 'Checked variable $foo = 1 does not match $foo? = 1',
        ];
        yield 'notPossiblyUnset' => [
            'code' => '<?php
                $foo = 1;
                /** @psalm-check-type $foo? = 1 */;
            ',
            'error_message' => 'Checked variable $foo? = 1 does not match $foo = 1',
        ];
        yield 'invalidIncompleteSyntax' => [
            'code' => '<?php
                /** @psalm-check-type */
            ',
            'error_message' => 'InvalidDocblock',
        ];
        yield 'invalidIncompleteSyntaxNoVar' => [
            'code' => '<?php
                /** @psalm-check-type = 1 */
            ',
            'error_message' => 'InvalidDocblock',
        ];
        yield 'invalidIncompleteSyntaxNoType' => [
            'code' => '<?php
                /** @psalm-check-type $var = */
            ',
            'error_message' => 'InvalidDocblock',
        ];
    }
}