PKPTestCase.inc.php

<?php
// Include PHPUnit
import('lib.pkp.tests.PKPTestHelper');
 
use PHPUnit\Framework\TestCase;
 
abstract class PKPTestCase extends TestCase {
   private
      $daoBackup = array(),
      $registryBackup = array(),
      $mockedRegistryKeys = array();
 
   protected function getMockedDAOs() {
      return array();
   }
 
   protected function getMockedRegistryKeys() {
      return $this->mockedRegistryKeys;
   }
 
   protected function setUp() : void {
      $this->setBackupGlobals(true);
 
      // Rather than using "include_once()", ADOdb uses
      // a global variable to maintain the information
      // whether its library has been included before (wtf!).
      // This causes problems with PHPUnit as PHPUnit will
      // delete all global state between two consecutive
      // tests to isolate tests from each other.
      if(function_exists('_array_change_key_case')) {
         global $ADODB_INCLUDED_LIB;
         $ADODB_INCLUDED_LIB = 1;
      }
      Config::setConfigFileName(Core::getBaseDir(). DIRECTORY_SEPARATOR. 'config.inc.php');
 
      // Backup DAOs.
      foreach($this->getMockedDAOs() as $mockedDao) {
         $this->daoBackup[$mockedDao] = DAORegistry::getDAO($mockedDao);
      }
 
      // Backup registry keys.
      foreach($this->getMockedRegistryKeys() as $mockedRegistryKey) {
         $this->registryBackup[$mockedRegistryKey] = Registry::get($mockedRegistryKey);
      }
   }
 
   protected function tearDown() : void {
      // Restore registry keys.
      foreach($this->getMockedRegistryKeys() as $mockedRegistryKey) {
         Registry::set($mockedRegistryKey, $this->registryBackup[$mockedRegistryKey]);
      }
 
      // Restore DAOs.
      foreach($this->getMockedDAOs() as $mockedDao) {
         DAORegistry::registerDAO($mockedDao, $this->daoBackup[$mockedDao]);
      }
   }
 
   public function getActualOutput() : string {
      // We do not want to see output.
      return '';
   }
 
 
   //
   // Protected helper methods
   //
   protected function setTestConfiguration($config, $configPath = 'config') {
      // Get the configuration file belonging to
      // this test configuration.
      $configFile = $this->getConfigFile($config, $configPath);
 
      // Avoid unnecessary configuration switches.
      if (Config::getConfigFileName() != $configFile) {
         // Switch the configuration file
         Config::setConfigFileName($configFile);
      }
   }
 
   protected function mockRequest($path = 'index/test-page/test-op', $userId = null) {
      // Back up the default request.
      if (!isset($this->registryBackup['request'])) {
         $this->mockedRegistryKeys[] = 'request';
         $this->registryBackup['request'] = Registry::get('request');
      }
 
      // Create a test request.
      Registry::delete('request');
      $application = Application::get();
      $_SERVER['REQUEST_METHOD'] = 'GET';
      $_SERVER['PATH_INFO'] = $path;
      $request = $application->getRequest();
      import('classes.core.PageRouter');
 
      // Test router.
      $router = new PageRouter();
      $router->setApplication($application);
      import('lib.pkp.classes.core.Dispatcher');
      $dispatcher = new Dispatcher();
      $dispatcher->setApplication($application);
      $router->setDispatcher($dispatcher);
      $request->setRouter($router);
 
      // Test user.
      $session = $request->getSession();
      $session->setUserId($userId);
 
      return $request;
   }
 
 
   //
   // Private helper methods
   //
   private function getConfigFile($config, $configPath = 'config') {
      // Build the config file name.
      return './lib/pkp/tests/'.$configPath.'/config.'.$config.'.inc.php';
   }
}