README

一个用于使用 Symfony、nelmio/alice 和 fzaninotto/Faker 管理测试数据的 bundle。

数据库支持在 FidryAliceDataFixtures 中实现。查看此项目以了解哪些数据库/ORM 受支持。

警告：这是 HautelookAliceBundle 2.0 的文档。如果您想查看 1.x 的文档，请前往 此处。

何时使用此 bundle？

HautelookAliceBundle 发生了很大变化，最初它只是作为 nelmio/alice 的简单 bundle，然后开始添加一些额外的功能来丰富它。

HautelookAliceBundle 1.x 是第一个达到一定成熟度的里程碑

• 通过命令轻松加载一组测试数据
• 能够为多个环境定义不同的测试数据集
• 使用自定义 Faker 提供程序自定义数据生成
• 使用处理器自定义加载行为

HautelookAliceBundle 2.x 发生了很大变化，尽管变化不大。在 1.x 中，由于 nelmio/alice 2.x 的限制，bundle 中引入了大量的复杂性，并且最好的解决方案是工作区（例如，无法处理循环引用）。这些复杂性的大部分都推回到 nelmio/alice 3.x，它具有更灵活的设计。因此

• nelmio/alice 3.x 允许您以优雅的方式轻松创建具有随机数据的 PHP 对象
• FidryAliceDataFixtures 是 nelmio/alice 3.x 的持久化层。如果您需要持久化加载的对象，则需要此包。它提供灵活性，可以在每次加载之间清除数据或对测试进行事务性加载，例如在测试完成后简单地回滚，而不是调用昂贵的清除。
• hautelook/alice-bundle 2.x 提供高级功能，包括测试数据发现（查找适当的文件并加载它们）和数据库测试的辅助程序。如果您只需为测试加载特定的文件集，则 FidryAliceDataFixtures 足够了。

文档

1. 安装
2. 基本用法
3. 数据库测试
4. 高级用法
   1. 启用数据库
   2. 特定环境的测试数据
   3. 测试数据参数
      1. Alice 参数
      2. 应用程序参数
   4. 使用服务工厂
   5. 按特定顺序加载测试数据
      1. 按特定顺序加载测试数据
      2. 按特定顺序持久化类
5. 自定义 Faker 提供程序
6. 自定义 Alice 处理器
7. 资源

安装

使用 Symfony Flex（推荐）

# If you do not have Doctrine installed yet:
composer require doctrine-orm

composer require --dev hautelook/alice-bundle 

您已准备好使用AliceBundle，可以跳转到下一节！

如果没有Flex，您将需要安装 doctrine/orm 并相应地在 app/AppKernel.php 或您的Kernel类所在位置注册Bundle。

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = [
        new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
        // ...
        new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
    ];
    
    if (in_array($this->getEnvironment(), ['dev', 'test'])) {
        //...
        $bundles[] = new Nelmio\Alice\Bridge\Symfony\NelmioAliceBundle();
        $bundles[] = new Fidry\AliceDataFixtures\Bridge\Symfony\FidryAliceDataFixturesBundle();
        $bundles[] = new Hautelook\AliceBundle\HautelookAliceBundle();
    }

    return $bundles;
}

根据您的需求配置Bundle，例如

# config/packages/dev/hautelook_alice.yaml

hautelook_alice:
    fixtures_path: 'fixtures' # Path to which to look for fixtures relative to the project directory or the bundle path. May be a string or an array of strings.
    root_dirs:
        - '%kernel.root_dir%'
        - '%kernel.project_dir%'

如果您使用的是非Flex架构，您可能需要使用 Resources/fixtures 而不是 fixtures。

基本用法

假设您使用的是 Doctrine，请确保已安装 doctrine/doctrine-bundle 和 doctrine/data-fixtures 包。

然后在以下位置之一创建一个固定文件

• 如果您使用flex，则为 fixtures
• 如果您有一个无Bundle的Symfony应用且非Flex，则为 app/Resources/fixtures
• src/AppBundle/Resources/fixtures 或您希望放置固定文件的任何Bundle

# fixtures/dummy.yaml

App\Entity\Dummy:
    dummy_{1..10}:
        name: <name()>
        related_dummy: '@related_dummy*'

# fixtures/related_dummy.yaml

App\Entity\RelatedDummy:
    related_dummy_{1..10}:
        name: <name()>

然后只需使用Doctrine命令 php bin/console hautelook:fixtures:load 加载您的固定文件。

如果您只想加载某个Bundle的固定文件，请执行 php bin/console hautelook:fixtures:load -b MyFirstBundle -b MySecondBundle。

查看更多.
下一章： 高级使用

数据库测试

该Bundle提供了一些优秀的助手，灵感来源于 Laravel，专门用于数据库测试：RefreshDatabaseTrait、ReloadDatabaseTrait 和 RecreateDatabaseTrait。这些特性允许在每次PHPUnit测试之前轻松地将数据库重置到已知状态：它清除数据库然后加载固定文件。

它们在编写 功能测试 以及使用 Panther 时特别有用。

为了提高性能，RefreshDatabaseTrait 只填充数据库一次，然后将每个测试包裹在一个事务中，该事务在执行后将回滚（无论成功或失败）。

<?php

namespace App\Tests;

use Hautelook\AliceBundle\PhpUnit\RefreshDatabaseTrait;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class NewsTest extends WebTestCase
{
    use RefreshDatabaseTrait;

    public function postCommentTest()
    {
        $client = static::createClient(); // The transaction starts just after the boot of the Symfony kernel
        $crawler = $client->request('GET', '/my-news');
        $form = $crawler->filter('#post-comment')->form(['new-comment' => 'Symfony is so cool!']);
        $client->submit($form);
        // At the end of this test, the transaction will be rolled back (even if the test fails)
    }
}

有时，无法在事务中包裹测试。例如，当使用Panther时，数据库更改由另一个PHP进程执行，因此它不会起作用。在这种情况下，使用 ReloadDatabase 特性。它将在每个测试之前清除数据库并加载固定文件。

<?php

namespace App\Tests;

use Hautelook\AliceBundle\PhpUnit\ReloadDatabaseTrait;
use Symfony\Component\Panther\PantherTestCase;

class NewsTest extends PantherTestCase // Be sure to extends KernelTestCase, WebTestCase or PantherTestCase
{
    use ReloadDatabaseTrait;

    public function postCommentTest()
    {
        $client = static::createPantherClient();// The database will be reset after every boot of the Symfony kernel

        $crawler = $client->request('GET', '/my-news');
        $form = $crawler->filter('#post-comment')->form(['new-comment' => 'Symfony is so cool!']);
        $client->submit($form);
    }
}

这种策略在使用Panther时不起作用，因为数据库更改是由外部事务之外的另一个进程执行的。

这两个特性都提供了多个配置选项，作为受保护的静态属性

• self::$manager：要使用的Doctrine管理器的名称
• self::$bundles：查找固定文件的Bundle列表
• self::$append：追加固定文件而不是清除
• self::$purgeWithTruncate：使用TRUNCATE清除
• self::$shard：要使用的Doctrine分片的名称
• self::$connection：要使用的Doctrine连接的名称

在 setUpBeforeClass 方法中使用它们。

<?php

namespace App\Tests;

use Hautelook\AliceBundle\PhpUnit\RefreshDatabaseTrait;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class NewsTest extends WebTestCase
{
    use RefreshDatabaseTrait;

    public static function setUpBeforeClass()
    {
        self::$append = true;
    }

    // ...
}

最后，如果您在测试中使用内存SQLite，请使用 RecreateDatabaseTrait 在“即时”创建数据库模式。

<?php

namespace App\Tests;

use Hautelook\AliceBundle\PhpUnit\RecreateDatabaseTrait;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class NewsTest extends WebTestCase
{
    use RecreateDatabaseTrait;

    // ...
}

资源

• Behat扩展： AliceBundleExtension
• 用于从Doctrine实体直接生成与AliceBundle兼容的固定文件的Bundle： AliceGeneratorBundle
• 升级指南
  • 从0.X升级到1.X
• 变更日志

鸣谢

该Bundle最初由 Baldur RENSCH 和 HauteLook 开发。现在由 Théo FIDRY 维护。

其他贡献者.

许可证