Releases: TNG/JGiven
v0.6.0
Major New Features
HTML5 Report
There is a new HTML5 report that is completely written from scratch. Instead of mutliple static HTML pages it only consists of a single HTML page that dynamically loads its content from a single jsonp file that contains the model of the scenario report. As a result the overall size of the generated files is much smaller. In addition, the new report is based on Foundation, which is a modern CSS framework, so the new report also looks much nicer then the old static one. One of the main new features is also that the HTML5 report has a full text search built in that works without having to open all scenarios in a single HTML page. As it heavily relies on JavaScript, don't expect that it works on old Browsers.
See the HTML5 Report of JGiven for an example.
Bug Fixes
- Core: An issue has been fixed where methods annotated with
@AfterStageand@AfterScenariocould accidentally appear in the report when they have been overriden and not annotated again. - Core: An issue has been fixed where methods annotated with
@AfterStageand@AfterScenariohave not been executed when an exception has been thrown (#46)
Breaking Changes
Non-public step methods appear in the report now
So far JGiven only reported public step methods. This behavior can lead to confusion, because it is not obvious that methods that are actually executed do not appear in the report. For this reason this behavior has been changed so that the visibility modifier is not taken into account anymore when reporting step methods.
How to migrate
If you have relied on the fact that non-public methods actually do not appear in the report, you can easily port your existing code by adding the @Hidden annotation to the corresponding method to explicitly state that the method should be hidden in the report.
Removed deprecated Schritte class (only used for German scenarios)
Use Stufe class instead
Removed @CasesAsTable annotation
As data tables are the default this annotation had no effect anymore, you can safely delete all usages.
Removed @ScenarioDescription annotation
The annotation is now just called @Description.
v0.5.4
v0.5.3
Minor new Features
- Text Report: Added status column to data tables #34
- HTML Report: Added expand all and collapse all buttons #37
Bug Fixes
- HTML Report: Correctly show status of failed scenarios where all steps have been successful #33
- HTML Report: Fix issue where in certain cases the content of a scenario was not expandable (no issue number)
v0.5.2
New Features
Core
- Step methods can now have extended descriptions with the
@ExtendedDescriptiontag. The extended description can be shown in the HTML report. #30
HTML Report
- The scenario content can now be searched
- A page with all scenarios is now generated
Bug Fixes
- Fixed bug concerning duplicate parameters in data tables #32
v0.5.1
v0.5.0
New Features
Derived Parameters #15
Derived parameters are parameters of step methods that are not directly passed to the scenario as a parameter, but are derived from them.
Consider the following example that tests that a simple calculator can add 1 to some input number:
@Test
@DataProvider( { "0", "1", "3" })
public void the_calculator_should_be_able_to_add_one(int input) {
given().a_calculator()
when().adding_$_and_$( input, 1 );
then().the_result_is( input + 1 );
}
The parameter of the last step the_result_is is not explicitly given as a parameter of the test method. Instead it is just derived from the input. In v0.4.0, JGiven would then not be able to generate a data table and fall back to print every case individually in the report.
In v0.5.0, JGiven will treat this derived parameter just like a normal parameter and will generate a data table for it. The name of the placeholder is then taken from parameter name of the step method. In addition, if an explicitly parameter is not used at all (but only derived values) it will not even appear in the data table.
Highlighting of case differences #14
If multiple cases of the same scenario are structurally different, JGiven cannot generate a data table for them. Instead each case is printed individually in the report. The problem is that the differences between the cases are often hard to spot. To help the reader, the differences are now highlighted in the HTML report.
Smaller enhancements
- Show number of cases in the scenario headline of the HTML report #26
- Elapsed time in HTML report should be shown in a convenient unit #24
- Test against different JUnit versions #22
Fixed Bugs
- JGiven creates null.json files for test classes where all tests are ignored #25
- Printed reports should not have collapsed scenarios #23
Backwards incompatible changes
JSON Model
- The JSON model has been changed to support #15.
This means that JSON models generated with v0.4.0 will not work with the report generator of v0.5.0.
This is in general no problem, because new JSON files are generated each time you execute your tests.
Release v0.4.0
- made scenarios and cases in HTML reports collapsible (Issue-#18)
- slightly changed layout and appearance of HTML reports
- measure duration of each step and include in reports (Issue-#13)
- scenarios are sorted by name in HTML reports
- fix issue with intercepting methods of stages during construction
- fix issue when multiple exceptions are thrown to throw the first one instead of the last one
@ScenarioDescriptionis now deprecated, instead just use@Description(Issue-#16)@Descriptionnow also works on test classes- fixed case generation for parameterized JUnit runner (Issue-#21)