AdonisJS 中文文档

主题

数据库测试 ​

数据库测试是指测试应用程序与数据库的交互方式。这包括测试写入数据库的内容、如何在测试之前运行迁移以及如何在测试之间保持数据库清洁。

迁移数据库 ​

在执行与数据库交互的测试之前，您需要首先运行迁移。我们在 testUtils 服务中有两个可用的钩子，您可以在 tests/bootstrap.ts 文件中配置它们。

每次运行周期后重置数据库 ​

我们有的第一个选项是 testUtils.db().migrate()。此钩子将首先运行所有迁移，然后回滚所有内容。

ts
// title: tests/bootstrap.ts
import testUtils from '@adonisjs/core/services/test_utils'

export const runnerHooks: Required<Pick<Config, 'setup' | 'teardown'>> = {
  setup: [
    () => testUtils.db().migrate(),
  ],
  teardown: [],
}

通过在此处配置钩子，将发生以下情况：

  • 在运行测试之前，将执行迁移。
  • 在测试结束时，数据库将被回滚。

因此，每次运行测试时，我们都会有一个全新的空数据库。

每次运行周期后截断表 ​

每次运行周期后重置数据库是一个不错的选择，但如果您有很多迁移，这可能会很慢。另一个选项是在每次运行周期后截断表。此选项会更快，因为迁移只会执行一次：您第一次在全新数据库上运行测试时。

在每次运行周期结束时，表将被截断，但我们的模式将保留。因此，下次运行测试时，我们将有一个空数据库，但模式已经就位，因此无需再次运行每个迁移。

ts
// title: tests/bootstrap.ts
import testUtils from '@adonisjs/core/services/test_utils'

export const runnerHooks: Required<Pick<Config, 'setup' | 'teardown'>> = {
  setup: [
    () => testUtils.db().truncate(),
  ],
}

填充数据库 ​

如果您需要填充数据库，可以使用 testUtils.db().seed() 钩子。此钩子将在运行测试之前运行所有种子。

ts
// title: tests/bootstrap.ts
import testUtils from '@adonisjs/core/services/test_utils'

export const runnerHooks: Required<Pick<Config, 'setup' | 'teardown'>> = {
  setup: [
    () => testUtils.db().seed(),
  ],
}

在测试之间保持数据库清洁 ​

全局事务 ​

运行测试时，您可能希望在每个测试之间保持数据库清洁。为此，您可以使用 testUtils.db().withGlobalTransaction() 钩子。此钩子将在每个测试之前启动事务，并在测试结束时回滚它。

ts
// title: tests/unit/user.spec.ts
import { test } from '@japa/runner'
import testUtils from '@adonisjs/core/services/test_utils'

test.group('User', (group) => {
  group.each.setup(() => testUtils.db().withGlobalTransaction())
})

请注意，如果您在测试代码中使用任何事务，这将不起作用，因为事务不能嵌套。在这种情况下，您可以使用 testUtils.db().migrate() 或 testUtils.db().truncate() 钩子代替。

截断表 ​

如上所述，如果您在测试代码中使用事务，全局事务将不起作用。在这种情况下，您可以使用 testUtils.db().truncate() 钩子。此钩子将在每个测试后截断所有表。

ts
// title: tests/unit/user.spec.ts
import { test } from '@japa/runner'

test.group('User', (group) => {
  group.each.setup(() => testUtils.db().truncate())
})