JUnit associates an instance of its Description class with each test method (which correspond to steps in cucumber). The Description instance of a test method/step mainly contains a label for the test method/step when JUnit and the various runners out there want to represent it visually.
Unfortunately, JUnit also uses the Description as a key to keep track of the state of test methods, i.e. whether they have run, failed, were ignored and so on. Thus, each test method/cucumber step must have an associated Description that is not Java-equal to any other Description in the whole Suite. Otherwise runners will get confused and report on the wrong steps.
Even more unfortunately, Descriptions are Java-equal when the labels contained within them are Java-equal. It follows that even with the current implementation of cucumber's ExecutionUnitRunner.describeChild() method, when a step occurs twice in the same scenario, the two corresponding Description instances will be Java-equal.
I see two ways to proceed here:
I'm going to have a look at the second option on Monday. From a glance at the code it seems finding the index of a step within a scenario should be a one-liner.
If you cucumber guys are ok with that approach, I will see if I can fix it that way and provide a pull request for it.
Great analysis! I think the short term solution is to work around JUnit in Cucumber-JVM. Perhaps just prepending a counter. That will look a bit ugly, but it seems to be the only option for junit 4.10 and older.
When a new JUnit is out with a fix for this, we should keep the short term solution as well, so that people who happen to be on an older junit can still have this working. We could decide at runtime whether to use the workaround or not.
Thanks for looking into this. If you create a junit ticket/pullreq, please link to this so they get the context.
Fixed issue #211. JUnit Descriptions for steps now include the step n…
…umber within the enclosing scenario, making them unique.
Improved JUnit runner. Closes #107,#211,#216
Fixed by #216
Use unique JUnit descriptions. Fixes #225, #211