Vendure电商平台测试指南：从零构建可靠的插件测试体系-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00976/article/details/148487734

Vendure电商平台测试指南：从零构建可靠的插件测试体系

vendure A headless GraphQL commerce platform for the modern web 项目地址: https://gitcode.com/gh_mirrors/ve/vendure

前言

在构建电商系统时，测试环节是确保系统稳定性和功能完整性的关键。本文将深入探讨如何为Vendure电商平台的插件开发构建完整的端到端测试体系，帮助开发者打造高质量的电商插件。

测试环境搭建

核心依赖安装

首先需要安装必要的测试依赖包：

npm install --save-dev @vendure/testing vitest graphql-tag @swc/core unplugin-swc

这里我们选择Vitest作为测试框架，相比传统测试工具，它具有以下优势：

对现代JavaScript特性的完美支持
极快的测试执行速度
与Vendure技术栈高度兼容

测试配置详解

创建vitest.config.mts配置文件：

import path from 'path';
import swc from 'unplugin-swc';
import { defineConfig } from 'vitest/config';

export default defineConfig({
    test: {
        include: ['**/*.e2e-spec.ts'],
        typecheck: {
            tsconfig: path.join(__dirname, 'tsconfig.e2e.json'),
        },
    },
    plugins: [
        swc.vite({
            jsc: {
                transform: {
                    useDefineForClassFields: false,
                },
            },
        }),
    ],
});

关键配置说明：

include指定测试文件匹配模式
通过SWC插件支持装饰器等高级语法
禁用useDefineForClassFields确保与Vendure的兼容性

同时需要创建专用的TypeScript配置tsconfig.e2e.json：

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "types": ["node"],
    "lib": ["es2015"],
    "useDefineForClassFields": false,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

数据库初始化策略

Vendure测试包提供了灵活的数据库初始化机制：

import {
    MysqlInitializer,
    PostgresInitializer,
    SqljsInitializer,
    registerInitializer,
} from '@vendure/testing';

const sqliteDataDir = path.join(__dirname, '__data__');

registerInitializer('sqljs', new SqljsInitializer(sqliteDataDir));
registerInitializer('postgres', new PostgresInitializer());
registerInitializer('mysql', new MysqlInitializer());

技术要点：

SQLite初始化器会缓存测试数据，大幅提升后续测试速度
支持多种数据库类型，确保测试环境与生产环境一致
自定义初始器可扩展支持其他TypeORM兼容数据库

测试环境构建

创建测试环境实例

const { server, adminClient, shopClient } = createTestEnvironment({
    ...testConfig,
    plugins: [MyPlugin],
});

关键组件说明：

server: 测试服务器实例
adminClient: 管理员API客户端
shopClient: 商店前端API客户端

服务器初始化

beforeAll(async () => {
    await server.init({
        productsCsvPath: path.join(__dirname, 'fixtures/e2e-products.csv'),
        initialData: myInitialData,
        customerCount: 2,
    });
    await adminClient.asSuperAdmin();
}, 60000);

初始化参数详解：

productsCsvPath: 产品数据CSV文件路径
initialData: 非产品类初始化数据（集合、配送方式等）
customerCount: 生成的测试客户数量

编写测试用例

基础GraphQL查询测试

it('测试自定义查询', async () => {
    adminClient.asSuperAdmin();
    
    const query = gql`
        query MyNewQuery($id: ID!) {
            myNewQuery(id: $id) {
                field1
                field2
            }
        }
    `;
    
    const result = await adminClient.query(query, {id: 123});
    expect(result.myNewQuery).toEqual({ /* 预期结果 */ });
});

测试要点：

使用graphql-tag简化查询构建
先以超级管理员身份认证
对API返回结果进行断言验证

并行测试注意事项

当使用多个测试套件时，需要为每个套件指定唯一端口：

const { server } = createTestEnvironment(mergeConfig(testConfig, {
    apiOptions: {
        port: 3051, // 唯一端口号
    },
    plugins: [MyPlugin],
}));

高级测试技巧

访问内部服务

通过server.app可以获取任何Vendure内部服务：

let productService: ProductService;

beforeAll(async () => {
    await server.init(/* ... */);
    productService = server.app.get(ProductService);
});

典型应用场景：