Test Suite - Revision history

Dirk: link to Jenkins article

2011-05-28T21:32:42Z

link to Jenkins article

Dirk: Hudson -> Jenkins

2011-02-07T10:35:41Z

Hudson -> Jenkins

Dirk: added links

2010-07-25T19:26:36Z

added links

Dirk: Added a note about installation instructions being included; fixed hierarchy of headlines

2009-08-15T19:23:17Z

Added a note about installation instructions being included; fixed hierarchy of headlines

Dirk: removed link to "live" test results (since they're not working yet); added category

2009-08-15T19:16:21Z

removed link to "live" test results (since they're not working yet); added category

Dirk: fixed typo in Wikipedia link

2009-08-15T19:09:29Z

fixed typo in Wikipedia link

Sean c: /* Working with databases */

2009-08-14T23:27:45Z

‎Working with databases

Sean c at 23:26, 14 August 2009

2009-08-14T23:26:54Z

Sean c at 23:21, 14 August 2009

2009-08-14T23:21:32Z

Sean c: /* Advanced details */

2009-08-14T23:17:02Z

‎Advanced details

@@ Line 105: / Line 105: @@
 * [http://project.geeklog.net/cgi-bin/hgwebdir.cgi/test-framework/ Mercurial repository]
-* [http://project.geeklog.net:8080/ Test suite running in Jenkins]
+* [http://project.geeklog.net:8080/ Test suite running] in [[Jenkins]]
 [[Category:Development]]

@@ Line 105: / Line 105: @@
 * [http://project.geeklog.net/cgi-bin/hgwebdir.cgi/test-framework/ Mercurial repository]
-* [http://project.geeklog.net:8080/ Test suite running in Hudson]
+* [http://project.geeklog.net:8080/ Test suite running in Jenkins]
 [[Category:Development]]

@@ Line 100: / Line 100: @@
   $tests = new Tests;
 ) Now we can perform any action on the test framework already scripted in tests.class.php, if you need to do something not already provided in this class, add it if you think it may be useful to other people. If it's something that will only be used once, just put it in the script. In this example, we tell $tests->runTests() to run tests on all files under 'suite', create a JSON log for the output, and discard the console output. A cronjob could be pointed at this and run it on a specified schedule.
 [[Category:Development]]

@@ Line 6: / Line 6: @@
 Using the test suite, you can run tests on the existing code, ensuring that the code continues to do exactly what it is supposed to do in a variety of scenarios. The suite uses a GUI, which displays existing tests that can be run, returns PHPUnit's console output, and stores the results to log files that can be viewed at any time.
 == How do I use it? ==
-== '''Running tests''' ==
+=== Running tests ===
 You have two ways you can run your tests. One is by using a simple GUI included with the test package, and the second is by using the console.
@@ Line 24: / Line 27: @@
-== '''Viewing and deleting logs''' ==
+=== Viewing and deleting logs ===
 If you are running tests with the GUI, the event will be logged in testpackage/logs/masterlog.txt, and JSON logs will be created in the same folder with information for the event. You can view these logs using the 'View logs' panel in the GUI - select the logs you want to view and press 'View'. Alternatively, you can delete old logs by selecting the logs and - you got it - pressing 'Delete'.
@@ Line 31: / Line 34: @@
 == Advanced details ==
-== '''Structure''' ==
+=== Structure ===
 Here is the file structure of the test suite:
@@ Line 54: / Line 57: @@
          -jobs (Scripts which can be pointed at by GUI and cronjobs to interact with test framework)
-== ''' Working with databases''' ==
+=== Working with databases ===
 This test package is designed to work with or without a Geeklog install. It does this by using the configuration paths you specified in the installation, and by using a XML version of Geeklog's SQL database. To write tests for a file requiring database calls, first ensure that default.xml exists (in testpackage/files/databases). This is the XML version of Geeklog's database, as appears after a fresh install. The class that handles the operations (done with simpleXML and xPath) on the database is xmldb.class.php, under testpackage/files/databases.
@@ Line 70: / Line 73: @@
 If you don't specify a database, it will load default.xml.
-== '''Adding tests''' ==
+=== Adding tests ===
 This will integrate new PHPUnit tests with the Geeklog test framework, (for example, if you wanted to write your own tests for Geeklog files and add them to the suite).
@@ Line 87: / Line 90: @@
 Your test should be ready to run!
-== '''Adding jobs''' ==
+=== Adding jobs ===
 With a few lines of code, you can interact with the Geeklog test framework's test running and logging system through what the test framework calls 'jobs'. These scripts are typically stored under tests/gui/jobs. You can browse through the existing scripts and tests.class.php to see how they work and are implemented. Let's take 'tests/gui/jobs/runAll.php' as an example.

@@ Line 1: / Line 1: @@
-Geeklog has its own [http://en.wikipedia.org/wiki/Unit_testing unit testing] suite, powered by [http://www.phpunit.de/ PHPUnit]. You can see the logging features being used at the [http://project.geeklog.net/ttt/tests/index_js.php Geeklog project site].
+Geeklog has its own [http://en.wikipedia.org/wiki/Unit_testing unit testing] suite, powered by [http://www.phpunit.de/ PHPUnit].
@@ Line 97: / Line 97: @@
   $tests = new Tests;
 ) Now we can perform any action on the test framework already scripted in tests.class.php, if you need to do something not already provided in this class, add it if you think it may be useful to other people. If it's something that will only be used once, just put it in the script. In this example, we tell $tests->runTests() to run tests on all files under 'suite', create a JSON log for the output, and discard the console output. A cronjob could be pointed at this and run it on a specified schedule.

← Older revision		Revision as of 19:09, 15 August 2009
Line 1:		Line 1:
−	Geeklog has its own [http://en.wikipedia.org/wiki/Unit_testing) unit testing] suite, powered by [http://www.phpunit.de/ PHPUnit]. You can see the logging features being used at the [http://project.geeklog.net/ttt/tests/index_js.php Geeklog project site].	+	Geeklog has its own [http://en.wikipedia.org/wiki/Unit_testing unit testing] suite, powered by [http://www.phpunit.de/ PHPUnit]. You can see the logging features being used at the [http://project.geeklog.net/ttt/tests/index_js.php Geeklog project site].

@@ Line 59: / Line 59: @@
 You can use xmldb.class.php in three steps.
 . Require tst.class.php, e.g: require_once 'tst.class.php'. You should be doing this anyway.
 . Require the file, e.g: require_once Tst::$tests.'/files/databases/xmldb.class.php'.
 . Create an object, e.g: $this->xml = new Xmldb;
-. Call the function you want, providing the database you want to load as the parameter, e.g: $_CONF = $this->xml->get_CONF('database'). If you don't specify a database, it will load default.xml.
+. Create an object, e.g:
+ $this->xml = new Xmldb;
 == '''Adding tests''' ==

@@ Line 9: / Line 9: @@
 == How do I use it? ==
-'''1. Running tests'''
+== '''Running tests''' ==
 You have two ways you can run your tests. One is by using a simple GUI included with the test package, and the second is by using the console.
@@ Line 24: / Line 24: @@
-'''2. Viewing and deleting logs'''
+== '''Viewing and deleting logs''' ==
 If you are running tests with the GUI, the event will be logged in testpackage/logs/masterlog.txt, and JSON logs will be created in the same folder with information for the event. You can view these logs using the 'View logs' panel in the GUI - select the logs you want to view and press 'View'. Alternatively, you can delete old logs by selecting the logs and - you got it - pressing 'Delete'.
@@ Line 31: / Line 31: @@
 == Advanced details ==
-'''1. Structure'''
+== '''Structure''' ==
 Here is the file structure of the test suite:
@@ Line 54: / Line 54: @@
          -jobs (Scripts which can be pointed at by GUI and cronjobs to interact with test framework)
-'''2. Working with databases'''
+== ''' Working with databases''' ==
 This test package is designed to work with or without a Geeklog install. It does this by using the configuration paths you specified in the installation, and by using a XML version of Geeklog's SQL database. To write tests for a file requiring database calls, first ensure that default.xml exists (in testpackage/files/databases). This is the XML version of Geeklog's database, as appears after a fresh install. The class that handles the operations (done with simpleXML and xPath) on the database is xmldb.class.php, under testpackage/files/databases.
@@ Line 64: / Line 64: @@
 . Call the function you want, providing the database you want to load as the parameter, e.g: $_CONF = $this->xml->get_CONF('database'). If you don't specify a database, it will load default.xml.
-'''3. Adding tests'''
+== '''3. Adding tests''' ==
 This will integrate new PHPUnit tests with the Geeklog test framework, (for example, if you wanted to write your own tests for Geeklog files and add them to the suite).
@@ Line 81: / Line 81: @@
 Your test should be ready to run!
-'''4. Adding jobs'''
+== '''4. Adding jobs''' ==
 With a few lines of code, you can interact with the Geeklog test framework's test running and logging system. These scripts are typically stored under tests/gui/jobs. You can browse through the existing scripts and tests.class.php to see how they work and are implemented. Let's take 'tests/gui/jobs/runAll.php' as an example.

@@ Line 48: / Line 48: @@
      -tests (This should be in your webroot)
          -gui (Files for GUI)
-        -css
+           -css
-        -development-bundle
+           -development-bundle
-        -images
+           -images
-         -jobs (Scripts user by GUI and cronjobs, etc. can be pointed at to interact with test framework)
+           -js
-        -js
+         -jobs (Scripts which can be pointed at by GUI and cronjobs to interact with test framework)
 '''2. Working with databases'''