如何使用PHPUnit在Zend Framework 2中测试EventListener

Question

我正在使用Zend Framework 2开发应用程序。某些应用程序服务会通知感兴趣的侦听器，这些侦听器会触发其他服务中的某些方法，例如：

UserService

<?php

class UserService implements EventManagerAwareInterface 
{
     public function create($data = array()) 
     {
         // user is already created here
         $params = array("user" => $user);
         $this->getEventManager()->trigger(__FUNCTION__ . '.post', $this, $params);
     }
}

UserListener

<?php

use Zend\EventManager\EventManagerInterface;
use Zend\EventManager\ListenerAggregateInterface;
use Zend\EventManager\EventInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class UserListener implements ListenerAggregateInterface
{
    protected $serviceManager;

    protected $listeners = array();

    public function __construct(ServiceLocatorInterface $serviceManager) 
    {
        $this->serviceManager = $serviceManager;
    }    

    public function attach(EventManagerInterface $events) 
    {
        $evm = $events->getSharedManager();

        $this->listeners[] = $evm->attach('Application\Service\UserService', 'create.post', array($this, 'notify'));
    }

    public function detach(EventManagerInterface $events) 
    {
        foreach ($this->listeners as $index => $listener) {
            if ($events->detach($listener)) {
                unset($this->listeners[$index]);
            }
        }
    }

    public function notify(EventInterface $events) 
    {
        $user = $events->getParam('user');
        $mailService = $this->serviceManager->get('MailService');
        $mailService->sendWelcomeMessage($user);
    } 
}

因此，我的问题是用PHPUnit测试Zend Framework事件监听器的最佳实践是什么，应如何正确测试所有监听器方法attach（） ， detach（） ， notify（）等？

任何帮助将非常感激！ 提前致谢！

Answer 1

如果您查看apizility zf-mvc-auth的源代码，则会看到很多监听器测试的示例。

https://github.com/zfcampus/zf-mvc-auth/tree/master/test/Authorization

尽管有些人可以说这些并不是完全真实的单元测试，并且它们在单元测试和功能测试之间有些模糊的界限，但我发现以这种方式测试监听器是最简单，最有效的方法陷入过度模拟的测试混乱中。 它们整洁，易于编写且易于理解。

Answer 2

以下是关于attach（）和detach（）的一些有用提示。 首先以要测试的Listener方法为例：

/**
 * {@inheritdoc}
 */
public function attach(EventManagerInterface $events)
{
    $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH,
                                         [$this, 'doAction']);
}

/**
 * {@inheritdoc}
 */
public function detach(EventManagerInterface $events)
{
    foreach ($this->listeners as $index => $listener) {
        if ($events->detach($listener)) {
            unset($this->listeners[$index]);
        }
    }
}

public function doAction($event)
{
    // Code truncated.
}

单元测试有帮助，侦听器实例称为$ this-> listener ：

/**
 * @covers Application\Event\MyListenerClass::attach
 */
public function testAttach()
{
    $eventManager = new EventManager();
    $this->listener->attach($eventManager);
    $events = $eventManager->getEvents();
    // Only one event attached to.
    $priorityQueue = $eventManager->getListeners($events[0]);

    $callBackHandler = $priorityQueue->extract();
    $callBackArray = $callBackHandler->getCallback();
    $this->assertEquals($this->listener, $callBackArray[0]);
    $this->assertEquals('doAction', $callBackArray[1]);
}

/**
 * @covers Application\Event\MyListenerClass::detach
 */
public function testDetach()
{
    $eventManager = new EventManager();
    $this->listener->attach($eventManager);
    $this->listener->detach($eventManager);
    $events = $eventManager->getEvents();
    // Only one event attached to.
    $priorityQueue = $eventManager->getListeners($events[0]);

    $this->assertEmpty($priorityQueue->toArray());
}

最后，也可以使用应用程序的ServiceManager中的EventManager代替此处代码中的示例实例，但这足以使某人入门。