Merge pull request #38 from php-lock/php-7.2

Upgrade to require minimum of PHP 7.2 and PHPUnit 9

Author: Willem Stuursma-Ruwen

.gitignore

@@ -1,5 +1,6 @@
 /.idea
+/.php_cs
+/.phpunit.result.cache
 /vendor
 /composer.lock
 /phpunit.xml
-/.php_cs

.travis.yml

@@ -5,7 +5,6 @@ cache:
     - $HOME/.composer/cache
 
 php:
-  - 7.1
   - 7.2
   - 7.3
   - 7.4

classes/mutex/PgAdvisoryLockMutex.php

@@ -36,7 +36,7 @@ public function __construct(\PDO $PDO, string $name)
             throw new RuntimeException('Unable to hash the key, sha256 algorithm is not supported.');
         }
 
-        list($bytes1, $bytes2) = str_split($hashed_name, 4);
+        [$bytes1, $bytes2] = str_split($hashed_name, 4);
 
         $this->key1 = unpack('i', $bytes1)[1];
         $this->key2 = unpack('i', $bytes2)[1];

classes/mutex/SpinlockMutex.php

@@ -30,7 +30,7 @@ abstract class SpinlockMutex extends LockMutex
     private $timeout;
 
     /**
-     * @var \malkusch\lock\util\Loop The loop.
+     * @var Loop The loop.
      */
     private $loop;
 

classes/util/Loop.php

@@ -22,14 +22,14 @@ class Loop
      *
      * @var double
      */
-    private const MINIMUM_WAIT_US = 1e4;
+    private const MINIMUM_WAIT_US = 1e4; // 0.01 seconds
 
     /**
      * Maximum time that we want to wait, between lock checks. In micro seconds.
      *
      * @var double
      */
-    private const MAXIMUM_WAIT_US = 1e6;
+    private const MAXIMUM_WAIT_US = 5e5; // 0.50 seconds
 
     /**
      * @var int The timeout in seconds.
@@ -110,7 +110,7 @@ public function execute(callable $code)
             }
 
             $min = min(
-                (int) self::MINIMUM_WAIT_US * 1.5 ** $i,
+                (int) self::MINIMUM_WAIT_US * 1.25 ** $i,
                 self::MAXIMUM_WAIT_US
             );
             $max = min($min * 2, self::MAXIMUM_WAIT_US);

composer.json

@@ -42,25 +42,25 @@
         }
     },
     "require": {
-        "php": ">=7.1",
+        "php": "^7.2",
         "psr/log": "^1"
     },
     "require-dev": {
         "ext-memcached": "*",
         "ext-pcntl": "*",
+        "ext-pdo": "*",
         "ext-pdo_mysql": "*",
         "ext-pdo_sqlite": "*",
         "ext-sysvsem": "*",
         "eloquent/liberator": "^2.0",
-        "friendsofphp/php-cs-fixer": "^2.14",
+        "friendsofphp/php-cs-fixer": "^2.16",
         "johnkary/phpunit-speedtrap": "^3.0",
-        "kriswallsmith/spork": "^0.3",
         "mikey179/vfsstream": "^1.6",
         "php-mock/php-mock-phpunit": "^2.1",
-        "phpunit/phpunit": "^7.4",
+        "phpunit/phpunit": "^9.4",
         "predis/predis": "^1.1",
-        "squizlabs/php_codesniffer": "^3.3",
-        "symfony/event-dispatcher": "^2.8"
+        "spatie/async": "^1.5",
+        "squizlabs/php_codesniffer": "^3.3"
     },
     "suggest": {
         "ext-igbinary": "To use this library with PHP Redis igbinary serializer enabled.",

phpunit.xml.dist

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.4/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.4/phpunit.xsd"
          backupGlobals="false"
          backupStaticAttributes="false"
          bootstrap="vendor/autoload.php"
@@ -15,11 +15,6 @@
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./classes</directory>
-        </whitelist>
-    </filter>
     <listeners>
         <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
     </listeners>

tests/mutex/CASMutexTest.php

@@ -2,6 +2,7 @@
 
 namespace malkusch\lock\mutex;
 
+use malkusch\lock\exception\LockAcquireException;
 use phpmock\environment\SleepEnvironmentBuilder;
 use phpmock\phpunit\PHPMock;
 use PHPUnit\Framework\TestCase;
@@ -18,7 +19,7 @@ class CASMutexTest extends TestCase
 {
     use PHPMock;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
@@ -33,11 +34,11 @@ protected function setUp()
 
     /**
      * Tests exceeding the execution timeout.
-     *
-     * @expectedException malkusch\lock\exception\LockAcquireException
      */
     public function testExceedTimeout()
     {
+        $this->expectException(LockAcquireException::class);
+
         $mutex = new CASMutex(1);
         $mutex->synchronized(function (): void {
             sleep(2);
@@ -46,11 +47,11 @@ public function testExceedTimeout()
 
     /**
      * Tests that an exception would stop any further iteration.
-     *
-     * @expectedException \DomainException
      */
     public function testExceptionStopsIteration()
     {
+        $this->expectException(\DomainException::class);
+
         $mutex = new CASMutex();
         $mutex->synchronized(function () {
             throw new \DomainException();

tests/mutex/FlockMutexTest.php

@@ -3,6 +3,8 @@
 namespace malkusch\lock\mutex;
 
 use Eloquent\Liberator\Liberator;
+use malkusch\lock\exception\DeadlineException;
+use malkusch\lock\exception\TimeoutException;
 use malkusch\lock\util\PcntlTimeout;
 use PHPUnit\Framework\TestCase;
 
@@ -24,15 +26,15 @@ class FlockMutexTest extends TestCase
      */
     private $file;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
         $this->file = tempnam(sys_get_temp_dir(), 'flock-');
         $this->mutex = Liberator::liberate(new FlockMutex(fopen($this->file, 'r'), 1));
     }
 
-    protected function tearDown()
+    protected function tearDown(): void
     {
         unlink($this->file);
 
@@ -54,12 +56,13 @@ public function testCodeExecutedOutsideLockIsNotThrown(int $strategy)
     }
 
     /**
-     * @expectedException \malkusch\lock\exception\TimeoutException
-     * @expectedExceptionMessage Timeout of 1 seconds exceeded.
      * @dataProvider dpTimeoutableStrategies
      */
     public function testTimeoutOccurs(int $strategy)
     {
+        $this->expectException(TimeoutException::class);
+        $this->expectExceptionMessage('Timeout of 1 seconds exceeded.');
+
         $another_resource = fopen($this->file, 'r');
         flock($another_resource, LOCK_EX);
 
@@ -84,19 +87,18 @@ public function dpTimeoutableStrategies()
         ];
     }
 
-    /**
-     * @expectedException \malkusch\lock\exception\DeadlineException
-     */
     public function testNoTimeoutWaitsForever()
     {
+        $this->expectException(DeadlineException::class);
+
         $another_resource = fopen($this->file, 'r');
         flock($another_resource, LOCK_EX);
 
         $this->mutex->strategy = FlockMutex::STRATEGY_BLOCK;
 
         $timebox = new PcntlTimeout(1);
         $timebox->timeBoxed(function () {
-            $this->mutex->synchronized(function () {
+            $this->mutex->synchronized(function (): void {
                 $this->fail('Did not expect code execution.');
             });
         });

tests/mutex/LockMutexTest.php

@@ -21,7 +21,7 @@ class LockMutexTest extends TestCase
      */
     private $mutex;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
@@ -30,23 +30,22 @@ protected function setUp()
 
     /**
      * Tests lock() fails and the code is not executed.
-     *
-     * @expectedException malkusch\lock\exception\LockAcquireException
      */
     public function testLockFails()
     {
+        $this->expectException(LockAcquireException::class);
+
         $this->mutex->expects($this->once())
             ->method('lock')
             ->willThrowException(new LockAcquireException());
 
-        $this->mutex->synchronized(function () {
+        $this->mutex->synchronized(function (): void {
             $this->fail('Should not execute code.');
         });
     }
 
     /**
      * Tests unlock() is called after the code was executed.
-     *
      */
     public function testUnlockAfterCode()
     {
@@ -74,11 +73,11 @@ public function testUnlockAfterException()
 
     /**
      * Tests unlock() fails after the code was executed.
-     *
-     * @expectedException malkusch\lock\exception\LockReleaseException
      */
     public function testUnlockFailsAfterCode()
     {
+        $this->expectException(LockReleaseException::class);
+
         $this->mutex->expects($this->once())
             ->method('unlock')
             ->willThrowException(new LockReleaseException());
@@ -89,11 +88,11 @@ public function testUnlockFailsAfterCode()
 
     /**
      * Tests unlock() fails after the code threw an exception.
-     *
-     * @expectedException malkusch\lock\exception\LockReleaseException
      */
     public function testUnlockFailsAfterException()
     {
+        $this->expectException(LockReleaseException::class);
+
         $this->mutex->expects($this->once())
             ->method('unlock')
             ->willThrowException(new LockReleaseException());