Skip to content

Java based DSL for writing a User Story from which one can create multiple Scenarios with BDD acceptance tests

License

Notifications You must be signed in to change notification settings

mahlatsem/dumb-bdd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dumb-BDD (Dumb Behaviour Driven Development)

MIT licensed Coverage Status Codeship Status for mahlatsem/dumb_bdd

#What is BDD (Behaviour Driven Development)? Behaviour Driven Development is a software development process from Test Driven Development (TDD), popularized by a gentleman named Dan North.
With BDD, an application is specked & designed by describing how it should behave provided certain Test input.
Learn more about BDD from wikipedia.

#What is dumb-bdd? Dumb-bdd is a pure Java based DSL (domain specific language) that guides one to write a User Story from which one can create multiple Scenarios with acceptance tests following BDD without much thinking, used seamlessly with Testing framework of choice as it comes without any special runners, just have the dependency on your classpath and you are done. It also provides some plugin based reporting.

The User Story also helps you to make sure your classes follow the Single Responsibility Principle, because once you find a test method needing a different User Story, then you should move the functionality under test into a different class with its own test class.

#####Usage
You only need access to com.codecheck123.dumbbdd.dsl.UserStory and from there, your IDE will guide you through the rest. Compiled to Java 6, so you can still use with Anonymous classes, you should work on upgrading to Java 8
#####Example:

public class PostJDK8CalculatorTest {
	private int result = 0; //can't reassign a local variable in an anonymous class
	
//create the one User Story for the different Test Scenarios to follow
	private final UserStory userStory = new UserStory
		.WithTitle("Addition Subtraction Division & Multiplication")
			.asA("Math idiot")
			.iWant("to run math operations")
			.soThat("I can avoid silly mistakes")
			.create();

	@Before
	public void resetResult(){
		result = 0; //reset with every test method to be safe
	}
	
	@Test
	public void useAllBasicOperators(){
		final Calculator calculator = new Calculator();
		
	//use User Story to create a Scenario
		userStory.scenarioWithTitle("Use operators + - / *")
			.given("I want to add '50'", (args) -> {
				calculator.add(args.first().asInt());
			})
			.and("I want to minus '20'", (args) -> {
				calculator.minus(args.first().asInt());
			})
			.and("Multiply by '2' & divide by '4'", (args) -> {
				calculator.multiply(args.first().asInt());
				calculator.divide(args.second().asInt());
			})
			.and("I want to add '30'", (args) -> {
				calculator.add(args.first().asInt());
			})
			.when("I request Results", (args) -> {
				result = calculator.getResults();
			})
			.then("Results equals '45'", (args) -> {
				assertEquals(args.first().asInt(), result);
			});
	}
	
	@Test
	public void restartCalculation(){
		final Calculator cal = new Calculator();
		
	//use User Story to create another Scenario, one scenario per test method
		userStory.scenarioWithTitle("Reset calculator to start from scratch")
			.given("I want to add '25'", (args) -> {
				cal.add(args.first().asInt());
			})
			.and("I want to minus '5'", (args) -> {
				cal.minus(args.first().asInt());
			})
			.when("I reset the calculator", (args) -> {
				result = cal.multiply(1);
				assertEquals(result,20);
				cal.reset();
			})
			.then("Result must be '0'", (args) -> {
				result = cal.getResults();
				assertEquals(args.first().asInt(),result);
			});
	}
}

#####Reporting For default, check console, an HTMLReporter is work in progress, you may add your own ReporterService by implementing com.codecheck123.dumbbdd.report.service.ReporterService then have your service automatically loaded by the jdk ServiceLoader.

##Weird parts of Dumb-BDD

  1. As seen in the example above private int result = 0; the result variable used throughout your tests must be the Test class' instance member, because we can't assign a method local variable within an anonymous class, especially since we want to use the results from a when inside a then lambda.
  2. Although Testing for Exceptions continues as normal as per Test framework you use, the Scenario currently does not get reported on by Dumb-BDD, but your Test framework will still give you the expected results.

#Why Another BDD Tool? There is already a number of BDD tools in existence that may be used for Java, and although these have paved the way for BDD into the Java world for many years, they do come with their own set of frustrations.

Out of the major BDD tools, there are 4 approaches taken in providing BDD:

1. Using the power of dynamic programming languages

These are the likes of Spock & EasyB, using groovy to provide powerful DSLs. You have to introduce groovy, which is not that difficult but it is an extra added language just for testing, and depending on which IDE you use, groovy support may not be that great, otherwise these are great mature tools.

2. Text or HTML

The likes of JBehave & Cucumber where a plain Text file may be written by none-programmers and these are mapped to Java tests by developers, so maintenance may be tricky as it becomes an overheard for developers to maintain the specification, the mapping, and the tests themselves, if you manage to figure that part out, will work great for your organization.

The likes of Concordion use an Html based file for the specifications.

3. IDE Plugin based

An example worth mentioning is Jnario which is a fantastic well thought out Eclipse plugin (Jnario may also be used standalone). You may run into compatibility issues between the available Xtend and Jnario versions. Xtend is the powerful dynamic java dialect that makes all the magic Jnario does possible. Like most BDD tools, works great with Junit, apart from the compatibility issues and just the fact that you have to install Xtend support into your IDE, only problem is if you need to run your tests via another runner, like Arquillian if you do JavaEE, you will have to go deep to write the integration work in. If you can find your way past those issues, I highly recommend trying Jnario, it is beautiful and you have been warned!

4. Pure Java based

The Goals of these tools is to provide fluent APIs purely in Java. My current go to Javascript BDD tool is Jasmine, and the Java BDD tools lambda-behave and oleaster are both inspired by Jasmine and they are similar, lambda-behave has Quickcheck like automatically generated testcases functionality and that may make a big difference to some.
Again, they also both have their owner runners, so if you need to run your tests with another runner like Arquillian, you will have to help with that integration. They are also very developer focused which is great if you never need to share your BDD reports with other stakeholders but that is kinda of what is great about BDD, sharing BDD style reports with other stakeholders to avoid disconnect. And finally, these projects are Java 8 heavy, so you need to upgrade those legacy apps, rightfully so.

And finally, JGiven seems to have been inspired by the same frustrations that inspired Dumb-BDD. Apart from JGiven's greater maturity, it comes down to that subjective ease of syntax on the eyes, that is, a single builder pattern lamda expressions/anonymous class vs simple methods with a couple of underscores so that the method name reads like spoken language, I personally couldn't deal with the underscores hence even after I came across this project, I liked it but I was still unsatisfied, Again...highly subjective, that may work for you.

Dumb-BDD also provides Test inputs in spoken language via the BDD expression/description, inspired by Jnario & JBehave. see example above

##Goals for Dumb-BDD

  • Should be so simple that no thinking should be necessary to use the tool (see example above)
  • Should Not require a special IDE plugin
  • Should Not require learning another programming language
  • Should work effortlessly with existing test frameworks (e.g. Junit, TestNG) without requiring a special runner
  • Should Not require using any particular dependency manager or build tool
  • The Tests and the Specifications should be maintained in a single place to avoid a disconnect between the two
  • Should use a realistic maintenance process, maintained by developers, then the generated reports shared with other stakeholders
  • Syntax should be intuitive to Read [subjective...Yes!]

#Who Is Dumb-BDD Created For?

  • One that is just starting the habit of writing tests
  • One that has heard about BDD/TDD and wants to start applying it
  • One that has been frustrated by the number of extra tools & languages he/she has had to use to get BDD going in Java
  • One that is struggling to introduce BDD/TDD to their team
  • One that has enjoyed using BDD in a dynamic programming language
  • One that is about to give up on BDD/TDD

#Contribution Pull Requests are welcome

#License MIT - so use as you wish

About

Java based DSL for writing a User Story from which one can create multiple Scenarios with BDD acceptance tests

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages