Flutter代码覆盖率统计插件coverage_util的使用

Flutter代码覆盖率统计插件coverage_util的使用

描述

该插件用于收集项目测试覆盖率的准确数据。

在计算覆盖率时，Codecov 只会分析那些被导入或导出到我们正在测试的文件中的文件。因此可能会出现某些功能未被测试但不会影响覆盖率百分比的情况，从而导致获取不准确的数据。

此插件将所有以 .dart 结尾的文件合并为一个文件，并将其添加到测试目录中。

异常情况：

• 包含 main 函数的文件；
• 作为其他文件一部分（如 part of）的文件；
• 导出其他文件的文件；
• 包含 .g. 的生成文件。

注意：默认情况下，由 freezed 生成的文件在计算测试覆盖率时不被考虑。

如果有一些文件由于某些原因不应被纳入计算，可以在文件中加入以下注释：

// coverage:ignore-file

然后运行命令 flutter test --coverage 来生成 lcov 文件，并将其转换为 HTML 格式，您可以自行打开并查看项目的测试覆盖率百分比。

为了成功进行转换，您需要安装 LCOV。如果您使用的是 brew，可以使用以下命令：

brew install lcov

要启动该工具，请先运行以下命令：

flutter pub global activate coverage_util

接下来运行：

flutter pub global run coverage_util

完整示例 Demo

假设我们有一个简单的 Flutter 应用程序，包含两个 Dart 文件：main.dart 和 utils.dart。我们将使用 coverage_util 插件来计算覆盖率。

文件结构

my_flutter_project/
├── lib/
│   ├── main.dart
│   └── utils.dart
├── test/
└── pubspec.yaml

lib/main.dart

import 'package:flutter/material.dart';
import './utils.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Coverage Test')),
        body: Center(child: Text('Hello World')),
      ),
    );
  }
}

// coverage:ignore-start
void someIgnoredFunction() {
  print('This function is ignored');
}
// coverage:ignore-end

lib/utils.dart

void anotherFunction() {
  print('Another function');
}

运行覆盖率测试

1. 确保已安装 LCOV：

brew install lcov

1. 激活 coverage_util：

flutter pub global activate coverage_util

1. 运行测试覆盖率：

flutter test --coverage

1. 将生成的 lcov 文件转换为 HTML：

flutter pub global run coverage_util

1. 打开生成的 HTML 文件以查看覆盖率报告：

open coverage/lcov-report/index.html