Prepare tests for PHPUnit 10 (#778)

* Migrate phpunit XML configuration * Use TestCase suffix for abstract test classes * Make data providers static * Mark risky test as it does not perform assertions * Rename Test.php classes
doctrine · Jul 31, 2023 · 8134a6e · 8134a6e
1 parent 294b0fb
commit 8134a6e
Show file tree

Hide file tree

Showing 18 changed files with 34 additions and 31 deletions.
diff --git a/Tests/CacheWarmer/HydratorCacheWarmerTest.php b/Tests/CacheWarmer/HydratorCacheWarmerTest.php
@@ -69,7 +69,7 @@ public function testWarmerNotExecuted(int $autoGenerate): void
     }
 
     /** @return array<array{int}> */
-    public function provideWarmerNotExecuted(): array
+    public static function provideWarmerNotExecuted(): array
     {
         return [
             [ Configuration::AUTOGENERATE_ALWAYS ],

diff --git a/Tests/CacheWarmer/PersistentCollectionCacheWarmerTest.php b/Tests/CacheWarmer/PersistentCollectionCacheWarmerTest.php
@@ -61,7 +61,7 @@ public function testWarmerNotExecuted(int $autoGenerate): void
         $this->warmer->warmUp('meh');
     }
 
-    public function provideWarmerNotExecuted(): array
+    public static function provideWarmerNotExecuted(): array
     {
         return [
             [ Configuration::AUTOGENERATE_ALWAYS ],

diff --git a/Tests/ContainerTest.php b/Tests/ContainerTest.php
@@ -52,7 +52,7 @@ public function testLoggerConfig(bool $expected, array $config, bool $debug): vo
     }
 
     /** @return array<string, array{expected: bool, config: array, debug: bool}> */
-    public function provideLoggerConfigs(): array
+    public static function provideLoggerConfigs(): array
     {
         $config = ['connections' => ['default' => []]];
 
@@ -109,7 +109,7 @@ public function testDataCollectorConfig(bool $expected, array $config, bool $deb
     }
 
     /** @return array<string, array{expected: bool, config: array, debug: bool}> */
-    public function provideDataCollectorConfigs(): array
+    public static function provideDataCollectorConfigs(): array
     {
         $config = ['connections' => ['default' => []]];
 

diff --git a/...njection/AbstractMongoDBExtensionTest.php → ...tion/AbstractMongoDBExtensionTestCase.php b/...njection/AbstractMongoDBExtensionTest.php → ...tion/AbstractMongoDBExtensionTestCase.php
@@ -39,7 +39,7 @@
 use function is_dir;
 use function reset;
 
-abstract class AbstractMongoDBExtensionTest extends TestCase
+abstract class AbstractMongoDBExtensionTestCase extends TestCase
 {
     abstract protected function loadFromFile(ContainerBuilder $container, string $file): void;
 

diff --git a/Tests/DependencyInjection/Compiler/CacheCompatibilityPassTest.php b/Tests/DependencyInjection/Compiler/CacheCompatibilityPassTest.php
@@ -46,7 +46,10 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
         self::assertTrue($kernel->isBooted());
     }
 
-    /** @group legacy */
+    /**
+     * @group legacy
+     * @doesNotPerformAssertions
+     */
     public function testMetadataCacheConfigUsingNonPsr6ServiceDefinedByApplication(): void
     {
         $this->expectDeprecation('Since doctrine/mongodb-odm-bundle 4.4: Configuring doctrine/cache is deprecated. Please update the cache service "custom_cache_service" to use a PSR-6 cache.');

diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -217,7 +217,7 @@ public function testFullConfiguration(array $config): void
     }
 
     /** @return array<mixed[]> */
-    public function provideFullConfiguration(): array
+    public static function provideFullConfiguration(): array
     {
         $yaml = Yaml::parse(file_get_contents(__DIR__ . '/Fixtures/config/yml/full.yml'));
         $yaml = $yaml['doctrine_mongodb'];
@@ -249,7 +249,7 @@ public function testMergeOptions(array $configs, array $expected): void
     }
 
     /** @return array<mixed[]> */
-    public function provideMergeOptions(): array
+    public static function provideMergeOptions(): array
     {
         $cases = [];
 
@@ -371,7 +371,7 @@ public function testNormalizeOptions(array $config, array $expected): void
     }
 
     /** @return array<mixed[]> */
-    public function provideNormalizeOptions(): array
+    public static function provideNormalizeOptions(): array
     {
         $cases = [];
 
@@ -527,7 +527,7 @@ public function testFixtureLoaderValidation(array $config): void
     }
 
     /** @return array<mixed[]> */
-    public function provideExceptionConfiguration(): array
+    public static function provideExceptionConfiguration(): array
     {
         $yaml = Yaml::parse(file_get_contents(__DIR__ . '/Fixtures/config/yml/exception.yml'));
         $yaml = $yaml['doctrine_mongodb'];

diff --git a/Tests/DependencyInjection/DoctrineMongoDBExtensionTest.php b/Tests/DependencyInjection/DoctrineMongoDBExtensionTest.php
@@ -139,15 +139,15 @@ private function getContainer($bundles = 'OtherXmlBundle'): ContainerBuilder
         ]));
     }
 
-    public function parameterProvider(): array
+    public static function parameterProvider(): array
     {
         return [
             ['proxy_namespace', 'proxy_namespace', 'foo'],
             ['proxy-namespace', 'proxy_namespace', 'bar'],
         ];
     }
 
-    public function getAutomappingConfigurations(): array
+    public static function getAutomappingConfigurations(): array
     {
         return [
             [

diff --git a/...ndles/AnnotationsBundle/Document/Test.php → ...notationsBundle/Document/TestDocument.php b/...ndles/AnnotationsBundle/Document/Test.php → ...notationsBundle/Document/TestDocument.php
@@ -7,6 +7,6 @@
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 
 /** @MongoDB\Document */
-class Test
+class TestDocument
 {
 }
diff --git a/...undles/AttributesBundle/Document/Test.php → ...ttributesBundle/Document/TestDocument.php b/...undles/AttributesBundle/Document/Test.php → ...ttributesBundle/Document/TestDocument.php
@@ -7,6 +7,6 @@
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 
 #[MongoDB\Document]
-class Test
+class TestDocument
 {
 }
diff --git a/.../DocumentListenerBundle/Document/Test.php → ...tListenerBundle/Document/TestDocument.php b/.../DocumentListenerBundle/Document/Test.php → ...tListenerBundle/Document/TestDocument.php
@@ -7,6 +7,6 @@
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
 
 #[MongoDB\Document]
-class Test
+class TestDocument
 {
 }
diff --git a/...undles/NewXmlBundle/src/Document/Test.php → ...ewXmlBundle/src/Document/TestDocument.php b/...undles/NewXmlBundle/src/Document/Test.php → ...ewXmlBundle/src/Document/TestDocument.php
@@ -4,6 +4,6 @@
 
 namespace Doctrine\Bundle\MongoDBBundle\Tests\DependencyInjection\Fixtures\Bundles\NewXmlBundle\Document;
 
-class Test
+class TestDocument
 {
 }
diff --git a/.../Bundles/OtherXmlBundle/Document/Test.php → .../OtherXmlBundle/Document/TestDocument.php b/.../Bundles/OtherXmlBundle/Document/Test.php → .../OtherXmlBundle/Document/TestDocument.php
@@ -4,6 +4,6 @@
 
 namespace Doctrine\Bundle\MongoDBBundle\Tests\DependencyInjection\Fixtures\Bundles\OtherXmlBundle\Document;
 
-class Test
+class TestDocument
 {
 }
diff --git a/...tures/Bundles/XmlBundle/Document/Test.php → ...ndles/XmlBundle/Document/TestDocument.php b/...tures/Bundles/XmlBundle/Document/Test.php → ...ndles/XmlBundle/Document/TestDocument.php
@@ -4,6 +4,6 @@
 
 namespace Doctrine\Bundle\MongoDBBundle\Tests\DependencyInjection\Fixtures\Bundles\XmlBundle\Document;
 
-class Test
+class TestDocument
 {
 }
diff --git a/Tests/DependencyInjection/XmlMongoDBExtensionTest.php b/Tests/DependencyInjection/XmlMongoDBExtensionTest.php
@@ -8,7 +8,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
-class XmlMongoDBExtensionTest extends AbstractMongoDBExtensionTest
+class XmlMongoDBExtensionTest extends AbstractMongoDBExtensionTestCase
 {
     protected function loadFromFile(ContainerBuilder $container, string $file): void
     {

diff --git a/Tests/DependencyInjection/YamlMongoDBExtensionTest.php b/Tests/DependencyInjection/YamlMongoDBExtensionTest.php
@@ -8,7 +8,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
-class YamlMongoDBExtensionTest extends AbstractMongoDBExtensionTest
+class YamlMongoDBExtensionTest extends AbstractMongoDBExtensionTestCase
 {
     protected function loadFromFile(ContainerBuilder $container, string $file): void
     {

diff --git a/Tests/Mapping/Driver/AbstractDriverTest.php → ...Mapping/Driver/AbstractDriverTestCase.php b/Tests/Mapping/Driver/AbstractDriverTest.php → ...Mapping/Driver/AbstractDriverTestCase.php
@@ -10,7 +10,7 @@
 use PHPUnit\Framework\TestCase;
 use ReflectionProperty;
 
-abstract class AbstractDriverTest extends TestCase
+abstract class AbstractDriverTestCase extends TestCase
 {
     public function testFindMappingFile(): void
     {

diff --git a/Tests/Mapping/Driver/XmlDriverTest.php b/Tests/Mapping/Driver/XmlDriverTest.php
@@ -6,7 +6,7 @@
 
 use Doctrine\Bundle\MongoDBBundle\Mapping\Driver\XmlDriver;
 
-class XmlDriverTest extends AbstractDriverTest
+class XmlDriverTest extends AbstractDriverTestCase
 {
     protected function getFileExtension(): string
     {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -26,16 +26,16 @@
         <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[direct]=1"/>
     </php>
 
-    <filter>
-        <whitelist>
+    <coverage>
+        <include>
             <directory>./</directory>
-            <exclude>
-                <directory>./Resources</directory>
-                <directory>./Tests</directory>
-                <directory>./vendor</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+        </include>
+        <exclude>
+            <directory>./Resources</directory>
+            <directory>./Tests</directory>
+            <directory>./vendor</directory>
+        </exclude>
+    </coverage>
 
     <listeners>
         <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener"/>