《Shortest AI驱动的E2E测试框架安装与配置指南》

1. 项目基础介绍

Shortest 是一个基于人工智能的自然语言端到端测试框架。它允许开发人员通过自然语言来编写测试脚本，极大地简化了测试流程。该项目主要用于自动化测试，确保Web应用在不同的场景和条件下能够正确运行。主要使用的编程语言是TypeScript。

2. 项目使用的关键技术和框架

• Anthropic Claude API: 用于处理自然语言理解的API。
• Playwright: 一个Node.js库，用于自动化Chrome、Firefox和Safari等浏览器。
• GitHub Integration: 支持GitHub身份验证和2FA验证。
• Mailosaur: 用于处理电子邮件验证的服务。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始安装Shortest之前，请确保您的环境中已经安装以下依赖项：

• Node.js (推荐版本^14.17.0)
• npm (推荐版本^6.14.15)
• pnpm (推荐安装全局版本)

安装步骤

步骤1：克隆项目仓库

首先，您需要克隆项目仓库到本地环境：

git clone https://github.com/anti-work/shortest.git
cd shortest

步骤2：安装依赖

使用pnpm安装项目依赖：

pnpm install

步骤3：配置环境变量

在项目根目录下创建一个.env.local文件，并添加以下环境变量：

ANTHROPIC_API_KEY=your_api_key
GITHUB_TOTP_SECRET=your_secret  # 如果需要进行GitHub身份验证测试

请将your_api_key和your_secret替换为您从Anthropic和GitHub获取的实际API密钥和TOTP密钥。

步骤4：初始化Shortest配置

在项目根目录下运行以下命令来初始化Shortest配置文件：

npx @antiwork/shortest init

该命令将自动安装Shortest作为开发依赖（如果尚未安装），创建一个默认的shortest.config.ts配置文件，并生成一个.env.local文件（如果尚不存在）。

步骤5：编写测试脚本

在项目中的app目录下，您可以开始编写自己的测试脚本。例如，创建一个login.test.ts文件，并添加以下内容：

import { shortest } from "@antiwork/shortest";

shortest("登录应用使用电子邮件和密码", {
  username: process.env.GITHUB_USERNAME,
  password: process.env.GITHUB_PASSWORD,
});

确保在.env.local文件中设置了GITHUB_USERNAME和GITHUB_PASSWORD环境变量。

步骤6：运行测试

使用以下命令运行所有测试：

pnpm shortest

或者，运行特定的测试文件：

pnpm shortest login.test.ts

如果需要以无头模式运行测试，可以添加--headless参数：

pnpm shortest --headless

现在，您已经成功安装并配置了Shortest，可以开始您的端到端测试工作了。