Merge pull request #448 from pestphp/feat/retry

feat: adds `--retry` option

.gitignore

@@ -7,6 +7,7 @@ coverage.xml
 /.php-cs-fixer.php
 .php-cs-fixer.cache
 .temp/coverage.php
+.temp/retry.json
 *.swp
 *.swo
 .vscode/

composer.json

@@ -83,7 +83,8 @@
                 "Pest\\Plugins\\Coverage",
                 "Pest\\Plugins\\Init",
                 "Pest\\Plugins\\Version",
-                "Pest\\Plugins\\Environment"
+                "Pest\\Plugins\\Environment",
+                "Pest\\Plugins\\Retry"
             ]
         },
         "laravel": {

overrides/Runner/TestSuiteLoader.php

@@ -85,7 +85,7 @@ final class TestSuiteLoader
             (static function () use ($suiteClassFile) {
                 include_once $suiteClassFile;
 
-                TestSuite::getInstance()->tests->makeIfExists($suiteClassFile);
+                TestSuite::getInstance()->tests->makeIfNeeded($suiteClassFile);
             })();
 
             $loadedClasses = array_values(

src/Bootstrappers/BootSubscribers.php

@@ -20,6 +20,8 @@ final class BootSubscribers
     private static array $subscribers = [
         Subscribers\EnsureConfigurationIsValid::class,
         Subscribers\EnsureConfigurationDefaults::class,
+        Subscribers\EnsureRetryRepositoryExists::class,
+        Subscribers\EnsureFailedTestsAreStoredForRetry::class,
     ];
 
     /**

src/Factories/TestCaseFactory.php

@@ -101,7 +101,7 @@ final class TestCaseFactory
      *
      * @param array<int, TestCaseMethodFactory> $methods
      */
-    public function evaluate(string $filename, array $methods): string
+    public function evaluate(string $filename, array $methods): void
     {
         if ('\\' === DIRECTORY_SEPARATOR) {
             // In case Windows, strtolower drive name, like in UsesCall.
@@ -123,7 +123,7 @@ final class TestCaseFactory
 
         $classFQN = 'P\\' . $relativePath;
         if (class_exists($classFQN)) {
-            return $classFQN;
+            return;
         }
 
         $hasPrintableTestCaseClassFQN = sprintf('\%s', HasPrintableTestCaseName::class);
@@ -142,7 +142,7 @@ final class TestCaseFactory
         }
 
         $methodsCode = implode('', array_map(
-            fn (TestCaseMethodFactory $methodFactory) => $methodFactory->buildForEvaluation(self::$annotations),
+            fn (TestCaseMethodFactory $methodFactory) => $methodFactory->buildForEvaluation($classFQN, self::$annotations),
             $methods
         ));
 
@@ -164,8 +164,6 @@ final class TestCaseFactory
         } catch (ParseError $caught) {
             throw new RuntimeException(sprintf('Unable to create test case for test file at %s', $filename), 1, $caught);
         }
-
-        return $classFQN;
     }
 
     /**

src/Factories/TestCaseMethodFactory.php

@@ -7,6 +7,7 @@ namespace Pest\Factories;
 use Closure;
 use Pest\Exceptions\ShouldNotHappen;
 use Pest\Factories\Concerns\HigherOrderable;
+use Pest\Plugins\Retry;
 use Pest\Repositories\DatasetsRepository;
 use Pest\Support\Str;
 use Pest\TestSuite;
@@ -107,7 +108,7 @@ final class TestCaseMethodFactory
      *
      * @param array<int, class-string> $annotationsToUse
      */
-    public function buildForEvaluation(array $annotationsToUse): string
+    public function buildForEvaluation(string $classFQN, array $annotationsToUse): string
     {
         if ($this->description === null) {
             throw ShouldNotHappen::fromMessage('The test description may not be empty.');
@@ -115,6 +116,10 @@ final class TestCaseMethodFactory
 
         $methodName = Str::evaluable($this->description);
 
+        if (Retry::$retrying && !TestSuite::getInstance()->retryTempRepository->exists(sprintf('%s::%s', $classFQN, $methodName))) {
+            return '';
+        }
+
         $datasetsCode = '';
         $annotations  = ['@test'];
 

src/Plugins/Concerns/HandleArguments.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Plugins\Concerns;
+
+/**
+ * @internal
+ */
+trait HandleArguments
+{
+    /**
+     * Checks if the given argument exists on the arguments.
+     *
+     * @param array<int, string> $arguments
+     */
+    public function hasArgument(string $argument, array $arguments): bool
+    {
+        return in_array($argument, $arguments, true);
+    }
+
+    /**
+     * Pops the given argument from the arguments.
+     *
+     * @param array<int, string> $arguments
+     *
+     * @return array<int, string>
+     */
+    public function popArgument(string $argument, array $arguments): array
+    {
+        $arguments = array_flip($arguments);
+
+        unset($arguments[$argument]);
+
+        return array_flip($arguments);
+    }
+}

src/Plugins/Retry.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Plugins;
+
+use Pest\Contracts\Plugins\HandlesArguments;
+
+/**
+ * @internal
+ */
+final class Retry implements HandlesArguments
+{
+    use Concerns\HandleArguments;
+
+    /**
+     * Whether it should show retry or not.
+     */
+    public static bool $retrying = false;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function handleArguments(array $arguments): array
+    {
+        self::$retrying = $this->hasArgument('--retry', $arguments);
+
+        return $this->popArgument('--retry', $arguments);
+    }
+}

src/Plugins/Version.php

@@ -13,6 +13,8 @@ use Symfony\Component\Console\Output\OutputInterface;
  */
 final class Version implements HandlesArguments
 {
+    use Concerns\HandleArguments;
+
     /**
      * Creates a new instance of the plugin.
      */
@@ -24,7 +26,7 @@ final class Version implements HandlesArguments
 
     public function handleArguments(array $arguments): array
     {
-        if (in_array('--version', $arguments, true)) {
+        if ($this->hasArgument('--version', $arguments)) {
             $this->output->writeln(
                 sprintf('Pest    %s', version()),
             );

src/Repositories/TempRepository.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Repositories;
+
+/**
+ * @internal
+ */
+final class TempRepository
+{
+    private const FOLDER = __DIR__ . '/../../.temp';
+
+    /**
+     * Creates a new Temp Repository instance.
+     */
+    public function __construct(private string $filename)
+    {
+        // ..
+    }
+
+    /**
+     * Adds a new element.
+     */
+    public function add(string $element): void
+    {
+        $this->save(array_merge(
+            $this->all(),
+            [$element]
+        ));
+    }
+
+    /**
+     * Clears the existing file, if any, and re-creates it.
+     */
+    public function boot(): void
+    {
+        @unlink(self::FOLDER . '/' . $this->filename . '.json'); // @phpstan-ignore-line
+
+        $this->save([]);
+    }
+
+    /**
+     * Checks if the given element exists.
+     */
+    public function exists(string $element): bool
+    {
+        return in_array($element, $this->all(), true);
+    }
+
+    /**
+     * Gets all elements.
+     *
+     * @return array<int, string>
+     */
+    private function all(): array
+    {
+        $contents = file_get_contents(self::FOLDER . '/' . $this->filename . '.json');
+
+        assert(is_string($contents));
+
+        $all = json_decode($contents, true);
+
+        return is_array($all) ? $all : [];
+    }
+
+    /**
+     * Save the given elements.
+     *
+     * @param array<int, string> $elements
+     */
+    private function save(array $elements): void
+    {
+        $contents = json_encode($elements);
+
+        file_put_contents(self::FOLDER . '/' . $this->filename . '.json', $contents);
+    }
+}

src/Repositories/TestRepository.php

@@ -100,7 +100,7 @@ final class TestRepository
     /**
      * Makes a Test Case from the given filename, if exists.
      */
-    public function makeIfExists(string $filename): void
+    public function makeIfNeeded(string $filename): void
     {
         if (array_key_exists($filename, $this->testCases)) {
             $this->make($this->testCases[$filename]);

src/Subscribers/EnsureFailedTestsAreStoredForRetry.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Subscribers;
+
+use Pest\TestSuite;
+use PHPUnit\Event\Test\Failed;
+use PHPUnit\Event\Test\FailedSubscriber;
+
+/**
+ * @internal
+ */
+final class EnsureFailedTestsAreStoredForRetry implements FailedSubscriber
+{
+    /**
+     * Runs the subscriber.
+     */
+    public function notify(Failed $event): void
+    {
+        TestSuite::getInstance()->retryTempRepository->add($event->test()->id());
+    }
+}

src/Subscribers/EnsureRetryRepositoryExists.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Pest\Subscribers;
+
+use Pest\TestSuite;
+use PHPUnit\Event\TestRunner\Started;
+use PHPUnit\Event\TestRunner\StartedSubscriber;
+
+/**
+ * @internal
+ */
+final class EnsureRetryRepositoryExists implements StartedSubscriber
+{
+    /**
+     * Runs the subscriber.
+     */
+    public function notify(Started $event): void
+    {
+        TestSuite::getInstance()->retryTempRepository->boot();
+    }
+}

src/TestSuite.php

@@ -9,6 +9,7 @@ use Pest\Repositories\AfterAllRepository;
 use Pest\Repositories\AfterEachRepository;
 use Pest\Repositories\BeforeAllRepository;
 use Pest\Repositories\BeforeEachRepository;
+use Pest\Repositories\TempRepository;
 use Pest\Repositories\TestRepository;
 use PHPUnit\Framework\TestCase;
 
@@ -47,6 +48,11 @@ final class TestSuite
      */
     public AfterAllRepository $afterAll;
 
+    /**
+     * Holds the retry temp repository.
+     */
+    public TempRepository $retryTempRepository;
+
     /**
      * Holds the root path.
      */
@@ -64,11 +70,12 @@ final class TestSuite
         string $rootPath,
         public string $testPath)
     {
-        $this->beforeAll  = new BeforeAllRepository();
-        $this->beforeEach = new BeforeEachRepository();
-        $this->tests      = new TestRepository();
-        $this->afterEach  = new AfterEachRepository();
-        $this->afterAll   = new AfterAllRepository();
+        $this->beforeAll             = new BeforeAllRepository();
+        $this->beforeEach            = new BeforeEachRepository();
+        $this->tests                 = new TestRepository();
+        $this->afterEach             = new AfterEachRepository();
+        $this->afterAll              = new AfterAllRepository();
+        $this->retryTempRepository   = new TempRepository('retry');
 
         $this->rootPath = (string) realpath($rootPath);
     }

tests/Unit/Plugins/Retry.php

@@ -0,0 +1,15 @@
+<?php
+
+use Pest\Plugins\Retry;
+
+beforeEach(fn () => Retry::$retrying = false);
+
+afterEach(fn () => Retry::$retrying = false);
+
+it('retries if --retry argument is used', function () {
+    $retry = new Retry();
+
+    $retry->handleArguments(['--retry']);
+
+    expect(Retry::$retrying)->toBeTrue();
+});