Silverstripe 6 compatibility (#79)

TheSceneman · satrun77 · web-flow · commit aa636dd5eb1a · 2025-08-07T08:24:18.000+12:00
* Add Silverstripe CMS 6 support
* Add PHPUnit 11 support
* Remove tests folder from phpcs check

---------

Co-authored-by: Mohamed Alsharaf &lt;mohamed.alsharaf@silverstripe.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,7 @@ node_modules
 /vendor/
 .DS_Store
 .idea
+.phpunit.result.cache
+app/
+composer.lock
+public/
diff --git a/composer.json b/composer.json
@@ -20,12 +20,13 @@
     ],
     "require": {
         "php": "^8.1",
-        "silverstripe/framework": "^5"
+        "silverstripe/framework": "^6"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5",
-        "tractorcow/silverstripe-fluent": "^7",
-        "slevomat/coding-standard": "~8.8.0"
+        "phpunit/phpunit": "^11.5",
+        "tractorcow/silverstripe-fluent": "^8",
+        "slevomat/coding-standard": "~8.8.0",
+        "silverstripe/cms": "^6"
     },
     "autoload": {
         "psr-4": {
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -3,7 +3,6 @@
     <description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
 
 	<file>src</file>
-	<file>tests</file>
 
     <!-- Show progress and output sniff names on violation, and add colours -->
     <arg value="p" />
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,16 +1,14 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
-    <testsuites>
-        <testsuite name="Default">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src/</directory>
-            <exclude>
-                <directory suffix=".php">tests/</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd">
+  <testsuite name="Default">
+    <directory>tests/</directory>
+  </testsuite>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+    <exclude>
+      <directory suffix=".php">tests/</directory>
+    </exclude>
+  </source>
 </phpunit>
diff --git a/src/Extensions/CacheKeyExtension.php b/src/Extensions/CacheKeyExtension.php
@@ -3,10 +3,10 @@
 namespace Terraformers\KeysForCache\Extensions;
 
 use SilverStripe\Core\Config\Config;
+use SilverStripe\Core\Extension;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\GridField\GridField;
 use SilverStripe\Forms\GridField\GridFieldConfig_RecordViewer;
-use SilverStripe\ORM\DataExtension;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\HasManyList;
 use SilverStripe\Versioned\Versioned;
@@ -20,7 +20,7 @@
  * @property DataObject|Versioned|$this $owner
  * @method HasManyList|CacheKey CacheKeys()
  */
-class CacheKeyExtension extends DataExtension
+class CacheKeyExtension extends Extension
 {
     private static array $has_many = [
         // Programmatically we know that we will only ever create one of these CacheKey records per unique DataObject,
diff --git a/src/Extensions/FluentExtension.php b/src/Extensions/FluentExtension.php
@@ -2,11 +2,11 @@
 
 namespace Terraformers\KeysForCache\Extensions;
 
-use SilverStripe\ORM\DataExtension;
+use SilverStripe\Core\Extension;
 use Terraformers\KeysForCache\DataTransferObjects\CacheKeyDto;
 use TractorCow\Fluent\State\FluentState;
 
-class FluentExtension extends DataExtension
+class FluentExtension extends Extension
 {
     public function updateCacheKey(CacheKeyDto $cacheKey): void
     {
diff --git a/src/Extensions/StagingExtension.php b/src/Extensions/StagingExtension.php
@@ -3,13 +3,13 @@
 namespace Terraformers\KeysForCache\Extensions;
 
 use SilverStripe\CMS\Controllers\ContentController;
-use SilverStripe\CMS\Model\SiteTreeExtension;
+use SilverStripe\Core\Extension;
 use Terraformers\KeysForCache\State\StagingState;
 
 /**
  * @property ContentController $owner
  */
-class StagingExtension extends SiteTreeExtension
+class StagingExtension extends Extension
 {
     public function contentcontrollerInit(ContentController $controller): void
     {
diff --git a/src/Models/CacheKey.php b/src/Models/CacheKey.php
@@ -2,8 +2,8 @@
 
 namespace Terraformers\KeysForCache\Models;
 
+use SilverStripe\Core\Validation\ValidationException;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\ORM\ValidationException;
 use SilverStripe\Versioned\Versioned;
 use Terraformers\KeysForCache\Extensions\CacheKeyExtension;
 
diff --git a/src/RelationshipGraph/Graph.php b/src/RelationshipGraph/Graph.php
@@ -10,8 +10,8 @@
 use SilverStripe\Core\Flushable;
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Model\ModelData;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\View\ViewableData;
 use Terraformers\KeysForCache\Models\CacheKey;
 
 class Graph implements Flushable
@@ -49,7 +49,7 @@ public function getEdgesFrom(string $from): array
         // Base classes that show up in every ancestry array
         $disallowList = [
             DataObject::class,
-            ViewableData::class,
+            ModelData::class,
         ];
 
         return array_filter(
diff --git a/src/Services/CacheProcessingService.php b/src/Services/CacheProcessingService.php
@@ -4,9 +4,9 @@
 
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Core\Injector\Injectable;
+use SilverStripe\Model\List\SS_List;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;
-use SilverStripe\ORM\SS_List;
 use SilverStripe\Versioned\Versioned;
 use Terraformers\KeysForCache\DataTransferObjects\EdgeUpdateDto;
 use Terraformers\KeysForCache\Models\CacheKey;
diff --git a/tests/Extensions/CacheKeyExtensionTest.php b/tests/Extensions/CacheKeyExtensionTest.php
@@ -3,6 +3,7 @@
 namespace Terraformers\KeysForCache\Tests\Extensions;
 
 use Page;
+use PHPUnit\Framework\Attributes\DataProvider;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\DataList;
 use SilverStripe\Versioned\Versioned;
@@ -24,9 +25,7 @@ class CacheKeyExtensionTest extends SapphireTest
         CachePage::class,
     ];
 
-    /**
-     * @dataProvider readingModes
-     */
+    #[DataProvider('readingModes')]
     public function testWriteGeneratesCacheKey(string $readingMode): void
     {
         $page = Versioned::withVersionedMode(static function () use ($readingMode): CachePage {
@@ -64,9 +63,7 @@ public function testWriteGeneratesCacheKey(string $readingMode): void
         });
     }
 
-    /**
-     * @dataProvider readingModes
-     */
+    #[DataProvider('readingModes')]
     public function testWriteDoesNotGenerateCacheKey(string $readingMode): void
     {
         Versioned::withVersionedMode(function () use ($readingMode): void {
@@ -472,7 +469,7 @@ public function testIgnoreList(): void
         );
     }
 
-    public function readingModes(): array
+    public static function readingModes(): array
     {
         return [
             [Versioned::DRAFT],
diff --git a/tests/Scenarios/CaresTest.php b/tests/Scenarios/CaresTest.php
@@ -2,6 +2,7 @@
 
 namespace Terraformers\KeysForCache\Tests\Scenarios;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\DataObject;
@@ -47,9 +48,7 @@ class CaresTest extends SapphireTest
         PolymorphicCaredHasMany::class,
     ];
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresPureHasOne(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -69,9 +68,7 @@ public function testCaresPureHasOne(string $readingMode, string $saveMethod, boo
         $this->assertCacheKeyChanges($page, $model, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresBelongsTo(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -91,9 +88,7 @@ public function testCaresBelongsTo(string $readingMode, string $saveMethod, bool
         $this->assertCacheKeyChanges($page, $model, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresHasOne(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -113,9 +108,7 @@ public function testCaresHasOne(string $readingMode, string $saveMethod, bool $e
         $this->assertCacheKeyChanges($page, $model, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModes
-     */
+    #[DataProvider('readingModes')]
     public function testCaresHasOneNonVersioned(string $readingMode): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -157,9 +150,7 @@ public function testCaresHasOneNonVersioned(string $readingMode): void
         });
     }
 
-    /**
-     * @dataProvider readingModes
-     */
+    #[DataProvider('readingModes')]
     public function testCaresHasOneVersionedNonStaged(string $readingMode): void
     {
         $page = $this->objFromFixture(CaresPage::class, 'page1');
@@ -198,9 +189,7 @@ public function testCaresHasOneVersionedNonStaged(string $readingMode): void
         });
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testPolymorphicCaresHasOne(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -220,9 +209,7 @@ public function testPolymorphicCaresHasOne(string $readingMode, string $saveMeth
         $this->assertCacheKeyChanges($page, $model, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresHasMany(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -238,9 +225,7 @@ public function testCaresHasMany(string $readingMode, string $saveMethod, bool $
         $this->assertCacheKeyChanges($page, $model, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testPolymorphicCaresHasMany(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -256,9 +241,7 @@ public function testPolymorphicCaresHasMany(string $readingMode, string $saveMet
         $this->assertCacheKeyChanges($page, $model, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testManyMany(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -278,9 +261,7 @@ public function testManyMany(string $readingMode, string $saveMethod, bool $expe
         $this->assertCacheKeyChanges($page, $model, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testManyManyThrough(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -372,15 +353,15 @@ function () use ($page, $model, $readingMode, $saveMethod, $expectKeyChange): vo
         );
     }
 
-    public function readingModes(): array
+    public static function readingModes(): array
     {
         return [
             [Versioned::DRAFT],
             [Versioned::LIVE],
         ];
     }
 
-    public function readingModesWithSaveMethods(): array
+    public static function readingModesWithSaveMethods(): array
     {
         return [
             // If write() is performed on a model then we would expect the CacheKey to be updated in DRAFT only. Since
diff --git a/tests/Scenarios/DotNotationCaresTest.php b/tests/Scenarios/DotNotationCaresTest.php
@@ -2,6 +2,7 @@
 
 namespace Terraformers\KeysForCache\Tests\Scenarios;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\DataObject;
@@ -29,9 +30,7 @@ class DotNotationCaresTest extends SapphireTest
         DotNotationCaredHasOne::class,
     ];
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresPureHasOne(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -55,9 +54,7 @@ public function testCaresPureHasOne(string $readingMode, string $saveMethod, boo
         $this->assertCacheKeyChanges($page, $modelOne, $modelTwo, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresBelongsTo(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -122,9 +119,7 @@ function () use ($page, $modelOne, $modelTwo, $readingMode, $saveMethod, $expect
         );
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresHasOne(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -148,9 +143,7 @@ public function testCaresHasOne(string $readingMode, string $saveMethod, bool $e
         $this->assertCacheKeyChanges($page, $modelOne, $modelTwo, $readingMode, $saveMethod, $expectKeyChange);
     }
 
-    /**
-     * @dataProvider readingModesWithSaveMethods
-     */
+    #[DataProvider('readingModesWithSaveMethods')]
     public function testCaresHasMany(string $readingMode, string $saveMethod, bool $expectKeyChange): void
     {
         // Updates are processed as part of scaffold, so we need to flush before we kick off
@@ -242,7 +235,7 @@ function () use ($page, $modelOne, $modelTwo, $readingMode, $saveMethod, $expect
         );
     }
 
-    public function readingModesWithSaveMethods(): array
+    public static function readingModesWithSaveMethods(): array
     {
         return [
             // If write() is performed on a model then we would expect the CacheKey to be updated in DRAFT only. Since
diff --git a/tests/Scenarios/DotNotationTouchesTest.php b/tests/Scenarios/DotNotationTouchesTest.php
diff --git a/tests/Scenarios/ExtendedCaresTest.php b/tests/Scenarios/ExtendedCaresTest.php
diff --git a/tests/Scenarios/ExtendedTouchesTest.php b/tests/Scenarios/ExtendedTouchesTest.php
diff --git a/tests/Scenarios/GlobalCaresTest.php b/tests/Scenarios/GlobalCaresTest.php
diff --git a/tests/Scenarios/TouchesTest.php b/tests/Scenarios/TouchesTest.php

Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,11 @@`
`2`	`2`
`3`	`3`	`namespace Terraformers\KeysForCache\Extensions;`
`4`	`4`
`5`		`-use SilverStripe\ORM\DataExtension;`
	`5`	`+use SilverStripe\Core\Extension;`
`6`	`6`	`use Terraformers\KeysForCache\DataTransferObjects\CacheKeyDto;`
`7`	`7`	`use TractorCow\Fluent\State\FluentState;`
`8`	`8`
`9`		`-class FluentExtension extends DataExtension`
	`9`	`+class FluentExtension extends Extension`
`10`	`10`	`{`
`11`	`11`	`public function updateCacheKey(CacheKeyDto $cacheKey): void`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,13 @@`
`3`	`3`	`namespace Terraformers\KeysForCache\Extensions;`
`4`	`4`
`5`	`5`	`use SilverStripe\CMS\Controllers\ContentController;`
`6`		`-use SilverStripe\CMS\Model\SiteTreeExtension;`
	`6`	`+use SilverStripe\Core\Extension;`
`7`	`7`	`use Terraformers\KeysForCache\State\StagingState;`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* @property ContentController $owner`
`11`	`11`	`*/`
`12`		`-class StagingExtension extends SiteTreeExtension`
	`12`	`+class StagingExtension extends Extension`
`13`	`13`	`{`
`14`	`14`	`public function contentcontrollerInit(ContentController $controller): void`
`15`	`15`	`{`