集成测试
集成测试侧重于测试程序的不同部分如何协同工作。在使用数据库的应用程序的上下文中，集成测试通常需要数据库可用并包含方便测试场景的数据。
模拟真实环境的一种方法是使用 Docker 来封装一个数据库和一些测试数据。这可以在测试中启动和关闭，从而作为与您的生产数据库隔离的环境运行。
注意：这篇文章 博客文章 提供了有关设置集成测试环境和针对真实数据库编写集成测试的全面指南，为希望探索该主题的人员提供了宝贵的见解。
先决条件
本指南假设您已在机器上安装了 Docker 和 Docker Compose，以及在您的项目中设置了 Jest。
以下电子商务架构将在整个指南中使用。这与文档其他部分中使用的传统 User 和 Post 模型有所不同，主要是因为您不太可能针对您的博客运行集成测试。
电子商务架构
schema.prisma
// Can have 1 customer
// Can have many order details
model CustomerOrder {
id Int @id @default(autoincrement())
createdAt DateTime @default(now())
customer Customer @relation(fields: [customerId], references: [id])
customerId Int
orderDetails OrderDetails[]
}
// Can have 1 order
// Can have many products
model OrderDetails {
id Int @id @default(autoincrement())
products Product @relation(fields: [productId], references: [id])
productId Int
order CustomerOrder @relation(fields: [orderId], references: [id])
orderId Int
total Decimal
quantity Int
}
// Can have many order details
// Can have 1 category
model Product {
id Int @id @default(autoincrement())
name String
description String
price Decimal
sku Int
orderDetails OrderDetails[]
category Category @relation(fields: [categoryId], references: [id])
categoryId Int
}
// Can have many products
model Category {
id Int @id @default(autoincrement())
name String
products Product[]
}
// Can have many orders
model Customer {
id Int @id @default(autoincrement())
email String @unique
address String?
name String?
orders CustomerOrder[]
}
本指南使用单例模式来设置 Prisma Client。有关如何设置单例模式的详细说明，请参阅 单例 文档。
将 Docker 添加到您的项目
在您的机器上安装了 Docker 和 Docker compose 后，您可以在项目中使用它们。
- 首先，在项目的根目录中创建一个
docker-compose.yml文件。在这里，您将添加一个 Postgres 镜像并指定环境凭据。
docker-compose.yml
# Set the version of docker compose to use
version: '3.9'
# The containers that compose the project
services:
db:
image: postgres:13
restart: always
container_name: integration-tests-prisma
ports:
- '5433:5432'
environment:
POSTGRES_USER: prisma
POSTGRES_PASSWORD: prisma
POSTGRES_DB: tests
注意：此处使用的 compose 版本（
3.9）是撰写本文时的最新版本。如果您正在遵循操作步骤，请确保使用相同的版本以保持一致性。
docker-compose.yml 文件定义了以下内容：
- Postgres 镜像 (
postgres) 和版本标签 (:13)。如果您在本地没有可用，则会下载此镜像。 - 端口
5433映射到内部 (Postgres 默认) 端口5432。这将是数据库在外部公开的端口号。 - 数据库用户凭据已设置，并为数据库指定了一个名称。
- 要连接到容器中的数据库，请使用在
docker-compose.yml文件中定义的凭据创建一个新的连接字符串。例如：
.env.test
DATABASE_URL="postgresql://prisma:prisma@localhost:5433/tests"
info
上面的 .env.test 文件用作多个 .env 文件设置的一部分。查看 使用多个 .env 文件 部分，详细了解如何使用多个 .env 文件设置项目。
- 要以分离状态创建容器以便您可以继续使用终端选项卡，请运行以下命令：
docker compose up -d
-
接下来，您可以通过在容器中执行
psql命令来检查数据库是否已创建。记下容器 ID。docker ps显示CLI结果CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
1322e42d833f postgres:13 "docker-entrypoint.s…" 2 seconds ago Up 1 second 0.0.0.0:5433->5432/tcp integration-tests-prisma
注意：容器 ID 对每个容器都是唯一的，您将看到不同的 ID 显示。
-
使用上一步中的容器 ID，在容器中运行
psql，使用创建的用户登录并检查数据库是否已创建：docker exec -it 1322e42d833f psql -U prisma tests显示CLI结果tests=# \l
List of databases
Name | Owner | Encoding | Collate | Ctype | Access privileges
postgres | prisma | UTF8 | en_US.utf8 | en_US.utf8 |
template0 | prisma | UTF8 | en_US.utf8 | en_US.utf8 | =c/prisma +
| | | | | prisma=CTc/prisma
template1 | prisma | UTF8 | en_US.utf8 | en_US.utf8 | =c/prisma +
| | | | | prisma=CTc/prisma
tests | prisma | UTF8 | en_US.utf8 | en_US.utf8 |
(4 rows)
集成测试
集成测试将在专用测试环境中针对数据库运行，而不是在生产或开发环境中运行。
操作流程
运行这些测试的流程如下：
- 启动容器并创建数据库
- 迁移架构
- 运行测试
- 销毁容器
每个测试套件将在所有测试运行之前为数据库播种数据。在套件中的所有测试完成后，将从所有表中删除数据，并终止连接。
要测试的函数
您正在测试的电子商务应用程序有一个创建订单的函数。此函数执行以下操作：
- 接受有关下单客户的信息
- 接受有关所订购产品的的信息
- 检查客户是否已有帐户
- 检查产品是否库存充足
- 如果产品不存在，则返回“缺货”消息
- 如果客户在数据库中不存在，则创建帐户
- 创建订单
下面是一个示例，展示了此类函数可能的外观：
create-order.ts
import prisma from '../client'
export interface Customer {
id?: number
name?: string
email: string
address?: string
}
export interface OrderInput {
customer: Customer
productId: number
quantity: number
}
/**
* Creates an order with customer.
* @param input The order parameters
*/
export async function createOrder(input: OrderInput) {
const { productId, quantity, customer } = input
const { name, email, address } = customer
// Get the product
const product = await prisma.product.findUnique({
where: {
id: productId,
},
})
// If the product is null its out of stock, return error.
if (!product) return new Error('Out of stock')
// If the customer is new then create the record, otherwise connect via their unique email
await prisma.customerOrder.create({
data: {
customer: {
connectOrCreate: {
create: {
name,
email,
address,
},
where: {
email,
},
},
},
orderDetails: {
create: {
total: product.price,
quantity,
products: {
connect: {
id: product.id,
},
},
},
},
},
})
}
测试套件
以下测试将检查 createOrder 函数是否按预期工作。它们将测试：
- 使用新客户创建新订单
- 使用现有客户创建订单
- 如果产品不存在，则显示“缺货”错误消息
在运行测试套件之前，将为数据库播种数据。测试套件完成后，将使用 deleteMany 来清除数据库中的数据。
tip
在您提前知道架构结构的情况下，使用 deleteMany 可能就足够了。这是因为操作需要根据模型关系的设置顺序执行。
但是，与更通用的解决方案相比，这种方法的可扩展性不如后者。对于那些情况以及使用原始 SQL 查询的示例，请参阅 使用原始 SQL/TRUNCATE 删除所有数据
__tests__/create-order.ts
import prisma from '../src/client'
import { createOrder, Customer, OrderInput } from '../src/functions/index'
beforeAll(async () => {
// create product categories
await prisma.category.createMany({
data: [{ name: 'Wand' }, { name: 'Broomstick' }],
})
console.log('✨ 2 categories successfully created!')
// create products
await prisma.product.createMany({
data: [
{
name: 'Holly, 11", phoenix feather',
description: 'Harry Potters wand',
price: 100,
sku: 1,
categoryId: 1,
},
{
name: 'Nimbus 2000',
description: 'Harry Potters broom',
price: 500,
sku: 2,
categoryId: 2,
},
],
})
console.log('✨ 2 products successfully created!')
// create the customer
await prisma.customer.create({
data: {
name: 'Harry Potter',
email: '[email protected]',
address: '4 Privet Drive',
},
})
console.log('✨ 1 customer successfully created!')
})
afterAll(async () => {
const deleteOrderDetails = prisma.orderDetails.deleteMany()
const deleteProduct = prisma.product.deleteMany()
const deleteCategory = prisma.category.deleteMany()
const deleteCustomerOrder = prisma.customerOrder.deleteMany()
const deleteCustomer = prisma.customer.deleteMany()
await prisma.$transaction([
deleteOrderDetails,
deleteProduct,
deleteCategory,
deleteCustomerOrder,
deleteCustomer,
])
await prisma.$disconnect()
})
it('should create 1 new customer with 1 order', async () => {
// The new customers details
const customer: Customer = {
id: 2,
name: 'Hermione Granger',
email: '[email protected]',
address: '2 Hampstead Heath',
}
// The new orders details
const order: OrderInput = {
customer,
productId: 1,
quantity: 1,
}
// Create the order and customer
await createOrder(order)
// Check if the new customer was created by filtering on unique email field
const newCustomer = await prisma.customer.findUnique({
where: {
email: customer.email,
},
})
// Check if the new order was created by filtering on unique email field of the customer
const newOrder = await prisma.customerOrder.findFirst({
where: {
customer: {
email: customer.email,
},
},
})
// Expect the new customer to have been created and match the input
expect(newCustomer).toEqual(customer)
// Expect the new order to have been created and contain the new customer
expect(newOrder).toHaveProperty('customerId', 2)
})
it('should create 1 order with an existing customer', async () => {
// The existing customers email
const customer: Customer = {
email: '[email protected]',
}
// The new orders details
const order: OrderInput = {
customer,
productId: 1,
quantity: 1,
}
// Create the order and connect the existing customer
await createOrder(order)
// Check if the new order was created by filtering on unique email field of the customer
const newOrder = await prisma.customerOrder.findFirst({
where: {
customer: {
email: customer.email,
},
},
})
// Expect the new order to have been created and contain the existing customer with an id of 1 (Harry Potter from the seed script)
expect(newOrder).toHaveProperty('customerId', 1)
})
it("should show 'Out of stock' message if productId doesn't exit", async () => {
// The existing customers email
const customer: Customer = {
email: '[email protected]',
}
// The new orders details
const order: OrderInput = {
customer,
productId: 3,
quantity: 1,
}
// The productId supplied doesn't exit so the function should return an "Out of stock" message
await expect(createOrder(order)).resolves.toEqual(new Error('Out of stock'))
})
运行测试
此设置隔离了真实场景，因此您可以在受控环境中针对真实数据测试应用程序的功能。
您可以将一些脚本添加到项目的 package.json 文件中，这些脚本将设置数据库并运行测试，然后手动销毁容器。
package.json
"scripts": {
"docker:up": "docker compose up -d",
"docker:down": "docker compose down",
"test": "yarn docker:up && yarn prisma migrate deploy && jest -i"
},
test 脚本执行以下操作：
- 运行
docker compose up -d来创建包含 Postgres 镜像和数据库的容器。 - 将
./prisma/migrations/目录中找到的迁移应用于数据库，这将在容器的数据库中创建表。 - 执行测试。
如果您满意，可以运行 yarn docker:down 来销毁容器、其数据库和任何测试数据。