Skip to content

Add testRunStartedId #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 24, 2025
Merged

Add testRunStartedId #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
725e2d3
Add testRunStartedId
davidjgoss Jul 24, 2025
eac0b72
update exports
davidjgoss Jul 24, 2025
ba55ecd
update CHANGELOG.md
davidjgoss Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Added
- BREAKING CHANGE: Add `testRunStartedId` to `TestPlanIngredients` ([#3](https://github.com/cucumber/javascript-core/pull/3))

## [0.1.0] - 2025-07-24
### Added
Expand Down
1 change: 1 addition & 0 deletions cucumber-core.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ export interface TestPlanIngredients {
gherkinDocument: GherkinDocument;
pickles: ReadonlyArray<Pickle>;
supportCodeLibrary: SupportCodeLibrary;
testRunStartedId: string;
}

// @public
Expand Down
89 changes: 18 additions & 71 deletions src/makeTestPlan.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ function parseGherkin(

describe('makeTestPlan', () => {
class FakeWorld {}

const testRunStartedId = 'run-id'
let newId: () => string

beforeEach(() => {
Expand All @@ -51,6 +51,7 @@ describe('makeTestPlan', () => {

const result = makeTestPlan(
{
testRunStartedId,
gherkinDocument,
pickles,
supportCodeLibrary,
Expand All @@ -69,6 +70,7 @@ describe('makeTestPlan', () => {

const result = makeTestPlan(
{
testRunStartedId,
gherkinDocument,
pickles,
supportCodeLibrary,
Expand All @@ -86,11 +88,7 @@ describe('makeTestPlan', () => {
const supportCodeLibrary = buildSupportCode({ newId }).build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand All @@ -111,11 +109,7 @@ describe('makeTestPlan', () => {
const supportCodeLibrary = buildSupportCode({ newId }).build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
strategy: {
Expand Down Expand Up @@ -154,11 +148,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand All @@ -172,11 +162,7 @@ describe('makeTestPlan', () => {
const supportCodeLibrary = buildSupportCode({ newId }).build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand All @@ -201,11 +187,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -235,11 +217,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -269,11 +247,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -308,11 +282,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -359,11 +329,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -414,11 +380,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -484,11 +446,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -528,11 +486,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -566,11 +520,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -605,11 +555,7 @@ describe('makeTestPlan', () => {
.build()

const result = makeTestPlan(
{
gherkinDocument,
pickles,
supportCodeLibrary,
},
{ testRunStartedId, gherkinDocument, pickles, supportCodeLibrary },
{
newId,
}
Expand Down Expand Up @@ -657,6 +603,7 @@ describe('makeTestPlan', () => {
id: '10',
},
],
testRunStartedId,
},
},
])
Expand Down
3 changes: 2 additions & 1 deletion src/makeTestPlan.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export function makeTestPlan(
ingredients: TestPlanIngredients,
options: TestPlanOptions = {}
): AssembledTestPlan {
const { gherkinDocument, pickles, supportCodeLibrary } = ingredients
const { testRunStartedId, gherkinDocument, pickles, supportCodeLibrary } = ingredients
const {
newId = IdGenerator.uuid(),
strategy = namingStrategy(
Expand All @@ -61,6 +61,7 @@ export function makeTestPlan(
id: this.id,
pickleId: pickle.id,
testSteps: this.steps.map((step) => step.toMessage()),
testRunStartedId,
}
},
}
Expand Down
4 changes: 4 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,10 @@ export type MatchedStep = {
* @public
*/
export interface TestPlanIngredients {
/**
* Identifier for the test run within which this plan will be executed
*/
testRunStartedId: string
/**
* The Gherkin document that has been processed
*/
Expand Down
Loading