介绍

Laravel 提供了各种有用的工具和断言,从而让测试数据库驱动变得更加容易。除此之外,Laravel 模型工厂和 Seeders 可以轻松地使用应用程序的 Eloquent 模型和关系来创建测试数据库记录。

每次测试后重置数据库

在进行测试之前,让我们讨论一下如何在每次测试后重置数据库,以便让先前测试的数据不会干扰后续测试。 Laravel 包含的 php Illuminate\Foundation\Testing\RefreshDatabase trait 会为你解决这个问题。只需在您的测试类上使用该 Trait:

  1. <?php
  2. namespace Tests\Feature;
  3. use Illuminate\Foundation\Testing\RefreshDatabase;
  4. use Illuminate\Foundation\Testing\WithoutMiddleware;
  5. use Tests\TestCase;
  6. class ExampleTest extends TestCase
  7. {
  8. use RefreshDatabase;
  9. /**
  10. * 一个基本的功能测试例子。
  11. */
  12. public function test_basic_example(): void
  13. {
  14. $response = $this->get('/');
  15. // ...
  16. }
  17. }

如果你的数据库结构是最新的,那么这个 Traitphp Illuminate\Foundation\Testing\RefreshDatabase 并不会迁移数据库。相反,它只会在一个数据库事务中执行测试。因此,任何由测试用例添加到数据库的记录,如果不使用这个 Trait,可能仍然存在于数据库中。

如果你想使用迁移来完全重置数据库,可以使用这个 Trait php Illuminate\Foundation\Testing\DatabaseMigrations 来替代。然而,php DatabaseMigrations 这个 Trait 明显比 php RefreshDatabase Trait 要慢。

模型工厂

当我们测试的时候,可能需要在执行测试之前向数据库插入一些数据。Laravel 允许你使用 模型工厂 为每个 Eloquent 模型 定义一组默认值,而不是在创建测试数据时手动指定每一列的值。

要学习有关创建和使用模型工厂来创建模型的更多信息,请参阅完整的 模型工厂文档。定义模型工厂后,你可以在测试中使用该工厂来创建模型:

  1. use App\Models\User;
  2. public function test_models_can_be_instantiated(): void
  3. {
  4. $user = User::factory()->create();
  5. // ...
  6. }

运行 seeders

如果你在功能测试时希望使用 数据库 seeders 来填充你的数据库, 你可以调用 php seed 方法。 默认情况下, php seed 方法将会执行 php DatabaseSeeder, 它将会执行你的所有其他 seeders。或者,你传递指定的 seeder 类名给 php seed 方法:

  1. <?php
  2. namespace Tests\Feature;
  3. use Database\Seeders\OrderStatusSeeder;
  4. use Database\Seeders\TransactionStatusSeeder;
  5. use Illuminate\Foundation\Testing\RefreshDatabase;
  6. use Illuminate\Foundation\Testing\WithoutMiddleware;
  7. use Tests\TestCase;
  8. class ExampleTest extends TestCase
  9. {
  10. use RefreshDatabase;
  11. /**
  12. * 测试创建新订单。
  13. */
  14. public function test_orders_can_be_created(): void
  15. {
  16. // 运行 DatabaseSeeder...
  17. $this->seed();
  18. // 运行指定 seeder...
  19. $this->seed(OrderStatusSeeder::class);
  20. // ...
  21. // 运行指定的 seeders...
  22. $this->seed([
  23. OrderStatusSeeder::class,
  24. TransactionStatusSeeder::class,
  25. // ...
  26. ]);
  27. }
  28. }

或者通过 php RefreshDatabase trait 在每次测试之前自动为数据库填充数据。你也可以通过在测试类上定义 php $seed 属性来实现:

  1. <?php
  2. namespace Tests;
  3. use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
  4. abstract class TestCase extends BaseTestCase
  5. {
  6. use CreatesApplication;
  7. /**
  8. * Indicates whether the default seeder should run before each test.
  9. *
  10. * @var bool
  11. */
  12. protected $seed = true;
  13. }

php $seed 属性为 php true 时,这个测试将在每个使用 php RefreshDatabase trait 的测试之前运行 php Database\Seeders\DatabaseSeeder 类。但是,你可以通过在测试类上定义 php $seeder 属性来指定要执行的 seeder:

  1. use Database\Seeders\OrderStatusSeeder;
  2. /**
  3. * 在测试前指定要运行的 seeder
  4. *
  5. * @var string
  6. */
  7. protected $seeder = OrderStatusSeeder::class;

可用的断言

Laravel 为你的 PHPUnit 功能测试提供了几个数据库断言。我们将在下面逐个讨论。

assertDatabaseCount
断言数据库中的表包含给定数量的记录:

  1. $this->assertDatabaseCount('users', 5);

assertDatabaseHas
断言数据库中的表包含给定键/值查询约束的记录:

  1. $this->assertDatabaseHas('users', [
  2. 'email' => 'sally@example.com',
  3. ]);

assertDatabaseMissing
断言数据库中的表不包含给定键/值查询约束的记录:

  1. $this->assertDatabaseMissing('users', [
  2. 'email' => 'sally@example.com',
  3. ]);

assertSoftDeleted
php assertSoftDeleted 方法断言给定的 Eloquent 模型已被「软删除」的记录:

  1. $this->assertSoftDeleted($user);

assertNotSoftDeleted
php assertNotSoftDeleted 方法断言给定的 Eloquent 模型没有被「软删除」的记录:

  1. $this->assertNotSoftDeleted($user);

assertModelExists
断言数据库中存在给定的模型:

  1. use App\Models\User;
  2. $user = User::factory()->create();
  3. $this->assertModelExists($user);

assertModelMissing
断言数据库中不存在给定的模型:

  1. use App\Models\User;
  2. $user = User::factory()->create();
  3. $user->delete();
  4. $this->assertModelMissing($user);

expectsDatabaseQueryCount
可以在测试开始时调用 php expectsDatabaseQueryCount 方法,以指定你希望在测试期间运行的数据库查询总数。如果实际执行的查询数量与这个预期不完全匹配,那么测试将失败:

  1. $this->expectsDatabaseQueryCount(5);
  2. // Test...