Writing tests - Revision history

Boy at 14:37, 20 May 2008

2008-05-20T14:37:44Z

@@ Line 1: / Line 1: @@
-{{Howto|easy|Sandy Pleyte <sandy@achievo.org>}}
+{{Howto|easy|Sandy Pleyte <sandy@achievo.org>, Boy Baukema <boy@achievo.org>}}
 == Basic testcase ==
@@ Line 71: / Line 71: @@
    assertFalse($result, $message = false)
 </syntaxhighlight>
 == Fixtures ==

bahtiar at 05:24, 16 May 2007

2007-05-16T05:24:16Z

← Older revision		Revision as of 05:24, 16 May 2007
Line 1:		Line 1:
	{{Howto\|easy\|Sandy Pleyte <sandy@achievo.org>}}		{{Howto\|easy\|Sandy Pleyte <sandy@achievo.org>}}

			== Basic testcase ==
	To create a test you need to take the following steps:		To create a test you need to take the following steps:

bahtiar at 05:23, 16 May 2007

2007-05-16T05:23:53Z

← Older revision		Revision as of 05:23, 16 May 2007
Line 1:		Line 1:
	~~(This howto is a work in progress)~~		{{Howto\|easy\|Sandy Pleyte <sandy@achievo.org>}}
	To create a test you need to take the following steps:		To create a test you need to take the following steps:

Line 8:		Line 8:
	class.test_[testname].inc		class.test_[testname].inc

	A test ~~cases needs~~ the following structure:		A basic test case has the following structure:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 20:		Line 20:
	{		{
	/**		/**
	* ~~Default constructor.~~		* This (optional) function will be called before each
	*/		* test_* function. Use it to initialise your test.
	~~public function __construct()~~
	{
	~~parent::__construct~~()~~; //Not necessary now, but maybe in the future.~~
	~~$this->addFixture('module.table'); //Fixtures need to be loaded in the constructor.~~
	}

	/**
	* This function will be called before ~~all other~~ test_* ~~functions~~. Use it to initialise
	* your ~~testclass~~.
	*/		*/
	function setUp()		function setUp()
	{		{
	~~//Don't forget to call the setUp of the parent.~~
	parent::setUp();		parent::setUp();
	}		}

	/**		/**
	* This function will be called after ~~all other~~ test_* ~~functions~~.		* This (optional) function will be called after
	* Useful to clean ~~stuff~~ up.		* each test_* function.
			* Useful to do clean-up.
	*/		*/
	function tearDown()		function tearDown()
	{		{
	~~//Don't forget to call the teadDown of the parent.~~
	parent::tearDown();		parent::tearDown();
	}		}
Line 53:		Line 43:
	function test_doSomething()		function test_doSomething()
	{		{
	//Do ~~some stuff~~		// Do the actual test here.
	$class = new exampleclass();		$class = new exampleclass();
	$class->doSomething();		$class->doSomething();
Line 62:		Line 52:
	</syntaxhighlight>		</syntaxhighlight>

	~~The actual testing~~ is done by the assert* functions. Here is a small list of the most ~~used~~ ones:		Reporting test results is done by the assert* functions. Here is a small list of the most common ones:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 80:		Line 70:
	</syntaxhighlight>		</syntaxhighlight>

	~~More information:~~		== Fixtures ==

	[~~http~~:~~//www.lastcraft.com/simple_test.php Simpletest~~]		In testcases you will sometimes want to use simulated database data. You can use [[Fixtures]] for this.
			See the following howto for using fixtures:

			* [[Using a test database]]

			== Running the testcases ==

	~~[[Using~~ a ~~test database]]~~		The following howto explains how to run a suite of testcases:

	[[Run tests]]		* [[Run tests]]

	=== Overloaders ===		=== Overloaders ===
Line 107:		Line 102:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			== More information ==

			[http://www.lastcraft.com/simple_test.php Simpletest]

bahtiar: Highlighting, cleanup, adherence to coding standards.

2007-05-14T17:54:22Z

Highlighting, cleanup, adherence to coding standards.

← Older revision		Revision as of 17:54, 14 May 2007
Line 2:		Line 2:
	To create a test you need to take the following steps:		To create a test you need to take the following steps:

	Create a directory 'testcases' in ~~your module~~ directory.		Create a directory 'testcases' in the directory where the class is located that you want to write a testcase for.

	In the directory you need to place one or more files with the name:		In the directory you need to place one or more files with the name:

	class.test_[~~testnaam~~].inc		class.test_[testname].inc

	A test cases needs the following structure:		A test cases needs the following structure:

	~~require_once(moduleDir~~("[modulename]~~")."class~~.[class you want to test]~~.inc~~");		<syntaxhighlight lang="php">
	~~//Take for example the class 'class.example.inc'~~		atkimport("[modulename].[class you want to test]");

	/**		/**
	* Unittests for the example class		* Unittests for the example class
Line 18:		Line 19:
	class test_testcase_name extends atkTestCase		class test_testcase_name extends atkTestCase
	{		{
	//~~Warning: This is PHP5.~~		/**
			* Default constructor.
			*/
	public function __construct()		public function __construct()
	{		{
Line 24:		Line 27:
	$this->addFixture('module.table'); //Fixtures need to be loaded in the constructor.		$this->addFixture('module.table'); //Fixtures need to be loaded in the constructor.
	}		}
	//This function will be called before all other test_* functions.
			/**
			* This function will be called before all other test_* functions. Use it to initialise
			* your testclass.
			*/
	function setUp()		function setUp()
	{		{
Line 30:		Line 37:
	parent::setUp();		parent::setUp();
	}		}
	//This function will be called after all other test_* functions.
			/**
			* This function will be called after all other test_* functions.
			* Useful to clean stuff up.
			*/
	function tearDown()		function tearDown()
	{		{
Line 36:		Line 47:
	parent::tearDown();		parent::tearDown();
	}		}
	/~~/Simpele~~ test function
			/**
			* Simple test function
			*/
	function test_doSomething()		function test_doSomething()
	{		{
Line 42:		Line 56:
	$class = new exampleclass();		$class = new exampleclass();
	$class->doSomething();		$class->doSomething();
	$result = $class->getSomeValue;		$result = $class->getSomeValue();
	$this->assertEqual($result,'expected_value','text in the test.');		$this->assertEqual($result,'expected_value','text in the test.');
	}		}
	}		}
			</syntaxhighlight>

	The actual testing is done by the assert* functions. Here is a small list of the most used ones:		The actual testing is done by the assert* functions. Here is a small list of the most used ones:

			<syntaxhighlight lang="php">
	assertNull($value, $message = "%s")		assertNull($value, $message = "%s")
	assertIsA($object, $type, $message = "%s")		assertIsA($object, $type, $message = "%s")
Line 62:		Line 78:
	assertTrue($result, $message = false)		assertTrue($result, $message = false)
	assertFalse($result, $message = false)		assertFalse($result, $message = false)
			</syntaxhighlight>
	~~These can be found in the 'atk~~/~~test' directory.~~


	More information:		More information:
Line 84:		Line 98:
	An example:		An example:

			<syntaxhighlight lang="php">
	function test_aclass()		function test_aclass()
	{		{
Line 91:		Line 106:
	$this->assertEqual($result, "blabla", "result should be blabla");		$this->assertEqual($result, "blabla", "result should be blabla");
	}		}
			</syntaxhighlight>

Sandy at 07:44, 14 May 2007

2007-05-14T07:44:57Z

← Older revision		Revision as of 07:44, 14 May 2007
Line 71:		Line 71:

	[[Using a test database]]		[[Using a test database]]

	[[Run tests]]		[[Run tests]]

Sandy at 07:44, 14 May 2007

2007-05-14T07:44:44Z

← Older revision		Revision as of 07:44, 14 May 2007
Line 71:		Line 71:

	[[Using a test database]]		[[Using a test database]]
			[[Run tests]]

	=== Overloaders ===		=== Overloaders ===

Sandy at 07:41, 14 May 2007

2007-05-14T07:41:00Z

← Older revision		Revision as of 07:41, 14 May 2007
Line 70:		Line 70:
	[http://www.lastcraft.com/simple_test.php Simpletest]		[http://www.lastcraft.com/simple_test.php Simpletest]

	[~~http://www.achievo.org/wiki/Using_a_test_database http://www.achievo.org/wiki/Using_a_test_database~~]		[[Using a test database]]

	=== Overloaders ===		=== Overloaders ===

Sandy at 07:39, 14 May 2007

2007-05-14T07:39:42Z

← Older revision		Revision as of 07:39, 14 May 2007
Line 69:		Line 69:

	[http://www.lastcraft.com/simple_test.php Simpletest]		[http://www.lastcraft.com/simple_test.php Simpletest]

	[http://www.achievo.org/wiki/Using_a_test_database http://www.achievo.org/wiki/Using_a_test_database]		[http://www.achievo.org/wiki/Using_a_test_database http://www.achievo.org/wiki/Using_a_test_database]

Sandy at 07:39, 14 May 2007

2007-05-14T07:39:25Z

← Older revision		Revision as of 07:39, 14 May 2007
Line 24:		Line 24:
	$this->addFixture('module.table'); //Fixtures need to be loaded in the constructor.		$this->addFixture('module.table'); //Fixtures need to be loaded in the constructor.
	}		}
	//~~Deze functie wordt steeds voor alle andere~~ test_* ~~functies aangeroepen~~.		//This function will be called before all other test_* functions.
	function setUp()		function setUp()
	{		{
	//~~Niet vergeten ook de~~ setUp ~~van de~~ parent ~~te doen~~.		//Don't forget to call the setUp of the parent.
	parent::setUp();		parent::setUp();
	}		}
	//~~Deze functie wordt steeds na alle andere~~ test_* ~~functies aangeroepen~~.		//This function will be called after all other test_* functions.
	function tearDown()		function tearDown()
	{		{
	//~~Niet vergeten ook de tearDown van de~~ parent ~~te doen~~.		//Don't forget to call the teadDown of the parent.
	parent::tearDown();		parent::tearDown();
	}		}
	//Simpele test ~~functie~~		//Simpele test function
	function test_doSomething()		function test_doSomething()
	{		{
	//~~Doe dingen~~		//Do some stuff
	$class = new exampleclass();		$class = new exampleclass();
	$class->doSomething();		$class->doSomething();
	$result = $class->getSomeValue;		$result = $class->getSomeValue;
	$this->assertEqual($result,'~~waarde_die_ik_had_dit_verwacht~~','~~tekst die~~ in ~~de tests wordt getoond~~.');		$this->assertEqual($result,'expected_value','text in the test.');
	}		}
	}		}

	~~Het eigenlijke testen wordt door de~~ assert* ~~functies gedaan~~. ~~Er zijn er verschillende, en de naam geeft~~		The actual testing is done by the assert* functions. Here is a small list of the most used ones:
	~~goed aan wat de eigenlijke functie~~ is:

	assertNull($value, $message = "%s")		assertNull($value, $message = "%s")
Line 64:		Line 63:
	assertFalse($result, $message = false)		assertFalse($result, $message = false)

	~~En vele anderen. Zie~~		These can be found in the 'atk/test' directory.
	~~platform/~~atk/test/
	~~voor meer mogelijkheden~~.


	~~Meer informatie op~~		More information:

			[http://www.lastcraft.com/simple_test.php Simpletest]
	[http://www.achievo.org/wiki/Using_a_test_database http://www.achievo.org/wiki/Using_a_test_database]		[http://www.achievo.org/wiki/Using_a_test_database http://www.achievo.org/wiki/Using_a_test_database]

	=== Overloaders ===		=== Overloaders ===

	~~Soms gebruikt een functie een klasse waarvoor je veel~~ extra setup ~~moet doen~~, ~~dan kan het handig zijn~~		Sometimes a function uses a class for which you need to do some extra setup, at that point it can be handy
	~~een~~ 'mock' ~~klasse te gebruiken die standaard resultaten oplevert~~. ~~Dan kun je die klasse overloaden door~~		to use a 'mock' class which will return some default results. Then you can overload this class by using an
	~~middel van een~~ overloader:		overloader:

	~~Dit werkt overigens alleen wanneer de klasse in kwestie geladen wordt door~~ atkNew().		This only works when a class is loaded with atkNew().

	~~Een voorbeeld~~:		An example:

	function ~~test_eenclass~~()		function test_aclass()
	{		{
	// ~~ik weet dat deze funktie~~ atkSoap ~~gebruikt maar dat wil ik effe niet voor deze~~ test.		// I know this function uses atkSoap, but we don't want to use it for this test
	atkClassLoader::addOverloader("atk.utils.atksoap", "mycustomsoapstub");		atkClassLoader::addOverloader("atk.utils.atksoap", "mycustomsoapstub");
	$result = ~~eenfunktie~~();		$result = afunction();
	$this->assertEqual($result, "blabla", "~~resultaat moet~~ blabla ~~zijn~~");		$this->assertEqual($result, "blabla", "result should be blabla");
	}		}

Sandy at 07:11, 14 May 2007

2007-05-14T07:11:52Z

New page

(This howto is a work in progress)
To create a test you need to take the following steps:

Create a directory 'testcases' in your module directory.

In the directory you need to place one or more files with the name:

class.test_[testnaam].inc

A test cases needs the following structure:

require_once(moduleDir("[modulename]")."class.[class you want to test].inc");
//Take for example the class 'class.example.inc'
/**
* Unittests for the example class
*
*/
class test_testcase_name extends atkTestCase
{
//Warning: This is PHP5.
public function __construct()
{
parent::__construct(); //Not necessary now, but maybe in the future.
$this->addFixture('module.table'); //Fixtures need to be loaded in the constructor.
}
//Deze functie wordt steeds voor alle andere test_* functies aangeroepen.
function setUp()
{
//Niet vergeten ook de setUp van de parent te doen.
parent::setUp();
}
//Deze functie wordt steeds na alle andere test_* functies aangeroepen.
function tearDown()
{
//Niet vergeten ook de tearDown van de parent te doen.
parent::tearDown();
}
//Simpele test functie
function test_doSomething()
{
//Doe dingen
$class = new exampleclass();
$class->doSomething();
$result = $class->getSomeValue;
$this->assertEqual($result,'waarde_die_ik_had_dit_verwacht','tekst die in de tests wordt getoond.');
}
}

Het eigenlijke testen wordt door de assert* functies gedaan. Er zijn er verschillende, en de naam geeft
goed aan wat de eigenlijke functie is:

assertNull($value, $message = "%s")
assertIsA($object, $type, $message = "%s")
assertEqual($first, $second, $message = "%s")
assertIdentical($first, $second, $message = "%s")
assertReference(&$first, &$second, $message = "%s")
assertCopy(&$first, &$second, $message = "%s")
assertWantedPattern($pattern, $subject, $message = "%s")
assertNoUnwantedPattern($pattern, $subject, $message = "%s")
assertNoErrors($message = "%s")
assertError($expected = false, $message = "%s")
assertErrorPattern($pattern, $message = "%s")
assertTrue($result, $message = false)
assertFalse($result, $message = false)

En vele anderen. Zie
platform/atk/test/
voor meer mogelijkheden.

Meer informatie op
[http://www.achievo.org/wiki/Using_a_test_database http://www.achievo.org/wiki/Using_a_test_database]

=== Overloaders ===

Soms gebruikt een functie een klasse waarvoor je veel extra setup moet doen, dan kan het handig zijn
een 'mock' klasse te gebruiken die standaard resultaten oplevert. Dan kun je die klasse overloaden door
middel van een overloader:

Dit werkt overigens alleen wanneer de klasse in kwestie geladen wordt door atkNew().

Een voorbeeld:

function test_eenclass()
{
// ik weet dat deze funktie atkSoap gebruikt maar dat wil ik effe niet voor deze test.
atkClassLoader::addOverloader("atk.utils.atksoap", "mycustomsoapstub");
$result = eenfunktie();
$this->assertEqual($result, "blabla", "resultaat moet blabla zijn");
}