This project illustrates the Serenity BDD reporting and living documentation features.

Git:

git clone https://github.com/wakaleo/serenity-banking-demo.git
cd serenity-banking-demo

Or simply download a zip file.

Open a command window and run:

mvn clean verify

This runs Cucumber features using Cucumber's JUnit runner. The @RunWith(CucumberWithSerenity.class) annotation on the CucumberTestSuite class tells JUnit to kick off Cucumber.

Open a command window and run:

gradlew test aggregate

This runs Cucumber features using Cucumber's JUnit runner. The @RunWith(CucumberWithSerenity.class) annotation on the CucumberTestSuite class tells JUnit to kick off Cucumber.

Both of the commands provided above will produce a Serenity test report in the target/site/serenity directory. Go take a look! Note that these tests contain deliberate errors and failures to illustate how Serenity reports errors.

You can learn more about the living documentation features of Serenity in the Serenity BDD Book.