Unit Testing

From Joomla! Documentation

Revision as of 14:49, 22 January 2008 by Instance (Talk | contribs)

Unit Testing

Unit testing is an essential part of a good Quality Control program. For more information, visit the Wikipedia article on unit testing.

Unit Testing in Open Source

Open source projects, with multiple developers working in parallel around the world, can greatly benefit from unit testing. The main benefits are:

  • Unit tests help highlight cases where seemingly minor changes cause unexpected breakage.
  • Unit tests help clearly specify how a class should behave.
  • Unit tests can expose design flaws very early in development.
  • Unit tests make great examples. They are a great place for developers to learn how to use the code.

Unit Testing in Joomla!

Unit testing capabilities in Joomla are still at an early stage. The intention is to define more standards for developing tests, and then to expand the scope of available tests

The SVN repository contains code under the /testing path. /testing/trunk contains code based on the SimpleTest framework. In early December 2007, the development team elected to move to the PHPUnit framework.

Work on using PHPUnit has been done in /testing/branches/2007-12-17. Some new tests have been added, many old tests from the SimpleTest days are completely broken.

At this point, PHPUnit based tests only run in a command line environment.

Current Work

  • The PHPUnit tests require a small modification to the code before they run. /libraries/loader.php requires a conditional "if (! function_exists('jimport'))" wrapper around the jimport() function.
  • Strategies for dealing with local configuration and mock objects are not yet complete.
  • Files of the form class-sequence-type-test.php, for example JObject-0000-class-test.php use PHPUnit.
  • The JDate tests present a good example of a data-driven test, but they won't run on the current 1.5 code base (there are some proposed API changes as a result of unit test development).
  • Previously functional tests, such as JFTP, haven't been moved to the PHPUnit environment yet.