Merge pull request jobbyphp#61 from garethellis36/make-tests-pass-on-windows

Make tests pass on Windows

Author: hellogerard

tests/BackgroundJobTest.php

@@ -21,6 +21,11 @@ class BackgroundJobTest extends \PHPUnit_Framework_TestCase
      */
     private $logFile;
 
+    /**
+     * @var Helper
+     */
+    private $helper;
+
     /**
      * {@inheritdoc}
      */
@@ -30,6 +35,8 @@ protected function setUp()
         if (file_exists($this->logFile)) {
             unlink($this->logFile);
         }
+
+        $this->helper = new Helper();
     }
 
     /**
@@ -89,11 +96,19 @@ public function testInvalidCommand()
         $this->runJob(['command' => 'invalid-command']);
 
         $this->assertContains('invalid-command', $this->getLogContent());
-        $this->assertContains('not found', $this->getLogContent());
-        $this->assertContains(
-            "ERROR: Job exited with status '127'",
-            $this->getLogContent()
-        );
+
+        if ($this->helper->getPlatform() === Helper::UNIX) {
+            $this->assertContains('not found', $this->getLogContent());
+            $this->assertContains(
+                "ERROR: Job exited with status '127'",
+                $this->getLogContent()
+            );
+        } else {
+            $this->assertContains(
+                'not recognized as an internal or external command',
+                $this->getLogContent()
+            );
+        }
     }
 
     /**
@@ -207,6 +222,10 @@ public function testMailShouldTriggerHelper()
      */
     public function testCheckMaxRuntime()
     {
+        if ($this->helper->getPlatform() !== Helper::UNIX) {
+            $this->markTestSkipped("'maxRuntime' is not supported on Windows");
+        }
+
         $helper = $this->getMock('Jobby\Helper', ['getLockLifetime']);
         $helper->expects($this->once())
             ->method('getLockLifetime')
@@ -229,6 +248,10 @@ public function testCheckMaxRuntime()
      */
     public function testCheckMaxRuntimeShouldFailIsExceeded()
     {
+        if ($this->helper->getPlatform() !== Helper::UNIX) {
+            $this->markTestSkipped("'maxRuntime' is not supported on Windows");
+        }
+
         $helper = $this->getMock('Jobby\Helper', ['getLockLifetime']);
         $helper->expects($this->once())
             ->method('getLockLifetime')

tests/HelperTest.php

@@ -25,6 +25,11 @@ class HelperTest extends \PHPUnit_Framework_TestCase
      */
     private $lockFile;
 
+    /**
+     * @var string
+     */
+    private $copyOfLockFile;
+
     /**
      * {@inheritdoc}
      */
@@ -33,6 +38,7 @@ protected function setUp()
         $this->helper = new Helper();
         $this->tmpDir = $this->helper->getTempDir();
         $this->lockFile = $this->tmpDir . '/test.lock';
+        $this->copyOfLockFile = $this->tmpDir . "/test.lock.copy";
     }
 
     /**
@@ -106,7 +112,17 @@ public function testAquireAndReleaseLock()
     public function testLockFileShouldContainCurrentPid()
     {
         $this->helper->acquireLock($this->lockFile);
-        $this->assertEquals(getmypid(), file_get_contents($this->lockFile));
+
+        //on Windows, file locking is mandatory not advisory, so you can't do file_get_contents on a locked file
+        //therefore, we need to make a copy of the lock file in order to read its contents
+        if ($this->helper->getPlatform() === Helper::WINDOWS) {
+            copy($this->lockFile, $this->copyOfLockFile);
+            $lockFile = $this->copyOfLockFile;
+        } else {
+            $lockFile = $this->lockFile;
+        }
+
+        $this->assertEquals(getmypid(), file_get_contents($lockFile));
 
         $this->helper->releaseLock($this->lockFile);
         $this->assertEmpty(file_get_contents($this->lockFile));
@@ -136,6 +152,10 @@ public function testLockLifetimeShouldBeZeroIfFileIsEmpty()
      */
     public function testLockLifetimeShouldBeZeroIfItContainsAInvalidPid()
     {
+        if ($this->helper->getPlatform() === Helper::WINDOWS) {
+            $this->markTestSkipped("Test relies on posix_ functions");
+        }
+
         file_put_contents($this->lockFile, 'invalid-pid');
         $this->assertEquals(0, $this->helper->getLockLifetime($this->lockFile));
     }
@@ -145,6 +165,10 @@ public function testLockLifetimeShouldBeZeroIfItContainsAInvalidPid()
      */
     public function testGetLocklifetime()
     {
+        if ($this->helper->getPlatform() === Helper::WINDOWS) {
+            $this->markTestSkipped("Test relies on posix_ functions");
+        }
+
         $this->helper->acquireLock($this->lockFile);
 
         $this->assertEquals(0, $this->helper->getLockLifetime($this->lockFile));

tests/JobbyTest.php

@@ -2,6 +2,7 @@
 
 namespace Jobby\Tests;
 
+use Jobby\Helper;
 use Jobby\Jobby;
 use SuperClosure\SerializableClosure;
 
@@ -15,6 +16,11 @@ class JobbyTest extends \PHPUnit_Framework_TestCase
      */
     private $logFile;
 
+    /**
+     * @var Helper
+     */
+    private $helper;
+
     /**
      * {@inheritdoc}
      */
@@ -24,6 +30,8 @@ protected function setUp()
         if (file_exists($this->logFile)) {
             unlink($this->logFile);
         }
+        
+        $this->helper = new Helper();
     }
 
     /**
@@ -54,7 +62,7 @@ public function testShell()
         $jobby->run();
 
         // Job runs asynchronously, so wait a bit
-        sleep(1);
+        sleep($this->getSleepTime());
 
         $this->assertEquals('Hello World!', $this->getLogContent());
     }
@@ -83,7 +91,7 @@ public function testSuperClosure()
         $jobby->run();
 
         // Job runs asynchronously, so wait a bit
-        sleep(1);
+        sleep($this->getSleepTime());
 
         $this->assertEquals('Another function!', $this->getLogContent());
     }
@@ -110,7 +118,7 @@ public function testClosure()
         $jobby->run();
 
         // Job runs asynchronously, so wait a bit
-        sleep(1);
+        sleep($this->getSleepTime());
 
         $this->assertEquals('A function!', $this->getLogContent());
     }
@@ -147,7 +155,7 @@ public function testShouldRunAllJobsAdded()
         $jobby->run();
 
         // Job runs asynchronously, so wait a bit
-        sleep(1);
+        sleep($this->getSleepTime());
 
         $this->assertContains('job-1', $this->getLogContent());
         $this->assertContains('job-2', $this->getLogContent());
@@ -174,7 +182,7 @@ public function testDefaultOptionsShouldBeMerged()
         $jobby->run();
 
         // Job runs asynchronously, so wait a bit
-        sleep(1);
+        sleep($this->getSleepTime());
 
         $this->assertEquals('A function!', $this->getLogContent());
     }
@@ -272,6 +280,10 @@ public function testShouldRunJobsAsync()
 
     public function testShouldFailIfMaxRuntimeExceeded()
     {
+        if ($this->helper->getPlatform() === Helper::WINDOWS) {
+            $this->markTestSkipped("'maxRuntime' is not supported on Windows");
+        }
+
         $jobby = new Jobby();
         $jobby->add(
             'slow job',
@@ -298,4 +310,9 @@ private function getLogContent()
     {
         return file_get_contents($this->logFile);
     }
+
+    private function getSleepTime()
+    {
+        return $this->helper->getPlatform() === Helper::UNIX ? 1 : 2;
+    }
 }