JGiven is a developer-friendly and pragmatic BDD tool for Java. Developers write scenarios in plain Java using a fluent, domain-specific API, JGiven generates reports that are readable by domain experts.
Behavior-Driven Development (BDD) is a development method where business analysts, developers, and testers describe the behavior of a software product in a common language and notation. Behavior is typically described in terms of scenarios, which are written in the Given-When-Then notation. The common language and notation is one cornerstone of BDD. The other cornerstone is that the defined scenarios are executable, form a comprehensive test suite, and a living documentation for the software product.
In classical BDD tools for Java like JBehave or Cucumber scenarios are written in plain text files. This allows non-developers to write scenarios, because no programming knowledge is required. To make scenarios executable, developers write so-called step-implementations. To bind plain text to step implementations regular expressions are used. For developers maintaining these executable scenarios has a high overhead that is not required if tests would be directly written in a programming language.
Beside the classical BDD tools there are a number of tools for Java to write BDD tests in a programming language like Groovy (easyb) or Scala (ScalaTest). To our knowledge, however, there is no BDD tool where scenarios can be written in plain Java.
Finally, there are specification testing frameworks like Spock (Groovy) or LambdaBehave which are very developer-centric and good for unit-testing, but the generated reports are not in Given-When-Then form and are not easily readable by non-developers.
- Scenarios are written in standard Java code using a fluent, domain-specific API (no extra language like Scala or Groovy needed, no IDE plugin needed)
- Java method names and parameters are parsed during test execution (no extra annotations needed)
- Scenarios are executed by either JUnit or TestNG (no extra test runner needed)
- Scenarios consist of so-called stages, which share state by injection, providing a modular way of writing Scenarios.
- JGiven generates scenario reports for business owners and domain experts
@Test
public void a_pancake_can_be_fried_out_of_an_egg_milk_and_flour() {
given().an_egg().
and().some_milk().
and().the_ingredient( "flour" );
when().the_cook_mangles_everything_to_a_dough().
and().the_cook_fries_the_dough_in_a_pan();
then().the_resulting_meal_is_a_pancake();
}The above test can be executed like any JUnit test. During the execution, JSON files are generated that can then be used afterwards to generated test reports. By default, a plain text report is shown in the console, which would look as follows:
Scenario: a pancake can be fried out of an egg milk and flour
Given an egg
And some milk
And the ingredient flour
When the cook mangles everything to a dough
And the cook fries the dough in a pan
Then the resulting meal is a pancake
In addition, you can generate a HTML Report.
Start by reading the documentation section on JGiven's website.
JGiven is published under the Apache License 2.0, see http://www.apache.org/licenses/LICENSE-2.0 for details.
After you have cloned the Git repository execute the following command to build and test JGiven:
./gradlew test
The following software is required for building and running the tests:
- JDK 1.6 (
JAVA_HOMEandPATHshould be set accordingly) - Gradle (is automatically downloaded by the
gradlewscript) - Bower (required for the HTML5 report generator, can be installed with
sudo npm install -g bower) - PhantomJS (required for the Selenium tests of the HTML5 report, can be installed under Ubuntu with
sudo apt-get install phantomjs)
- Fork the project
- Create a new feature branch with your contribution
- Implement your great new feature or bug fix
- Issue a pull request
Please follow the code format of existing code.
You can ensure this by using the provided Eclipse formatter develop/eclipse-formatter.xml.