Test Driven Development
|Title||Test Driven Development (TDD) Introduction using Java in Eclipse/JUnit|
|Overview||Students will follow and implement a beginner level java-based Test Driven Development (TDD) approach with JUnit in the Eclipse IDE. First, they create a test case that fails, then they start creating mock code, and finally a simple piece of code that allows their test to pass.|
|Prerequisite Knowledge|| Students should be familiar with:
|Learning Objectives|| Upon completion, students should be able to:
Is there background reading material?
It is assumed, as per the prerequisites above, that students have already learned about TDD. However, if teacher or students need some content to start on, the best quick dummies guide would be this YouTube video summarizing TDD, and this graphical explanation of the TDD process. If you want more extensive TDD learning content, check out Kent Becks "Test-Driven Development by Example". He is the inventor of TDD and wrote JUnit, the focus of this exercise. Additionally, see how a CalPoly and College of Charleston class used TDD in their studies. For more resources, and ideas on secondary TDD exercises, see the Appendix of this page.
What is the rationale for this activity?
The method of how developers go about implementing code is varied. Test driven development is one such method stemming in the 2000's that has gained momentum as an accepted and research-proven method for increasing software quality, readability, and reliability. Testing software to assure that it works within particular constraints is an extension of quality assurance (QA) efforts that most professional software products enact to increase their products value. With TDD, this testing is built-in even before students write their first line of code. This means that students will have a better grasp on what they are programming and why. It means that students will have code that not only works when they first implement it, but that will continue to work when others develop next to it and run the same tests.
This activity follows a tutorial that steps you through the TDD development process in the Eclipse IDE using its integrated JUnit module. Follow the below tutorials while implementing the TDD test code in Eclipse on your own computer. Finally, you will create standard functional code that gets the tests to succeed (green JUnit bar). You will hand in this code, the associated test code, and two screenshots.
Step 1: Setup Eclipse and JUnit
First, you will need to setup and understand your coding environment. If you have not setup the Eclipse IDE for java before, read through some of the below links. You need to be able to run code and tests with the IDE. There can be some unexpected "gotchas".
- Download and install Eclipse - JUnit comes with "Eclipse IDE for Java Developers"
- Become familiar with the Eclipse Workbench and in Running code - there is a built-in Eclipse Help Guide, as well as 3rd party tutorials.
- If you get stuck on anything:
- Watch How to Create and Run a Simple JUnit test in Eclipse IDE.
- Try the tips in the Comments section below if you get really stuck.
- Start a new Java Project and include your own name in the 'Project name' field.
- Ex: "NumberCounter-NYeates"
Step 2: Make the test
As per TDD you will write a failing test first, before writing any real code that achieves your purpose. The meat of this activity is in the Code Affine tutorial below:
- It is an illustrated step-by-step walk through of creating a test and then creating the associated System Under Test (SUT) code (the code which implements the functionality that you actually want).
- Create a file called "NumberRangeCounterTest.java" to put the test code into.
- Create a separate file called "NumberRangeCounter.java" to put the skeleton SUT code into.
- Implement the test class code and the skeleton SUT code found in the tutorial and get a failing test.
- You will be marked up for commenting your code.
- Take a screenshot of the failing test (red JUnit bar) and code.
Step 3: Write the code
You should now have a test case that fails and a stub/skeleton for the System Under Test (SUT) code. Now, you need to make the test succeed. This means implementing the SUT code (the code that actually implements the functionality wanted) to make the test go green in Eclipse.
- Create working SUT code in the "NumberRangeCounter.java" file.
- You will be marked up for commenting your code.
- Take a screenshot of the succeeding test (green JUnit bar), alongside the code implemented to attain it.
(Optional self-learning) For tips and tricks on using JUnit in Eclipse, see the following:
After having gone through the above tutorials and coding exercise, students will hand in the following code and screenshots:
- Test code and implementation (SUT) code that, together, make a successful test case (green in Eclipse JUnit).
- A screenshot of the test failing (red JUnit bard), before you write the SUT code.
- A screenshot of the test succeeding (green JUnit bar), along side the code you just ran.
Note: You may not use the screenshots provided in the tutorial, as that would be plagiarism. Provide full-screen shots that include the entire Eclipse work space.
|Criteria||Level 1 (fail)||Level 2 (pass)||Level 3 (good)||Level 4 (exceptional)|
|Installed and used Eclipse IDE and JUnit tools||Did not attempt install or failed install and did not come to instructor||Attempted install, had issues, came to teacher for assistance||Installed Eclipse but did not use JUnit for rest of assignment||Installed Eclipse and successfully utilized JUnit for the rest of the assignment|
|Implemented failing (red) TDD test code||Did not attempt - no screenshot, no code||"Red" Screenshot given but TDD test code provided is incorrect/incomplete||"Red" Screenshot and the correct TDD test code given||"Red" Screenshot and the correct TDD test code given, as well as added comments in the code|
|Implemented SUT code that passes the (green) TDD test code||Did not attempt - no screenshot, no code||Attempted and SUT code exits, but was never able to get "Green" bar from JUnit||SUT code exists and screenshot shows successful "Green" bar||SUT code exists, screenshot shows successful "Green" bar, and comments have been added to the code|
What should the instructor know before using this activity?
- Step through this activity yourself beforehand, as students will have some gotchas upon installing Eclipse and trying to use JUnit
What are some likely difficulties that an instructor may encounter using this activity?
- Students may not be able to setup and start running code in Eclipse easily
- Watch the How to Create and Run a Simple JUnit test in Eclipse IDE video to get ideas
- Assure that you add the JUnit Buildpath Library to your project
- Assure that two lines exist at the top of your tests source code file
- import static org.junit.Assert.*;
- import org.junit.Test;
|ACM Knowledge Area/Knowledge Unit||SE - Software Engineering, from ACM_Body_of_Knowledge|
|ACM Topic||SE/Testing types, SE/Testing Fundamentals, SE/Test-driven development - https://www.acm.org/education/CS2013-final-report.pdf|
|Level of Difficulty||Medium|
|Estimated Time to Completion||2-6 hrs dependent on student familiarity with Java and Eclipse IDE|
A computer that can run or install the Eclipse IDE for Java Developers (all major operating systems have easy installers)
|Source||http://www.codeaffine.com/2014/08/12/junit-in-a-nutshell-hello-world/ permission to use given by author Frank Appel|
|License||Creative Commons CC-BY|
Suggestions for Open Source Community:
Suggestions for an open source community member who is working in conjunction with the instructor.
- Show students any unit testing or TDD-based development you may already have in place. A real life example, with an explanation from a community developer would be a perfect way to solidify the understanding that testing is necessary for real world software.
This work is licensed under a Creative Commons Attribution 4.0 International License
The below appendix includes information found while researching and creating the above Learning Activity. Instructors may find it useful if they are wanting to create their own follow-on activities or want more info.
The below bullets are additional background readings, books and study materials that can be used in the learning of TDD:
- 5 min TDD overview video https://www.youtube.com/watch?v=QCif_-r8eK4
- Graphical explanation of TDD http://www.agiledata.org/essays/tdd.html
- Kent Beck book (he invented TDD) http://www.amazon.com/exec/obidos/ASIN/0321146530/
- Astels TDD book http://www.amazon.com/exec/obidos/ASIN/0131016490/
- Unit test vs Acceptance test https://dzone.com/articles/Write-JUnit-Tests-in-Spring-With-Mocked-and-Real-Objects
- TDD in a CalPoly course https://users.csc.calpoly.edu/~djanzen/courses/405W10/presentations/TDD.pdf
- Research showing TDD's pro's and con's https://tuhat.halvi.helsinki.fi/portal/files/29553974/2014_01_swqd_author_version.pdf
- JUnit Testing book - https://www.packtpub.com/application-development/testing-junit
- Is TDD Dead? https://www.youtube.com/watch?v=z9quxZsLcfo
- List of all open source testing tools - http://www.opensourcetesting.org/
Below lists 3rd party tutorials, how-to's, and learning resources that explain TDD and JUnit. They may be useful as alternative or harder secondary learning activities so that students can dive in a bit deeper.
- http://www.codeaffine.com/2014/08/12/junit-in-a-nutshell-hello-world/ , http://www.codeaffine.com/2012/11/26/working-efficiently-with-junit-in-eclipse-2/
- A superbly written step-by-step walk through of creating a test and then creating the associated functional code
- It uses JUnit, which is an open source technology - it uses a helloworld example
- Line-by-line explanation of code and tests and process to create Monopoly features via TDD
- Not sure what students would do, as all answers are given
- Specific to spring framework, and not for beginners; possibly complex to implement for beginners
- http://technologyconversations.com/2013/12/20/test-driven-development-tdd-example-walkthrough/ http://osherove.com/tdd-kata-1/ https://vimeo.com/8506325
- These are a great series of TDD "Practice Exercises"; It gives you requirements that you are supposed to serially step through and implement on top of each other
- Tetris based TDD
- It gives you test cases, already written, and you code to satisfy the tests
- License says "This material may NOT be used as course material without prior written agreement."
Examples of OSS projects that were implemented with TDD
The below list shows actual open source projects that were created with TDD methodologies. These could be used as examples of TDD in-practice. Students could learn how TDD is done in real life, learn best practices, etc. They are divided below into the two best examples, and then a number of other weaker examples.
- Well-known java unit testing framework written by Kent Beck, inventor or TDD himself
- ex of actual test code: https://github.com/junit-team/junit/blob/master/src/test/java/junit/tests/framework/AssertTest.java
- Written by one of the Agile Manifesto co-authors
- Very clean code, tests in /test directory
- Not as well known, but might be easier for students to understand
- Superb write up by SQLite of how they do extensive testing, but its possibly not developed with TDD principles, or maybe partially.
- Another TDD example project, but its around .NET .... meh
Initial Ideas and research
Below are a brainstorm of ideas that pre-empted the creation of the TDD learning activity. It is purely an idea and note taking set of bullets:
- Idea 1: Find a project that already has a testing harness and associated tests; learn it, and add a new unit test
- Idea 2: Create a test harness to make, build, and run unit tests on an existing open source project
- Jim Bowring has done this in the past, though it seems they are lengthy projects vs a shorter activity; Do we want to create a “project”-oriented LA?
- Idea 3: Use an existing JUnit exercise / tutorial to teach a simple TDD 'test first, code later' scenario
- Teach the “mental discipline” of testing
- How can we test a Requirement?
- Ensuring testing starts at user requirement gathering
- Iterating through tests once code has been written, helps to improve the tests
- Dave thinks ManageIQ community does unit testing
- Background reading:
- http://www.cs.cofc.edu/~bowring/ - Jim Bowring has a course in testing
- Boris Byser - the test guru
- Kent Beck - extreme programming (ford motor)