messages.md

Cucumber Messages

Each message is an instance of Envelope. The Envelope message will only have one of its fields set, which indicates the payload of the message.

Attachment

Field	Type	Required	Description
body	string	yes
contentEncoding	AttachmentContentEncoding	yes
fileName	string	no
mediaType	string	yes
source	Source	no
testCaseStartedId	string	no
testStepId	string	no
url	string	no

Duration

Field	Type	Required	Description
seconds	integer	yes
nanos	integer	yes

Envelope

Field	Type	Required	Description
attachment	Attachment	no
gherkinDocument	GherkinDocument	no
hook	Hook	no
meta	Meta	no
parameterType	ParameterType	no
parseError	ParseError	no
pickle	Pickle	no
source	Source	no
stepDefinition	StepDefinition	no
testCase	TestCase	no
testCaseFinished	TestCaseFinished	no
testCaseStarted	TestCaseStarted	no
testRunFinished	TestRunFinished	no
testRunStarted	TestRunStarted	no
testStepFinished	TestStepFinished	no
testStepStarted	TestStepStarted	no
undefinedParameterType	UndefinedParameterType	no

Exception

Field	Type	Required	Description
type	string	yes
message	string	no
stackTrace	string	no

GherkinDocument

Field	Type	Required	Description
uri	string	no
feature	Feature	no
comments	Comment[]	yes

Background

Field	Type	Required	Description
location	Location	yes
keyword	string	yes
name	string	yes
description	string	yes
steps	Step[]	yes
id	string	yes

Comment

Field	Type	Required	Description
location	Location	yes
text	string	yes

DataTable

Field	Type	Required	Description
location	Location	yes
rows	TableRow[]	yes

DocString

Field	Type	Required	Description
location	Location	yes
mediaType	string	no
content	string	yes
delimiter	string	yes

Examples

Field	Type	Required	Description
location	Location	yes
tags	Tag[]	yes
keyword	string	yes
name	string	yes
description	string	yes
tableHeader	TableRow	no
tableBody	TableRow[]	yes
id	string	yes

Feature

Field	Type	Required	Description
location	Location	yes
tags	Tag[]	yes
language	string	yes
keyword	string	yes
name	string	yes
description	string	yes
children	FeatureChild[]	yes

FeatureChild

Field	Type	Required	Description
rule	Rule	no
background	Background	no
scenario	Scenario	no

Rule

Field	Type	Required	Description
location	Location	yes
tags	Tag[]	yes
keyword	string	yes
name	string	yes
description	string	yes
children	RuleChild[]	yes
id	string	yes

RuleChild

Field	Type	Required	Description
background	Background	no
scenario	Scenario	no

Scenario

Field	Type	Required	Description
location	Location	yes
tags	Tag[]	yes
keyword	string	yes
name	string	yes
description	string	yes
steps	Step[]	yes
examples	Examples[]	yes
id	string	yes

Step

Field	Type	Required	Description
location	Location	yes
keyword	string	yes
keywordType	StepKeywordType	no
text	string	yes
docString	DocString	no
dataTable	DataTable	no
id	string	yes

TableCell

Field	Type	Required	Description
location	Location	yes
value	string	yes

TableRow

Field	Type	Required	Description
location	Location	yes
cells	TableCell[]	yes
id	string	yes

Tag

Field	Type	Required	Description
location	Location	yes
name	string	yes
id	string	yes

Hook

Field	Type	Required	Description
id	string	yes
name	string	no
sourceReference	SourceReference	yes
tagExpression	string	no

Location

Field	Type	Required	Description
line	integer	yes
column	integer	no

Meta

Field	Type	Required	Description
protocolVersion	string	yes
implementation	Product	yes
runtime	Product	yes
os	Product	yes
cpu	Product	yes
ci	Ci	no

Ci

Field	Type	Required	Description
name	string	yes
url	string	no
buildNumber	string	no
git	Git	no

Git

Field	Type	Required	Description
remote	string	yes
revision	string	yes
branch	string	no
tag	string	no

Product

Field	Type	Required	Description
name	string	yes
version	string	no

ParameterType

Field	Type	Required	Description
name	string	yes
regularExpressions	string[]	yes
preferForRegularExpressionMatch	boolean	yes
useForSnippets	boolean	yes
id	string	yes
sourceReference	SourceReference	no

ParseError

Field	Type	Required	Description
source	SourceReference	yes
message	string	yes

Pickle

Field	Type	Required	Description
id	string	yes
uri	string	yes
name	string	yes
language	string	yes
steps	PickleStep[]	yes
tags	PickleTag[]	yes
astNodeIds	string[]	yes

PickleDocString

Field	Type	Required	Description
mediaType	string	no
content	string	yes

PickleStep

Field	Type	Required	Description
argument	PickleStepArgument	no
astNodeIds	string[]	yes
id	string	yes
type	PickleStepType	no
text	string	yes

PickleStepArgument

Field	Type	Required	Description
docString	PickleDocString	no
dataTable	PickleTable	no

PickleTable

Field	Type	Required	Description
rows	PickleTableRow[]	yes

PickleTableCell

Field	Type	Required	Description
value	string	yes

PickleTableRow

Field	Type	Required	Description
cells	PickleTableCell[]	yes

PickleTag

Field	Type	Required	Description
name	string	yes
astNodeId	string	yes

Source

Field	Type	Required	Description
uri	string	yes
data	string	yes
mediaType	SourceMediaType	yes

SourceReference

Field	Type	Required	Description
uri	string	no
javaMethod	JavaMethod	no
javaStackTraceElement	JavaStackTraceElement	no
location	Location	no

JavaMethod

Field	Type	Required	Description
className	string	yes
methodName	string	yes
methodParameterTypes	string[]	yes

JavaStackTraceElement

Field	Type	Required	Description
className	string	yes
fileName	string	yes
methodName	string	yes

StepDefinition

Field	Type	Required	Description
id	string	yes
pattern	StepDefinitionPattern	yes
sourceReference	SourceReference	yes

StepDefinitionPattern

Field	Type	Required	Description
source	string	yes
type	StepDefinitionPatternType	yes

TestCase

Field	Type	Required	Description
id	string	yes
pickleId	string	yes
testSteps	TestStep[]	yes

Group

Field	Type	Required	Description
children	Group[]	yes
start	integer	no
value	string	no

StepMatchArgument

Field	Type	Required	Description
group	Group	yes
parameterTypeName	string	no

StepMatchArgumentsList

Field	Type	Required	Description
stepMatchArguments	StepMatchArgument[]	yes

TestStep

Field	Type	Required	Description
hookId	string	no
id	string	yes
pickleStepId	string	no
stepDefinitionIds	string[]	no
stepMatchArgumentsLists	StepMatchArgumentsList[]	no

TestCaseFinished

Field	Type	Required	Description
testCaseStartedId	string	yes
timestamp	Timestamp	yes
willBeRetried	boolean	yes

TestCaseStarted

Field	Type	Required	Description
attempt	integer	yes
id	string	yes
testCaseId	string	yes
workerId	string	no
timestamp	Timestamp	yes

TestRunFinished

Field	Type	Required	Description
message	string	no
success	boolean	yes
timestamp	Timestamp	yes
exception	Exception	no

TestRunStarted

Field	Type	Required	Description
timestamp	Timestamp	yes

TestStepFinished

Field	Type	Required	Description
testCaseStartedId	string	yes
testStepId	string	yes
testStepResult	TestStepResult	yes
timestamp	Timestamp	yes

TestStepResult

Field	Type	Required	Description
duration	Duration	yes
message	string	no
status	TestStepResultStatus	yes
exception	Exception	no

TestStepStarted

Field	Type	Required	Description
testCaseStartedId	string	yes
testStepId	string	yes
timestamp	Timestamp	yes

Timestamp

Field	Type	Required	Description
seconds	integer	yes
nanos	integer	yes

UndefinedParameterType

Field	Type	Required	Description
expression	string	yes
name	string	yes

AttachmentContentEncoding

One of the following:

• "IDENTITY"
• "BASE64"

PickleStepType

One of the following:

• "Unknown"
• "Context"
• "Action"
• "Outcome"

SourceMediaType

One of the following:

• "text/x.cucumber.gherkin+plain"
• "text/x.cucumber.gherkin+markdown"

StepDefinitionPatternType

One of the following:

• "CUCUMBER_EXPRESSION"
• "REGULAR_EXPRESSION"

StepKeywordType

One of the following:

• "Unknown"
• "Context"
• "Action"
• "Outcome"
• "Conjunction"

TestStepResultStatus

One of the following:

• "UNKNOWN"
• "PASSED"
• "SKIPPED"
• "PENDING"
• "UNDEFINED"
• "AMBIGUOUS"
• "FAILED"