1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-30 04:39:00 +01:00
psalm/tests/TypeParseTest.php

1320 lines
34 KiB
PHP
Raw Normal View History

<?php
namespace Psalm\Tests;
use function function_exists;
use function print_r;
Test parallelization (#4045) * Run tests in random order Being able to run tests in any order is a pre-requisite for being able to run them in parallel. * Reset type coverage between tests, fix affected tests * Reset parser and lexer between test runs and on php version change Previously lexer was reset, but parser kept the reference to the old one, and reference to the parser was kept by StatementsProvider. This resulted in order-dependent tests - if the parser was first initialized with phpVersion set to 7.4 then arrow functions worked fine, but were failing when the parser was initially constructed with settings for 7.3 This can be demonstrated on current master by upgrading to nikic/php-parser:4.9 and running: ``` vendor/bin/phpunit --no-coverage --filter="inferredArgArrowFunction" tests/ClosureTest.php ``` Now all tests using PHP 7.4 features must set the PHP version accordingly. * Marked more tests using 7.4 syntax * Reset newline-between-annotation flag between tests * Resolve real paths before passing them to checkPaths When checkPaths is called from psalm.php the paths are resolved, so we just mimicking SUT behaviour here. * Restore newline-between-annotations in DocCommentTest * Tweak Appveyor caches * Tweak TravisCI caches * Tweak CircleCI caches * Run tests in parallel Use `vendor/bin/paratest` instead of `vendor/bin/phpunit` * Use default paratest runner on Windows WrapperRunner is not supported on Windows. * TRAVIS_TAG could be empty * Restore appveyor conditional caching
2020-08-23 16:32:07 +02:00
use Psalm\Internal\RuntimeCaches;
2019-07-05 22:24:00 +02:00
use Psalm\Type;
use function stripos;
class TypeParseTest extends TestCase
{
/**
* @return void
*/
2019-05-17 00:36:36 +02:00
public function setUp() : void
{
Test parallelization (#4045) * Run tests in random order Being able to run tests in any order is a pre-requisite for being able to run them in parallel. * Reset type coverage between tests, fix affected tests * Reset parser and lexer between test runs and on php version change Previously lexer was reset, but parser kept the reference to the old one, and reference to the parser was kept by StatementsProvider. This resulted in order-dependent tests - if the parser was first initialized with phpVersion set to 7.4 then arrow functions worked fine, but were failing when the parser was initially constructed with settings for 7.3 This can be demonstrated on current master by upgrading to nikic/php-parser:4.9 and running: ``` vendor/bin/phpunit --no-coverage --filter="inferredArgArrowFunction" tests/ClosureTest.php ``` Now all tests using PHP 7.4 features must set the PHP version accordingly. * Marked more tests using 7.4 syntax * Reset newline-between-annotation flag between tests * Resolve real paths before passing them to checkPaths When checkPaths is called from psalm.php the paths are resolved, so we just mimicking SUT behaviour here. * Restore newline-between-annotations in DocCommentTest * Tweak Appveyor caches * Tweak TravisCI caches * Tweak CircleCI caches * Run tests in parallel Use `vendor/bin/paratest` instead of `vendor/bin/phpunit` * Use default paratest runner on Windows WrapperRunner is not supported on Windows. * TRAVIS_TAG could be empty * Restore appveyor conditional caching
2020-08-23 16:32:07 +02:00
RuntimeCaches::clearAll();
$this->file_provider = new \Psalm\Tests\Internal\Provider\FakeFileProvider();
$config = new TestConfig();
$providers = new \Psalm\Internal\Provider\Providers(
$this->file_provider,
new \Psalm\Tests\Internal\Provider\FakeParserCacheProvider()
);
$this->project_analyzer = new \Psalm\Internal\Analyzer\ProjectAnalyzer(
$config,
$providers
);
}
2018-03-22 22:55:36 +01:00
/**
* @return void
*/
public function testThisToStatic()
{
$this->assertSame('static', (string) Type::parseString('$this'));
}
/**
* @return void
*/
public function testThisToStaticUnion()
{
$this->assertSame('A|static', (string) Type::parseString('$this|A'));
2018-03-22 22:55:36 +01:00
}
2017-01-13 20:07:23 +01:00
/**
* @return void
*/
public function testIntOrString()
{
2017-05-27 02:05:57 +02:00
$this->assertSame('int|string', (string) Type::parseString('int|string'));
}
2018-03-23 03:28:06 +01:00
/**
* @return void
*/
public function testBracketedIntOrString()
{
$this->assertSame('int|string', (string) Type::parseString('(int|string)'));
}
2018-03-21 01:19:26 +01:00
/**
* @return void
*/
public function testBoolOrIntOrString()
{
$this->assertSame('bool|int|string', (string) Type::parseString('bool|int|string'));
}
2017-11-20 06:32:40 +01:00
/**
* @return void
*/
public function testNullable()
{
$this->assertSame('null|string', (string) Type::parseString('?string'));
}
/**
* @return void
*/
public function testNullableUnion()
{
$this->assertSame('int|null|string', (string) Type::parseString('?(string|int)'));
}
2018-05-21 18:55:44 +02:00
/**
* @return void
*/
public function testNullableFullyQualified()
{
$this->assertSame('null|stdClass', (string) Type::parseString('?\\stdClass'));
}
2018-06-09 05:54:07 +02:00
/**
* @return void
*/
public function testNullableOrNullable()
{
$this->assertSame('int|null|string', (string) Type::parseString('?string|?int'));
2018-06-09 05:54:07 +02:00
}
/**
* @return void
*/
public function testBadNullableCharacterInUnion()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('int|array|?');
}
/**
* @return void
*/
public function testBadNullableCharacterInUnionWithFollowing()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('int|array|?|bool');
}
2017-01-13 20:07:23 +01:00
/**
* @return void
*/
public function testArrayWithClosingBracket()
{
2017-05-27 02:05:57 +02:00
$this->assertSame('array<int, int>', (string) Type::parseString('array<int, int>'));
}
/**
* @return void
*/
public function testArrayWithoutClosingBracket()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('array<int, int');
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testArrayWithSingleArg()
{
$this->assertSame('array<array-key, int>', (string) Type::parseString('array<int>'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testArrayWithNestedSingleArg()
{
$this->assertSame('array<array-key, array<array-key, int>>', (string) Type::parseString('array<array<int>>'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testArrayWithUnion()
{
2017-05-27 02:05:57 +02:00
$this->assertSame('array<int|string, string>', (string) Type::parseString('array<int|string, string>'));
}
/**
* @return void
*/
public function testNonEmptyArrray()
{
$this->assertSame('non-empty-array<array-key, int>', (string) Type::parseString('non-empty-array<int>'));
}
2017-01-13 20:07:23 +01:00
/**
* @return void
*/
public function testGeneric()
{
2017-05-27 02:05:57 +02:00
$this->assertSame('B<int>', (string) Type::parseString('B<int>'));
}
/**
* @return void
*/
public function testIntersection()
{
$this->assertSame('I1&I2&I3', (string) Type::parseString('I1&I2&I3'));
}
2018-03-22 22:55:36 +01:00
/**
* @return void
*/
public function testIntersectionOrNull()
{
$this->assertSame('I1&I2|null', (string) Type::parseString('I1&I2|null'));
2018-03-22 22:55:36 +01:00
}
/**
* @return void
*/
public function testNullOrIntersection()
{
$this->assertSame('I1&I2|null', (string) Type::parseString('null|I1&I2'));
2018-03-22 22:55:36 +01:00
}
/**
* @return void
*/
public function testInteratorAndTraversable()
{
$this->assertSame('Iterator<mixed, int>&Traversable', (string) Type::parseString('Iterator<int>&Traversable'));
2018-03-22 22:55:36 +01:00
}
/**
* @return void
*/
public function testStaticAndStatic()
{
$this->assertSame('static', (string) Type::parseString('static&static'));
}
2018-03-22 22:55:36 +01:00
/**
* @return void
*/
public function testTraversableAndIteratorOrNull()
{
$this->assertSame(
'Traversable&Iterator<mixed, int>|null',
2018-03-22 22:55:36 +01:00
(string) Type::parseString('Traversable&Iterator<int>|null')
);
}
/**
* @return void
*/
public function testIteratorAndTraversableOrNull()
{
$this->assertSame(
'Iterator<mixed, int>&Traversable|null',
(string) Type::parseString('Iterator<mixed, int>&Traversable|null')
);
}
/**
* @return void
*/
public function testIntersectionAfterGeneric()
{
$this->assertSame('Countable&iterable<mixed, int>&I', (string) Type::parseString('Countable&iterable<int>&I'));
}
/**
* @return void
*/
public function testIntersectionOfIterables()
{
$this->assertSame('iterable<mixed, A>&iterable<mixed, B>', (string) Type::parseString('iterable<A>&iterable<B>'));
}
/**
* @return void
*/
public function testIntersectionOfObjectLike()
{
$this->assertSame('array{a: int, b: int}', (string) Type::parseString('array{a: int}&array{b: int}'));
}
/**
* @return void
*/
public function testIntersectionOfObjectLikeWithMergedProperties()
{
$this->assertSame('array{a: int}', (string) Type::parseString('array{a: int}&array{a: mixed}'));
}
/**
* @return void
*/
public function testIntersectionOfObjectLikeWithPossiblyUndefinedMergedProperties()
{
$this->assertSame('array{a: int}', (string) Type::parseString('array{a: int}&array{a?: int}'));
}
/**
* @return void
*/
public function testIntersectionOfObjectLikeWithConflictingProperties()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('array{a: string}&array{a: int}');
}
/**
* @return void
*/
public function testUnionOfIntersectionOfObjectLike()
{
$this->assertSame('array{a: int|string, b?: int}', (string) Type::parseString('array{a: int}|array{a: string}&array{b: int}'));
$this->assertSame('array{a: int|string, b?: int}', (string) Type::parseString('array{b: int}&array{a: string}|array{a: int}'));
}
/**
* @return void
*/
public function testIntersectionOfUnionOfObjectLike()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('array{a: int}&array{a: string}|array{b: int}');
}
/**
* @return void
*/
public function testIntersectionOfObjectLikeAndObject()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('array{a: int}&T1');
}
2019-06-30 03:56:34 +02:00
public function testIterableContainingObjectLike() : void
{
2020-05-11 15:08:53 +02:00
$this->assertSame('iterable<string, array{int}>', Type::parseString('iterable<string, array{int}>')->getId());
}
2017-01-13 20:07:23 +01:00
/**
* @return void
*/
2018-03-21 01:19:26 +01:00
public function testPhpDocSimpleArray()
2016-10-30 02:57:03 +02:00
{
$this->assertSame('array<array-key, A>', (string) Type::parseString('A[]'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testPhpDocUnionArray()
{
$this->assertSame('array<array-key, A|B>', (string) Type::parseString('(A|B)[]'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testPhpDocMultiDimensionalArray()
{
$this->assertSame('array<array-key, array<array-key, A>>', (string) Type::parseString('A[][]'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testPhpDocMultidimensionalUnionArray()
{
$this->assertSame('array<array-key, array<array-key, A|B>>', (string) Type::parseString('(A|B)[][]'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testPhpDocObjectLikeArray()
{
$this->assertSame(
2019-06-16 15:42:34 +02:00
'array<array-key, array{b: bool, d: string}>',
(string) Type::parseString('array{b: bool, d: string}[]')
);
}
2018-03-21 01:19:26 +01:00
/**
* @return void
*/
public function testPhpDocUnionOfArrays()
{
$this->assertSame('array<array-key, A|B>', (string) Type::parseString('A[]|B[]'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testPhpDocUnionOfArraysOrObject()
{
$this->assertSame('C|array<array-key, A|B>', (string) Type::parseString('A[]|B[]|C'));
2016-10-30 02:57:03 +02:00
}
/**
* @return void
*/
public function testPsalmOnlyAtomic()
{
$this->assertSame('class-string', (string) Type::parseString('class-string'));
}
/**
* @return void
*/
2020-04-28 15:17:31 +02:00
public function testParameterizedClassString()
{
$this->assertSame('class-string<A>', (string) Type::parseString('class-string<A>'));
}
/**
* @return void
*/
2020-04-28 15:17:31 +02:00
public function testParameterizedClassStringUnion()
{
$this->assertSame('class-string<A>|class-string<B>', (string) Type::parseString('class-string<A>|class-string<B>'));
}
2017-10-12 20:02:06 +02:00
/**
* @return void
*/
public function testInvalidType()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2017-10-12 20:02:06 +02:00
Type::parseString('array(A)');
}
2018-03-23 03:28:06 +01:00
/**
* @return void
*/
public function testBracketedUnionAndIntersection()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2018-03-23 03:28:06 +01:00
Type::parseString('(A|B)&C');
}
2018-06-30 20:25:32 +02:00
/**
* @return void
*/
public function testBracketInUnion()
{
Type::parseString('null|(scalar|array|object)');
}
2017-01-13 20:07:23 +01:00
/**
* @return void
*/
2018-03-21 01:19:26 +01:00
public function testObjectLikeWithSimpleArgs()
{
2019-06-16 15:42:34 +02:00
$this->assertSame('array{a: int, b: string}', (string) Type:: parseString('array{a: int, b: string}'));
2018-03-21 01:19:26 +01:00
}
/**
* @return void
*/
public function testObjectLikeWithSpace()
{
$this->assertSame('array{\'a \': int, \'b \': string}', (string) Type:: parseString('array{\'a \': int, \'b \': string}'));
}
/**
* @return void
*/
public function testObjectLikeWithQuotedKeys()
{
$this->assertSame('array{\'\\"\': int, \'\\\'\': string}', (string) Type:: parseString('array{\'"\': int, \'\\\'\': string}'));
$this->assertSame('array{\'\\"\': int, \'\\\'\': string}', (string) Type:: parseString('array{"\\"": int, "\\\'": string}'));
}
/**
* @return void
*/
public function testObjectLikeWithClassConstantKey()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('array{self::FOO: string}');
}
/**
* @return void
*/
public function testObjectLikeWithQuotedClassConstantKey()
{
$this->assertSame('array{\'self::FOO\': string}', (string) Type:: parseString('array{"self::FOO": string}'));
}
/**
* @return void
*/
public function testObjectLikeWithoutClosingBracket()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2019-06-16 15:42:34 +02:00
Type::parseString('array{a: int, b: string');
}
/**
* @return void
*/
public function testObjectLikeArrayInType()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('array{a:[]}');
}
/**
* @return void
*/
public function testObjectWithSimpleArgs()
{
$this->assertSame('object{a:int, b:string}', (string) Type::parseString('object{a:int, b:string}'));
}
/**
* @return void
*/
public function testObjectWithDollarArgs()
{
$this->assertSame('object{a:int, $b:string}', (string) Type::parseString('object{a:int, $b:string}'));
}
2018-03-21 01:19:26 +01:00
/**
* @return void
*/
public function testObjectLikeWithUnionArgs()
{
2017-05-27 02:05:57 +02:00
$this->assertSame(
2019-06-16 15:42:34 +02:00
'array{a: int|string, b: string}',
(string) Type::parseString('array{a: int|string, b: string}')
2016-11-02 07:29:00 +01:00
);
2018-03-21 01:19:26 +01:00
}
2016-11-02 07:29:00 +01:00
2018-03-21 01:19:26 +01:00
/**
* @return void
*/
public function testObjectLikeWithGenericArgs()
{
2017-05-27 02:05:57 +02:00
$this->assertSame(
'array{a: array<int, int|string>, b: string}',
2019-06-16 15:42:34 +02:00
(string) Type::parseString('array{a: array<int, string|int>, b: string}')
2016-11-02 07:29:00 +01:00
);
2018-03-21 01:19:26 +01:00
}
2018-03-21 01:19:26 +01:00
/**
* @return void
*/
public function testObjectLikeWithIntKeysAndUnionArgs()
{
$this->assertSame(
2020-05-11 15:08:53 +02:00
'array{null|stdClass}',
(string)Type::parseString('array{stdClass|null}')
);
2018-03-21 01:19:26 +01:00
}
2018-03-21 01:19:26 +01:00
/**
* @return void
*/
public function testObjectLikeWithIntKeysAndGenericArgs()
{
$this->assertSame(
2020-05-11 15:08:53 +02:00
'array{array<array-key, mixed>}',
(string)Type::parseString('array{array}')
);
$this->assertSame(
2020-05-11 15:08:53 +02:00
'array{array<int, string>}',
(string)Type::parseString('array{array<int, string>}')
);
}
/**
* @return void
*/
public function testObjectLikeOptional()
{
$this->assertSame(
2019-06-16 15:42:34 +02:00
'array{a: int, b?: int}',
(string)Type::parseString('array{a: int, b?: int}')
);
}
/**
* @return void
*/
public function testSimpleCallable()
{
$this->assertSame(
2018-04-08 18:57:56 +02:00
'callable(int, string):void',
(string)Type::parseString('callable(int, string) : void')
);
}
/**
* @return void
*/
public function testCallableWithoutClosingBracket()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('callable(int, string');
}
/**
* @return void
*/
public function testCallableWithParamNames()
{
$this->assertSame(
'callable(int, string):void',
(string)Type::parseString('callable(int $foo, string $bar) : void')
);
}
/**
* @return void
*/
public function testCallableReturningIntersection()
{
$this->assertSame(
'callable(int, string):I1&I2',
(string)Type::parseString('callable(int, string) : (I1&I2)')
);
}
2018-03-28 16:53:19 +02:00
/**
* @return void
*/
public function testEmptyCallable()
{
$this->assertSame(
2018-04-08 18:57:56 +02:00
'callable():void',
2018-03-28 16:53:19 +02:00
(string)Type::parseString('callable() : void')
);
}
/**
* @return void
*/
public function testCallableWithUnionLastType()
{
$this->assertSame(
2018-04-08 18:57:56 +02:00
'callable(int, int|string):void',
(string)Type::parseString('callable(int, int|string) : void')
);
}
/**
* @return void
*/
public function testCallableWithVariadic()
{
$this->assertSame(
2018-04-08 18:57:56 +02:00
'callable(int, string...):void',
(string)Type::parseString('callable(int, string...) : void')
);
}
/**
* @return void
*/
public function testCallableThatReturnsACallable()
{
$this->assertSame(
'callable():callable():string',
(string)Type::parseString('callable() : callable() : string')
);
}
/**
* @return void
*/
public function testCallableThatReturnsACallableThatReturnsACallable()
{
$this->assertSame(
'callable():callable():callable():string',
(string)Type::parseString('callable() : callable() : callable() : string')
);
}
2018-04-19 01:04:06 +02:00
/**
* @return void
*/
2018-04-19 01:00:08 +02:00
public function testCallableOrInt()
{
$this->assertSame(
'callable(string):void|int',
(string)Type::parseString('callable(string):void|int')
);
}
/**
* @return void
*/
public function testCallableWithGoodVariadic()
{
Type::parseString('callable(int, string...) : void');
Type::parseString('callable(int,string...) : void');
}
/**
* @return void
*/
public function testCallableWithSpreadBefore()
{
$this->assertSame(
'callable(int, string...):void',
(string)Type::parseString('callable(int, ...string):void')
);
}
/**
* @return void
*/
public function testConditionalTypeWithSpaces()
{
$this->assertSame(
'(T is string ? string : int)',
(string) Type::parseString('(T is string ? string : int)', null, ['T' => ['' => [Type::getArray()]]])
);
}
/**
* @return void
*/
public function testConditionalTypeWithUnion()
{
$this->assertSame(
'(T is string|true ? int|string : int)',
(string) Type::parseString('(T is "hello"|true ? string|int : int)', null, ['T' => ['' => [Type::getArray()]]])
);
}
/**
* @return void
*/
public function testConditionalTypeWithObjectLikeArray()
{
$this->assertSame(
'(T is array{a: string} ? string : int)',
(string) Type::parseString('(T is array{a: string} ? string : int)', null, ['T' => ['' => [Type::getArray()]]])
);
}
/**
* @return void
*/
public function testConditionalTypeWithGenericIs()
{
$this->assertSame(
'(T is array<array-key, string> ? string : int)',
(string) Type::parseString('(T is array<string> ? string : int)', null, ['T' => ['' => [Type::getArray()]]])
);
}
/**
* @return void
*/
public function testConditionalTypeWithIntersection()
{
$this->assertSame(
'(T is A&B ? string : int)',
(string) Type::parseString('(T is A&B ? string : int)', null, ['T' => ['' => [Type::getArray()]]])
);
}
/**
* @return void
*/
public function testConditionalTypeWithoutSpaces()
{
$this->assertSame(
'(T is string ? string : int)',
(string) Type::parseString('(T is string?string:int)', null, ['T' => ['' => [Type::getArray()]]])
);
}
/**
* @return void
*/
public function testConditionalTypeWithCallableElseBool()
{
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('(T is string ? callable() : bool)', null, ['T' => ['' => [Type::getArray()]]]);
}
/**
* @return void
*/
public function testConditionalTypeWithCallableReturningBoolElseBool()
{
$this->assertSame(
'(T is string ? callable():bool : bool)',
(string) Type::parseString('(T is string ? (callable() : bool) : bool)', null, ['T' => ['' => [Type::getArray()]]])
);
}
public function testConditionalTypeWithGenerics() : void
{
$this->assertSame(
'(T is string ? string : array<string, string>)',
(string) Type::parseString(
'(T is string ? string : array<string, string>)',
null,
['T' => ['' => [Type::getArray()]]]
)
);
}
public function testConditionalTypeWithCallableBracketed() : void
{
$this->assertSame(
'(T is string ? callable(string, string):string : callable(mixed...):mixed)',
(string) Type::parseString(
'(T is string ? (callable(string, string):string) : (callable(mixed...):mixed))',
null,
['T' => ['' => [Type::getArray()]]]
)
);
}
public function testConditionalTypeWithCallableNotBracketed() : void
{
$this->assertSame(
'(T is string ? callable(string, string):string : callable(mixed...):mixed)',
(string) Type::parseString(
'(T is string ? callable(string, string):string : callable(mixed...):mixed)',
null,
['T' => ['' => [Type::getArray()]]]
)
);
}
2018-04-16 00:16:31 +02:00
/**
* @return void
*/
public function testCallableWithTrailingColon()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2018-04-16 00:16:31 +02:00
Type::parseString('callable(int):');
}
/**
* @return void
*/
public function testCallableWithAnotherBadVariadic()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('callable(int, string..) : void');
}
/**
* @return void
*/
public function testCallableWithVariadicAndDefault()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('callable(int, string...=) : void');
}
/**
* @return void
*/
public function testBadVariadic()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('string...');
}
2018-03-27 20:43:39 +02:00
/**
* @return void
*/
public function testBadFullStop()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2018-03-27 20:43:39 +02:00
Type::parseString('string.');
}
2018-04-05 20:11:57 +02:00
/**
* @return void
*/
public function testBadSemicolon()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2018-04-05 20:11:57 +02:00
Type::parseString('string;');
}
/**
* @return void
*/
public function testBadGenericString()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('string<T>');
}
/**
* @return void
*/
public function testBadAmpersand()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('&array');
}
/**
* @return void
*/
public function testBadColon()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString(':array');
}
2018-09-06 04:36:32 +02:00
/**
* @return void
*/
public function testBadBrackets()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2018-09-06 04:36:32 +02:00
Type::parseString('max(a)');
}
2018-09-06 04:40:52 +02:00
/**
* @return void
*/
public function testMoreBadBrackets()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2018-09-06 04:40:52 +02:00
Type::parseString('max(a):void');
}
/**
* @return void
*/
public function testGeneratorWithWBadBrackets()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('Generator{string, A}');
}
/**
* @return void
*/
public function testBadEquals()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('=array');
}
/**
* @return void
*/
public function testBadBar()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('|array');
}
/**
* @return void
*/
public function testBadColonDash()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
Type::parseString('array|string:-');
}
2018-03-29 08:20:19 +02:00
/**
* @return void
*/
public function testDoubleBar()
{
2019-05-17 00:36:36 +02:00
$this->expectException(\Psalm\Exception\TypeParseTreeException::class);
2018-03-29 08:20:19 +02:00
Type::parseString('PDO||Closure|numeric');
}
/**
* @return void
*/
public function testCallableWithDefault()
{
$this->assertSame(
2018-04-08 18:57:56 +02:00
'callable(int, string=):void',
(string)Type::parseString('callable(int, string=) : void')
);
}
/**
* @return void
*/
public function testNestedCallable()
{
$this->assertSame(
'callable(callable(A):B):C',
(string)Type::parseString('callable(callable(A):B):C')
);
}
/**
* @return void
*/
public function testCallableWithoutReturn()
{
$this->assertSame(
'callable(int, string)',
(string)Type::parseString('callable(int, string)')
);
}
2018-04-19 01:00:08 +02:00
/**
* @return void
*/
public function testCombineLiteralStringWithClassString()
{
$this->assertSame(
2019-11-30 18:57:18 +01:00
'class-string|string(array)',
Type::parseString('"array"|class-string')->getId()
);
}
/**
* @return void
*/
public function testCombineLiteralClassStringWithClassString()
{
$this->assertSame(
2019-12-02 05:09:34 +01:00
'class-string',
2019-11-30 18:57:18 +01:00
Type::parseString('A::class|class-string')->getId()
);
}
/**
* @return void
*/
public function testKeyOfClassConstant()
{
$this->assertSame(
'key-of<Foo\Baz::BAR>',
(string)Type::parseString('key-of<Foo\Baz::BAR>')
);
}
/**
* @return void
*/
public function testKeyOfTemplate()
{
$this->assertSame(
'key-of<T>',
(string)Type::parseString('key-of<T>', null, ['T' => ['' => [Type::getArray()]]])
);
}
/**
* @return void
*/
public function testIndexedAccess()
{
$this->assertSame(
'T[K]',
(string) Type::parseString(
'T[K]',
null,
[
'T' => ['' => [Type::getArray()]],
'K' => ['' => [new Type\Union([
new Type\Atomic\TTemplateKeyOf('T', 'fn-foo', Type::getMixed())
])]],
]
)
);
}
/**
* @return void
*/
public function testValueOfClassConstant()
{
$this->assertSame(
'value-of<Foo\Baz::BAR>',
(string)Type::parseString('value-of<Foo\Baz::BAR>')
);
}
public function testClassStringMap() : void
{
$this->assertSame(
'class-string-map<T as Foo, T>',
(string)Type::parseString('class-string-map<T as Foo, T>')
);
}
/**
* @return void
*/
public function testVeryLargeType()
{
2020-02-22 17:28:24 +01:00
$very_large_type = 'array{a: Closure():(array<array-key, mixed>|null), b?: Closure():array<array-key, mixed>, c?: Closure():array<array-key, mixed>, d?: Closure():array<array-key, mixed>, e?: Closure():(array{f: null|string, g: null|string, h: null|string, i: string, j: mixed, k: mixed, l: mixed, m: mixed, n: bool, o?: array{0: string}}|null), p?: Closure():(array{f: null|string, g: null|string, h: null|string, i: string, j: mixed, k: mixed, l: mixed, m: mixed, n: bool, o?: array{0: string}}|null), q: string, r?: Closure():(array<array-key, mixed>|null), s: array<array-key, mixed>}|null';
$this->assertSame(
$very_large_type,
(string) Type::parseString($very_large_type)
);
}
2018-05-20 23:19:53 +02:00
/**
* @return void
*/
public function testEnum()
{
$docblock_type = Type::parseString('( \'foo\\\'with\' | "bar\"bar" | "baz" | "bat\\\\" | \'bang bang\' | 1 | 2 | 3 | 4.5)');
2018-05-20 23:19:53 +02:00
$resolved_type = new Type\Union([
new Type\Atomic\TLiteralString('foo\'with'),
new Type\Atomic\TLiteralString('bar"bar'),
new Type\Atomic\TLiteralString('baz'),
new Type\Atomic\TLiteralString('bat\\'),
new Type\Atomic\TLiteralString('bang bang'),
new Type\Atomic\TLiteralInt(1),
new Type\Atomic\TLiteralInt(2),
new Type\Atomic\TLiteralInt(3),
2019-03-23 19:27:54 +01:00
new Type\Atomic\TLiteralFloat(4.5),
2018-05-20 23:19:53 +02:00
]);
$this->assertSame($resolved_type->getId(), $docblock_type->getId());
}
2019-12-11 17:29:26 +01:00
public function testEmptyString() : void
2019-12-11 16:52:46 +01:00
{
$docblock_type = Type::parseString('""|"admin"|"fun"');
$resolved_type = new Type\Union([
new Type\Atomic\TLiteralString(''),
new Type\Atomic\TLiteralString('admin'),
new Type\Atomic\TLiteralString('fun'),
]);
$this->assertSame($resolved_type->getId(), $docblock_type->getId());
$docblock_type = Type::parseString('"admin"|""|"fun"');
$resolved_type = new Type\Union([
new Type\Atomic\TLiteralString('admin'),
new Type\Atomic\TLiteralString(''),
new Type\Atomic\TLiteralString('fun'),
]);
$this->assertSame($resolved_type->getId(), $docblock_type->getId());
$docblock_type = Type::parseString('"admin"|"fun"|""');
$resolved_type = new Type\Union([
new Type\Atomic\TLiteralString('admin'),
new Type\Atomic\TLiteralString('fun'),
new Type\Atomic\TLiteralString(''),
]);
$this->assertSame($resolved_type->getId(), $docblock_type->getId());
}
/**
* @return void
*/
public function testEnumWithoutSpaces()
{
$docblock_type = Type::parseString('\'foo\\\'with\'|"bar\"bar"|"baz"|"bat\\\\"|\'bang bang\'|1|2|3|4.5');
$resolved_type = new Type\Union([
new Type\Atomic\TLiteralString('foo\'with'),
new Type\Atomic\TLiteralString('bar"bar'),
new Type\Atomic\TLiteralString('baz'),
new Type\Atomic\TLiteralString('bat\\'),
new Type\Atomic\TLiteralString('bang bang'),
new Type\Atomic\TLiteralInt(1),
new Type\Atomic\TLiteralInt(2),
new Type\Atomic\TLiteralInt(3),
2019-03-23 19:27:54 +01:00
new Type\Atomic\TLiteralFloat(4.5),
]);
$this->assertSame($resolved_type->getId(), $docblock_type->getId());
}
/**
* @return void
*/
public function testSingleLiteralString()
{
$this->assertSame(
'string',
(string)Type::parseString('"var"')
);
}
/**
* @return void
*/
public function testSingleLiteralInt()
{
$this->assertSame(
'int',
(string)Type::parseString('6')
);
}
/**
* @return void
*/
public function testSingleLiteralFloat()
{
$this->assertSame(
'float',
(string)Type::parseString('6.315')
);
}
/**
* @return void
*/
public function testEnumWithClassConstants()
{
$docblock_type = Type::parseString('("baz" | One2::TWO_THREE | Foo::BAR_BAR | Bat\Bar::BAZ_BAM)');
$resolved_type = new Type\Union([
new Type\Atomic\TLiteralString('baz'),
new Type\Atomic\TScalarClassConstant('One2', 'TWO_THREE'),
new Type\Atomic\TScalarClassConstant('Foo', 'BAR_BAR'),
new Type\Atomic\TScalarClassConstant('Bat\\Bar', 'BAZ_BAM'),
]);
$this->assertSame($resolved_type->getId(), $docblock_type->getId());
}
/**
* @return void
*/
public function testReflectionTypeParse()
{
2019-05-17 00:36:36 +02:00
if (!function_exists('Psalm\Tests\someFunction')) {
/** @psalm-suppress UnusedParam */
function someFunction(string $param, array $param2, int $param3 = null) : string
{
return 'hello';
}
}
$reflectionFunc = new \ReflectionFunction('Psalm\Tests\someFunction');
$reflectionParams = $reflectionFunc->getParameters();
$this->assertSame(
'string',
(string) \Psalm\Codebase::getPsalmTypeFromReflection($reflectionParams[0]->getType())
);
$this->assertSame(
'array<array-key, mixed>',
(string) \Psalm\Codebase::getPsalmTypeFromReflection($reflectionParams[1]->getType())
);
$this->assertSame(
2019-01-27 23:27:12 +01:00
'int|null',
(string) \Psalm\Codebase::getPsalmTypeFromReflection($reflectionParams[2]->getType())
);
$this->assertSame(
'string',
(string) \Psalm\Codebase::getPsalmTypeFromReflection($reflectionFunc->getReturnType())
);
}
2018-04-19 01:00:08 +02:00
/**
* @return void
*/
public function testValidCallMapType()
{
$callmap_types = \Psalm\Internal\Codebase\InternalCallMapHandler::getCallMap();
2019-01-09 03:44:50 +01:00
foreach ($callmap_types as $signature) {
$return_type = $signature[0] ?? null;
$param_type_1 = $signature[1] ?? null;
$param_type_2 = $signature[2] ?? null;
$param_type_3 = $signature[3] ?? null;
$param_type_4 = $signature[4] ?? null;
2018-04-19 01:00:08 +02:00
if ($return_type && $return_type !== 'void') {
if (stripos($return_type, 'oci-') !== false) {
2019-04-09 22:52:32 +02:00
continue;
}
try {
\Psalm\Type::parseString($return_type);
} catch (\Psalm\Exception\TypeParseTreeException $e) {
self::assertTrue(false, $e . ' | ' . print_r($signature, true));
}
2018-04-19 01:00:08 +02:00
}
if ($param_type_1 && $param_type_1 !== 'mixed') {
if (stripos($param_type_1, 'oci-') !== false) {
2019-04-09 22:52:32 +02:00
continue;
}
2018-04-19 01:00:08 +02:00
try {
\Psalm\Type::parseString($param_type_1);
} catch (\Psalm\Exception\TypeParseTreeException $e) {
self::assertTrue(false, $e . ' | ' . print_r($signature, true));
}
}
2018-04-19 01:00:08 +02:00
if ($param_type_2 && $param_type_2 !== 'mixed') {
try {
\Psalm\Type::parseString($param_type_2);
} catch (\Psalm\Exception\TypeParseTreeException $e) {
self::assertTrue(false, $e . ' | ' . print_r($signature, true));
}
}
2018-04-19 01:00:08 +02:00
if ($param_type_3 && $param_type_3 !== 'mixed') {
try {
\Psalm\Type::parseString($param_type_3);
} catch (\Psalm\Exception\TypeParseTreeException $e) {
self::assertTrue(false, $e . ' | ' . print_r($signature, true));
}
}
2018-04-19 01:00:08 +02:00
if ($param_type_4 && $param_type_4 !== 'mixed') {
try {
\Psalm\Type::parseString($param_type_4);
} catch (\Psalm\Exception\TypeParseTreeException $e) {
self::assertTrue(false, $e . ' | ' . print_r($signature, true));
}
}
}
2018-04-19 01:00:08 +02:00
}
}