1 <?php // #!/usr/local/bin/php -Cq
2 /* Copyright (C) 2004 Dan Frankowski <dfrankow@cs.umn.edu>
3 * Copyright (C) 2004,2005 Reini Urban <rurban@x-ray.at>
5 * This file is part of PhpWiki.
7 * PhpWiki is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * PhpWiki is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with PhpWiki; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * Unit tests for PhpWiki.
25 * You must have PEAR's PHPUnit package <http://pear.php.net/package/PHPUnit>.
26 * These tests are unrelated to test/maketest.pl, which do not use PHPUnit.
27 * These tests run from the command-line as well as from the browser.
28 * Use the argv (from cli) or tests (from browser) params to run only certain tests.
30 * $ tests.php test=<testname1> test=<testname2> ... db=dba debug=9 level=10
32 /****************************************************************
33 User definable options
34 *****************************************************************/
35 // common cfg options are taken from config/config.ini
37 //TODO: let the user decide which constants to use: define="x=y"
38 //define('USE_DB_SESSION', false);
39 //define('ENABLE_USER_NEW', false);
41 // memory usage: (8MB limit on certain servers)
43 // cli: Mem16712 => Mem16928
44 // web: Mem21216 => Mem26332 (5MB)
47 // cli: Mem20696 => Mem31240 (with USECACHE) (10MB)
48 // cli: Mem20240 => Mem30212 (without USECACHE) (10MB)
49 // web: Mem29424 => Mem35400 (without USECACHE) (6MB)
50 //define('USECACHE', false);
52 ####################################################################
54 # Preamble needed to get the tests to run.
56 ####################################################################
59 // Add root dir to the path
60 if (substr(PHP_OS,0,3) == 'WIN')
61 $cur_dir = str_replace("\\","/", $cur_dir);
62 $rootdir = $cur_dir . '/../../';
63 $ini_sep = substr(PHP_OS,0,3) == 'WIN' ? ';' : ':';
64 $include_path = ini_get('include_path') . $ini_sep . $rootdir . $ini_sep . $rootdir . "lib/pear";
65 ini_set('include_path', $include_path);
66 define('DEFAULT_LANGUAGE','en'); // don't use browser detection
69 if (!empty($HTTP_SERVER_VARS) and $HTTP_SERVER_VARS["SERVER_NAME"] == 'phpwiki.sourceforge.net') {
70 ini_set('include_path', ini_get('include_path') . ":/usr/share/pear");
71 //define('ENABLE_PAGEPERM',false); // costs nothing
72 define('USECACHE',false); // really?
73 //define('WIKIDB_NOCACHE_MARKUP',1);
76 // available database backends to test:
77 $database_backends = array(
80 'SQL', // default backend defined in the config.ini DSN
81 'ADODB', // same backend as defined in the config.ini DSN
82 // specific backends (need to be setup)
83 'PearDB_pgsql', 'PearDB_sqlite', 'PearDB_mysql',
86 'ADODB_postgres7', 'ADODB_sqlite', 'ADODB_mysql',
89 'PDO_pqsql', 'PDO_sqlite', 'PDO_mysql',
90 //'PDO_oci', 'PDO_odbc',
92 //TODO: convert cvs test
93 //TODO: read some database values from config.ini, just use the "test_" prefix
94 // "flatfile" testing occurs in "tests/unit/.testbox/"
95 // "dba" needs the DATABASE_DBA_HANDLER, also in the .textbox directory
96 //$database_dba_handler = (substr(PHP_OS,0,3) == 'WIN') ? "db3" : "gdbm";
97 // "SQL" and "ADODB" need delete permissions to the test db
98 // You have to create that database beforehand with our schema
99 //$database_dsn = "mysql://wikiuser:@localhost/phpwiki";
100 $database_prefix = "test_";
101 // For "cvs" see the seperate tests/unit_test_backend_cvs.php (cvs is experimental)
103 // Quiet warnings in IniConfig.php
104 $HTTP_SERVER_VARS['REMOTE_ADDR'] = '127.0.0.1';
105 $HTTP_SERVER_VARS['HTTP_USER_AGENT'] = "PHPUnit";
107 function printMemoryUsage($msg = '') {
110 if ($msg) echo $msg,"\n";
111 if ((defined('DEBUG') and (DEBUG & 8)) or !defined('DEBUG')) {
112 require_once("lib/stdlib.php");
113 echo "-- MEMORY USAGE: ";
115 $mem = getMemoryUsage();
116 if (!$initmem) $initmem = $mem;
117 // old libc on sf.net server doesn't understand "%+4d"
118 echo sprintf("%8d\t[%s%4d]\t[+%4d]\n", $mem, $mem > $oldmem ? "+" : ($mem == $oldmem ? " " : ""),
119 $mem - $oldmem, $mem - $initmem);
124 /* // now in stdlib.php
125 function printSimpleTrace($bt) {
128 foreach ($bt as $i => $elem) {
129 if (!array_key_exists('file', $elem)) {
132 print " " . $elem['file'] . ':' . $elem['line'] . "\n";
136 // Show lots of detail when an assert() in the code fails
137 function assert_callback( $script, $line, $message ) {
138 echo "assert failed: script ", $script," line ", $line," :";
140 if (function_exists('debug_backtrace')) { // >= 4.3.0
142 printSimpleTrace(debug_backtrace());
146 $foo = assert_options( ASSERT_CALLBACK, 'assert_callback');
149 // Get error reporting to call back, too
151 // set the error reporting level for this script
152 if (defined('E_STRICT') and (E_ALL & E_STRICT)) // strict php5?
153 error_reporting(E_ALL & ~E_STRICT); // exclude E_STRICT
155 error_reporting(E_ALL); // php4
157 // This is too strict, fails on every notice and warning.
159 function myErrorHandler$errno, $errstr, $errfile, $errline) {
160 echo "$errfile: $errline: error# $errno: $errstr\n";
162 printSimpleTrace(debug_backtrace());
164 // The ErrorManager version
165 function _ErrorHandler_CB(&$error) {
167 printSimpleTrace(debug_backtrace());
168 if ($error->isFatal()) {
169 $error->errno = E_USER_WARNING;
170 return true; // ignore error
174 // set to the user defined error handler
175 // $old_error_handler = set_error_handler("myErrorHandler");
176 // This is already done via _DEBUG_TRACE
177 //$ErrorManager->pushErrorHandler(new WikiFunctionCb('_ErrorHandler_CB'));
180 function purge_dir($dir) {
182 if (!isset($finder)) {
183 $finder = new FileFinder;
185 $fileSet = new fileSet($dir);
186 assert(!empty($dir));
187 foreach ($fileSet->getFiles() as $f) {
192 function purge_testbox() {
194 if (isset($GLOBALS['request'])) {
195 $dbi = $GLOBALS['request']->getDbh();
197 $dir = $DBParams['directory'];
198 switch ($DBParams['dbtype']) {
200 assert(!empty($dir));
201 foreach (array('latest_ver','links','page_data','ver_data') as $d) {
202 purge_dir("$dir/$d");
208 foreach ($dbi->_backend->_table_names as $table) {
209 $dbi->genericSqlQuery("DELETE FROM $table");
217 $dbi->_cache->close();
218 $dbi->_backend->_latest_versions = array();
222 function printConstant($v) {
225 if (constant($v) or constant($v)===0 or constant($v)==='0') echo constant($v);
227 } else echo "undefined";
231 * via the HTML sapi interface print a form to easily change the current cmdline settings.
233 function html_option_form() {
234 global $debug_level, $user_level, $start_debug;
237 $option = HTML::div(array('class' => 'option'),
238 HTML::span(array('style'=>'font-weight: bold','onDblClick'=>'flipAll(\'test[\')'), 'test: '),
240 foreach ($GLOBALS['alltests'] as $s) {
241 $input = array('type' => 'checkbox', 'name' => 'test['.$s.']', 'value' => '1');
242 if (in_array($s,$GLOBALS['runtests'])) $input['checked'] = 'checked';
243 $option->pushContent(HTML::input($input), $s, HTML::br());
245 $form->pushContent(HTML::td($option));
247 $option = HTML::div(array('class' => 'option'),
248 HTML::span(array('style'=>'font-weight: bold','onDblClick'=>'flipAll(\'db[\')'), 'db: '),
250 foreach ($GLOBALS['database_backends'] as $s) {
251 $input = array('type' => 'checkbox', 'name' => 'db['.$s.']', 'value' => '1');
252 if (in_array($s,$GLOBALS['run_database_backends'])) $input['checked'] = 'checked';
253 $option->pushContent(HTML::input($input), $s, HTML::br());
255 $form->pushContent(HTML::td($option));
258 "function flipAll(formName) {
260 formObj = document.forms[0];
261 for (var i=0; i < formObj.length; i++) {
262 fldObj = formObj.elements[i];
263 if ((fldObj.type == 'checkbox') && (fldObj.name.substring(0,formName.length) == formName)) {
264 if (isFirstSet == -1)
265 isFirstSet = (fldObj.checked) ? true : false;
266 fldObj.checked = (isFirstSet) ? false : true;
270 function updateDebugEdit(formObj) {
272 for (var i=0; i < formObj.length; i++) {
273 fldObj = formObj.elements[i];
274 if ((fldObj.type == 'checkbox') && (fldObj.name.substring(0,7) == '_debug[')) {
275 if (fldObj.checked) val = val + parseInt(fldObj.value);
278 formObj.debug.value = val;
280 function updateLevelEdit(formObj) {
281 for (var i=0; i < formObj.length; i++) {
282 fldObj = formObj.elements[i];
283 if ((fldObj.type == 'radio') && (fldObj.name.substring(0,7) == '_level[')) {
284 if (fldObj.checked) {
285 formObj.level.value = fldObj.value;
291 $option = HTML::div(array('class' => 'option'),
292 HTML::span(array('style'=>'font-weight: bold','onDblClick'=>'flipAll(\'_debug[\')'), 'debug: '),
293 HTML::input(array('name'=>'debug','id'=>'debug','value'=>$debug_level,'size'=>5)),
295 foreach (array('VERBOSE' => 1,
304 $input = array('type' => 'checkbox', 'name' => '_debug[]', 'value' => $v,
305 'onClick' => 'updateDebugEdit(this.form)');
306 if ($debug_level & $v) $input['checked'] = 'checked';
307 $option->pushContent(HTML::input($input), "_DEBUG_".$s, HTML::br());
309 $form->pushContent(HTML::td($option));
311 $option = HTML::div(array('class' => 'option'),
312 HTML::span(array('style'=>'font-weight: bold'), "level: "),
313 HTML::input(array('name'=>'level','id'=>'level','value'=>$user_level,'size'=>5)),
315 foreach (array('FORBIDDEN' => -1,
320 'UNOBTAINABLE'=> 100,
322 $input = array('type' => 'radio', 'name' => '_level[]', 'value' => $v,
323 'onClick' => 'updateLevelEdit(this.form)');
324 if ($user_level & $v) $input['checked'] = 'checked';
325 $option->pushContent(HTML::input($input), "WIKIAUTH_".$s, HTML::br());
327 $form->pushContent(HTML::td($option));
330 $option = HTML::div(array('class' => 'option'), 'defines: ', HTML::br());
331 if (!empty($GLOBALS['define']))
332 foreach ($GLOBALS['define'] as $s) {
334 $input = array('type' => 'edit', 'name' => $s, 'value' => constant($s));
335 $option->pushContent(HTML::input($input), $s, HTML::br());
339 $form->pushContent(HTML::td($option));
340 $table = HTML::form(array('action' => $_SERVER['PHP_SELF'],
342 'accept-charset' => $GLOBALS['charset']),
344 HTML::table(HTML::tr(array('valign'=>'top'), $form)),
345 HTML::input(array('type' => 'submit')),
346 HTML::input(array('type' => 'reset')));
348 $table->pushContent(HiddenInputs(array('start_debug' => $start_debug)));
349 return $table->printXml();
352 //####################################################################
354 // End of preamble, run the test suite ..
356 //####################################################################
360 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD']))
362 elseif (!empty($HTTP_SERVER_VARS['argv']))
363 $argv = $HTTP_SERVER_VARS['argv'];
364 elseif (!ini_get("register_argc_argv"))
365 echo "Could not read cmd args (register_argc_argv=Off?)\n";
368 $debug_level = 1; //was 9, _DEBUG_VERBOSE | _DEBUG_TRACE
369 //if (defined('E_STRICT')) $debug_level = 5; // add PARSER flag on php5
370 $user_level = 1; // BOGO (conflicts with RateIt)
371 // use argv (from cli) or tests (from browser) params to run only certain tests
372 // avoid pear: Console::Getopt
373 $alltests = array('InlineParserTest','HtmlParserTest',
374 'PageListTest','ListPagesTest',
376 'AllPagesTest','AllUsersTest','OrphanedPagesTest','WantedPagesTest','TextSearchTest',
378 // support db=file db=dba test=SetupWiki test=DumpHtml debug=num -dconstant=value
379 // or db=file,dba test=SetupWiki,DumpHtml debug=num -dconstant=value
380 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD'])) {
382 foreach ($HTTP_GET_VARS as $key => $val) {
384 foreach ($val as $k => $v) $argv[] = $key."=".$k;
385 elseif (strstr($val,",") and in_array($key, array("test","db")))
386 foreach (explode(",",$val) as $v) $argv[] = $key."=".$v;
388 $argv[] = $key."=".$val;
390 } elseif (!empty($argv) and preg_match("/test\.php$/", $argv[0])) {
396 $run_database_backends = array();
397 foreach ($argv as $arg) {
398 if (preg_match("/^test=(.+)$/",$arg,$m) and in_array($m[1], $alltests))
400 elseif (preg_match("/^db=(.+)$/",$arg,$m) and in_array($m[1], $database_backends))
401 $run_database_backends[] = $m[1];
402 elseif (preg_match("/^debug=(\d+)$/",$arg,$m))
403 $debug_level = $m[1];
404 elseif (preg_match("/^level=(\d+)$/",$arg,$m))
406 elseif (preg_match("/^\-d(\w+)=(.+)$/",$arg,$m)) {
407 $define[$m[1]] = $m[2];
408 if ($m[2] == 'true') $m[2] = true;
409 elseif ($m[2] == 'false') $m[2] = false;
410 if (!defined($m[1])) define($m[1], $m[2]);
411 } elseif (in_array($arg, $alltests))
413 elseif ($debug_level & 1)
414 echo "ignored arg: ", $arg, "\n";
418 if (empty($run_database_backends))
419 $run_database_backends = $database_backends;
420 if (empty($runtests))
421 $runtests = $alltests;
422 if ($debug_level & 1) {
424 echo "PHP_SAPI=",php_sapi_name(), "\n";
425 echo "PHP_OS=",PHP_OS, "\n";
426 echo "PHP_VERSION=",PHP_VERSION, "\n";
427 echo "test=", join(",",$runtests),"\n";
428 echo "db=", join(",",$run_database_backends),"\n";
429 echo "debug=", $debug_level,"\n";
430 echo "level=", $user_level,"\n";
431 if (!empty($define)) {
432 foreach ($define as $k => $v) printConstant($k);
434 if ($debug_level & 8) {
435 echo "pid=",getmypid(),"\n";
441 if (!defined('DEBUG'))
442 define('DEBUG', $debug_level);
443 // override defaults:
444 if (!defined('RATING_STORAGE'))
445 define('RATING_STORAGE', 'WIKIPAGE');
446 if (!defined('GROUP_METHOD'))
447 define('GROUP_METHOD', 'NONE');
450 printMemoryUsage("beforePEAR");
453 printMemoryUsage("beforePhpWiki");
455 define('PHPWIKI_NOMAIN', true);
456 // Other needed files
457 require_once $rootdir.'index.php';
458 require_once $rootdir.'lib/main.php';
460 // init filefinder for pear path fixup.
461 FindFile ('PHPUnit.php', 'missing_okay');
462 // PEAR library (requires version ??)
463 require_once 'PHPUnit.php';
467 if ($debug_level & 1) {
469 echo "PHPWIKI_VERSION=",PHPWIKI_VERSION, strstr(PHPWIKI_VERSION,"pre") ? strftime(" / %Y%m%d") : "","\n";
470 if ($debug_level & 9) {
471 // which constants affect memory?
472 foreach (explode(",","USECACHE,WIKIDB_NOCACHE_MARKUP,ENABLE_USER_NEW,ENABLE_PAGEPERM") as $v) {
479 global $ErrorManager;
480 $ErrorManager->setPostponedErrorMask(EM_FATAL_ERRORS|EM_WARNING_ERRORS|EM_NOTICE_ERRORS);
481 // FIXME: ignore cached requests (if-modified-since) from cli
482 class MockRequest extends WikiRequest {
483 function MockRequest(&$dbparams) {
484 $this->_dbi = WikiDB::open($dbparams);
485 $this->_user = new MockUser("a_user", $GLOBALS['user_level']);
486 $this->_group = new GroupNone();
487 $this->_args = array('pagename' => 'HomePage', 'action' => 'browse');
490 function getGroup() {
491 if (is_object($this->_group))
492 return $this->_group;
493 else // FIXME: this is set to "/f:" somewhere.
494 return new GroupNone();
498 if (ENABLE_USER_NEW) {
499 class MockUser extends _WikiUser {
500 function MockUser($name, $level) {
501 $this->_userid = $name;
502 $this->_isSignedIn = $level > 1;
503 $this->_level = $level;
505 function isSignedIn() {
506 return $this->_isSignedIn;
510 class MockUser extends WikiUser {
511 function MockUser($name, $level) {
512 $this->_userid = $name;
513 $this->_isSignedIn = $level > 1;
514 $this->_level = $level;
516 function isSignedIn() {
517 return $this->_isSignedIn;
524 $request->_user = WikiUser('AnonUser');
526 $request->_user = new WikiUser($request, 'AnonUser');
527 $request->_prefs = $request->_user->getPreferences();
530 if (DEBUG & _DEBUG_TRACE)
531 printMemoryUsage("PhpWikiLoaded");
533 // provide a nice input form for all options
534 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD'])) {
535 echo html_option_form();
538 // save and restore all args for each test.
539 class phpwiki_TestCase extends PHPUnit_TestCase {
541 global $request, $WikiTheme;
542 include_once("themes/" . THEME . "/themeinfo.php");
543 $this->_savedargs = $request->_args;
544 $request->_args = array();
546 echo $this->_name,"\n";
550 function tearDown() {
552 $request->_args = $this->_savedargs;
553 if (DEBUG & _DEBUG_TRACE)
558 // Test all db backends.
559 foreach ($run_database_backends as $dbtype) {
560 // if (DEBUG & _DEBUG_TRACE)
561 // printMemoryUsage("PHPUnitInitialized");
562 $DBParams['dbtype'] = $dbtype;
563 if (string_starts_with($dbtype, 'PearDB_')) {
564 $DBParams['dbtype'] = 'SQL';
565 preg_replace("/^([^:]+):/", substr($dbtype, 7).":", $DBParams['dsn']);
567 if (string_starts_with($dbtype, 'ADODB_')) {
568 $DBParams['dbtype'] = 'ADODB';
569 preg_replace("/^([^:]+):/", substr($dbtype, 6).":", $DBParams['dsn']);
571 if (string_starts_with($dbtype, 'PDO_')) {
572 $DBParams['dbtype'] = 'PDO';
573 preg_replace("/^([^:]+):/", substr($dbtype, 4).":", $DBParams['dsn']);
575 $DBParams['directory'] = $cur_dir . '/.testbox';
576 $DBParams['prefix'] = $database_prefix;
578 //$DBParams['dba_handler'] = $database_dba_handler;
580 echo "Testing DB Backend \"$dbtype\" ...\n";
581 $request = new MockRequest($DBParams);
582 if ( ! ENABLE_USER_NEW ) {
583 $request->_user->_request =& $request;
584 $request->_user->_dbi =& $request->_dbi;
586 if (DEBUG & _DEBUG_TRACE)
587 printMemoryUsage("PhpWikiInitialized");
589 foreach ($runtests as $test) {
590 if (!@ob_get_level()) ob_start();
591 $suite = new PHPUnit_TestSuite("phpwiki");
592 if (file_exists(dirname(__FILE__).'/lib/'.$test.'.php'))
593 require_once dirname(__FILE__).'/lib/'.$test.'.php';
595 require_once dirname(__FILE__).'/lib/plugin/'.$test.'.php';
596 $suite->addTest( new PHPUnit_TestSuite($test) );
598 @set_time_limit(240);
599 $result = PHPUnit::run($suite);
600 echo "ran " . $result->runCount() . " tests, " . $result->failureCount() . " failures.\n";
602 if ($result->failureCount() > 0) {
603 echo "More detail:\n";
604 echo $result->toString();
608 $request->chunkOutput();
609 $request->_dbi->close();
610 unset($request->_user);
611 unset($request->_dbi);
617 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD']))
620 // (c-file-style: "gnu")
625 // c-hanging-comment-ender-p: nil
626 // indent-tabs-mode: nil