gherkin library

Classes

ActionMessage

A general message related to all kinds of entities in Gherkin tests

AggregatedHook

AggregatedReporter

And

And1<TInput1>

And1WithWorld<TInput1, TWorld extends World>

And2<TInput1, TInput2>

And2WithWorld<TInput1, TInput2, TWorld extends World>

And3<TInput1, TInput2, TInput3>

And3WithWorld<TInput1, TInput2, TInput3, TWorld extends World>

And4<TInput1, TInput2, TInput3, TInput4>

And4WithWorld<TInput1, TInput2, TInput3, TInput4, TWorld extends World>

And5<TInput1, TInput2, TInput3, TInput4, TInput5>

And5WithWorld<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>

AndWithWorld<TWorld extends World>

Attachment

AttachmentManager

But

But1<TInput1>

But1WithWorld<TInput1, TWorld extends World>

But2<TInput1, TInput2>

But2WithWorld<TInput1, TInput2, TWorld extends World>

But3<TInput1, TInput2, TInput3>

But3WithWorld<TInput1, TInput2, TInput3, TWorld extends World>

But4<TInput1, TInput2, TInput3, TInput4>

But4WithWorld<TInput1, TInput2, TInput3, TInput4, TWorld extends World>

But5<TInput1, TInput2, TInput3, TInput4, TInput5>

But5WithWorld<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>

ButWithWorld<TWorld extends World>

CustomParameter<T>

A class used to define and parse custom parameters in step definitions see https://docs.cucumber.io/cucumber/cucumber-expressions/#custom-parameter-types

DisposableReporter

An abstract class that allows you to send messages and intercept them.

ErroredStepResult

ExceptionReporter

An abstract class that allows you to track the status of exceptions.

ExecutableStep

FeatureFileMatcher

FeatureFileReader

FeatureFileVisitor

FeatureMessage

A message related to a feature

FeatureReporter

An abstract class that allows you to track the status of features.

FloatParameterBase

FloatParameterCamel

FloatParameterLower

FullFeatureReporter

This is an abstraction for the implementation of all methods for generating reports without TestReporter

FullReporter

This is an abstraction for the implementation of all methods for generating reports

GenericFunctionStepDefinition<TWorld extends World>

GherkinExpression

GherkinRunner

GherkinTable

Given

Given1<TInput1>

Given1WithWorld<TInput1, TWorld extends World>

Given2<TInput1, TInput2>

Given2WithWorld<TInput1, TInput2, TWorld extends World>

Given3<TInput1, TInput2, TInput3>

Given3WithWorld<TInput1, TInput2, TInput3, TWorld extends World>

Given4<TInput1, TInput2, TInput3, TInput4>

Given4WithWorld<TInput1, TInput2, TInput3, TInput4, TWorld extends World>

Given5<TInput1, TInput2, TInput3, TInput4, TInput5>

Given5WithWorld<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>

GivenWithWorld<TWorld extends World>

Hook

A hook that is run during certain points in the execution cycle You can override any or none of the methods

InfoReporter

This is an abstraction for the implementation of all methods for generating reports

IntParameterBase

IntParameterCamel

IntParameterLower

IoFeatureFileAccessor

JsonReporter

JsonSerializableReporter

LanguageService

MessageReporter

An abstract class that allows you to send messages and intercept them.

NumParameterCamel

NumParameterLower

PluralParameter

ProcessHandler

ProgressReporter

ReportActionHandler<S extends ActionMessage>

Auxiliary class for customizing the actions of features

Reporter

An abstract class both for all reporters

RunnableDebugInformation

ScenarioMessage

A message related to a scenario or scenarioOutline

ScenarioReporter

An abstract class that allows you to track the status of scenarios.

SerializableReporter<T>

Interface provides serialize objects to type T

StateAction<T extends ActionMessage>

Auxiliary class for performing various actions

StdoutReporter

StepContext<TWorld extends World>

Class that contains the contextual information when a step is run Provides access to the world, reporter, step configuration and expect functions.

StepDefinition<TWorld extends World>

StepDefinition1<TWorld extends World, TInput1>

StepDefinition2<TWorld extends World, TInput1, TInput2>

StepDefinition3<TWorld extends World, TInput1, TInput2, TInput3>

StepDefinition4<TWorld extends World, TInput1, TInput2, TInput3, TInput4>

StepDefinition5<TWorld extends World, TInput1, TInput2, TInput3, TInput4, TInput5>

StepDefinitionBase<TWorld extends World>

StepDefinitionConfiguration

StepDefinitionGeneric<TWorld extends World>

StepMessage

A message related to a step

StepReporter

An abstract class that allows you to track the status of steps.

StepResult

StringParameterBase

StringParameterCamel

StringParameterLower

TableRow

Tag

TagExpressionEvaluator

Evaluates tag expression lexicon such as @smoke and @perf @smoke and not @perf not @smoke and not @perf not (@smoke or @perf) @smoke and (@perf or @android) see https://cucumber.io/docs/cucumber/api/?sbsearch=tag%20expressions#tags

TestConfiguration

TestMessage

TestReporter

An abstract class that allows you to track the status of the start of tests.

TestRunSummaryReporter

Then

Then1<TInput1>

Then1WithWorld<TInput1, TWorld extends World>

Then2<TInput1, TInput2>

Then2WithWorld<TInput1, TInput2, TWorld extends World>

Then3<TInput1, TInput2, TInput3>

Then3WithWorld<TInput1, TInput2, TInput3, TWorld extends World>

Then4<TInput1, TInput2, TInput3, TInput4>

Then4WithWorld<TInput1, TInput2, TInput3, TInput4, TWorld extends World>

Then5<TInput1, TInput2, TInput3, TInput4, TInput5>

Then5WithWorld<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>

ThenWithWorld<TWorld extends World>

When

When1<TInput1>

When1WithWorld<TInput1, TWorld extends World>

When2<TInput1, TInput2>

When2WithWorld<TInput1, TInput2, TWorld extends World>

When3<TInput1, TInput2, TInput3>

When3WithWorld<TInput1, TInput2, TInput3, TWorld extends World>

When4<TInput1, TInput2, TInput3, TInput4>

When4WithWorld<TInput1, TInput2, TInput3, TInput4, TWorld extends World>

When5<TInput1, TInput2, TInput3, TInput4, TInput5>

When5WithWorld<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>

WhenWithWorld<TWorld extends World>

WordParameterBase

WordParameterCamel

WordParameterLower

World

Enums

ExecutionOrder

MessageLevel

StepExecutionResult

Target

Mixins

AllReporters

This mixin allows you to create aggregating reporters.

Functions

and<TWorld extends World>(Pattern pattern, Future<void> onInvoke(StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

and1<TInput1, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

and2<TInput1, TInput2, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

and3<TInput1, TInput2, TInput3, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

and4<TInput1, TInput2, TInput3, TInput4, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

and5<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, TInput5 input5, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

but<TWorld extends World>(Pattern pattern, Future<void> onInvoke(StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

but1<TInput1, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

but2<TInput1, TInput2, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

but3<TInput1, TInput2, TInput3, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

but4<TInput1, TInput2, TInput3, TInput4, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

but5<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, TInput5 input5, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

given<TWorld extends World>(Pattern pattern, Future<void> onInvoke(StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

given1<TInput1, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

given2<TInput1, TInput2, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

given3<TInput1, TInput2, TInput3, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

given4<TInput1, TInput2, TInput3, TInput4, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

given5<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, TInput5 input5, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

step<TWorld extends World, TInput1, TInput2, TInput3, TInput4, TInput5>(Pattern pattern, int expectedParameterCount, Function onInvoke, {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

then<TWorld extends World>(Pattern pattern, Future<void> onInvoke(StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

then1<TInput1, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

then2<TInput1, TInput2, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

then3<TInput1, TInput2, TInput3, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

then4<TInput1, TInput2, TInput3, TInput4, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

then5<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, TInput5 input5, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

when<TWorld extends World>(Pattern pattern, Future<void> onInvoke(StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

when1<TInput1, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

when2<TInput1, TInput2, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

when3<TInput1, TInput2, TInput3, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

when4<TInput1, TInput2, TInput3, TInput4, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

when5<TInput1, TInput2, TInput3, TInput4, TInput5, TWorld extends World>(Pattern pattern, Future<void> onInvoke(TInput1 input1, TInput2 input2, TInput3 input3, TInput4 input4, TInput5 input5, StepContext<TWorld> context), {StepDefinitionConfiguration? configuration}) → StepDefinitionGeneric<TWorld>

Typedefs

ActionReport<T> = Future<void> Function([T? message])

CreateAttachmentManager = Future<AttachmentManager> Function(TestConfiguration config)

CreateWorld = Future<World> Function(TestConfiguration config)

FutureAction = Future<void> Function()

FutureValueAction<T> = Future<void> Function(T message)

ReportInvoke<T extends Reporter> = Future<void>? Function(T report)

Transformer<TValue> = TValue Function(String value)

VoidCallback = void Function()

WriteReportCallback = Future<void> Function(String report, String path)

Exceptions / Errors

GherkinDialogNotSupportedException

GherkinException

GherkinStepNotDefinedException

GherkinStepParameterMismatchException

GherkinSyntaxException

GherkinTestRunFailedException