Flutter代码质量报告插件dart_dot_reporter的使用

简介

dart_dot_reporter 是一个用于生成简洁且可读性高的测试报告的插件，适用于 Dart 和 Flutter 项目。该工具受到 webdriver.io 的 dot-reporter 启发。

以下是 dart_dot_reporter 的一些特性：

• 提供简洁的测试报告。
• 支持多种标志选项以定制输出。
• 适合在 CI 环境中查看结果。

示例输出

安装

要使用 dart_dot_reporter，可以通过以下命令安装：

使用 pub 全局激活

pub global activate dart_dot_reporter

或者使用 flutter 命令：

flutter pub global activate dart_dot_reporter

安装完成后，确保将 $HOME/.pub-cache/bin 添加到系统路径中。

更新插件

更新插件时，只需再次运行相同的激活命令：

pub global activate dart_dot_reporter

使用方法

Dart 项目

在 Dart 项目中使用 dart_dot_reporter，首先需要生成机器可读的日志文件（JSON 格式），然后将其传递给插件进行解析。

pub run test --reporter=json > machine.log || echo 'Tests failed'
dart_dot_reporter machine.log

Flutter 项目

在 Flutter 项目中使用类似的方法：

flutter test --machine > machine.log || echo 'Tests failed'
flutter pub global run dart_dot_reporter machine.log

参数说明

dart_dot_reporter 支持以下参数：

dart_dot_reporter <machine.log> [flags]

必须参数

• <machine.log>: 测试日志文件路径。

可选标志

示例代码

示例 1: 基本用法

输入日志 (before)

00:01 +1 -1: test/dart_dot_reporter_test.dart: parser can parse file with lines containing json [E]
  Expected: TestModel:<TestModel { 29 State.Failure API update Expected: {
                        'id': 103                      }
              Actual: {
                        'ids': 102,
                      }
               Which: is missing map key 'id'
             }>
    Actual: TestModel:<TestModel { 29 State.Failure API update  Expected: {
                        'id': 103
                      }
              Actual: {
                        'ids': 102,
                      }
               Which: is missing map key 'id'
             }>

  package:test_api                       expect
  test/dart_dot_reporter_test.dart 37:7  main.<fn>.<fn>

00:01 +1 -2: test/dart_dot_reporter_test.dart: dot_reporter Ignore "loading" tests [E]
  Expected: <2>
    Actual: <5>
  Unexpected number of calls

  package:test_api                         expect
  package:mockito/src/mock.dart 866:5      VerificationResult.called
  test/dart_dot_reporter_test.dart 106:29  main.<fn>.<fn>

输出报告 (after)

.XX

X parser can parse file with lines containing json
X dot_reporter Ignore "loading" tests

Total: 3
Success: 1
Skipped: 0
Failure: 2

带颜色的输出

示例 2: 使用标志

命令行

dart_dot_reporter machine.log --show-message --show-success --show-id

输出报告

.!XX

27 . API getAll
28 ! API delete
29 X API update
  Expected: {
            'id': 103
          }
  Actual: {
            'ids': 102,
          }
  Which: is missing map key 'id'

31 X API too big print text

Total: 4
Success: 1
Skipped: 1
Failure: 2

已知问题

• 如果测试名称以 loading / 开头，该测试会被跳过。

TODO 列表

• 计算测试执行时间，并显示耗时最长的测试。
• 支持管道模式，例如：pub run test --reporter=json | dart_dot_reporter。

开发

要运行插件的开发版本，请使用以下命令：

dart bin/dart_dot_reporter.dart