Trigger a deprecation message when annotation-based configuration is used as the default (#54)

Author: mpdude

.github/workflows/tests.yml

@@ -32,5 +32,7 @@ jobs:
                     coverage: none
             -   name: Install dependencies
                 run: composer update --no-interaction --prefer-dist --${{ matrix.dependency-version}} --no-progress --no-suggest
+            -   name: Allow self-deprecation notices when testing against ORM 2.0
+                run: composer show | egrep -q 'doctrine/orm\s+2' && echo "SYMFONY_DEPRECATIONS_HELPER=max[self]=9999" >> "$GITHUB_ENV" || true
             -   name: Run test suite
                 run: vendor/bin/phpunit

CHANGELOG.md

@@ -5,3 +5,4 @@ This changelog tracks deprecations and changes breaking backwards compatibility.
 # Version 1.16
 
 - The `\Webfactory\Doctrine\ORMTestInfrastructure\Query::getExecutionTimeInSeconds()` method has been deprecated without replacement in https://github.com/webfactory/doctrine-orm-test-infrastructure/pull/52, to prepare for the removal of the `DebugStack` class in Doctrine DBAL 4.0.
+- Using annotation-based mapping as the default in `ORMInfrastructure::create*()` methods has been deprecated. Pass a mapping driver or upgrade `doctrine/orm` to >= 3.0 to switch to attributes-based mapping. Attributes-based configuration will be the default in the next major version.

README.md

@@ -92,7 +92,7 @@ class MyEntityRepositoryTest extends TestCase
 Migrating to attribute-based mapping configuration
 --------------------------------------------------
 
-The `ORMInfrastructure::createWithDependenciesFor()` and ``ORMInfrastructure::createOnlyFor()` methods by default
+The `ORMInfrastructure::createWithDependenciesFor()` and `ORMInfrastructure::createOnlyFor()` methods by default
 assume that the Doctrine ORM mapping is provided through annotations. This has been deprecated in Doctrine ORM 2.x
 and is no longer be supported in ORM 3.0.
 

src/ORMTestInfrastructure/ConfigurationFactory.php

@@ -12,6 +12,7 @@
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\PsrCachedReader;
 use Doctrine\Common\Annotations\Reader;
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Doctrine\ORM\Mapping\Driver\AttributeDriver;
 use Doctrine\ORM\ORMSetup;
@@ -78,6 +79,11 @@ private function createDefaultMappingDriver(array $entityClasses)
         $paths = $this->getDirectoryPathsForClassNames($entityClasses);
 
         if (class_exists(AnnotationDriver::class)) {
+            Deprecation::trigger(
+                'webfactory/doctrine-orm-test-infrastructure',
+                'https://github.com/webfactory/doctrine-orm-test-infrastructure/pull/54',
+                'Since the AnnotationDriver has been removed in ORM 3.0, using annotation-based mapping as the default has been deprecated in 1.16. In 2.0, attribute-based configuration will be the new default. Either upgrade doctrine/orm to >=3.0 or pass a mapping driver when calling `ORMInfrastructure::create*()` methods to make this notice go away.'
+            );
             return new AnnotationDriver($this->getAnnotationReader(), $paths);
         }