-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
custom_formatter.feature
145 lines (125 loc) · 4.96 KB
/
custom_formatter.feature
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
Feature: custom formatter
Background:
Given a file named "features/a.feature" with:
"""
Feature: a feature
Scenario: a scenario
Given an undefined step
"""
Scenario: extending Formatter
Given a file named "simple_formatter.js" with:
"""
const { Formatter, formatterHelpers, Status } = require('@cucumber/cucumber')
class SimpleFormatter extends Formatter {
constructor(options) {
super(options)
options.eventBroadcaster.on('envelope', (envelope) => {
if (envelope.testCaseFinished) {
this.logTestCaseFinished(envelope.testCaseFinished)
} else if (envelope.testRunFinished) {
this.logTestRunFinished(envelope.testRunFinished)
}
})
}
logTestCaseFinished(testCaseFinished) {
const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(testCaseFinished.testCaseStartedId)
this.log(testCaseAttempt.gherkinDocument.feature.name + ' / ' + testCaseAttempt.pickle.name + '\n')
const parsed = formatterHelpers.parseTestCaseAttempt({
cwd: this.cwd,
snippetBuilder: this.snippetBuilder,
supportCodeLibrary: this.supportCodeLibrary,
testCaseAttempt
})
parsed.testSteps.forEach(testStep => {
this.log(' ' + testStep.keyword + (testStep.text || '') + ' - ' + Status[testStep.result.status] + '\n')
})
this.log('\n')
}
logTestRunFinished(testRunFinished) {
this.log(testRunFinished.success ? 'SUCCESS' : 'FAILURE')
}
}
module.exports = SimpleFormatter
"""
When I run cucumber-js with `--format ./simple_formatter.js`
Then it fails
And it outputs the text:
"""
a feature / a scenario
Given an undefined step - UNDEFINED
FAILURE
"""
Scenario: extending SummaryFormatter
Given a file named "features/a.feature" with:
"""
Feature: a feature
Scenario: a scenario
Given an undefined step
"""
And a file named "simple_formatter.js" with:
"""
const { SummaryFormatter, formatterHelpers, Status } = require('@cucumber/cucumber')
class SimpleFormatter extends SummaryFormatter {
constructor(options) {
super(options)
options.eventBroadcaster.on('envelope', (envelope) => {
if (envelope.testCaseFinished) {
this.logTestCaseFinished(envelope.testCaseFinished)
}
})
}
logTestCaseFinished(testCaseFinished) {
const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(testCaseFinished.testCaseStartedId)
this.log(testCaseAttempt.gherkinDocument.feature.name + ' / ' + testCaseAttempt.pickle.name + '\n')
const parsed = formatterHelpers.parseTestCaseAttempt({
cwd: this.cwd,
snippetBuilder: this.snippetBuilder,
supportCodeLibrary: this.supportCodeLibrary,
testCaseAttempt
})
parsed.testSteps.forEach(testStep => {
this.log(' ' + testStep.keyword + (testStep.text || '') + ' - ' + Status[testStep.result.status] + '\n')
})
this.log('\n')
}
}
module.exports = SimpleFormatter
"""
When I run cucumber-js with `--format ./simple_formatter.js`
Then it fails
And it outputs the text:
"""
a feature / a scenario
Given an undefined step - UNDEFINED
Failures:
1) Scenario: a scenario # features/a.feature:2
? Given an undefined step
Undefined. Implement with the following snippet:
Given('an undefined step', function () {
// Write code here that turns the phrase above into concrete actions
return 'pending';
});
1 scenario (1 undefined)
1 step (1 undefined)
<duration-stat>
"""
Scenario Outline: supported module formats
Given a file named "features/step_definitions/cucumber_steps.js" with:
"""
const {Given} = require('@cucumber/cucumber')
Given('an undefined step', function() {});
"""
And a file named "simple_formatter<EXT>" with:
"""
<IMPORT_STATEMENT>
class CustomFormatter extends Formatter {}
<EXPORT_STATEMENT>
"""
When I run cucumber-js with `--format ./simple_formatter<EXT>`
Then it passes
Examples:
| EXT | IMPORT_STATEMENT | EXPORT_STATEMENT |
| .ts | import {Formatter} from '@cucumber/cucumber' | export default CustomFormatter |
| .mjs | import {Formatter} from '@cucumber/cucumber' | export default CustomFormatter |
| .js | const {Formatter} = require('@cucumber/cucumber') | module.exports = CustomFormatter |
| .js | const {Formatter} = require('@cucumber/cucumber') | exports.default = CustomFormatter |