soramitsu/kagome-dev

Kagome构建与测试工具镜像

镜像概述

该Docker镜像专为kagome项目设计，集成了构建和测试所需的完整工具链，旨在提供一致、便捷的开发环境，消除因本地环境差异导致的构建或测试问题。

核心功能与特性

• 完整编译工具：包含clang-8编译器，支持C++代码编译
• 静态代码分析：集成clang-tidy工具，用于代码风格检查和潜在问题检测
• 代码覆盖率分析：提供llvm-cov工具，支持生成详细的代码覆盖率报告
• 内存安全检测：内置sanitizers工具集（如AddressSanitizer、UndefinedBehaviorSanitizer等），用于检测内存泄漏和未定义行为
• 环境一致性：预配置所有依赖组件，确保跨平台构建和测试结果一致

使用场景与适用范围

• Kagome项目开发者进行本地代码构建与测试
• CI/CD流程中集成，实现自动化构建和质量检测
• 新团队成员快速搭建标准化开发环境
• 代码覆盖率分析和内存安全测试场景

使用方法与配置说明

基本使用

拉取并运行镜像（需先安装Docker）：

bash
docker run -it --rm -v /本地/kagome源代码路径:/kagome kagome-build-test-image

参数说明：

• -it：交互式终端模式
• --rm：容器退出后自动清理
• -v：将本地kagome源代码目录挂载到容器内/kagome路径

项目构建流程

在容器内执行以下命令构建项目：

bash
cd /kagome
mkdir build && cd build
cmake .. -DCMAKE_CXX_COMPILER=clang++-8
make -j$(nproc)

静态代码分析

使用clang-tidy进行代码检查：

bash
clang-tidy -p build src/**/*.cpp -- -Iinclude

代码覆盖率测试

生成并查看覆盖率报告：

bash
# 启用覆盖率编译
cmake .. -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=ON
make -j$(nproc)

# 运行测试生成覆盖率数据
ctest

# 生成覆盖率报告
llvm-cov show -instr-profile=coverage.profdata ./bin/kagome_tests

内存安全检测

使用sanitizers检测内存问题：

bash
# 启用AddressSanitizer
cmake .. -DCMAKE_CXX_COMPILER=clang++-8 -DCMAKE_CXX_FLAGS="-fsanitize=address -fno-omit-frame-pointer"
make -j$(nproc)

# 运行测试检测内存问题
./bin/kagome_tests