Portability	portable
Stability	unstable
Maintainer	Marco Túlio Pimenta Gontijo <marcotmarcot@gmail.com>
Safe Haskell	Safe-Infered

Language.Abacate.Types

Description

Synopsis

Documentation

type Abacate = Feature Source

An Abacate file contains exactly one feature.

data Feature Source

For a more detailed description of features, check https://github.com/cucumber/cucumber/wiki/Feature-Introduction.

Constructors

Feature
Fields fBegComment :: Comment fTags :: Tags fHeader :: Header fBackground :: Maybe Background fFeatureElements :: FeatureElements fEndComment :: Comment

Instances

Eq Feature
Show Feature

type Header = Text Source

The Header contains the title and description of the Feature. It is usually on the format:

 Feature: TITLE
   DESCRIPTION LINE 1
   DESCRIPTION LINE 2

type FeatureElements = [FeatureElement]Source

data FeatureElement Source

A FeatureElement is simply a Scenario or a ScenarioOutline.

Constructors

FES Scenario
FESO ScenarioOutline

Instances

Eq FeatureElement
Show FeatureElement

data Scenario Source

The Scenario contains a list of Steps.

Constructors

Scenario
Fields scTags :: Tags scBasicScenario :: BasicScenario

Instances

Eq Scenario
Show Scenario

data ScenarioOutline Source

The Steps of the ScenarioOutline can contain placeholders which are substituted by the fields of the ExamplesSection. For more information on the ScenarioOutline check https://github.com/cucumber/cucumber/wiki/Scenario-outlines.

Constructors

ScenarioOutline
Fields soExamplesSection :: ExamplesSection soScenario :: Scenario

Instances

Eq ScenarioOutline
Show ScenarioOutline

type Background = BasicScenario Source

The Background is basically a Scenario without Tags. It's used to create a context for the other Scenarios to run, and a Feature can only have one Background. For more information on the Background check https://github.com/cucumber/cucumber/wiki/Background.

data BasicScenario Source

This is the basic type for Scenario, ScenarioOutline and Background.

Constructors

BasicScenario
Fields bsComment :: Comment bsName :: Text bsSteps :: Steps

Instances

Eq BasicScenario
Show BasicScenario

type Tags = [Tag]Source

type Tag = Text Source

A Tag is a textual element started with @.

type Comment = Text Source

type Steps = [Step]Source

data Step Source

For more information on Steps check https://github.com/cucumber/cucumber/wiki/Given-When-Then.

Constructors

Step
Fields stComment :: Comment stStepKeyword :: StepKeyword stBody :: Text stMultilineArg :: Maybe MultilineArg

Instances

Eq Step
Show Step

type ExamplesSection = [Examples]Source

data Examples Source

The Examples are used to fill the value of placeholders on ScenarioOutlines.

Constructors

Examples
Fields eComment :: Comment eName :: Text eTable :: Table

Instances

Eq Examples
Show Examples

data MultilineArg Source

Steps can have multi-line arguments. For more information check https://github.com/cucumber/cucumber/wiki/Multiline-Step-Arguments.

Constructors

MAT Table
MAPS PyString

Instances

Eq MultilineArg
Show MultilineArg

type PyString = Text Source

type Table = [Row]Source

type Row = [Cell]Source

type Cell = Text Source

data StepKeyword Source

Constructors

Given
When
Then
And
But

Instances

Bounded StepKeyword
Enum StepKeyword
Eq StepKeyword
Read StepKeyword
Show StepKeyword