minor(behat): add behat file+line in exceptions

Author: nikophil

src/Test/Behat/Exception/InvalidResetDbTag.php

@@ -2,35 +2,70 @@
 
 namespace Zenstruck\Foundry\Test\Behat\Exception;
 
+use Behat\Behat\EventDispatcher\Event\BeforeFeatureTested;
+use Behat\Behat\EventDispatcher\Event\BeforeScenarioTested;
+
 final class InvalidResetDbTag extends \LogicException
 {
-    public static function bothTagsUsed(): self
+    public function __construct(string $message, BeforeFeatureTested|BeforeScenarioTested $event)
+    {
+        $file = $event->getFeature()->getFile();
+
+        if (!$file) {
+            parent::__construct($message);
+
+            return;
+        }
+
+        $suite = $event->getEnvironment()->getSuite();
+        if ($suite->hasSetting('paths')) {
+            foreach ($suite->getSetting('paths') as $path) {
+                if (!$path) {
+                    continue;
+                }
+
+                if (str_contains($file, $path)) {
+                    $file = substr($file, strpos($file, $path)); // @phpstan-ignore argument.type (strpos cannot be false if $path is contained in $file)
+                    break;
+                }
+            }
+        }
+
+        $errorFileAndLine = match($event::class){
+            BeforeFeatureTested::class => "{$file}:{$event->getFeature()->getLine()}",
+            BeforeScenarioTested::class => "{$file}:{$event->getScenario()->getLine()}",
+        };
+
+        parent::__construct("$message\nAt $errorFileAndLine");
+    }
+
+    public static function bothTagsUsed(BeforeScenarioTested $event): self
     {
-        return new self('Cannot use both "@resetDB" and "@noResetDB" tags at the same time.');
+        return new self('Cannot use both "@resetDB" and "@noResetDB" tags at the same time.', $event);
     }
 
-    public static function resetDbWithScenarioMode(): self
+    public static function resetDbWithScenarioMode(BeforeFeatureTested|BeforeScenarioTested $event): self
     {
-        return new self('Cannot use "@noResetDB" tag with database_reset_mode set as "manual".');
+        return new self('Cannot use "@noResetDB" tag with database_reset_mode set as "manual".', $event);
     }
 
-    public static function noResetDbWithManualMode(): self
+    public static function noResetDbWithManualMode(BeforeFeatureTested|BeforeScenarioTested $event): self
     {
-        return new self('Cannot use "@noResetDB" tag with database_reset_mode set as "manual".');
+        return new self('Cannot use "@noResetDB" tag with database_reset_mode set as "manual".', $event);
     }
 
-    public static function resetDbOnFeatureWithFeatureMode(): self
+    public static function resetDbOnFeatureWithFeatureMode(BeforeFeatureTested $event): self
     {
-        return new self('Cannot use "@resetDB" tag on a feature with database_reset_mode set as "feature".');
+        return new self('Cannot use "@resetDB" tag on a feature with database_reset_mode set as "feature".', $event);
     }
 
-    public static function resetDbOnScenarioWithScenarioMode(): self
+    public static function resetDbOnScenarioWithScenarioMode(BeforeScenarioTested $event): self
     {
-        return new self('Cannot use "@resetDB" tag on a scenario with database_reset_mode set as "scenario".');
+        return new self('Cannot use "@resetDB" tag on a scenario with database_reset_mode set as "scenario".', $event);
     }
 
-    public static function noResetDbWithFeatureMode(): self
+    public static function noResetDbWithFeatureMode(BeforeFeatureTested|BeforeScenarioTested $event): self
     {
-        return new self('Cannot use "@noResetDB" with database_reset_mode set as "feature".');
+        return new self('Cannot use "@noResetDB" with database_reset_mode set as "feature".', $event);
     }
 }

src/Test/Behat/Listener/DatabaseResetListener.php

@@ -96,18 +96,18 @@ public function disableStaticConnection(): void
     public function validateFeature(BeforeFeatureTested $event): void
     {
         if ($this->hasResetDbTag($event) && $this->resetMode === DatabaseResetMode::FEATURE) {
-            throw InvalidResetDbTag::resetDbOnFeatureWithFeatureMode();
+            throw InvalidResetDbTag::resetDbOnFeatureWithFeatureMode($event);
         }
     }
 
     public function validateScenario(BeforeScenarioTested $event): void
     {
         if ($this->hasResetDbTag($event) && $this->resetMode === DatabaseResetMode::SCENARIO) {
-            throw InvalidResetDbTag::resetDbOnScenarioWithScenarioMode();
+            throw InvalidResetDbTag::resetDbOnScenarioWithScenarioMode($event);
         }
 
         if ($this->hasResetDbTag($event) && $this->hasNoResetDbTag($event)) {
-            throw InvalidResetDbTag::bothTagsUsed();
+            throw InvalidResetDbTag::bothTagsUsed($event);
         }
     }
 
@@ -175,8 +175,7 @@ private function hasResetDbTag(BeforeFeatureTested|BeforeScenarioTested $event):
         }
 
         if ($this->resetMode === DatabaseResetMode::SCENARIO) {
-            // todo: ajouter des infos concernant le fichier de features
-            throw InvalidResetDbTag::resetDbWithScenarioMode();
+            throw InvalidResetDbTag::resetDbWithScenarioMode($event);
         }
 
         return true;
@@ -201,8 +200,8 @@ private function hasNoResetDbTag(BeforeFeatureTested|BeforeScenarioTested $event
         }
 
         return match($this->resetMode) {
-            DatabaseResetMode::MANUAL => throw InvalidResetDbTag::noResetDbWithManualMode(),
-            DatabaseResetMode::FEATURE => throw InvalidResetDbTag::noResetDbWithFeatureMode(),
+            DatabaseResetMode::MANUAL => throw InvalidResetDbTag::noResetDbWithManualMode($event),
+            DatabaseResetMode::FEATURE => throw InvalidResetDbTag::noResetDbWithFeatureMode($event),
             default => true,
         };
     }

tests/Integration/Behat/Listener/DatabaseResetListenerTest.php

@@ -17,7 +17,8 @@
 use Behat\Behat\EventDispatcher\Event\BeforeScenarioTested;
 use Behat\Gherkin\Node\FeatureNode;
 use Behat\Gherkin\Node\ScenarioNode;
-use Behat\Testwork\Environment\Environment;
+use Behat\Testwork\Environment\StaticEnvironment;
+use Behat\Testwork\Suite\GenericSuite;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
@@ -314,6 +315,11 @@ private function objectRegistry(): ObjectRegistry
         return self::getContainer()->get('.zenstruck_foundry.behat.object_registry'); // @phpstan-ignore return.type
     }
 
+    private function createEnvironment(): StaticEnvironment
+    {
+        return new StaticEnvironment(new GenericSuite('default', ['paths' => ['/path/to']]));
+    }
+
     /**
      * @param list<string> $tags
      */
@@ -331,9 +337,7 @@ private function createFeatureEvent(array $tags): BeforeFeatureTested
             1
         );
 
-        $environment = $this->createStub(Environment::class);
-
-        return new BeforeFeatureTested($environment, $feature);
+        return new BeforeFeatureTested($this->createEnvironment(), $feature);
     }
 
     /**
@@ -355,8 +359,6 @@ private function createScenarioEvent(array $tags): BeforeScenarioTested
             1
         );
 
-        $environment = $this->createStub(Environment::class);
-
-        return new BeforeScenarioTested($environment, $feature, $scenario);
+        return new BeforeScenarioTested($this->createEnvironment(), $feature, $scenario);
     }
 }