Flutter驱动控制插件fluttium_driver的使用

Flutter驱动控制插件fluttium_driver的使用

使用示例

下面是一个完整的示例，演示如何使用fluttium_driver来执行用户流程测试。

示例代码

import 'dart:io';

import 'package:fluttium_driver/fluttium_driver.dart';
import 'package:fluttium_interfaces/fluttium_interfaces.dart';
import 'package:mason/mason.dart' hide GitPath;

Future<void> main() async {
  // 初始化FluttiumDriver实例
  final driver = FluttiumDriver(
    logger: Logger(level: Level.verbose), // 设置日志级别为详细
    configuration: const DriverConfiguration(
      flavor: 'development', // 设置开发环境
      target: 'lib/main_development.dart', // 设置目标文件
      deviceId: 'chrome', // 设置设备ID为Chrome
    ),
    actions: {
      'expect_environment_text': const ActionLocation(
        path: 'actions/expect_environment_text', // 设置动作路径
      ),
    },
    projectDirectory: Directory('../../example'), // 设置项目目录
    userFlowFile: File('../../example/flows/progress_flow.yaml'), // 设置用户流程文件
  );

  // 订阅步骤更新
  final stepsSubscription = driver.steps.listen(
    (steps) {
      // 清除终端
      stdout.write('\x1B[2J\x1B[0;0H\n');

      for (final step in steps) {
        switch (step.status) {
          case StepStatus.initial:
            stdout.writeln(' ⚪️ ${step.description}'); // 初始状态
            break;
          case StepStatus.running:
            stdout.writeln(' 🟡 ${step.description}'); // 运行中
            break;
          case StepStatus.done:
            stdout.writeln(' 🟢 ${step.description}'); // 完成
            break;
          case StepStatus.failed:
            stdout.writeln(
              ' 🔴 ${step.description} - reason: ${step.failReason}', // 失败
            );
            break;
        }
      }
    },
    onError: (Object err) {
      if (err is FatalDriverException) {
        stderr.writeln(' Fatal Driver Exception: ${err.reason}'); // 错误处理
        return driver.quit(); // 退出驱动程序
      }
    },
  );

  // 监听中断信号
  final processSubscription =
      ProcessSignal.sigint.watch().listen((_) => driver.quit());

  // 执行驱动程序
  await driver.run();
  await stepsSubscription.cancel(); // 取消订阅
  await processSubscription.cancel(); // 取消订阅
}

代码解释

1. 初始化FluttiumDriver实例：

   final driver = FluttiumDriver(
     logger: Logger(level: Level.verbose),
     configuration: const DriverConfiguration(
       flavor: 'development',
       target: 'lib/main_development.dart',
       deviceId: 'chrome',
     ),
     actions: {
       'expect_environment_text': const ActionLocation(
         path: 'actions/expect_environment_text',
       ),
     },
     projectDirectory: Directory('../../example'),
     userFlowFile: File('../../example/flows/progress_flow.yaml'),
   );
   

   这里创建了一个FluttiumDriver实例，并配置了日志级别、环境、目标文件、设备ID等参数。同时设置了动作路径和用户流程文件。

2. 订阅步骤更新：

   final stepsSubscription = driver.steps.listen(
     (steps) {
       stdout.write('\x1B[2J\x1B[0;0H\n');
       for (final step in steps) {
         switch (step.status) {
           case StepStatus.initial:
             stdout.writeln(' ⚪️ ${step.description}');
             break;
           case StepStatus.running:
             stdout.writeln(' 🟡 ${step.description}');
             break;
           case StepStatus.done:
             stdout.writeln(' 🟢 ${step.description}');
             break;
           case StepStatus.failed:
             stdout.writeln(
               ' 🔴 ${step.description} - reason: ${step.failReason}',
             );
             break;
         }
       }
     },
     onError: (Object err) {
       if (err is FatalDriverException) {
         stderr.writeln(' Fatal Driver Exception: ${err.reason}');
         return driver.quit();
       }
     },
   );
   

   订阅driver.steps事件，以便实时监听每个步骤的状态变化，并在终端输出相应的状态信息。同时处理错误情况，如果发生致命异常，则退出驱动程序。

3. 监听中断信号：

   final processSubscription =
       ProcessSignal.sigint.watch().listen((_) => driver.quit());
   

   监听系统中断信号（如Ctrl+C），当接收到信号时调用driver.quit()方法退出驱动程序。

4. 执行驱动程序：

   await driver.run();
   

   执行驱动程序，开始运行用户流程测试。

5. 取消订阅：

   await stepsSubscription.cancel();
   await processSubscription.cancel();