<?php

/**

 * @file

 * Tests for system.module.

 */

/**

 * Helper class for module test cases.

 */

class ModuleTestCase extends DrupalWebTestCase {

  protected $admin_user;

  function setUp() {

    parent::setUp('system_test');

    $this->admin_user = $this->drupalCreateUser(array('access administration pages', 'administer modules'));

    $this->drupalLogin($this->admin_user);

  }

  /**

   * Assert there are tables that begin with the specified base table name.

   *

   * @param $base_table

   *   Beginning of table name to look for.

   * @param $count

   *   (optional) Whether or not to assert that there are tables that match the

   *   specified base table. Defaults to TRUE.

   */

  function assertTableCount($base_table, $count = TRUE) {

    $tables = db_find_tables(Database::getConnection()->prefixTables('{' . $base_table . '}') . '%');

    if ($count) {

      return $this->assertTrue($tables, format_string('Tables matching "@base_table" found.', array('@base_table' => $base_table)));

    }

    return $this->assertFalse($tables, format_string('Tables matching "@base_table" not found.', array('@base_table' => $base_table)));

  }

  /**

   * Assert that all tables defined in a module's hook_schema() exist.

   *

   * @param $module

   *   The name of the module.

   */

  function assertModuleTablesExist($module) {

    $tables = array_keys(drupal_get_schema_unprocessed($module));

    $tables_exist = TRUE;

    foreach ($tables as $table) {

      if (!db_table_exists($table)) {

        $tables_exist = FALSE;

      }

    }

    return $this->assertTrue($tables_exist, format_string('All database tables defined by the @module module exist.', array('@module' => $module)));

  }

  /**

   * Assert that none of the tables defined in a module's hook_schema() exist.

   *

   * @param $module

   *   The name of the module.

   */

  function assertModuleTablesDoNotExist($module) {

    $tables = array_keys(drupal_get_schema_unprocessed($module));

    $tables_exist = FALSE;

    foreach ($tables as $table) {

      if (db_table_exists($table)) {

        $tables_exist = TRUE;

      }

    }

    return $this->assertFalse($tables_exist, format_string('None of the database tables defined by the @module module exist.', array('@module' => $module)));

  }

  /**

   * Assert the list of modules are enabled or disabled.

   *

   * @param $modules

   *   Module list to check.

   * @param $enabled

   *   Expected module state.

   */

  function assertModules(array $modules, $enabled) {

    module_list(TRUE);

    foreach ($modules as $module) {

      if ($enabled) {

        $message = 'Module "@module" is enabled.';

      }

      else {

        $message = 'Module "@module" is not enabled.';

      }

      $this->assertEqual(module_exists($module), $enabled, format_string($message, array('@module' => $module)));

    }

  }

  /**

   * Verify a log entry was entered for a module's status change.

   * Called in the same way of the expected original watchdog() execution.

   *

   * @param $type

   *   The category to which this message belongs.

   * @param $message

   *   The message to store in the log. Keep $message translatable

   *   by not concatenating dynamic values into it! Variables in the

   *   message should be added by using placeholder strings alongside

   *   the variables argument to declare the value of the placeholders.

   *   See t() for documentation on how $message and $variables interact.

   * @param $variables

   *   Array of variables to replace in the message on display or

   *   NULL if message is already translated or not possible to

   *   translate.

   * @param $severity

   *   The severity of the message, as per RFC 3164.

   * @param $link

   *   A link to associate with the message.

   */

  function assertLogMessage($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = '') {

    $count = db_select('watchdog', 'w')

      ->condition('type', $type)

      ->condition('message', $message)

      ->condition('variables', serialize($variables))

      ->condition('severity', $severity)

      ->condition('link', $link)

      ->countQuery()

      ->execute()

      ->fetchField();

    $this->assertTrue($count > 0, format_string('watchdog table contains @count rows for @message', array('@count' => $count, '@message' => $message)));

  }

}

/**

 * Test module enabling/disabling functionality.

 */

class EnableDisableTestCase extends ModuleTestCase {

  protected $profile = 'testing';

  public static function getInfo() {

    return array(

      'name' => 'Enable/disable modules',

      'description' => 'Enable/disable core module and confirm table creation/deletion.',

      'group' => 'Module',

    );

  }

  /**

   * Test that all core modules can be enabled, disabled and uninstalled.

   */

  function testEnableDisable() {

    // Try to enable, disable and uninstall all core modules, unless they are

    // hidden or required.

    $modules = system_rebuild_module_data();

    foreach ($modules as $name => $module) {

      if ($module->info['package'] != 'Core' || !empty($module->info['hidden']) || !empty($module->info['required'])) {

        unset($modules[$name]);

      }

    }

    $this->assertTrue(count($modules), format_string('Found @count core modules that we can try to enable in this test.', array('@count' => count($modules))));

    // Enable the dblog module first, since we will be asserting the presence

    // of log messages throughout the test.

   if (isset($modules['dblog'])) {

     $modules = array('dblog' => $modules['dblog']) + $modules;

   }

   // Set a variable so that the hook implementations in system_test.module

   // will display messages via drupal_set_message().

   variable_set('test_verbose_module_hooks', TRUE);

    // Throughout this test, some modules may be automatically enabled (due to

    // dependencies). We'll keep track of them in an array, so we can handle

    // them separately.

    $automatically_enabled = array();

    // Go through each module in the list and try to enable it (unless it was

    // already enabled automatically due to a dependency).

    foreach ($modules as $name => $module) {

      if (empty($automatically_enabled[$name])) {

        // Start a list of modules that we expect to be enabled this time.

        $modules_to_enable = array($name);

        // Find out if the module has any dependencies that aren't enabled yet;

        // if so, add them to the list of modules we expect to be automatically

        // enabled.

        foreach (array_keys($module->requires) as $dependency) {

          if (isset($modules[$dependency]) && empty($automatically_enabled[$dependency])) {

            $modules_to_enable[] = $dependency;

            $automatically_enabled[$dependency] = TRUE;

          }

        }

        // Check that each module is not yet enabled and does not have any

        // database tables yet.

        foreach ($modules_to_enable as $module_to_enable) {

          $this->assertModules(array($module_to_enable), FALSE);

          $this->assertModuleTablesDoNotExist($module_to_enable);

        }

        // Install and enable the module.

        $edit = array();

        $edit['modules[Core][' . $name . '][enable]'] = $name;

        $this->drupalPost('admin/modules', $edit, t('Save configuration'));

        // Handle the case where modules were installed along with this one and

        // where we therefore hit a confirmation screen.

        if (count($modules_to_enable) > 1) {

          $this->drupalPost(NULL, array(), t('Continue'));

        }

        $this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');

        // Check that hook_modules_installed() and hook_modules_enabled() were

        // invoked with the expected list of modules, that each module's

        // database tables now exist, and that appropriate messages appear in

        // the logs.

        foreach ($modules_to_enable as $module_to_enable) {

          $this->assertText(t('hook_modules_installed fired for @module', array('@module' => $module_to_enable)));

          $this->assertText(t('hook_modules_enabled fired for @module', array('@module' => $module_to_enable)));

          $this->assertModules(array($module_to_enable), TRUE);

          $this->assertModuleTablesExist($module_to_enable);

          $this->assertLogMessage('system', "%module module installed.", array('%module' => $module_to_enable), WATCHDOG_INFO);

          $this->assertLogMessage('system', "%module module enabled.", array('%module' => $module_to_enable), WATCHDOG_INFO);

        }

        // Disable and uninstall the original module, and check appropriate

        // hooks, tables, and log messages. (Later, we'll go back and do the

        // same thing for modules that were enabled automatically.) Skip this

        // for the dblog module, because that is needed for the test; we'll go

        // back and do that one at the end also.

        if ($name != 'dblog') {

          $this->assertSuccessfulDisableAndUninstall($name);

        }

      }

    }

    // Go through all modules that were automatically enabled, and try to

    // disable and uninstall them one by one.

    while (!empty($automatically_enabled)) {

      $initial_count = count($automatically_enabled);

      foreach (array_keys($automatically_enabled) as $name) {

        // If the module can't be disabled due to dependencies, skip it and try

        // again the next time. Otherwise, try to disable it.

        $this->drupalGet('admin/modules');

        $disabled_checkbox = $this->xpath('//input[@type="checkbox" and @disabled="disabled" and @name="modules[Core][' . $name . '][enable]"]');

        if (empty($disabled_checkbox) && $name != 'dblog') {

          unset($automatically_enabled[$name]);

          $this->assertSuccessfulDisableAndUninstall($name);

        }

      }

      $final_count = count($automatically_enabled);

      // If all checkboxes were disabled, something is really wrong with the

      // test. Throw a failure and avoid an infinite loop.

      if ($initial_count == $final_count) {

        $this->fail(t('Remaining modules could not be disabled.'));

        break;

      }

    }

    // Disable and uninstall the dblog module last, since we needed it for

    // assertions in all the above tests.

    if (isset($modules['dblog'])) {

      $this->assertSuccessfulDisableAndUninstall('dblog');

    }

    // Now that all modules have been tested, go back and try to enable them

    // all again at once. This tests two things:

    // - That each module can be successfully enabled again after being

    //   uninstalled.

    // - That enabling more than one module at the same time does not lead to

    //   any errors.

    $edit = array();

    foreach (array_keys($modules) as $name) {

      $edit['modules[Core][' . $name . '][enable]'] = $name;

    }

    $this->drupalPost('admin/modules', $edit, t('Save configuration'));

    $this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');

  }

  /**

   * Ensures entity info cache is updated after changes.

   */

  function testEntityInfoChanges() {

    module_enable(array('entity_cache_test'));

    $entity_info = entity_get_info();

    $this->assertTrue(isset($entity_info['entity_cache_test']), 'Test entity type found.');

    // Change the label of the test entity type and make sure changes appear

    // after flushing caches.

    variable_set('entity_cache_test_label', 'New label.');

    drupal_flush_all_caches();

    $info = entity_get_info('entity_cache_test');

    $this->assertEqual($info['label'], 'New label.', 'New label appears in entity info.');

    // Disable the providing module and make sure the entity type is gone.

    module_disable(array('entity_cache_test', 'entity_cache_test_dependency'));

    $entity_info = entity_get_info();

    $this->assertFalse(isset($entity_info['entity_cache_test']), 'Entity type of the providing module is gone.');

  }

  /**

   * Tests entity info cache after enabling a module with a dependency on an entity providing module.

   *

   * @see entity_cache_test_watchdog()

   */

  function testEntityInfoCacheWatchdog() {

    module_enable(array('entity_cache_test'));

    $info = variable_get('entity_cache_test');

    $this->assertEqual($info['label'], 'Entity Cache Test', 'Entity info label is correct.');

    $this->assertEqual($info['controller class'], 'DrupalDefaultEntityController', 'Entity controller class info is correct.');

  }

  /**

   * Disables and uninstalls a module and asserts that it was done correctly.

   *

   * @param $module

   *   The name of the module to disable and uninstall.

   */

  function assertSuccessfulDisableAndUninstall($module) {

    // Disable the module.

    $edit = array();

    $edit['modules[Core][' . $module . '][enable]'] = FALSE;

    $this->drupalPost('admin/modules', $edit, t('Save configuration'));

    $this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');

    $this->assertModules(array($module), FALSE);

    // Check that the appropriate hook was fired and the appropriate log

    // message appears.

    $this->assertText(t('hook_modules_disabled fired for @module', array('@module' => $module)));

    $this->assertLogMessage('system', "%module module disabled.", array('%module' => $module), WATCHDOG_INFO);

    //  Check that the module's database tables still exist.

    $this->assertModuleTablesExist($module);

    // Uninstall the module.

    $edit = array();

    $edit['uninstall[' . $module . ']'] = $module;

    $this->drupalPost('admin/modules/uninstall', $edit, t('Uninstall'));

    $this->drupalPost(NULL, NULL, t('Uninstall'));

    $this->assertText(t('The selected modules have been uninstalled.'), 'Modules status has been updated.');

    $this->assertModules(array($module), FALSE);

    // Check that the appropriate hook was fired and the appropriate log

    // message appears. (But don't check for the log message if the dblog

    // module was just uninstalled, since the {watchdog} table won't be there

    // anymore.)

    $this->assertText(t('hook_modules_uninstalled fired for @module', array('@module' => $module)));

    if ($module != 'dblog') {

      $this->assertLogMessage('system', "%module module uninstalled.", array('%module' => $module), WATCHDOG_INFO);

    }

    // Check that the module's database tables no longer exist.

    $this->assertModuleTablesDoNotExist($module);

  }

}

/**

 * Tests failure of hook_requirements('install').

 */

class HookRequirementsTestCase extends ModuleTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Requirements hook failure',

      'description' => "Attempts enabling a module that fails hook_requirements('install').",

      'group' => 'Module',

    );

  }

  /**

   * Assert that a module cannot be installed if it fails hook_requirements().

   */

  function testHookRequirementsFailure() {

    $this->assertModules(array('requirements1_test'), FALSE);

    // Attempt to install the requirements1_test module.

    $edit = array();

    $edit['modules[Testing][requirements1_test][enable]'] = 'requirements1_test';

    $this->drupalPost('admin/modules', $edit, t('Save configuration'));

    // Makes sure the module was NOT installed.

    $this->assertText(t('Requirements 1 Test failed requirements'), 'Modules status has been updated.');

    $this->assertModules(array('requirements1_test'), FALSE);

  }

}

/**

 * Test module dependency functionality.

 */

class ModuleDependencyTestCase extends ModuleTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Module dependencies',

      'description' => 'Enable module without dependency enabled.',

      'group' => 'Module',

    );

  }

  /**

   * Checks functionality of project namespaces for dependencies.

   */

  function testProjectNamespaceForDependencies() {

    // Enable module with project namespace to ensure nothing breaks.

    $edit = array(

      'modules[Testing][system_project_namespace_test][enable]' => TRUE,

    );

    $this->drupalPost('admin/modules', $edit, t('Save configuration'));

    $this->assertModules(array('system_project_namespace_test'), TRUE);

  }

  /**

   * Attempt to enable translation module without locale enabled.

   */

  function testEnableWithoutDependency() {

    // Attempt to enable content translation without locale enabled.

    $edit = array();

    $edit['modules[Core][translation][enable]'] = 'translation';

    $this->drupalPost('admin/modules', $edit, t('Save configuration'));

    $this->assertText(t('Some required modules must be enabled'), 'Dependency required.');

    $this->assertModules(array('translation', 'locale'), FALSE);

    // Assert that the locale tables weren't enabled.

    $this->assertTableCount('languages', FALSE);

    $this->assertTableCount('locale', FALSE);

    $this->drupalPost(NULL, NULL, t('Continue'));

    $this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');

    $this->assertModules(array('translation', 'locale'), TRUE);

    // Assert that the locale tables were enabled.

    $this->assertTableCount('languages', TRUE);

    $this->assertTableCount('locale', TRUE);

  }

  /**

   * Attempt to enable a module with a missing dependency.

   */

  function testMissingModules() {

    // Test that the system_dependencies_test module is marked

    // as missing a dependency.

    $this->drupalGet('admin/modules');

    $this->assertRaw(t('@module (<span class="admin-missing">missing</span>)', array('@module' => drupal_ucfirst('_missing_dependency'))), 'A module with missing dependencies is marked as such.');

    $checkbox = $this->xpath('//input[@type="checkbox" and @disabled="disabled" and @name="modules[Testing][system_dependencies_test][enable]"]');

    $this->assert(count($checkbox) == 1, 'Checkbox for the module is disabled.');

    // Force enable the system_dependencies_test module.

    module_enable(array('system_dependencies_test'), FALSE);

    // Verify that the module is forced to be disabled when submitting

    // the module page.

    $this->drupalPost('admin/modules', array(), t('Save configuration'));

    $this->assertText(t('The @module module is missing, so the following module will be disabled: @depends.', array('@module' => '_missing_dependency', '@depends' => 'system_dependencies_test')), 'The module missing dependencies will be disabled.');

    // Confirm.

    $this->drupalPost(NULL, NULL, t('Continue'));

    // Verify that the module has been disabled.

    $this->assertModules(array('system_dependencies_test'), FALSE);

  }

  /**

   * Tests enabling a module that depends on an incompatible version of a module.

   */

  function testIncompatibleModuleVersionDependency() {

    // Test that the system_incompatible_module_version_dependencies_test is

    // marked as having an incompatible dependency.

    $this->drupalGet('admin/modules');

    $this->assertRaw(t('@module (<span class="admin-missing">incompatible with</span> version @version)', array(

      '@module' => 'System incompatible module version test (>2.0)',

      '@version' => '1.0',

    )), 'A module that depends on an incompatible version of a module is marked as such.');

    $checkbox = $this->xpath('//input[@type="checkbox" and @disabled="disabled" and @name="modules[Testing][system_incompatible_module_version_dependencies_test][enable]"]');

    $this->assert(count($checkbox) == 1, 'Checkbox for the module is disabled.');

  }

  /**

   * Tests enabling a module that depends on a module with an incompatible core version.

   */

  function testIncompatibleCoreVersionDependency() {

    // Test that the system_incompatible_core_version_dependencies_test is

    // marked as having an incompatible dependency.

    $this->drupalGet('admin/modules');

    $this->assertRaw(t('@module (<span class="admin-missing">incompatible with</span> this version of Drupal core)', array(

      '@module' => 'System incompatible core version test',

    )), 'A module that depends on a module with an incompatible core version is marked as such.');

    $checkbox = $this->xpath('//input[@type="checkbox" and @disabled="disabled" and @name="modules[Testing][system_incompatible_core_version_dependencies_test][enable]"]');

    $this->assert(count($checkbox) == 1, 'Checkbox for the module is disabled.');

  }

  /**

   * Tests enabling a module that depends on a module which fails hook_requirements().

   */

  function testEnableRequirementsFailureDependency() {

    $this->assertModules(array('requirements1_test'), FALSE);

    $this->assertModules(array('requirements2_test'), FALSE);

    // Attempt to install both modules at the same time.

    $edit = array();

    $edit['modules[Testing][requirements1_test][enable]'] = 'requirements1_test';

    $edit['modules[Testing][requirements2_test][enable]'] = 'requirements2_test';

    $this->drupalPost('admin/modules', $edit, t('Save configuration'));

    // Makes sure the modules were NOT installed.

    $this->assertText(t('Requirements 1 Test failed requirements'), 'Modules status has been updated.');

    $this->assertModules(array('requirements1_test'), FALSE);

    $this->assertModules(array('requirements2_test'), FALSE);

    // Makes sure that already enabled modules the failing modules depend on

    // were not disabled.

    $this->assertModules(array('comment'), TRUE);

  }

  /**

   * Tests that module dependencies are enabled in the correct order via the

   * UI. Dependencies should be enabled before their dependents.

   */

  function testModuleEnableOrder() {

    module_enable(array('module_test'), FALSE);

    $this->resetAll();

    $this->assertModules(array('module_test'), TRUE);

    variable_set('dependency_test', 'dependency');

    // module_test creates a dependency chain: forum depends on poll, which

    // depends on php. The correct enable order is, php, poll, forum.

    $expected_order = array('php', 'poll', 'forum');

    // Enable the modules through the UI, verifying that the dependency chain

    // is correct.

    $edit = array();

    $edit['modules[Core][forum][enable]'] = 'forum';

    $this->drupalPost('admin/modules', $edit, t('Save configuration'));

    $this->assertModules(array('forum'), FALSE);

    $this->assertText(t('You must enable the Poll, PHP filter modules to install Forum.'), t('Dependency chain created.'));

    $edit['modules[Core][poll][enable]'] = 'poll';