[TASK] Replace usages of getMockForAbstractClass in EXT:core

`getMockForAbstractClass` has been (soft-)deprecated in PHPUnit 10.1: sebastianbergmann/phpunit#5241 Hence, we should replace its usages to follow best practices and avoid deprecation warnings later with PHPUnit 11. We do this by creating dedicated fixture subclasses of the affected abstract classes. Resolves: #101630 Related: #101601 Releases: main, 12.4 Change-Id: I27f526cb7ee4e1f2081c05befd3d70549dd0e2fd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80945 Tested-by: core-ci <[email protected]> Tested-by: Benjamin Franzke <[email protected]> Reviewed-by: Benjamin Franzke <[email protected]>
TYPO3 · Sep 11, 2023 · c454452 · c454452
1 parent a7570a3
commit c454452
Show file tree

Hide file tree

Showing 13 changed files with 445 additions and 51 deletions.
diff --git a/Build/phpstan/phpstan-baseline.neon b/Build/phpstan/phpstan-baseline.neon
@@ -1387,7 +1387,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\#1 \\$uid of method TYPO3\\\\CMS\\\\Core\\\\Resource\\\\AbstractRepository\\<object\\>\\:\\:findByUid\\(\\) expects int, string given\\.$#"
-			count: 2
+			count: 1
 			path: ../../typo3/sysext/core/Tests/Unit/Resource/Repository/AbstractRepositoryTest.php
 
 		-

diff --git a/typo3/sysext/core/Tests/Unit/Log/Processor/AbstractMemoryProcessorTest.php b/typo3/sysext/core/Tests/Unit/Log/Processor/AbstractMemoryProcessorTest.php
@@ -17,7 +17,7 @@
 
 namespace TYPO3\CMS\Core\Tests\Unit\Log\Processor;
 
-use TYPO3\CMS\Core\Log\Processor\AbstractMemoryProcessor;
+use TYPO3\CMS\Core\Tests\Unit\Log\Processor\Fixtures\TestingMemoryProcessor;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
 final class AbstractMemoryProcessorTest extends UnitTestCase
@@ -27,7 +27,7 @@ final class AbstractMemoryProcessorTest extends UnitTestCase
      */
     public function setRealMemoryUsageSetsRealMemoryUsage(): void
     {
-        $processor = $this->getMockForAbstractClass(AbstractMemoryProcessor::class);
+        $processor = new TestingMemoryProcessor();
         $processor->setRealMemoryUsage(false);
         self::assertFalse($processor->getRealMemoryUsage());
     }
@@ -37,7 +37,7 @@ public function setRealMemoryUsageSetsRealMemoryUsage(): void
      */
     public function setFormatSizeSetsFormatSize(): void
     {
-        $processor = $this->getMockForAbstractClass(AbstractMemoryProcessor::class);
+        $processor = new TestingMemoryProcessor();
         $processor->setFormatSize(false);
         self::assertFalse($processor->getFormatSize());
     }

diff --git a/typo3/sysext/core/Tests/Unit/Log/Processor/Fixtures/TestingMemoryProcessor.php b/typo3/sysext/core/Tests/Unit/Log/Processor/Fixtures/TestingMemoryProcessor.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Core\Tests\Unit\Log\Processor\Fixtures;
+
+use TYPO3\CMS\Core\Log\LogRecord;
+use TYPO3\CMS\Core\Log\Processor\AbstractMemoryProcessor;
+
+/**
+ * Testing subclass of `AbstractMemoryProcessor`.
+ */
+final class TestingMemoryProcessor extends AbstractMemoryProcessor
+{
+    public function processLogRecord(LogRecord $logRecord): LogRecord
+    {
+        throw new \BadMethodCallException('Not implemented', 1691578434);
+    }
+}
diff --git a/typo3/sysext/core/Tests/Unit/Resource/AbstractFileTest.php b/typo3/sysext/core/Tests/Unit/Resource/AbstractFileTest.php
@@ -17,9 +17,10 @@
 
 namespace TYPO3\CMS\Core\Tests\Unit\Resource;
 
-use TYPO3\CMS\Core\Resource\AbstractFile;
 use TYPO3\CMS\Core\Resource\File;
+use TYPO3\CMS\Core\Resource\FolderInterface;
 use TYPO3\CMS\Core\Resource\ResourceStorage;
+use TYPO3\CMS\Core\Tests\Unit\Resource\Fixtures\TestingFile;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
 /**
@@ -37,8 +38,8 @@ public function getParentFolderGetsParentFolderFromStorage(): void
 
         $mockedStorageForParent = $this->createMock(ResourceStorage::class);
 
-        $parentFolderFixture = $this->getMockForAbstractClass(AbstractFile::class);
-        $parentFolderFixture->setIdentifier($parentIdentifier)->setStorage($mockedStorageForParent);
+        $parentFolderFixture = $this->createMock(FolderInterface::class);
+        $parentFolderFixture->method('getStorage')->willReturn($mockedStorageForParent);
 
         $mockedStorage = $this->getMockBuilder(ResourceStorage::class)
             ->onlyMethods(['getFolderIdentifierFromFileIdentifier', 'getFolder'])
@@ -47,7 +48,7 @@ public function getParentFolderGetsParentFolderFromStorage(): void
         $mockedStorage->expects(self::once())->method('getFolderIdentifierFromFileIdentifier')->with($currentIdentifier)->willReturn($parentIdentifier);
         $mockedStorage->expects(self::once())->method('getFolder')->with($parentIdentifier)->willReturn($parentFolderFixture);
 
-        $currentFolderFixture = $this->getMockForAbstractClass(AbstractFile::class);
+        $currentFolderFixture = new TestingFile();
         $currentFolderFixture->setIdentifier($currentIdentifier)->setStorage($mockedStorage);
 
         self::assertSame($parentFolderFixture, $currentFolderFixture->getParentFolder());

diff --git a/typo3/sysext/core/Tests/Unit/Resource/Collection/FileCollectionRegistryTest.php b/typo3/sysext/core/Tests/Unit/Resource/Collection/FileCollectionRegistryTest.php
@@ -17,9 +17,9 @@
 
 namespace TYPO3\CMS\Core\Tests\Unit\Resource\Collection;
 
-use TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection;
 use TYPO3\CMS\Core\Resource\Collection\FileCollectionRegistry;
 use TYPO3\CMS\Core\Resource\Collection\StaticFileCollection;
+use TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures\TestingFileCollection;
 use TYPO3\CMS\Core\Utility\StringUtility;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
@@ -30,7 +30,7 @@ final class FileCollectionRegistryTest extends UnitTestCase
      */
     public function registeredFileCollectionClassesCanBeRetrieved(): void
     {
-        $className = get_class($this->getMockForAbstractClass(AbstractFileCollection::class));
+        $className = TestingFileCollection::class;
         $subject = new FileCollectionRegistry();
         $subject->registerFileCollectionClass($className, 'foobar');
         $returnedClassName = $subject->getFileCollectionClass('foobar');
@@ -56,7 +56,7 @@ public function registerFileCollectionClassThrowsExceptionIfTypeIsTooLong(): voi
         $this->expectException(\InvalidArgumentException::class);
         $this->expectExceptionCode(1391295611);
         $subject = new FileCollectionRegistry();
-        $className = get_class($this->getMockForAbstractClass(AbstractFileCollection::class));
+        $className = TestingFileCollection::class;
         $type = str_pad('', 40);
         $subject->registerFileCollectionClass($className, $type);
     }
@@ -69,7 +69,7 @@ public function registerFileCollectionClassThrowsExceptionIfTypeIsAlreadyRegiste
         $this->expectException(\InvalidArgumentException::class);
         $this->expectExceptionCode(1391295643);
         $subject = new FileCollectionRegistry();
-        $className = get_class($this->getMockForAbstractClass(AbstractFileCollection::class));
+        $className = TestingFileCollection::class;
         $className2 = get_class($this->getMockForAbstractClass(StaticFileCollection::class));
         $subject->registerFileCollectionClass($className, 'foobar');
         $subject->registerFileCollectionClass($className2, 'foobar');
@@ -80,7 +80,7 @@ public function registerFileCollectionClassThrowsExceptionIfTypeIsAlreadyRegiste
      */
     public function registerFileCollectionClassOverridesExistingRegisteredFileCollectionClass(): void
     {
-        $className = get_class($this->getMockForAbstractClass(AbstractFileCollection::class));
+        $className = TestingFileCollection::class;
         $className2 = get_class($this->getMockForAbstractClass(StaticFileCollection::class));
         $subject = new FileCollectionRegistry();
         $subject->registerFileCollectionClass($className, 'foobar');
@@ -103,7 +103,7 @@ public function getFileCollectionClassThrowsExceptionIfClassIsNotRegistered(): v
      */
     public function getFileCollectionClassAcceptsClassNameIfClassIsRegistered(): void
     {
-        $className = get_class($this->getMockForAbstractClass(AbstractFileCollection::class));
+        $className = TestingFileCollection::class;
         $subject = new FileCollectionRegistry();
         $subject->registerFileCollectionClass($className, 'foobar');
         self::assertEquals($className, $subject->getFileCollectionClass('foobar'));
@@ -114,7 +114,7 @@ public function getFileCollectionClassAcceptsClassNameIfClassIsRegistered(): voi
      */
     public function fileCollectionRegistryIsInitializedWithPreconfiguredFileCollections(): void
     {
-        $className = get_class($this->getMockForAbstractClass(AbstractFileCollection::class));
+        $className = TestingFileCollection::class;
         $type = substr(StringUtility::getUniqueId('type_'), 0, 30);
         $GLOBALS['TYPO3_CONF_VARS']['SYS']['fal']['registeredCollections'] = [
             $type => $className,
@@ -128,7 +128,7 @@ public function fileCollectionRegistryIsInitializedWithPreconfiguredFileCollecti
      */
     public function fileCollectionExistsReturnsTrueForAllExistingFileCollections(): void
     {
-        $className = get_class($this->getMockForAbstractClass(AbstractFileCollection::class));
+        $className = TestingFileCollection::class;
         $type = 'foo';
         $GLOBALS['TYPO3_CONF_VARS']['SYS']['fal']['registeredCollections'] = [
             $type => $className,

diff --git a/typo3/sysext/core/Tests/Unit/Resource/Collection/Fixtures/TestingFileCollection.php b/typo3/sysext/core/Tests/Unit/Resource/Collection/Fixtures/TestingFileCollection.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Core\Tests\Unit\Resource\Collection\Fixtures;
+
+use TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection;
+
+/**
+ * Testing subclass of `AbstractFileCollection`.
+ */
+final class TestingFileCollection extends AbstractFileCollection
+{
+    public function loadContents(): void
+    {
+        // stub
+    }
+}
diff --git a/typo3/sysext/core/Tests/Unit/Resource/Driver/AbstractDriverTest.php b/typo3/sysext/core/Tests/Unit/Resource/Driver/AbstractDriverTest.php
@@ -17,7 +17,7 @@
 
 namespace TYPO3\CMS\Core\Tests\Unit\Resource\Driver;
 
-use TYPO3\CMS\Core\Resource\Driver\AbstractDriver;
+use TYPO3\CMS\Core\Tests\Unit\Resource\Driver\Fixtures\TestingDriver;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
 final class AbstractDriverTest extends UnitTestCase
@@ -27,7 +27,7 @@ final class AbstractDriverTest extends UnitTestCase
      */
     public function isCaseSensitiveFileSystemReturnsTrueIfNothingIsConfigured(): void
     {
-        $subject = $this->getMockForAbstractClass(AbstractDriver::class, [], '', false);
+        $subject = new TestingDriver();
         self::assertTrue($subject->isCaseSensitiveFileSystem());
     }
 }
diff --git a/typo3/sysext/core/Tests/Unit/Resource/Driver/DriverRegistryTest.php b/typo3/sysext/core/Tests/Unit/Resource/Driver/DriverRegistryTest.php
@@ -19,6 +19,7 @@
 
 use TYPO3\CMS\Core\Resource\Driver\DriverInterface;
 use TYPO3\CMS\Core\Resource\Driver\DriverRegistry;
+use TYPO3\CMS\Core\Tests\Unit\Resource\Driver\Fixtures\TestingDriver;
 use TYPO3\CMS\Core\Utility\StringUtility;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
@@ -55,7 +56,7 @@ public function registerDriverClassThrowsExceptionIfShortnameIsAlreadyTakenByAno
         $this->expectException(\InvalidArgumentException::class);
         $this->expectExceptionCode(1314979451);
         $className = get_class($this->createMock(DriverInterface::class));
-        $className2 = get_class($this->getMockForAbstractClass(DriverInterface::class));
+        $className2 = TestingDriver::class;
         $subject = new DriverRegistry();
         $subject->registerDriverClass($className, 'foobar');
         $subject->registerDriverClass($className2, 'foobar');