Documentation for StepEvent hooks in Behat 3.0 about behat

[stof]

I don't think this will be easy to do, because Behat does not run inside your Symfony application (and the code being tested with Behat might not be a Symfony application at all).

Maybe https://github.com/FriendsOfBehat/SymfonyExtension could have a way to make it work.

[tacman]

I poked around the code a bit to find the new calls, but my event listener isn't being called.

<?php

namespace App\EventListener;

use Behat\Testwork\Event\Event;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
use Behat\Behat\EventDispatcher\Event\StepTested;
final class BehatListener
{
    #[AsEventListener(event: StepTested::BEFORE)]
    public function onBeforeStepTested(Event $event): void
    {
        dd($event);
        // ...
    }

}

The listener seems like it's registered correctly, here's the debug:

"tester.step_tested.before" event
---------------------------------

 ------- ------------------------------------------------------- ---------- 
  Order   Callable                                                Priority  
 ------- ------------------------------------------------------- ---------- 
  #1      App\EventListener\BehatListener::onBeforeStepTested()   0         
 ------- ------------------------------------------------------- ---------- 

[tacman]

I think I need to implement / extend EventDispatchingStepTester in the FeatureContext.

But EventDispatchingBackgroundTester is marked as final, so it can't be extended.

class FeatureContext extends EventDispatchingBackgroundTester implements Context, BackgroundTester
{

So there must be some other way to wire this up! @everzet? I'll make a PR to the docs once this works.

[stof]

Behat events are not dispatched in the event dispatcher of your Symfony app (which is where you register your listener right now).

See https://docs.behat.org/en/latest/user_guide/context/hooks.html for the documentation about hooks in 3.x

[stof]

making the context implement BackgroundTester does not make sense at all.

[tacman]

Thanks!

Certainly I'd love to hook it into the Symfony events, and then inject the services I need there. Is there a way to inject the Symfony event dispatcher and dispatch a Symfony event?

I have a custom logger that logs the steps and scenarios, and renders that log via Twig (and needs some other services). I'm open to suggestions on how to implement that, especially inside a bundle so it can be reused.

[stof]

anyway, as this issue was originally asking for documentation and that documentation exists already (see my first comment), I'm closing this issue.

[tacman]

Thanks, @stof