dherkin2 1.0.1+1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 65

dherkin

Gherkin/cucumber implementation in dart.

For information on gherkin syntax and Behavior Driven Development (BDD) please see: http://cukes.info/

Fork

The fork of the project removed all Future-implementations and replaced them with the Dart2 async/await semantics. With this implementation the actual step implementations require a Completer as the first parameter that must be completed at the end of each test step. The reason is that the implementation uses the LibraryMirror.invoke method that cannot be used with await.

Usage

Dherkin can be executed in a number of ways.

cucumberd

Library comes with an executable runner script cucumberd in bin/ directory. Create symbolic link in a directory on your path, like /usr/local/bin:

cd /usr/local/bin
ln -s path/to/dherkin/bin/cucumberd .

Execute:

cucumberd examples/test_feature.feature

Note: cucumberd will auto-include all step definitions in steps/ sub-directory. Ability to add steps source locations via command-line arguments is planned.

Custom Runner

Alternatively, you might opt for writing your own script:

   library my_bdd_runner;

   import 'package:dherkin/dherkin.dart';
   import 'my_step_defs.dart'; // import stepdefs, mandatory since no auto-scanning happens

   main(args) {
     run(args);
   }

   // write your StepDefs below

Invoke the runner : $ dart my_bdd_runner.dart my_gherkin.feature

Anatomy of a stepdef

A stepdef is a top-level function annotated with one of Gherkin keywords. Such a function can take any number of positional parameters, and up to three optional named parameters.

@And("I am a table step \"(\\w+?)\"")
i_am_a_table(arg1, {exampleRow, table, out}) {
   out.writeln("Executing...${exampleRow['column2']}");
}

Table found on the step will be passed in as table. A scenario outline row will be passed in as exampleRow

Output

Due to asynchronous nature of execution, output of print statements will not appear near the gherkin step that ran them. For that purpose, optional named parameter out will be injected if the stepdef function states that it takes it

Parallelism

Features and scenarios are executed in multiple workers, so there is a degree of unpredictability of the order of execution.

1.0.1+1

  • Introduced this changelog.

1.0.1

  • Upgraded all dependencies.
  • Minimal required Dart SDK is now 2.0.0.
  • Removed log4dart because it is not dart2 compatible. Replaced it with the logging lib from pub.dart.

1.0.0

  • The fork removed all future-code and replaced it with async/await. The reason for that is that it can properly be used in dart2 tests.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  dherkin2: ^1.0.1+1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:dherkin2/dherkin.dart';
import 'package:dherkin2/dherkin_core.dart';
  
Version Uploaded Documentation Archive
1.0.1+1 Sep 14, 2018 Go to the documentation of dherkin2 1.0.1+1 Download dherkin2 1.0.1+1 archive
1.0.1 Sep 14, 2018 Go to the documentation of dherkin2 1.0.1 Download dherkin2 1.0.1 archive
1.0.0 Jun 5, 2018 Go to the documentation of dherkin2 1.0.0 Download dherkin2 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
31
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
65
Learn more about scoring.

We analyzed this package on Oct 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.12.4

Platforms

Detected platforms: other

Platform components identified in package: io, mirrors.

Health suggestions

Format bin/cucumberd.dart.

Run dartfmt to format bin/cucumberd.dart.

Format lib/dherkin.dart.

Run dartfmt to format lib/dherkin.dart.

Format lib/dherkin_core.dart.

Run dartfmt to format lib/dherkin_core.dart.

Fix additional 10 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/gherkin_parser.dart (Run dartfmt to format lib/src/gherkin_parser.dart.)
  • lib/src/model/background.dart (Run dartfmt to format lib/src/model/background.dart.)
  • lib/src/model/feature.dart (Run dartfmt to format lib/src/model/feature.dart.)
  • lib/src/model/runtime.dart (Run dartfmt to format lib/src/model/runtime.dart.)
  • lib/src/model/scenario.dart (Run dartfmt to format lib/src/model/scenario.dart.)
  • lib/src/model/step.dart (Run dartfmt to format lib/src/model/step.dart.)
  • lib/src/model/table.dart (Run dartfmt to format lib/src/model/table.dart.)
  • lib/src/output/console_buffer.dart (Run dartfmt to format lib/src/output/console_buffer.dart.)
  • lib/src/output/output.dart (Run dartfmt to format lib/src/output/output.dart.)
  • lib/src/status/status.dart (Run dartfmt to format lib/src/status/status.dart.)

Maintenance suggestions

Maintain an example.

None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use dherkin2.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
ansicolor ^1.0.2 1.0.2
args ^1.5.0 1.5.0
logging ^0.11.3+2 0.11.3+2
Dev dependencies
build_runner ^0.10.2