Use PHPUnit attributes instead of annotations

doctrine · Oct 29, 2023 · 5e64564 · 5e64564
1 parent f12e48c
commit 5e64564
Show file tree

Hide file tree

Showing 65 changed files with 387 additions and 571 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -981,12 +981,12 @@ parameters:
 			path: tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataLoadEventTest.php
 
 		-
-			message: "#^Parameter \\#1 \\$mapping of method Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\ClassMetadata\\<class@anonymous/tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataTest\\.php\\:230\\>\\:\\:mapField\\(\\) expects array\\{type\\?\\: string, fieldName\\?\\: string, name\\?\\: string, strategy\\?\\: string, association\\?\\: int, id\\?\\: bool, isOwningSide\\?\\: bool, collectionClass\\?\\: class\\-string, \\.\\.\\.\\}, array\\{fieldName\\: 'enum', enumType\\: 'Documents\\\\\\\\Card'\\} given\\.$#"
+			message: "#^Parameter \\#1 \\$mapping of method Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\ClassMetadata\\<class@anonymous/tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataTest\\.php\\:231\\>\\:\\:mapField\\(\\) expects array\\{type\\?\\: string, fieldName\\?\\: string, name\\?\\: string, strategy\\?\\: string, association\\?\\: int, id\\?\\: bool, isOwningSide\\?\\: bool, collectionClass\\?\\: class\\-string, \\.\\.\\.\\}, array\\{fieldName\\: 'enum', enumType\\: 'Documents\\\\\\\\Card'\\} given\\.$#"
 			count: 1
 			path: tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataTest.php
 
 		-
-			message: "#^Parameter \\#1 \\$mapping of method Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\ClassMetadata\\<class@anonymous/tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataTest\\.php\\:249\\>\\:\\:mapField\\(\\) expects array\\{type\\?\\: string, fieldName\\?\\: string, name\\?\\: string, strategy\\?\\: string, association\\?\\: int, id\\?\\: bool, isOwningSide\\?\\: bool, collectionClass\\?\\: class\\-string, \\.\\.\\.\\}, array\\{fieldName\\: 'enum', enumType\\: 'Documents\\\\\\\\SuitNonBacked'\\} given\\.$#"
+			message: "#^Parameter \\#1 \\$mapping of method Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\ClassMetadata\\<class@anonymous/tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataTest\\.php\\:250\\>\\:\\:mapField\\(\\) expects array\\{type\\?\\: string, fieldName\\?\\: string, name\\?\\: string, strategy\\?\\: string, association\\?\\: int, id\\?\\: bool, isOwningSide\\?\\: bool, collectionClass\\?\\: class\\-string, \\.\\.\\.\\}, array\\{fieldName\\: 'enum', enumType\\: 'Documents\\\\\\\\SuitNonBacked'\\} given\\.$#"
 			count: 1
 			path: tests/Doctrine/ODM/MongoDB/Tests/Mapping/ClassMetadataTest.php
 

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/ExprTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/ExprTest.php
@@ -9,6 +9,7 @@
 use Doctrine\ODM\MongoDB\Aggregation\Expr;
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
 use LogicException;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class ExprTest extends BaseTestCase
 {
@@ -17,26 +18,25 @@ class ExprTest extends BaseTestCase
     /**
      * @param array<string, string>          $expected
      * @param Closure(Expr): mixed[]|mixed[] $args
-     *
-     * @dataProvider provideAccumulatorExpressionOperators
-     * @dataProvider provideArithmeticExpressionOperators
-     * @dataProvider provideArrayExpressionOperators
-     * @dataProvider provideBooleanExpressionOperators
-     * @dataProvider provideComparisonExpressionOperators
-     * @dataProvider provideConditionalExpressionOperators
-     * @dataProvider provideCustomExpressionOperators
-     * @dataProvider provideDataSizeExpressionOperators
-     * @dataProvider provideDateExpressionOperators
-     * @dataProvider provideGroupAccumulatorExpressionOperators
-     * @dataProvider provideMiscExpressionOperators
-     * @dataProvider provideObjectExpressionOperators
-     * @dataProvider provideSetExpressionOperators
-     * @dataProvider provideStringExpressionOperators
-     * @dataProvider provideTimestampExpressionOperators
-     * @dataProvider provideTrigonometryExpressionOperators
-     * @dataProvider provideTypeExpressionOperators
-     * @dataProvider provideWindowExpressionOperators
      */
+    #[DataProvider('provideAccumulatorExpressionOperators')]
+    #[DataProvider('provideArithmeticExpressionOperators')]
+    #[DataProvider('provideArrayExpressionOperators')]
+    #[DataProvider('provideBooleanExpressionOperators')]
+    #[DataProvider('provideComparisonExpressionOperators')]
+    #[DataProvider('provideConditionalExpressionOperators')]
+    #[DataProvider('provideCustomExpressionOperators')]
+    #[DataProvider('provideDataSizeExpressionOperators')]
+    #[DataProvider('provideDateExpressionOperators')]
+    #[DataProvider('provideGroupAccumulatorExpressionOperators')]
+    #[DataProvider('provideMiscExpressionOperators')]
+    #[DataProvider('provideObjectExpressionOperators')]
+    #[DataProvider('provideSetExpressionOperators')]
+    #[DataProvider('provideStringExpressionOperators')]
+    #[DataProvider('provideTimestampExpressionOperators')]
+    #[DataProvider('provideTrigonometryExpressionOperators')]
+    #[DataProvider('provideTypeExpressionOperators')]
+    #[DataProvider('provideWindowExpressionOperators')]
     public function testGenericOperator(array $expected, string $operator, $args): void
     {
         $expr = $this->createExpr();
@@ -49,26 +49,25 @@ public function testGenericOperator(array $expected, string $operator, $args): v
     /**
      * @param array<string, string>          $expected
      * @param Closure(Expr): mixed[]|mixed[] $args
-     *
-     * @dataProvider provideAccumulatorExpressionOperators
-     * @dataProvider provideArithmeticExpressionOperators
-     * @dataProvider provideArrayExpressionOperators
-     * @dataProvider provideBooleanExpressionOperators
-     * @dataProvider provideComparisonExpressionOperators
-     * @dataProvider provideConditionalExpressionOperators
-     * @dataProvider provideCustomExpressionOperators
-     * @dataProvider provideDataSizeExpressionOperators
-     * @dataProvider provideDateExpressionOperators
-     * @dataProvider provideGroupAccumulatorExpressionOperators
-     * @dataProvider provideMiscExpressionOperators
-     * @dataProvider provideObjectExpressionOperators
-     * @dataProvider provideSetExpressionOperators
-     * @dataProvider provideStringExpressionOperators
-     * @dataProvider provideTimestampExpressionOperators
-     * @dataProvider provideTrigonometryExpressionOperators
-     * @dataProvider provideTypeExpressionOperators
-     * @dataProvider provideWindowExpressionOperators
      */
+    #[DataProvider('provideAccumulatorExpressionOperators')]
+    #[DataProvider('provideArithmeticExpressionOperators')]
+    #[DataProvider('provideArrayExpressionOperators')]
+    #[DataProvider('provideBooleanExpressionOperators')]
+    #[DataProvider('provideComparisonExpressionOperators')]
+    #[DataProvider('provideConditionalExpressionOperators')]
+    #[DataProvider('provideCustomExpressionOperators')]
+    #[DataProvider('provideDataSizeExpressionOperators')]
+    #[DataProvider('provideDateExpressionOperators')]
+    #[DataProvider('provideGroupAccumulatorExpressionOperators')]
+    #[DataProvider('provideMiscExpressionOperators')]
+    #[DataProvider('provideObjectExpressionOperators')]
+    #[DataProvider('provideSetExpressionOperators')]
+    #[DataProvider('provideStringExpressionOperators')]
+    #[DataProvider('provideTimestampExpressionOperators')]
+    #[DataProvider('provideTrigonometryExpressionOperators')]
+    #[DataProvider('provideTypeExpressionOperators')]
+    #[DataProvider('provideWindowExpressionOperators')]
     public function testGenericOperatorWithField(array $expected, string $operator, $args): void
     {
         $expr = $this->createExpr();

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/BucketAutoTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/BucketAutoTest.php
@@ -13,6 +13,7 @@
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
 use Documents\CmsComment;
 use Documents\User;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class BucketAutoTest extends BaseTestCase
 {
@@ -22,9 +23,8 @@ class BucketAutoTest extends BaseTestCase
     /**
      * @param array<string, string>          $expected
      * @param mixed[]|Closure(Expr): mixed[] $args
-     *
-     * @dataProvider provideGroupAccumulatorExpressionOperators
      */
+    #[DataProvider('provideGroupAccumulatorExpressionOperators')]
     public function testGroupAccumulators(array $expected, string $operator, $args): void
     {
         $args = $this->resolveArgs($args);

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/BucketTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/BucketTest.php
@@ -13,6 +13,7 @@
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
 use Documents\CmsComment;
 use Documents\User;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class BucketTest extends BaseTestCase
 {
@@ -22,9 +23,8 @@ class BucketTest extends BaseTestCase
     /**
      * @param array<string, string>          $expected
      * @param mixed[]|Closure(Expr): mixed[] $args
-     *
-     * @dataProvider provideGroupAccumulatorExpressionOperators
      */
+    #[DataProvider('provideGroupAccumulatorExpressionOperators')]
     public function testGroupAccumulators(array $expected, string $operator, $args): void
     {
         $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
@@ -7,6 +7,7 @@
 use Doctrine\ODM\MongoDB\Aggregation\Stage\GeoNear;
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationTestTrait;
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class GeoNearTest extends BaseTestCase
 {
@@ -37,11 +38,8 @@ public function testFromBuilder(): void
         self::assertSame([['$geoNear' => $stage]], $builder->getPipeline());
     }
 
-    /**
-     * @param mixed $value
-     *
-     * @dataProvider provideOptionalSettings
-     */
+    /** @param mixed $value */
+    #[DataProvider('provideOptionalSettings')]
     public function testOptionalSettings(string $field, $value): void
     {
         $geoNearStage = new GeoNear($this->getTestAggregationBuilder(), 0, 0);

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GraphLookupTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GraphLookupTest.php
@@ -16,6 +16,7 @@
 use Documents\GraphLookup\ReportingHierarchy;
 use Documents\GraphLookup\Traveller;
 use Documents\User;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 use function array_merge;
 use function count;
@@ -149,9 +150,8 @@ public static function provideEmployeeAggregations(): array
     /**
      * @param Closure(Builder): GraphLookup $addGraphLookupStage
      * @param array<string, string>         $expectedFields
-     *
-     * @dataProvider provideEmployeeAggregations
      */
+    #[DataProvider('provideEmployeeAggregations')]
     public function testWithEmployees(Closure $addGraphLookupStage, array $expectedFields): void
     {
         $this->insertEmployeeTestData();
@@ -222,9 +222,8 @@ public static function provideTravellerAggregations(): array
     /**
      * @param Closure(Builder): GraphLookup $addGraphLookupStage
      * @param array<string, string>         $expectedFields
-     *
-     * @dataProvider provideTravellerAggregations
      */
+    #[DataProvider('provideTravellerAggregations')]
     public function testWithTraveller(Closure $addGraphLookupStage, array $expectedFields): void
     {
         $this->insertTravellerTestData();

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GroupTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/GroupTest.php
@@ -10,6 +10,7 @@
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationOperatorsProviderTrait;
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationTestTrait;
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class GroupTest extends BaseTestCase
 {
@@ -19,9 +20,8 @@ class GroupTest extends BaseTestCase
     /**
      * @param array<string, string>          $expected
      * @param mixed[]|Closure(Expr): mixed[] $args
-     *
-     * @dataProvider provideGroupAccumulatorExpressionOperators
      */
+    #[DataProvider('provideGroupAccumulatorExpressionOperators')]
     public function testGroupAccumulators(array $expected, string $operator, $args): void
     {
         $groupStage = new Group($this->getTestAggregationBuilder());

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/MergeTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/MergeTest.php
@@ -10,6 +10,7 @@
 use Documents\User;
 use Generator;
 use InvalidArgumentException;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 use function is_callable;
 
@@ -80,11 +81,8 @@ public static function providePipeline(): Generator
         ];
     }
 
-    /**
-     * @param array<array<string, mixed>>|callable $pipeline
-     *
-     * @dataProvider providePipeline
-     */
+    /** @param array<array<string, mixed>>|callable $pipeline */
+    #[DataProvider('providePipeline')]
     public function testStageWithPipeline($pipeline): void
     {
         if (is_callable($pipeline)) {

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/OperatorTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/OperatorTest.php
@@ -11,6 +11,7 @@
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationOperatorsProviderTrait;
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationTestTrait;
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class OperatorTest extends BaseTestCase
 {
@@ -20,23 +21,22 @@ class OperatorTest extends BaseTestCase
     /**
      * @param array<string, mixed>           $expected
      * @param mixed[]|Closure(Expr): mixed[] $args
-     *
-     * @dataProvider provideAccumulatorExpressionOperators
-     * @dataProvider provideArithmeticExpressionOperators
-     * @dataProvider provideArrayExpressionOperators
-     * @dataProvider provideBooleanExpressionOperators
-     * @dataProvider provideComparisonExpressionOperators
-     * @dataProvider provideConditionalExpressionOperators
-     * @dataProvider provideDataSizeExpressionOperators
-     * @dataProvider provideDateExpressionOperators
-     * @dataProvider provideMiscExpressionOperators
-     * @dataProvider provideObjectExpressionOperators
-     * @dataProvider provideSetExpressionOperators
-     * @dataProvider provideStringExpressionOperators
-     * @dataProvider provideTimestampExpressionOperators
-     * @dataProvider provideTrigonometryExpressionOperators
-     * @dataProvider provideTypeExpressionOperators
      */
+    #[DataProvider('provideAccumulatorExpressionOperators')]
+    #[DataProvider('provideArithmeticExpressionOperators')]
+    #[DataProvider('provideArrayExpressionOperators')]
+    #[DataProvider('provideBooleanExpressionOperators')]
+    #[DataProvider('provideComparisonExpressionOperators')]
+    #[DataProvider('provideConditionalExpressionOperators')]
+    #[DataProvider('provideDataSizeExpressionOperators')]
+    #[DataProvider('provideDateExpressionOperators')]
+    #[DataProvider('provideMiscExpressionOperators')]
+    #[DataProvider('provideObjectExpressionOperators')]
+    #[DataProvider('provideSetExpressionOperators')]
+    #[DataProvider('provideStringExpressionOperators')]
+    #[DataProvider('provideTimestampExpressionOperators')]
+    #[DataProvider('provideTrigonometryExpressionOperators')]
+    #[DataProvider('provideTypeExpressionOperators')]
     public function testProxiedExpressionOperators(array $expected, string $operator, $args): void
     {
         $stage = $this->getStubStage();

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/ProjectTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Aggregation/Stage/ProjectTest.php
@@ -8,6 +8,7 @@
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationOperatorsProviderTrait;
 use Doctrine\ODM\MongoDB\Tests\Aggregation\AggregationTestTrait;
 use Doctrine\ODM\MongoDB\Tests\BaseTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class ProjectTest extends BaseTestCase
 {
@@ -39,7 +40,7 @@ public function testFromBuilder(): void
         self::assertSame([['$project' => ['_id' => false, '$field' => true, '$otherField' => true, 'product' => ['$multiply' => ['$field', 5]]]]], $builder->getPipeline());
     }
 
-    /** @dataProvider provideAccumulatorExpressionOperators */
+    #[DataProvider('provideAccumulatorExpressionOperators')]
     public function testAccumulatorsWithMultipleArguments(array $expected, string $operator, $args): void
     {
         $projectStage = new Project($this->getTestAggregationBuilder());