Add pretty formatter #57

Closed
wants to merge 1 commit into
from

Projects

None yet

2 participants

@renier
renier commented Apr 10, 2012

This adds a pretty formatter to cucumber-js. It makes some changes to the Core API to enable traversing from the feature object down to the steps with their step results. Tests for this are in another commit that will be part of another pull request.

@jbpros
Member
jbpros commented Apr 10, 2012

Thank you Renier.

I'd like to keep the AST (abstract syntax tree) decoupled from the execution, the results and therefore keep it stateless. What I mean by that is the execution results are not supposed to be stored on AST objects. In other terms, a tree should be able to be visited (executed) more than once.

Practically, Cucumber.Ast.Step should know nothing about StepResult objects.

Let's do some BDD here ... :)

Outcome: The formatter should be able to display the step name/contents related to a step result, when it receives one.

Context: Step results currently have no link to their parent step.

Actions/Options:

  1. As a step result event always follow its step event, the formatter could store the current step and build a step/result pair to a local map when the result event is caught. This is easy but the day we introduce parallel scenario execution (if we do someday :)) things will go wrong.
  2. Accept the step object as a parameter to SupportCode.StepDefinition#invoke() and attach the step to the step result when it's instantiated. This would be robust and it makes a lot of sense, IMO.

WDYT?

@renier
renier commented Apr 13, 2012

Hi Julien,

I think that the AST objects remembering the last result for that object, if there was any, does not prevent the tree from being executed/visited more than once.

However, I see nothing wrong with your proposal of instead feeding the AST object into the step result. I'll have to look at the code again with that idea in mind and see if there are any problems. If not, it should not be hard to refactor.

@jbpros
Member
jbpros commented Apr 13, 2012

Hi Renier,

I'm almost done implementing the second solution. 6b58ca2

I'll finish that today I think.

@jbpros jbpros added a commit that referenced this pull request Apr 13, 2012
@jbpros jbpros Store step on step results (#57)
- The parent step is now available on all types of step results
- Step results "inherit" from a base step result object (extraction refactoring)
aa27ab1
@jbpros
Member
jbpros commented Apr 13, 2012

@renier you can now call stepResult.getStep() on any kind of step result.

@renier renier closed this Apr 17, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment