API Reference Cucumber v#1.0.0

A behavior-driven development (BDD) testing framework for Elixir using Gherkin syntax.

Exception raised when a step's text matches more than one step definition.

An attachment recorded during a cucumber run via Cucumber.attach/4, Cucumber.log/2, or Cucumber.link/2.

Raised in every scenario when the run's before_all hooks failed.

Compiles discovered features and steps into ExUnit test modules.

Discovers and loads feature files, step definitions, and hook modules.

Result struct returned by Cucumber.Discovery.discover/1.

Parser and matcher for Cucumber Expressions used in step definitions.

Provides hooks for setup and teardown in Cucumber tests.

Builders and NDJSON encoding for Cucumber Messages, the protocol every Cucumber implementation emits so formatters, report services, and the Cucumber Compatibility Kit can consume runs uniformly.

Drives Cucumber Messages emission through the Cucumber.RunCoordinator sink.

Defines custom parameter types for use in cucumber expressions.

Exception raised when a step (or before hook) signals it is not yet implemented by returning :pending or {:pending, message}.

Run-wide coordination process for cucumber test runs.

Runtime execution of cucumber steps.

Provides macros for defining cucumber step definitions.

Exception raised when a step in a Cucumber scenario fails.

Raised when a step pattern references a parameter type that is neither a built-in nor a registered custom type (see Cucumber.ParameterTypes).

Represents a Gherkin Background section.

Represents an Examples block within a Scenario Outline.

Represents a parsed Gherkin feature file (minimal subset).

Parser for Markdown feature files — "Markdown with Gherkin" (MDG).

NimbleParsec-based Gherkin parser.

Exception raised when parsing a Gherkin file fails.

Gherkin parser using NimbleParsec.

A pickle: one concrete, runnable scenario compiled from a feature's AST.

One step of a Gherkin.Pickle.

Compiles a parsed Gherkin.Feature into its Cucumber Messages gherkinDocument node and the list of Gherkin.Pickles to execute.

Result of Gherkin.Pickles.compile/2.

Represents a Gherkin Rule section.

Represents a Gherkin Scenario section.

Represents a Gherkin Scenario Outline section.

Represents a Gherkin step (Given/When/Then/And/But/*).

Installs Cucumber into your Elixir project.