FluidFramework 项目中的测试与自动化实践指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00095/article/details/148508836

FluidFramework 项目中的测试与自动化实践指南

FluidFramework Library for building distributed, real-time collaborative web applications 项目地址: https://gitcode.com/gh_mirrors/fl/FluidFramework

前言

在分布式协作系统开发中，确保代码质量和系统稳定性至关重要。本文将深入探讨 FluidFramework 项目的测试与自动化实践，帮助开发者构建可靠的实时协作应用。

FluidFramework 测试体系概述

FluidFramework 采用了多层次的测试策略，主要包括：

单元测试：验证独立模块的功能正确性
集成测试：检查模块间的交互行为
端到端测试：模拟真实用户场景

测试框架主要基于 Mocha 和 Jest，结合 Puppeteer 进行浏览器自动化测试，使用 webpack 进行模块打包。

测试环境配置

本地测试环境（Tinylicious）

Tinylicious 是 FluidFramework 提供的本地服务实现，适合开发阶段和持续集成测试。

配置步骤

安装依赖包：

npm install tinylicious start-server-and-test mocha

在 package.json 中添加脚本：

"scripts": {
    "start:tinylicious": "tinylicious > tinylicious.log 2>&1",
    "test:mocha": "mocha",
    "test:tinylicious": "start-server-and-test start:tinylicious 7070 test:mocha"
}

工作原理

启动 Tinylicious 服务
监听 7070 端口就绪状态
执行测试用例
测试完成后自动终止服务

云端测试环境（Azure Fluid Relay）

对于需要真实云环境验证的场景，可以使用 Azure Fluid Relay 的测试租户。

关键配置项

租户ID（tenantId）
终端地址（endpoint）
认证令牌提供者（tokenProvider）

统一客户端设计模式

为了实现代码复用，可以采用统一客户端设计，使同一套测试代码能够适配不同环境。

function createAzureClient(): AzureClient {
    const useAzure = process.env.FLUID_CLIENT === "azure";
    const tenantKey = useAzure ? (process.env.FLUID_TENANTKEY as string) : "";
    const user = { id: "userId", name: "Test User" };

    const connectionConfig = useAzure
        ? {
              type: "remote",
              tenantId: "myTenantId",
              tokenProvider: new InsecureTokenProvider(tenantKey, user),
              endpoint: "https://myOrdererUrl",
          }
        : {
              type: "local",
              tokenProvider: new InsecureTokenProvider("fooBar", user),
              endpoint: "http://localhost:7070",
          };
    return new AzureClient({ connection: connectionConfig });
}

测试用例编写实践

基本测试结构

describe("容器操作测试套件", () => {
    const client = createAzureClient();
    let documentId: string;
    
    beforeEach("初始化文档ID", () => {
        documentId = uuid(); // 使用UUID生成唯一文档ID
    });

    it("应能成功创建Azure容器", async () => {
        const schema: ContainerSchema = {
            initialObjects: {
                customMap: SharedMap,
            },
        };

        const { container } = await client.createContainer(schema);
        expect(container).toBeDefined();
    });
});

测试脚本配置

"scripts": {
    "start:tinylicious": "tinylicious > tinylicious.log 2>&1",
    "test:mocha": "mocha",
    "test:azure": "cross-env process.env.FLUID_CLIENT='\"azure\"' && npm run test:mocha",
    "test:tinylicious": "start-server-and-test start:tinylicious 7070 test:mocha"
}