Add parameter type hints to tests

doctrine · Sep 14, 2021 · fba6112 · fba6112
1 parent 38fc494
commit fba6112
Show file tree

Hide file tree

Showing 99 changed files with 439 additions and 216 deletions.
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -31,7 +31,6 @@
         <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification" />
 
         <!-- Will cause BC breaks to method signatures - disabled for now -->
-        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint" />
         <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint" />
         <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint" />
 
@@ -70,6 +69,10 @@
         <exclude-pattern>*/lib/*</exclude-pattern>
     </rule>
 
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint">
+        <exclude-pattern>*/lib/*</exclude-pattern>
+    </rule>
+
     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint">
         <!-- We do want to test generating collections without return types -->
         <exclude-pattern>*/tests/Doctrine/ODM/MongoDB/Tests/PersistentCollection/Coll*</exclude-pattern>

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/AggregationOperatorsProviderTrait.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/AggregationOperatorsProviderTrait.php
@@ -613,6 +613,9 @@ protected function createExpr(): Expr
         return new Expr($this->dm, new ClassMetadata(User::class));
     }
 
+    /**
+     * @param mixed $args
+     */
     protected function resolveArgs($args): array
     {
         if (is_array($args)) {

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/ExprTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/ExprTest.php
@@ -5,6 +5,7 @@
 namespace Doctrine\ODM\MongoDB\Tests\Aggregation;
 
 use BadMethodCallException;
+use Closure;
 use Doctrine\ODM\MongoDB\Aggregation\Expr;
 use Doctrine\ODM\MongoDB\Tests\BaseTest;
 use LogicException;
@@ -14,9 +15,11 @@ class ExprTest extends BaseTest
     use AggregationOperatorsProviderTrait;
 
     /**
+     * @param array|Closure $args
+     *
      * @dataProvider provideAllOperators
      */
-    public function testGenericOperator($expected, $operator, $args): void
+    public function testGenericOperator(array $expected, string $operator, $args): void
     {
         $expr = $this->createExpr();
         $args = $this->resolveArgs($args);
@@ -26,9 +29,11 @@ public function testGenericOperator($expected, $operator, $args): void
     }
 
     /**
+     * @param array|Closure $args
+     *
      * @dataProvider provideAllOperators
      */
-    public function testGenericOperatorWithField($expected, $operator, $args): void
+    public function testGenericOperatorWithField(array $expected, string $operator, $args): void
     {
         $expr = $this->createExpr();
         $args = $this->resolveArgs($args);

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GeoNearTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GeoNearTest.php
@@ -38,9 +38,11 @@ public function testGeoNearFromBuilder(): void
     }
 
     /**
+     * @param mixed $value
+     *
      * @dataProvider provideOptionalSettings
      */
-    public function testOptionalSettings($field, $value): void
+    public function testOptionalSettings(string $field, $value): void
     {
         $geoNearStage = new GeoNear($this->getTestAggregationBuilder(), 0, 0);
 

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GroupTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GroupTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\Tests\Aggregation\Stage;
 
+use Closure;
 use Doctrine\ODM\MongoDB\Aggregation\Expr;
 use Doctrine\ODM\MongoDB\Aggregation\Stage\Group;
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationOperatorsProviderTrait;
@@ -16,9 +17,11 @@ class GroupTest extends BaseTest
     use AggregationOperatorsProviderTrait;
 
     /**
+     * @param Closure|array $args
+     *
      * @dataProvider provideProxiedExprMethods
      */
-    public function testProxiedExprMethods($method, $args = []): void
+    public function testProxiedExprMethods(string $method, $args = []): void
     {
         $args = $this->resolveArgs($args);
 

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/MatchStageTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/MatchStageTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\Tests\Aggregation\Stage;
 
+use Closure;
 use DateTime;
 use Doctrine\ODM\MongoDB\Aggregation\Stage\MatchStage;
 use Doctrine\ODM\MongoDB\Query\Expr;
@@ -40,9 +41,11 @@ public function testMatchFromBuilder(): void
     }
 
     /**
+     * @param Closure|array $args
+     *
      * @dataProvider provideProxiedExprMethods
      */
-    public function testProxiedExprMethods($method, array $args = []): void
+    public function testProxiedExprMethods(string $method, $args = []): void
     {
         $expr = $this->getMockQueryExpr();
         $expr

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/OperatorTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/OperatorTest.php
@@ -5,6 +5,7 @@
 namespace Doctrine\ODM\MongoDB\Tests\Aggregation\Stage;
 
 use BadMethodCallException;
+use Closure;
 use Doctrine\ODM\MongoDB\Aggregation\Expr;
 use Doctrine\ODM\MongoDB\Aggregation\Stage\Operator;
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationOperatorsProviderTrait;
@@ -17,9 +18,11 @@ class OperatorTest extends BaseTest
     use AggregationOperatorsProviderTrait;
 
     /**
+     * @param Closure|array $args
+     *
      * @dataProvider provideExpressionOperators
      */
-    public function testProxiedExpressionOperators($expected, $operator, $args): void
+    public function testProxiedExpressionOperators(array $expected, string $operator, $args): void
     {
         $stage = $this->getStubStage();
         $args  = $this->resolveArgs($args);

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/ProjectTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/ProjectTest.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\Tests\Aggregation\Stage;
 
+use Closure;
 use Doctrine\ODM\MongoDB\Aggregation\Expr;
 use Doctrine\ODM\MongoDB\Aggregation\Stage\Project;
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationTestTrait;
@@ -44,7 +45,7 @@ public function testProjectFromBuilder(): void
     /**
      * @dataProvider provideAccumulators
      */
-    public function testAccumulatorsWithMultipleArguments($operator): void
+    public function testAccumulatorsWithMultipleArguments(string $operator): void
     {
         $projectStage = new Project($this->getTestAggregationBuilder());
         $projectStage
@@ -64,9 +65,11 @@ public function provideAccumulators(): array
     }
 
     /**
+     * @param Closure|array $args
+     *
      * @dataProvider provideProxiedExprMethods
      */
-    public function testProxiedExprMethods($method, $args = []): void
+    public function testProxiedExprMethods(string $method, $args = []): void
     {
         $expr = $this->getMockAggregationExpr();
         $expr

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/SortTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/SortTest.php
@@ -13,19 +13,23 @@ class SortTest extends BaseTest
     use AggregationTestTrait;
 
     /**
+     * @param string|array<string, string> $field
+     *
      * @dataProvider provideSortOptions
      */
-    public function testSortStage($expectedSort, $field, $order = null): void
+    public function testSortStage(array $expectedSort, $field, ?string $order = null): void
     {
         $sortStage = new Sort($this->getTestAggregationBuilder(), $field, $order);
 
         $this->assertSame(['$sort' => $expectedSort], $sortStage->getExpression());
     }
 
     /**
+     * @param string|array<string, string> $field
+     *
      * @dataProvider provideSortOptions
      */
-    public function testSortFromBuilder($expectedSort, $field, $order = null): void
+    public function testSortFromBuilder(array $expectedSort, $field, ?string $order = null): void
     {
         $builder = $this->getTestAggregationBuilder();
         $builder->sort($field, $order);

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/BaseTest.php b/tests/Doctrine/ODM/MongoDB/Tests/BaseTest.php
@@ -93,7 +93,7 @@ protected function getConfiguration(): Configuration
      *
      * @deprecated
      */
-    public static function assertArraySubset($subset, $array, bool $checkForObjectIdentity = false, string $message = ''): void
+    public static function assertArraySubset(array $subset, array $array, bool $checkForObjectIdentity = false, string $message = ''): void
     {
         foreach ($subset as $key => $value) {
             self::assertArrayHasKey($key, $array, $message);

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Events/LifecycleCallbacksTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Events/LifecycleCallbacksTest.php
@@ -13,7 +13,7 @@
 
 class LifecycleCallbacksTest extends BaseTest
 {
-    private function createUser($name = 'jon', $fullName = 'Jonathan H. Wage'): User
+    private function createUser(string $name = 'jon', string $fullName = 'Jonathan H. Wage'): User
     {
         $user                = new User();
         $user->name          = $name;

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Events/LifecycleListenersTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Events/LifecycleListenersTest.php
@@ -225,7 +225,7 @@ class MyEventListener
     /** @psalm-var array<string, list<class-string>> */
     public $called = [];
 
-    public function __call($method, $args)
+    public function __call(string $method, array $args)
     {
         $document                = $args[0]->getDocument();
         $className               = get_class($document);
@@ -245,7 +245,7 @@ class PostCollectionLoadEventListener
     /** @var TestCase */
     private $phpunit;
 
-    public function __construct($phpunit)
+    public function __construct(TestCase $phpunit)
     {
         $this->phpunit = $phpunit;
     }

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/AlsoLoadTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/AlsoLoadTest.php
@@ -317,7 +317,7 @@ class AlsoLoadDocument
     public $testOlder;
 
     /** @ODM\AlsoLoad({"name", "fullName"}) */
-    public function populateFirstAndLastName($name): void
+    public function populateFirstAndLastName(string $name): void
     {
         [$this->firstName, $this->lastName] = explode(' ', $name);
     }

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/AtomicSetTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/AtomicSetTest.php
@@ -90,6 +90,8 @@ public function testAtomicUpsert(): void
     }
 
     /**
+     * @param array|ArrayCollection|null $clearWith
+     *
      * @dataProvider provideAtomicCollectionUnset
      */
     public function testAtomicCollectionUnset($clearWith): void
@@ -119,6 +121,9 @@ public function testAtomicCollectionUnset($clearWith): void
         $this->assertCount(0, $user->phonenumbers);
     }
 
+    /**
+     * @return array<array{array|ArrayCollection|null}>
+     */
     public function provideAtomicCollectionUnset(): array
     {
         return [

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/BinDataTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/BinDataTest.php
@@ -15,7 +15,7 @@ class BinDataTest extends BaseTest
     /**
      * @dataProvider provideData
      */
-    public function testBinData($field, $data, $type): void
+    public function testBinData(string $field, string $data, int $type): void
     {
         $test         = new BinDataTestUser();
         $test->$field = $data;
@@ -28,6 +28,9 @@ public function testBinData($field, $data, $type): void
         $this->assertEquals($data, $check[$field]->getData());
     }
 
+    /**
+     * @return array<array{string, string, int}>
+     */
     public function provideData(): array
     {
         return [

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/CommitImprovementTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/CommitImprovementTest.php
@@ -158,7 +158,7 @@ public function getSubscribedEvents(): array
         ];
     }
 
-    public function __call($eventName, $args)
+    public function __call(string $eventName, array $args)
     {
         $document = $args[0]->getDocument();
         if (! ($document instanceof User)) {

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/CustomCollectionsTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/CustomCollectionsTest.php
@@ -291,7 +291,7 @@ public function getEnabled(): MyEmbedsCollection
         });
     }
 
-    public function move($i, $j): void
+    public function move(int $i, int $j): void
     {
         $tmp = $this->get($i);
         $this->set($i, $this->get($j));

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Functional/DateTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Functional/DateTest.php
@@ -38,6 +38,9 @@ public function testDates(): void
     }
 
     /**
+     * @param DateTime|UTCDateTime $oldValue
+     * @param DateTime|UTCDateTime $newValue
+     *
      * @dataProvider provideEquivalentDates
      */
     public function testDateInstanceChangeDoesNotCauseUpdateIfValueIsTheSame($oldValue, $newValue): void
@@ -55,6 +58,9 @@ public function testDateInstanceChangeDoesNotCauseUpdateIfValueIsTheSame($oldVal
         $this->assertEmpty($changeset);
     }
 
+    /**
+     * @return array<array{DateTime|UTCDateTime, DateTime|UTCDateTime}>
+     */
     public function provideEquivalentDates(): array
     {
         return [
@@ -76,6 +82,7 @@ public function testDateInstanceValueChangeDoesCauseUpdateIfValueIsTheSame(): vo
         $this->dm->clear();
 
         $user = $this->dm->getRepository(get_class($user))->findOneBy([]);
+        $this->assertInstanceOf(DateTime::class, $user->getCreatedAt());
         $user->getCreatedAt()->setTimestamp(time() - 3600);
 
         $this->dm->getUnitOfWork()->computeChangeSets();