Defense Unicorns UDS Core 项目开发指南与技术实践

项目概述

Defense Unicorns UDS Core 是一个专注于安全交付的开源项目，采用现代化的持续交付实践。该项目遵循严格的开发流程和质量标准，确保每个变更都经过充分验证且可立即发布。

开发理念与流程

持续交付实践

项目团队遵循最小化持续交付(Minimum CD)原则，核心要点包括：

1. 主干开发模式：所有开发工作都在主分支(main)上进行，采用短生命周期的特性分支
2. 可发布代码：合并到主分支的代码必须处于可立即发布状态
3. 自动化测试：所有变更在合并前必须通过自动化测试
4. 不可变制品：发布的产物具有不可变性，确保部署的一致性

开发环境准备

在开始开发前，需要配置以下工具链：

• 版本控制工具：Git 用于代码管理
• 本地Kubernetes环境：K3d 提供轻量级Kubernetes集群
• 运行时环境：Node.js（建议使用24版本以保持与CI环境一致）
• 项目CLI工具：UDS命令行工具用于任务执行和部署

代码质量保障

预提交检查

项目采用严格的代码质量门禁，包括：

1. 拼写检查：通过codespell工具确保代码注释和文档的拼写正确
2. YAML格式校验：使用yamllint保持配置文件格式统一

安装检查工具的命令：

uds run lint-check
# 或
pip install yamllint codespell

完成标准(Definition of Done)

每个变更必须满足以下条件才能视为完成：

1. 通过所有CI流水线测试
2. 新增测试覆盖变更内容
3. 经过同行评审
4. 满足验收标准
5. 相关文档同步更新

测试策略

项目采用分层测试策略：

组件级测试

每个组件在src/<component>/tasks.yaml中包含轻量级验证，主要检查：

• Pod健康状态
• 端点可访问性
• 基础功能验证

端到端测试

项目使用Playwright框架进行浏览器自动化测试，特点包括：

• 支持SSO会话共享的认证流程
• 提供测试录制功能加速测试开发
• 专注于UDS Core特有配置的验证

测试策略强调验证核心配置而非完整功能，依赖上游项目的完善测试覆盖。

开发工作流程

1. 环境初始化

git clone <repository-url>
cd uds-core
git checkout -b my-feature-branch

2. 本地测试执行

项目提供多级测试命令：

# 轻量级验证
uds run test-uds-core

# 完整端到端测试(与CI一致)
uds run test:uds-core-e2e

# 针对特定组件的快速测试
uds run test-single-layer --set LAYER=metrics-server

测试支持多种镜像源配置：

--set FLAVOR=<registry1/unicorn>

变更提交规范

1. 问题跟踪：重大变更需先创建问题描述
2. 分支策略：优先使用主仓库分支而非fork
3. 提交签名：所有提交必须经过签名
4. 测试验证：确保变更通过全部测试
5. PR规范：
   • 必须基于main分支
   • 必须通过CI检查
   • 必须有相关issue(微小修复除外)

技术要点解析

安全考量

项目采用严格的CI/CD安全策略：

• 限制fork仓库的敏感信息访问
• 维护人员会协助验证外部贡献的完整测试流程
• 提交签名确保代码来源可信

效率优化

提供多种测试模式平衡验证效率与完整性：

• 组件级快速测试加速开发迭代
• 完整端到端测试确保系统整体质量
• 支持多种镜像源配置测试

通过这套严谨而不失灵活的开发流程，Defense Unicorns UDS Core项目能够在保证高质量交付的同时，保持开发效率和对社区贡献的开放性。