PKPTestHelper.inc.php

<?php
define('PKP_TEST_ENTIRE_DB', 1);
 
abstract class PKPTestHelper {
 
   //
   // Public helper methods
   //
   public static function backupTables($tables, $test) {
      $dao = new DAO();
      $driver = Config::getVar('database', 'driver');
      foreach ($tables as $table) {
         switch ($driver) {
            case 'mysql':
            case 'mysqli':
               $createLikeSql = "CREATE TABLE backup_$table LIKE $table";
               break;
            case 'postgres':
            case 'postgres64':
            case 'postgres7':
            case 'postgres8':
            case 'postgres9':
               $createLikeSql = "CREATE TABLE backup_$table (LIKE $table)";
               break;
            default:
               $test->fail("Unknown driver \"$driver\"");
               return;
         }
 
         $sqls = array(
            "DROP TABLE IF EXISTS backup_$table",
            $createLikeSql,
            "INSERT INTO backup_$table SELECT * FROM $table"
         );
         foreach ($sqls as $sql) {
            if (!$dao->update($sql, false, true, false)) {
               $test->fail("Error while backing up $table: offending SQL is '$sql'");
            }
         }
      }
   }
 
   public static function restoreTables($tables, $test) {
      $dao = new DAO();
      foreach ($tables as $table) {
         $sqls = array(
            "TRUNCATE TABLE $table",
            "INSERT INTO $table SELECT * FROM backup_$table",
            "DROP TABLE backup_$table"
         );
         foreach ($sqls as $sql) {
            if (!$dao->update($sql, false, true, false)) {
               $test->fail("Error while restoring $table: offending SQL is '$sql'");
            }
         }
      }
   }
 
   public static function restoreDB($test) {
      $filename = getenv('DATABASEDUMP');
      if (!$filename || !file_exists($filename)) {
         $test->fail('Database dump filename needs to be specified in env variable DATABASEDUMP!');
         return;
      }
 
      $output = $status = null; // For PHP scrutinizer
      switch (Config::getVar('database', 'driver')) {
         case 'mysql':
         case 'mysqli':
            exec($cmd = 'zcat ' .
               escapeshellarg($filename) .
               ' | /usr/bin/mysql --user=' .
               escapeshellarg(Config::getVar('database', 'username')) .
               ' --password=' .
               escapeshellarg(Config::getVar('database', 'password')) .
               ' --host=' .
               escapeshellarg(Config::getVar('database', 'host')) .
               ' ' .
               escapeshellarg(Config::getVar('database', 'name')),
               $output,
               $status
            );
            if ($status !== 0) {
               $test->fail("Error while restoring database from \"$filename\" (command: \"$cmd\").");
            }
            break;
         case 'postgres':
         case 'postgres64':
         case 'postgres7':
         case 'postgres8':
         case 'postgres9':
            // WARNING: Does not send a password.
            exec($cmd = 'zcat ' .
               escapeshellarg($filename) .
               ' | /usr/bin/psql --username=' .
               escapeshellarg(Config::getVar('database', 'username')) .
               ' --no-password' .
               ' --host=' .
               escapeshellarg(Config::getVar('database', 'host')) .
               ' ' .
               escapeshellarg(Config::getVar('database', 'name')),
               $output,
               $status
            );
            if ($status !== 0) {
               $test->fail("Error while restoring database from \"$filename\" (command: \"$cmd\".");
            }
            break;
      }
   }
 
   public static function xdebugScream($scream) {
      if (extension_loaded('xdebug')) {
         static $previous = null;
         if ($scream) {
            assert(!is_null($previous));
            ini_set('xdebug.scream', $previous);
         } else {
            $previous = ini_get('xdebug.scream');
            ini_set('xdebug.scream', false);
         }
      }
   }
}