SoC test framework - Revision history

Dirk: added a link to Test Suite

2009-08-15T19:17:41Z

added a link to Test Suite

Dirk: link to project repository

2009-05-21T16:04:44Z

link to project repository

Dirk: list student / mentor on the top of the page

2009-05-15T18:58:07Z

list student / mentor on the top of the page

Dirk: using PHPUnit

2009-05-13T15:30:36Z

using PHPUnit

Choplair: pre-SoC / present work content seperation

2009-05-09T17:23:30Z

pre-SoC / present work content seperation

Dirk: GSoC project: Test framework

2009-01-12T14:14:56Z

GSoC project: Test framework

New page

<center>(This is an idea page for the [[Google Summer of Code]])</center>

== Incentive ==

Very little testing on Geeklog is currently done automatically. As the complexity of the software is ever increasing, it's not enough to rely on manual tests done by the developers (and, by extension, the community during beta and release candidate phases) any more.

So the goal of this project is to implement test framework(s) to allow for automated tests of Geeklog and its features.

== Details ==

There are two aspects that we'd like to see tested, which may actually make it possible to have this split into '''two''' projects:

* tests of the code on class / function level
* tests of the front-end functionality available through the browser

At the code level, [http://en.wikipedia.org/wiki/Unit_testing unit tests] are required to make sure the code behaves as expected at its interface (API) so that after making changes to the internals, the API still behaves the same.

Unit testing is usually associated with object oriented code, which may sound like a problem given that Geeklog is not fully object oriented. However, unit tests can also be written for the many collections of functions in <tt>system/lib-*.php</tt> and <tt>lib-common.php</tt>.

Testing the functionality implemented in, say, <tt>admin/story.php</tt> (the Admin panel that provides access to all stories on a site) is probably best done through a tool that tests the web frontend.

== Frameworks ==

There already exist numerous test frameworks for PHP code and for web applications. So unless there's a ''very'' good reason not to pick one of those, we would suggest looking into existing frameworks (and adapt them, if necessary).

Here's an incomplete list of test frameworks. We expect the student to research more options before making a choice:

* [http://qa.php.net/write-test.php PHP Tests] (*.phpt) as used by the PHP project
* [http://www.phpunit.de/ PHPUnit]
* [http://seleniumhq.org/ Selenium]

Open source solutions would be preferred, although there are some commercial frameworks that may be worth looking into.

== Level of Difficulty ==

''low to medium''

The focus in this project lies on picking the proper tool (i.e. test framework) and then demonstrating that it does the job by implementing tests for a representative portion of the code / functionality. We certainly don't expect complete coverage of all of Geeklog in just one summer. This project is about laying the groundwork.

[[Category:Summer of Code]] [[Category:Development]]

@@ Line 9: / Line 9: @@
 * first decision: We are going to use [http://phpunit.de/ PHPUnit].
 * This will be a separate project, to be run against the Geeklog repository. So we're starting with a fresh repository (instead of branching the Geeklog repo).
+* Description: [[Test Suite]]

@@ Line 1: / Line 1: @@
 This is one of the projects to be implemented during the [[Google Summer of Code]] 2009.
-'''Student:''' Sean Clark, '''Mentor:''' Dirk Haun
+'''Student:''' Sean Clark, '''Mentor:''' Dirk Haun<br/>
@@ Line 7: / Line 8: @@
 * first decision: We are going to use [http://phpunit.de/ PHPUnit].
 ''(more: TBD)''

@@ Line 1: / Line 1: @@
-<center>(This is an idea page for the [[Google Summer of Code]])</center>
+This is one of the projects to be implemented during the [[Google Summer of Code]] 2009.
 == Project info and advancement during Summer of Code ==
@@ Line 49: / Line 52: @@
 The focus in this project lies on picking the proper tool (i.e. test framework) and then demonstrating that it does the job by implementing tests for a representative portion of the code / functionality. We certainly don't expect complete coverage of all of Geeklog in just one summer. This project is about laying the groundwork.
 [[Category:Summer of Code]] [[Category:Development]]

← Older revision		Revision as of 15:30, 13 May 2009
Line 3:		Line 3:
	== Project info and advancement during Summer of Code ==		== Project info and advancement during Summer of Code ==

−	(~~to be written~~)	+	* first decision: We are going to use [http://phpunit.de/ PHPUnit].
		+
		+	''(more: TBD)''

@@ Line 1: / Line 1: @@
 <center>(This is an idea page for the [[Google Summer of Code]])</center>
-== Incentive ==
+== Project info and advancement during Summer of Code ==
 Very little testing on Geeklog is currently done automatically. As the complexity of the software is ever increasing, it's not enough to rely on manual tests done by the developers (and, by extension, the community during beta and release candidate phases) any more.
@@ Line 8: / Line 15: @@
-== Details ==
+=== Details ===
 There are two aspects that we'd like to see tested, which may actually make it possible to have this split into '''two''' projects:
@@ Line 22: / Line 29: @@
-== Frameworks ==
+=== Frameworks ===
 There already exist numerous test frameworks for PHP code and for web applications. So unless there's a ''very'' good reason not to pick one of those, we would suggest looking into existing frameworks (and adapt them, if necessary).
@@ Line 35: / Line 42: @@
-== Level of Difficulty ==
+=== Level of Difficulty ===
 ''low to medium''