端到端研发自动化系统使用手册

系统概述

本系统是基于 OpenClaw 和 Claude Code 两大 AI 智能体框架构建的端到端研发自动化平台，实现从需求分析到生产部署的全流程自动化。

🎯 核心特性

🛠️ 技术栈

🚀 快速开始

# 1. 克隆项目
git clone https://github.com/your-org/openclaw-claude-automation.git
cd openclaw-claude-automation

# 2. 安装依赖
pip install -r requirements.txt
npm install

# 3. 配置环境变量
cp .env.example .env
# 编辑.env 文件，填入必要的 API Keys

# 4. 启动 OpenClaw
python src/openclaw_server.py

# 5. 验证安装
python tests/health_check.py

系统架构

系统采用分层架构设计，从上到下分为用户交互层、OpenClaw 协调层、Claude Code 执行层和基础设施层。

📊 架构优势

各角色 Agents 配置

系统预置了完整的研发岗位 Agents，每个 Agent 都有明确的职责边界和专业技能。

📋 产品经理 Agent

# .agents/product_manager/AGENTS.md

## 角色定义
你是一名资深产品经理，负责需求分析、PRD 文档撰写和产品规划。

## 核心技能
- 需求收集与分析
- 用户故事编写
- PRD 文档结构化
- 优先级排序 (MoSCoW 法则)

## 输出规范
- 使用标准 PRD 模板
- 包含功能列表、验收标准
- 明确非功能性需求

🏛️ 架构师 Agent

# .agents/architect/AGENTS.md

## 角色定义
你是一名系统架构师，负责技术方案设计和架构评审。

## 核心技能
- 系统架构设计
- 技术选型评估
- 性能与安全考量
- API 设计规范制定

## 输出规范
- 架构图 (Mermaid/C4 模型)
- 技术栈说明
- 风险评估报告

💻 开发工程师 Agent

# .agents/developer/AGENTS.md

## 角色定义
你是全栈开发工程师，负责前后端代码实现。

## 核心技能
- RESTful API 开发
- 前端组件开发
- 数据库设计与优化
- 代码审查

## 输出规范
- 遵循团队代码规范
- 包含单元测试
- API 文档自动生成

✅ 测试工程师 Agent

# .agents/qa/AGENTS.md

## 角色定义
你是 QA 工程师，负责测试策略制定和自动化测试执行。

## 核心技能
- 测试用例设计
- 自动化测试脚本
- 性能测试
- 安全测试

## 输出规范
- 测试覆盖率报告
- Bug 跟踪与分类
- 质量门禁检查

🚀 DevOps Agent

# .agents/devops/AGENTS.md

## 角色定义
你是 DevOps 工程师，负责 CI/CD 流水线配置和生产部署。

## 核心技能
- Jenkins Pipeline 编写
- Docker 容器化
- K8s 部署配置
- 监控告警设置

## 输出规范
- 可重复的部署脚本
- 回滚方案
- 运维文档

工作流程详解

系统实现了从需求到部署的完整自动化工作流，每个阶段都支持人机协同。

📝 阶段 1: 需求分析 → PRD 设计

🏗️ 阶段 2: 技术方案设计

🤖 阶段 3: AI Coding

✅ 阶段 4: 测试自动化

🚀 阶段 5: CI/CD 部署

测试自动化模块

系统采用测试金字塔模型，结合 AI 智能体实现各层级测试的自动化。

📊 测试金字塔

🧪 单元测试示例

# tests/unit/backend/test_api.py
import pytest
from fastapi.testclient import TestClient
from src.api.main import app

client = TestClient(app)

class TestUserAPI:
    """用户 API 测试套件"""
    
    def test_create_user_success(self):
        """测试成功创建用户"""
        payload = {
            "username": "testuser",
            "email": "test@example.com",
            "password": "SecurePass123!"
        }
        
        response = client.post("/api/v1/users", json=payload)
        
        assert response.status_code == 201
        data = response.json()
        assert "id" in data
        assert data["username"] == payload["username"]
    
    @pytest.mark.parametrize("invalid_email", [
        "invalid-email",
        "@example.com",
        "user@"
    ])
    def test_create_user_invalid_email(self, invalid_email):
        """参数化测试：无效邮箱格式"""
        payload = {
            "username": "testuser",
            "email": invalid_email,
            "password": "SecurePass123!"
        }
        
        response = client.post("/api/v1/users", json=payload)
        assert response.status_code == 422

🔗 集成测试示例

# tests/integration/test_api_integration.py
import pytest
import httpx

@pytest.mark.asyncio
async def test_user_registration_flow():
    """测试完整的用户注册流程"""
    async with httpx.AsyncClient(base_url="http://localhost:8000") as client:
        # 1. 创建用户
        register_payload = {
            "username": "integration_test_user",
            "email": "integration@test.com",
            "password": "Test123!"
        }
        
        response = await client.post("/api/v1/users", json=register_payload)
        assert response.status_code == 201
        
        # 2. 登录获取 token
        login_payload = {
            "username": "integration_test_user",
            "password": "Test123!"
        }
        
        response = await client.post("/api/v1/auth/login", json=login_payload)
        assert response.status_code == 200
        token = response.json()["access_token"]
        
        # 3. 使用 token 访问受保护接口
        headers = {"Authorization": f"Bearer {token}"}
        response = await client.get("/api/v1/users/me", headers=headers)
        assert response.status_code == 200

🎭 UI 自动化测试

# tests/e2e/test_user_flow.py
from playwright.sync_api import expect

def test_successful_login_and_logout(page):
    """测试成功登录和登出流程"""
    # 导航到登录页
    page.goto('/login')
    
    # 填写登录表单
    page.fill('input[name="username"]', 'testuser')
    page.fill('input[name="password"]', 'password123')
    page.click('button[type="submit"]')
    
    # 验证跳转到仪表板
    expect(page.locator('.welcome-message')).to_be_visible()
    
    # 执行登出
    page.click('button[data-testid="logout"]')
    
    # 验证返回登录页
    expect(page.locator('input[name="username"]')).to_be_visible()

⚡ 运行测试命令

# 运行所有单元测试
pytest tests/unit -v --cov=src

# 运行集成测试
pytest tests/integration -v -m integration

# 运行 E2E 测试
playwright test tests/e2e --reporter=html

# 生成综合测试报告
python scripts/generate_test_report.py

CI/CD 集成与部署

系统采用 Jenkins Pipeline 实现完整的 CI/CD 流程，支持自动化构建、测试和部署。

📋 Jenkins Pipeline 关键阶段

🎯 质量门禁

最佳实践

✅ 推荐做法

• 保持 CLAUDE.md 在 30 行以内，只包含关键信息
• 使用 AGENTS.md 作为通用标准，确保跨平台兼容
• 为每个 Agent 明确定义职责边界和输出规范
• 在关键决策点设置人工审核环节
• 定期更新和维护 Agent Skills 库
• 实施完善的日志记录和监控告警

❌ 避免做法

• 不要在配置文件中硬编码敏感信息
• 避免测试之间的相互依赖
• 不要跳过质量门禁强制部署
• 避免单个 Agent 承担过多职责
• 不要忽视安全扫描结果