Trait magic to support PHPUnit 6, 7, and 8

Author: trowski

composer.json

@@ -7,14 +7,18 @@
         {
             "name": "Niklas Keller",
             "email": "[email protected]"
+        },
+        {
+            "name": "Aaron Piotrowski",
+            "email": "[email protected]"
         }
     ],
     "support": {
         "issues": "https://github.com/amphp/phpunit-util/issues",
         "irc": "irc://irc.freenode.org/amphp"
     },
     "require": {
-        "phpunit/phpunit": "^6"
+        "phpunit/phpunit": "^6 | ^7 | ^8"
     },
     "require-dev": {
         "amphp/amp": "^2",

phpunit.xml.dist

@@ -25,7 +25,4 @@
             <directory suffix=".php">src</directory>
         </whitelist>
     </filter>
-    <listeners>
-        <listener class="Amp\PHPUnit\LoopReset"/>
-    </listeners>
 </phpunit>

src/AsyncTestCase.php

@@ -13,36 +13,17 @@
  */
 abstract class AsyncTestCase extends PHPUnitTestCase
 {
+    use Internal\AsyncTestSetNameTrait,
+        Internal\AsyncTestSetUpTrait;
+
     const RUNTIME_PRECISION = 2;
 
     /** @var string|null Timeout watcher ID. */
     private $timeoutId;
 
-    /** @var string Temporary storage for actual test name. */
-    private $realTestName;
-
     /** @var int Minimum runtime in milliseconds. */
     private $minimumRuntime = 0;
 
-    /** @var bool */
-    private $setUpInvoked = false;
-
-    protected function setUp()
-    {
-        $this->setUpInvoked = true;
-        Loop::set((new Loop\DriverFactory)->create());
-        \gc_collect_cycles(); // extensions using an event loop may otherwise leak the file descriptors to the loop
-    }
-
-    /**
-     * @codeCoverageIgnore Invoked before code coverage data is being collected.
-     */
-    final public function setName($name)
-    {
-        parent::setName($name);
-        $this->realTestName = $name;
-    }
-
     final protected function runTest()
     {
         parent::setName('runAsyncTest');

src/Internal/AsyncTestSetNameTrait.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Amp\PHPUnit\Internal;
+
+use PHPUnit\Framework\TestCase;
+
+if ((new \ReflectionMethod(TestCase::class, 'setName'))->hasReturnType()) {
+    // PHPUnit 7+
+    trait AsyncTestSetNameTrait
+    {
+        /** @var string Temporary storage for actual test name. */
+        private $realTestName;
+
+        /**
+         * @codeCoverageIgnore Invoked before code coverage data is being collected.
+         */
+        final public function setName(string $name): void
+        {
+            parent::setName($name);
+            $this->realTestName = $name;
+        }
+    }
+} else {
+    // PHPUnit 6
+    trait AsyncTestSetNameTrait
+    {
+        /** @var string Temporary storage for actual test name. */
+        private $realTestName;
+
+        /**
+         * @codeCoverageIgnore Invoked before code coverage data is being collected.
+         */
+        final public function setName($name)
+        {
+            parent::setName($name);
+            $this->realTestName = $name;
+        }
+    }
+}

src/Internal/AsyncTestSetUpTrait.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Amp\PHPUnit\Internal;
+
+use Amp\Loop;
+use PHPUnit\Framework\TestCase;
+
+if ((new \ReflectionMethod(TestCase::class, 'setUp'))->hasReturnType()) {
+    // PHPUnit 8+
+    trait AsyncTestSetUpTrait
+    {
+        /** @var bool */
+        private $setUpInvoked = false;
+
+        protected function setUp(): void
+        {
+            $this->setUpInvoked = true;
+            Loop::set((new Loop\DriverFactory)->create());
+            \gc_collect_cycles(); // extensions using an event loop may otherwise leak the file descriptors to the loop
+        }
+    }
+} else {
+    // PHPUnit 6 or 7
+    trait AsyncTestSetUpTrait
+    {
+        /** @var bool */
+        private $setUpInvoked = false;
+
+        protected function setUp()
+        {
+            $this->setUpInvoked = true;
+            Loop::set((new Loop\DriverFactory)->create());
+            \gc_collect_cycles(); // extensions using an event loop may otherwise leak the file descriptors to the loop
+        }
+    }
+}

test/InvalidAsyncTestCaseTest.php

@@ -5,22 +5,38 @@
 use Amp\PHPUnit\AsyncTestCase;
 use PHPUnit\Framework\AssertionFailedError;
 
-class InvalidAsyncTestCaseTest extends AsyncTestCase
-{
-    protected function setUp()
+if ((new \ReflectionMethod(AsyncTestCase::class, 'setUp'))->hasReturnType()) {
+    // PHPUnit 8+
+    class InvalidAsyncTestCaseTest extends AsyncTestCase
     {
-        // No call to parent::setUp()
+        protected function setUp(): void
+        {
+            // No call to parent::setUp()
 
-        $this->expectException(AssertionFailedError::class);
-        $this->expectExceptionMessage('without calling the parent method');
-    }
+            $this->expectException(AssertionFailedError::class);
+            $this->expectExceptionMessage('without calling the parent method');
+        }
 
-    /**
-     * @expectedException \Error
-     * @expectedExceptionMessage without calling the parent method
-     */
-    public function testMethod()
+        public function testMethod()
+        {
+            // Test will fail because setUp() did not call the parent method
+        }
+    }
+} else {
+    // PHPUnit 6 or 7
+    class InvalidAsyncTestCaseTest extends AsyncTestCase
     {
-        // Test will fail because setUp() did not call the parent method
+        protected function setUp()
+        {
+            // No call to parent::setUp()
+
+            $this->expectException(AssertionFailedError::class);
+            $this->expectExceptionMessage('without calling the parent method');
+        }
+
+        public function testMethod()
+        {
+            // Test will fail because setUp() did not call the parent method
+        }
     }
 }