Flutter插件gits_cucumber的使用

Flutter插件gits_cucumber的使用_gits_cucumber 包基于 patrol 和 integration_test 来简化使用 Gherkin 语言进行集成测试的过程

gits_cucumber 包基于 patrol 和 integration_test 来简化使用 Gherkin 语言进行集成测试的过程。它可以在 gits_cli 上使用。

安装

首先安装 gits_cli：

dart pub global activate gits_cli

然后在项目中安装 gits_cucumber：

dart pub add gits_cucumber --dev

使用

为了使用 gits_cucumber，你需要在 integration_test 目录下创建一个文件 cucumber_test.dart 并导入它：

import 'package:gits_cucumber/gits_cucumber.dart';

一旦导入，你可以编写 Widget 测试：

import 'support/cucumber_config.dart';
import 'support/cucumber_hook.dart';
import 'support/step_definitions.dart';

void main() async {
  await GitsCucumber(
    config: CucumberConfig(),
    hook: CucumberHook(),
    reporter: [JsonReporter(), StdoutReporter()],
    stepDefinitions: stepDefinitions,
  ).execute();
}

配置

你可以创建一个 Config 类或将其设置为默认值 null：

import 'package:core/core.dart';
import 'package:gits_cucumber/gits_cucumber.dart';

class CucumberConfig extends Config {
  @override
  bool get nativeAutomation => false;

  @override
  NativeAutomatorConfig get nativeAutomatorConfig =>
      const NativeAutomatorConfig(
        androidAppName: Environment.appName,
        iosAppName: Environment.appName,
        packageName: Environment.androidApplicationId,
        bundleId: Environment.iosApplicationId,
      );

  @override
  PatrolTesterConfig get patrolTesterConfig => const PatrolTesterConfig(
        visibleTimeout: Duration(minutes: 1),
      );

  @override
  bool get skipScenario => false;

  @override
  Duration get timeout => const Duration(minutes: 5);
}

钩子

现在你可以添加 Hook 以供 Cucumber 使用：

import 'package:core/core.dart';
import 'package:gits_cucumber/gits_cucumber.dart';
import 'package:gits_flutter_starter_kit/main.dart' as app;

class CucumberHook extends Hook {
  @override
  Future<void> onBeforeExecute() async {
    await app.init();
  }

  @override
  Future<void> onAfterExecute() async {}

  @override
  Future<void> onBeforeFeature(PatrolTester $) async {}

  @override
  Future<void> onAfterFeature(PatrolTester $) async {
    await FlutterSecureStorageHelper.logout();
  }

  @override
  Future<void> onBeforeScenario(PatrolTester $) async {
    await $.pumpWidget(const app.MyApp());
  }

  @override
  Future<void> onAfterScenario(PatrolTester $) async {
    locator<GoRouter>().go('/');
  }

  @override
  Future<void> onBeforeStep(PatrolTester $) async {}

  @override
  Future<void> onAfterStep(PatrolTester $) async {}
}

步骤定义

你需要在 step_definitions.dart 中定义步骤：

import 'package:flutter/material.dart';
import 'package:gits_cucumber/gits_cucumber.dart';

Map<RegExp, Function> stepDefinitions = {
  // 行动
  RegExp(r'I wait for "([^"]*)" key to visible'):
      (PatrolTester $, String key) async {
    await $(Key(key)).waitUntilVisible();
  },
  RegExp(r'I clear textfield in "([^"]*)" key'):
      (PatrolTester $, String key) async {
    await $(Key(key)).enterText('');
  },
  RegExp(r'I enter "([^"]*)" into "([^"]*)" key'):
      (PatrolTester $, String value, String key) async {
    await $(Key(key)).enterText(value);
  },
  RegExp(r'I scroll in "([^"]*)" key until visible "([^"]*)" key'):
      (PatrolTester $, String scrollKey, String visibleKey) async {
    await $(Key(visibleKey))
        .scrollTo(scrollable: $(Key(scrollKey)).$(Scrollable));
  },
  RegExp(r'I tap "([^"]*)" key'): (PatrolTester $, String key) async {
    await $(Key(key)).tap();
  },
  RegExp(r'I longtap "([^"]*)" key'): (PatrolTester $, String key) async {
    await $.tester.longPress($(key));
  },
};

你还可以添加其他自定义的步骤定义，使用正则表达式。

在 pubspec.yaml 中添加资源

1. 在 integration_test/ndjson/ 创建目录。
2. 然后在 pubspec.yaml 中添加这些资源：

flutter:
  uses-material-design: true
  assets:
    - integration_test/ndjson/

报告器

报告器是可以报告测试运行状态的类。这可以简单地将场景结果记录到控制台。内置的报告器包括：

• StdoutReporter：将所有消息从测试运行记录到标准输出（控制台）。
• JsonReporter：创建一个包含测试运行结果的 JSON 文件，然后可以使用 https://www.npmjs.com/package/cucumber-html-reporter 创建 HTML 报告。你可以传递要创建的 JSON 文件的路径。

特性

编写你的特性文件 integration_test/features/login.feature：

Feature: 登录

  场景: 使用用户名和 PIN 登录失败
    当我输入 "example@gits.id" 到 "inputEmail" 键
    当我在 "scrollLogin" 键上滚动直到 "inputPin" 键可见
    当我输入 "123455" 到 "inputPin" 键
    当我在 "scrollLogin" 键上滚动直到 "btnLogin" 键可见
    当我点击 "btnLogin" 键

  场景: 使用用户名和 PIN 登录成功
    当我输入 "example@gits.id" 到 "inputEmail" 键
    当我在 "scrollLogin" 键上滚动直到 "inputPin" 键可见
    当我输入 "123456" 到 "inputPin" 键
    当我在 "scrollLogin" 键上滚动直到 "btnLogin" 键可见
    当我点击 "btnLogin" 键

Gits CLI

现在你已经完成了 GitsCucumber 的设置，可以通过调用 gits_cli 命令来运行测试：

gits_cli cucumber