#6 Improve test coverage for FlockMutex

Author: willemstuursma

classes/exception/DeadlineException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace malkusch\lock\exception;
+
+class DeadlineException extends \Exception
+{
+
+}

classes/exception/TimeoutException.php

@@ -11,5 +11,12 @@
  */
 class TimeoutException extends LockAcquireException
 {
-
+    /**
+     * @param int $timeout
+     * @return TimeoutException
+     */
+    public static function create($timeout)
+    {
+        return new self(sprintf("Timeout of %d seconds exceeded.", $timeout));
+    }
 }

classes/mutex/FlockMutex.php

@@ -2,6 +2,7 @@
 
 namespace malkusch\lock\mutex;
 
+use malkusch\lock\exception\DeadlineException;
 use malkusch\lock\exception\ExecutionOutsideLockException;
 use malkusch\lock\exception\LockAcquireException;
 use malkusch\lock\exception\LockReleaseException;
@@ -99,9 +100,15 @@ private function lockPcntl()
     {
         $timebox = new PcntlTimeout($this->timeout);
 
-        $timebox->timeBoxed(function () {
-            $this->lockBlocking();
-        });
+        try {
+            $timebox->timeBoxed(
+                function () {
+                    $this->lockBlocking();
+                }
+            );
+        } catch (DeadlineException $e) {
+            throw TimeoutException::create($this->timeout);
+        }
     }
 
     /**

classes/mutex/MySQLMutex.php

@@ -62,7 +62,7 @@ public function lock()
             throw new LockAcquireException("An error occurred while acquiring the lock");
         }
 
-        throw new TimeoutException("Timeout when acquiring lock.");
+        throw TimeoutException::create($this->timeout);
     }
 
     public function unlock()

classes/mutex/PgAdvisoryLockMutex.php

@@ -2,9 +2,6 @@
 
 namespace malkusch\lock\mutex;
 
-use malkusch\lock\exception\LockAcquireException;
-use malkusch\lock\exception\TimeoutException;
-
 class PgAdvisoryLockMutex extends LockMutex
 {
     /**

classes/util/Loop.php

@@ -69,10 +69,10 @@ public function execute(callable $code)
     {
         $this->looping = true;
         $minWait = 100; // microseconds
-        $timeout = microtime(true) + $this->timeout; // At this time, the lock will time out.
+        $deadline = microtime(true) + $this->timeout; // At this time, the lock will time out.
         $result = null;
 
-        for ($i = 0; $this->looping && microtime(true) < $timeout; $i++) {
+        for ($i = 0; $this->looping && microtime(true) < $deadline; $i++) {
             $result = call_user_func($code);
             if (!$this->looping) {
                 break;
@@ -84,22 +84,22 @@ public function execute(callable $code)
             /*
              * Calculate max time remaining, don't sleep any longer than that.
              */
-            $usecRemaining = \intval(($timeout - microtime(true))  * 1e6);
+            $usecRemaining = \intval(($deadline - microtime(true))  * 1e6);
 
             if ($usecRemaining <= 0) {
                 /*
                  * We've ran out of time.
                  */
-                throw new TimeoutException("Timeout of $this->timeout seconds exceeded.");
+                throw TimeoutException::create($this->timeout);
             }
 
             $usleep = \min($usecRemaining, \random_int($min, $max));
 
             usleep($usleep);
         }
 
-        if (microtime(true) >= $timeout) {
-            throw new TimeoutException("Timeout of $this->timeout seconds exceeded.");
+        if (microtime(true) >= $deadline) {
+            throw TimeoutException::create($this->timeout);
         }
 
         return $result;

classes/util/PcntlTimeout.php

@@ -2,6 +2,7 @@
 
 namespace malkusch\lock\util;
 
+use malkusch\lock\exception\DeadlineException;
 use malkusch\lock\exception\TimeoutException;
 use malkusch\lock\exception\LockAcquireException;
 
@@ -34,7 +35,7 @@ public function __construct($timeout)
             throw new \RuntimeException("PCNTL module not enabled");
         }
         if ($timeout <= 0) {
-            throw new \InvalidArgumentException("Timeout must be positiv and non zero");
+            throw new \InvalidArgumentException("Timeout must be positive and non zero");
         }
         $this->timeout = $timeout;
     }
@@ -52,13 +53,13 @@ public function __construct($timeout)
      * @param callable $code Executed code block
      * @return mixed Return value of the executed block
      *
-     * @throws TimeoutException Running the code timed out
+     * @throws DeadlineException Running the code hit the deadline
      * @throws LockAcquireException Installing the timeout failed
      */
     public function timeBoxed(callable $code)
     {
         $signal = pcntl_signal(SIGALRM, function () {
-            throw new TimeoutException("Timed out");
+            throw new DeadlineException(sprintf("Timebox hit deadline of %d seconds", $this->timeout));
         });
         if (!$signal) {
             throw new LockAcquireException("Could not install signal");

tests/mutex/FlockMutexTest.php

@@ -3,6 +3,7 @@
 namespace malkusch\lock\mutex;
 
 use Eloquent\Liberator\Liberator;
+use malkusch\lock\util\PcntlTimeout;
 
 /**
  * @author Willem Stuursma-Ruwen <[email protected]>
@@ -52,6 +53,7 @@ public function testCodeExecutedOutsideLockIsNotThrown($strategy)
 
     /**
      * @expectedException \malkusch\lock\exception\TimeoutException
+     * @expectedExceptionMessage Timeout of 1 seconds exceeded.
      * @dataProvider dpTimeoutableStrategies
      */
     public function testTimeoutOccurs($strategy)
@@ -79,4 +81,22 @@ public function dpTimeoutableStrategies()
             [FlockMutex::STRATEGY_BUSY],
         ];
     }
+
+    /**
+     * @expectedException \malkusch\lock\exception\DeadlineException
+     */
+    public function testNoTimeoutWaitsForever()
+    {
+        $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->fail("Did not expect code execution.");
+            });
+        });
+    }
 }

tests/mutex/RedisMutexTest.php

@@ -125,6 +125,7 @@ function () use (&$i, $available) {
      *
      * @test
      * @expectedException \malkusch\lock\exception\TimeoutException
+     * @expectedExceptionMessage Timeout of 1 seconds exceeded.
      * @dataProvider provideMinority
      */
     public function testAcquireTooFewKeys($count, $available)

tests/mutex/SpinlockMutexTest.php

@@ -52,13 +52,15 @@ public function testFailAcquireLock()
     /**
      * Tests failing to acquire the lock due to a timeout.
      *
-     * @test
-     * @expectedException malkusch\lock\exception\TimeoutException
+     * @expectedException \malkusch\lock\exception\TimeoutException
+     * @expectedExceptionMessage Timeout of 3 seconds exceeded.
      */
     public function testAcquireTimesOut()
     {
         $mutex = $this->getMockForAbstractClass(SpinlockMutex::class, ["test"]);
-        $mutex->expects($this->any())->method("acquire")->willReturn(false);
+        $mutex->expects($this->atLeastOnce())
+            ->method("acquire")
+            ->willReturn(false);
 
         $mutex->synchronized(function () {
             $this->fail("execution is not expected");