Merge pull request #72 from Codeception/6.0-symfony5

Symfony 5 support for PHPUnit 5.7

Author: Naktibalda

src/DispatcherWrapper.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Codeception\PHPUnit;
+
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface;
+
+trait DispatcherWrapper
+{
+    /**
+     * Compatibility wrapper for dispatcher change between Symfony 4 and 5
+     * @param EventDispatcher $dispatcher
+     * @param string $eventType
+     * @param Event $eventObject
+     */
+    protected function dispatch(EventDispatcher $dispatcher, $eventType, Event $eventObject)
+    {
+        //TraceableEventDispatcherInterface was introduced in symfony/event-dispatcher 2.5 and removed in 5.0
+        if (!interface_exists(TraceableEventDispatcherInterface::class)) {
+            //Symfony 5
+            $dispatcher->dispatch($eventObject, $eventType);
+        } else {
+            //Symfony 2,3 or 4
+            $dispatcher->dispatch($eventType, $eventObject);
+        }
+
+    }
+}

src/Listener.php

@@ -1,17 +1,18 @@
 <?php
 namespace Codeception\PHPUnit;
 
+use Codeception\PHPUnit\DispatcherWrapper;
 use Codeception\Event\FailEvent;
 use Codeception\Event\SuiteEvent;
 use Codeception\Event\TestEvent;
 use Codeception\Events;
 use Codeception\TestInterface;
-use Exception;
-use PHPUnit\Framework\Test;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
 class Listener implements \PHPUnit\Framework\TestListener
 {
+    use DispatcherWrapper;
+
     /**
      * @var \Symfony\Component\EventDispatcher\EventDispatcher
      */
@@ -34,7 +35,7 @@ public function __construct(EventDispatcher $dispatcher)
      * @param float $time
      * @since  Method available since Release 4.0.0
      */
-    public function addRiskyTest(\PHPUnit\Framework\Test $test, Exception $e, $time)
+    public function addRiskyTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
     {
     }
 
@@ -79,17 +80,17 @@ public function addSkippedTest(\PHPUnit\Framework\Test $test, \Exception $e, $ti
 
     public function startTestSuite(\PHPUnit\Framework\TestSuite $suite)
     {
-        $this->dispatcher->dispatch('suite.start', new SuiteEvent($suite));
+        $this->dispatch($this->dispatcher, 'suite.start', new SuiteEvent($suite));
     }
 
     public function endTestSuite(\PHPUnit\Framework\TestSuite $suite)
     {
-        $this->dispatcher->dispatch('suite.end', new SuiteEvent($suite));
+        $this->dispatch($this->dispatcher, 'suite.end', new SuiteEvent($suite));
     }
 
     public function startTest(\PHPUnit\Framework\Test $test)
     {
-        $this->dispatcher->dispatch(Events::TEST_START, new TestEvent($test));
+        $this->dispatch($this->dispatcher, Events::TEST_START, new TestEvent($test));
         if (!$test instanceof TestInterface) {
             return;
         }
@@ -119,17 +120,17 @@ public function endTest(\PHPUnit\Framework\Test $test, $time)
             $this->fire(Events::TEST_AFTER, new TestEvent($test, $time));
         }
 
-        $this->dispatcher->dispatch(Events::TEST_END, new TestEvent($test, $time));
+        $this->dispatch($this->dispatcher, Events::TEST_END, new TestEvent($test, $time));
     }
 
     protected function fire($event, TestEvent $eventType)
     {
         $test = $eventType->getTest();
         if ($test instanceof TestInterface) {
             foreach ($test->getMetadata()->getGroups() as $group) {
-                $this->dispatcher->dispatch($event . '.' . $group, $eventType);
+                $this->dispatch($this->dispatcher, $event . '.' . $group, $eventType);
             }
         }
-        $this->dispatcher->dispatch($event, $eventType);
+        $this->dispatch($this->dispatcher, $event, $eventType);
     }
 }

src/ResultPrinter/UI.php

@@ -3,12 +3,15 @@
 
 use Codeception\Event\FailEvent;
 use Codeception\Events;
+use Codeception\PHPUnit\DispatcherWrapper;
 use Codeception\Test\Unit;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
 class UI extends \PHPUnit\TextUI\ResultPrinter
 {
+    use DispatcherWrapper;
+
     /**
      * @var EventDispatcher
      */
@@ -23,7 +26,8 @@ public function __construct(EventDispatcher $dispatcher, $options, $out = null)
     protected function printDefect(\PHPUnit\Framework\TestFailure $defect, $count)
     {
         $this->write("\n---------\n");
-        $this->dispatcher->dispatch(
+        $this->dispatch(
+            $this->dispatcher,
             Events::TEST_FAIL_PRINT,
             new FailEvent($defect->failedTest(), null, $defect->thrownException(), $count)
         );