Flutter代码覆盖率测试插件test_coverage的使用

介绍

test_coverage 是一个简单的命令行工具，用于从 Dart VM 测试中收集测试覆盖率信息。它在本地开发期间生成覆盖率报告时非常有用。

使用方法

1. 添加依赖

在项目的 pubspec.yaml 文件中添加 test_coverage 作为开发依赖：

dev_dependencies:
  test_coverage: ^0.4.2

然后运行以下命令安装依赖：

pub get

2. 运行测试覆盖率工具

在项目的根目录下运行以下命令来执行测试覆盖率工具：

pub run test_coverage

执行完成后，结果将保存在 coverage/lcov.info 文件中。

3. 生成 HTML 报告

如果你的系统上已经安装了 lcov 工具（对于 macOS，可以通过 brew install lcov 安装），你可以使用以下命令生成 HTML 报告：

genhtml -o coverage coverage/lcov.info
# 在 macOS 上打开生成的 HTML 文件：
open coverage/index.html

集成

生成的 coverage/lcov.info 文件可以直接被 Codecov 命令行工具使用，无需额外步骤。

此库尚未与 Coveralls 进行过测试。

生成徽章图像

覆盖率徽章的 SVG 图像会自动生成并保存到项目的根目录下的 coverage_badge.svg 文件中。你可以在 GitHub 的 README.md 中添加它，如下所示：

如果你不需要徽章，可以在运行测试覆盖率工具时使用 `--no-badge` 标志。

## 已知限制

- 此库专为运行 Dart VM 测试而设计。它未经过测试，也不太可能适用于编译为 JavaScript 的 Dart 代码。对于 Flutter，无需使用此工具，因为它支持通过 `flutter test --coverage` 收集覆盖率信息。

## 工作原理

该工具执行以下步骤：

### 1. 生成 `test/.test_coverage.dart` 文件（测试所有脚本）

扫描你的 `test/` 目录以查找所有 `*_test.dart` 文件，并创建 `test/.test_coverage.dart` 文件，该文件导入所有找到的测试文件并在同一文件（和进程）中运行相应的 `main()` 函数，从而简化覆盖率信息的收集。

建议将此文件添加到 `.gitignore` 中。

以下是 `test/.test_coverage.dart` 的示例：

```dart
// 自动由 test_coverage 生成，请勿手动编辑。
// 考虑将其添加到 .gitignore。

import 'some_test.dart' as some_test;
import 'nested/other_test.dart' as other_test;
import 'some_other_test.dart' as some_other_test;

void main() {
  some_test.main();
  other_test.main();
  some_other_test.main();
}

2. 执行测试

使用的命令如下：

dart --pause-isolates-on-exit --enable_asserts --enable-vm-service \
  test/.test_coverage.dart