Use attributes in tests (#2596)

* Use attributes for tests * Use attributes for benchmark * Use attributes in tools/sandbox/Documents * Change more annotations to attributes * Ignore known SA errors
doctrine · Mar 6, 2024 · 8c7fa3f · 8c7fa3f
1 parent ac2f60b
commit 8c7fa3f
Show file tree

Hide file tree

Showing 278 changed files with 3,318 additions and 7,375 deletions.
diff --git a/benchmark/BaseBench.php b/benchmark/BaseBench.php
@@ -6,7 +6,7 @@
 
 use Doctrine\ODM\MongoDB\Configuration;
 use Doctrine\ODM\MongoDB\DocumentManager;
-use Doctrine\ODM\MongoDB\Mapping\Driver\AnnotationDriver;
+use Doctrine\ODM\MongoDB\Mapping\Driver\AttributeDriver;
 use MongoDB\Client;
 use MongoDB\Model\DatabaseInfo;
 use PhpBench\Benchmark\Metadata\Annotations\BeforeMethods;
@@ -80,8 +80,8 @@ public function clearDatabase(): void
         }
     }
 
-    protected static function createMetadataDriverImpl(): AnnotationDriver
+    protected static function createMetadataDriverImpl(): AttributeDriver
     {
-        return AnnotationDriver::create(__DIR__ . '/../tests/Documents');
+        return AttributeDriver::create(__DIR__ . '/../tests/Documents');
     }
 }
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -790,6 +790,16 @@ parameters:
 			count: 1
 			path: tests/Doctrine/ODM/MongoDB/Tests/Functional/NestedDocumentsTest.php
 
+		-
+			message: "#^Parameter \\$discriminatorMap of attribute class Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\Annotations\\\\ReferenceOne constructor expects array\\<string, class\\-string\\>\\|null, array\\<string, string\\> given\\.$#"
+			count: 1
+			path: tests/Doctrine/ODM/MongoDB/Tests/Functional/TargetDocumentTest.php
+
+		-
+			message: "#^Parameter \\$targetDocument of attribute class Doctrine\\\\ODM\\\\MongoDB\\\\Mapping\\\\Annotations\\\\ReferenceOne constructor expects class\\-string\\|null, string given\\.$#"
+			count: 1
+			path: tests/Doctrine/ODM/MongoDB/Tests/Functional/TargetDocumentTest.php
+
 		-
 			message: "#^Property Doctrine\\\\ODM\\\\MongoDB\\\\Tests\\\\Functional\\\\Ticket\\\\GH1058PersistDocument\\:\\:\\$id is never written, only read\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -391,6 +391,11 @@
       <code><![CDATA[['upsert' => true]]]></code>
     </InvalidArgument>
   </file>
+  <file src="tests/Doctrine/ODM/MongoDB/Tests/Functional/TargetDocumentTest.php">
+    <UndefinedClass>
+      <code><![CDATA[['Foo' => 'Doctrine\ODM\MongoDB\Tests\Functional\SomeInvalidClass']]]></code>
+    </UndefinedClass>
+  </file>
   <file src="tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH1011Test.php">
     <InvalidArgument>
       <code><![CDATA[$doc->embeds]]></code>

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/BaseTestCase.php b/tests/Doctrine/ODM/MongoDB/Tests/BaseTestCase.php
@@ -6,7 +6,7 @@
 
 use Doctrine\ODM\MongoDB\Configuration;
 use Doctrine\ODM\MongoDB\DocumentManager;
-use Doctrine\ODM\MongoDB\Mapping\Driver\AnnotationDriver;
+use Doctrine\ODM\MongoDB\Mapping\Driver\AttributeDriver;
 use Doctrine\ODM\MongoDB\Tests\Query\Filter\Filter;
 use Doctrine\ODM\MongoDB\UnitOfWork;
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
@@ -116,7 +116,7 @@ public static function assertArraySubset(array $subset, array $array, bool $chec
 
     protected static function createMetadataDriverImpl(): MappingDriver
     {
-        return AnnotationDriver::create(__DIR__ . '/../../../../Documents');
+        return AttributeDriver::create(__DIR__ . '/../../../../Documents');
     }
 
     protected static function createTestDocumentManager(): DocumentManager

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/DocumentManagerTest.php b/tests/Doctrine/ODM/MongoDB/Tests/DocumentManagerTest.php
@@ -231,59 +231,38 @@ public function testDifferentStoreAsDbReferences(): void
     }
 }
 
-/** @ODM\Document */
+#[ODM\Document]
 class WrongSimpleRefDocument
 {
-    /**
-     * @ODM\Id
-     *
-     * @var string|null
-     */
+    /** @var string|null */
+    #[ODM\Id]
     public $id;
 
-    /**
-     * @ODM\ReferenceOne(targetDocument=Documents\Tournament\Participant::class, storeAs="id")
-     *
-     * @var Participant|null
-     */
+    /** @var Participant|null */
+    #[ODM\ReferenceOne(targetDocument: Participant::class, storeAs: 'id')]
     public $ref;
 }
 
-/** @ODM\Document */
+#[ODM\Document]
 class ReferenceStoreAsDocument
 {
-    /**
-     * @ODM\Id
-     *
-     * @var string|null
-     */
+    /** @var string|null */
+    #[ODM\Id]
     public $id;
 
-    /**
-     * @ODM\ReferenceOne(targetDocument=User::class, storeAs="id")
-     *
-     * @var User|null
-     */
+    /** @var User|null */
+    #[ODM\ReferenceOne(targetDocument: User::class, storeAs: 'id')]
     public $ref1;
 
-    /**
-     * @ODM\ReferenceOne(targetDocument=User::class, storeAs="dbRef")
-     *
-     * @var Collection<int, User>
-     */
+    /** @var Collection<int, User> */
+    #[ODM\ReferenceOne(targetDocument: User::class, storeAs: 'dbRef')]
     public $ref2;
 
-    /**
-     * @ODM\ReferenceOne(targetDocument=User::class, storeAs="dbRefWithDb")
-     *
-     * @var Collection<int, User>
-     */
+    /** @var Collection<int, User> */
+    #[ODM\ReferenceOne(targetDocument: User::class, storeAs: 'dbRefWithDb')]
     public $ref3;
 
-    /**
-     * @ODM\ReferenceOne(targetDocument=User::class, storeAs="ref")
-     *
-     * @var Collection<int, User>
-     */
+    /** @var Collection<int, User> */
+    #[ODM\ReferenceOne(targetDocument: User::class, storeAs: 'ref')]
     public $ref4;
 }
diff --git a/tests/Doctrine/ODM/MongoDB/Tests/Events/LifecycleCallbacksTest.php b/tests/Doctrine/ODM/MongoDB/Tests/Events/LifecycleCallbacksTest.php
@@ -246,110 +246,72 @@ public function testEventsNotFiredForInverseSide(): void
     }
 }
 
-/** @ODM\Document */
+#[ODM\Document]
 class User extends BaseDocument
 {
-    /**
-     * @ODM\Id
-     *
-     * @var string|null
-     */
+    /** @var string|null */
+    #[ODM\Id]
     public $id;
 
-    /**
-     * @ODM\EmbedOne(targetDocument=Profile::class)
-     *
-     * @var Profile|null
-     */
+    /** @var Profile|null */
+    #[ODM\EmbedOne(targetDocument: Profile::class)]
     public $profile;
 
-    /**
-     * @ODM\EmbedMany(targetDocument=Profile::class)
-     *
-     * @var Collection<int, Profile>|array<Profile>
-     */
+    /** @var Collection<int, Profile>|array<Profile> */
+    #[ODM\EmbedMany(targetDocument: Profile::class)]
     public $profiles = [];
 
-    /**
-     * @ODM\ReferenceMany(targetDocument=User::class)
-     *
-     * @var Collection<int, User>|array<User>
-     */
+    /** @var Collection<int, User>|array<User> */
+    #[ODM\ReferenceMany(targetDocument: self::class)]
     public $friends = [];
 }
 
-/** @ODM\Document */
+#[ODM\Document]
 class Cart extends BaseDocument
 {
-    /**
-     * @ODM\Id
-     *
-     * @var string|null
-     */
+    /** @var string|null */
+    #[ODM\Id]
     public $id;
 
-    /**
-     * @ODM\ReferenceOne(targetDocument=Customer::class, inversedBy="cart")
-     *
-     * @var Customer|null
-     */
+    /** @var Customer|null */
+    #[ODM\ReferenceOne(targetDocument: Customer::class, inversedBy: 'cart')]
     public $customer;
 }
 
-/** @ODM\Document */
+#[ODM\Document]
 class Customer extends BaseDocument
 {
-    /**
-     * @ODM\Id
-     *
-     * @var string|null
-     */
+    /** @var string|null */
+    #[ODM\Id]
     public $id;
 
-    /**
-     * @ODM\ReferenceOne(targetDocument=Cart::class, mappedBy="customer")
-     *
-     * @var Cart|null
-     */
+    /** @var Cart|null */
+    #[ODM\ReferenceOne(targetDocument: Cart::class, mappedBy: 'customer')]
     public $cart;
 }
 
-/** @ODM\EmbeddedDocument */
+#[ODM\EmbeddedDocument]
 class Profile extends BaseDocument
 {
-    /**
-     * @ODM\EmbedOne(targetDocument=Profile::class)
-     *
-     * @var Profile|null
-     */
+    /** @var Profile|null */
+    #[ODM\EmbedOne(targetDocument: self::class)]
     public $profile;
 }
 
-/**
- * @ODM\MappedSuperclass
- * @ODM\HasLifecycleCallbacks
- */
+#[ODM\MappedSuperclass]
+#[ODM\HasLifecycleCallbacks]
 abstract class BaseDocument
 {
-    /**
-     * @ODM\Field(type="string")
-     *
-     * @var string|null
-     */
+    /** @var string|null */
+    #[ODM\Field(type: 'string')]
     public $name;
 
-    /**
-     * @ODM\Field(type="date")
-     *
-     * @var DateTime
-     */
+    /** @var DateTime */
+    #[ODM\Field(type: 'date')]
     public $createdAt;
 
-    /**
-     * @ODM\Field(type="date")
-     *
-     * @var DateTime|null
-     */
+    /** @var DateTime|null */
+    #[ODM\Field(type: 'date')]
     public $updatedAt;
 
     /** @var bool */
@@ -379,57 +341,57 @@ abstract class BaseDocument
     /** @var bool */
     public $preFlush = false;
 
-    /** @ODM\PrePersist */
+    #[ODM\PrePersist]
     public function prePersist(Event\LifecycleEventArgs $e): void
     {
         $this->prePersist = true;
         $this->createdAt  = new DateTime();
     }
 
-    /** @ODM\PostPersist */
+    #[ODM\PostPersist]
     public function postPersist(Event\LifecycleEventArgs $e): void
     {
         $this->postPersist = true;
     }
 
-    /** @ODM\PreUpdate */
+    #[ODM\PreUpdate]
     public function preUpdate(Event\PreUpdateEventArgs $e): void
     {
         $this->preUpdate = true;
         $this->updatedAt = new DateTime();
     }
 
-    /** @ODM\PostUpdate */
+    #[ODM\PostUpdate]
     public function postUpdate(Event\LifecycleEventArgs $e): void
     {
         $this->postUpdate = true;
     }
 
-    /** @ODM\PreRemove */
+    #[ODM\PreRemove]
     public function preRemove(Event\LifecycleEventArgs $e): void
     {
         $this->preRemove = true;
     }
 
-    /** @ODM\PostRemove */
+    #[ODM\PostRemove]
     public function postRemove(Event\LifecycleEventArgs $e): void
     {
         $this->postRemove = true;
     }
 
-    /** @ODM\PreLoad */
+    #[ODM\PreLoad]
     public function preLoad(Event\PreLoadEventArgs $e): void
     {
         $this->preLoad = true;
     }
 
-    /** @ODM\PostLoad */
+    #[ODM\PostLoad]
     public function postLoad(Event\LifecycleEventArgs $e): void
     {
         $this->postLoad = true;
     }
 
-    /** @ODM\PreFlush */
+    #[ODM\PreFlush]
     public function preFlush(Event\PreFlushEventArgs $e): void
     {
         $this->preFlush = true;