Run tests without doctrine/annotations installed (#2781)

* Add a test build with doctrine/annotations uninstalled

* Update tests to only register either the annotation or attribute driver to avoid unintended overwrites due to namespaces

* Don't fail fast to let all jobs run

* Need new coverage artifact names for no-annotations builds

.github/workflows/continuous-integration.yml

@@ -11,7 +11,7 @@ env:
 
 jobs:
  phpunit:
- name: "PHPUnit ${{ matrix.php-version }} (${{ matrix.deps }})"
+ name: "PHPUnit ${{ matrix.php-version }} (${{ matrix.deps }})${{ matrix.no-annotations == true && ' - Without Annotations' || '' }}"
  runs-on: "ubuntu-20.04"
 
  services:
@@ -21,6 +21,7 @@ jobs:
  - 27017:27017
 
  strategy:
+ fail-fast: false
  matrix:
  php-version:
  - "7.4"
@@ -30,11 +31,19 @@ jobs:
  - "8.3"
  deps:
  - "highest"
+ no-annotations:
+ - false
  include:
  - deps: "lowest"
  php-version: "7.4"
  - deps: "highest"
  php-version: "8.3"
+ - deps: "highest"
+ php-version: "7.4"
+ no-annotations: true
+ - deps: "highest"
+ php-version: "8.3"
+ no-annotations: true
 
  steps:
  - name: "Checkout"
@@ -53,6 +62,11 @@ jobs:
  - name: "Remove PHP-CS-Fixer"
  run: "composer remove --dev --no-update friendsofphp/php-cs-fixer"
 
+ # Remove doctrine/annotations if configured to do so
+ - name: "Remove doctrine/annotations"
+ if: "${{ matrix.no-annotations }}"
+ run: "composer remove --dev --no-update doctrine/annotations"
+
  - name: "Install dependencies with Composer"
  uses: "ramsey/composer-install@v3"
  with:
@@ -64,7 +78,7 @@ jobs:
  - name: "Upload coverage file"
  uses: "actions/upload-artifact@v4"
  with:
- name: "${{ github.job }}-${{ matrix.php-version }}-${{ matrix.deps }}-coverage"
+ name: "${{ github.job }}-${{ matrix.php-version }}-${{ matrix.deps }}-${{ matrix.no-annotations == true && 'no-annotations' || 'with-annotations' }}-coverage"
  path: "coverage.xml"
 
  lint-doctrine-xml-schema:

tests/Gedmo/Mapping/Fixture/Unmapped/Timestampable.php

@@ -25,5 +25,6 @@ class Timestampable
  *
  * @Tmsp(on="create")
  */
+ #[Tmsp(on: 'create')]
  private $created;
 }

tests/Gedmo/Mapping/LoggableORMMappingTest.php

@@ -59,9 +59,7 @@ public static function dataLoggableObject(): \Generator
  {
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedLoggable::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedLoggable::class];
  }
 
@@ -121,9 +119,7 @@ public static function dataLoggableObjectWithCompositeKey(): \Generator
 
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedLoggableComposite::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedLoggableComposite::class];
  }
 
@@ -166,9 +162,7 @@ public static function dataLoggableObjectWithCompositeKeyAndRelation(): \Generat
 
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedLoggableCompositeRelation::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedLoggableCompositeRelation::class];
  }
 
@@ -214,9 +208,7 @@ public static function dataLoggableObjectWithEmbedded(): \Generator
  {
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedLoggableWithEmbedded::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedLoggableWithEmbedded::class];
  }
  }

tests/Gedmo/Mapping/MetadataFactory/CustomDriverTest.php

@@ -11,6 +11,7 @@
 
 namespace Gedmo\Tests\Mapping\MetadataFactory;
 
+use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\EventManager;
 use Doctrine\DBAL\DriverManager;
 use Doctrine\ORM\Configuration;
@@ -19,6 +20,7 @@
 use Doctrine\ORM\Tools\SchemaTool;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
+use Gedmo\Mapping\Driver\AttributeReader;
 use Gedmo\Tests\Mapping\Fixture\Unmapped\Timestampable;
 use Gedmo\Timestampable\TimestampableListener;
 use PHPUnit\Framework\TestCase;
@@ -48,7 +50,13 @@ protected function setUp(): void
 
  $evm = new EventManager();
  $this->timestampable = new TimestampableListener();
- $this->timestampable->setAnnotationReader($_ENV['annotation_reader']);
+
+ if (PHP_VERSION >= 80000) {
+ $this->timestampable->setAnnotationReader(new AttributeReader());
+ } elseif (class_exists(AnnotationReader::class)) {
+ $this->timestampable->setAnnotationReader($_ENV['annotation_reader']);
+ }
+
  $evm->addEventSubscriber($this->timestampable);
  $connection = DriverManager::getConnection($conn, $config);
  $this->em = new EntityManager($connection, $config, $evm);

tests/Gedmo/Mapping/ORMMappingTestCase.php

@@ -76,9 +76,7 @@ final protected function createChainedMappingDriver(): MappingDriverChain
 
  if (PHP_VERSION_ID >= 80000) {
  $chain->addDriver(new AttributeDriver([]), 'Gedmo\Tests\Mapping\Fixture');
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class) && class_exists(AnnotationReader::class)) {
  $chain->addDriver(new AnnotationDriver(new AnnotationReader()), 'Gedmo\Tests\Mapping\Fixture');
  }
 

tests/Gedmo/Mapping/SluggableMappingTest.php

@@ -51,9 +51,7 @@ public static function dataSluggableObject(): \Generator
 
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedSluggable::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedSluggable::class];
  }
  }

tests/Gedmo/Mapping/SoftDeleteableMappingTest.php

@@ -50,9 +50,7 @@ public static function dataSoftDeleteableObject(): \Generator
 
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedSoftDeleteable::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedSoftDeleteable::class];
  }
 

tests/Gedmo/Mapping/SortableMappingTest.php

@@ -49,9 +49,7 @@ public static function dataSortableObject(): \Generator
 
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedSortable::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedSortable::class];
  }
 

tests/Gedmo/Mapping/TimestampableMappingTest.php

@@ -49,9 +49,7 @@ public static function dataTimestampableObject(): \Generator
  {
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedCategory::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedCategory::class];
  }
 

tests/Gedmo/Mapping/TranslatableMappingTest.php

@@ -51,9 +51,7 @@ public static function dataSortableObject(): \Generator
 
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedUser::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedUser::class];
  }
 

tests/Gedmo/Mapping/UploadableMappingTest.php

@@ -54,9 +54,7 @@ public static function dataUploadableObject(): \Generator
 
  if (PHP_VERSION_ID >= 80000) {
  yield 'Model with attributes' => [AnnotatedUploadable::class];
- }
-
- if (class_exists(AnnotationDriver::class)) {
+ } elseif (class_exists(AnnotationDriver::class)) {
  yield 'Model with annotations' => [AnnotatedUploadable::class];
  }
 

tests/Gedmo/Timestampable/AttributeChangeTest.php

@@ -25,6 +25,8 @@
  * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  *
  * @requires PHP >= 8.0
+ *
+ * @todo This test requires {@see ChangeTest} to have been run first to load the {@see TimestampableListenerStub}
  */
 final class AttributeChangeTest extends BaseTestCaseORM
 {

tests/bootstrap.php

@@ -29,8 +29,8 @@
 
 require dirname(__DIR__).'/vendor/autoload.php';
 
-$reader = new AnnotationReader();
-$reader = new PsrCachedReader($reader, new ArrayAdapter());
-$_ENV['annotation_reader'] = $reader;
+if (class_exists(AnnotationReader::class)) {
+ $_ENV['annotation_reader'] = new PsrCachedReader(new AnnotationReader(), new ArrayAdapter());
+}
 
 Type::addType('uuid', UuidType::class);