Merge pull request #601 from creative-commoners/pulls/6/phpunit11

DEP Use PHPUnit 11
silverstripe · Sep 18, 2024 · 9e49bb5 · 9e49bb5
2 parents b7af2d2 + f8222fb
commit 9e49bb5
Show file tree

Hide file tree

Showing 18 changed files with 85 additions and 90 deletions.
diff --git a/tests/Auth/HandlerTest.php b/tests/Auth/HandlerTest.php
@@ -8,6 +8,7 @@
 use SilverStripe\GraphQL\Tests\Fake\BrutalAuthenticatorFake;
 use SilverStripe\GraphQL\Tests\Fake\FalsyAuthenticatorFake;
 use SilverStripe\GraphQL\Tests\Fake\PushoverAuthenticatorFake;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 /**
  * @package silverstripe-graphql
@@ -65,7 +66,6 @@ public function testGetAuthenticator()
 
     /**
      * Test that an exception is thrown if an authenticator is configured that doesn't implement the interface
-     *
      */
     public function testExceptionThrownWhenAuthenticatorDoesNotImplementAuthenticatorInterface()
     {
@@ -80,8 +80,8 @@ public function testExceptionThrownWhenAuthenticatorDoesNotImplementAuthenticato
      *
      * @param array  $authenticators
      * @param string $expected
-     * @dataProvider prioritisedAuthenticatorProvider
      */
+    #[DataProvider('prioritisedAuthenticatorProvider')]
     public function testAuthenticatorsCanBePrioritised($authenticators, $expected)
     {
         Handler::config()->set('authenticators', $authenticators);
@@ -92,7 +92,7 @@ public function testAuthenticatorsCanBePrioritised($authenticators, $expected)
     /**
      * @return array
      */
-    public function prioritisedAuthenticatorProvider()
+    public static function prioritisedAuthenticatorProvider()
     {
         return [
             [
@@ -128,7 +128,6 @@ public function prioritisedAuthenticatorProvider()
 
     /**
      * Ensure that an failed authentication attempt throws an exception
-     *
      */
     public function testFailedAuthenticationThrowsException()
     {
@@ -142,7 +141,6 @@ public function testFailedAuthenticationThrowsException()
      * Ensure that when a falsy value is returned from an authenticator (when it should throw
      * an exception on failure) that a sensible default message is used in a ValidationException
      * instead.
-     *
      */
     public function testFailedAuthenticationWithFalsyReturnValueThrowsDefaultException()
     {

diff --git a/tests/ControllerTest.php b/tests/ControllerTest.php
@@ -9,12 +9,13 @@
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\GraphQL\Controller;
 use SilverStripe\ORM\DB;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class ControllerTest extends SapphireTest
 {
     protected $usesDatabase = false;
 
-    public function providePrepareBacktrace()
+    public static function providePrepareBacktrace()
     {
         $querySource = <<<'GRAPHQL'
             query ReadFiles($filter: FakeInputType!) {
@@ -152,9 +153,7 @@ public function providePrepareBacktrace()
         ];
     }
 
-    /**
-     * @dataProvider providePrepareBacktrace
-     */
+    #[DataProvider('providePrepareBacktrace')]
     public function testPrepareBacktrace(array $trace, array $expected)
     {
         $controller = new Controller(__FUNCTION__);

diff --git a/tests/Middleware/CSRFMiddlewareTest.php b/tests/Middleware/CSRFMiddlewareTest.php
@@ -6,7 +6,7 @@
 use SilverStripe\GraphQL\Middleware\CSRFMiddleware;
 use SilverStripe\Security\SecurityToken;
 
-class CSRFMiddlewareTest extends BaseMiddlewareProcessTest
+class CSRFMiddlewareTest extends MiddlewareProcessTestBase
 {
     private bool $securityTokenWasEnabled = false;
 

diff --git a/.../Middleware/BaseMiddlewareProcessTest.php → .../Middleware/MiddlewareProcessTestBase.php b/.../Middleware/BaseMiddlewareProcessTest.php → .../Middleware/MiddlewareProcessTestBase.php
@@ -9,7 +9,7 @@
 use SilverStripe\GraphQL\Middleware\QueryMiddleware;
 use SilverStripe\GraphQL\Schema\Schema as SchemaSchema;
 
-abstract class BaseMiddlewareProcessTest extends SapphireTest
+abstract class MiddlewareProcessTestBase extends SapphireTest
 {
     /**
      * @var callable

diff --git a/tests/Modules/AssetAdmin/ReadFileUsageQueryCreatorTest.php b/tests/Modules/AssetAdmin/ReadFileUsageQueryCreatorTest.php
@@ -10,6 +10,7 @@
 use SilverStripe\Dev\SapphireTest;
 use Silverstripe\Assets\Dev\TestAssetStore;
 use SilverStripe\GraphQL\Schema\Schema;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 /**
  * Most of the search functionality is covered in {@link FileFilterInputTypeCreatorTest}
@@ -38,7 +39,7 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    public function fileUsageDataProvider()
+    public static function fileUsageDataProvider()
     {
         return [
             [File::class, 'rootfile', 2, 'rootfile file is used twice'],
@@ -50,12 +51,12 @@ public function fileUsageDataProvider()
     }
 
     /**
-     * @dataProvider fileUsageDataProvider
      * @param string $class
      * @param string $fixture
      * @param int|false $expectedCount
      * @param $message
      */
+    #[DataProvider('fileUsageDataProvider')]
     public function testUsageCount(string $class, string $fixture, $expectedCount, $message)
     {
         $id = $this->idFromFixture($class, $fixture);

diff --git a/tests/Modules/CMS/LinkablePluginTest.php b/tests/Modules/CMS/LinkablePluginTest.php
@@ -10,6 +10,7 @@
 use SilverStripe\GraphQL\Schema\Field\ModelQuery;
 use SilverStripe\GraphQL\Schema\Schema;
 use SilverStripe\GraphQL\Schema\SchemaConfig;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class LinkablePluginTest extends SapphireTest
 {
@@ -24,8 +25,8 @@ protected function setUp(): void
 
     /**
      * @param bool $list
-     * @dataProvider provideApply
      */
+    #[DataProvider('provideApply')]
     public function testApply(bool $list)
     {
         $query = new ModelQuery(
@@ -102,7 +103,7 @@ public function testResolver()
     }
 
 
-    public function provideApply()
+    public static function provideApply()
     {
         return [
             [true],

diff --git a/tests/PersistedQuery/HTTPProviderTest.php b/tests/PersistedQuery/HTTPProviderTest.php
@@ -33,7 +33,7 @@ public function testSchemaMapping()
     public function testHTTPRequests()
     {
         $mock = $this->getMockBuilder(HTTPClient::class)
-            ->setMethods(['getURL'])
+            ->onlyMethods(['getURL'])
             ->getMock();
         $mock->expects($this->once())
             ->method('getURL')

diff --git a/tests/Schema/AbstractTypeRegistryTest.php b/tests/Schema/AbstractTypeRegistryTest.php
@@ -11,6 +11,7 @@
 use ReflectionObject;
 use stdClass;
 use SilverStripe\Control\Session;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class AbstractTypeRegistryTest extends SapphireTest
 {
@@ -50,9 +51,7 @@ public function testRebuildOnMissingPath()
         );
     }
 
-    /**
-     * @dataProvider provideRebuildOnMissing
-     */
+    #[DataProvider('provideRebuildOnMissing')]
     public function testRebuildOnMissing(
         bool $controller,
         bool $autobuild,
@@ -93,7 +92,7 @@ public function testRebuildOnMissing(
         $this->assertSame($expected, $canRebuildOnMissingMethod->invoke($registry));
     }
 
-    public function provideRebuildOnMissing(): array
+    public static function provideRebuildOnMissing(): array
     {
         // controller = current controller is a GraphQLController
         // autobuild = if autobuild is enabled

diff --git a/tests/Schema/DataObject/Plugin/DBFieldArgs/DBDateArgsTest.php b/tests/Schema/DataObject/Plugin/DBFieldArgs/DBDateArgsTest.php
@@ -32,7 +32,7 @@ public function testApply()
     public function testResolve()
     {
         $fake = $this->getMockBuilder(DBDate::class)
-            ->setMethods(['Nice'])
+            ->onlyMethods(['Nice'])
             ->getMock();
         $fake->expects($this->once())
             ->method('Nice');

diff --git a/tests/Schema/DataObject/Plugin/DBFieldArgs/DBDatetimeArgsTest.php b/tests/Schema/DataObject/Plugin/DBFieldArgs/DBDatetimeArgsTest.php
@@ -33,7 +33,7 @@ public function testApply()
     public function testResolve()
     {
         $fake = $this->getMockBuilder(DBDatetime::class)
-            ->setMethods(['Time'])
+            ->onlyMethods(['Time'])
             ->getMock();
         $fake->expects($this->once())
             ->method('Time');

diff --git a/tests/Schema/DataObject/Plugin/DBFieldArgs/DBFieldArgsTest.php b/tests/Schema/DataObject/Plugin/DBFieldArgs/DBFieldArgsTest.php
@@ -13,7 +13,7 @@ class DBFieldArgsTest extends SapphireTest
     public function testBaseFormatResolver()
     {
         $fake = $this->getMockBuilder(DBText::class)
-            ->setMethods(['FirstSentence'])
+            ->onlyMethods(['FirstSentence'])
             ->getMock();
         $fake->expects($this->once())
             ->method('FirstSentence');

diff --git a/tests/Schema/DataObject/Plugin/DBFieldArgs/DBHTMLTextArgsTest.php b/tests/Schema/DataObject/Plugin/DBFieldArgs/DBHTMLTextArgsTest.php
@@ -33,11 +33,20 @@ public function testApply()
     public function testResolve()
     {
         $fake = $this->getMockBuilder(DBHTMLText::class)
-            ->setMethods(['setProcessShortcodes'])
+            ->onlyMethods(['setProcessShortcodes'])
             ->getMock();
-        $fake->expects($this->exactly(4))
+        $matcher = $this->exactly(4);
+        $fake->expects($matcher)
             ->method('setProcessShortcodes')
-            ->withConsecutive([true], [false], [false], [true]);
+            ->willReturnCallback(function (bool $process) use ($fake, $matcher) {
+                match ($matcher->numberOfInvocations()) {
+                    1 => $this->assertSame(true, $process),
+                    2 => $this->assertSame(false, $process),
+                    3 => $this->assertSame(false, $process),
+                    4 => $this->assertSame(true, $process),
+                };
+                return $fake;
+            });
 
         $trueConfig = new SchemaConfig();
         $trueConfig->set('modelConfig.DataObject', ['parseShortcodes' => true]);

diff --git a/tests/Schema/DataObject/Plugin/DBFieldArgs/DBTextArgsTest.php b/tests/Schema/DataObject/Plugin/DBFieldArgs/DBTextArgsTest.php
@@ -32,7 +32,7 @@ public function testApply()
     public function testResolve()
     {
         $fake = $this->getMockBuilder(DBText::class)
-            ->setMethods(['FirstParagraph'])
+            ->onlyMethods(['FirstParagraph'])
             ->getMock();
         $fake->expects($this->once())
             ->method('FirstParagraph');
@@ -44,7 +44,7 @@ public function testResolve()
         DBTextArgs::resolve($fake, ['format' => 'FirstParagraph', 'limit' => 5], []);
 
         $fake = $this->getMockBuilder(DBText::class)
-            ->setMethods(['LimitSentences'])
+            ->onlyMethods(['LimitSentences'])
             ->getMock();
         $fake->expects($this->once())
             ->method('LimitSentences')

diff --git a/tests/Schema/DataObject/Plugin/DBFieldArgs/DBTimeArgsTest.php b/tests/Schema/DataObject/Plugin/DBFieldArgs/DBTimeArgsTest.php
@@ -33,7 +33,7 @@ public function testApply()
     public function testResolve()
     {
         $fake = $this->getMockBuilder(DBTime::class)
-            ->setMethods(['Nice'])
+            ->onlyMethods(['Nice'])
             ->getMock();
         $fake->expects($this->once())
             ->method('Nice');

diff --git a/tests/Schema/DataObject/Plugin/FiltersTest.php b/tests/Schema/DataObject/Plugin/FiltersTest.php
@@ -15,19 +15,21 @@
 use SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters\NotEqualFilter;
 use SilverStripe\GraphQL\Schema\DataObject\Plugin\QueryFilter\Filters\StartsWithFilter;
 use SilverStripe\ORM\ArrayList;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class FiltersTest extends SapphireTest
 {
-    private array $values = [
+    /**
+     * @internal
+     */
+    private static array $values = [
         'string' => 'test',
         'array' => ['a', 'b'],
         'number' => 42,
         'null' => null
     ];
 
-    /**
-     * @dataProvider filterArgumentsProvider
-     */
+    #[DataProvider('filterArgumentsProvider')]
     public function testFilterArguments(FieldFilterInterface $filter, string $identifier, array $params): void
     {
         $this->assertEquals($identifier, $filter->getIdentifier());
@@ -40,58 +42,58 @@ public function testFilterArguments(FieldFilterInterface $filter, string $identi
         }
     }
 
-    public function filterArgumentsProvider(): array
+    public static function filterArgumentsProvider(): array
     {
         return [
             [
                 new ContainsFilter(),
                 'contains',
-                array_slice($this->values, 0, 2, true)
+                array_slice(FiltersTest::$values, 0, 2, true)
             ],
             [
                 new EndsWithFilter(),
                 'endswith',
-                array_slice($this->values, 0, 2, true)
+                array_slice(FiltersTest::$values, 0, 2, true)
             ],
             [
                 new EqualToFilter(),
                 'eq',
-                $this->values
+                FiltersTest::$values
             ],
             [
                 new GreaterThanFilter(),
                 'gt',
-                $this->values
+                FiltersTest::$values
             ],
             [
                 new GreaterThanOrEqualFilter(),
                 'gte',
-                $this->values
+                FiltersTest::$values
             ],
             [
                 new InFilter(),
                 'in',
-                $this->values['array']
+                FiltersTest::$values['array']
             ],
             [
                 new LessThanFilter(),
                 'lt',
-                $this->values
+                FiltersTest::$values
             ],
             [
                 new LessThanOrEqualFilter(),
                 'lte',
-                $this->values
+                FiltersTest::$values
             ],
             [
                 new NotEqualFilter(),
                 'ne',
-                $this->values
+                FiltersTest::$values
             ],
             [
                 new StartsWithFilter(),
                 'startswith',
-                array_slice($this->values, 0, 2, true)
+                array_slice(FiltersTest::$values, 0, 2, true)
             ]
         ];
     }

diff --git a/tests/Schema/DataObject/Plugin/InheritanceTest.php b/tests/Schema/DataObject/Plugin/InheritanceTest.php
@@ -35,6 +35,7 @@
 use SilverStripe\GraphQL\Tests\Schema\DataObject\FakeInterfaceBuilder;
 use SilverStripe\GraphQL\Tests\Schema\DataObject\TestSchema;
 use SilverStripe\ORM\DataObject;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class InheritanceTest extends SapphireTest
 {
@@ -62,8 +63,8 @@ class InheritanceTest extends SapphireTest
      * @param false $unions
      * @throws \ReflectionException
      * @throws SchemaBuilderException
-     * @dataProvider provideUnionOption
      */
+    #[DataProvider('provideUnionOption')]
     public function testInheritance($unions = false)
     {
         $schema = new TestSchema();
@@ -168,7 +169,7 @@ private function assertCalls(array $expected, array $actual)
         $this->assertEmpty(array_diff($compare ?? [], $expected), 'Actual calls exceed the expected calls');
     }
 
-    public function provideUnionOption()
+    public static function provideUnionOption()
     {
         return [
             [true],