Merge pull request #173 from ably/php82

Improve PHP 8.2 compatibility and testing
ably · Feb 22, 2023 · 0824bb6 · 0824bb6
2 parents c272809 + 46fdc0b
commit 0824bb6
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 13 deletions.
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -14,12 +14,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: [7.2, 7.3, 7.4, 8.0, 8.1]
+        php-version: [7.2, 7.3, 7.4, 8.0, 8.1, 8.2]
         protocol: [ 'json', 'msgpack' ]
         ignorePlatformReq: [ '' ]
-        include:
-          - php-version: 8.2
-            ignorePlatformReq: '--ignore-platform-req=php+'
 
     steps:
       - uses: actions/checkout@v2

diff --git a/composer.json b/composer.json
@@ -25,6 +25,11 @@
             "Ably\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "tests\\": "tests/"
+        }
+    },
     "scripts": {
         "test": "vendor/bin/phpunit"
     }

diff --git a/tests/AblyRestTest.php b/tests/AblyRestTest.php
@@ -12,6 +12,8 @@
 
 class AblyRestTest extends \PHPUnit\Framework\TestCase {
 
+    use AssertsRegularExpressions;
+
     protected static $testApp;
     protected static $defaultOptions;
 
@@ -84,7 +86,7 @@ public function testInitLibWithSpecifiedHost() {
         ];
         $ably = new AblyRest( $opts );
         $ably->time(); // make a request
-        $this->assertRegExp( '/^https?:\/\/some\.other\.host/', $ably->http->lastUrl, 'Unexpected host mismatch' );
+        $this->assertMatchesRegularExpression( '/^https?:\/\/some\.other\.host/', $ably->http->lastUrl, 'Unexpected host mismatch' );
     }
 
     /**
@@ -144,7 +146,7 @@ public function testTLSDefaultIsTrue() {
         ];
         $ably = new AblyRest( $opts );
         $ably->time(); // make a request
-        $this->assertRegExp( '/^https:\/\/rest\.ably\.io/', $ably->http->lastUrl, 'Unexpected scheme/url mismatch' );
+        $this->assertMatchesRegularExpression( '/^https:\/\/rest\.ably\.io/', $ably->http->lastUrl, 'Unexpected scheme/url mismatch' );
     }
 
     /**
@@ -158,7 +160,7 @@ public function testTLSCanBeFalse() {
         ];
         $ably = new AblyRest( $opts );
         $ably->time(); // make a request
-        $this->assertRegExp( '/^http:\/\/rest\.ably\.io/', $ably->http->lastUrl, 'Unexpected scheme/url mismatch' );
+        $this->assertMatchesRegularExpression( '/^http:\/\/rest\.ably\.io/', $ably->http->lastUrl, 'Unexpected scheme/url mismatch' );
     }
 
     /**
@@ -172,7 +174,7 @@ public function testTLSExplicitTrue() {
         ];
         $ably = new AblyRest( $opts );
         $ably->time(); // make a request
-        $this->assertRegExp( '/^https:\/\/rest\.ably\.io/', $ably->http->lastUrl, 'Unexpected scheme/url mismatch' );
+        $this->assertMatchesRegularExpression( '/^https:\/\/rest\.ably\.io/', $ably->http->lastUrl, 'Unexpected scheme/url mismatch' );
     }
 
 

diff --git a/tests/AssertsRegularExpressions.php b/tests/AssertsRegularExpressions.php
@@ -0,0 +1,25 @@
+<?php
+namespace tests;
+
+/**
+ * PHPUnit has deprecated the old function `assertRegExp` for asserting regular
+ * expression matches. However, the versions of PHPUnit compatible with PHP 7.2 do
+ * not have the new version.
+ * 
+ * This trait adds a version of the method that calls the old version for PHP 7.2
+ * or the new version for newer versions.
+ * 
+ * Can be removed once PHP 7.2 is dropped from CI.
+ */
+trait AssertsRegularExpressions
+{
+    public static function assertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void
+    {
+        if (version_compare(phpversion(), '7.3.0', '<')) {
+            self::assertRegExp($pattern, $string, $message);
+            return;
+        }
+
+        parent::assertMatchesRegularExpression($pattern, $string, $message);
+    }
+}
diff --git a/tests/AuthTest.php b/tests/AuthTest.php
@@ -8,11 +8,14 @@
 use Ably\Models\TokenParams;
 use Ably\Models\TokenRequest;
 use Ably\Utils\Miscellaneous;
+use tests\AssertsRegularExpressions;
 
 require_once __DIR__ . '/factories/TestApp.php';
 
 class AuthTest extends \PHPUnit\Framework\TestCase {
 
+    use AssertsRegularExpressions;
+
     protected static $testApp;
     protected static $defaultOptions;
 
@@ -304,9 +307,11 @@ public function testCreateTokenRequestValidity() {
         $ably->auth->authorize();
 
         $this->assertFalse( $ably->auth->isUsingBasicAuth(), 'Expected token auth to be used' );
-        $this->assertGreaterThanOrEqual( $timestamp, $ably->auth->getTokenDetails()->issued,
-            'Expected token issued timestamp to be greater than or equal to the time of the request' );
-
+        $this->assertLessThan(
+            200,
+            abs($timestamp - $ably->auth->getTokenDetails()->issued),
+            'Expected token issued timestamp to be near to the time of request (allowing for clock skew)'
+        );
         $ably->stats(); // requires valid token, throws exception if invalid
     }
 
@@ -543,7 +548,7 @@ public function testHTTPHeadersKey() {
 
         $ably->get("/dummy_test");
 
-        $this->assertRegExp('/Authorization\s*:\s*Basic\s+'.base64_encode($fakeKey).'/i', $ably->http->headers[0]);
+        $this->assertMatchesRegularExpression('/Authorization\s*:\s*Basic\s+'.base64_encode($fakeKey).'/i', $ably->http->headers[0]);
     }
 
     /**
@@ -558,7 +563,7 @@ public function testHTTPHeadersToken() {
 
         $ably->get("/dummy_test");
 
-        $this->assertRegExp('/Authorization\s*:\s*Bearer\s+'.base64_encode($fakeToken).'/i', $ably->http->headers[0]);
+        $this->assertMatchesRegularExpression('/Authorization\s*:\s*Bearer\s+'.base64_encode($fakeToken).'/i', $ably->http->headers[0]);
     }
 }