autopas/autopas-build-code-coverage

AutoPas code-coverage Docker镜像

镜像概述和主要用途

该镜像属于AutoPas-Dockerfiles项目，专门用于构建AutoPas库的代码覆盖率版本。通过此镜像，开发者无需在本地配置复杂依赖，即可快速生成代码覆盖率报告，分析测试用例对代码的覆盖情况，助力提升测试质量和代码可靠性。

核心功能和特性

• 完整工具链：集成构建代码覆盖率版本所需的全部工具，包括：
  • python：支持覆盖率报告生成脚本
  • gcc：C++编译器，用于构建AutoPas库
  • cmake：构建系统，配置编译选项
  • ninja：高效构建工具，加速编译过程
  • lcov + gcov：代码覆盖率数据收集与处理工具
  • gcovr：生成多格式代码覆盖率报告（如HTML、XML）
  • ccache：编译缓存工具，显著加快重复构建速度

使用场景和适用范围

• AutoPas库开发者进行代码覆盖率测试
• 集成到CI/CD流程中，自动化分析代码覆盖情况
• 评估测试用例完整性，识别未覆盖的代码区域
• 提升代码质量，确保关键功能得到充分测试验证

使用方法和配置说明

前提条件

• 已安装Docker引擎
• 本地已克隆AutoPas源代码仓库

基本使用步骤

1. 拉取镜像

从Docker Hub获取预构建的code-coverage镜像：

bash
docker pull autopas/buildenv:code-coverage

2. 构建代码覆盖率版本

挂载AutoPas源代码目录到容器，执行构建命令：

bash
docker run -v /path/to/autopas/source:/autopas -w /autopas autopas/buildenv:code-coverage \
  sh -c "cmake -B build -DCMAKE_BUILD_TYPE=Coverage -G Ninja && ninja -C build"

• /path/to/autopas/source：本地AutoPas源代码目录的绝对路径
• -DCMAKE_BUILD_TYPE=Coverage：启用代码覆盖率构建模式
• ninja -C build：使用ninja构建项目

3. 生成覆盖率报告

构建完成后，使用gcovr生成HTML格式报告：

bash
docker run -v /path/to/autopas/source:/autopas -w /autopas/build autopas/buildenv:code-coverage \
  gcovr --html --html-details -o coverage_report.html .

生成的coverage_report.html将保存在本地源代码的build目录，可通过浏览器查看详细覆盖率数据。

高级配置

• 报告格式调整：通过gcovr参数生成不同格式报告，例如XML格式：

  bash
  gcovr --xml -o coverage_report.xml .
  

• 编译缓存优化：ccache默认启用，可通过挂载缓存目录持久化缓存：

  bash
  docker run -v /path/to/ccache:/root/.ccache -v /path/to/autopas/source:/autopas ...
  

注意事项

• 确保本地源代码目录具有读写权限，以便容器正常构建和生成报告
• 首次构建耗时较长，后续构建将通过ccache显著加速
• 可根据项目需求调整cmake参数，添加额外编译选项