akiunlocks/ruby

Ruby Code Climate测试报告镜像

镜像概述

本镜像基于官方Ruby基础镜像构建，预装了Code Climate test reporter工具，旨在简化Ruby项目的测试覆盖率报告生成流程，帮助开发者快速集成测试报告功能并提交至Code Climate平台。

核心功能与特性

• 基础Ruby环境：提供完整的Ruby运行时环境，支持标准Ruby项目开发与测试。
• 预装Code Climate test reporter：内置Code Climate测试报告生成工具，无需额外安装配置。
• 简化测试报告流程：集成测试报告生成与提交功能，减少手动操作步骤。
• 版本兼容性：支持多种Ruby版本（具体版本可通过镜像标签指定，如ruby:3.2-codeclimate）。

使用场景与适用范围

• Ruby开发项目：适用于各类Ruby应用、Ruby on Rails项目等。
• CI/CD流程集成：可嵌入Jenkins、GitHub Actions、GitLab CI等持续集成/部署流程。
• 测试覆盖率报告：需要生成、分析测试覆盖率数据并提交至Code Climate平台的场景。
• 开发与调试：本地开发环境中快速验证测试报告功能。

使用方法与配置说明

前提条件

• 已安装Docker环境。
• 拥有Code Climate账号及项目的CODECLIMATE_REPO_TOKEN（可在Code Climate项目设置中获取）。

镜像拉取

通过Docker Hub拉取镜像（假设镜像名称为ruby-codeclimate-test-reporter，具体以实际镜像仓库为准）：

bash
docker pull docker.xuanyuan.run/ruby-codeclimate-test-reporter:latest

如需指定Ruby版本，可通过标签选择，例如：

bash
docker pull docker.xuanyuan.run/ruby-codeclimate-test-reporter:3.2  # Ruby 3.2版本

基本运行命令

在项目根目录下运行以下命令，生成并提交测试报告：

bash
docker run --rm \
  -v $(pwd):/app \  # 挂载本地项目目录至容器内/app
  -w /app \         # 设置工作目录为/app
  -e CODECLIMATE_REPO_TOKEN=your_repo_token \  # 替换为实际的Code Climate仓库令牌
  ruby-codeclimate-test-reporter \
  sh -c "bundle install && bundle exec rake test && cc-test-reporter format-coverage -t simplecov coverage/coverage.json && cc-test-reporter upload-coverage"

环境变量配置

CI环境集成示例（GitHub Actions）

在.github/workflows/test.yml中添加以下步骤：

yaml
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run tests with Code Climate report
        uses: docker/run-action@v3
        with:
          image: docker.xuanyuan.run/ruby-codeclimate-test-reporter:3.2
          volumes:
            - ${{ github.workspace }}:/app
          env:
            CODECLIMATE_REPO_TOKEN: ${{ secrets.CODECLIMATE_REPO_TOKEN }}
          command: sh -c "bundle install && bundle exec rake test && cc-test-reporter format-coverage -t simplecov coverage/coverage.json && cc-test-reporter upload-coverage"

Docker Compose配置示例

创建docker-compose.yml：

yaml
version: '3.8'
services:
  test-report:
    image: docker.xuanyuan.run/ruby-codeclimate-test-reporter:latest
    volumes:
      - .:/app
    working_dir: /app
    environment:
      - CODECLIMATE_REPO_TOKEN=your_repo_token  # 替换为实际令牌
    command: >
      sh -c "bundle install &&
             bundle exec rake test &&
             cc-test-reporter format-coverage -t simplecov coverage/coverage.json &&
             cc-test-reporter upload-coverage"

运行命令：

bash
docker-compose run test-report

注意事项

• 确保项目中已配置测试框架（如RSpec、Minitest）及覆盖率工具（如SimpleCov），以生成覆盖率数据文件（通常为coverage/coverage.json）。
• CODECLIMATE_REPO_TOKEN为敏感信息，建议通过环境变量或CI/CD密钥管理工具传递，避免硬编码。
• 不同Ruby版本的镜像需对应项目的Ruby版本要求，避免兼容性问题。