(海南大学刘伟) [新增] 单元测试、代码覆盖率及其使用说明 · Pull Request !1 · LaterComer/rtt-gcov

## 单元测试 & 代码覆盖率

### 相关目录结构

```sh
工程主目录
├── applications/
│   ├── src/
│   │   ├── SConscript           # 需要添加覆盖率测试参数
│   │   ├── jswyll_packet.c      # 应用代码
│   │   └── jswyll_packet.h
│   ├── test/
│   │   ├── gcov/                # 代码覆盖率收集
│   │   ├── unity/               # 单元测试库，参见https://github.com/ThrowTheSwitch/Unity
│   │   ├── test_all.c           # 测试总入口
│   │   ├── test_all.h
│   │   ├── test_jswyll_packet.c # 测试jswyll_packet
│   │   ├── test_jswyll_packet.h
│   │   ├── unity_config.h       # 单元测试配置
│   │   └── write_gcda.py        # 脚本，用于将打印的gcda的Hex数据写入对应的文件
│   ├── main.c # 应用主入口
├── build/
│   ├── lcov/
│   │   ├── index.html           # 代码覆盖率输出结果首页
├── rtconfig.py # 需要添加覆盖率测试参数
```

### 首次使用

1. 下载Git；下载[lcov](https://github.com/linux-test-project/lcov/releases "Releases · linux-test-project/lcov") 版本v1.15及以上，下载、解压后将lcov文件夹下的bin/文件夹添加到PATH环境变量（重启电脑）
2. 新建文件夹，用于编写应用代码（被测试代码，例如：`applications/src`）
3. 从[applications/SConscript](applications/SConscript "applications/SConscript")将编译脚本到第1步的路径下，并将第8行修改为：

```python
    group = DefineGroup('文件夹名', src, depend = [''], CPPPATH = CPPPATH, LOCAL_CFLAGS=' --coverage')
    ```

> 其中`--coverage`等价于`-fprofile-arcs -ftest-coverage`这表示将这个文件夹的源码添加覆盖率测试（插桩）。
4. 修改[rtconfig.py](rtconfig.py "rtconfig.py")的LFLAGS，`LFLAGS = DEVICE + ' -nostartfiles -Wl,--gc-sections,-Map=rtthread.map,-cref,-u,system_vectors --coverage' + ' -T %s' % LINK_SCRIPT`，使链接时将相关的代码也使用覆盖率测试。

5. 在除了第1步被测试以外的文件夹下编写测试代码，调用被测试代码。

```c
    __gcov_call_constructors();

test_xxx();

__gcov_exit();
    ```

6. 编译并运行代码，将生成的gcda文件的内容放在输出的提示路径上

7. 在工程主目录右键，选择`Git Bash Here`，输入

```sh
    lcov -c -d . --rc lcov_branch_coverage=1 -o build/test.coverage --gcov-tool 编译器路径/bin/arm-none-eabi-gcov && genhtml --branch-coverage build/test.coverage -o build/lcov
    ```

> **注意：**编译器的路径应和编译代码时的版本一致。将`编译器路径/bin/`添加到系统环境变量（然后重启电脑），则上述命令可以省去`编译器路径/bin/`

8. 用浏览器打开`build/lcov/index.html`，查看被测试代码的覆盖结果

### 后续使用

修改被测试代码或测试代码后，重复上述步骤6\~8。

类型	指派人员	状态
审查	LaterComer 已审查通过	已完成 (1/1人)
测试	LaterComer 已测试通过	已完成 (1/1人)

LaterComer/rtt-gcov .gitee-modal { width: 500px !important; }

搜索帮助

LaterComer/rtt-gcov