tests/unit/test.php

   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>
   4  *
   5  * This file is part of PhpWiki.
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 /**
  23  * Unit tests for PhpWiki.
  24  *
  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.
  29  *
  30  * $ tests.php test=<testname1> test=<testname2> ... db=dba debug=9 level=10
  31  */
  32 /****************************************************************
  33    User definable options
  34 *****************************************************************/
  35 // common cfg options are taken from config/config.ini
  36
  37 define('GROUP_METHOD', 'NONE');
  38 define('USE_DB_SESSION', false);
  39 define('RATING_STORAGE', 'WIKIPAGE');
  40
  41 // memory usage: (8MB limit on certain servers)
  42 // setupwiki
  43 // cli:  Mem16712 => Mem16928
  44 // web:  Mem21216 => Mem26332 (5MB)
  45
  46 // dumphtml:
  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);
  51
  52 // available database backends to test:
  53 $database_backends = array(
  54                            'file',
  55                            'dba',
  56                            'SQL',
  57                            'ADODB',
  58                            );
  59 // "flatfile" testing occurs in "tests/unit/.testbox/"
  60 // "dba" needs the DATABASE_DBA_HANDLER, also in the .textbox directory
  61 $database_dba_handler = "db3";
  62 // "SQL" and "ADODB" need delete permissions to the test db
  63 //  You have to create that database beforehand with our schema
  64 $database_dsn = "mysql://wikiuser:@localhost/phpwiki_test";
  65 // For "cvs" see the seperate tests/unit_test_backend_cvs.php
  66
  67 ####################################################################
  68 #
  69 # Preamble needed to get the tests to run.
  70 #
  71 ####################################################################
  72
  73 $cur_dir = getcwd();
  74 # Add root dir to the path
  75 if (substr(PHP_OS,0,3) == 'WIN')
  76     $cur_dir = str_replace("\\","/",$cur_dir);
  77 $rootdir = $cur_dir . '/../../';
  78 $ini_sep = substr(PHP_OS,0,3) == 'WIN' ? ';' : ':';
  79 ini_set('include_path', ini_get('include_path') . $ini_sep . $rootdir);
  80
  81 # Quiet warnings in IniConfig.php
  82 $HTTP_SERVER_VARS['REMOTE_ADDR'] = '127.0.0.1';
  83 $HTTP_SERVER_VARS['HTTP_USER_AGENT'] = "PHPUnit";
  84
  85 function printMemoryUsage($msg = '') {
  86     if ($msg) echo $msg,"\n";
  87     if ((defined('DEBUG') and (DEBUG & 8)) or !defined('DEBUG')) {
  88         echo "-- MEMORY USAGE: ";
  89         if (function_exists('memory_get_usage')) {
  90             echo memory_get_usage(),"\n";
  91         } elseif (function_exists('getrusage')) {
  92             $u = getrusage();
  93             echo $u['ru_maxrss'],"\n";
  94         } elseif (substr(PHP_OS,0,3)=='WIN') { // requires a newer cygwin
  95             // what we want is the process memory only: apache or php
  96             $pid = getmypid();
  97             // this works only if it's a cygwin process (apache or php)
  98             //echo `cat /proc/$pid/statm |cut -f1`,"\n";
  99             // if it's native windows use something like this:
 100             // (requires pslist from systinternals.com)
 101             echo `pslist $pid|grep -A1 Mem|perl -ane"print \$F[5]"`,"\n";
 102         } else {
 103             $pid = getmypid();
 104             echo `ps -eo%mem,rss,pid | grep $pid`,"\n";
 105         }
 106         flush();
 107     }
 108 }
 109 function printSimpleTrace($bt) {
 110     //print_r($bt);
 111     echo "Traceback:\n";
 112     foreach ($bt as $i => $elem) {
 113         if (!array_key_exists('file', $elem)) {
 114             continue;
 115         }
 116         print "  " . $elem['file'] . ':' . $elem['line'] . "\n";
 117     }
 118 }
 119 # Show lots of detail when an assert() in the code fails
 120 function assert_callback( $script, $line, $message ) {
 121    echo "assert failed: script ", $script," line ", $line," :";
 122    echo "$message";
 123    echo "Traceback:\n";
 124    printSimpleTrace(debug_backtrace());
 125    exit;
 126 }
 127 $foo = assert_options( ASSERT_CALLBACK, 'assert_callback');
 128
 129 #
 130 # Get error reporting to call back, too
 131 #
 132 // set the error reporting level for this script
 133 if (defined('E_STRICT') and (E_ALL & E_STRICT)) // strict php5?
 134     error_reporting(E_ALL & ~E_STRICT);         // exclude E_STRICT
 135 else
 136     error_reporting(E_ALL); // php4
 137
 138 // This is too strict, fails on every notice and warning.
 139 /*
 140 function myErrorHandler$errno, $errstr, $errfile, $errline) {
 141    echo "$errfile: $errline: error# $errno: $errstr\n";
 142    echo "Traceback:\n";
 143    printSimpleTrace(debug_backtrace());
 144 }
 145 // The ErrorManager version
 146 function _ErrorHandler_CB(&$error) {
 147    echo "Traceback:\n";
 148    printSimpleTrace(debug_backtrace());
 149    if ($error->isFatal()) {
 150         $error->errno = E_USER_WARNING;
 151         return true; // ignore error
 152    }
 153    return true;
 154 }
 155 // set to the user defined error handler
 156 // $old_error_handler = set_error_handler("myErrorHandler");
 157 // This is already done via _DEBUG_TRACE
 158 //$ErrorManager->pushErrorHandler(new WikiFunctionCb('_ErrorHandler_CB'));
 159 */
 160
 161 function purge_dir($dir) {
 162     static $finder;
 163     if (!isset($finder)) {
 164         $finder = new FileFinder;
 165     }
 166     $fileSet = new fileSet($dir);
 167     assert(!empty($dir));
 168     foreach ($fileSet->getFiles() as $f) {
 169         unlink("$dir/$f");
 170     }
 171 }
 172
 173 function purge_testbox() {
 174     global $db_params;
 175     if (isset($GLOBALS['request'])) {
 176         $dbi = $GLOBALS['request']->getDbh();
 177     }
 178     $dir = $db_params['directory'];
 179     switch ($db_params['dbtype']) {
 180     case 'file':
 181         assert(!empty($dir));
 182         foreach (array('latest_ver','links','page_data','ver_data') as $d) {
 183             purge_dir("$dir/$d");
 184         }
 185         break;
 186     case 'SQL':
 187     case 'ADODB':
 188         foreach ($dbi->_backend->_table_names as $table) {
 189             $dbi->genericSqlQuery("DELETE FROM $table");
 190         }
 191         break;
 192     case 'dba':
 193         purge_dir($dir);
 194         break;
 195     }
 196     if (isset($dbi)) {
 197         $dbi->_cache->close();
 198         $dbi->_backend->_latest_versions = array();
 199     }
 200 }
 201
 202 ####################################################################
 203 #
 204 # End of preamble, run the test suite ..
 205 #
 206 ####################################################################
 207
 208 # lib/config.php might do a cwd()
 209
 210 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD']))
 211     echo "<pre>\n";
 212 // purge the testbox
 213
 214 $debug_level = 9; //_DEBUG_VERBOSE | _DEBUG_TRACE
 215 $user_level  = 1; // BOGO
 216 // use argv (from cli) or tests (from browser) params to run only certain tests
 217 // avoid pear: Console::Getopt
 218 $alltests = array('InlineParserTest','HtmlParserTest','PageListTest','ListPagesTest',
 219                   'SetupWiki','DumpHtml','AllPagesTest','AllUsersTest','OrphanedPagesTest');
 220 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD'])) {
 221     $argv = array();
 222     foreach ($HTTP_GET_VARS as $key => $val) {
 223         if (is_array($val))
 224             foreach ($val as $v) $argv[] = $key."=".$v;
 225         elseif (strstr($val,",") and in_array($key,array("test","db")))
 226             foreach (explode(",",$val) as $v) $argv[] = $key."=".$v;
 227         else
 228             $argv[] = $key."=".$val;
 229     }
 230 } elseif (!empty($argv) and preg_match("/test\.php$/", $argv[0]))
 231     array_shift($argv);
 232 if (!empty($argv)) {
 233     //support db=file db=dba test=SetupWiki test=DumpHtml debug=num
 234     $runtests = array();
 235     $run_database_backends = array();
 236     foreach ($argv as $arg) {
 237         if (preg_match("/^test=(.+)$/",$arg,$m) and in_array($m[1], $alltests))
 238             $runtests[] = $m[1];
 239         elseif (preg_match("/^db=(.+)$/",$arg,$m) and in_array($m[1], $database_backends))
 240             $run_database_backends[] = $m[1];
 241         elseif (preg_match("/^debug=(\d+)$/",$arg,$m))
 242             $debug_level = $m[1];
 243         elseif (preg_match("/^level=(\d+)$/",$arg,$m))
 244             $user_level = $m[1];
 245         elseif (in_array($arg, $alltests))
 246             $runtests[] = $arg;
 247         elseif ($debug_level & 1)
 248             echo "ignored arg: ", $arg, "\n";
 249     }
 250     if (!empty($run_database_backends))
 251         $database_backends = $run_database_backends;
 252     if (!empty($runtests))
 253         $alltests = $runtests;
 254     if ($debug_level & 1) {
 255         echo "test=", join(",",$alltests),"\n";
 256         echo "db=", join(",",$database_backends),"\n";
 257         echo "debug=", $debug_level,"\n";
 258         echo "level=", $user_level,"\n";
 259         if ($debug_level & 8)
 260             echo "pid=",getmypid(),"\n";
 261         echo "\n";
 262     }
 263     flush();
 264 }
 265 define('DEBUG', $debug_level);
 266
 267
 268 if (DEBUG & 8)
 269     printMemoryUsage("before PEAR");
 270
 271 # Test files
 272 require_once 'PHPUnit.php';
 273
 274 if (DEBUG & 8)
 275     printMemoryUsage("after PEAR, before PhpWiki");
 276
 277 define('PHPWIKI_NOMAIN', true);
 278 # Other needed files
 279 require_once $rootdir.'index.php';
 280 require_once $rootdir.'lib/main.php';
 281
 282 global $ErrorManager;
 283 $ErrorManager->setPostponedErrorMask(EM_FATAL_ERRORS|EM_WARNING_ERRORS|EM_NOTICE_ERRORS);
 284 //FIXME: ignore cached requests (if-modified-since) from cli
 285 class MockRequest extends WikiRequest {
 286     function MockRequest(&$dbparams) {
 287         $this->_dbi = WikiDB::open($dbparams);
 288         $this->_user = new MockUser("a_user", $GLOBALS['user_level']);
 289         $this->_group = WikiGroup::getGroup();
 290         $this->_args = array('pagename' => 'HomePage', 'action' => 'browse');
 291         $this->Request();
 292     }
 293     function getGroup() {
 294         if (is_object($this->_group))
 295             return $this->_group;
 296         else // FIXME: this is set to "/f:" somewhere.
 297             return WikiGroup::getGroup();
 298     }
 299 }
 300
 301 if (ENABLE_USER_NEW) {
 302     class MockUser extends _WikiUser {
 303         function MockUser($name, $level) {
 304             $this->_userid = $name;
 305             $this->_isSignedIn = $level > 1;
 306             $this->_level = $level;
 307         }
 308         function isSignedIn() {
 309             return $this->_isSignedIn;
 310         }
 311     }
 312 } else {
 313     class MockUser extends WikiUser {
 314         function MockUser($name, $level) {
 315             $this->_userid = $name;
 316             $this->_isSignedIn = $level > 1;
 317             $this->_level = $level;
 318         }
 319         function isSignedIn() {
 320             return $this->_isSignedIn;
 321         }
 322     }
 323 }
 324
 325 /*
 326 if (ENABLE_USER_NEW)
 327     $request->_user = WikiUser('AnonUser');
 328 else {
 329     $request->_user = new WikiUser($request, 'AnonUser');
 330     $request->_prefs = $request->_user->getPreferences();
 331 }
 332 */
 333 include_once("themes/" . THEME . "/themeinfo.php");
 334
 335 if (DEBUG & _DEBUG_TRACE)
 336     printMemoryUsage("after PhpWiki, before tests");
 337
 338 // save and restore all args for each test.
 339 class phpwiki_TestCase extends PHPUnit_TestCase {
 340     function setUp() {
 341         global $request;
 342         $this->_savedargs = $request->_args;
 343         $request->_args = array();
 344         if (DEBUG & 1) {
 345             echo $this->_name,"\n";
 346             flush();
 347         }
 348     }
 349     function tearDown() {
 350         global $request;
 351         $request->_args = $this->_savedargs;
 352         if (DEBUG & _DEBUG_TRACE)
 353             printMemoryUsage();
 354     }
 355 }
 356
 357 # Test all db backends.
 358 foreach ($database_backends as $dbtype) {
 359
 360     $suite  = new PHPUnit_TestSuite("phpwiki");
 361
 362     $db_params                         = array();
 363     $db_params['directory']            = $cur_dir . '/.testbox';
 364     $db_params['dsn']                  = $database_dsn;
 365     $db_params['dba_handler']          = $database_dba_handler;
 366     $db_params['dbtype']               = $dbtype;
 367
 368     echo "Testing DB Backend \"$dbtype\" ...\n";
 369     $request = new MockRequest($db_params);
 370
 371     foreach ($alltests as $test) {
 372         if (file_exists(dirname(__FILE__).'/lib/'.$test.'.php'))
 373             require_once dirname(__FILE__).'/lib/'.$test.'.php';
 374         else
 375             require_once dirname(__FILE__).'/lib/plugin/'.$test.'.php';
 376         $suite->addTest( new PHPUnit_TestSuite($test) );
 377     }
 378
 379     $result = PHPUnit::run($suite);
 380     echo "ran " . $result->runCount() . " tests, " . $result->failureCount() . " failures.\n";
 381     flush();
 382
 383     if ($result->failureCount() > 0) {
 384         echo "More detail:\n";
 385         echo $result->toString();
 386     }
 387 }
 388
 389 if (isset($HTTP_SERVER_VARS['REQUEST_METHOD']))
 390     echo "</pre>\n";
 391
 392 // (c-file-style: "gnu")
 393 // Local Variables:
 394 // mode: php
 395 // tab-width: 8
 396 // c-basic-offset: 4
 397 // c-hanging-comment-ender-p: nil
 398 // indent-tabs-mode: nil
 399 // End:
 400 ?>