Как настроить модульные тесты с большой нагрузкой на базу данных в Symfony2 с помощью PHPUnit?
Я совсем новичок в мире тестирования и хочу убедиться, что нахожусь на правильном пути.
Я пытаюсь настроить модульные тесты в проекте symfony2 с использованием phpunit.
PHPUnit работает, и простые тесты контроллера по умолчанию работают нормально. (Однако речь идет не о функциональном тестировании, а о модульном тестировании моего приложения.)
Мой проект в значительной степени зависит от взаимодействия с базой данных, и, насколько я понимаю, из phpunit документация, я должен создать класс на основе \PHPUnit_Extensions_Database_TestCase
, затем создать приспособления для моей бд и работать оттуда.
Тем не менее, symfony2 предлагает только класс WebTestCase
, который расширяется только из \PHPUnit_Framework_TestCase
из коробки.
Итак, я прав, предполагая, что я должен создать свой собственный DataBaseTestCase
, который в основном копирует WebTestCase
, с той лишь разницей, что он простирается от \PHPUnit_Extensions_Database_TestCase
и реализует все свои абстрактные методы?
Или есть другой "встроенный" рекомендуемый рабочий процесс для symfony2 что касается тестов, ориентированных на базу данных?
Поскольку я хочу убедиться, что мои модели хранят и извлекают правильные данные, я не хочу в конечном итоге случайно проверять специфику доктрины.
3 answers
Я никогда не использовал PHPUnit_Extensions_Database_TestCase
, в основном потому, что по этим двум причинам:
- Он плохо масштабируется. Если вы настраиваете и удаляете базу данных для каждого отдельного теста, и у вас есть приложение, которое в значительной степени зависит от базы данных, вы в конечном итоге создаете и удаляете одну и ту же схему снова и снова.
- Мне нравится, чтобы мои приспособления были не только в моих тестах, но и в моей базе данных разработки, а некоторые приспособления даже необходимы для производства (начальный администратор пользователя или продукта категории или что-то еще). Наличие их внутри xml, который можно использовать только для phpunit, мне кажется неправильным.
Мой путь в теории...
Я использую доктрину/пакет доктрин-приспособлений для приспособлений (независимо от цели) и настраиваю всю базу данных со всеми приспособлениями. Затем я выполняю все тесты с этой базой данных и обязательно воссоздаю базу данных, если тест изменил ее.
Преимущества заключаются в том, что мне не нужно снова настраивать базу данных если тест только читает, но ничего не меняет. Для внесения изменений я должен удалить его и создать снова или обязательно отменить изменения.
Я использую sqlite для тестирования, потому что я могу настроить базу данных, затем скопировать файл sqlite и заменить его чистым, чтобы вернуть исходную базу данных. Таким образом, мне не нужно удалять базу данных, создавать ее и снова загружать все приспособления для чистой базы данных.
... и в коде
Я написал статью о том, как я делаю тесты базы данных с помощью symfony2 и phpunit.
Хотя он использует sqlite, я думаю, что можно легко внести изменения, чтобы использовать MySQL или Postgres или что-то еще.
Размышляя дальше
Вот некоторые другие идеи, которые могут сработать:
- Однажды я читал о тестовой установке, в которой перед использованием базы данных вы запускаете транзакцию (в рамках метода установки), а затем используете удаление для отката. Таким образом, вам не нужно снова настраивать базу данных, а просто нужно инициализируйте его один раз.
- Моя настройка, описанная выше, имеет тот недостаток, что база данных настраивается каждый раз при выполнении phpunit, даже если вы выполняете только некоторые модульные тесты без взаимодействия с базой данных. Я экспериментирую с настройкой, в которой я использую глобальную переменную, которая указывает, была ли настроена база данных, а затем в рамках тестов вызываю метод, который проверяет эту переменную и инициализирует базу данных, если этого еще не произошло. Таким образом, только когда тестам нужна база данных, установка будет случаться.
- Одна из проблем с sqlite заключается в том, что в некоторых редких случаях он работает не так, как MySQL. Однажды у меня была проблема, когда что-то вело себя по-другому в MySQL и sqlite, что приводило к сбою теста, когда в MySQL все работало. Я не могу точно вспомнить, что это было.
Tl;dr:
- Если и только если вы хотите пройти весь маршрут функционального тестирования, то я рекомендую посмотреть ответ Сгеттшкеса.
- Если вы хотите провести модульное тестирование своего приложения и вам нужно протестировать код, который взаимодействует с базой данных, либо читайте дальше, либо переходите непосредственно к документам symfony2
В моем первоначальном вопросе были определенные аспекты, которые ясно показывают, что мое понимание различий между модульным тестированием и функциональные тесты отсутствовали. (Как я уже писал, я хочу провести модульное тестирование приложения, но одновременно говорил и о тестировании контроллера; и это функциональный тест по определению).
Модульное тестирование имеет смысл только для сервисов, а не для репозиториев. И эти службы могут использовать насмешки менеджера сущности. (Я бы даже зашел так далеко, чтобы сказать: если возможно, напишите службы, которые ожидают, что в них будут переданы только сущности. Тогда вам нужно только создать насмешки над этими сущностями и вашим модульные тесты вашей бизнес-логики становятся очень простыми.)
Мой фактический вариант использования моего приложения был довольно хорошо отражен в документах symfony2 о том, как тестировать код, который взаимодействует с базой данных.
Они приводят этот пример для служебного теста:
Класс обслуживания:
use Doctrine\Common\Persistence\ObjectManager;
class SalaryCalculator
{
private $entityManager;
public function __construct(ObjectManager $entityManager)
{
$this->entityManager = $entityManager;
}
public function calculateTotalSalary($id)
{
$employeeRepository = $this->entityManager
->getRepository('AppBundle:Employee');
$employee = $employeeRepository->find($id);
return $employee->getSalary() + $employee->getBonus();
}
}
Класс тестирования службы:
namespace Tests\AppBundle\Salary;
use AppBundle\Salary\SalaryCalculator;
use AppBundle\Entity\Employee;
use Doctrine\ORM\EntityRepository;
use Doctrine\Common\Persistence\ObjectManager;
class SalaryCalculatorTest extends \PHPUnit_Framework_TestCase
{
public function testCalculateTotalSalary()
{
// First, mock the object to be used in the test
$employee = $this->getMock(Employee::class);
$employee->expects($this->once())
->method('getSalary')
->will($this->returnValue(1000));
$employee->expects($this->once())
->method('getBonus')
->will($this->returnValue(1100));
// Now, mock the repository so it returns the mock of the employee
$employeeRepository = $this
->getMockBuilder(EntityRepository::class)
->disableOriginalConstructor()
->getMock();
$employeeRepository->expects($this->once())
->method('find')
->will($this->returnValue($employee));
// Last, mock the EntityManager to return the mock of the repository
$entityManager = $this
->getMockBuilder(ObjectManager::class)
->disableOriginalConstructor()
->getMock();
$entityManager->expects($this->once())
->method('getRepository')
->will($this->returnValue($employeeRepository));
$salaryCalculator = new SalaryCalculator($entityManager);
$this->assertEquals(2100, $salaryCalculator->calculateTotalSalary(1));
}
}
Для такого рода тестов не требуется тестовая база данных, только насмешка.
Поскольку важно проверить бизнес-логику, а не уровень сохраняемости.
Только для функциональных тестов имеет смысл иметь собственную тестовую базу данных, которую впоследствии следует создать и разрушить, и большой вопрос должен быть:
Когда функциональный тест имеет смысл?
Раньше я думал, что тестировать все вещи - правильный ответ; однако после работы с большим количеством устаревшего программного обеспечения, которое само по себе едва было разработано на основе тестирования, я стал немного более ленивымпрагматичным и рассматриваю определенные функциональные возможности как работающий, пока ошибка не докажет обратное.
Предположим, у меня есть приложение, которое анализирует XML, создает из него объект и сохраняет эти объекты в базе данных. Если известно, что логика, хранящая объекты в базе данных, работает (например, в: компании требуются данные, и на данный момент она еще не сломана), и даже если эта логика представляет собой большую уродливую кучу дерьма, нет неизбежной необходимости это проверять. Как и все, что мне нужно, чтобы убедиться, что мой анализатор XML извлекает правильные данные. Я могу сделайте вывод из опыта, что будут сохранены правильные данные.
Существуют сценарии, в которых функциональный тест весьма важен, например, если бы нужно было написать интернет-магазин. Там было бы критически важно для бизнеса, чтобы купленные товары сохранялись в базе данных, и здесь функциональные тесты со всей базой данных тестов имеют абсолютный смысл.
Вы можете использовать этот класс:
<?php
namespace Project\Bundle\Tests;
require_once dirname(__DIR__).'/../../../app/AppKernel.php';
use Doctrine\ORM\Tools\SchemaTool;
abstract class TestCase extends \PHPUnit_Framework_TestCase
{
/**
* @var Symfony\Component\HttpKernel\AppKernel
*/
protected $kernel;
/**
* @var Doctrine\ORM\EntityManager
*/
protected $entityManager;
/**
* @var Symfony\Component\DependencyInjection\Container
*/
protected $container;
public function setUp()
{
// Boot the AppKernel in the test environment and with the debug.
$this->kernel = new \AppKernel('test', true);
$this->kernel->boot();
// Store the container and the entity manager in test case properties
$this->container = $this->kernel->getContainer();
$this->entityManager = $this->container->get('doctrine')->getEntityManager();
// Build the schema for sqlite
$this->generateSchema();
parent::setUp();
}
public function tearDown()
{
// Shutdown the kernel.
$this->kernel->shutdown();
parent::tearDown();
}
protected function generateSchema()
{
// Get the metadatas of the application to create the schema.
$metadatas = $this->getMetadatas();
if ( ! empty($metadatas)) {
// Create SchemaTool
$tool = new SchemaTool($this->entityManager);
$tool->createSchema($metadatas);
} else {
throw new Doctrine\DBAL\Schema\SchemaException('No Metadata Classes to process.');
}
}
/**
* Overwrite this method to get specific metadatas.
*
* @return Array
*/
protected function getMetadatas()
{
return $this->entityManager->getMetadataFactory()->getAllMetadata();
}
}
А затем вы можете проверить свою сущность. Что-то вроде этого (при условии, что у вас есть пользователь сущности)
//Entity Test
class EntityTest extends TestCase {
protected $user;
public function setUp()
{
parent::setUp();
$this->user = new User();
$this->user->setUsername('username');
$this->user->setPassword('p4ssw0rd');
$this->entityManager->persist($this->user);
$this->entityManager->flush();
}
public function testUser(){
$this->assertEquals($this->user->getUserName(), "username");
...
}
}
Надеюсь, это поможет.
Источник: theodo.fr/blog/2011/09/symfony2-unit-database-tests