Skip to content

Commit 72bed7f

Browse files
davidjgossdavidjgoss
authored
Add new methods for attachments, hooks, meta (#67)
1 parent a27b1d0 commit 72bed7f

11 files changed

+927
-4
lines changed

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
66
and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
9+
### Added
10+
- New method `findAttachmentsBy(TestStepFinished)` ([#67](https://github.com/cucumber/query/pull/67))
11+
- New method `findHookBy(TestStep)` ([#67](https://github.com/cucumber/query/pull/67))
12+
- New method `findMeta()` ([#67](https://github.com/cucumber/query/pull/67))
13+
14+
### Fixed
15+
- [JavaScript] Attachments are not presumed to have a related test step ([#67](https://github.com/cucumber/query/pull/67))
916

1017
## [13.0.3] - 2024-12-22
1118
### Fixed

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,10 @@ status of a step, a scenario or an entire file.
5555
| `findAllTestCaseStarted(): List<TestCaseStarted>` | | | ✓ | | ✓ |
5656
| `findAllTestCaseStartedGroupedByFeature(): Map<Optional<Feature>, List<TestCaseStarted>>` | | | ✓ | | ✓ |
5757
| `findAllTestSteps(): List<TestStep>` | | | ✓ | | ✓ |
58+
| `findAttachmentsBy(TestStepFinished): List<Attachment>` | | | ✓ | | ✓ |
5859
| `findFeatureBy(TestCaseStarted): Optional<Feature>` | | | ✓ | | ✓ |
60+
| `findHookBy(TestStep): Optional<Hook>` | | | ✓ | | ✓ |
61+
| `findMeta(): Optional<Meta>` | | | ✓ | | ✓ |
5962
| `findMostSevereTestStepResulBy(TestCaseStarted): Optional<TestStepResult>` | | | ✓ | | ✓ |
6063
| `findNameOf(Pickle, NamingStrategy): String` | | | ✓ | | ✓ |
6164
| `findPickleBy(TestCaseStarted): Optional<Pickle>` | | | ✓ | | ✓ |

‎java/src/main/java/io/cucumber/query/Query.java

+41
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
package io.cucumber.query;
22

33
import io.cucumber.messages.Convertor;
4+
import io.cucumber.messages.types.Attachment;
45
import io.cucumber.messages.types.Envelope;
56
import io.cucumber.messages.types.Examples;
67
import io.cucumber.messages.types.Feature;
78
import io.cucumber.messages.types.GherkinDocument;
9+
import io.cucumber.messages.types.Hook;
10+
import io.cucumber.messages.types.Meta;
811
import io.cucumber.messages.types.Pickle;
912
import io.cucumber.messages.types.PickleStep;
1013
import io.cucumber.messages.types.Rule;
@@ -67,7 +70,10 @@ public final class Query {
6770
private final Map<String, Step> stepById = new ConcurrentHashMap<>();
6871
private final Map<String, TestStep> testStepById = new ConcurrentHashMap<>();
6972
private final Map<String, PickleStep> pickleStepById = new ConcurrentHashMap<>();
73+
private final Map<String, Hook> hookById = new ConcurrentHashMap<>();
74+
private final Map<String, List<Attachment>> attachmentsByTestCaseStartedId = new ConcurrentHashMap<>();
7075
private final Map<Object, Lineage> lineageById = new ConcurrentHashMap<>();
76+
private Meta meta;
7177
private TestRunStarted testRunStarted;
7278
private TestRunFinished testRunFinished;
7379

@@ -135,10 +141,29 @@ public List<TestStep> findAllTestSteps() {
135141
.collect(toList());
136142
}
137143

144+
public List<Attachment> findAttachmentsBy(TestStepFinished testStepFinished) {
145+
requireNonNull(testStepFinished);
146+
return attachmentsByTestCaseStartedId.getOrDefault(testStepFinished.getTestCaseStartedId(), emptyList()).stream()
147+
.filter(attachment -> attachment.getTestStepId()
148+
.map(testStepId -> testStepFinished.getTestStepId().equals(testStepId))
149+
.orElse(false))
150+
.collect(toList());
151+
}
152+
138153
public Optional<Feature> findFeatureBy(TestCaseStarted testCaseStarted) {
139154
return findLineageBy(testCaseStarted).flatMap(Lineage::feature);
140155
}
141156

157+
public Optional<Hook> findHookBy(TestStep testStep) {
158+
requireNonNull(testStep);
159+
return testStep.getHookId()
160+
.map(hookById::get);
161+
}
162+
163+
public Optional<Meta> findMeta() {
164+
return ofNullable(meta);
165+
}
166+
142167
public Optional<TestStepResult> findMostSevereTestStepResultBy(TestCaseStarted testCaseStarted) {
143168
requireNonNull(testCaseStarted);
144169
return findTestStepsFinishedBy(testCaseStarted)
@@ -330,6 +355,7 @@ public List<Entry<TestStepFinished, TestStep>> findTestStepFinishedAndTestStepBy
330355
}
331356

332357
public void update(Envelope envelope) {
358+
envelope.getMeta().ifPresent(this::updateMeta);
333359
envelope.getTestRunStarted().ifPresent(this::updateTestRunStarted);
334360
envelope.getTestRunFinished().ifPresent(this::updateTestRunFinished);
335361
envelope.getTestCaseStarted().ifPresent(this::updateTestCaseStarted);
@@ -338,6 +364,8 @@ public void update(Envelope envelope) {
338364
envelope.getGherkinDocument().ifPresent(this::updateGherkinDocument);
339365
envelope.getPickle().ifPresent(this::updatePickle);
340366
envelope.getTestCase().ifPresent(this::updateTestCase);
367+
envelope.getHook().ifPresent(this::updateHook);
368+
envelope.getAttachment().ifPresent(this::updateAttachment);
341369
}
342370

343371
private Optional<Lineage> findLineageBy(GherkinDocument element) {
@@ -382,6 +410,15 @@ private Optional<Lineage> findLineageBy(TestCaseStarted testCaseStarted) {
382410
.flatMap(this::findLineageBy);
383411
}
384412

413+
private void updateAttachment(Attachment attachment) {
414+
attachment.getTestCaseStartedId()
415+
.ifPresent(testCaseStartedId -> this.attachmentsByTestCaseStartedId.compute(testCaseStartedId, updateList(attachment)));
416+
}
417+
418+
private void updateHook(Hook hook) {
419+
this.hookById.put(hook.getId(), hook);
420+
}
421+
385422
private void updateTestCaseStarted(TestCaseStarted testCaseStarted) {
386423
this.testCaseStarted.add(testCaseStarted);
387424
}
@@ -437,6 +474,10 @@ private void updateSteps(List<Step> steps) {
437474
steps.forEach(step -> stepById.put(step.getId(), step));
438475
}
439476

477+
private void updateMeta(Meta event) {
478+
this.meta = event;
479+
}
480+
440481
private <K, E> BiFunction<K, List<E>, List<E>> updateList(E element) {
441482
return (key, existing) -> {
442483
if (existing != null) {

‎java/src/test/java/io/cucumber/query/QueryAcceptanceTest.java

+24
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import io.cucumber.messages.NdjsonToMessageIterable;
66
import io.cucumber.messages.types.Envelope;
77
import io.cucumber.messages.types.Feature;
8+
import io.cucumber.messages.types.Hook;
89
import io.cucumber.messages.types.Pickle;
910
import io.cucumber.messages.types.PickleStep;
1011
import io.cucumber.messages.types.Step;
@@ -31,6 +32,7 @@
3132
import java.util.List;
3233
import java.util.Map;
3334
import java.util.Objects;
35+
import java.util.Optional;
3436
import java.util.stream.Stream;
3537

3638
import static com.fasterxml.jackson.core.util.DefaultIndenter.SYSTEM_LINEFEED_INSTANCE;
@@ -50,7 +52,9 @@ public class QueryAcceptanceTest {
5052
static List<TestCase> acceptance() {
5153

5254
return Stream.of(
55+
Paths.get("../testdata/attachments.feature.ndjson"),
5356
Paths.get("../testdata/empty.feature.ndjson"),
57+
Paths.get("../testdata/hooks.feature.ndjson"),
5458
Paths.get("../testdata/minimal.feature.ndjson"),
5559
Paths.get("../testdata/rules.feature.ndjson"),
5660
Paths.get("../testdata/examples-tables.feature.ndjson")
@@ -111,10 +115,29 @@ private static Map<String, Object> createQueryResults(Query query) {
111115
.map(entry -> Arrays.asList(entry.getKey().map(Feature::getName), entry.getValue().stream()
112116
.map(TestCaseStarted::getId)
113117
.collect(toList()))));
118+
results.put("findAttachmentsBy", query.findAllTestCaseStarted().stream()
119+
.map(query::findTestStepFinishedAndTestStepBy)
120+
.flatMap(Collection::stream)
121+
.map(Map.Entry::getKey)
122+
.map(query::findAttachmentsBy)
123+
.flatMap(Collection::stream)
124+
.map(attachment -> Arrays.asList(
125+
attachment.getTestStepId(),
126+
attachment.getTestCaseStartedId(),
127+
attachment.getMediaType(),
128+
attachment.getContentEncoding()
129+
))
130+
.collect(toList()));
114131
results.put("findFeatureBy", query.findAllTestCaseStarted().stream()
115132
.map(query::findFeatureBy)
116133
.map(feature -> feature.map(Feature::getName))
117134
.collect(toList()));
135+
results.put("findHookBy", query.findAllTestSteps().stream()
136+
.map(query::findHookBy)
137+
.map(hook -> hook.map(Hook::getId))
138+
.filter(Optional::isPresent)
139+
.collect(toList()));
140+
results.put("findMeta", query.findMeta().map(meta -> meta.getImplementation().getName()));
118141
results.put("findMostSevereTestStepResultBy", query.findAllTestCaseStarted().stream()
119142
.map(query::findMostSevereTestStepResultBy)
120143
.map(testStepResult -> testStepResult.map(TestStepResult::getStatus))
@@ -146,6 +169,7 @@ private static Map<String, Object> createQueryResults(Query query) {
146169
results.put("findPickleStepBy", query.findAllTestSteps().stream()
147170
.map(query::findPickleStepBy)
148171
.map(pickleStep -> pickleStep.map(PickleStep::getText))
172+
.filter(Optional::isPresent)
149173
.collect(toList()));
150174
results.put("findStepBy", query.findAllPickleSteps().stream()
151175
.map(query::findStepBy)

‎javascript/src/Query.ts

+39-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
import * as messages from '@cucumber/messages'
22
import {
3+
Attachment,
34
Duration,
45
Feature,
56
getWorstTestStepResult,
67
GherkinDocument,
8+
Hook,
9+
Meta,
710
Pickle,
811
PickleStep,
912
Rule,
@@ -18,7 +21,7 @@ import {
1821
TestStepFinished,
1922
TestStepResult,
2023
TestStepResultStatus,
21-
TimeConversion
24+
TimeConversion,
2225
} from '@cucumber/messages'
2326
import {ArrayMultimap} from '@teppeis/multimaps'
2427
import {Lineage, NamingStrategy} from "./Lineage";
@@ -45,6 +48,7 @@ export default class Query {
4548
readonly messages.StepMatchArgumentsList[]
4649
>()
4750

51+
private meta: Meta
4852
private testRunStarted: TestRunStarted
4953
private testRunFinished: TestRunFinished
5054
private readonly testCaseStarted: Array<TestCaseStarted> = []
@@ -57,8 +61,13 @@ export default class Query {
5761
private readonly testCaseFinishedByTestCaseStartedId: Map<string, TestCaseFinished> = new Map()
5862
private readonly testStepFinishedByTestCaseStartedId: ArrayMultimap<string, TestStepFinished> =
5963
new ArrayMultimap()
64+
private readonly attachmentsByTestCaseStartedId: ArrayMultimap<string, Attachment> =
65+
new ArrayMultimap()
6066

6167
public update(envelope: messages.Envelope) {
68+
if (envelope.meta) {
69+
this.meta = envelope.meta
70+
}
6271
if (envelope.gherkinDocument) {
6372
this.updateGherkinDocument(envelope.gherkinDocument)
6473
}
@@ -78,7 +87,7 @@ export default class Query {
7887
this.updateTestCaseStarted(envelope.testCaseStarted)
7988
}
8089
if (envelope.attachment) {
81-
this.attachmentsByTestStepId.put(envelope.attachment.testStepId, envelope.attachment)
90+
this.updateAttachment(envelope.attachment)
8291
}
8392
if (envelope.testStepFinished) {
8493
this.updateTestStepFinished(envelope.testStepFinished)
@@ -201,6 +210,15 @@ export default class Query {
201210
}
202211
}
203212

213+
private updateAttachment(attachment: Attachment) {
214+
if (attachment.testStepId) {
215+
this.attachmentsByTestStepId.put(attachment.testStepId, attachment)
216+
}
217+
if (attachment.testCaseStartedId) {
218+
this.attachmentsByTestCaseStartedId.put(attachment.testCaseStartedId, attachment)
219+
}
220+
}
221+
204222
private updateTestStepFinished(testStepFinished: TestStepFinished) {
205223
this.testStepFinishedByTestCaseStartedId.put(
206224
testStepFinished.testCaseStartedId,
@@ -420,10 +438,26 @@ export default class Query {
420438
return testSteps.sort(comparatorById)
421439
}
422440

441+
public findAttachmentsBy(testStepFinished: TestStepFinished): ReadonlyArray<Attachment> {
442+
return this.attachmentsByTestCaseStartedId.get(testStepFinished.testCaseStartedId)
443+
.filter(attachment => attachment.testStepId === testStepFinished.testStepId)
444+
}
445+
423446
public findFeatureBy(testCaseStarted: TestCaseStarted): Feature | undefined {
424447
return this.findLineageBy(testCaseStarted)?.feature
425448
}
426449

450+
public findHookBy(testStep: TestStep): Hook | undefined {
451+
if (!testStep.hookId){
452+
return undefined
453+
}
454+
return this.hooksById.get(testStep.hookId)
455+
}
456+
457+
public findMeta(): Meta | undefined {
458+
return this.meta;
459+
}
460+
427461
public findMostSevereTestStepResultBy(testCaseStarted: TestCaseStarted): TestStepResult | undefined {
428462
return this.findTestStepFinishedAndTestStepBy(testCaseStarted)
429463
.map(([testStepFinished]) => testStepFinished.testStepResult)
@@ -443,7 +477,9 @@ export default class Query {
443477
}
444478

445479
public findPickleStepBy(testStep: TestStep): PickleStep | undefined {
446-
assert.ok(testStep.pickleStepId, 'Expected TestStep to have a pickleStepId')
480+
if (!testStep.pickleStepId){
481+
return undefined
482+
}
447483
return this.pickleStepById.get(testStep.pickleStepId)
448484
}
449485

‎javascript/src/acceptance.spec.ts

+22-1
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,24 @@ describe('Acceptance Tests', async () => {
6060
findAllTestSteps: query.findAllTestSteps().length,
6161
findAllTestCaseStartedGroupedByFeature: [...query.findAllTestCaseStartedGroupedByFeature().entries()]
6262
.map(([feature, testCaseStarteds]) => [feature.name, testCaseStarteds.map(testCaseStarted => testCaseStarted.id)]),
63+
findAttachmentsBy: query.findAllTestCaseStarted()
64+
.map(testCaseStarted => query.findTestStepsFinishedBy(testCaseStarted))
65+
.map(testStepFinisheds => testStepFinisheds.map(testStepFinished => query.findAttachmentsBy(testStepFinished)))
66+
.flat(2)
67+
.map(attachment => ([
68+
attachment.testStepId,
69+
attachment.testCaseStartedId,
70+
attachment.mediaType,
71+
attachment.contentEncoding,
72+
])),
6373
findFeatureBy: query.findAllTestCaseStarted()
6474
.map(testCaseStarted => query.findFeatureBy(testCaseStarted))
6575
.map(feature => feature?.name),
76+
findHookBy: query.findAllTestSteps()
77+
.map(testStep => query.findHookBy(testStep))
78+
.map(hook => hook?.id)
79+
.filter(value => !!value),
80+
findMeta: query.findMeta()?.implementation?.name,
6681
findMostSevereTestStepResultBy: query.findAllTestCaseStarted()
6782
.map(testCaseStarted => query.findMostSevereTestStepResultBy(testCaseStarted))
6883
.map(testStepResult => testStepResult?.status),
@@ -78,7 +93,8 @@ describe('Acceptance Tests', async () => {
7893
.map(pickle => pickle?.name),
7994
findPickleStepBy: query.findAllTestSteps()
8095
.map(testStep => query.findPickleStepBy(testStep))
81-
.map(pickleStep => pickleStep?.text),
96+
.map(pickleStep => pickleStep?.text)
97+
.filter(value => !!value),
8298
findStepBy: query.findAllPickleSteps()
8399
.map(pickleStep => query.findStepBy(pickleStep))
84100
.map(step => step?.text),
@@ -118,7 +134,9 @@ interface ResultsFixture {
118134
findAllTestCaseStarted: number,
119135
findAllTestSteps: number,
120136
findAllTestCaseStartedGroupedByFeature: Array<[string, string[]]>,
137+
findAttachmentsBy: Array<[string, string, string, string]>,
121138
findFeatureBy: Array<string>,
139+
findMeta: string,
122140
findMostSevereTestStepResultBy: Array<TestStepResultStatus>,
123141
findNameOf: {
124142
long: Array<string>,
@@ -127,6 +145,7 @@ interface ResultsFixture {
127145
short: Array<string>,
128146
shortPickleName: Array<string>
129147
},
148+
findHookBy: Array<string>,
130149
findPickleBy: Array<string>,
131150
findPickleStepBy: Array<string>,
132151
findStepBy: Array<string>,
@@ -143,6 +162,7 @@ interface ResultsFixture {
143162

144163
const defaults: Partial<ResultsFixture> = {
145164
findAllTestCaseStartedGroupedByFeature: [],
165+
findAttachmentsBy: [],
146166
findFeatureBy: [],
147167
findMostSevereTestStepResultBy: [],
148168
findNameOf: {
@@ -152,6 +172,7 @@ const defaults: Partial<ResultsFixture> = {
152172
short: [],
153173
shortPickleName: []
154174
},
175+
findHookBy: [],
155176
findPickleBy: [],
156177
findPickleStepBy: [],
157178
findStepBy: [],

0 commit comments

Comments
 (0)