Unit Testing - Revision history

Yvesh: At least some updates so people not contact wrong persons

2017-04-10T17:22:20Z

At least some updates so people not contact wrong persons

← Older revision		Revision as of 17:22, 10 April 2017
Line 49:		Line 49:

	==== The Unit Test Team ====		==== The Unit Test Team ====
	If you can commit to the Joomla code base, then you should consider yourself part of the ~~unit test~~ team!		If you can commit to the Joomla code base, then you should consider yourself part of the automated testing team! There is also a public Glip group for questions around testing (Testing & CI General Public Group).

	Writing tests concurrently with code (or even before) is a good way to not only save development time, but a great tool for defending against regressions. Writing tests early in the development cycle also helps identify and resolve design issues sooner, which reduces refactoring.		Writing tests concurrently with code (or even before) is a good way to not only save development time, but a great tool for defending against regressions. Writing tests early in the development cycle also helps identify and resolve design issues sooner, which reduces refactoring.

	If you want to get started on unit testing, get in touch with ~~Alan Langford~~ (~~instance~~) or ~~Ray Tsai~~ (~~mihu~~). Either of us will be happy to help out.		If you want to get started on unit testing, get in touch with Robert Deutz (rdeutz) or Yves Hoppe (yvesh). Either of us will be happy to help out.

	==== Current Work ====		==== Current Work ====
Line 62:		Line 62:
	* 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).		* 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.		* Previously functional tests, such as JFTP, haven't been moved to the PHPUnit environment yet.
	* The custom test runner is no longer needed. The current tests will run with the latest ~~SVN version~~ of PHPUnit ~~3.4. This code will eventually become PHPUnit 3.~~4.1. Thanks to Sebastian Bergmann for his excellent work on an excellent project!		* The custom test runner is no longer needed. The current tests will run with the latest of PHPUnit 4.8.Thanks to Sebastian Bergmann for his excellent work on an excellent project!

	==== Writing Unit Tests ====		==== Writing Unit Tests ====

JoomlaWikiBot: JSplit

2013-04-25T20:54:55Z

JSplit

← Older revision		Revision as of 20:54, 25 April 2013
Line 1:		Line 1:
	{{~~cookiejar~~}}		{{JSplit}}
	Note that this article is badly out of date.		Note that this article is badly out of date.
	== News and Updates ==		== News and Updates ==
Line 10:		Line 10:
	2008 06 22: Add information on limiting tests by version.		2008 06 22: Add information on limiting tests by version.

	2008 06 21: ~~Added --class~~-exclude, --sequence-exclude, ~~and --test~~-exclude options.		2008 06 21: Added—class-exclude, --sequence-exclude, and—test-exclude options.

	2008 06 21: PHPUnit has been updated to version 3.2.21 with SVN rev 10436. Please update.		2008 06 21: PHPUnit has been updated to version 3.2.21 with SVN rev 10436. Please update.
Line 41:		Line 41:
	* Stub - Allows the test to define responses to method calls (return values, exceptions) to simulate the dependent object.		* Stub - Allows the test to define responses to method calls (return values, exceptions) to simulate the dependent object.
	* Spy - A Fake or Stub that records method calls and parameters for later analysis.		* Spy - A Fake or Stub that records method calls and parameters for later analysis.
	* Mock - A Fake or Stub with a set of ~~expectations -- method~~ calls and ~~parameters -- that~~ are automatically verified for correctness.		* Mock - A Fake or Stub with a set of expectations—method calls and parameters—that are automatically verified for correctness.

	=== Unit Testing in Joomla! ===		=== Unit Testing in Joomla! ===
Line 67:		Line 67:
	At risk of stating the obvious, in the "purest" case the purpose of a unit test is to ''isolate a unit of code from its environment and to test the operation of that code''.		At risk of stating the obvious, in the "purest" case the purpose of a unit test is to ''isolate a unit of code from its environment and to test the operation of that code''.

	This isolation is usually achieved by writing dummy classes that emulate the code unit's environment. These dummy objects can be passive, by simply simulating the environment, or they can be more active, keeping track of how they are being used by the test unit and reporting any variations from the expected behaviour. See [[~~Unit_Testing_Mock_Objects~~\|Mock Objects in Joomla]] for a detailed example.		This isolation is usually achieved by writing dummy classes that emulate the code unit's environment. These dummy objects can be passive, by simply simulating the environment, or they can be more active, keeping track of how they are being used by the test unit and reporting any variations from the expected behaviour. See [[Unit Testing Mock Objects\|Mock Objects in Joomla]] for a detailed example.

	An interesting aspect of writing tests is that they become ''de facto'' detailed technical specifications of the interfaces between units of code. The fact that these specifications can be verified in an automated way makes them a superb resource when refactoring code.		An interesting aspect of writing tests is that they become ''de facto'' detailed technical specifications of the interfaces between units of code. The fact that these specifications can be verified in an automated way makes them a superb resource when refactoring code.
Line 76:		Line 76:
	/unittest/sample-simpletest.php.txt		/unittest/sample-simpletest.php.txt

	Here are some example tests: [[~~Unit_Testing_~~--~~_a_Simple_Example~~\|Simple Example]], [[~~Unit_Testing_~~--~~_Data_Driven_Example~~\|Data Driven Example]], [[~~Unit_Testing_~~--~~_Plugin_Example~~\|Plugin Example]], [[~~Unit_Testing_~~--~~_UI_Example~~\|UI Example]].		Here are some example tests: [[Unit Testing -- a Simple Example\|Simple Example]], [[Unit Testing -- Data Driven Example\|Data Driven Example]], [[Unit Testing -- Plugin Example\|Plugin Example]], [[Unit Testing -- UI Example\|UI Example]].

	==== Running Unit Tests ====		==== Running Unit Tests ====
Line 95:		Line 95:
	The unit test will the run, and the results are rendered. You will see a series of dots for each passed test and other letters for failed tests.		The unit test will the run, and the results are rendered. You will see a series of dots for each passed test and other letters for failed tests.

	See http://www.phpunit.de/manual/current/en/textui.html for help using ~~the --filter~~ switch to run only certain tests. There are also many other command line switches you can use to get results in various formats.		See http://www.phpunit.de/manual/current/en/textui.html for help using the—filter switch to run only certain tests. There are also many other command line switches you can use to get results in various formats.

	== Troubleshooting ==		== Troubleshooting ==

Dextercowley: Reverted edits by Tom6 (talk) to last revision by Radiant tech

2012-02-03T00:11:28Z

Reverted edits by Tom6 (talk) to last revision by Radiant tech

Show changes

Tom6: Blanked the page

2012-02-03T00:10:09Z

Blanked the page

Show changes

Radiant tech: replaced ref to SVN with GitHub platform/link

2011-12-14T23:25:42Z

replaced ref to SVN with GitHub platform/link

← Older revision		Revision as of 23:25, 14 December 2011
Line 44:		Line 44:

	=== Unit Testing in Joomla! ===		=== 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.		Unit testing capabilities in Joomla are steadily developing. [Add note re amount of coverage for platform by unit tests.]

	The ~~SVN repository contains code under the~~ /~~testing path.~~ /~~testing/trunk used to contain code based on the SimpleTest framework~~. ~~In early December 2007, the development team elected to move to the [http:~~//~~www.phpunit.de PHPUnit~~] ~~framework.~~		The [https://github.com/joomla/joomla-platform Joomla Platform GitHub repository] contains PHPUnit tests within the /tests subdirectory. See [http://docs.joomla.org/Running_Automated_Tests_for_Version_1.6 Running Automated Tests for Version 1.6] for instructions on setting up unit testing in your IDE.

	~~The~~ PHPUnit tests ~~are found in '''~~/tests~~/unit''' in the development trunk~~. See [http://docs.joomla.org/Running_Automated_Tests_for_Version_1.6 Running Automated Tests for Version 1.6] for instructions on setting up unit testing in your IDE.

	==== The Unit Test Team ====		==== The Unit Test Team ====

Elin at 02:33, 27 October 2011

2011-10-27T02:33:03Z

← Older revision		Revision as of 02:33, 27 October 2011
Line 1:		Line 1:
	{{cookiejar}}		{{cookiejar}}
			Note that this article is badly out of date.
	== News and Updates ==		== News and Updates ==
	2011 10 26 Use version 3.5.15 of PHPUnit. Please see reference material on github.		2011 10 26 Use version 3.5.15 of PHPUnit. Please see reference material on github.

Elin: /* News and Updates */

2011-10-27T02:31:57Z

News and Updates

← Older revision		Revision as of 02:31, 27 October 2011
Line 1:		Line 1:
	{{cookiejar}}		{{cookiejar}}
	== News and Updates ==		== News and Updates ==
			2011 10 26 Use version 3.5.15 of PHPUnit. Please see reference material on github.

	2009 10 06: Tests now depend on the SVN version of PHPUnit 3.4.1.		2009 10 06: Tests now depend on the SVN version of PHPUnit 3.4.1.

Paladin: Corrected unit test file naming convention

2010-10-19T17:46:55Z

Corrected unit test file naming convention

← Older revision		Revision as of 17:46, 19 October 2010
Line 78:		Line 78:

	==== Running Unit Tests ====		==== Running Unit Tests ====
	Test files follow the form ~~class-sequence-type-Test~~.php, for example ~~JObject-0000-class-Test~~.php. For tests that are not class based, the ~~first element refers to~~ the ~~object~~ being tested~~. An example of this is the e-mail cloaking plugin test, which is called emailcloak-0000-mode1-Test.php~~.		Test files follow the form classnameTest.php, for example JObjectTest.php. For tests that are not class based, use the name of the file being tested.

	Joomla unit tests use the standard PHPUnit test runner. See http://www.phpunit.de for documentation.		Joomla unit tests use the standard PHPUnit test runner. See http://www.phpunit.de for documentation.

Paladin: /* Unit Testing in Joomla! */

2010-09-25T16:42:36Z

Unit Testing in Joomla!

← Older revision		Revision as of 16:42, 25 September 2010
Line 45:		Line 45:
	The SVN repository contains code under the /testing path. /testing/trunk used to contain code based on the SimpleTest framework. In early December 2007, the development team elected to move to the [http://www.phpunit.de PHPUnit] framework.		The SVN repository contains code under the /testing path. /testing/trunk used to contain code based on the SimpleTest framework. In early December 2007, the development team elected to move to the [http://www.phpunit.de PHPUnit] framework.

	The PHPUnit tests are ~~available from~~ '''/~~testing~~/~~trunk~~'''~~. Some new tests have been added, any remaining tests from~~ the ~~SimpleTest days are completely broken~~. See ~~/testing/branches/old-simpletest if you need to run something from that suite.~~		The PHPUnit tests are found in '''/tests/unit''' in the development trunk. See [http://docs.joomla.org/Running_Automated_Tests_for_Version_1.6 Running Automated Tests for Version 1.6] for instructions on setting up unit testing in your IDE.

	~~The unit tests are located in two places~~:
	* /testing/trunk/~~1.5~~/~~unittest - these are tests for Joomla! 1~~.~~5 (/development/releases/1~~.5)
	* /testing/trunk/1.6~~/unittest - there are tests~~ for ~~Joomla!~~ 1.6 ~~(/development/trunk)~~

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

	==== The Unit Test Team ====		==== The Unit Test Team ====

Paladin: /* Unit Testing */

2010-09-25T16:29:36Z

Unit Testing

← Older revision		Revision as of 16:29, 25 September 2010
Line 12:		Line 12:

	== Unit Testing ==		== Unit Testing ==
	Unit testing is an essential part of a good Quality Control program.		Unit testing is not only an essential part of a good Quality Control program, it is an aid to development as well. Writing new tests before writing code helps focus the developer on the problem at hand. The practice also encourages writing smaller, more loosely coupled, more reusable, and more maintainable code units and these benefits often outweigh the benefits gained by treating unit tests solely as a QC tool. When used in this manner correctness becomes more a by-product of the process than the goal.
	For a good general discussion of unit testing, visit the [http://en.wikipedia.org/wiki/Unit_test Wikipedia article].		For a good general discussion of unit testing, visit the [http://en.wikipedia.org/wiki/Unit_test Wikipedia article].