Add Background keyword

Author: olexale

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [0.1.3] - More Gherkin keywords
 
+* Add `Background` keyword
 * Add `directives_ordering` linter exception
 
 ## [0.1.2] - More Gherkin keywords

lib/src/bdd_line.dart

@@ -10,6 +10,7 @@ class BddLine {
 
 enum LineType {
   feature,
+  background,
   scenario,
   step,
   unknown,
@@ -19,6 +20,9 @@ LineType _lineTypeFromString(String line) {
   if (featureMarkers.any((marker) => line.startsWith(marker))) {
     return LineType.feature;
   }
+  if (backgroundMarkers.any((marker) => line.startsWith(marker))) {
+    return LineType.background;
+  }
   if (scenarioMarkers.any((marker) => line.startsWith(marker))) {
     return LineType.scenario;
   }
@@ -29,6 +33,7 @@ LineType _lineTypeFromString(String line) {
 }
 
 const featureMarkers = ['Feature:'];
+const backgroundMarkers = ['Background:'];
 const scenarioMarkers = ['Scenario:', 'Example:'];
 const stepMarkers = ['Given', 'When', 'Then', 'And', 'But'];
 

lib/src/feature_generator.dart

@@ -22,30 +22,59 @@ String generateFeatureDart(List<BddLine> lines, List<StepFile> steps) {
 
   sb.writeln('');
   sb.writeln('void main() {');
+  _parseBackground(sb, lines);
 
   final features = splitWhen(
       lines.skipWhile((value) => value.type != LineType.feature), // skip header
       (e) => e.type == LineType.feature);
 
   for (final feature in features) {
-    sb.writeln('  group(\'${feature.first.value}\', () {');
+    _parseFeature(sb, feature);
+  }
+  sb.writeln('}');
+  return sb.toString();
+}
 
-    final scenarios =
-        splitWhen(feature.skip(1), (e) => e.type == LineType.scenario).toList();
-    for (final scenario in scenarios) {
-      sb.writeln(
-          '    testWidgets(\'${scenario.first.value}\', (WidgetTester tester) async {');
+var backgroundOffset = -1;
+void _parseBackground(StringBuffer sb, List<BddLine> feature) {
+  backgroundOffset =
+      feature.indexWhere((element) => element.type == LineType.background);
+  if (backgroundOffset == -1) {
+    return;
+  }
+  sb.writeln('  setUp(() async {');
+  backgroundOffset++;
+  while (feature[backgroundOffset].type == LineType.step) {
+    sb.writeln(
+        '    await ${getStepMethodCall(feature[backgroundOffset].value)};');
+    backgroundOffset++;
+  }
+  sb.writeln('  });');
+}
 
-      for (final step in scenario.skip(1)) {
-        sb.writeln('      await ${getStepMethodCall(step.value)};');
-      }
+void _parseFeature(StringBuffer sb, List<BddLine> feature) {
+  sb.writeln('  group(\'${feature.first.value}\', () {');
 
-      sb.writeln('    });');
-    }
-    sb.writeln('  });');
+  final scenarios = splitWhen(
+      feature.skip(backgroundOffset == -1
+          ? 1 // Skip 'Feature:'
+          : backgroundOffset), // or 'Backround:'
+      (e) => e.type == LineType.scenario).toList();
+  for (final scenario in scenarios) {
+    _parseScenario(sb, scenario);
   }
-  sb.writeln('}');
-  return sb.toString();
+  sb.writeln('  });');
+}
+
+void _parseScenario(StringBuffer sb, List<BddLine> scenario) {
+  sb.writeln(
+      '    testWidgets(\'${scenario.first.value}\', (WidgetTester tester) async {');
+
+  for (final step in scenario.skip(1)) {
+    sb.writeln('      await ${getStepMethodCall(step.value)};');
+  }
+
+  sb.writeln('    });');
 }
 
 List<List<T>> splitWhen<T>(Iterable<T> original, bool Function(T) predicate) =>

test/background_test.dart

@@ -0,0 +1,41 @@
+import 'package:bdd_widget_test/src/feature_file.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+import 'testing_data.dart';
+
+void main() {
+  test('Background steps appear before groups ', () {
+    const featureFile = '''
+Feature: Testing feature
+  Background:
+    Given the server always return errors
+  Scenario: Testing scenario
+    Given the app is running
+''';
+
+    const expectedFeatureDart = '''
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: unused_import, directives_ordering
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+import './step/the_server_always_return_errors.dart';
+import './step/the_app_is_running.dart';
+
+void main() {
+  setUp(() async {
+    await theServerAlwaysReturnErrors(tester);
+  });
+  group('Testing feature', () {
+    testWidgets('Testing scenario', (WidgetTester tester) async {
+      await theAppIsRunning(tester);
+    });
+  });
+}
+''';
+
+    final feature = FeatureFile(path: 'test.feature', input: featureFile);
+    expect(feature.dartContent, expectedFeatureDart);
+  });
+}