Test Driven Development

(Difference between revisions)
Jump to: navigation, search
(added comments and help if problems with running code)
(link to comments section for troubleshooting; appendix updated)
Line 45: Line 45:
 
* [https://eclipse.org/downloads/ Download and install] Eclipse - JUnit comes with "Eclipse IDE for Java Developers"
 
* [https://eclipse.org/downloads/ 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.
 
* Become familiar with the Eclipse Workbench and in Running code - there is a built-in Eclipse Help Guide, as well as 3rd party tutorials.
* Start a new Java Project and include your own name in the "Project name" field.
+
* Start a new Java Project and include your own name in the 'Project name' field.
 
** Example Project Name: "NumberCounter-NYeates"
 
** Example Project Name: "NumberCounter-NYeates"
** Watch [https://www.youtube.com/watch?v=tkzJsP7NP54 How to Create and Run a Simple JUnit test in Eclipse IDE] if you get stuck
+
** Watch [https://www.youtube.com/watch?v=tkzJsP7NP54 How to Create and Run a Simple JUnit test in Eclipse IDE] if you get stuck.
 +
** Try the tips in the [[#Comments|Comments section]] below if you get really stuck.
  
  
Line 102: Line 103:
  
 
|-
 
|-
| '''Implemented SUT code that passed (green) the TDD test code'''
+
| '''Implemented SUT code that passes the (green) TDD test code'''
 
| Did not attempt - no screenshot, no code
 
| Did not attempt - no screenshot, no code
 
| Attempted and SUT code exits, but was never able to get "Green" bar from JUnit
 
| Attempted and SUT code exits, but was never able to get "Green" bar from JUnit
Line 128: Line 129:
 
{| border="1"
 
{| border="1"
 
|-  
 
|-  
|'''ACM Knowledge Area/Knowledge Unit''' || What ACM Computing Curricula 2013 knowledge area and units does this activity cover? [[ACM_Body_of_Knowledge]]
+
|'''ACM Knowledge Area/Knowledge Unit''' || SE - Software Engineering, from [[ACM_Body_of_Knowledge]]
 
|-
 
|-
|'''ACM Topic''' || What specific topics are addressed? The Computing Curriucula 2013 provides a list of topics - https://www.acm.org/education/CS2013-final-report.pdf
+
|'''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
 
|'''Level of Difficulty''' || Medium
 
|-
 
|-
|'''Estimated Time to Completion''' ||  4-10 hrs dependent on student familiarity with Java and Eclipse IDE
+
|'''Estimated Time to Completion''' ||  2-6 hrs dependent on student familiarity with Java and Eclipse IDE
 
|-
 
|-
 
|'''Materials/Environment''' ||  
 
|'''Materials/Environment''' ||  
A computer that can run or install the Eclipse IDE for Java Developers (all major OS platforms have easy installers)
+
A computer that can run or install the Eclipse IDE for Java Developers (all major operating systems have easy installers)
 
|-
 
|-
 
|'''Author''' || Nick Yeates  
 
|'''Author''' || Nick Yeates  
Line 148: Line 149:
 
=== Suggestions for Open Source Community: ===
 
=== Suggestions for Open Source Community: ===
 
Suggestions for an open source community member who is working in conjunction with the instructor.
 
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.
  
  
Line 162: Line 164:
  
 
=== Appendix ===
 
=== Appendix ===
 +
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.
  
 
=== Examples of OSS projects that use TDD ===
 
=== Examples of OSS projects that use TDD ===
Line 190: Line 193:
  
  
=== TDD "Lessons" ===
+
=== TDD Tutorials ===
 
* 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/
 
* 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
 
** 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 - but it uses a helloworld example - not sure if we want this or more of an integration with an existing oss project
+
** It uses JUnit, which is an open source technology - it uses a helloworld example
** Code Affine gave us permission to use!
+
  
 
* https://schuchert.wikispaces.com/Cxx+TDD+Monopoly
 
* https://schuchert.wikispaces.com/Cxx+TDD+Monopoly
Line 203: Line 205:
 
* https://dzone.com/articles/Write-JUnit-Tests-in-Spring-With-Mocked-and-Real-Objects
 
* https://dzone.com/articles/Write-JUnit-Tests-in-Spring-With-Mocked-and-Real-Objects
 
** Specific to spring framework, and not for beginners; possibly complex to implement for beginners
 
** Specific to spring framework, and not for beginners; possibly complex to implement for beginners
**I think DZone is copyright encumbered :-/ all content on it is proprietary in their submission legal text
 
  
 
* http://technologyconversations.com/2013/12/20/test-driven-development-tdd-example-walkthrough/ http://osherove.com/tdd-kata-1/ https://vimeo.com/8506325
 
* 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
 
** 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
** This uses open source, but it isn't involved in any existing oss project
 
** Unknown copyright
 
  
 
* https://github.com/orfjackal/tdd-tetris-tutorial
 
* https://github.com/orfjackal/tdd-tetris-tutorial
 
** Tetris based TDD
 
** Tetris based TDD
 
** It gives you test cases, already written, and you code to satisfy the tests
 
** It gives you test cases, already written, and you code to satisfy the tests
** License says "You may use and modify this material freely for personal non-commercial use. This material may NOT be used as course material without prior written agreement."
+
** License says "This material may NOT be used as course material without prior written agreement."
  
  
 
+
=== Initial Ideas and research ===
=== Ideas and research ===
+
 
TDD
 
TDD
 
* Idea 1: Find a project that already has a testing harness and associated tests; learn it, and add a new unit test
 
* Idea 1: Find a project that already has a testing harness and associated tests; learn it, and add a new unit test
Line 229: Line 227:
 
** Iterating through tests once code has been written, helps to improve the tests
 
** Iterating through tests once code has been written, helps to improve the tests
  
* Dave thinks ManageIQ does unit testing
+
* Dave thinks ManageIQ community does unit testing
  
 
* Background reading:
 
* Background reading:
** http://www.cs.cofc.edu/~bowring/ - course in testing
+
** http://www.cs.cofc.edu/~bowring/ - Jim Bowring has a course in testing
 
** Boris Byser - the test guru
 
** Boris Byser - the test guru
 
** Kent Beck - extreme programming (ford motor)
 
** Kent Beck - extreme programming (ford motor)
** http://foss2serve.org/index.php/Test_Coverage_Activity
 

Revision as of 09:50, 19 February 2016

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:
  • Programming simple Java
  • Developing object-oriented software (classes, methods, instances)
  • Test Driven Development (TDD) workflow and theory
Learning Objectives Students should be able to:
  • Install and use the Eclipse IDE and JUnit
  • Use JUnit in Eclipse to implement and run a failing TDD test
  • Use JUnit in Eclipse to implement code that passes a TDD test

Background:

Background reading

None of these are required by the student, but can be used in the learning of TDD that must precede this activity:

Rationale

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 in certain within particular constraints is an extension of quality assurance (QA) efforts that most professional software products do to increase their products value. With TDD, this testing is built-in even before students to 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.


Directions:

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 actual non-test code that gets the tests to succeed (green JUnit bar). You will hand in this code, the associated test, and two screenshots.


Setup Eclipse and JUnit

  • 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.
  • Start a new Java Project and include your own name in the 'Project name' field.


Next, follow the Eclipse-JUnit-based TDD tutorial located at:

  • http://www.codeaffine.com/2014/08/12/junit-in-a-nutshell-hello-world/
    • 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), alongside the test class used to bring the Assertion fail.


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 to make the test go green in Eclipse.
  • 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:


Deliverables:

Code and screenshots:

  • Test code and implementation 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.


Assessment:

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

Comments:

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


Additional Information:

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
Materials/Environment

A computer that can run or install the Eclipse IDE for Java Developers (all major operating systems have easy installers)

Author Nick Yeates
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


Appendix

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.

Examples of OSS projects that use TDD

Best examples

  • https://github.com/unclebob/fitnesse
    • 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

Weaker examples


TDD Tutorials

  • https://github.com/orfjackal/tdd-tetris-tutorial
    • 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."


Initial Ideas and research

TDD

  • 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:
Personal tools
Namespaces
Variants
Actions
Events
Learning Resources
HFOSS Projects
Evaluation
Navigation
Toolbox