https://github.com/TNG/JGiven
Behavior-Driven Development in plain Java
https://github.com/TNG/JGiven
bdd behavior-driven-development java jgiven tdd test-automation test-driven-development
Last synced: 8 months ago
JSON representation
Behavior-Driven Development in plain Java
- Host: GitHub
- URL: https://github.com/TNG/JGiven
- Owner: TNG
- License: apache-2.0
- Created: 2014-04-11T06:10:24.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T18:44:52.000Z (over 1 year ago)
- Last Synced: 2024-05-23T01:39:29.647Z (over 1 year ago)
- Topics: bdd, behavior-driven-development, java, jgiven, tdd, test-automation, test-driven-development
- Language: Java
- Homepage: http://jgiven.org
- Size: 37 MB
- Stars: 431
- Watchers: 17
- Forks: 100
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-java - JGiven
README
[](https://github.com/TNG/JGiven/actions/workflows/jgiven_branch_and_pr_build.yml)
[](https://coveralls.io/r/TNG/JGiven?branch=master)
[](http://opensource.org/licenses/Apache-2.0)
[](https://maven-badges.herokuapp.com/maven-central/com.tngtech.jgiven/jgiven-junit)
[](https://gitter.im/TNG/JGiven?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://javadoc.io/doc/com.tngtech.jgiven/jgiven-core)
[](https://www.codetriage.com/tng/jgiven)
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.
## Why another BDD tool?
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](https://jbehave.org) or [Cucumber](https://cukes.info) 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](http://easyb.org)) or Scala ([ScalaTest](http://www.scalatest.org)). 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](https://spock.org) (Groovy) or [LambdaBehave](https://richardwarburton.github.io/lambda-behave/) 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.
## BDD with JGiven
* 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
## Example
```Java
@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 generate 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 an [HTML Report](https://jgiven.org/jgiven-report/html5/).
## Getting Started
1. Start by reading the [documentation](https://jgiven.org/docs/) section on JGiven's website.
2. See the [talk](https://www.youtube.com/watch?v=gh_yjb3x8Yc) on JGiven held on the TNG Big Techday 8
## License
JGiven is published under the Apache License 2.0, see
https://www.apache.org/licenses/LICENSE-2.0 for details.
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md)