Flutter行为驱动开发插件gherkin的使用

dart_gherkin 是一个功能齐全的Gherkin解析器和测试运行器，适用于Flutter和Dart 2。它遵循Cucumber的各种实现方式，并提供了特定于Flutter的功能来帮助进行应用程序测试。

以下是关于如何在Flutter项目中使用gherkin插件的详细指南和示例代码。

快速入门

创建特征文件

首先创建一个名为 test 的文件夹，在该文件夹内创建一个名为 features 的文件夹，然后创建一个名为 calculator_can_add.feature 的文件。

Feature: Calculator
  Tests the addition feature of the calculator

  Scenario: Add two numbers
    Given the numbers 1.5 and 2.1
    When they are added
    Then expected result is 3.6

实现步骤定义

步骤定义是特征文件中的文本步骤的编码表示。每个步骤以 Given、Then、When、And 或 But 开头。

例如，实现一个给定步骤：

import 'package:gherkin/gherkin.dart';
import '../worlds/custom_world.world.dart';

StepDefinitionGeneric GivenTheNumbers() {
  return given2<num, num, CalculatorWorld>(
    'the numbers {num} and {num}',
    (input1, input2, context) async {
      context.world.calculator.storeNumericInput(input1);
      context.world.calculator.storeNumericInput(input2);
    },
  );
}

配置测试运行

创建一个名为 test.dart 的文件，并将以下代码放入其中：

import 'dart:async';
import 'package:gherkin/gherkin.dart';
import 'supporting_files/steps/given_the_numbers.step.dart';
import 'supporting_files/steps/then_expect_numeric_result.step.dart';
import 'supporting_files/steps/when_numbers_are_added.step.dart';
import 'supporting_files/worlds/custom_world.world.dart';

Future<void> main() {
  final steps = [
    givenTheNumbers(),
    whenTheStoredNumbersAreAdded(),
    thenExpectNumericResult()
  ];
  final config = TestConfiguration.standard(
    steps,
    hooks: [HookExample()],
    customStepParameterDefinitions: [PowerOfTwoParameter()],
    createWorld: (config) => Future.value(CalculatorWorld()),
  );

  return GherkinRunner().execute(config);
}

运行测试：

dart test.dart

配置说明

配置对象指定了要运行的内容以及运行所使用的类（如步骤、钩子和报告器）。配置参数包括：

• features: 指定要运行的特征文件的位置。
• tagExpression: 定义基于标签的特性场景运行。
• order: 场景执行顺序。
• defaultLanguage: 特征文件的默认语言。
• stepDefinitions: 自定义步骤定义类实例。
• customStepParameterDefinitions: 自定义步骤参数定义。
• hooks: 钩子类实例。
• reporters: 报告器类实例。
• createWorld: 创建自定义世界上下文对象的方法。

示例Demo

以下是一个完整的示例，展示如何使用 gherkin 插件编写和运行BDD测试。

特征文件 (calculator_can_add.feature)

Feature: Calculator
  Tests the addition feature of the calculator

  Scenario: Add two numbers
    Given the numbers 1.5 and 2.1
    When they are added
    Then expected result is 3.6

步骤定义 (given_the_numbers.step.dart)

import 'package:gherkin/gherkin.dart';
import '../worlds/custom_world.world.dart';

StepDefinitionGeneric GivenTheNumbers() {
  return given2<num, num, CalculatorWorld>(
    'the numbers {num} and {num}',
    (input1, input2, context) async {
      context.world.calculator.storeNumericInput(input1);
      context.world.calculator.storeNumericInput(input2);
    },
  );
}

测试运行配置 (test.dart)

import 'dart:async';
import 'package:gherkin/gherkin.dart';
import 'supporting_files/steps/given_the_numbers.step.dart';
import 'supporting_files/steps/then_expect_numeric_result.step.dart';
import 'supporting_files/steps/when_numbers_are_added.step.dart';
import 'supporting_files/worlds/custom_world.world.dart';

Future<void> main() {
  final steps = [
    givenTheNumbers(),
    whenTheStoredNumbersAreAdded(),
    thenExpectNumericResult()
  ];
  final config = TestConfiguration.standard(
    steps,
    hooks: [HookExample()],
    customStepParameterDefinitions: [PowerOfTwoParameter()],
    createWorld: (config) => Future.value(CalculatorWorld()),
  );

  return GherkinRunner().execute(config);
}

运行测试

在命令行中运行以下命令：

dart pub get
cd example
dart test.dart

这将运行 features 文件夹中的特征文件。

通过以上步骤，您可以轻松地在Flutter项目中使用 gherkin 插件进行行为驱动开发。希望这个指南对您有所帮助！