README

一个用于使用 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 已足够。

文档

安装

使用 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 或您内核类所在的任何位置相应地注册扩展

<?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%'

如果您正在使用非弹性架构，您可能想使用 Resources/fixtures 而不是 fixtures。

基本使用

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

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

如果您使用 flex，则使用 fixtures
如果您有一个非 flex 的无 bundle 的 Symfony 应用程序，则使用 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。这些 trait 允许在每次 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 trait。它将在每个测试之前清除数据库并加载固定数据。

<?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 时不起作用，因为数据库的更改是由另一个进程在事务之外进行的。

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

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 维护。

其他贡献者.

vivvvi / hautelook

维护者

详细信息

README

何时使用此扩展？

文档

安装

基本使用

数据库测试

资源

致谢

许可