Skip to content

Commit

Permalink
Support state objects requiring other state objects (#137)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Fryuni
Fryuni authored Nov 21, 2023
2 parents 1dc7a1a + 01dba4e commit d7315b2
Show file tree
Hide file tree
Showing 4 changed files with 373 additions and 12 deletions.
347 changes: 347 additions & 0 deletions cucumber-tsflow-specs/features/custom-context-objects.feature
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,350 @@ Feature: Custom context objects
Then it passes
And the output contains "The state is 'initial value'"
And the output contains "The state is 'step value'"

Scenario: Custom context objects can depend on other custom context objects two levels deep
Given a file named "features/a.feature" with:
"""feature
Feature: some feature
Scenario: scenario a
Given the state is "initial value"
When I set the state to "step value"
Then the state is "step value"
"""
And a file named "support/level-one-state.ts" with:
"""ts
import {binding} from 'cucumber-tsflow';
import {LevelTwoState} from './level-two-state';
@binding([LevelTwoState])
export class LevelOneState {
constructor(public levelTwoState: LevelTwoState) {
}
}
"""
And a file named "support/level-two-state.ts" with:
"""ts
export class LevelTwoState {
public value: string = "initial value";
}
"""
And a file named "step_definitions/one.ts" with:
"""ts
import {LevelTwoState} from '../support/level-two-state';
import {binding, when} from 'cucumber-tsflow';
@binding([LevelTwoState])
class Steps {
public constructor(private readonly levelTwoState: LevelTwoState) {
}
@when("I set the state to {string}")
public setState(newValue: string) {
this.levelTwoState.value = newValue;
}
}
export = Steps;
"""
And a file named "step_definitions/two.ts" with:
"""ts
import {LevelOneState} from '../support/level-one-state';
import {binding, then} from 'cucumber-tsflow';
import * as assert from 'node:assert';
@binding([LevelOneState])
class Steps {
public constructor(private readonly levelOneState: LevelOneState) {}
@then("the state is {string}")
public checkValue(value: string) {
console.log(`The state is '${this.levelOneState.levelTwoState.value}'`);
assert.equal(this.levelOneState.levelTwoState.value, value, "State value does not match");
}
}
export = Steps;
"""
When I run cucumber-js
Then it passes
And the output contains "The state is 'initial value'"
And the output contains "The state is 'step value'"

Scenario: Custom context objects can depend on other custom context objects three levels deep
Given a file named "features/a.feature" with:
"""feature
Feature: some feature
Scenario: scenario a
Given the state is "initial value"
When I set the state to "step value"
Then the state is "step value"
"""
And a file named "support/level-one-state.ts" with:
"""ts
import {binding} from 'cucumber-tsflow';
import {LevelTwoState} from './level-two-state';
@binding([LevelTwoState])
export class LevelOneState {
constructor(public levelTwoState: LevelTwoState) {
}
}
"""
And a file named "support/level-two-state.ts" with:
"""ts
import {binding} from 'cucumber-tsflow';
import {LevelThreeState} from './level-three-state';
@binding([LevelThreeState])
export class LevelTwoState {
constructor(public levelThreeState: LevelThreeState) {
}
}
"""
And a file named "support/level-three-state.ts" with:
"""ts
export class LevelThreeState {
public value: string = "initial value";
}
"""
And a file named "step_definitions/one.ts" with:
"""ts
import {LevelThreeState} from '../support/level-three-state';
import {binding, when} from 'cucumber-tsflow';
@binding([LevelThreeState])
class Steps {
public constructor(private readonly levelThreeState: LevelThreeState) {
}
@when("I set the state to {string}")
public setState(newValue: string) {
this.levelThreeState.value = newValue;
}
}
export = Steps;
"""
And a file named "step_definitions/two.ts" with:
"""ts
import {LevelOneState} from '../support/level-one-state';
import {binding, then} from 'cucumber-tsflow';
import * as assert from 'node:assert';
@binding([LevelOneState])
class Steps {
public constructor(private readonly levelOneState: LevelOneState) {}
@then("the state is {string}")
public checkValue(value: string) {
console.log(`The state is '${this.levelOneState.levelTwoState.levelThreeState.value}'`);
assert.equal(this.levelOneState.levelTwoState.levelThreeState.value, value, "State value does not match");
}
}
export = Steps;
"""
When I run cucumber-js
Then it passes
And the output contains "The state is 'initial value'"
And the output contains "The state is 'step value'"

Scenario: Circular dependencies are explicitly communicated to the developer
Given a file named "features/a.feature" with:
"""feature
Feature: some feature
Scenario: scenario a
Given the state is "initial value"
When I set the state to "step value"
Then the state is "step value"
"""
And a file named "support/state-one.ts" with:
"""ts
import {binding} from 'cucumber-tsflow';
import {StateTwo} from './state-two';
@binding([StateTwo])
export class StateOne {
constructor(public stateTwo: StateTwo) {
}
}
"""
And a file named "support/state-two.ts" with:
"""ts
import {StateOne} from './state-one';
import {binding} from 'cucumber-tsflow';
@binding([StateOne])
export class StateTwo {
public value: string = "initial value";
constructor(public stateOne: StateOne) {
}
}
"""
And a file named "step_definitions/one.ts" with:
"""ts
import {StateTwo} from '../support/state-two';
import {binding, when} from 'cucumber-tsflow';
@binding([StateTwo])
class Steps {
public constructor(private readonly stateTwo: StateTwo) {
}
@when("I set the state to {string}")
public setState(newValue: string) {
this.stateTwo.value = newValue;
}
}
export = Steps;
"""
And a file named "step_definitions/two.ts" with:
"""ts
import {StateOne} from '../support/state-one';
import {binding, then} from 'cucumber-tsflow';
import * as assert from 'node:assert';
@binding([StateOne])
class Steps {
public constructor(private readonly stateOne: StateOne) {}
@then("the state is {string}")
public checkValue(value: string) {
console.log(`The state is '${this.stateOne.stateTwo.value}'`);
assert.equal(this.stateOne.stateTwo.value, value, "State value does not match");
}
}
export = Steps;
"""
When I run cucumber-js
Then it fails
And the error output contains text:
"""
Undefined context type at index 0 for StateOne, do you possibly have a circular dependency?
"""


Scenario: Circular dependencies within the same file are vaguely communicated to the developer
Given a file named "features/a.feature" with:
"""feature
Feature: some feature
Scenario: scenario a
Given the state is "initial value"
When I set the state to "step value"
Then the state is "step value"
"""
And a file named "support/state.ts" with:
"""ts
import {binding} from 'cucumber-tsflow';
export class StateOne {
constructor(public stateTwo: StateTwo) { }
}
@binding([StateOne])
export class StateTwo {
public value: string = "initial value";
constructor(public stateOne: StateOne) { }
}
exports.StateOne = binding([StateTwo])(StateOne);
"""
And a file named "step_definitions/one.ts" with:
"""ts
import {StateTwo} from '../support/state';
import {binding, when} from 'cucumber-tsflow';
@binding([StateTwo])
class StepsOne {
public constructor(private readonly stateTwo: StateTwo) {
}
@when("I set the state to {string}")
public setState(newValue: string) {
this.stateTwo.value = newValue;
}
}
export = StepsOne;
"""
And a file named "step_definitions/two.ts" with:
"""ts
import {StateOne} from '../support/state';
import {binding, then} from 'cucumber-tsflow';
import * as assert from 'node:assert';
@binding([StateOne])
class StepsTwo {
public constructor(private readonly stateOne: StateOne) {}
@then("the state is {string}")
public checkValue(value: string) {
console.log(`The state is '${this.stateOne.stateTwo.value}'`);
assert.equal(this.stateOne.stateTwo.value, value, "State value does not match");
}
}
export = StepsTwo;
"""
When I run cucumber-js
Then it fails
And the error output contains text:
"""
Undefined context type at index 0 for StepsTwo, do you possibly have a circular dependency?
"""

Scenario: In-file circular dependencies are thrown as maximum call stack exceeded errors
Given a file named "features/a.feature" with:
"""feature
Feature: some feature
Scenario: scenario a
Given the state is "initial value"
When I set the state to "step value"
Then the state is "step value"
"""
And a file named "support/circular.ts" with:
"""ts
import {binding} from 'cucumber-tsflow';
export class StateOne {
constructor(public stateTwo: StateTwo) { }
}
@binding([StateOne])
export class StateTwo {
public value: string = "initial value";
constructor(public stateOne: StateOne) { }
}
exports.StateOne = binding([StateTwo])(StateOne);
"""
And a file named "step_definitions/one.ts" with:
"""ts
import {StateTwo} from '../support/circular';
import * as assert from 'node:assert';
import {binding, when, then} from 'cucumber-tsflow';
@binding([StateTwo])
class Steps {
public constructor(private readonly stateTwo: StateTwo) {
}
@when("I set the state to {string}")
public setState(newValue: string) {
this.stateTwo.value = newValue;
}
@then("the state is {string}")
public checkValue(value: string) {
console.log(`The state is '${this.stateTwo.value}'`);
assert.equal(this.stateTwo.value, value, "State value does not match");
}
}
export = Steps;
"""
When I run cucumber-js
Then it fails
And the output contains "RangeError: Maximum call stack size exceeded"
8 changes: 8 additions & 0 deletions cucumber-tsflow/src/binding-decorator.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,14 @@ export function binding(requiredContextTypes?: ContextType[]): TypeDecorator {
requiredContextTypes
);

if (Array.isArray(requiredContextTypes)) {
for (const i in requiredContextTypes) {
if (typeof requiredContextTypes[i] === 'undefined') {
throw new Error(`Undefined context type at index ${i} for ${target.name}, do you possibly have a circular dependency?`);
}
}
}

const allBindings: StepBinding[] = [
...bindingRegistry.getStepBindingsForTarget(target),
...bindingRegistry.getStepBindingsForTarget(target.prototype),
Expand Down
Loading

0 comments on commit d7315b2

Please sign in to comment.