【发布时间】：2015-09-16 13:18:39
【问题描述】：
我创建了一个 AuditLoggerBundle*，它有一个使用 Doctrine 事件（prePersist、preUpdate 和 preRemove）的服务，以便在 audit_log 表（AuditLog 实体）中创建一个新条目。
该捆绑包可以与我的其他捆绑包一起正常工作，但我想对其进行单元测试和功能测试。
问题在于，为了对AuditLoggerListener 函数进行功能测试，我需要至少有两个“假”实体可以持久化、更新等。
在这个捆绑包中，我不知道该怎么做，因为我只有一个 AuditLog 实体，而且我需要使用两个 over 实体（只在测试中使用）。
- 第一个实体将是“可审计的”（我必须在 如果我对此实体执行持久化、更新或删除操作，则为 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 表中是否有一个新条目.. .
【问题讨论】：
-
如果您想在数据库中查看新条目，这不是单元测试，而是功能测试，您可以使用 SF2 WebTestCase symfony.com/doc/current/book/testing.html#functional-tests 或 behat docs.behat.org/en/v2.5 等框架进行测试.单元测试只会检查你的类的 IO，不会有数据库交互，你会检查 EntityManager 方法是否被调用，它应该是足够的，因为 Doctrine EntityManager 也是可信任的单元测试。
-
好的，我明白这一点，我可以对我的函数进行一些单元测试，以确保实际调用了一些函数（例如persist、flush、getEntity、getEntityManager 等......）。所以现在我想为这个监听器做一个功能测试。我在其他项目上做了很多功能测试，但它们都使用 HMI 或我可以使用的真实实体（没有模拟）。
-
在这个捆绑包中，我不知道该怎么做，因为我只有一个 AuditLog 实体，我需要使用两个 over 实体（仅在测试中使用）。第一个实体将是“可审计的”（如果我对此实体进行持久化、更新或删除，我必须在 audit_log 中有一个新条目）。第二个将是“不可审计的”（当我对该实体执行持久化、更新或删除时，我不能在 audit_log 表中有新条目）。
-
对于功能测试，您仍然可以使用模拟，但在您的情况下，我认为最简单的方法应该是创建一个您可以在测试中使用的虚拟实体。
-
“虚拟实体”是什么意思？
标签： php symfony doctrine-orm event-listener subscriber