PHP 8 Compatibility + GitHub Actions CI

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ci:
+    name: CI
+    uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1
+    with:
+      phplinting: false
+      simple_matrix: true
+      phpcoverage_force_off: true
+      endtoend: false
+      extra_jobs: |
+        - php: '8.0'
+          db: mysql80
+          phpunit: true
+          phpunit_suite: 'all'

README.md

@@ -2,7 +2,7 @@
 
 # SilverStripe RESTful API
 
-[![Build Status](https://travis-ci.org/colymba/silverstripe-restfulapi.png?branch=master)](https://travis-ci.org/colymba/silverstripe-restfulapi)
+[![Build Status](https://github.com/colymba/silverstripe-restfulapi/actions/workflows/ci.yml/badge.svg)](https://github.com/colymba/silverstripe-restfulapi/actions/workflows/ci.yml)
 
 This module implements a RESTful API for read/write access to your SilverStripe Models. It comes bundled with a default Token Authenticator, Query Handler and JSON Serializers, and can be extended to your need and to return XML or other content type via custom components.
 

composer.json

@@ -17,7 +17,7 @@
         "silverstripe/framework": "~4.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "~5.7@stable"
+        "phpunit/phpunit": "^9.5"
     },
     "autoload": {
         "psr-4": {

phpunit.xml

@@ -15,9 +15,11 @@
 	- http://doc.silverstripe.org/framework/en/topics/testing/#configuration
 -->
 <phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
-    <testsuite name="Default">
-        <directory>tests</directory>
-    </testsuite>
+    <testsuites>
+        <testsuite name="Default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
     <groups>
         <exclude>
             <group>CORSPreflight</group>

src/PermissionManagers/DefaultPermissionManager.php

@@ -28,7 +28,7 @@ class DefaultPermissionManager implements PermissionManager
      * @param  string                  $httpMethod  API request HTTP method
      * @return Boolean                              true or false if permission was given or not
      */
-    public function checkPermission($model, $member = null, $httpMethod)
+    public function checkPermission($model, $member = null, $httpMethod = 'GET')
     {
         if (is_string($model)) {
             $model = singleton($model);

src/PermissionManagers/PermissionManager.php

@@ -24,5 +24,5 @@ interface PermissionManager
      * @param  string                  $httpMethod  API request HTTP method
      * @return Boolean                              true or false if permission was given or not
      */
-    public function checkPermission($model, $member = null, $httpMethod);
+    public function checkPermission($model, $member = null, $httpMethod = 'GET');
 }

src/QueryHandlers/DefaultQueryHandler.php

@@ -248,7 +248,7 @@ public function parseQueryParameters(array $params)
      * @param  HTTPRequest         $request        The original HTTP request
      * @return DataObject|DataList                    Result of the search (note: DataList can be empty)
      */
-    public function findModel($model, $id = false, $queryParams, HTTPRequest $request)
+    public function findModel($model, $id = false, $queryParams = [], HTTPRequest $request = null)
     {
         if ($id) {
             $return = DataObject::get_by_id($model, $id);

src/RESTfulAPI.php

@@ -440,7 +440,7 @@ private function setAnswerCORS(HTTPResponse $answer)
         //allowed headers
         $allowedHeaders = '';
         $requestHeaders = $this->request->getHeader('Access-Control-Request-Headers');
-        if ($cors['Allow-Headers'] === '*') {
+        if ($cors['Allow-Headers'] === '*' && $requestHeaders != null) {
             $allowedHeaders = $requestHeaders;
         } else {
             $allowedHeaders = $cors['Allow-Headers'];

src/ThirdParty/Inflector/Inflector.php

@@ -273,7 +273,7 @@ protected static function _cache($type, $key, $value = false)
     public static function reset()
     {
         if (empty(self::$_initialState)) {
-            self::$_initialState = get_class_vars('Inflector');
+            self::$_initialState = get_class_vars(Inflector::class);
             return;
         }
         foreach (self::$_initialState as $key => $val) {

tests/Authenticators/TokenAuthenticatorTest.php

@@ -40,7 +40,7 @@ protected function getAuthenticator()
         return $auth;
     }
 
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
 

tests/PermissionManagers/DefaultPermissionManagerTest.php

@@ -34,7 +34,7 @@ class DefaultPermissionManagerTest extends RESTfulAPITester
         ApiTestLibrary::class,
     );
 
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
 
@@ -83,25 +83,27 @@ public function testReadPermissions()
             'Enabled' => false,
         ));
 
+        $id = ApiTestLibrary::get()->first()->ID;
+
         // GET with permission = OK
         $requestHeaders = $this->getRequestHeaders();
         $requestHeaders['X-Silverstripe-Apitoken'] = $this->getAdminToken();
-        $response = Director::test('api/apitestlibrary/1', null, null, 'GET', null, $requestHeaders);
+        $response = Director::test('api/apitestlibrary/' . $id, null, null, 'GET', null, $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             200,
+            $response->getStatusCode(),
             "Member of 'restfulapi-administrators' Group should be able to READ records."
         );
 
         // GET with NO Permission = BAD
         $requestHeaders = $this->getRequestHeaders();
         $requestHeaders['X-Silverstripe-Apitoken'] = $this->getStrangerToken();
-        $response = Director::test('api/apitestlibrary/1', null, null, 'GET', null, $requestHeaders);
+        $response = Director::test('api/apitestlibrary/' . $id, null, null, 'GET', null, $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             403,
+            $response->getStatusCode(),
             "Member without permission should NOT be able to READ records."
         );
     }
@@ -116,25 +118,27 @@ public function testEditPermissions()
             'Enabled' => false,
         ));
 
+        $id = ApiTestLibrary::get()->first()->ID;
+
         // PUT with permission = OK
         $requestHeaders = $this->getRequestHeaders();
         $requestHeaders['X-Silverstripe-Apitoken'] = $this->getAdminToken();
-        $response = Director::test('api/apitestlibrary/1', null, null, 'PUT', '{"Name":"Api"}', $requestHeaders);
+        $response = Director::test('api/apitestlibrary/' . $id, null, null, 'PUT', '{"Name":"Api"}', $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             200,
+            $response->getStatusCode(),
             "Member of 'restfulapi-administrators' Group should be able to EDIT records."
         );
 
         // PUT with NO Permission = BAD
         $requestHeaders = $this->getRequestHeaders();
         $requestHeaders['X-Silverstripe-Apitoken'] = $this->getStrangerToken();
-        $response = Director::test('api/apitestlibrary/1', null, null, 'PUT', '{"Name":"Api"}', $requestHeaders);
+        $response = Director::test('api/apitestlibrary/' . $id, null, null, 'PUT', '{"Name":"Api"}', $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             403,
+            $response->getStatusCode(),
             "Member without permission should NOT be able to EDIT records."
         );
     }
@@ -155,8 +159,8 @@ public function testCreatePermissions()
         $response = Director::test('api/apitestlibrary', null, null, 'POST', '{"Name":"Api"}', $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             200,
+            $response->getStatusCode(),
             "Member of 'restfulapi-administrators' Group should be able to CREATE records."
         );
 
@@ -166,8 +170,8 @@ public function testCreatePermissions()
         $response = Director::test('api/apitestlibrary', null, null, 'POST', '{"Name":"Api"}', $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             403,
+            $response->getStatusCode(),
             "Member without permission should NOT be able to CREATE records."
         );
     }
@@ -182,25 +186,27 @@ public function testDeletePermissions()
             'Enabled' => false,
         ));
 
+        $id = ApiTestLibrary::get()->first()->ID;
+
         // DELETE with permission = OK
         $requestHeaders = $this->getRequestHeaders();
         $requestHeaders['X-Silverstripe-Apitoken'] = $this->getAdminToken();
-        $response = Director::test('api/apitestlibrary/1', null, null, 'DELETE', null, $requestHeaders);
+        $response = Director::test('api/apitestlibrary/' . $id, null, null, 'DELETE', null, $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             200,
+            $response->getStatusCode(),
             "Member of 'restfulapi-administrators' Group should be able to DELETE records."
         );
 
         // DELETE with NO Permission = BAD
         $requestHeaders = $this->getRequestHeaders();
         $requestHeaders['X-Silverstripe-Apitoken'] = $this->getStrangerToken();
-        $response = Director::test('api/apitestlibrary/1', null, null, 'DELETE', null, $requestHeaders);
+        $response = Director::test('api/apitestlibrary/' . $id, null, null, 'DELETE', null, $requestHeaders);
 
         $this->assertEquals(
-            $response->getStatusCode(),
             403,
+            $response->getStatusCode(),
             "Member without permission should NOT be able to DELETE records."
         );
     }

tests/QueryHandlers/DefaultQueryHandlerTest.php

@@ -43,7 +43,7 @@ class DefaultQueryHandlerTest extends RESTfulAPITester
     /**
      * Turn on API access for the book and widget fixtures by default
      */
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
@@ -81,7 +81,7 @@ protected function getQueryHandler()
         return $qh;
     }
 
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
 
@@ -147,7 +147,10 @@ public function testAPIDisabled()
     public function testFindSingleModel()
     {
         $qh = $this->getQueryHandler();
-        $request = $this->getHTTPRequest('GET', ApiTestBook::class, '1');
+
+        $id = ApiTestBook::get()->first()->ID;
+
+        $request = $this->getHTTPRequest('GET', ApiTestBook::class, $id);
         $result = $qh->handleQuery($request);
 
         $this->assertContainsOnlyInstancesOf(
@@ -156,7 +159,7 @@ public function testFindSingleModel()
             'Single model request should return a DataObject of class model'
         );
         $this->assertEquals(
-            1,
+            $id,
             $result->ID,
             'IDs mismatch. DataObject is not the record requested'
         );

tests/RESTfulAPITester.php

@@ -150,7 +150,7 @@ public function getRequestHeaders($site = null)
         );
     }
 
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
 
@@ -159,7 +159,7 @@ public static function setUpBeforeClass()
         }
     }
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();