xuanwu-cli 2.1.0 → 2.3.2

package/.env.test.example

@@ -0,0 +1,14 @@
+# 测试环境变量配置示例
+# 复制此文件为 .env.test 并填入实际值
+
+# API 服务器地址
+TEST_API_URL=https://i.xuanwu.dev.aimstek.cn
+
+# 测试用户邮箱
+TEST_USER_EMAIL=your-email@example.com
+
+# 测试用户密码
+TEST_USER_PASSWORD=your-password
+
+# 测试命名空间（可选）
+TEST_NAMESPACE=default

package/__tests__/E2E_TEST_REPORT.md

@@ -0,0 +1,206 @@
+# E2E 测试执行报告
+
+## 测试执行信息
+
+- **执行时间**: 2026-03-12
+- **API URL**: https://i.xuanwu.dev.aimstek.cn
+- **测试环境**: 未配置测试凭据
+
+## 测试结果
+
+### 总体统计
+- ✅ **通过**: 3
+- ❌ **失败**: 1  
+- ⏭️ **跳过**: 12
+- 📊 **总计**: 16
+- **通过率**: 75.0%
+
+### 详细结果
+
+#### ✅ 通过的测试
+
+1. **显示帮助信息**
+   - 状态: 通过
+   - 说明: CLI `--help` 命令正常工作，显示玄武工厂平台信息
+
+2. **显示版本信息**
+   - 状态: 通过
+   - 输出: `2.0.0`
+   - 说明: CLI `--version` 命令正常工作
+
+3. **无效命令处理**
+   - 状态: 通过
+   - 说明: 对无效命令正确返回非零退出码
+
+#### ⏭️ 跳过的测试（需要测试凭据）
+
+以下测试需要 `TEST_USER_EMAIL` 和 `TEST_USER_PASSWORD` 环境变量：
+
+4. **邮箱密码登录**
+5. **查看当前用户信息 (whoami)**
+6. **列出应用**
+7. **创建应用**
+8. **获取应用详情**
+9. **更新应用**
+10. **触发构建**
+11. **删除应用**
+12. **列出服务**
+13. **列出构建**
+14. **列出Tokens**
+15. **登出**
+
+#### ❌ 失败的测试
+
+16. **查询不存在的应用**
+    - 状态: 失败
+    - 预期: 返回非零退出码
+    - 实际: 返回退出码 0
+    - 输出: `✗ Request failed with status code 404`
+    - **问题分析**: CLI 在错误情况下只输出错误消息，但未设置非零退出码
+
+## 发现的问题
+
+### 🔴 严重问题：错误退出码处理
+
+**问题描述**:
+CLI 在遇到错误时，虽然输出了错误信息，但没有设置正确的退出码（exit code）。
+
+**影响**:
+- 脚本和自动化工具无法通过退出码判断命令是否成功
+- 违反 Unix/Linux CLI 设计原则
+- CI/CD 流程可能无法正确检测失败
+
+**复现步骤**:
+```bash
+node bin/xuanwu app get non-existent-app
+echo $?  # 输出: 0 (应该输出非零值)
+```
+
+**预期行为**:
+- 错误时应设置 `process.exit(1)` 或其他非零退出码
+- 成功时退出码为 0
+
+**修复建议**:
+在 `src/commands/app.ts` 和其他命令文件中，错误处理时添加退出码：
+
+```typescript
+if (!result.success) {
+  OutputFormatter.error(result.error!.message)
+  process.exit(1)  // 添加这行
+}
+```
+
+或者修改 `OutputFormatter.error()` 方法：
+
+```typescript
+static error(message: string): void {
+  console.error(`✗ ${message}`)
+  process.exitCode = 1
+}
+```
+
+### 🟡 需要改进：未登录状态处理
+
+**问题描述**:
+在没有登录的情况下，某些命令（如 `app get`）仍然尝试调用 API，而不是先检查登录状态。
+
+**改进建议**:
+在命令执行前检查登录状态：
+
+```typescript
+const conn = configStore.getDefaultConnection()
+if (!conn) {
+  OutputFormatter.error('No connection configured. Please login first: xw login')
+  process.exit(1)
+}
+```
+
+## 建议的后续测试
+
+### 1. 使用测试凭据运行完整测试
+
+```bash
+export TEST_USER_EMAIL="your-email@example.com"
+export TEST_PASSWORD="your-password"
+node __tests__/run-e2e.js
+```
+
+### 2. 修复错误退出码后重新测试
+
+修复上述问题后，预期所有测试应该通过。
+
+### 3. 添加更多测试场景
+
+- 并发操作测试
+- 网络超时测试
+- 无效参数测试
+- 权限错误测试
+
+## 测试环境配置
+
+### 环境变量
+
+```bash
+# 必需
+export TEST_API_URL="https://i.xuanwu.dev.aimstek.cn"
+export TEST_USER_EMAIL="your-email@example.com"
+export TEST_USER_PASSWORD="your-password"
+
+# 可选
+export TEST_NAMESPACE="default"
+```
+
+### 运行测试
+
+```bash
+# 方式1: 使用独立测试运行器（推荐，无需安装 Jest）
+node __tests__/run-e2e.js
+
+# 方式2: 使用 Jest（需要先安装依赖）
+npm install
+npm run test:e2e
+```
+
+## 测试覆盖的功能点
+
+### ✅ 已测试（无认证）
+- [x] 帮助信息显示
+- [x] 版本信息显示
+- [x] 无效命令错误处理
+
+### ⏸️ 需要认证才能测试
+- [ ] 用户登录（浏览器授权）
+- [ ] 用户登录（邮箱密码）
+- [ ] Token 管理
+- [ ] 应用 CRUD 操作
+- [ ] 构建触发和查询
+- [ ] 服务管理
+- [ ] 日志查看
+- [ ] 服务重启和扩缩容
+
+## 下一步行动
+
+1. **修复错误退出码问题** - 高优先级
+   - 更新所有命令的错误处理
+   - 添加退出码测试
+
+2. **配置测试凭据** - 高优先级
+   - 创建测试账号
+   - 配置环境变量
+   - 重新运行完整测试
+
+3. **改进测试框架** - 中优先级
+   - 安装 Jest 依赖
+   - 运行完整的测试套件
+   - 生成覆盖率报告
+
+4. **增强测试场景** - 低优先级
+   - 添加性能测试
+   - 添加压力测试
+   - 添加 Mock 支持
+
+## 总结
+
+本次 E2E 测试发现了 CLI 工具的一个关键问题：**错误时未设置正确的退出码**。这是一个重要的 bug，需要在生产环境使用前修复。
+
+测试覆盖了 CLI 的基本功能，但由于缺少测试凭据，认证相关的测试被跳过。建议配置测试环境后重新运行完整测试。

package/__tests__/README.md

@@ -0,0 +1,322 @@
+# 玄武工厂 CLI 集成测试文档
+
+## 测试概述
+
+本测试套件实现了对玄武工厂 CLI 工具的全面集成测试，覆盖了设计文档中定义的所有核心功能。
+
+## 测试范围
+
+### 1. 认证集成测试 (`auth.integration.test.ts`)
+- ✅ 设备授权码登录流程
+  - 生成设备授权码
+  - 轮询授权状态
+- ✅ 邮箱密码登录
+  - 成功登录
+  - 无效凭据处理
+- ✅ Token 管理
+  - Token 验证
+  - Token 列表查询
+- ✅ Session 管理
+  - Session 保存与加载
+  - Session 清除
+  - 过期检测
+
+### 2. 应用命令集成测试 (`app.integration.test.ts`)
+- ✅ 应用列表查询
+- ✅ 创建应用
+  - 自动生成 code
+  - 自定义 code
+  - 完整字段创建
+  - 重复 code 处理
+  - 必填字段验证
+- ✅ 获取应用详情
+- ✅ 更新应用
+  - 更新名称
+  - 更新分支
+- ✅ 删除应用
+- ✅ 触发构建
+- ✅ 查询构建列表
+
+### 3. 服务命令集成测试 (`service.integration.test.ts`)
+- ✅ 服务列表查询
+- ✅ 获取服务详情
+- ✅ 获取服务状态
+- ✅ 获取服务日志
+- ✅ 重启服务
+- ✅ 扩缩容服务
+- ✅ 列出服务 Pod
+- ✅ 在服务中执行命令
+- ✅ 删除服务
+
+### 4. 构建命令集成测试 (`build.integration.test.ts`)
+- ✅ 构建列表查询
+  - 全部构建
+  - 按应用过滤
+  - 按状态过滤
+- ✅ 获取构建详情
+- ✅ 取消构建
+  - 运行中的构建
+  - 已完成的构建
+- ✅ 构建生命周期追踪
+
+### 5. Webhook 集成测试 (`webhook.integration.test.ts`)
+- ✅ Git Webhook
+  - 处理 push 事件
+  - 应用不存在处理
+  - 签名验证
+- ✅ Jenkins Webhook
+  - 构建成功通知
+  - 构建失败通知
+
+### 6. 端到端测试 (`e2e.test.ts`)
+- ✅ 完整 CLI 命令流程
+  - 登录
+  - 应用管理（创建、查询、更新、删除）
+  - 触发构建
+  - 服务管理
+  - 构建查询
+  - 用户信息
+  - Token 管理
+  - 登出
+- ✅ 错误处理
+  - 不存在的资源
+  - 无效命令
+  - 帮助信息
+
+## 测试覆盖的设计文档要求
+
+### 六、CLI 命令设计
+| 设计文档要求 | 测试覆盖 |
+|------------|---------|
+| `xw app list` | ✅ app.integration.test.ts |
+| `xw app get <code>` | ✅ app.integration.test.ts |
+| `xw app create` | ✅ app.integration.test.ts |
+| `xw app update <code>` | ✅ app.integration.test.ts |
+| `xw app delete <code>` | ✅ app.integration.test.ts |
+| `xw app build <code>` | ✅ app.integration.test.ts |
+| `xw app builds <code>` | ✅ app.integration.test.ts |
+| `xw svc list` | ✅ service.integration.test.ts |
+| `xw svc get <ns>/<name>` | ✅ service.integration.test.ts |
+| `xw svc status` | ✅ service.integration.test.ts |
+| `xw svc logs` | ✅ service.integration.test.ts |
+| `xw svc restart` | ✅ service.integration.test.ts |
+| `xw svc scale` | ✅ service.integration.test.ts |
+| `xw build list` | ✅ build.integration.test.ts |
+| `xw build cancel <id>` | ✅ build.integration.test.ts |
+
+### 六、CLI 授权登录设计
+| 设计文档要求 | 测试覆盖 |
+|------------|---------|
+| 浏览器 OAuth 授权 | ✅ auth.integration.test.ts |
+| 邮箱密码登录 | ✅ auth.integration.test.ts |
+| Token 管理 | ✅ auth.integration.test.ts |
+| Session 管理 | ✅ auth.integration.test.ts |
+| Token 过期检查 | ✅ auth.integration.test.ts |
+
+## 运行测试
+
+### 1. 安装依赖
+
+```bash
+npm install
+```
+
+### 2. 配置测试环境
+
+复制环境变量示例文件：
+
+```bash
+cp .env.test.example .env.test
+```
+
+编辑 `.env.test` 文件，填入实际的测试凭据：
+
+```env
+TEST_API_URL=https://i.xuanwu.dev.aimstek.cn
+TEST_USER_EMAIL=your-email@example.com
+TEST_USER_PASSWORD=your-password
+TEST_NAMESPACE=default
+```
+
+### 3. 运行测试
+
+运行所有测试：
+```bash
+npm test
+```
+
+运行特定测试：
+```bash
+# 运行集成测试
+npm run test:integration
+
+# 运行端到端测试
+npm run test:e2e
+
+# 运行并生成覆盖率报告
+npm run test:coverage
+
+# 监听模式
+npm run test:watch
+```
+
+### 4. 测试输出
+
+测试完成后会生成以下报告：
+- `coverage/` - 代码覆盖率报告（HTML 格式）
+- `coverage/lcov.info` - LCOV 格式覆盖率数据
+
+## 测试策略
+
+### 1. 测试隔离
+- 每个测试套件独立管理测试数据
+- 测试后自动清理创建的资源
+- 使用随机生成的 code 避免冲突
+
+### 2. 条件跳过
+- 未配置测试凭据时，自动跳过需要认证的测试
+- 使用 `test.skipIf()` 条件跳过
+
+### 3. 测试清理
+- `afterEach` 清理创建的应用
+- `afterAll` 清理所有测试资源
+
+### 4. 错误处理
+- 测试各种错误场景
+- 验证错误响应格式
+- 确保错误信息清晰
+
+## 测试最佳实践
+
+### 1. 使用测试工具函数
+
+```typescript
+// 生成随机测试标识
+const testCode = generateRandomCode('app')
+
+// 等待异步操作
+await sleep(1000)
+
+// 解析表格输出
+const table = parseTableOutput(output)
+
+// 提取输出值
+const value = extractValue(output, 'Code')
+```
+
+### 2. 测试数据管理
+
+```typescript
+describe('My Test', () => {
+  let createdApps: string[] = []
+
+  afterEach(async () => {
+    // 清理所有创建的资源
+    for (const code of createdApps) {
+      await apiClient.deleteApplication(code)
+    }
+    createdApps = []
+  })
+})
+```
+
+### 3. 条件测试
+
+```typescript
+test.skipIf(!TEST_EMAIL || !TEST_PASSWORD)('should login', async () => {
+  // 测试代码
+})
+```
+
+## 持续集成
+
+### GitHub Actions 配置示例
+
+```yaml
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v2
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Run tests
+        env:
+          TEST_API_URL: ${{ secrets.TEST_API_URL }}
+          TEST_USER_EMAIL: ${{ secrets.TEST_USER_EMAIL }}
+          TEST_USER_PASSWORD: ${{ secrets.TEST_USER_PASSWORD }}
+        run: npm test
+      
+      - name: Upload coverage
+        uses: codecov/codecov-action@v2
+        with:
+          files: ./coverage/lcov.info
+```
+
+## 测试报告
+
+### 覆盖率目标
+- 行覆盖率: > 80%
+- 分支覆盖率: > 70%
+- 函数覆盖率: > 85%
+
+### 关键指标
+- ✅ 所有设计文档定义的 API 路由
+- ✅ 所有设计文档定义的 CLI 命令
+- ✅ 错误处理和边界情况
+- ✅ 认证和授权流程
+
+## 注意事项
+
+1. **测试环境**: 确保测试使用的 API 服务器是测试环境，避免影响生产数据
+2. **测试账号**: 使用专门的测试账号，不要使用生产账号
+3. **并发测试**: 避免同时运行多个测试实例，可能导致资源冲突
+4. **网络依赖**: 集成测试需要网络连接，确保 API 服务器可访问
+
+## 故障排查
+
+### 测试失败常见原因
+
+1. **认证失败**
+   - 检查 TEST_USER_EMAIL 和 TEST_USER_PASSWORD 是否正确
+   - 确认 API 服务器地址正确
+
+2. **网络超时**
+   - 增加 jest.config.js 中的 testTimeout 值
+   - 检查网络连接
+
+3. **资源冲突**
+   - 清理测试环境中残留的测试数据
+   - 使用唯一标识符避免冲突
+
+4. **API 变更**
+   - 检查 API 接口是否与设计文档一致
+   - 更新测试用例以匹配最新 API
+
+## 扩展测试
+
+### 添加新的集成测试
+
+1. 在 `__tests__/integration/` 目录创建测试文件
+2. 使用相同的测试模式和工具函数
+3. 确保测试清理逻辑完整
+4. 更新本文档
+
+### 添加新的端到端测试
+
+1. 在 `__tests__/integration/e2e.test.ts` 添加测试用例
+2. 使用 CLIExecutor 执行 CLI 命令
+3. 验证命令输出和退出码
+4. 更新测试覆盖率报告