Index

A B C D E F G I L M N P R S T V W
All Classes|All Packages

A

addScene(Scene) - Method in class net.tangly.bdd.engine.StoryRun

afterAll(ExtensionContext) - Method in class net.tangly.bdd.engine.StoryExtension

and(String, Consumer<Scene>) - Method in class net.tangly.bdd.Phase

and(String, Consumer<Scene>) - Method in class net.tangly.bdd.Scene

AND - Static variable in class net.tangly.bdd.engine.Constants

ands() - Method in class net.tangly.bdd.Phase

B

BDD_REPORTS_FOLDER - Static variable in class net.tangly.bdd.engine.Constants

beforeAll(ExtensionContext) - Method in class net.tangly.bdd.engine.StoryExtension

beforeEach(ExtensionContext) - Method in class net.tangly.bdd.engine.StoryExtension

C

CLASS_NAME - Static variable in class net.tangly.bdd.engine.Constants

clazz() - Method in class net.tangly.bdd.engine.StoryRun

Constants - Class in net.tangly.bdd.engine

JSON field identifiers used to generate a JSON representation of stories and features.

D

description() - Method in class net.tangly.bdd.engine.StoryRun

description() - Method in annotation type net.tangly.bdd.Feature

Returns the detailed description of the story as human readable information for living documentation.

description() - Method in class net.tangly.bdd.Scene

description() - Method in annotation type net.tangly.bdd.Story

Returns the detailed description of the story as human readable information for living documentation.

DESCRIPTION - Static variable in class net.tangly.bdd.engine.Constants

E

EXT - Static variable in class net.tangly.bdd.engine.Constants

F

Feature - Annotation Type in net.tangly.bdd

A feature or a story describes a behavior of the build system.

featureDescription() - Method in class net.tangly.bdd.engine.StoryRun

featureId() - Method in class net.tangly.bdd.engine.StoryRun

featureName() - Method in class net.tangly.bdd.engine.StoryRun

featureTags() - Method in class net.tangly.bdd.engine.StoryRun

findSceneByMethodName(String) - Method in class net.tangly.bdd.engine.StoryRun

G

get(String) - Method in class net.tangly.bdd.Scene

getOrCreateBddReportsFolder(Class<?>) - Static method in class net.tangly.bdd.engine.StoryWriter

given() - Method in class net.tangly.bdd.Scene

given(String, Consumer<Scene>) - Method in class net.tangly.bdd.Scene

GIVEN - Static variable in class net.tangly.bdd.engine.Constants

I

id() - Method in class net.tangly.bdd.engine.StoryRun

id() - Method in annotation type net.tangly.bdd.Feature

Returns the identifier of the feature.

id() - Method in annotation type net.tangly.bdd.Story

Returns the identifier of the story.

ID - Static variable in class net.tangly.bdd.engine.Constants

L

lambda() - Method in class net.tangly.bdd.Phase

M

merge(Path) - Method in class net.tangly.bdd.engine.StoryMerger

Merges all BDD reports in the given directory into one file.

METHOD_NAME - Static variable in class net.tangly.bdd.engine.Constants

methodName() - Method in class net.tangly.bdd.Scene

N

name() - Method in class net.tangly.bdd.engine.StoryRun

NAME - Static variable in class net.tangly.bdd.engine.Constants

net.tangly.bdd - module net.tangly.bdd

Provides classes for a programmer first behavior driven framework build on the features of Junit 5.

net.tangly.bdd - package net.tangly.bdd

The package provides the abstractions to write behaviour driven design tests based on JUnit 5.

net.tangly.bdd.engine - package net.tangly.bdd.engine

The package provides the implementation of a behaviour driven design library based on the extension model of JUnit 5.

P

PACKAGE_NAME - Static variable in class net.tangly.bdd.engine.Constants

packages() - Method in class net.tangly.bdd.engine.StoryRun

Phase - Class in net.tangly.bdd

Represents a phase in a scene such as a given, when or then phase for the acceptance test modeled within the scene.

Phase(String, Consumer<Scene>) - Constructor for class net.tangly.bdd.Phase

put(String, Object) - Method in class net.tangly.bdd.Scene

R

resolveParameter(ParameterContext, ExtensionContext) - Method in class net.tangly.bdd.engine.StoryExtension

Inject the previously created scene object into the test method.

run() - Method in class net.tangly.bdd.Scene

S

Scenario - Annotation Type in net.tangly.bdd

Represents a use case in a Story.

SCENARIOS - Static variable in class net.tangly.bdd.engine.Constants

Scene - Class in net.tangly.bdd

A scene is central to BDD or specification by example style of writing tests.

Scene(Method) - Constructor for class net.tangly.bdd.Scene

scenes() - Method in class net.tangly.bdd.engine.StoryRun

STORIES - Static variable in class net.tangly.bdd.engine.Constants

Story - Annotation Type in net.tangly.bdd

Represents a story in BDD or specification by example style of writing tests.

StoryAsciiDocPublisher - Class in net.tangly.bdd.engine

The publisher creates a AsciiDoc report of the behaviour driven design tests documentation generated as JSON during JUnit 5 runs.

StoryAsciiDocPublisher(Path, Path) - Constructor for class net.tangly.bdd.engine.StoryAsciiDocPublisher

StoryExtension - Class in net.tangly.bdd.engine

A custom extension that allow test authors to create and run behaviors and stories i.e.

StoryExtension() - Constructor for class net.tangly.bdd.engine.StoryExtension

StoryMerger - Class in net.tangly.bdd.engine

Merges a set of JSON files produced through the execution of BDD JUnit tests.

StoryMerger() - Constructor for class net.tangly.bdd.engine.StoryMerger

StoryRun - Class in net.tangly.bdd.engine

Recall that our custom extension generates BDD reports after executing the tests.

StoryRun(Class<?>) - Constructor for class net.tangly.bdd.engine.StoryRun

storyTags() - Method in class net.tangly.bdd.engine.StoryRun

StoryWriter - Class in net.tangly.bdd.engine

Writes the story with all executed scenarios in a JSON file.

StoryWriter(StoryRun) - Constructor for class net.tangly.bdd.engine.StoryWriter

supportsParameter(ParameterContext, ExtensionContext) - Method in class net.tangly.bdd.engine.StoryExtension

T

tags() - Method in annotation type net.tangly.bdd.Feature

Returns the tags associated with the feature.

tags() - Method in annotation type net.tangly.bdd.Story

Returns the tags associated with the feature.

TAGS - Static variable in class net.tangly.bdd.engine.Constants

text() - Method in class net.tangly.bdd.Phase

TEXT - Static variable in class net.tangly.bdd.engine.Constants

then() - Method in class net.tangly.bdd.Scene

then(String, Consumer<Scene>) - Method in class net.tangly.bdd.Scene

THEN - Static variable in class net.tangly.bdd.engine.Constants

V

value() - Method in annotation type net.tangly.bdd.Feature

Returns the name of the feature as human readable information for living documentation.

value() - Method in annotation type net.tangly.bdd.Scenario

Returns the description of the scenario as human readable information for living documentation.

value() - Method in annotation type net.tangly.bdd.Story

Returns the name of the story as human readable information for living documentation.

W

when() - Method in class net.tangly.bdd.Scene

when(String, Consumer<Scene>) - Method in class net.tangly.bdd.Scene

WHEN - Static variable in class net.tangly.bdd.engine.Constants

write(Path) - Method in class net.tangly.bdd.engine.StoryMerger

Writes the features to the provided file.

A B C D E F G I L M N P R S T V W
All Classes|All Packages