phpunit-bootstrap.php

<?php
// This script may not be executed remotely.
if (isset($_SERVER['SERVER_NAME'])) {
   die('This script can only be executed from the command-line.');
}
 
 
// Configure the index file location, assume that pkp-lib is
// included within a PKP application.
// FIXME: This doesn't work if lib/pkp is symlinked.
// realpath($_['SCRIPT_FILENAME'].'/../../index.php') could work
// but see http://bugs.php.net/bug.php?id=50366
define('INDEX_FILE_LOCATION', dirname(dirname(dirname(dirname(__FILE__)))).'/index.php');
chdir(dirname(INDEX_FILE_LOCATION));
 
// Configure PKP error handling for tests
define('DONT_DIE_ON_ERROR', true);
 
// Don't support sessions
define('SESSION_DISABLE_INIT', true);
 
// Configure assertions for tests
ini_set('assert.active', true);
ini_set('assert.bail', false);
ini_set('assert.warning', true);
ini_set('assert.callback', null);
ini_set('assert.quiet_eval', false);
 
// NB: Our test framework provides the possibility to
// import mock classes to replace regular classes.
// This is necessary to mock static method calls.
// Unfortunately we can only define one mock environment
// per test run as PHP does not allow to change a class
// implementation while running.
// We therefore need to define the mock environment globally
// so that tests can check their environment requirement
// before they start importing.
if (isset($_SERVER['PKP_MOCK_ENV'])) {
   define('PHPUNIT_CURRENT_MOCK_ENV', $_SERVER['PKP_MOCK_ENV']);
   $mockEnvs = '';
   foreach(array('lib/pkp/tests/mock/', 'tests/mock/') as $testDir) {
      $normalizedMockEnv = normalizeMockEnvironment($testDir . $_SERVER['PKP_MOCK_ENV']);
      if ($normalizedMockEnv) {
         if (!empty($mockEnvs)) $mockEnvs .= ';';
         $mockEnvs .= $normalizedMockEnv;
      }
   }
   define('PHPUNIT_ADDITIONAL_INCLUDE_DIRS', $mockEnvs);
} else {
   // Use the current test folder as mock environment
   // if no environment has been explicitly set.
   // The phpunit cli tool's last parameter is the test class, file or directory
   define('PHPUNIT_CURRENT_MOCK_ENV', '__NONE__');
   assert(is_array($_SERVER['argv']) and count($_SERVER['argv'])>1);
   $testDir = end($_SERVER['argv']);
   define('PHPUNIT_ADDITIONAL_INCLUDE_DIRS', normalizeMockEnvironment($testDir));
}
 
function require_mock_env($mockEnv) {
   if (PHPUNIT_CURRENT_MOCK_ENV == '__NONE__' || PHPUNIT_CURRENT_MOCK_ENV != $mockEnv) {
      // Tests that require different mock environments cannot run
      // in the same test batch as this would require re-defining
      // already defined classes.
      debug_print_backtrace();
      die(
         'You are trying to run a test in the wrong mock environment ('
         . PHPUNIT_CURRENT_MOCK_ENV . ' rather than ' . $mockEnv.')!'
      );
   }
}
 
function import($class) {
   static $mockEnvArray = null;
 
   // Expand and verify additional include directories.
   if (is_null($mockEnvArray)) {
      if (defined('PHPUNIT_ADDITIONAL_INCLUDE_DIRS')) {
         $mockEnvArray = explode(';', PHPUNIT_ADDITIONAL_INCLUDE_DIRS);
         foreach($mockEnvArray as $mockEnv) {
            if (!is_dir($mockEnv)) die ('Invalid mock environment directory ' . $mockEnv . '!');
         }
      } else {
         $mockEnvArray = array();
      }
   }
 
   // Test whether we have a mock implementation of
   // the requested class.
   foreach($mockEnvArray as $mockEnv) {
      $classParts = explode('.', $class);
      $mockClassFile = $mockEnv . '/Mock'.array_pop($classParts) . '.inc.php';
      if (file_exists($mockClassFile)) {
         require_once($mockClassFile);
         return;
      }
   }
 
   // No mock implementation found, do the normal import
   require_once('./'.str_replace('.', '/', $class) . '.inc.php');
}
 
function normalizeMockEnvironment($mockEnv) {
      if (substr($mockEnv, 0, 1) != '/') {
         $mockEnv = getcwd() . '/' . $mockEnv;
      }
      if (!is_dir($mockEnv)) {
         $mockEnv = dirname($mockEnv);
      }
      $mockEnv = realpath($mockEnv);
 
      // Test whether this is a valid directory.
      if (is_dir($mockEnv)) {
         return $mockEnv;
      } else {
         // Make sure that we do not try to
         // identify a mock env again but mark
         // it as "not found".
         return false;
      }
}
 
// Set up minimal PKP application environment
require_once('./lib/pkp/includes/bootstrap.inc.php');
 
// Make sure ADOdb doesn't "clean up" our /tmp folder.
$ADODB_CACHE_DIR = CacheManager::getFileCachePath() . DIRECTORY_SEPARATOR . '_db';
 
// Remove the PKP error handler so that PHPUnit
// can set its own error handler and catch errors for us.
error_reporting(E_ALL & ~E_STRICT & ~E_DEPRECATED);
 
// Show errors in the UI
ini_set('display_errors', true);