CODEWITHSUNDEEP
symfonydoctrine
drakonli
drakonli

Reputation: 2434

How to test that EventListener has been called on event in Symfony?

What I have:

I have an EventListener that listens to PreRemove entity event in Symfony.

services:
   my_bundle.entity_listener.my_listener:
      class: 'MyCompany\MyBundle\MyListener'
      public: false
      tags:
        - { name: doctrine.orm.entity_listener, entity: 'MyCompany\MyBundle\Entity\MyEntity', event: preRemove }

What I want:

I want to have a test (functional/integrational/unit or any other really) that somehow checks that when MyEntity is being removed a particular EventListener is being called.

UPDATE

I don't want to do it in a unit test, the need is to actually check that event dispatcher will really call that particular event listener to that particular event.

UPDATE 2

I thought it was obvious, but it seems that it's not - the solution should NOT modify EventListener or Event.

UPDATE 3

I specified that I do not care what the name of the test is: functional, unit or any other.

UPDATE 4

The solution must guarantee that test will pass in context of any environment. So, if someone extends my bundles and messes with my definitions I should still be able to validate if the EventHandling actually works.

Also, checking the result of handling is not an option because:

  1. EventListener can do absolutely anything - there may be cases where I cannot simply check the result and know for sure that EventListener works.

  2. Someone may handle an Event in almost exactly the same way, so that the "result" is the same, but the "way" is wrong.

Upvotes: 4

Views: 4417

Answers (5)

Brucie Alpha
Brucie Alpha

Reputation: 1226

Maybe you can use the symfony profiler?

see How to Use the Profiler in a Functional Test

in the profiler events section you have two tabs with called / not called Listeners http://whatever.com/app_dev.php/_profiler/352211?panel=events

Upvotes: 0

albert
albert

Reputation: 4468

I think I understand what you want. You want a integration test (to test it on all environment) without modifying the listener, the event dispatcher, etc.

Solution 1

When you work on dev, test or prod symfony load different events dispatchers it use the same interface and behaviour but it is different implementations (I haven't check doctrine one).

So you will have different dispatchers for each environment and you don't want to know what happens inside. Let's call this blackbox.

Action delete -> [ black box  ->  listener called ] -> listener effect

You don't want to look at the blackbox or touch it in any way? Search for the effect that has the listener on the system. Database, log file, mailer, etc.

Solution 2

If you allow me to hook into the blackbox you I will sorrounder the listener with a proxy and monitor if the listener has been called on the proxy.

Solution 3

Alternative you can use the data collectors from the symfony profiler but you won't probably have that enabled on production.

Upvotes: 0

Mike Doe
Mike Doe

Reputation: 17604

How about creating a compiler pass and add it to the last stage of container compilation:

$container->addCompilerPass(
    new CheckEntityListenerRegistered(),
    PassConfig::TYPE_AFTER_REMOVING,
    -1000
);

That compiler would get executed last. You could check from that point if your listener is registered properly, and if it is, you could assume it's going to be executed by the Doctrine's Unit of Work.

Upvotes: 0

Sam Janssens
Sam Janssens

Reputation: 1491

check out this : Write UnitTest for Symfony EventListener

It may be of help, as i had a (sort of) similar issue/question

Upvotes: 1

jah
jah

Reputation: 2131

A functional test is for testing functionality; it isn't intended to test the implementation of that functionality or the configuration of that implementation.

A test such as the one you propose will be brittle and not very useful.

What you probably want is to test the feature that the event listener implements.

Upvotes: 1

Related Questions