介绍

#

本指南介绍了如何使用 Flutter 应用运行集成测试。通过本指南,您将学习如何执行以下操作:

  • 设置集成测试。
  • 验证应用是否显示特定文本。
  • 轻触特定小部件。
  • 运行集成测试。

本指南参考了 Flutter 自带的 counter_app 项目以及 Flutter integration_test 包。integration_test 包允许您:

创建一个新的测试应用

#

集成测试需要一个待测试应用。本示例使用 Flutter 运行 flutter create 命令时生成的内置 计数器应用 示例。计数器应用允许用户轻触按钮来增加计数。

  1. 要创建内置 Flutter 应用的一个实例,请在终端中运行以下命令:

    flutter create counter_app
  2. 切换到 counter_app 目录。

  3. 在您偏好的 IDE 中打开 lib/main.dart

  4. floatingActionButton() 小部件添加一个 key 参数,该参数使用 Key 类的一个实例,其字符串值为 increment

    dart
     floatingActionButton: FloatingActionButton(
       key: const ValueKey('increment'),
       onPressed: _incrementCounter,
       tooltip: 'Increment',
       child: const Icon(Icons.add),
     ),
  5. 保存您的 lib/main.dart 文件。

进行这些更改后,lib/main.dart 文件应类似于以下代码。

lib/main.dart
dart
import 'package:flutter/material.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Counter App',
      home: MyHomePage(title: 'Counter App Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text(widget.title)),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text('You have pushed the button this many times:'),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        // Provide a Key to this button. This allows finding this
        // specific button inside the test suite, and tapping it.
        key: const Key('increment'),
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

添加 integration_test 依赖

#

您需要将测试包添加到您的新应用中。

要将 integration_testflutter_test 包作为 dev_dependencies 使用 sdk: flutter 添加,请运行以下命令。

flutter pub add 'dev:integration_test:{"sdk":"flutter"}'

输出

Building flutter tool...
Resolving dependencies... 
Got dependencies.
Resolving dependencies... 
+ file 7.0.0
+ flutter_driver 0.0.0 from sdk flutter
+ fuchsia_remote_debug_protocol 0.0.0 from sdk flutter
+ integration_test 0.0.0 from sdk flutter
...
  test_api 0.6.1 (0.7.1 available)
  vm_service 13.0.0 (14.2.1 available)
+ webdriver 3.0.3
Changed 8 dependencies!
7 packages have newer versions incompatible with dependency constraints.
Try `flutter pub outdated` for more information.

已更新的 pubspec.yaml 文件

pubspec.yaml
yaml
# ...
dev_dependencies:
  # ... added dependencies
  flutter_test:
    sdk: flutter
  flutter_lints: ^6.0.0
  integration_test:
    sdk: flutter
# ...

创建集成测试文件

#

集成测试位于 Flutter 项目内部的一个单独目录中。

  1. 创建一个名为 integration_test 的新目录。
  2. 在该目录中添加一个名为 app_test.dart 的空文件。

生成的目录树应类似于以下内容:

counter_app/
  lib/
    main.dart
  integration_test/
    app_test.dart

编写集成测试

#

集成测试文件包含一个 Dart 代码文件,它依赖于 integration_testflutter_test 和您应用的 Dart 文件。

  1. 在您偏好的 IDE 中打开您的 integration_test/app_test.dart 文件。

  2. 复制以下代码并将其粘贴到您的 integration_test/app_test.dart 文件中。最后一个 import 应该指向您的 counter_appmain.dart 文件。(此 import 指向名为 introduction 的示例应用。)

    integration_test/counter_test.dart
    dart
    import 'package:flutter/material.dart';
    import 'package:flutter_test/flutter_test.dart';
    import 'package:how_to/main.dart';
    import 'package:integration_test/integration_test.dart';
    
    void main() {
      IntegrationTestWidgetsFlutterBinding.ensureInitialized();
    
      group('end-to-end test', () {
        testWidgets('tap on the floating action button, verify counter', (
          tester,
        ) async {
          // Load app widget.
          await tester.pumpWidget(const MyApp());
    
          // Verify the counter starts at 0.
          expect(find.text('0'), findsOneWidget);
    
          // Finds the floating action button to tap on.
          final fab = find.byKey(const ValueKey('increment'));
    
          // Emulate a tap on the floating action button.
          await tester.tap(fab);
    
          // Trigger a frame.
          await tester.pumpAndSettle();
    
          // Verify the counter increments by 1.
          expect(find.text('1'), findsOneWidget);
        });
      });
    }

本示例分三步进行:

  1. 初始化 IntegrationTestWidgetsFlutterBinding。此单例服务在物理设备上执行测试。

  2. 使用 WidgetTester 类与小部件交互并测试小部件。

  3. 测试重要场景。

运行集成测试

#

运行的集成测试因您测试的平台而异。

  • 要测试桌面平台,请使用命令行或 CI 系统。
  • 要测试移动平台,请使用命令行或 Firebase Test Lab。
  • 要在 Web 浏览器中测试,请使用命令行。

在桌面平台测试

#
如果您使用 CI 系统测试 Linux 应用,请展开

要测试 Linux 应用,您的 CI 系统必须首先调用 X 服务器。在 GitHub Action、GitLab Runner 或类似配置文件中,将集成测试设置为 *与* xvfb-run 工具一起工作。

这样做会调用一个 X 窗口系统,Flutter 可以在其中启动和测试您的 Linux 应用。

例如,使用 GitHub Actions 时,您的 jobs.setup.steps 应包含一个类似于以下内容的步骤:

yaml
      - name: Run Integration Tests
        uses: username/xvfb-action@v1.1.2
        with:
          run: flutter test integration_test -d linux -r github

这会在 X 窗口中启动集成测试。

如果您不以这种方式配置集成,Flutter 将返回一个错误。

Building Linux application...
Error waiting for a debug connection: The log reader stopped unexpectedly, or never started.

要在 macOS、Windows 或 Linux 平台上测试,请完成以下任务。

  1. 从项目的根目录运行以下命令。

    flutter test integration_test/app_test.dart
  2. 如果提示选择测试平台,请选择桌面平台。输入 1 选择桌面平台。

根据平台,命令结果应类似于以下输出。

PS C:\path\to\counter_app> flutter test .\integration_test\app_test.dart
Resolving dependencies...
Downloading packages...
  flutter_lints 3.0.2 (4.0.0 available)
  leak_tracker 10.0.4 (10.0.5 available)
  leak_tracker_flutter_testing 3.0.3 (3.0.5 available)
  lints 3.0.0 (4.0.0 available)
  material_color_utilities 0.8.0 (0.11.1 available)
  meta 1.12.0 (1.15.0 available)
  test_api 0.7.0 (0.7.1 available)
  vm_service 14.2.1 (14.2.2 available)
Got dependencies!
8 packages have newer versions incompatible with dependency constraints.
Try `flutter pub outdated` for more information.

Connected devices:

Windows (desktop) • windows • windows-x64    • Microsoft Windows [Version 10.0.22631.3593]
Chrome (web)      • chrome  • web-javascript • Google Chrome 124.0.6367.207
Edge (web)        • edge    • web-javascript • Microsoft Edge 124.0.2478.97

[1]: Windows (windows)
[2]: Chrome (chrome)
[3]: Edge (edge)

Please choose one (or "q" to quit): 1

00:00 +0: loading C:/path/to/counter_app/integration_test/app_test.dart               B
00:29 +0: loading C:/path/to/counter_app/counter_app/integration_test/app_test.dart   29.1s
√ Built build\windows\x64\runner\Debug\counter_app.exe
00:31 +1: All tests passed!
flutter test integration_test
Resolving dependencies... 
Downloading packages... 
  flutter_lints 3.0.2 (4.0.0 available)
> leak_tracker 10.0.4 (was 10.0.0) (10.0.5 available)
> leak_tracker_flutter_testing 3.0.3 (was 2.0.1) (3.0.5 available)
> leak_tracker_testing 3.0.1 (was 2.0.1)
  lints 3.0.0 (4.0.0 available)
  material_color_utilities 0.8.0 (0.11.1 available)
> meta 1.12.0 (was 1.11.0) (1.15.0 available)
> test_api 0.7.0 (was 0.6.1) (0.7.1 available)
> vm_service 14.2.1 (was 13.0.0) (14.2.2 available)
Changed 6 dependencies!
8 packages have newer versions incompatible with dependency constraints.
Try `flutter pub outdated` for more information.

Connected devices:

macOS (desktop)                 • macos                 • darwin-arm64   • macOS 14.4.1 23E224 darwin-arm64
Mac Designed for iPad (desktop) • mac-designed-for-ipad • darwin         • macOS 14.4.1 23E224 darwin-arm64
Chrome (web)                    • chrome                • web-javascript • Google Chrome 124.0.6367.208

No wireless devices were found.

[1]: macOS (macos)
[2]: Mac Designed for iPad (mac-designed-for-ipad)
[3]: Chrome (chrome)
Please choose one (or "q" to quit): 1

00:01 +0: loading /path/to/counter_app/integration_test/app_test.dart        R
00:02 +0: loading /path/to/counter_app/integration_test/app_test.dart    846ms
00:03 +0: loading /path/to/counter_app/integration_test/app_test.dart        B

Building macOS application...
✓ Built build/macos/Build/Products/Debug/counter_app.app
00:32 +1: All tests passed!
flutter test integration_test/app_test.dart

Connected devices:

Linux (desktop) • linux  • linux-x64      • Ubuntu 22.04.4 LTS 6.5.0-35-generic
Chrome (web)    • chrome • web-javascript • Google Chrome 104.0.5112.101

[1]: Linux (linux)
[2]: Chrome (chrome)

Please choose one (or "q" to quit): 1

00:00 +0: /path/to/counter_app/integration_test/app_test.dart     B
00:16 +0: /path/to/counter_app/integration_test/app_test.dart

✓ Built build/linux/x64/debug/bundle/counter_app

在 Android 设备上测试

#

要在真实的 Android 设备上测试,请完成以下任务。

  1. 连接 Android 设备。

  2. 从项目的根目录运行以下命令。

    flutter test integration_test/app_test.dart

    结果应类似于以下输出。

    flutter test integration_test/app_test.dart
    00:04 +0: loading /path/to/counter_app/integration_test/app_test.dart
    00:15 +0: loading /path/to/counter_app/integration_test/app_test.dart
    00:18 +0: loading /path/to/counter_app/integration_test/app_test.dart   2,387ms
    Installing build/app/outputs/flutter-apk/app.apk...  612ms
    00:21 +1: All tests passed!
  3. 验证测试完成后是否已删除计数器应用。如果未删除,后续测试将失败。如果需要,请长按应用并从上下文菜单中选择 移除应用


在 iOS 设备上测试

#

要在真实的 iOS 设备上测试,请完成以下任务。

  1. 连接 iOS 设备。

  2. 从项目的根目录运行以下命令。

    flutter test integration_test/app_test.dart

    结果应类似于以下输出。

    flutter test integration_test/app_test.dart
    00:04 +0: loading /path/to/counter_app/integration_test/app_test.dart
    00:15 +0: loading /path/to/counter_app/integration_test/app_test.dart
    00:18 +0: loading /path/to/counter_app/integration_test/app_test.dart   2,387ms
    Xcode build done.                                           13.5s
    00:21 +1: All tests passed!
  3. 验证测试完成后是否已删除计数器应用。如果未删除,后续测试将失败。如果需要,请长按应用并从上下文菜单中选择 移除应用


在 Web 浏览器中测试

#

要在 Web 浏览器中测试,请执行以下步骤。

  1. ChromeDriver 安装到您选择的目录中。

    npx @puppeteer/browsers install chromedriver@stable

    为了简化安装,此命令使用 @puppeteer/browsers Node 库。

  2. 将 ChromeDriver 的路径添加到您的 $PATH 环境变量中。

  3. 验证 ChromeDriver 安装是否成功。

    chromedriver --version
    ChromeDriver 124.0.6367.60 (8771130bd84f76d855ae42fbe02752b03e352f17-refs/branch-heads/6367@{#798})
  4. 在您的 counter_app 项目目录中,创建一个名为 test_driver 的新目录。

    mkdir test_driver
  5. 在此目录中,创建一个名为 integration_test.dart 的新文件。

  6. 复制以下代码并将其粘贴到您的 integration_test.dart 文件中。

    test_driver/integration_test.dart
    dart
    import 'package:integration_test/integration_test_driver.dart';
    
    Future<void> main() => integrationDriver();
  7. 如下启动 chromedriver

    chromedriver --port=4444
  8. 从项目的根目录运行以下命令:

    flutter drive \
      --driver=test_driver/integration_test.dart \
      --target=integration_test/app_test.dart \
      -d chrome

    响应应类似于以下输出:

    Resolving dependencies...
      leak_tracker 10.0.0 (10.0.5 available)
      leak_tracker_flutter_testing 2.0.1 (3.0.5 available)
      leak_tracker_testing 2.0.1 (3.0.1 available)
      material_color_utilities 0.8.0 (0.11.1 available)
      meta 1.11.0 (1.14.0 available)
      test_api 0.6.1 (0.7.1 available)
      vm_service 13.0.0 (14.2.1 available)
    Got dependencies!
    7 packages have newer versions incompatible with dependency constraints.
    Try `flutter pub outdated` for more information.
    Launching integration_test/app_test.dart on Chrome in debug mode...
    Waiting for connection from debug service on Chrome...             10.9s
    This app is linked to the debug service: ws://127.0.0.1:51523/3lofIjIdmbs=/ws
    Debug service listening on ws://127.0.0.1:51523/3lofIjIdmbs=/ws
    00:00 +0: end-to-end test tap on the floating action button, verify counter
    00:01 +1: (tearDownAll)
    00:01 +2: All tests passed!
    All tests passed.
    Application finished.

    要将其作为无头测试运行,请使用 -d web-server 选项运行 flutter drive

    flutter drive \
      --driver=test_driver/integration_test.dart \
      --target=integration_test/app_test.dart \
      -d web-server

要了解更多信息,请参阅 使用 Web 运行 Flutter 驱动器测试 Wiki 页面。


在 Firebase Test Lab 中测试 (Android)

#

您可以使用 Firebase Test Lab 测试 Android 目标。

Android 设置

#

请遵循 README 中 Android 设备测试 部分的说明。

Test Lab 项目设置

#
  1. 启动您的 Firebase 控制台

  2. 如有必要,请创建一个新的 Firebase 项目。

  3. 导航到 质量 > Test Lab

    Firebase Test Lab Console

上传 Android APK

#

完成以下步骤以上传 Android APK。

  1. 使用 Gradle 创建 APK。

    // Go to the Android directory which contains the gradlew script
    pushd android
    
    // Build a debug APK for Flutter with gradlew
    // Note that a standard --release build will not include package:integration_test
    flutter build apk --debug
    
    // Build an Android test APK
    ./gradlew app:assembleAndroidTest
    
    // Build a debug APK by passing in an integration test
    ./gradlew app:assembleDebug -Ptarget=integration_test/<name>_test.dart
    • <name>_test.dart:在 项目设置 部分创建的文件。
  2. 如有需要,以逗号分隔的列表形式将参数传递给集成测试。将所有参数编码为 base64

    ./gradlew project:task -Pdart-defines="{base64 (key=value)}[, ...]"
    • (key=value)}[, ...]:将其替换为逗号分隔的键值对列表。
  3. 返回您的上一个目录。

    popd

有关其他说明,请参阅 README 的 Firebase Test Lab 部分

启动 Robo 测试

#

要使用 Robo 测试运行集成测试,请完成以下步骤。

  1. 将 debug APK 从 <flutter_project_directory>/build/app/outputs/apk/debug 拖动到网页上的 Android Robo Test 目标。例如:

    Firebase Test Lab upload
  2. 点击 运行测试

  3. 选择 Instrumentation 测试类型。

  4. 将应用 APK 添加到 App APK 或 AAB 框中。

    <flutter_project_directory>/build/app/outputs/apk/debug/<file>.apk

  5. 将测试 APK 添加到 Test APK 框中。

    <flutter_project_directory>/build/app/outputs/apk/androidTest/debug/<file>.apk

    Firebase Test Lab upload two APKs
  6. 如果发生故障,请点击红色图标以查看输出。

    Firebase Test Lab test results

在 Firebase Test Lab 中测试 (iOS)

#

您可以使用 Firebase Test Lab 测试 iOS 目标。

iOS 设置

#

请遵循 iOS 设备测试说明

Test Lab 项目设置

#
  1. 启动您的 Firebase 控制台

  2. 如有必要,请创建一个新的 Firebase 项目。

  3. 导航到 质量 > Test Lab

    Firebase Test Lab Console

通过 Firebase 控制台上传 Xcode 测试

#

要了解如何使用 Firebase Test Lab 控制台从 ZIP 文件上传测试,请参阅 Firebase Test Lab iOS 说明

使用命令行将 Xcode 测试上传到 Firebase 控制台

#

要了解如何使用命令行从 ZIP 文件上传测试到 Firebase Test Lab 控制台,请参阅 iOS 设备测试说明