bdd_flutter 2.0.0
bdd_flutter: ^2.0.0 copied to clipboard
A Flutter package for Behavior-Driven Development (BDD) testing.
2.0.0 #
2.0 changes the shape of the generated code. Run dart run bdd_flutter migrate once to move a 1.x project; see "Upgrading from 1.x" in the README.
Breaking #
- Step code moves from
.bdd_scenarios.dart(one class per scenario, edited by you and appended to by the tool) to three files per feature:<name>.bdd_steps.dart: a generatedabstract interface class <Feature>StepsContract, rewritten on every build<name>_steps.dart: your<Feature>Steps implements <Feature>StepsContract, created once and never touched again<name>.bdd_test.dart: the generated tests
- One steps class per feature, with one method per distinct step. Background, Rule background and scenario steps share it, so state lives in normal fields instead of top-level variables
- Quoted text and standalone numbers in step text become typed parameters:
I add 2 "apple"isiAdd(num number, String text)instead ofiAdd2Apple(). Steps that differ only in these values share a method - Outline columns are typed:
numwhen every value is a number Dart prints back unchanged,boolfortrue/false, otherwiseString - Widget tests get the
WidgetTesterthrough atesterfield set by the generated test, not as a method parameter - Unimplemented steps throw
UnimplementedErrorinstead of passing silently - Minimum Dart SDK is 3.8.0 (required by
cucumber_gherkin) - Removed: the manifest (
.bdd_flutter/manifest.yaml), incremental append andbuild --force;buildalways rewrites generated files and never touches yours - Tags that are not valid
dart testtag names, such as 1.x's@className("X"), are ignored - Config:
scenario_suffixis replaced bysteps_suffix(defaultSteps);scenario_suffixis only read bymigrate.additional_importsnow go into new_steps.dartfiles
Features #
.featurefiles are parsed by the officialcucumber_gherkinparser and mapped fromcucumber_messagestypes (#6)- Supports
Butand*steps,Scenario Outline,Rule(with its ownBackground), severalExamplesblocks, several tags on one line, comments, escaped\|in tables and non-English keywords (# language: fr) - Scenario Outlines generate one test per example row, in a group named after the scenario; each row runs the Background with fresh state, and a failing row no longer hides the others
Rule:blocks becomegroup('Rule: …'), and a Rule's Background runs after the feature's- Doc strings and data tables are passed as
String docStringandList<List<String>> dataTable, with<column>placeholders filled per row - Gherkin tags are passed to
test()/testWidgets()astags:, merged from feature, rule, scenario and Examples;buildlists them fordart_test.yaml @skipon a feature, rule, scenario or Examples block generatesskip: truegenerate_widget_testsnow applies to scenarios without@unitTest/@widgetTest; the closest decorator wins (scenario, then rule, then feature)- Generated files are formatted with the SDK's
dart format, using your package's style and page width buildreports steps your_steps.dartlacks and steps it overrides that the feature no longer has- New
migratecommand carries 1.x step code into the new steps files - Steps used by several features can be written once in
mixin SharedSteps(test/shared_steps.dart), created with stubs the first time steps are shared and then yours. New steps classes mix it in. A step becoming shared later only prints a tip, and method names are worked out per feature, so a change to one feature never breaks another bdd_flutter testreport: Scenario Outline rows and Rules are nested, skipped tests are shown and counted, failures point at the line in your steps file, features are sorted by path, durations appear only for failed and slow tests, and colors followNO_COLORand the terminal- Accented letters are folded in generated names (
Incrémenter→Incrementer, Vietnamese included); text with no Latin letters gets a stable hashed name. No extra dependency: the folding table is built in. Names never collide with Dart keywords orObjectmembers - Invalid
.featurefiles are reported with line and column and skipped;buildexits with code 1 so CI catches them - Steps carry a
keywordType(context, action, outcome, conjunction)
Bug Fixes #
- Skipped tests were listed in the test report as nameless passing tests under an empty "Test File:" heading, and counted as passed
- Scenario Outline rows no longer share state set up by the Background
- Example values containing
'or$no longer produce invalid code, in arguments and test names - Numbers such as
1.50,02134or$10.00are never turned into a different value
Example #
- Every example feature now has working steps, and
login.featureis a real widget test withmocktail - Add
test/cart/cart.feature(Rule, two Examples blocks,Butand*),test/compteur/compteur.feature(French keywords) andtest/stress/stress.feature(doc strings, data tables, repeated placeholders, tags on Examples, symbols in step text) - Add
dart_test.yamldeclaring the example's tags test/complex/complex1.featureis marked@skip: it shows generated names for long, real-world step text
1.1.1 #
Features #
dart run bdd_flutter testnow runs all test files (BDD and regular), not just.bdd_test.dart- Separate report sections: BDD Test Report (grouped by Feature/Scenario) and Non-BDD Test Report (grouped by test file and group name with indentation)
- Combined summary at the bottom with total pass/fail counts
Tests #
- Add integration tests for
BDDControllerincremental build (rename, remove, modify, delete, force, append scenarios)
1.1.0 #
Bug Fixes #
- Fix class name generation for names starting with digits (e.g.,
"123 login"→X123LoginScenario) - Fix class name generation for names with special characters (hyphens, punctuation now stripped)
- Fix method name generation for steps starting with digits (leading digits stripped)
- Fix
snakeCaseToCamelCasecrash on leading/trailing underscores - Return safe fallback names (
Unnamed,unnamed,step) instead of empty strings for edge cases - Fix Background class name not sanitized — feature names with spaces/hyphens (e.g.,
"Form auto-save") produced invalid Dart class names - Fix incremental build skipping regeneration when generated files are deleted but manifest entry still exists
- Fix incremental build appending instead of regenerating when scenarios are removed, renamed, or modified — caused broken test files referencing non-existent classes
Tests #
- Add comprehensive unit tests for
StringXextensions (PascalCase, snakeCaseToCamelCase, toSnakeCase) - Add unit tests for
Step.methodNameedge cases (digits, special chars, empty text, params) - Add unit tests for
Scenarioclass name generation, decorator resolution, and hash consistency - Add unit tests for
Decoratorparsing and set helpers
1.0.0 #
BREAKING CHANGES #
- Removed
build_runnerdependency entirely — usedart run bdd_flutter buildinstead - Removed
--no-widget-testand--new-onlyCLI flags - Configuration moved from
build.yamlto.bdd_flutter/config.yaml - Generated file extensions changed from
.bdd_scenarios.g.dartto.bdd_scenarios.dartand.bdd_test.g.dartto.bdd_test.dart
Features #
- New standalone CLI:
dart run bdd_flutter buildanddart run bdd_flutter test - Incremental test generation with manifest tracking (only regenerates changed scenarios)
--forceflag to regenerate all filestestcommand with formatted Feature/Scenario report output- Custom test directory via
test_dirconfig option - Custom scenario class suffix via
scenario_suffixconfig option (e.g.,Stepsinstead ofScenario) - Additional imports support via
additional_importsconfig option - Background steps support
@unitTest/@widgetTestdecorators at feature and scenario level- Scenario-level Examples tables for parameterized tests
Improvements #
- Clean Architecture restructure (domain, infrastructure, presentation layers)
- Instance-based scenario classes (supports
latefields for shared state) - Comprehensive documentation across all layers
0.3.0 #
- remove
build_runnerdependency - add custom CLI
dart run bdd remaneto remove.gfrom generated files extensiondart run bdd buildto generate files from feature files
0.2.0 #
- change output files extension to
.bdd_scenarios.g.dartand.bdd_test.g.dart - add
ignore_featuresoption tobuild.yaml - fix example
- fix import file name
- update readme
0.1.5 #
- fix import file name
0.1.4 #
- fix builder with examples
- add ignore decorator on feature
0.1.3 #
- fix builder issue with examples
- restructure code
0.1.2 #
- add
@disableReporterand@enableReporterdecorators - fix build_runner error
- improve documentation
- change log to stdout
- update readme
0.1.1 #
- add
@classNamedecorator - fix build_runner error
0.1.0 #
- refactor to use factory pattern
- improve code readability
- improve documentation
0.0.1 #
- Initial release