Flutter测试报告生成插件testreport的使用

目录

• 简介
• 用途
• 许可证和贡献者
• 示例代码

简介

testreport库可以用于处理Dart测试的结果。该库的目标是从Dart测试运行器输出的json数据中解析出可解释的测试结果，并提供API以供进一步处理。

用途

通过运行以下命令：

pub run test simple_test.dart --reporter json

其中，simple_test.dart的内容如下：

import 'package:test/test.dart';

main() {
  test('simple', () {
    expect(true, true);
  });
}

Dart测试运行器将以JSON格式输出测试结果，作为事件流的一部分。例如：

{"protocolVersion":"0.1.0","runnerVersion":"0.12.13+1","type":"start","time":0}
{"count":1,"type":"allSuites","time":0}
{"suite":{"id":0,"platform":"vm","path":"simple_test.dart"},"type":"suite","time":0}
{"test":{"id":1,"name":"loading simple_test.dart","suiteID":0,"groupIDs":[],"metadata":{"skip":false,"skipReason":null}},"type":"testStart","time":0}
{"testID":1,"result":"success","hidden":true,"type":"testDone","time":237}
{"group":{"id":2,"suiteID":0,"parentID":null,"name":null,"metadata":{"skip":false,"skipReason":null},"testCount":1},"type":"group","time":241}
{"test":{"id":3,"name":"simple","suiteID":0,"groupIDs":[2],"metadata":{"skip":false,"skipReason":null}},"type":"testStart","time":242}
{"testID":3,"result":"success","hidden":false,"type":"testDone","time":268}
{"success":true,"type":"done","time":271}

从这个JSON输出中，很难直观地看出执行了多少个测试、有多少失败以及每个测试花费的时间。Processor将这些JSON事件转换为适合进一步处理的Report对象。

许可证和贡献者

• 本项目采用MIT许可证，详情见LICENSE。
• 贡献者名单见AUTHORS。

示例代码

下面是一个完整的示例代码，展示了如何使用testreport库来读取并处理测试结果文件：

import 'dart:io';
import 'dart:convert';

import 'package:testreport/testreport.dart';

void main(List<String> args) async {
  // 检查参数是否正确
  if (args.isEmpty) {
    print('Usage: dart example.dart &lt;path_to_test_result_file&gt;');
    return;
  }

  final file = File(args[0]);
  if (!file.existsSync()) {
    print('File not found: ${args[0]}');
    return;
  }

  // 读取文件内容并创建报告
  final lines = LineSplitter().bind(utf8.decoder.bind(file.openRead()));
  final report = await createReport(file.lastModifiedSync(), lines);

  // 输出报告中的问题
  for (final suite in report.suites) {
    for (final test in suite.problems) {
      for (final problem in test.problems) {
        print('${suite.path} - ${test.name}: ${problem.message}');
      }
    }
  }
}

Future<Report> createReport(DateTime when, Stream<String> lines) async {
  var processor = Processor(timestamp: when);
  await for (final line in lines) {
    processor.process(json.decode(line) as Map<String, dynamic>);
  }
  return processor.report;
}

使用说明

1. 将上述代码保存为example.dart。
2. 准备一个包含测试结果的JSON文件（例如test_results.json）。
3. 运行命令：

   dart example.dart path/to/test_results.json
   

这将输出所有测试套件中的问题，包括测试名称和问题描述。通过这种方式，您可以更方便地查看和分析测试结果。