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

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

test_reporter 是一个CLI工具，用于包装 dart 和 flutter 测试命令以生成测试报告。以下是详细的使用说明和示例代码。

包装测试命令

通过在您的测试命令前加上 dart run test_reporter -- 来包装 dart test 或 flutter test 进程。例如：

dart run test_reporter -- dart test

对于Flutter测试：

dart run test_report器 -- flutter test

您还可以像平常一样传递参数给 dart 或 flutter 测试：

dart run test_reporter -- flutter test --tags golden --coverage

更多详情，请参阅 GitHub仓库 的README文件。

与Allure Report Adapter一起使用

步骤1：添加依赖

在您的 pubspec.yaml 文件中添加 allure_report 和 test_reporter 作为开发依赖项：

dev_dependencies:
  # reporter
  allure_report: ^1.0.0
  test_reporter: ^1.0.0

步骤2：创建 reporter.dart 文件

在项目的 test 目录下创建一个名为 reporter.dart 的文件。如果没有创建该文件，将会使用基本控制台报告器。

import 'package:allure_report/allure_report.dart';
import 'package:test_reporter/test_reporter.dart';

TestReporter create() {
  return AllureReporter();
}

步骤3：运行测试命令

使用以下命令运行测试并生成报告：

dart run test_reporter -- dart test

或者对于Flutter测试：

dart run test_reporter -- flutter test

输出

Allure结果将被放置在项目根目录下的 allure-results 文件夹中。要查看报告，请按照 Allure文档 中的指南启动本地Web服务器。

注意事项

请注意，完整的Allure格式目前不完全支持。并非所有功能都可用，完整规格的支持需要进一步开发。

下面是一个具体的示例，展示如何在Flutter项目中集成和使用 test_reporter 插件来生成测试报告。

示例演示

添加依赖

首先，在您的 pubspec.yaml 文件中添加必要的依赖：

dev_dependencies:
  allure_report: ^1.0.0
  test_reporter: ^1.0.0

创建 reporter.dart

接下来，在您的项目 test 目录下创建一个 reporter.dart 文件：

import 'package:allure_report/allure_report.dart';
import 'package:test_reporter/test_reporter.dart';

TestReporter create() {
  return AllureReporter();
}

运行测试

最后，运行测试并生成报告：

dart run test_reporter -- flutter test

更多关于Flutter测试报告生成插件test_reporter的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter测试报告生成插件test_reporter的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是一个关于如何在Flutter项目中使用test_reporter插件来生成测试报告的详细代码示例。这个示例将涵盖基本的设置、编写测试代码以及生成测试报告的过程。

1. 安装test_reporter插件

首先，你需要在你的Flutter项目中添加test_reporter依赖。打开你的pubspec.yaml文件，并在dev_dependencies部分添加以下依赖：

dev_dependencies:
  flutter_test:
    sdk: flutter
  test_reporter: ^1.0.0  # 请检查最新版本号

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

flutter pub get

2. 配置test_reporter

在你的Flutter项目根目录下创建一个名为test_reporter_config.json的配置文件，内容如下：

{
  "outputDirectory": "./test_reports",
  "reportFormats": ["html", "json"],
  "mergeReports": true,
  "showSummary": true
}

3. 编写测试代码

在你的test目录下创建一个新的测试文件，例如example_test.dart，并编写一些简单的测试：

import 'package:flutter_test/flutter_test.dart';

void main() {
  test('adds one to input values', () {
    expect(1 + 1, 2);
  });

  test('adds two to input values', () {
    expect(1 + 2, 3);
  });

  testWidgets('renders a widget correctly', (WidgetTester tester) async {
    await tester.pumpWidget(MaterialApp(
      home: Scaffold(
        body: Center(
          child: Text('Hello, World!'),
        ),
      ),
    ));

    expect(find.text('Hello, World!'), findsOneWidget);
  });
}

4. 修改build.gradle文件

为了在使用test_reporter时避免权限问题，你需要在android/app/build.gradle文件中添加以下配置：

android {
    // 其他配置...

    lintOptions {
        disable 'InvalidPackage'
    }

    // 确保你的测试任务有适当的权限
    testOptions {
        execution 'ANDROIDX_TEST_ORCHESTRATOR'
    }
}

5. 运行测试并生成报告

现在你可以使用test_reporter运行测试并生成报告。在你的项目根目录下运行以下命令：

flutter test --machine | test-reporter --config=test_reporter_config.json

这条命令会将测试结果通过--machine格式输出，并通过test-reporter工具解析和生成报告。

6. 查看生成的报告

运行完上述命令后，你应该会在项目根目录下的test_reports文件夹中看到生成的测试报告。这些报告可能包括HTML文件和JSON文件，你可以打开HTML文件来查看详细的测试结果和可视化图表。

注意事项

  • 确保你已经安装了Node.js和npm，因为test_reporter可能依赖于这些工具。
  • 如果有任何版本兼容性问题，请参考test_reporter的官方文档或GitHub仓库。
  • 在生产环境中使用时，请根据实际需求调整配置和测试代码。

通过上述步骤，你应该能够成功地在Flutter项目中使用test_reporter插件来生成测试报告。

回到顶部