feature symfony#16194 [PhpUnit] Mock clock on @group time-sensitive annotations (nicolas-grekas)

This PR was merged into the 2.8 branch.

Discussion
----------

[PhpUnit] Mock clock on @group time-sensitive annotations

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

Instead of spreading the same clock mock code everywhere, let's create a test case that helps mocking the time related functions.

Commits
-------

34a0846 [PhpUnit] Mock clock on @group time-sensitive annotations

Author: fabpot

src/Symfony/Bridge/PhpUnit/ClockMock.php

@@ -0,0 +1,113 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\PhpUnit;
+
+/**
+ * @author Nicolas Grekas <[email protected]>
+ */
+class ClockMock
+{
+    private static $now;
+
+    public static function withClockMock($enable = null)
+    {
+        if (null === $enable) {
+            return null !== self::$now;
+        }
+
+        self::$now = is_numeric($enable) ? (float) $enable : ($enable ? microtime(true) : null);
+    }
+
+    public static function time()
+    {
+        if (null === self::$now) {
+            return \time();
+        }
+
+        return (int) self::$now;
+    }
+
+    public static function sleep($s)
+    {
+        if (null === self::$now) {
+            return \sleep($s);
+        }
+
+        self::$now += (int) $s;
+
+        return 0;
+    }
+
+    public static function usleep($us)
+    {
+        if (null === self::$now) {
+            return \usleep($us);
+        }
+
+        self::$now += $us / 1000000;
+    }
+
+    public static function microtime($asFloat = false)
+    {
+        if (null === self::$now) {
+            return \microtime($asFloat);
+        }
+
+        if ($asFloat) {
+            return self::$now;
+        }
+
+        return sprintf("%0.6f %d\n", $now - (int) $now, (int) self::$now);
+    }
+
+    public static function register($class)
+    {
+        $self = get_called_class();
+
+        $mockedNs = array(substr($class, 0, strrpos($class, '\\')));
+        if (strpos($class, '\\Tests\\')) {
+            $ns = str_replace('\\Tests\\', '\\', $class);
+            $mockedNs[] = substr($ns, 0, strrpos($ns, '\\'));
+        }
+        foreach ($mockedNs as $ns) {
+            if (function_exists($ns.'\time')) {
+                continue;
+            }
+            eval(<<<EOPHP
+namespace $ns;
+
+function time()
+{
+    return \\$self::time();
+}
+
+function microtime(\$asFloat = false)
+{
+    return \\$self::microtime(\$asFloat);
+}
+
+function sleep(\$s)
+{
+    return \\$self::sleep(\$s);
+}
+
+function usleep(\$us)
+{
+    return \\$self::usleep(\$us);
+}
+
+EOPHP
+            );
+        }
+    }
+
+}

src/Symfony/Bridge/PhpUnit/SymfonyTestsListener.php

@@ -24,6 +24,7 @@ class SymfonyTestsListener extends \PHPUnit_Framework_BaseTestListener
     private $skippedFile = false;
     private $wasSkipped = array();
     private $isSkipped = array();
+    private $testsStack = array();
 
     public function __destruct()
     {
@@ -82,4 +83,27 @@ public function addSkippedTest(\PHPUnit_Framework_Test $test, \Exception $e, $ti
             $this->isSkipped[$class][$method] = 1;
         }
     }
+
+    public function startTest(\PHPUnit_Framework_Test $test)
+    {
+        if ($test instanceof \PHPUnit_Framework_TestCase) {
+            $groups = \PHPUnit_Util_Test::getGroups(get_class($test), $test->getName());
+
+            if (in_array('time-sensitive', $groups, true)) {
+                ClockMock::register(get_class($test));
+                ClockMock::withClockMock(true);
+            }
+        }
+    }
+
+    public function endTest(\PHPUnit_Framework_Test $test, $time)
+    {
+        if ($test instanceof \PHPUnit_Framework_TestCase) {
+            $groups = \PHPUnit_Util_Test::getGroups(get_class($test), $test->getName());
+
+            if (in_array('time-sensitive', $groups, true)) {
+                ClockMock::withClockMock(false);
+            }
+        }
+    }
 }

src/Symfony/Component/Console/Tests/ClockMock.php

@@ -13,25 +13,13 @@
 
 use Symfony\Component\Console\Helper\ProgressHelper;
 use Symfony\Component\Console\Output\StreamOutput;
-use Symfony\Component\Console\Tests;
-
-require_once __DIR__.'/../ClockMock.php';
 
 /**
  * @group legacy
+ * @group time-sensitive
  */
 class LegacyProgressHelperTest extends \PHPUnit_Framework_TestCase
 {
-    protected function setUp()
-    {
-        Tests\with_clock_mock(true);
-    }
-
-    protected function tearDown()
-    {
-        Tests\with_clock_mock(false);
-    }
-
     public function testAdvance()
     {
         $progress = new ProgressHelper();

src/Symfony/Component/Console/Tests/Helper/LegacyProgressHelperTest.php

@@ -14,22 +14,12 @@
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Helper\Helper;
 use Symfony\Component\Console\Output\StreamOutput;
-use Symfony\Component\Console\Tests;
-
-require_once __DIR__.'/../ClockMock.php';
 
+/**
+ * @group time-sensitive
+ */
 class ProgressBarTest extends \PHPUnit_Framework_TestCase
 {
-    protected function setUp()
-    {
-        Tests\with_clock_mock(true);
-    }
-
-    protected function tearDown()
-    {
-        Tests\with_clock_mock(false);
-    }
-
     public function testMultipleStart()
     {
         $bar = new ProgressBar($output = $this->getOutputStream());

src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php

@@ -18,8 +18,10 @@
  *
  * @author John Kary <[email protected]>
  * @author Hugo Hamon <[email protected]>
+ *
+ * @group time-sensitive
  */
-class CookieTest extends ClockMockTestCase
+class CookieTest extends \PHPUnit_Framework_TestCase
 {
     public function invalidNames()
     {

src/Symfony/Component/HttpFoundation/Tests/ClockMockTestCase.php

@@ -14,7 +14,10 @@
 use Symfony\Component\HttpFoundation\ResponseHeaderBag;
 use Symfony\Component\HttpFoundation\Cookie;
 
-class ResponseHeaderBagTest extends ClockMockTestCase
+/**
+ * @group time-sensitive
+ */
+class ResponseHeaderBagTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @covers Symfony\Component\HttpFoundation\ResponseHeaderBag::allPreserveCase

src/Symfony/Component/HttpFoundation/Tests/CookieTest.php

@@ -12,13 +12,13 @@
 namespace Symfony\Component\HttpFoundation\Tests\Session\Storage\Handler;
 
 use Symfony\Component\HttpFoundation\Session\Storage\Handler\LegacyPdoSessionHandler;
-use Symfony\Component\HttpFoundation\Tests\ClockMockTestCase;
 
 /**
  * @group legacy
  * @requires extension pdo_sqlite
+ * @group time-sensitive
  */
-class LegacyPdoSessionHandlerTest extends ClockMockTestCase
+class LegacyPdoSessionHandlerTest extends \PHPUnit_Framework_TestCase
 {
     private $pdo;
 

src/Symfony/Component/HttpFoundation/Tests/ResponseHeaderBagTest.php

@@ -12,12 +12,12 @@
 namespace Symfony\Component\HttpFoundation\Tests\Session\Storage\Handler;
 
 use Symfony\Component\HttpFoundation\Session\Storage\Handler\MemcacheSessionHandler;
-use Symfony\Component\HttpFoundation\Tests\ClockMockTestCase;
 
 /**
  * @requires extension memcache
+ * @group time-sensitive
  */
-class MemcacheSessionHandlerTest extends ClockMockTestCase
+class MemcacheSessionHandlerTest extends \PHPUnit_Framework_TestCase
 {
     const PREFIX = 'prefix_';
     const TTL = 1000;