1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 00:39:38 +01:00
psalm/tests/TypeComparatorTest.php

188 lines
5.4 KiB
PHP
Raw Normal View History

<?php
2023-10-19 13:12:06 +02:00
declare(strict_types=1);
namespace Psalm\Tests;
2021-12-03 20:11:20 +01:00
use Psalm\Internal\Analyzer\ProjectAnalyzer;
use Psalm\Internal\Provider\FakeFileProvider;
2021-12-03 20:11:20 +01:00
use Psalm\Internal\Provider\Providers;
use Psalm\Internal\RuntimeCaches;
2021-12-03 20:11:20 +01:00
use Psalm\Internal\Type\Comparator\UnionTypeComparator;
use Psalm\Internal\Type\TypeTokenizer;
use Psalm\Tests\Internal\Provider\FakeParserCacheProvider;
use Psalm\Type;
use Psalm\Type\Atomic\TPropertiesOf;
2021-12-03 21:07:25 +01:00
use function array_diff_key;
use function array_keys;
use function array_map;
class TypeComparatorTest extends TestCase
{
public function setUp(): void
{
RuntimeCaches::clearAll();
$this->file_provider = new FakeFileProvider();
$config = new TestConfig();
2021-12-03 20:11:20 +01:00
$providers = new Providers(
$this->file_provider,
2022-12-18 17:15:15 +01:00
new FakeParserCacheProvider(),
);
2021-12-03 20:11:20 +01:00
$this->project_analyzer = new ProjectAnalyzer(
$config,
2022-12-18 17:15:15 +01:00
$providers,
);
}
/**
* @dataProvider getAllBasicTypes
*/
public function testTypeAcceptsItself(string $type_string): void
{
2021-12-03 20:11:20 +01:00
$type_1 = Type::parseString($type_string);
$type_2 = Type::parseString($type_string);
$this->assertTrue(
2021-12-03 20:11:20 +01:00
UnionTypeComparator::isContainedBy(
$this->project_analyzer->getCodebase(),
$type_1,
2022-12-18 17:15:15 +01:00
$type_2,
),
);
}
/**
* @return array<array{string}>
*/
public function getAllBasicTypes(): array
{
// these types are not valid without generics attached
$basic_generic_types = [
'key-of' => true,
'arraylike-object' => true,
'value-of' => true,
'class-string-map' => true,
'int-mask-of' => true,
'int-mask' => true,
'pure-Closure' => true,
];
foreach (TPropertiesOf::tokenNames() as $token_name) {
$basic_generic_types[$token_name] = true;
}
2021-12-03 21:07:25 +01:00
$basic_types = array_diff_key(
2021-12-03 20:11:20 +01:00
TypeTokenizer::PSALM_RESERVED_WORDS,
$basic_generic_types,
[
'open-resource' => true, // unverifiable
'non-empty-countable' => true, // bit weird, maybe a bug?
Add support for strict arrays, fix type alias intersection, fix array_is_list assertion on non-lists (#8395) * Immutable CodeLocation * Remove excess clones * Remove external clones * Remove leftover clones * Fix final clone issue * Immutable storages * Refactoring * Fixes * Fixes * Fix * Fix * Fixes * Simplify * Fixes * Fix * Fixes * Update * Fix * Cache global types * Fix * Update * Update * Fixes * Fixes * Refactor * Fixes * Fix * Fix * More caching * Fix * Fix * Update * Update * Fix * Fixes * Update * Refactor * Update * Fixes * Break one more test * Fix * FIx * Fix * Fix * Fix * Fix * Improve performance and readability * Equivalent logic * Fixes * Revert * Revert "Revert" This reverts commit f9175100c8452c80559234200663fd4c4f4dd889. * Fix * Fix reference bug * Make default TypeVisitor immutable * Bugfix * Remove clones * Partial refactoring * Refactoring * Fixes * Fix * Fixes * Fixes * cs-fix * Fix final bugs * Add test * Misc fixes * Update * Fixes * Experiment with removing different property * revert "Experiment with removing different property" This reverts commit ac1156e077fc4ea633530d51096d27b6e88bfdf9. * Uniform naming * Uniform naming * Hack hotfix * Clean up $_FILES ref #8621 * Undo hack, try fixing properly * Helper method * Remove redundant call * Partially fix bugs * Cleanup * Change defaults * Fix bug * Fix (?, hope this doesn't break anything else) * cs-fix * Review fixes * Bugfix * Bugfix * Improve logic * Add support for list{} and callable-list{} types, properly implement array_is_list assertions (fixes #8389) * Default to sealed arrays * Fix array_merge bug * Fixes * Fix * Sealed type checks * Properly infer properties-of and get_object_vars on final classes * Fix array_map zipping * Fix tests * Fixes * Fixes * Fix more stuff * Recursively resolve type aliases * Fix typo * Fixes * Fix array_is_list assertion on keyed array * Add BC docs * Fixes * fix * Update * Update * Update * Update * Seal arrays with count assertions * Fix #8528 * Fix * Update * Improve sealed array foreach logic * get_object_vars on template properties * Fix sealed array assertion reconciler logic * Improved reconciler * Add tests * Single source of truth for test types * Fix tests * Fixup tests * Fixup tests * Fixup tests * Update * Fix tests * Fix tests * Final fixes * Fixes * Use list syntax only when needed * Fix tests * Cs-fix * Update docs * Update docs * Update docs * Update docs * Update docs * Document missing types * Update docs * Improve class-string-map docs * Update * Update * I love working on psalm :) * Keep arrays unsealed by default * Fixup tests * Fix syntax mistake * cs-fix * Fix typo * Re-import missing types * Keep strict types only in return types * argc/argv fixes * argc/argv fixes * Fix test * Comment-out valinor code, pinging @romm pls merge https://github.com/CuyZ/Valinor/pull/246 so we can add valinor to the psalm docs :)
2022-11-05 22:34:42 +01:00
],
[
'array' => true, // Requires a shape
'list' => true, // Requires a shape
2022-12-18 17:15:15 +01:00
],
);
$basic_types['array{test: 123}'] = true;
$basic_types['list{123}'] = true;
Add support for strict arrays, fix type alias intersection, fix array_is_list assertion on non-lists (#8395) * Immutable CodeLocation * Remove excess clones * Remove external clones * Remove leftover clones * Fix final clone issue * Immutable storages * Refactoring * Fixes * Fixes * Fix * Fix * Fixes * Simplify * Fixes * Fix * Fixes * Update * Fix * Cache global types * Fix * Update * Update * Fixes * Fixes * Refactor * Fixes * Fix * Fix * More caching * Fix * Fix * Update * Update * Fix * Fixes * Update * Refactor * Update * Fixes * Break one more test * Fix * FIx * Fix * Fix * Fix * Fix * Improve performance and readability * Equivalent logic * Fixes * Revert * Revert "Revert" This reverts commit f9175100c8452c80559234200663fd4c4f4dd889. * Fix * Fix reference bug * Make default TypeVisitor immutable * Bugfix * Remove clones * Partial refactoring * Refactoring * Fixes * Fix * Fixes * Fixes * cs-fix * Fix final bugs * Add test * Misc fixes * Update * Fixes * Experiment with removing different property * revert "Experiment with removing different property" This reverts commit ac1156e077fc4ea633530d51096d27b6e88bfdf9. * Uniform naming * Uniform naming * Hack hotfix * Clean up $_FILES ref #8621 * Undo hack, try fixing properly * Helper method * Remove redundant call * Partially fix bugs * Cleanup * Change defaults * Fix bug * Fix (?, hope this doesn't break anything else) * cs-fix * Review fixes * Bugfix * Bugfix * Improve logic * Add support for list{} and callable-list{} types, properly implement array_is_list assertions (fixes #8389) * Default to sealed arrays * Fix array_merge bug * Fixes * Fix * Sealed type checks * Properly infer properties-of and get_object_vars on final classes * Fix array_map zipping * Fix tests * Fixes * Fixes * Fix more stuff * Recursively resolve type aliases * Fix typo * Fixes * Fix array_is_list assertion on keyed array * Add BC docs * Fixes * fix * Update * Update * Update * Update * Seal arrays with count assertions * Fix #8528 * Fix * Update * Improve sealed array foreach logic * get_object_vars on template properties * Fix sealed array assertion reconciler logic * Improved reconciler * Add tests * Single source of truth for test types * Fix tests * Fixup tests * Fixup tests * Fixup tests * Update * Fix tests * Fix tests * Final fixes * Fixes * Use list syntax only when needed * Fix tests * Cs-fix * Update docs * Update docs * Update docs * Update docs * Update docs * Document missing types * Update docs * Improve class-string-map docs * Update * Update * I love working on psalm :) * Keep arrays unsealed by default * Fixup tests * Fix syntax mistake * cs-fix * Fix typo * Re-import missing types * Keep strict types only in return types * argc/argv fixes * argc/argv fixes * Fix test * Comment-out valinor code, pinging @romm pls merge https://github.com/CuyZ/Valinor/pull/246 so we can add valinor to the psalm docs :)
2022-11-05 22:34:42 +01:00
2021-12-03 21:07:25 +01:00
return array_map(
2023-10-21 20:45:09 +02:00
static fn($type) => [$type],
2022-12-18 17:15:15 +01:00
array_keys($basic_types),
);
}
2021-04-27 17:26:27 +02:00
/**
* @dataProvider getSuccessfulComparisons
2021-04-27 17:26:27 +02:00
*/
public function testTypeAcceptsType(string $parent_type_string, string $child_type_string): void
{
2021-12-03 20:11:20 +01:00
$parent_type = Type::parseString($parent_type_string);
$child_type = Type::parseString($child_type_string);
2021-04-27 17:26:27 +02:00
$this->assertTrue(
2021-12-03 20:11:20 +01:00
UnionTypeComparator::isContainedBy(
2021-04-27 17:26:27 +02:00
$this->project_analyzer->getCodebase(),
$child_type,
2022-12-18 17:15:15 +01:00
$parent_type,
),
'Type ' . $parent_type_string . ' should contain ' . $child_type_string,
);
}
/**
* @dataProvider getUnsuccessfulComparisons
*/
public function testTypeDoesNotAcceptType(string $parent_type_string, string $child_type_string): void
{
$parent_type = Type::parseString($parent_type_string);
$child_type = Type::parseString($child_type_string);
$this->assertFalse(
UnionTypeComparator::isContainedBy(
$this->project_analyzer->getCodebase(),
$child_type,
$parent_type,
),
'Type ' . $parent_type_string . ' should not contain ' . $child_type_string,
2021-04-27 17:26:27 +02:00
);
}
/**
* @return array<array{string, string}>
2021-04-27 17:26:27 +02:00
*/
public function getSuccessfulComparisons(): array
2021-04-27 17:26:27 +02:00
{
return [
'iterableAcceptsArray' => [
'iterable',
'array',
],
'listAcceptsEmptyArray' => [
'list',
2021-10-13 19:37:47 +02:00
'array<never, never>',
],
'arrayAcceptsEmptyArray' => [
'array',
2021-10-13 19:37:47 +02:00
'array<never, never>',
],
'arrayOptionalKeyed1AcceptsEmptyArray' => [
'array{foo?: string}',
2021-10-13 19:37:47 +02:00
'array<never, never>',
],
'arrayOptionalKeyed2AcceptsEmptyArray' => [
'array{foo?: string}&array<string, mixed>',
2021-10-13 19:37:47 +02:00
'array<never, never>',
2021-04-27 17:26:27 +02:00
],
'Lowercase-stringAndCallable-string' => [
'lowercase-string',
'callable-string',
],
'callableUnionAcceptsCallableUnion' => [
2023-04-19 12:37:06 +02:00
'(callable(int,string[]): void)|(callable(int): void)',
'(callable(int): void)|(callable(int,string[]): void)',
],
2021-04-27 17:26:27 +02:00
];
}
/** @return iterable<string, list{string,string}> */
public function getUnsuccessfulComparisons(): iterable
{
yield 'genericListDoesNotAcceptListTupleWithMismatchedTypes' => [
'list<int>',
'list{int, string}',
];
yield 'genericListDoesNotAcceptArrayTupleWithMismatchedTypes' => [
'list<int>',
'array{int, string}',
];
yield 'nonEmptyMixedDoesNotAcceptMixed' => [
'non-empty-mixed',
'mixed',
];
}
}