1 <?php // #!/usr/local/bin/php -Cq
2 /* Copyright (C) 2004 Dan Frankowski <dfrankow@cs.umn.edu>
3 * Copyright (C) 2004 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
68 if (!empty($HTTP_SERVER_VARS) and $HTTP_SERVER_VARS["SERVER_NAME"] == 'phpwiki.sourceforge.net') {
69 ini_set('include_path', ini_get('include_path') . ":/usr/share/pear");
70 //define('ENABLE_PAGEPERM',false); // costs nothing
71 define('USECACHE',false); // really?
72 //define('WIKIDB_NOCACHE_MARKUP',1);
75 // available database backends to test:
76 $database_backends = array(
82 //TODO: convert cvs test
83 //TODO: read some database values from config.ini, just use the "test_" prefix
84 // "flatfile" testing occurs in "tests/unit/.testbox/"
85 // "dba" needs the DATABASE_DBA_HANDLER, also in the .textbox directory
86 //$database_dba_handler = (substr(PHP_OS,0,3) == 'WIN') ? "db3" : "gdbm";
87 // "SQL" and "ADODB" need delete permissions to the test db
88 // You have to create that database beforehand with our schema
89 //$database_dsn = "mysql://wikiuser:@localhost/phpwiki";
90 $database_prefix = "test_";
91 // For "cvs" see the seperate tests/unit_test_backend_cvs.php (cvs is experimental)
93 # Quiet warnings in IniConfig.php
94 $HTTP_SERVER_VARS['REMOTE_ADDR'] = '127.0.0.1';
95 $HTTP_SERVER_VARS['HTTP_USER_AGENT'] = "PHPUnit";
97 function printMemoryUsage($msg = '') {
100 if ($msg) echo $msg,"\n";
101 if ((defined('DEBUG') and (DEBUG & 8)) or !defined('DEBUG')) {
102 require_once("lib/stdlib.php");
103 echo "-- MEMORY USAGE: ";
105 $mem = getMemoryUsage();
106 if (!$initmem) $initmem = $mem;
107 // old libc on sf.net server doesn't understand "%+4d"
108 echo sprintf("%8d\t[%s%4d]\t[+%4d]\n", $mem, $mem > $oldmem ? "+" : ($mem == $oldmem ? " " : ""),
109 $mem - $oldmem, $mem - $initmem);
114 /* // now in stdlib.php
115 function printSimpleTrace($bt) {
118 foreach ($bt as $i => $elem) {
119 if (!array_key_exists('file', $elem)) {
122 print " " . $elem['file'] . ':' . $elem['line'] . "\n";
126 # Show lots of detail when an assert() in the code fails
127 function assert_callback( $script, $line, $message ) {
128 echo "assert failed: script ", $script," line ", $line," :";
130 if (function_exists('debug_backtrace')) { // >= 4.3.0
132 printSimpleTrace(debug_backtrace());
136 $foo = assert_options( ASSERT_CALLBACK, 'assert_callback');
139 # Get error reporting to call back, too
141 // set the error reporting level for this script
142 if (defined('E_STRICT') and (E_ALL & E_STRICT)) // strict php5?
143 error_reporting(E_ALL & ~E_STRICT); // exclude E_STRICT
145 error_reporting(E_ALL); // php4
147 // This is too strict, fails on every notice and warning.
149 function myErrorHandler$errno, $errstr, $errfile, $errline) {
150 echo "$errfile: $errline: error# $errno: $errstr\n";
152 printSimpleTrace(debug_backtrace());
154 // The ErrorManager version
155 function _ErrorHandler_CB(&$error) {
157 printSimpleTrace(debug_backtrace());
158 if ($error->isFatal()) {
159 $error->errno = E_USER_WARNING;
160 return true; // ignore error
164 // set to the user defined error handler
165 // $old_error_handler = set_error_handler("myErrorHandler");
166 // This is already done via _DEBUG_TRACE
167 //$ErrorManager->pushErrorHandler(new WikiFunctionCb('_ErrorHandler_CB'));
170 function purge_dir($dir) {
172 if (!isset($finder)) {
173 $finder = new FileFinder;
175 $fileSet = new fileSet($dir);
176 assert(!empty($dir));
177 foreach ($fileSet->getFiles() as $f) {
182 function purge_testbox() {
184 if (isset($GLOBALS['request'])) {
185 $dbi = $GLOBALS['request']->getDbh();
187 $dir = $DBParams['directory'];
188 switch ($DBParams['dbtype']) {
190 assert(!empty($dir));
191 foreach (array('latest_ver','links','page_data','ver_data') as $d) {
192 purge_dir("$dir/$d");
197 foreach ($dbi->_backend->_table_names as $table) {
198 $dbi->genericSqlQuery("DELETE FROM $table");
206 $dbi->_cache->close();
207 $dbi->_backend->_latest_versions = array();
211 function printConstant($v) {
214 if (constant($v) or constant($v)===0 or constant($v)==='0') echo constant($v);
216 } else echo "undefined";
220 * via the HTML sapi interface print a form to easily change the current cmdline settings.
222 function html_option_form() {
223 global $debug_level, $user_level, $start_debug;
226 $option = HTML::div(array('class' => 'option'),
227 HTML::span(array('style'=>'font-weight: bold','onDblClick'=>'flipAll(\'test[\')'), 'test: '),
229 foreach ($GLOBALS['alltests'] as $s) {
230 $input = array('type' => 'checkbox', 'name' => 'test['.$s.']', 'value' => '1');
231 if (in_array($s,$GLOBALS['runtests'])) $input['checked'] = 'checked';
232 $option->pushContent(HTML::input($input), $s, HTML::br());
234 $form->pushContent(HTML::td($option));
236 $option = HTML::div(array('class' => 'option'),
237 HTML::span(array('style'=>'font-weight: bold','onDblClick'=>'flipAll(\'db[\')'), 'db: '),
239 foreach ($GLOBALS['database_backends'] as $s) {
240 $input = array('type' => 'checkbox', 'name' => 'db['.$s.']', 'value' => '1');
241 if (in_array($s,$GLOBALS['run_database_backends'])) $input['checked'] = 'checked';
242 $option->pushContent(HTML::input($input), $s, HTML::br());
244 $form->pushContent(HTML::td($option));
247 "function flipAll(formName) {
249 formObj = document.forms[0];
250 for (var i=0; i < formObj.length; i++) {
251 fldObj = formObj.elements[i];
252 if ((fldObj.type == 'checkbox') && (fldObj.name.substring(0,formName.length) == formName)) {
253 if (isFirstSet == -1)
254 isFirstSet = (fldObj.checked) ? true : false;
255 fldObj.checked = (isFirstSet) ? false : true;
259 function updateDebugEdit(formObj) {
261 for (var i=0; i < formObj.length; i++) {
262 fldObj = formObj.elements[i];
263 if ((fldObj.type == 'checkbox') && (fldObj.name.substring(0,7) == '_debug[')) {
264 if (fldObj.checked) val = val + parseInt(fldObj.value);
267 formObj.debug.value = val;
269 function updateLevelEdit(formObj) {
270 for (var i=0; i < formObj.length; i++) {
271 fldObj = formObj.elements[i];
272 if ((fldObj.type == 'radio') && (fldObj.name.substring(0,7) == '_level[')) {
273 if (fldObj.checked) {
274 formObj.level.value = fldObj.value;
280 $option = HTML::div(array('class' => 'option'),
281 HTML::span(array('style'=>'font-weight: bold','onDblClick'=>'flipAll(\'_debug[\')'), 'debug: '),
282 HTML::input(array('name'=>'debug','id'=>'debug','value'=>$debug_level,'size'=>5)),
284 foreach (array('VERBOSE' => 1,
293 $input = array('type' => 'checkbox', 'name' => '_debug[]', 'value' => $v,
294 'onClick' => 'updateDebugEdit(this.form)');
295 if ($debug_level & $v) $input['checked'] = 'checked';
296 $option->pushContent(HTML::input($input), "_DEBUG_".$s, HTML::br());
298 $form->pushContent(HTML::td($option));
300 $option = HTML::div(array('class' => 'option'),
301 HTML::span(array('style'=>'font-weight: bold'), "level: "),
302 HTML::input(array('name'=>'level','id'=>'level','value'=>$user_level,'size'=>5)),
304 foreach (array('FORBIDDEN' => -1,
309 'UNOBTAINABLE'=> 100,
311 $input = array('type' => 'radio', 'name' => '_level[]', 'value' => $v,
312 'onClick' => 'updateLevelEdit(this.form)');
313 if ($user_level & $v) $input['checked'] = 'checked';
314 $option->pushContent(HTML::input($input), "WIKIAUTH_".$s, HTML::br());
316 $form->pushContent(HTML::td($option));
319 $option = HTML::div(array('class' => 'option'), 'defines: ', HTML::br());
320 if (!empty($GLOBALS['define']))
321 foreach ($GLOBALS['define'] as $s) {
323 $input = array('type' => 'edit', 'name' => $s, 'value' => constant($s));
324 $option->pushContent(HTML::input($input), $s, HTML::br());
328 $form->pushContent(HTML::td($option));
329 $table = HTML::form(array('action' => $_SERVER['PHP_SELF'],
331 'accept-charset' => $GLOBALS['charset']),
333 HTML::table(HTML::tr(array('valign'=>'top'), $form)),
334 HTML::input(array('type' => 'submit')),
335 HTML::input(array('type' => 'reset')));
337 $table->pushContent(HiddenInputs(array('start_debug' => $start_debug)));
338 return $table->printXml();
341 ####################################################################
343 # End of preamble, run the test suite ..
345 ####################################################################
349 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD']))
351 elseif (!empty($HTTP_SERVER_VARS['argv']))
352 $argv = $HTTP_SERVER_VARS['argv'];
353 elseif (!ini_get("register_argc_argv"))
354 echo "Could not read cmd args (register_argc_argv=Off?)\n";
357 $debug_level = 1; //was 9, _DEBUG_VERBOSE | _DEBUG_TRACE
358 //if (defined('E_STRICT')) $debug_level = 5; // add PARSER flag on php5
359 $user_level = 1; // BOGO (conflicts with RateIt)
360 // use argv (from cli) or tests (from browser) params to run only certain tests
361 // avoid pear: Console::Getopt
362 $alltests = array('InlineParserTest','HtmlParserTest',
363 'PageListTest','ListPagesTest',
365 'AllPagesTest','AllUsersTest','OrphanedPagesTest','WantedPagesTest','TextSearchTest',
367 // support db=file db=dba test=SetupWiki test=DumpHtml debug=num -dconstant=value
368 // or db=file,dba test=SetupWiki,DumpHtml debug=num -dconstant=value
369 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD'])) {
371 foreach ($HTTP_GET_VARS as $key => $val) {
373 foreach ($val as $k => $v) $argv[] = $key."=".$k;
374 elseif (strstr($val,",") and in_array($key, array("test","db")))
375 foreach (explode(",",$val) as $v) $argv[] = $key."=".$v;
377 $argv[] = $key."=".$val;
379 } elseif (!empty($argv) and preg_match("/test\.php$/", $argv[0])) {
385 $run_database_backends = array();
386 foreach ($argv as $arg) {
387 if (preg_match("/^test=(.+)$/",$arg,$m) and in_array($m[1], $alltests))
389 elseif (preg_match("/^db=(.+)$/",$arg,$m) and in_array($m[1], $database_backends))
390 $run_database_backends[] = $m[1];
391 elseif (preg_match("/^debug=(\d+)$/",$arg,$m))
392 $debug_level = $m[1];
393 elseif (preg_match("/^level=(\d+)$/",$arg,$m))
395 elseif (preg_match("/^\-d(\w+)=(.+)$/",$arg,$m)) {
396 $define[$m[1]] = $m[2];
397 if ($m[2] == 'true') $m[2] = true;
398 elseif ($m[2] == 'false') $m[2] = false;
399 if (!defined($m[1])) define($m[1], $m[2]);
400 } elseif (in_array($arg, $alltests))
402 elseif ($debug_level & 1)
403 echo "ignored arg: ", $arg, "\n";
407 if (empty($run_database_backends))
408 $run_database_backends = $database_backends;
409 if (empty($runtests))
410 $runtests = $alltests;
411 if ($debug_level & 1) {
413 echo "PHP_SAPI=",php_sapi_name(), "\n";
414 echo "PHP_OS=",PHP_OS, "\n";
415 echo "PHP_VERSION=",PHP_VERSION, "\n";
416 echo "test=", join(",",$runtests),"\n";
417 echo "db=", join(",",$run_database_backends),"\n";
418 echo "debug=", $debug_level,"\n";
419 echo "level=", $user_level,"\n";
420 if (!empty($define)) {
421 foreach ($define as $k => $v) printConstant($k);
423 if ($debug_level & 8) {
424 echo "pid=",getmypid(),"\n";
430 if (!defined('DEBUG'))
431 define('DEBUG', $debug_level);
432 // override defaults:
433 if (!defined('RATING_STORAGE'))
434 define('RATING_STORAGE', 'WIKIPAGE');
435 if (!defined('GROUP_METHOD'))
436 define('GROUP_METHOD', 'NONE');
439 printMemoryUsage("beforePEAR");
442 printMemoryUsage("beforePhpWiki");
444 define('PHPWIKI_NOMAIN', true);
446 require_once $rootdir.'index.php';
447 require_once $rootdir.'lib/main.php';
449 // init filefinder for pear path fixup.
450 FindFile ('PHPUnit.php', 'missing_okay');
451 // PEAR library (requires version ??)
452 require_once 'PHPUnit.php';
456 if ($debug_level & 1) {
458 echo "PHPWIKI_VERSION=",PHPWIKI_VERSION, strstr(PHPWIKI_VERSION,"pre") ? strftime(" / %Y%m%d") : "","\n";
459 if ($debug_level & 9) {
460 // which constants affect memory?
461 foreach (explode(",","USECACHE,WIKIDB_NOCACHE_MARKUP,ENABLE_USER_NEW,ENABLE_PAGEPERM") as $v) {
468 global $ErrorManager;
469 $ErrorManager->setPostponedErrorMask(EM_FATAL_ERRORS|EM_WARNING_ERRORS|EM_NOTICE_ERRORS);
470 //FIXME: ignore cached requests (if-modified-since) from cli
471 class MockRequest extends WikiRequest {
472 function MockRequest(&$dbparams) {
473 $this->_dbi = WikiDB::open($dbparams);
474 $this->_user = new MockUser("a_user", $GLOBALS['user_level']);
475 $this->_group = new GroupNone();
476 $this->_args = array('pagename' => 'HomePage', 'action' => 'browse');
479 function getGroup() {
480 if (is_object($this->_group))
481 return $this->_group;
482 else // FIXME: this is set to "/f:" somewhere.
483 return new GroupNone();
487 if (ENABLE_USER_NEW) {
488 class MockUser extends _WikiUser {
489 function MockUser($name, $level) {
490 $this->_userid = $name;
491 $this->_isSignedIn = $level > 1;
492 $this->_level = $level;
494 function isSignedIn() {
495 return $this->_isSignedIn;
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;
513 $request->_user = WikiUser('AnonUser');
515 $request->_user = new WikiUser($request, 'AnonUser');
516 $request->_prefs = $request->_user->getPreferences();
519 include_once("themes/" . THEME . "/themeinfo.php");
520 if (DEBUG & _DEBUG_TRACE)
521 printMemoryUsage("PhpWikiLoaded");
523 // provide a nice input form for all options
524 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD'])) {
525 echo html_option_form();
528 // save and restore all args for each test.
529 class phpwiki_TestCase extends PHPUnit_TestCase {
532 $this->_savedargs = $request->_args;
533 $request->_args = array();
535 echo $this->_name,"\n";
539 function tearDown() {
541 $request->_args = $this->_savedargs;
542 if (DEBUG & _DEBUG_TRACE)
547 # Test all db backends.
548 foreach ($run_database_backends as $dbtype) {
549 // if (DEBUG & _DEBUG_TRACE)
550 // printMemoryUsage("PHPUnitInitialized");
552 $DBParams['dbtype'] = $dbtype;
553 $DBParams['directory'] = $cur_dir . '/.testbox';
554 $DBParams['prefix'] = $database_prefix;
556 //$DBParams['dsn'] = $database_dsn;
557 //$DBParams['dba_handler'] = $database_dba_handler;
559 echo "Testing DB Backend \"$dbtype\" ...\n";
560 $request = new MockRequest($DBParams);
561 if ( ! ENABLE_USER_NEW ) {
562 $request->_user->_request =& $request;
563 $request->_user->_dbi =& $request->_dbi;
565 if (DEBUG & _DEBUG_TRACE)
566 printMemoryUsage("PhpWikiInitialized");
568 foreach ($runtests as $test) {
569 if (!@ob_get_level()) ob_start();
570 $suite = new PHPUnit_TestSuite("phpwiki");
571 if (file_exists(dirname(__FILE__).'/lib/'.$test.'.php'))
572 require_once dirname(__FILE__).'/lib/'.$test.'.php';
574 require_once dirname(__FILE__).'/lib/plugin/'.$test.'.php';
575 $suite->addTest( new PHPUnit_TestSuite($test) );
577 @set_time_limit(240);
578 $result = PHPUnit::run($suite);
579 echo "ran " . $result->runCount() . " tests, " . $result->failureCount() . " failures.\n";
581 if ($result->failureCount() > 0) {
582 echo "More detail:\n";
583 echo $result->toString();
587 $request->chunkOutput();
588 $request->_dbi->close();
589 unset($request->_user);
590 unset($request->_dbi);
596 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD']))
599 // (c-file-style: "gnu")
604 // c-hanging-comment-ender-p: nil
605 // indent-tabs-mode: nil