/
reporting_activities.spec.ts
272 lines (230 loc) · 12.5 KB
/
reporting_activities.spec.ts
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
import 'mocha';
import { expect } from '@integration/testing-tools';
import { Duration, StageManager } from '@serenity-js/core';
import {
ActivityRelatedArtifactArchived,
ActivityRelatedArtifactGenerated,
ArtifactArchived,
ArtifactGenerated,
SceneFinished,
SceneStarts,
TaskFinished,
TaskStarts,
TestRunFinishes,
} from '@serenity-js/core/lib/events';
import { Path } from '@serenity-js/core/lib/io';
import { ActivityDetails, ExecutionSuccessful, JSONData, Name, Photo, TextData, Timestamp } from '@serenity-js/core/lib/model';
import * as sinon from 'sinon';
import { SerenityBDDReporter } from '../../../../../src/stage';
import { SerenityBDDReport } from '../../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema';
import { given } from '../../given';
import { defaultCardScenario, photo } from '../../samples';
import { create } from '../create';
describe('SerenityBDDReporter', () => {
let stageManager: sinon.SinonStubbedInstance<StageManager>,
reporter: SerenityBDDReporter;
beforeEach(() => {
const env = create();
stageManager = env.stageManager;
reporter = env.reporter;
});
describe('when reporting activities that took place during scenario execution', () => {
/**
* @test {SerenityBDDReporter}
* @test {SceneStarts}
* @test {TaskStarts}
* @test {TaskFinished}
* @test {ExecutionSuccessful}
* @test {SceneFinished}
* @test {TestRunFinishes}
*/
it('reports the outcome of a single activity', () => {
const pickACard = new ActivityDetails(new Name('Pick the default credit card'));
given(reporter).isNotifiedOfFollowingEvents(
new SceneStarts(defaultCardScenario),
new TaskStarts(pickACard),
new TaskFinished(pickACard, new ExecutionSuccessful()),
new SceneFinished(defaultCardScenario, new ExecutionSuccessful()),
new TestRunFinishes(),
);
const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);
expect(report.testSteps).to.have.lengthOf(1);
expect(report.testSteps[0].description).to.equal(pickACard.name.value);
expect(report.testSteps[0].result).to.equal('SUCCESS');
});
it('ignores any activities that occurred after the scene has finished', () => {
const pickACard = new ActivityDetails(new Name('Pick the default credit card'));
given(reporter).isNotifiedOfFollowingEvents(
new SceneStarts(defaultCardScenario),
new SceneFinished(defaultCardScenario, new ExecutionSuccessful()),
// activities that occur outside of the scenario, i.e. in Mocha's `after` hook, should be ignored by this reporter
new TaskStarts(pickACard),
new TaskFinished(pickACard, new ExecutionSuccessful()),
new TestRunFinishes(),
);
const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);
expect(report.testSteps).to.have.lengthOf(0);
});
/**
* @test {SerenityBDDReporter}
* @test {SceneStarts}
* @test {TaskStarts}
* @test {TaskFinished}
* @test {ExecutionSuccessful}
* @test {SceneFinished}
* @test {TestRunFinishes}
*/
it('reports the outcome of a sequence of several activities', () => {
const pickACard = new ActivityDetails(new Name('Pick the default credit card'));
const makePayment = new ActivityDetails(new Name('Make the payment'));
given(reporter).isNotifiedOfFollowingEvents(
new SceneStarts(defaultCardScenario),
new TaskStarts(pickACard),
new TaskFinished(pickACard, new ExecutionSuccessful()),
new TaskStarts(makePayment),
new TaskFinished(makePayment, new ExecutionSuccessful()),
new SceneFinished(defaultCardScenario, new ExecutionSuccessful()),
new TestRunFinishes(),
);
const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);
expect(report.testSteps).to.have.lengthOf(2);
expect(report.testSteps[0].description).to.equal(pickACard.name.value);
expect(report.testSteps[0].result).to.equal('SUCCESS');
expect(report.testSteps[1].description).to.equal(makePayment.name.value);
expect(report.testSteps[1].result).to.equal('SUCCESS');
});
/**
* @test {SerenityBDDReporter}
* @test {SceneStarts}
* @test {TaskStarts}
* @test {TaskFinished}
* @test {ExecutionSuccessful}
* @test {SceneFinished}
* @test {TestRunFinishes}
*/
it('reports the outcome of nested activities', () => {
const pickACard = new ActivityDetails(new Name('Pick the default credit card'));
const viewListOfCards = new ActivityDetails(new Name('View the list of available cards'));
given(reporter).isNotifiedOfFollowingEvents(
new SceneStarts(defaultCardScenario),
new TaskStarts(pickACard),
new TaskStarts(viewListOfCards),
new TaskFinished(viewListOfCards, new ExecutionSuccessful()),
new TaskFinished(pickACard, new ExecutionSuccessful()),
new SceneFinished(defaultCardScenario, new ExecutionSuccessful()),
new TestRunFinishes(),
);
const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);
expect(report.testSteps).to.have.lengthOf(1);
expect(report.testSteps[0].children).to.have.lengthOf(1);
expect(report.testSteps[0].children[0].description).to.equal(viewListOfCards.name.value);
expect(report.testSteps[0].children[0].result).to.equal('SUCCESS');
});
});
describe('order of events', () => {
/**
* @test {SerenityBDDReporter}
* @test {SceneStarts}
* @test {TaskStarts}
* @test {ArtifactGenerated}
* @test {TaskFinished}
* @test {ExecutionSuccessful}
* @test {SceneFinished}
* @test {TestRunFinishes}
*/
it('records the events in a correct order', () => {
const pickACard = new ActivityDetails(new Name('Pick the default credit card'));
const t1 = new Timestamp(new Date(0));
const t2 = new Timestamp(new Date(10));
given(reporter).isNotifiedOfFollowingEvents(
new SceneStarts(defaultCardScenario),
new TaskStarts(pickACard),
new ActivityRelatedArtifactGenerated(pickACard, new Name('photo1'), photo),
new ActivityRelatedArtifactArchived(pickACard, new Name('photo1'), Photo, new Path('target/site/serenity/photo1.png'), t1),
new TaskFinished(pickACard, new ExecutionSuccessful()),
new ActivityRelatedArtifactGenerated(pickACard, new Name('photo2'), photo),
new ActivityRelatedArtifactArchived(pickACard, new Name('photo2'), Photo, new Path('target/site/serenity/photo2.png'), t2),
new SceneFinished(defaultCardScenario, new ExecutionSuccessful()),
new TestRunFinishes(),
);
const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);
expect(report.testSteps).to.have.lengthOf(1);
expect(report.testSteps[0].screenshots).to.deep.equal([
{ screenshot: 'photo1.png', timeStamp: t1.toMillisecondTimestamp() },
{ screenshot: 'photo2.png', timeStamp: t2.toMillisecondTimestamp() },
]);
});
/**
* @test {SerenityBDDReporter}
* @test {SceneStarts}
* @test {TaskStarts}
* @test {TaskFinished}
* @test {ExecutionSuccessful}
* @test {SceneFinished}
* @test {TestRunFinishes}
*/
it('records the order of test steps so that the Serenity BDD reporter can display the reportData in the correct context', () => {
const
pickACard = new ActivityDetails(new Name('Pick a credit card')),
makePayment = new ActivityDetails(new Name('Make a payment'));
given(reporter).isNotifiedOfFollowingEvents(
new SceneStarts(defaultCardScenario),
new TaskStarts(pickACard),
new ArtifactGenerated(new Name('pick a card message'), JSONData.fromJSON({ card: 'default' })),
new ArtifactArchived(new Name('pick a card message'), JSONData, new Path('target/site/serenity/pick-a-card-message-md5hash.json')),
new TaskFinished(pickACard, new ExecutionSuccessful()),
new TaskStarts(makePayment),
new ArtifactGenerated(new Name('make a payment message'), JSONData.fromJSON({ amount: '£42' })),
new ArtifactArchived(new Name('make a payment message'), JSONData, new Path('target/site/serenity/make-a-payment-message-md5hash.json')),
new ArtifactGenerated(new Name('server log'), TextData.fromJSON({ contentType: 'text/plain', data: 'received payment request' })),
new TaskFinished(makePayment, new ExecutionSuccessful()),
new SceneFinished(defaultCardScenario, new ExecutionSuccessful()),
new TestRunFinishes(),
);
const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);
expect(report.testSteps).to.have.lengthOf(2);
expect(report.testSteps[0].number).to.equal(1);
expect(report.testSteps[0].reportData[0].title).to.equal('pick a card message');
expect(report.testSteps[0].reportData[0].contents).to.equal('{\n "card": "default"\n}');
expect(report.testSteps[1].number).to.equal(2);
expect(report.testSteps[1].reportData[0].title).to.equal('make a payment message');
expect(report.testSteps[1].reportData[0].contents).to.deep.equal('{\n \"amount\": \"£42\"\n}');
expect(report.testSteps[1].reportData[1].title).to.equal('server log');
expect(report.testSteps[1].reportData[1].contents).to.deep.equal('received payment request');
});
});
describe('artifacts', () => {
/**
* @test {SerenityBDDReporter}
* @test {SceneStarts}
* @test {TaskStarts}
* @test {ArtifactGenerated}
* @test {TaskFinished}
* @test {ExecutionSuccessful}
* @test {SceneFinished}
* @test {TestRunFinishes}
*/
it('records the arbitrary JSON data emitted during the interaction', () => {
const pickACard = new ActivityDetails(new Name('Pick the default credit card'));
const t1 = new Timestamp(new Date(0));
const t2 = new Timestamp(new Date(10));
given(reporter).isNotifiedOfFollowingEvents(
new SceneStarts(defaultCardScenario),
new TaskStarts(pickACard),
new ActivityRelatedArtifactGenerated(pickACard, new Name('photo1'), photo),
new ActivityRelatedArtifactArchived(pickACard, new Name('photo1'), Photo, new Path('target/site/serenity/photo1.png'), t1),
new TaskFinished(pickACard, new ExecutionSuccessful()),
new ActivityRelatedArtifactGenerated(pickACard, new Name('photo2'), photo),
new ActivityRelatedArtifactArchived(pickACard, new Name('photo2'), Photo, new Path('target/site/serenity/photo2.png'), t2),
new SceneFinished(defaultCardScenario, new ExecutionSuccessful()),
new TestRunFinishes(),
);
const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);
expect(report.testSteps).to.have.lengthOf(1);
expect(report.testSteps[0].screenshots).to.deep.equal([
{ screenshot: 'photo1.png', timeStamp: t1.toMillisecondTimestamp() },
{ screenshot: 'photo2.png', timeStamp: t2.toMillisecondTimestamp() },
]);
});
});
});