simpletest.install in SimpleTest 6.2

Install, update and uninstall functions for the simpletest module.

File

simpletest.install

<?php

/**
 * @file
 * Install, update and uninstall functions for the simpletest module.
 */

/**
 * Minimum value of PHP memory_limit for SimpleTest.
 */
define('SIMPLETEST_MINIMUM_PHP_MEMORY_LIMIT', '64M');

/**
 * Implements hook_requirements().
 */
function simpletest_requirements($phase) {
  $requirements = array();
  $t = get_t();
  $has_curl = function_exists('curl_init');
  $has_hash = function_exists('hash_hmac');
  $has_domdocument = method_exists('DOMDocument', 'loadHTML');
  $open_basedir = ini_get('open_basedir');
  $patch_installed = isset($GLOBALS['simpletest_installed']);
  $requirements['curl'] = array(
    'title' => $t('cURL'),
    'value' => $has_curl ? $t('Enabled') : $t('Not found'),
  );
  if (!$has_curl) {
    $requirements['curl']['severity'] = REQUIREMENT_ERROR;
    $requirements['curl']['description'] = $t('The testing framework could not be installed because the PHP <a href="@curl_url">cURL</a> library is not available.', array(
      '@curl_url' => 'http://php.net/manual/en/curl.setup.php',
    ));
  }
  $requirements['hash'] = array(
    'title' => $t('hash'),
    'value' => $has_hash ? $t('Enabled') : $t('Not found'),
  );
  if (!$has_hash) {
    $requirements['hash']['severity'] = REQUIREMENT_ERROR;
    $requirements['hash']['description'] = $t('The testing framework could not be installed because the PHP <a href="@hash_url">hash</a> extension is disabled.', array(
      '@hash_url' => 'http://php.net/manual/en/book.hash.php',
    ));
  }
  $requirements['php_domdocument'] = array(
    'title' => $t('PHP DOMDocument class'),
    'value' => $has_domdocument ? $t('Enabled') : $t('Not found'),
  );
  if (!$has_domdocument) {
    $requirements['php_domdocument']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_domdocument']['description'] = $t('The testing framework requires the DOMDocument class to be available. Check the configure command at the <a href="@link-phpinfo">PHP info page</a>.', array(
      '@link-phpinfo' => url('admin/reports/status/php'),
    ));
  }

  // SimpleTest currently needs 2 cURL options which are incompatible with
  // having PHP's open_basedir restriction set.
  // See http://drupal.org/node/674304.
  $requirements['php_open_basedir'] = array(
    'title' => $t('PHP open_basedir restriction'),
    'value' => $open_basedir ? $t('Enabled') : $t('Disabled'),
  );
  if ($open_basedir) {
    $requirements['php_open_basedir']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_open_basedir']['description'] = $t('The testing framework requires the PHP <a href="@open_basedir-url">open_basedir</a> restriction to be disabled. Check your webserver configuration or contact your web host.', array(
      '@open_basedir-url' => 'http://php.net/manual/en/ini.core.php#ini.open-basedir',
    ));
  }

  // Check the current memory limit. If it is set too low, SimpleTest will fail
  // to load all tests and throw a fatal error.
  $memory_limit = ini_get('memory_limit');
  if ($memory_limit && $memory_limit != -1 && parse_size($memory_limit) < parse_size(SIMPLETEST_MINIMUM_PHP_MEMORY_LIMIT)) {
    $requirements['php_memory_limit']['severity'] = REQUIREMENT_ERROR;
    $requirements['php_memory_limit']['description'] = t('The testing framework requires the PHP memory limit to be at least %memory_minimum_limit. The current value is %memory_limit. <a href="@url">Follow these steps to continue</a>.', array(
      '%memory_limit' => $memory_limit,
      '%memory_minimum_limit' => SIMPLETEST_MINIMUM_PHP_MEMORY_LIMIT,
      '@url' => 'http://drupal.org/node/207036',
    ));
  }

  // Check that the global variable is defined signifying that the patch
  // was correctly applied to the Drupal 6 core.
  $requirements['simpletest_patch'] = array(
    'title' => $t('SimpleTest code addition'),
    'value' => $patch_installed ? $t('Found') : $t('Not found'),
  );
  if (!$patch_installed) {
    $requirements['simpletest_patch']['severity'] = REQUIREMENT_ERROR;
    $requirements['simpletest_patch']['description'] = $t('SimpleTest could not be installed. The required core patch must be applied. See the included <a href="@install">INSTALL.txt</a>.', array(
      '@install' => base_path() . drupal_get_path('module', 'simpletest') . '/INSTALL.txt',
    ));
  }
  return $requirements;
}

/**
 * Implements hook_schema().
 */
function simpletest_schema() {
  $schema['simpletest'] = array(
    'description' => 'Stores simpletest messages',
    'fields' => array(
      'message_id' => array(
        'type' => 'serial',
        'not null' => TRUE,
        'description' => 'Primary Key: Unique simpletest message ID.',
      ),
      'test_id' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Test ID, messages belonging to the same ID are reported together',
      ),
      'test_class' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The name of the class that created this message.',
      ),
      'status' => array(
        'type' => 'varchar',
        'length' => 9,
        'not null' => TRUE,
        'default' => '',
        'description' => 'Message status. Core understands pass, fail, exception.',
      ),
      'message' => array(
        'type' => 'text',
        'not null' => TRUE,
        'description' => 'The message itself.',
      ),
      'message_group' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The message group this message belongs to. For example: warning, browser, user.',
      ),
      'function' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'Name of the assertion function or method that created this message.',
      ),
      'line' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Line number on which the function is called.',
      ),
      'file' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'Name of the file where the function is called.',
      ),
    ),
    'primary key' => array(
      'message_id',
    ),
    'indexes' => array(
      'reporter' => array(
        'test_class',
        'message_id',
      ),
    ),
  );
  $schema['simpletest_test_id'] = array(
    'description' => 'Stores simpletest test IDs, used to auto-incrament the test ID so that a fresh test ID is used.',
    'fields' => array(
      'test_id' => array(
        'type' => 'serial',
        'not null' => TRUE,
        'description' => 'Primary Key: Unique simpletest ID used to group test results together. Each time a set of tests
                            are run a new test ID is used.',
      ),
      'last_prefix' => array(
        'type' => 'varchar',
        'length' => 60,
        'not null' => FALSE,
        'default' => '',
        'description' => 'The last database prefix used during testing.',
      ),
    ),
    'primary key' => array(
      'test_id',
    ),
  );
  return $schema;
}

/**
 * Implements hook_install().
 */
function simpletest_install() {

  // Install schema.
  drupal_install_schema('simpletest');

  // Create the SimpleTest directory.
  $path = file_directory_path() . '/simpletest';
  file_check_directory($path, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
}

/**
 * Implements hook_uninstall().
 */
function simpletest_uninstall() {
  simpletest_clean_environment();

  // Remove settings variables.
  variable_del('simpletest_httpauth_method');
  variable_del('simpletest_httpauth_username');
  variable_del('simpletest_httpauth_password');
  variable_del('simpletest_clear_results');
  variable_del('simpletest_verbose');

  // Uninstall schema.
  drupal_uninstall_schema('simpletest');

  // Remove generated files.
  simpletest_file_unmanaged_delete_recursive(file_directory_path() . '/simpletest');
}

/**
 * Upgrade simpletest 5.x-1.x and 6.x-1.x to 6.x-2.1 release.
 *
 * Provides a basic upgrade path for initial switch to 2.x branch. The update
 * path will not be continued as there is no data that needs to be updated and
 * any further releases should simply un-install and install just like Drupal
 * HEAD development.
 */
function simpletest_update_6200() {
  $ret = array();

  // Drop any existing SimpleTest tables.
  if (db_table_exists('simpletest')) {
    db_drop_table($ret, 'simpletest');
  }
  if (db_table_exists('simpletest_test_id')) {
    db_drop_table($ret, 'simpletest_test_id');
  }

  // Install most recent schema and files.
  simpletest_install();
  return $ret;
}

/**
 * Renamed authentication username and password variables.
 */
function simpletest_update_6201() {
  $username = variable_get('simpletest_username', '');
  $password = variable_get('simpletest_password', '');
  variable_set('simpletest_httpauth_username', $username);
  variable_set('simpletest_httpauth_password', $password);
  variable_del('simpletest_username', '');
  variable_del('simpletest_password', '');
  return array();
}

Functions

Name	Description
simpletest_install	Implements hook_install().
simpletest_requirements	Implements hook_requirements().
simpletest_schema	Implements hook_schema().
simpletest_uninstall	Implements hook_uninstall().
simpletest_update_6200	Upgrade simpletest 5.x-1.x and 6.x-1.x to 6.x-2.1 release.
simpletest_update_6201	Renamed authentication username and password variables.

Constants

Name	Description
SIMPLETEST_MINIMUM_PHP_MEMORY_LIMIT	Minimum value of PHP memory_limit for SimpleTest.