Rebar3中CT测试与编译钩子的工作目录差异问题分析

问题背景

在使用Rebar3构建Erlang项目时，特别是包含NIF(C语言扩展)的umbrella项目，开发者经常会遇到一个棘手的问题：ct(Common Test)钩子和compile钩子在执行时的工作目录($PWD)不一致，导致构建和测试流程出现异常。

现象描述

在一个典型的umbrella项目结构中：

项目根目录
   - apps
   - -- 应用A
   - -- 应用B

当在项目根目录执行rebar3 ct命令时，会出现以下现象：

1. compile钩子会在应用目录下执行(如apps/应用A)
2. ct钩子却会在项目根目录下执行

这种差异会导致基于路径的构建命令(如CMake)无法正确找到源文件，特别是当需要为NIF编写单元测试时，这个问题尤为突出。

技术原理分析

Rebar3钩子执行机制

Rebar3的钩子执行遵循特定的规则：

1. 应用级钩子：定义在应用目录的rebar.config中，执行时会切换到该应用目录
2. 项目级钩子：定义在项目根目录的rebar.config中，执行时保持在项目根目录

CT测试的特殊性

Common Test(CT)在Rebar3中有特殊处理：

1. CT测试被视为全局性操作，而非应用级操作
2. 所有测试用例会被收集到同一个目录(_build/test/extras/tests)
3. 日志文件也统一存放在全局目录(_build/test/logs)

这种设计导致ct钩子始终在项目根目录执行，与应用级的compile钩子行为不一致。

解决方案

方案一：使用项目级配置

将所有构建配置移到项目根目录的rebar.config中：

{pre_hooks, [
    {ct, "cmake命令"},
    {compile, "cmake命令"}
]}.

优点：

• 保证所有钩子在同一目录下执行
• 配置集中管理

缺点：

• 失去了应用级别的隔离性
• 不适合需要应用独立配置的场景

方案二：使用环境变量控制

通过Rebar3的profile机制控制构建行为：

1. 在rebar.config中定义profile：

{profiles, [
    {unit, [
        {shell_hook_env, [
            {"BUILD_UNIT_TESTS", "1"}
        ]}
    ]}
]}.

2. 在应用配置中根据环境变量调整构建：

{pre_hooks, [
    {compile, "cmake -DMYLIB_UNIT_TESTS=${BUILD_UNIT_TESTS}"},
    {ct, "/bin/sh -c '[ -z ${BUILD_UNIT_TESTS+x} ] || ctest命令'"}
]}.

优点：

• 保持应用级别配置
• 灵活控制测试行为
• 可通过rebar3 as unit ct触发特定构建

方案三：自定义测试命令

对于NIF单元测试，可以考虑：

1. 将C测试作为独立的构建目标
2. 通过自定义Rebar3命令来运行
3. 与Erlang的CT测试分开管理

最佳实践建议

1. 简单项目：采用项目级配置，统一工作目录

2. 复杂umbrella项目：

   • 使用环境变量控制不同构建场景
   • 考虑将C测试与Erlang测试分离
   • 为NIF测试编写专门的Makefile或CMake脚本

3. 长期维护：

   • 文档化构建流程
   • 在CI中明确区分不同测试阶段
   • 考虑使用容器化构建环境消除路径依赖

总结

Rebar3中ct与compile钩子的工作目录差异源于其设计理念：CT被视为全局操作，而编译是应用级操作。理解这一设计原理后，开发者可以通过调整配置策略或引入环境变量控制来解决路径问题。对于包含NIF的复杂项目，建议采用方案二的profile机制，既能保持灵活性，又能确保构建可靠性。