我创建了一个 AuditLoggerBundle*,它有一个使用 Doctrine Events(prePersist、preUpdate 和 preRemove)的服务,以便在 audit_log 表(AuditLog 实体)中创建一个新条目。
该 bundle 与我的其他 bundle 一起工作正常,但我想对其进行单元测试和功能测试。
问题是,为了对 AuditLoggerListener
函数进行功能测试,我需要至少有两个可以持久化、更新等的“假”实体。
在这个包中,我不知道如何执行此操作,因为我只有一个 AuditLog 实体,我需要使用两个实体(将仅在测试中使用)。
- 第一个实体将是“可审计的”(我必须在 audit_log(如果我对该实体进行持久化、更新或删除)。
- 第二个将是“不可审核的”(我不能有新条目 当我在 audit_log 表中执行持久化、更新或删除时 这个实体)。*
- 这两个实体可以与唯一的 EntityClass 相关,但不能是 AuditLog 的实例
这就是我对持续功能测试的看法:
<?php
$animal = new Animal(); //this is a fake Auditable entity
$animal->setName('toto');
$em = new EntityManager(); //actually I will use the container to get this manager
$em->persist($animal);
$em->flush();
//Here we test that I have a new line in audit_log table with the right informations
所以我的问题是我的包中没有任何 Animal 实体,我只需要这个来测试包,所以它必须只在测试数据库中创建,而不是在生产环境中创建(当我这样做时app/console doctrine:schema:update --force
EDIT_1:阅读您的回答后,将对 AuditLoggerListener 函数执行单元测试,但我仍想进行功能测试
*是的,我知道有很多,但它们不符合我的要求。
感谢您的回答,希望对一些人有所帮助!
EDIT_2:这是代码 服务:
services:
#add a prefix to the auditLogger table
kali_audit_logger.doctrine.table.prefix:
class: Kali\AuditLoggerBundle\EventListener\TablePrefixListener
arguments: [%application.db.table.prefix%]
tags:
- { name: doctrine.event_listener, event: loadClassMetadata }
#audit all doctrine actions made by a user
kali_audit_logger.doctrine.event.logger:
class: Kali\AuditLoggerBundle\EventListener\AuditLoggerListener
arguments: [@kali_audit_log, @jms_serializer.serializer, @security.token_storage, %application.auditable.entities%, %application.non.auditable.entities%]
tags:
- { name: doctrine.event_listener, event: prePersist }
- { name: doctrine.event_listener, event: preUpdate }
- { name: doctrine.event_listener, event: preRemove }
# new AuditLog
kali_audit_log:
class: Kali\AuditLoggerBundle\Entity\AuditLog
听众:
namespace Kali\AuditLoggerBundle\EventListener;
use DateTime;
use Doctrine\ORM\Event\LifecycleEventArgs;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Event\PreUpdateEventArgs;
use JMS\Serializer\SerializerInterface;
use Kali\AuditLoggerBundle\Entity\AuditLog;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
/**
* Class AuditLoggerListener
* insert a new entry in audit_log table for every doctrine event
*
* @package Kali\AuditLoggerBundle\EventListener
*/
class AuditLoggerListener
{
/**
* @var TokenStorage
*/
protected $securityToken;
/**
* @var EntityManager
*/
protected $em;
/**
* @var array
*/
protected $auditableEntities;
/**
* @var array
*/
protected $nonAuditableEntities = ['Kali\AuditLoggerBundle\Entity\AuditLog'];
/**
* @var AuditLog
*/
protected $auditLogger;
/**
* @var SerializerInterface
*/
protected $serializer;
/**
* @param AuditLog $auditLogger
* @param SerializerInterface $serializer
* @param TokenStorage $securityToken
* @param array $auditableEntities
* @param array $nonAuditableEntities
*/
public function __construct(
AuditLog $auditLogger,
SerializerInterface $serializer,
TokenStorage $securityToken,
$auditableEntities = [],
$nonAuditableEntities = []
) {
$this->auditLogger = $auditLogger;
$this->serializer = $serializer;
$this->securityToken = $securityToken;
$this->auditableEntities = $auditableEntities;
//add all non auditable entities to the current array of non auditable entities
array_merge($this->nonAuditableEntities, $nonAuditableEntities);
}
/**
*
* @param LifecycleEventArgs $args
*
* @return boolean
*/
public function prePersist(LifecycleEventArgs $args)
{
$this->em = $args->getEntityManager();
$entity = $args->getEntity();
$this->em
->getEventManager()
->removeEventListener('prePersist', $this);
if ($this->isAuditableEntity($entity)) {
$this->addAudit(
$this->securityToken->getToken()->getUsername(),
"INSERT",
get_class($entity),
$this->serializer->serialize($entity, JsonEncoder::FORMAT)
);
}
return true;
}
/**
*
* @param PreUpdateEventArgs $args
*
* @return boolean
*/
public function preUpdate(PreUpdateEventArgs $args)
{
$this->em = $args->getEntityManager();
$entity = $args->getEntity();
$this->em
->getEventManager()
->removeEventListener('preUpdate', $this);
if ($this->isAuditableEntity($entity)) {
$this->addAudit(
$this->securityToken->getToken()->getUsername(),
"UPDATE",
get_class($entity),
$this->serializer->serialize($entity, JsonEncoder::FORMAT),
$this->serializer->serialize($args->getEntityChangeSet(), JsonEncoder::FORMAT)
);
}
return true;
}
/**
*
* @param LifecycleEventArgs $args
*
* @return boolean
*/
public function preRemove(LifecycleEventArgs $args)
{
$this->em = $args->getEntityManager();
$entity = $args->getEntity();
$this->em
->getEventManager()
->removeEventListener('preRemove', $this);
if ($this->isAuditableEntity($entity)) {
$this->addAudit(
$this->securityToken->getToken()->getUsername(),
"REMOVE",
get_class($entity),
$this->serializer->serialize($entity, JsonEncoder::FORMAT)
);
}
return true;
}
/**
* Insert a new line in audit_log table
*
* @param string $user
* @param string $action
* @param string $entityClass
* @param null|string $entityValue
* @param null|string $entityChange
*
* @return void
*/
private function addAudit($user, $action, $entityClass, $entityValue = null, $entityChange = null)
{
if ($this->auditLogger) {
$this->auditLogger
->setUser($user)
->setAction($action)
->setEntityClass($entityClass)
->setEntityValue($entityValue)
->setEntityChange($entityChange)
->setDate(new DateTime());
}
if ($this->em) {
$this->em->persist($this->auditLogger);
$this->em->flush();
}
}
/**
* check if an entity is auditable
*
* @param $entity
*
* @return bool
*/
private function isAuditableEntity($entity)
{
$auditable = false;
//the entity must not be in the non auditable entity array
if (!in_array(get_class($entity), $this->nonAuditableEntities)
&& (empty($this->auditableEntities) || (!empty($this->auditableEntities) && in_array(get_class($entity), $this->auditableEntities)))
) {
$auditable = true;
}
return $auditable;
}
}
我想测试一下这个监听器的preXXXX功能... 因此,例如,我需要测试当我对一个假实体(我真的不知道如何模拟)进行持久化时,我的 audit_log 表中是否有一个新条目.. .
最佳答案
it's almost not possible to do functional tests on a shared bundle, because you can't rely on the Symfony2 distribution. I think in this case the best thing to do is properly Unit Test your bundle. – olaurendeau
这里是监听器相关的测试类(100%覆盖该类):
<?php
namespace Kali\AuditLoggerBundle\Tests\Controller;
use Kali\AuditLoggerBundle\Entity\AuditLog;
use Kali\AuditLoggerBundle\EventListener\AuditLoggerListener;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
/**
* Class AuditLoggerListenerTest
* @package Kali\AuditLoggerBundle\Tests\Controller
*/
class AuditLoggerListenerTest extends WebTestCase
{
protected static $container;
/**
* This method is called before the first test of this test class is run.
*
* @since Method available since Release 3.4.0
*/
public static function setUpBeforeClass()
{
self::$container = static::createClient()->getContainer();
}
/*
* ===========================================================================
* TESTS ON AUDITABLE ENTITIES
* ===========================================================================
*/
/**
* test prepersist function
*/
public function testPrePersistWithAuditableEntity()
{
//Mock all the needed objects
$token = $this->mockToken();
$tokenStorage = $this->mockTokenStorage();
$eventManager = $this->mockEventManager();
$entityManager = $this->mockEntityManager();
$entity = $this->mockEntity();
$lifeCycleEvent = $this->mockEvent('LifecycleEventArgs');
//assert the methods that must be called or not
$token -> expects($this->once())->method('getUsername');
$tokenStorage -> expects($this->once())->method('getToken')->willReturn($token);
$eventManager -> expects($this->once())->method('removeEventListener');
$entityManager -> expects($this->once())->method('getEventManager')->willReturn($eventManager);
$entityManager -> expects($this->once())->method('persist');
$lifeCycleEvent -> expects($this->never())->method('getEntityChangeSet');
$lifeCycleEvent -> expects($this->once())->method('getEntityManager')->willReturn($entityManager);
$lifeCycleEvent -> expects($this->once())->method('getEntity')->willReturn($entity);
//instanciate the listener
$listener = new AuditLoggerListener(
new AuditLog(),
self::$container->get('jms_serializer'),//Yes this is not really good to do that
$tokenStorage
);
// call the function to test
$listener->prePersist($lifeCycleEvent);
}
/**
* test preUpdate function
*/
public function testPreUpdateWithAuditableEntity()
{
//Mock all the needed objects
$token = $this->mockToken();
$tokenStorage = $this->mockTokenStorage();
$eventManager = $this->mockEventManager();
$entityManager = $this->mockEntityManager();
$entity = $this->mockEntity();
$lifeCycleEvent = $this->mockEvent('PreUpdateEventArgs');
//assert the methods that must be called or not
$token -> expects($this->once())->method('getUsername');
$tokenStorage -> expects($this->once())->method('getToken')->willReturn($token);
$eventManager -> expects($this->once())->method('removeEventListener');
$entityManager -> expects($this->once())->method('getEventManager')->willReturn($eventManager);
$entityManager -> expects($this->once())->method('persist');
$lifeCycleEvent -> expects($this->once())->method('getEntityChangeSet');
$lifeCycleEvent -> expects($this->once())->method('getEntityManager')->willReturn($entityManager);
$lifeCycleEvent -> expects($this->once())->method('getEntity')->willReturn($entity);
//instanciate the listener
$listener = new AuditLoggerListener(
new AuditLog(),
self::$container->get('jms_serializer'),//Yes this is not really good to do that
$tokenStorage
);
// call the function to test
$listener->preUpdate($lifeCycleEvent);
}
/**
* test PreRemove function
*/
public function testPreRemoveWithAuditableEntity()
{
//Mock all the needed objects
$token = $this->mockToken();
$tokenStorage = $this->mockTokenStorage();
$eventManager = $this->mockEventManager();
$entityManager = $this->mockEntityManager();
$entity = $this->mockEntity();
$lifeCycleEvent = $this->mockEvent('LifecycleEventArgs');
//assert the methods that must be called or not
$token -> expects($this->once())->method('getUsername');
$tokenStorage -> expects($this->once())->method('getToken')->willReturn($token);
$eventManager -> expects($this->once())->method('removeEventListener');
$entityManager -> expects($this->once())->method('getEventManager')->willReturn($eventManager);
$entityManager -> expects($this->once())->method('persist');
$lifeCycleEvent -> expects($this->never())->method('getEntityChangeSet');
$lifeCycleEvent -> expects($this->once())->method('getEntityManager')->willReturn($entityManager);
$lifeCycleEvent -> expects($this->once())->method('getEntity')->willReturn($entity);
//instanciate the listener
$listener = new AuditLoggerListener(
new AuditLog(),
self::$container->get('jms_serializer'),//Yes this is not really good to do that
$tokenStorage
);
// call the function to test
$listener->preRemove($lifeCycleEvent);
}
/*
* ===========================================================================
* TESTS ON NON AUDITABLE ENTITIES
* ===========================================================================
*/
/**
* test prepersit function
*/
public function testPrePersistWithNonAuditableEntity()
{
//Mock all the needed objects
$token = $this->mockToken();
$tokenStorage = $this->mockTokenStorage();
$eventManager = $this->mockEventManager();
$entityManager = $this->mockEntityManager();
$entity = new AuditLog();//this entity is non Auditable
$lifeCycleEvent = $this->mockEvent('LifecycleEventArgs');
//assert the methods that must be called or not
$token -> expects($this->never())->method('getUsername');
$tokenStorage -> expects($this->never())->method('getToken')->willReturn($token);
$eventManager -> expects($this->once())->method("removeEventListener");
$entityManager -> expects($this->never())->method('persist');
$entityManager -> expects($this->once())->method('getEventManager')->willReturn($eventManager);
$lifeCycleEvent -> expects($this->never())->method('getEntityChangeSet');
$lifeCycleEvent -> expects($this->once())->method('getEntityManager')->willReturn($entityManager);
$lifeCycleEvent -> expects($this->once())->method('getEntity')->willReturn($entity);
$listener = new AuditLoggerListener(
new AuditLog(),
self::$container->get('jms_serializer'),
$tokenStorage
);
$listener->prePersist($lifeCycleEvent);
}
/**
* test prepersit function
*/
public function testPreUpdateWithNonAuditableEntity()
{
//Mock all the needed objects
$token = $this->mockToken();
$tokenStorage = $this->mockTokenStorage();
$eventManager = $this->mockEventManager();
$entityManager = $this->mockEntityManager();
$entity = new AuditLog();//this entity is non Auditable
$lifeCycleEvent = $this->mockEvent('PreUpdateEventArgs');
//assert the methods that must be called or not
$token -> expects($this->never())->method('getUsername');
$tokenStorage -> expects($this->never())->method('getToken')->willReturn($token);
$eventManager -> expects($this->once())->method("removeEventListener");
$entityManager -> expects($this->never())->method('persist');
$entityManager -> expects($this->once())->method('getEventManager')->willReturn($eventManager);
$lifeCycleEvent -> expects($this->never())->method('getEntityChangeSet');
$lifeCycleEvent -> expects($this->once())->method('getEntityManager')->willReturn($entityManager);
$lifeCycleEvent -> expects($this->once())->method('getEntity')->willReturn($entity);
$listener = new AuditLoggerListener(
new AuditLog(),
self::$container->get('jms_serializer'),
$tokenStorage
);
$listener->preUpdate($lifeCycleEvent);
}
/**
* test preRemove function
*/
public function testPreRemoveWithNonAuditableEntity()
{
//Mock all the needed objects
$token = $this->mockToken();
$tokenStorage = $this->mockTokenStorage();
$eventManager = $this->mockEventManager();
$entityManager = $this->mockEntityManager();
$entity = new AuditLog();//this entity is non Auditable
$lifeCycleEvent = $this->mockEvent('LifecycleEventArgs');
//assert the methods that must be called or not
$token -> expects($this->never())->method('getUsername');
$tokenStorage -> expects($this->never())->method('getToken')->willReturn($token);
$eventManager -> expects($this->once())->method("removeEventListener");
$entityManager -> expects($this->never())->method('persist');
$entityManager -> expects($this->once())->method('getEventManager')->willReturn($eventManager);
$lifeCycleEvent -> expects($this->never())->method('getEntityChangeSet');
$lifeCycleEvent -> expects($this->once())->method('getEntityManager')->willReturn($entityManager);
$lifeCycleEvent -> expects($this->once())->method('getEntity')->willReturn($entity);
$listener = new AuditLoggerListener(
new AuditLog(),
self::$container->get('jms_serializer'),
$tokenStorage
);
$listener->preRemove($lifeCycleEvent);
}
/*
* ===========================================================================
* MOCKS
* ===========================================================================
*/
/**
* Mock a Token object
*
* @return \PHPUnit_Framework_MockObject_MockObject
*/
private function mockToken()
{
$token = $this->getMock(
'Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken',
['getUsername'],
[],
'',
false
);
return $token;
}
/**
* Mock a TokenStorage object
*
* @return \PHPUnit_Framework_MockObject_MockObject
*/
private function mockTokenStorage()
{
//mock tokenStorage
$tokenStorage = $this->getMock(
'Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage',
['getToken'],
[],
'',
false
);
return $tokenStorage;
}
/**
* Mock an EventManager Object
*
* @return \PHPUnit_Framework_MockObject_MockObject
*/
private function mockEventManager()
{
//mock the event manager
$eventManager = $this->getMock(
'\Doctrine\Common\EventManager',
['removeEventListener'],
[],
'',
false
);
return $eventManager;
}
/**
* Mock an EntityManager
*
* @return \PHPUnit_Framework_MockObject_MockObject
*/
private function mockEntityManager()
{
//mock the entityManager
$emMock = $this->getMock(
'\Doctrine\ORM\EntityManager',
['getEventManager', 'persist', 'update', 'remove', 'flush'],
[],
'',
false
);
return $emMock;
}
/**
* Mock an Entity Object
*
* @return \PHPUnit_Framework_MockObject_MockObject
*/
private function mockEntity()
{
$entity = $this->getMockBuilder('stdClass')
->setMethods(['getName', 'getType'])
->getMock();
$entity->expects($this->any())
->method('getName')
->will($this->returnValue('toto'));
$entity->expects($this->any())
->method('getType')
->will($this->returnValue('chien'));
return $entity;
}
/**
* mock a lifeCycleEventArgs Object
*
* @param $eventType
*
* @return \PHPUnit_Framework_MockObject_MockObject
*/
private function mockEvent($eventType)
{
$lifeCycleEvent = $this->getMock(
'\Doctrine\ORM\Event\\'.$eventType,
['getEntityManager', 'getEntity', 'getEntityChangeSet'],
[],
'',
false
);
return $lifeCycleEvent;
}
}
如果你对此有什么想说的,请发表评论:) (例如,我可以将“模拟所有需要的对象”部分重构为一个函数)
关于php - 如何在没有任何实体的情况下测试学说 EventListener/Subscriber,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32609772/