KeystoneJS项目测试指南：如何高效测试你的应用-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00200/article/details/148418316

KeystoneJS项目测试指南：如何高效测试你的应用

keystone The most powerful headless CMS for Node.js — built with GraphQL and React 项目地址: https://gitcode.com/gh_mirrors/key/keystone

前言

在开发Web应用时，测试是确保系统行为符合预期的重要环节。本文将深入探讨如何在KeystoneJS项目中编写有效的测试用例，涵盖从基础配置到高级测试技巧的各个方面。

测试环境搭建

初始化测试配置

KeystoneJS提供了专门的测试工具包@keystone-6/core/testing，结合Jest测试框架可以构建完整的测试体系。以下是典型的测试初始化代码：

import { getContext } from '@keystone-6/core/context';
import { resetDatabase } from '@keystone-6/core/testing';
import * as PrismaModule from '.prisma/client';
import baseConfig from './keystone';

// 为每个Jest工作线程创建独立的测试数据库
const dbUrl = `file:./test-${process.env.JEST_WORKER_ID}.db`;
const prismaSchemaPath = path.join(__dirname, 'schema.prisma');
const config = { ...baseConfig, db: { ...baseConfig.db, url: dbUrl } };

// 每个测试用例前重置数据库
beforeEach(async () => {
  await resetDatabase(dbUrl, prismaSchemaPath);
});

// 获取上下文对象
const context = getContext(config, PrismaModule);

关键点说明：

使用独立数据库文件确保测试隔离性
resetDatabase保证每个测试用例都有干净的初始状态
getContext获取应用上下文，这是测试的核心入口

基础测试模式

1. 使用Query API测试CRUD操作

Query API提供了简洁的方式来验证基本数据操作：

test('创建用户并验证字段', async () => {
  const person = await context.query.Person.createOne({
    data: { 
      name: 'Alice', 
      email: 'alice@example.com', 
      password: 'super-secret' 
    },
    query: 'id name email password { isSet }',
  });
  
  expect(person.name).toEqual('Alice');
  expect(person.email).toEqual('alice@example.com');
  expect(person.password.isSet).toEqual(true);
});

2. 测试预期失败的操作

使用context.graphql.raw可以同时检查返回数据和错误信息：

test('验证必填字段检查', async () => {
  const { data, errors } = await context.graphql.raw({
    query: `mutation {
      createPerson(data: { email: "alice@example.com", password: "super-secret" }) {
        id name email password { isSet }
      }
    }`,
  });
  
  expect(data.createPerson).toBe(null);
  expect(errors).toHaveLength(1);
  expect(errors[0].path).toEqual(['createPerson']);
  expect(errors[0].message).toContain('Person.name: Name must not be empty');
});

高级测试技巧

1. 会话模拟测试

context.withSession()允许模拟用户登录状态，非常适合测试权限控制：

test('测试任务权限控制', async () => {
  // 创建测试用户
  const [alice, bob] = await context.query.Person.createMany({
    data: [
      { name: 'Alice', email: 'alice@example.com', password: 'super-secret' },
      { name: 'Bob', email: 'bob@example.com', password: 'super-secret' },
    ],
  });

  // Alice创建任务
  const task = await context.query.Task.createOne({
    data: {
      label: 'Experiment with Keystone',
      assignedTo: { connect: { id: alice.id } },
    },
  });

  // 模拟Bob尝试修改Alice的任务
  const { errors } = await context
    .withSession({ itemId: bob.id, data: {} })
    .graphql.raw({
      query: `mutation update($id: ID!) {
        updateTask(where: { id: $id }, data: { isComplete: true }) {
          id
        }
      }`,
      variables: { id: task.id },
    });
  
  expect(errors[0].message).toContain('Access denied');
});

2. 测试钩子(Hooks)行为

验证业务逻辑钩子的执行情况：

test('验证密码加密钩子', async () => {
  const plainPassword = 'super-secret';
  const person = await context.query.Person.createOne({
    data: { 
      name: 'Alice',
      email: 'alice@example.com',
      password: plainPassword
    },
    query: 'password { isSet hash }',
  });
  
  expect(person.password.isSet).toBe(true);
  expect(person.password.hash).not.toEqual(plainPassword);
});

测试最佳实践

隔离性原则：每个测试用例应完全独立，使用resetDatabase确保状态重置
并行测试：利用Jest的worker机制实现并行测试，提高效率
测试分层：
- 单元测试：验证单个函数或组件
- 集成测试：验证模块间交互
- E2E测试：验证完整业务流程
测试覆盖率：重点关注业务逻辑、权限控制和数据验证等核心功能

常见测试场景

1. 验证虚拟字段

test('验证全名虚拟字段', async () => {
  const person = await context.query.Person.createOne({
    data: { 
      firstName: 'John',
      lastName: 'Doe'
    },
    query: 'fullName',
  });
  
  expect(person.fullName).toEqual('John Doe');
});

2. 测试复杂查询

test('验证分页查询', async () => {
  // 先创建测试数据
  await context.query.Person.createMany({
    data: [...Array(20).keys()].map(i => ({
      name: `User ${i}`,
      email: `user${i}@example.com`
    }))
  });
  
  const { data } = await context.graphql.raw({
    query: `query {
      allPeople(first: 5, skip: 10) {
        name
      }
    }`
  });
  
  expect(data.allPeople).toHaveLength(5);
  expect(data.allPeople[0].name).toEqual('User 10');
});