README

A Symfony 扩展包，用于使用 nelmio/alice 和 fzaninotto/Faker 管理测试数据。

数据库支持在 FidryAliceDataFixtures 中完成。查看此项目以了解支持的数据库/ORM。

注意：这是 HautelookAliceBundle 2.0 的文档。如果您想查看 1.x 的文档，请访问此处。

何时使用此包？

HautelookAliceBundle 发生了很大变化，最初它是一个简单的 nelmio/alice 扩展包，后来开始提供一些额外的功能来丰富它。

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

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

HautelookAliceBundle 2.x 发生了很大变化，尽管变化不大。在 1.x 中，由于 nelmio/alice 2.x 的限制，包中引入了大量的复杂性，并且最多只是权宜之计（例如，无法处理循环引用）。其中许多复杂性已经推回到 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类所在位置相应地注册捆绑包。

<?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;
}

根据您的需求配置捆绑包，例如

# 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
• 如果您有一个非flex的无捆绑Symfony应用程序，则使用 app/Resources/fixtures
• src/AppBundle/Resources/fixtures 或您想要放置固定文件的任何捆绑包

# 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 加载您的固定文件。

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

更多信息.
下一章： 高级使用

数据库测试

该捆绑包提供了一些友好的辅助工具，这些工具受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：要查找固定文件的捆绑包列表
• 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兼容的固定文件的捆绑包：AliceGeneratorBundle
• 升级指南
  • 从0.X升级到1.X
• 变更日志

致谢

此捆绑包最初由 Baldur RENSCH 和 HauteLook 开发。它现在由 Théo FIDRY 维护。

其他贡献者.

许可证