elastio/rust_ci

Rust CI工具镜像

镜像概述

本镜像专为Rust项目持续集成(CI)场景设计，预安装全套Rust开发与CI工具链，旨在减少CI配置复杂度，确保构建环境一致性，加速自动化流程部署。通过集成核心工具，避免重复安装步骤，适用于各类CI/CD平台及本地开发环境标准化。

核心功能与特性

• 完整Rust工具链：包含rustup、cargo、rustc，支持多版本Rust切换（stable/beta/nightly）
• 代码质量工具：
  • rustfmt（代码格式化）
  • clippy（静态代码分析）
  • cargo-check（快速编译检查）
• 测试与覆盖率：
  • cargo-test（内置测试框架）
  • tarpaulin（测试覆盖率报告生成）
• 安全与依赖管理：
  • cargo-audit（依赖安全漏洞扫描）
  • cargo-deny（依赖许可合规性检查）
  • cargo-outdated（过时依赖检测）
• 构建优化工具：
  • cargo-build-deps（预构建依赖缓存）
  • sccache（跨构建缓存编译结果）

使用场景

1. CI/CD流水线集成：直接用于GitHub Actions、GitLab CI、Jenkins等平台，实现自动化测试、构建与质量检查
2. 开发环境标准化：确保团队成员使用一致的工具版本，消除"本地可运行，CI失败"问题
3. 自动化质量门禁：在代码合并前自动执行clippy检查、格式化验证、安全审计
4. 快速原型验证：本地临时测试不同Rust版本兼容性或工具链特性

使用方法

基本使用示例

运行测试命令

bash
docker run --rm -v $(pwd):/app -w /app docker.xuanyuan.run/rust-ci-tools cargo test

执行代码质量检查

bash
# 运行clippy静态分析（显示警告视为错误）
docker run --rm -v $(pwd):/app -w /app docker.xuanyuan.run/rust-ci-tools cargo clippy -- -D warnings

# 检查代码格式化
docker run --rm -v $(pwd):/app -w /app docker.xuanyuan.run/rust-ci-tools cargo fmt -- --check

生成测试覆盖率报告

bash
docker run --rm --cap-add=SYS_PTRACE -v $(pwd):/app -w /app docker.xuanyuan.run/rust-ci-tools cargo tarpaulin --out Xml --output-dir ./coverage

CI/CD平台集成示例

GitHub Actions配置

yaml
name: Rust CI
on: [push, pull_request]

jobs:
  quality-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run clippy and fmt check
        uses: docker://rust-ci-tools
        with:
          args: sh -c "cargo fmt -- --check && cargo clippy -- -D warnings"

  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run tests with coverage
        uses: docker://rust-ci-tools
        with:
          args: cargo tarpaulin --out Lcov --output-dir ./coverage
        env:
          RUST_VERSION: stable

高级配置说明

环境变量

持久化缓存配置

为加速重复构建，可挂载工具缓存目录：

bash
docker run --rm \
  -v $(pwd):/app \
  -v cargo-cache:/root/.cargo \
  -v sccache-cache:/root/.cache/sccache \
  -w /app \
  docker.xuanyuan.run/rust-ci-tools \
  cargo build --release

权限注意事项

• 本地使用时，建议通过-u $(id -u):$(id -g)指定当前用户ID，避免生成文件权限问题：

  bash
  docker run --rm -u $(id -u):$(id -g) -v $(pwd):/app -w /app docker.xuanyuan.run/rust-ci-tools cargo test
  

• 覆盖率工具tarpaulin需要SYS_PTRACE权限，CI环境中需配置对应capabilities

版本管理建议

• 生产环境CI配置中建议指定具体镜像标签（如:1.75.0），避免工具版本变更导致流程中断
• 通过RUST_VERSION环境变量控制Rust编译器版本，无需更换基础镜像
• 定期更新镜像标签以获取安全补丁和工具功能更新

典型命令参考