feat: add extension for phpunit >= 10

Author: marmichalski

src/Extension/TestFinishedSubscriber.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VCR\PHPUnit\TestListener\Extension;
+
+use PHPUnit\Event\Test\Finished;
+use PHPUnit\Event\Test\FinishedSubscriber;
+use VCR\PHPUnit\TestListener\VCRTestHandler;
+
+final class TestFinishedSubscriber implements FinishedSubscriber
+{
+    public function notify(Finished $event): void
+    {
+        VCRTestHandler::onEnd();
+    }
+}

src/Extension/TestPreparationStartedSubscriber.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VCR\PHPUnit\TestListener\Extension;
+
+use PHPUnit\Event\Code\TestMethod;
+use PHPUnit\Event\Test\PreparationStarted;
+use PHPUnit\Event\Test\PreparationStartedSubscriber;
+use VCR\PHPUnit\TestListener\VCRTestHandler;
+
+final class TestPreparationStartedSubscriber implements PreparationStartedSubscriber
+{
+    public function notify(PreparationStarted $event): void
+    {
+        $testMethod = $event->test();
+        if (!$testMethod instanceof TestMethod) {
+            return;
+        }
+
+        VCRTestHandler::onStart($testMethod->className(), $testMethod->name());
+    }
+}

src/Extension/VCRExtension.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace VCR\PHPUnit\TestListener\Extension;
+
+use PHPUnit\Runner\Extension\Extension;
+use PHPUnit\Runner\Extension\Facade;
+use PHPUnit\Runner\Extension\ParameterCollection;
+use PHPUnit\TextUI\Configuration\Configuration;
+
+/**
+ * An Extension that integrates with PHP-VCR.
+ *
+ * Here is an example XML configuration for activating this listener in PHPUnit >= 10.
+ *
+ * <code>
+ *   <extensions>
+ *     <bootstrap class="VCR\PHPUnit\TestListener\VcrExtension" />
+ *   </extensions>
+ * </code>
+ */
+final class VCRExtension implements Extension
+{
+    public function bootstrap(Configuration $configuration, Facade $facade, ParameterCollection $parameters): void
+    {
+        $facade->registerSubscribers(
+            new TestPreparationStartedSubscriber(),
+            new TestFinishedSubscriber()
+        );
+    }
+}

src/VCRTestHandler.php

@@ -0,0 +1,74 @@
+<?php
+declare(strict_types=1);
+
+namespace VCR\PHPUnit\TestListener;
+
+use PHPUnit\Framework\AssertionFailedError;
+use PHPUnit\Framework\Test;
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\TestListener;
+use PHPUnit\Framework\TestSuite;
+use PHPUnit\Framework\Warning;
+use VCR\VCR;
+
+final class VCRTestHandler
+{
+    private function __construct() {}
+
+    public static function onStart(string $class, string $method): void
+    {
+        if (!method_exists($class, $method)) {
+            return;
+        }
+
+        $reflection = new \ReflectionMethod($class, $method);
+        $docBlock = $reflection->getDocComment();
+
+        // Use regex to parse the doc_block for a specific annotation
+        $parsed = self::parseDocBlock($docBlock, '@vcr');
+        $cassetteName = array_pop($parsed);
+
+        if (empty($cassetteName)) {
+            return;
+        }
+
+        // If the cassette name ends in .json, then use the JSON storage format
+        if (substr($cassetteName, -5) === '.json') {
+            VCR::configure()->setStorage('json');
+        }
+
+        VCR::turnOn();
+        VCR::insertCassette($cassetteName);
+    }
+
+    public static function onEnd(): void
+    {
+        VCR::turnOff();
+    }
+
+    private static function parseDocBlock($docBlock, $tag): array
+    {
+        $matches = [];
+
+        if (empty($docBlock)) {
+            return $matches;
+        }
+
+        $regex = "/{$tag} (.*)(\\r\\n|\\r|\\n)/U";
+        preg_match_all($regex, $docBlock, $matches);
+
+        if (empty($matches[1])) {
+            return array();
+        }
+
+        // Removed extra index
+        $matches = $matches[1];
+
+        // Trim the results, array item by array item
+        foreach ($matches as $ix => $match) {
+            $matches[$ix] = trim($match);
+        }
+
+        return $matches;
+    }
+}

src/VCRTestListener.php

@@ -14,7 +14,7 @@
 /**
  * A TestListener that integrates with PHP-VCR.
  *
- * Here is an example XML configuration for activating this listener:
+ * Here is an example XML configuration for activating this listener in PHPUnit < 10.
  *
  * <code>
  *   <listeners>
@@ -32,61 +32,13 @@ public function startTest(Test $test): void
     {
         $class = \get_class($test);
         \assert($test instanceof TestCase);
-        $method = $test->getName(false);
 
-        if (!method_exists($class, $method)) {
-            return;
-        }
-
-        $reflection = new \ReflectionMethod($class, $method);
-        $docBlock = $reflection->getDocComment();
-
-        // Use regex to parse the doc_block for a specific annotation
-        $parsed = self::parseDocBlock($docBlock, '@vcr');
-        $cassetteName = array_pop($parsed);
-
-        if (empty($cassetteName)) {
-            return;
-        }
-
-        // If the cassette name ends in .json, then use the JSON storage format
-        if (substr($cassetteName, -5) === '.json') {
-            VCR::configure()->setStorage('json');
-        }
-
-        VCR::turnOn();
-        VCR::insertCassette($cassetteName);
-    }
-
-    private static function parseDocBlock($docBlock, $tag): array
-    {
-        $matches = [];
-
-        if (empty($docBlock)) {
-            return $matches;
-        }
-
-        $regex = "/{$tag} (.*)(\\r\\n|\\r|\\n)/U";
-        preg_match_all($regex, $docBlock, $matches);
-
-        if (empty($matches[1])) {
-            return array();
-        }
-
-        // Removed extra index
-        $matches = $matches[1];
-
-        // Trim the results, array item by array item
-        foreach ($matches as $ix => $match) {
-            $matches[$ix] = trim($match);
-        }
-
-        return $matches;
+        VCRTestHandler::onStart($class, $test->getName(false));
     }
 
     public function endTest(Test $test, float $time): void
     {
-        VCR::turnOff();
+        VCRTestHandler::onEnd();
     }
 
     public function addError(Test $test, \Throwable $t, float $time): void