Unit Tests - Revision history

201.58.238.117: /* PHPUnit */

2012-10-19T18:53:43Z

‎PHPUnit

201.58.238.117: /* PHPUnit */

2012-10-19T17:28:25Z

‎PHPUnit

201.29.87.221: /* PHPUnit */

2012-10-03T21:48:11Z

‎PHPUnit

201.29.87.221: /* PHPUnit */

2012-10-03T19:06:11Z

‎PHPUnit

Beghelli: Insert advice to upgrade PEAR

2011-11-24T13:00:56Z

Insert advice to upgrade PEAR

Jerico.dev: Documented new mock folder in the tests directory.

2010-03-17T14:26:29Z

Documented new mock folder in the tests directory.

Jerico.dev: our -> a

2009-10-28T18:43:08Z

our -> a

Jerico.dev: Referring to the web test environment

2009-10-28T01:54:23Z

Referring to the web test environment

Jerico.dev: Added section about debugging

2009-10-23T14:44:52Z

Added section about debugging

Jerico.dev: Explain how to mock static method calls.

2009-10-21T14:04:39Z

Explain how to mock static method calls.

@@ Line 22: / Line 22: @@
 sudo pear channel-discover pear.phpunit.de
 sudo pear install phpunit/PHPUnit-3.6.4
 </pre>

@@ Line 22: / Line 22: @@
 sudo pear channel-discover pear.phpunit.de
 sudo pear install phpunit/PHPUnit-3.6.4
 </pre>

@@ Line 21: / Line 21: @@
 <pre>
 sudo pear channel-discover pear.phpunit.de
-sudo pear install phpunit/PHPUnit
+sudo pear install phpunit/PHPUnit-3.6.4
 </pre>
 == PKP Unit Test Framework ==

@@ Line 20: / Line 20: @@
 On the command line execute
 <pre>
-pear channel-discover pear.phpunit.de
+sudo pear channel-discover pear.phpunit.de
-pear install phpunit/PHPUnit
+sudo pear install phpunit/PHPUnit
 </pre>

@@ Line 7: / Line 7: @@
 == PEAR ==
-You'll need PEAR installed for the following steps to work. If you are on Linux simply install the corresponding package provided by your packaging system. If you are on Windows execute the "go-pear.bat" in the PHP installation directory and follow the on-screen instructions.
+You'll need PEAR installed and upgraded for the following steps to work. If you are on Linux simply install the corresponding package provided by your packaging system. To upgrade, execute:
 If you are on Linux you may also find some or all of the other required software pre-packaged for your distribution. Please check that before installing software manually.

@@ Line 99: / Line 99: @@
 == What if my test class depends on calls to static class methods? ==
-From a testing point of view, static method calls are evil. It is impossible to mock static method calls with the system under test being unaware of it. Static method calls are not so nice for other reasons as well: They make it difficult to "drop in" different implementations of a class at runtime. This restricts design flexibility and code maintainability. It is usually better to use the [http://en.wikipedia.org/wiki/Singleton_pattern#PHP Singleton pattern] instead.
+From a testing point of view, static method calls are evil. It is impossible to mock static method calls with the system under test being unaware of it. Static method calls are not so nice for other reasons as well: They make it difficult to "drop in" different implementations of a class at runtime. This restricts design flexibility and code maintainability. It is usually better to use the [http://en.wikipedia.org/wiki/Singleton_pattern#PHP singleton pattern] instead.
-If you cannot avoid static method calls at all then you can manually create a mock class that will be included rather than the standard PKP implementation:
+If you cannot avoid static method calls or if you have to rely on legacy classes then you can manually create a mock class that will be included rather than the standard PKP implementation:
 * create a file called "Mock<Classname>.inc.php" in the same directory as your unit test class.
@@ Line 108: / Line 108: @@
 * the test framework will automatically drop in the mock class instead of the original class
-Here is an example for a mock Locale class. The class is placed in the file MockLocale.inc.php in the "/lib/pkp/tests/classes/submission" directory.
+If you need the same mock class several times then you can implement it in the 'tests/mock' folder and drop a file with the same name into your current unit test directory that imports the central mock class from the 'tests/mock' folder.
 <pre>

@@ Line 3: / Line 3: @@
 == Web Test Environment (Selenium) ==
-Please install our [[Web Tests]] environment if you intend to create or execute automated web tests with PHPUnit.
+Please install a [[Web Tests]] environment if you intend to create or execute automated web tests with PHPUnit.
 == PEAR ==

← Older revision		Revision as of 01:54, 28 October 2009
Line 1:		Line 1:
−	= Installing and Configuring your Test Environment =	+	= Installing and Configuring your Unit Test Environment =
		+
		+	== Web Test Environment (Selenium) ==
		+
		+	Please install our [[Web Tests]] environment if you intend to create or execute automated web tests with PHPUnit.

	== PEAR ==		== PEAR ==

← Older revision		Revision as of 14:44, 23 October 2009
Line 191:		Line 191:

	That's it. Now you're ready to develop and execute your tests. Enjoy!		That's it. Now you're ready to develop and execute your tests. Enjoy!
		+
		+	== What if my test fails with an error? ==
		+
		+	You've got various possibilities to debug your test. Usually the test will show a backtrace when there was an error. If this is not the case then have a look in "tests/results/error.log". Errors that occur within the PKP library will be logged there.
		+
		+	If this still doesn't help then try to debug your test. Set a break point and execute the debugger. See [[Configure Eclipse for PHPUnit]] for debug configuration instructions.

	= Installing and Configuring the Build Environment =		= Installing and Configuring the Build Environment =

← Older revision		Revision as of 14:04, 21 October 2009
Line 92:		Line 92:

	See the [http://www.phpunit.de/manual/current/en/test-doubles.html#test-doubles.mock-objects chapter about mock objects] in the PHPUnit manual for further details.		See the [http://www.phpunit.de/manual/current/en/test-doubles.html#test-doubles.mock-objects chapter about mock objects] in the PHPUnit manual for further details.
		+
		+	== What if my test class depends on calls to static class methods? ==
		+
		+	From a testing point of view, static method calls are evil. It is impossible to mock static method calls with the system under test being unaware of it. Static method calls are not so nice for other reasons as well: They make it difficult to "drop in" different implementations of a class at runtime. This restricts design flexibility and code maintainability. It is usually better to use the [http://en.wikipedia.org/wiki/Singleton_pattern#PHP Singleton pattern] instead.
		+
		+	If you cannot avoid static method calls at all then you can manually create a mock class that will be included rather than the standard PKP implementation:
		+
		+	* create a file called "Mock<Classname>.inc.php" in the same directory as your unit test class.
		+	* in this file implement a mock version of <Classname>.
		+	* implement only the methods required either during PKP framework initialization or for your own test.
		+	* the test framework will automatically drop in the mock class instead of the original class
		+
		+	Here is an example for a mock Locale class. The class is placed in the file MockLocale.inc.php in the "/lib/pkp/tests/classes/submission" directory.
		+
		+	<pre>
		+	class Locale {
		+	/*
		+	* method required during setup of
		+	* the PKP application framework
		+	*/
		+	function initialize() {
		+	// do nothing
		+	}
		+
		+	/*
		+	* method required during setup of
		+	* the PKP application framework
		+	* @return string test locale
		+	*/
		+	function getLocale() {
		+	return 'de_DE';
		+	}
		+
		+	/*
		+	* method required during setup of
		+	* the PKP application framework
		+	*/
		+	function registerLocaleFile($locale, $filename, $addToTop = false) {
		+	// do nothing
		+	}
		+
		+	/**
		+	* Mocked method
		+	* @return array a test array of locales
		+	*/
		+	function getLocalePrecedence() {
		+	return array('de_DE', 'en_US');
		+	}
		+	}
		+	</pre>

	== PHPUnit annotations ==		== PHPUnit annotations ==