<?php

/**

 * @file

 * This file contains tests for the Update Manager module.

 *

 * The overarching methodology of these tests is we need to compare a given

 * state of installed modules and themes (e.g., version, project grouping,

 * timestamps, etc) against a current state of what the release history XML

 * files we fetch say is available. We have dummy XML files (in the

 * modules/update/tests directory) that describe various scenarios of what's

 * available for different test projects, and we have dummy .info file data

 * (specified via hook_system_info_alter() in the update_test helper module)

 * describing what's currently installed. Each test case defines a set of

 * projects to install, their current state (via the 'update_test_system_info'

 * variable) and the desired available update data (via the

 * 'update_test_xml_map' variable), and then performs a series of assertions

 * that the report matches our expectations given the specific initial state and

 * availability scenario.

 */

/**

 * Defines some shared functions used by all update tests.

 */

class UpdateTestHelper extends DrupalWebTestCase {

  /**

   * Refreshes the update status based on the desired available update scenario.

   *

   * @param $xml_map

   *   Array that maps project names to availability scenarios to fetch. The key

   *   '#all' is used if a project-specific mapping is not defined.

   * @param $url

   *   (optional) A string containing the URL to fetch update data from.

   *   Defaults to 'update-test'.

   *

   * @see update_test_mock_page()

   */

  protected function refreshUpdateStatus($xml_map, $url = 'update-test') {

    // Tell the Update Manager module to fetch from the URL provided by

    // update_test module.

    variable_set('update_fetch_url', url($url, array('absolute' => TRUE)));

    // Save the map for update_test_mock_page() to use.

    variable_set('update_test_xml_map', $xml_map);

    // Manually check the update status.

    $this->drupalGet('admin/reports/updates/check');

  }

  /**

   * Runs a series of assertions that are applicable to all update statuses.

   */

  protected function standardTests() {

    $this->assertRaw('<h3>' . t('Drupal core') . '</h3>');

    $this->assertRaw(l(t('Drupal'), 'http://example.com/project/drupal'), 'Link to the Drupal project appears.');

    $this->assertNoText(t('No available releases found'));

  }

}

/**

 * Tests behavior related to discovering and listing updates to Drupal core.

 */

class UpdateCoreTestCase extends UpdateTestHelper {

  public static function getInfo() {

    return array(

      'name' => 'Update core functionality',

      'description' => 'Tests the Update Manager module through a series of functional tests using mock XML data.',

      'group' => 'Update',

    );

  }

  function setUp() {

    parent::setUp('update_test', 'update');

    $admin_user = $this->drupalCreateUser(array('administer site configuration', 'administer modules'));

    $this->drupalLogin($admin_user);

  }

  /**

   * Tests the Update Manager module when no updates are available.

   */

  function testNoUpdatesAvailable() {

    $this->setSystemInfo7_0();

    $this->refreshUpdateStatus(array('drupal' => '0'));

    $this->standardTests();

    $this->assertText(t('Up to date'));

    $this->assertNoText(t('Update available'));

    $this->assertNoText(t('Security update required!'));

  }

  /**

   * Tests the Update Manager module when one normal update is available.

   */

  function testNormalUpdateAvailable() {

    $this->setSystemInfo7_0();

    $this->refreshUpdateStatus(array('drupal' => '1'));

    $this->standardTests();

    $this->assertNoText(t('Up to date'));

    $this->assertText(t('Update available'));

    $this->assertNoText(t('Security update required!'));

    $this->assertRaw(l('7.1', 'http://example.com/drupal-7-1-release'), 'Link to release appears.');

    $this->assertRaw(l(t('Download'), 'http://example.com/drupal-7-1.tar.gz'), 'Link to download appears.');

    $this->assertRaw(l(t('Release notes'), 'http://example.com/drupal-7-1-release'), 'Link to release notes appears.');

  }

  /**

   * Tests the Update Manager module when a security update is available.

   */

  function testSecurityUpdateAvailable() {

    $this->setSystemInfo7_0();

    $this->refreshUpdateStatus(array('drupal' => '2-sec'));

    $this->standardTests();

    $this->assertNoText(t('Up to date'));

    $this->assertNoText(t('Update available'));

    $this->assertText(t('Security update required!'));

    $this->assertRaw(l('7.2', 'http://example.com/drupal-7-2-release'), 'Link to release appears.');

    $this->assertRaw(l(t('Download'), 'http://example.com/drupal-7-2.tar.gz'), 'Link to download appears.');

    $this->assertRaw(l(t('Release notes'), 'http://example.com/drupal-7-2-release'), 'Link to release notes appears.');

  }

  /**

   * Ensures proper results where there are date mismatches among modules.

   */

  function testDatestampMismatch() {

    $system_info = array(

      '#all' => array(

        // We need to think we're running a -dev snapshot to see dates.

        'version' => '7.0-dev',

        'datestamp' => time(),

      ),

      'block' => array(

        // This is 2001-09-09 01:46:40 GMT, so test for "2001-Sep-".

        'datestamp' => '1000000000',

      ),

    );

    variable_set('update_test_system_info', $system_info);

    $this->refreshUpdateStatus(array('drupal' => 'dev'));

    $this->assertNoText(t('2001-Sep-'));

    $this->assertText(t('Up to date'));

    $this->assertNoText(t('Update available'));

    $this->assertNoText(t('Security update required!'));

  }

  /**

   * Checks that running cron updates the list of available updates.

   */

  function testModulePageRunCron() {

    $this->setSystemInfo7_0();

    variable_set('update_fetch_url', url('update-test', array('absolute' => TRUE)));

    variable_set('update_test_xml_map', array('drupal' => '0'));

    $this->cronRun();

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

    $this->assertNoText(t('No update information available.'));

  }

  /**

   * Checks the messages at admin/modules when the site is up to date.

   */

  function testModulePageUpToDate() {

    $this->setSystemInfo7_0();

    // Instead of using refreshUpdateStatus(), set these manually.

    variable_set('update_fetch_url', url('update-test', array('absolute' => TRUE)));

    variable_set('update_test_xml_map', array('drupal' => '0'));

    $this->drupalGet('admin/reports/updates');

    $this->clickLink(t('Check manually'));

    $this->assertText(t('Checked available update data for one project.'));

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

    $this->assertNoText(t('There are updates available for your version of Drupal.'));

    $this->assertNoText(t('There is a security update available for your version of Drupal.'));

  }

  /**

   * Checks the messages at admin/modules when an update is missing.

   */

  function testModulePageRegularUpdate() {

    $this->setSystemInfo7_0();

    // Instead of using refreshUpdateStatus(), set these manually.

    variable_set('update_fetch_url', url('update-test', array('absolute' => TRUE)));

    variable_set('update_test_xml_map', array('drupal' => '1'));

    $this->drupalGet('admin/reports/updates');

    $this->clickLink(t('Check manually'));

    $this->assertText(t('Checked available update data for one project.'));

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

    $this->assertText(t('There are updates available for your version of Drupal.'));

    $this->assertNoText(t('There is a security update available for your version of Drupal.'));

  }

  /**

   * Checks the messages at admin/modules when a security update is missing.

   */

  function testModulePageSecurityUpdate() {

    $this->setSystemInfo7_0();

    // Instead of using refreshUpdateStatus(), set these manually.

    variable_set('update_fetch_url', url('update-test', array('absolute' => TRUE)));

    variable_set('update_test_xml_map', array('drupal' => '2-sec'));

    $this->drupalGet('admin/reports/updates');

    $this->clickLink(t('Check manually'));

    $this->assertText(t('Checked available update data for one project.'));

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

    $this->assertNoText(t('There are updates available for your version of Drupal.'));

    $this->assertText(t('There is a security update available for your version of Drupal.'));

    // Make sure admin/appearance warns you you're missing a security update.

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

    $this->assertNoText(t('There are updates available for your version of Drupal.'));

    $this->assertText(t('There is a security update available for your version of Drupal.'));

    // Make sure duplicate messages don't appear on Update status pages.

    $this->drupalGet('admin/reports/status');

    // We're expecting "There is a security update..." inside the status report

    // itself, but the drupal_set_message() appears as an li so we can prefix

    // with that and search for the raw HTML.

    $this->assertNoRaw('<li>' . t('There is a security update available for your version of Drupal.'));

    $this->drupalGet('admin/reports/updates');

    $this->assertNoText(t('There is a security update available for your version of Drupal.'));

    $this->drupalGet('admin/reports/updates/settings');

    $this->assertNoText(t('There is a security update available for your version of Drupal.'));

  }

  /**

   * Tests the Update Manager module when the update server returns 503 errors.

   */

  function testServiceUnavailable() {

    $this->refreshUpdateStatus(array(), '503-error');

    // Ensure that no "Warning: SimpleXMLElement..." parse errors are found.

    $this->assertNoText('SimpleXMLElement');

    $this->assertUniqueText(t('Failed to get available update data for one project.'));

  }

  /**

   * Tests that exactly one fetch task per project is created and not more.

   */

  function testFetchTasks() {

    $projecta = array(

      'name' => 'aaa_update_test',

    );

    $projectb = array(

      'name' => 'bbb_update_test',

    );

    $queue = DrupalQueue::get('update_fetch_tasks');

    $this->assertEqual($queue->numberOfItems(), 0, 'Queue is empty');

    update_create_fetch_task($projecta);

    $this->assertEqual($queue->numberOfItems(), 1, 'Queue contains one item');

    update_create_fetch_task($projectb);

    $this->assertEqual($queue->numberOfItems(), 2, 'Queue contains two items');

    // Try to add project a again.

    update_create_fetch_task($projecta);

    $this->assertEqual($queue->numberOfItems(), 2, 'Queue still contains two items');

    // Clear cache and try again.

    _update_cache_clear();

    drupal_static_reset('_update_create_fetch_task');

    update_create_fetch_task($projecta);

    $this->assertEqual($queue->numberOfItems(), 2, 'Queue contains two items');

  }

  /**

   * Sets the version to 7.0 when no project-specific mapping is defined.

   */

  protected function setSystemInfo7_0() {

    $setting = array(

      '#all' => array(

        'version' => '7.0',

      ),

    );

    variable_set('update_test_system_info', $setting);

  }

}

/**

 * Tests behavior related to handling updates to contributed modules and themes.

 */

class UpdateTestContribCase extends UpdateTestHelper {

  public static function getInfo() {

    return array(

      'name' => 'Update contrib functionality',

      'description' => 'Tests how the Update Manager module handles contributed modules and themes in a series of functional tests using mock XML data.',

      'group' => 'Update',

    );

  }

  function setUp() {

    parent::setUp('update_test', 'update', 'aaa_update_test', 'bbb_update_test', 'ccc_update_test');

    $admin_user = $this->drupalCreateUser(array('administer site configuration'));

    $this->drupalLogin($admin_user);

  }

  /**

   * Tests when there is no available release data for a contrib module.

   */

  function testNoReleasesAvailable() {

    $system_info = array(

      '#all' => array(

        'version' => '7.0',

      ),

      'aaa_update_test' => array(

        'project' => 'aaa_update_test',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

    );

    variable_set('update_test_system_info', $system_info);

    $this->refreshUpdateStatus(array('drupal' => '0', 'aaa_update_test' => 'no-releases'));

    $this->drupalGet('admin/reports/updates');

    // Cannot use $this->standardTests() because we need to check for the

    // 'No available releases found' string.

    $this->assertRaw('<h3>' . t('Drupal core') . '</h3>');

    $this->assertRaw(l(t('Drupal'), 'http://example.com/project/drupal'));

    $this->assertText(t('Up to date'));

    $this->assertRaw('<h3>' . t('Modules') . '</h3>');

    $this->assertNoText(t('Update available'));

    $this->assertText(t('No available releases found'));

    $this->assertNoRaw(l(t('AAA Update test'), 'http://example.com/project/aaa_update_test'));

  }

  /**

   * Tests the basic functionality of a contrib module on the status report.

   */

  function testUpdateContribBasic() {

    $system_info = array(

      '#all' => array(

        'version' => '7.0',

      ),

      'aaa_update_test' => array(

        'project' => 'aaa_update_test',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

    );

    variable_set('update_test_system_info', $system_info);

    $this->refreshUpdateStatus(

      array(

        'drupal' => '0',

        'aaa_update_test' => '1_0',

      )

    );

    $this->standardTests();

    $this->assertText(t('Up to date'));

    $this->assertRaw('<h3>' . t('Modules') . '</h3>');

    $this->assertNoText(t('Update available'));

    $this->assertRaw(l(t('AAA Update test'), 'http://example.com/project/aaa_update_test'), 'Link to aaa_update_test project appears.');

  }

  /**

   * Tests that contrib projects are ordered by project name.

   *

   * If a project contains multiple modules, we want to make sure that the

   * available updates report is sorted by the parent project names, not by the

   * names of the modules included in each project. In this test case, we have

   * two contrib projects, "BBB Update test" and "CCC Update test". However, we

   * have a module called "aaa_update_test" that's part of the "CCC Update test"

   * project. We need to make sure that we see the "BBB" project before the

   * "CCC" project, even though "CCC" includes a module that's processed first

   * if you sort alphabetically by module name (which is the order we see things

   * inside system_rebuild_module_data() for example).

   */

  function testUpdateContribOrder() {

    // We want core to be version 7.0.

    $system_info = array(

      '#all' => array(

        'version' => '7.0',

      ),

      // All the rest should be visible as contrib modules at version 7.x-1.0.

      // aaa_update_test needs to be part of the "CCC Update test" project,

      // which would throw off the report if we weren't properly sorting by

      // the project names.

      'aaa_update_test' => array(

        'project' => 'ccc_update_test',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

      // This should be its own project, and listed first on the report.

      'bbb_update_test' => array(

        'project' => 'bbb_update_test',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

      // This will contain both aaa_update_test and ccc_update_test, and

      // should come after the bbb_update_test project.

      'ccc_update_test' => array(

        'project' => 'ccc_update_test',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

    );

    variable_set('update_test_system_info', $system_info);

    $this->refreshUpdateStatus(array('drupal' => '0', '#all' => '1_0'));

    $this->standardTests();

    // We're expecting the report to say all projects are up to date.

    $this->assertText(t('Up to date'));

    $this->assertNoText(t('Update available'));

    // We want to see all 3 module names listed, since they'll show up either

    // as project names or as modules under the "Includes" listing.

    $this->assertText(t('AAA Update test'));

    $this->assertText(t('BBB Update test'));

    $this->assertText(t('CCC Update test'));

    // We want aaa_update_test included in the ccc_update_test project, not as

    // its own project on the report.

    $this->assertNoRaw(l(t('AAA Update test'), 'http://example.com/project/aaa_update_test'), 'Link to aaa_update_test project does not appear.');

    // The other two should be listed as projects.

    $this->assertRaw(l(t('BBB Update test'), 'http://example.com/project/bbb_update_test'), 'Link to bbb_update_test project appears.');

    $this->assertRaw(l(t('CCC Update test'), 'http://example.com/project/ccc_update_test'), 'Link to bbb_update_test project appears.');

    // We want to make sure we see the BBB project before the CCC project.

    // Instead of just searching for 'BBB Update test' or something, we want

    // to use the full markup that starts the project entry itself, so that

    // we're really testing that the project listings are in the right order.

    $bbb_project_link = '<div class="project"><a href="http://example.com/project/bbb_update_test">BBB Update test</a>';

    $ccc_project_link = '<div class="project"><a href="http://example.com/project/ccc_update_test">CCC Update test</a>';

    $this->assertTrue(strpos($this->drupalGetContent(), $bbb_project_link) < strpos($this->drupalGetContent(), $ccc_project_link), "'BBB Update test' project is listed before the 'CCC Update test' project");

  }

  /**

   * Tests that subthemes are notified about security updates for base themes.

   */

  function testUpdateBaseThemeSecurityUpdate() {

    // Only enable the subtheme, not the base theme.

    db_update('system')

      ->fields(array('status' => 1))

      ->condition('type', 'theme')

      ->condition('name', 'update_test_subtheme')

      ->execute();

    // Define the initial state for core and the subtheme.

    $system_info = array(

      // We want core to be version 7.0.

      '#all' => array(

        'version' => '7.0',

      ),

      // Show the update_test_basetheme

      'update_test_basetheme' => array(

        'project' => 'update_test_basetheme',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

      // Show the update_test_subtheme

      'update_test_subtheme' => array(

        'project' => 'update_test_subtheme',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

    );

    variable_set('update_test_system_info', $system_info);

    $xml_mapping = array(

      'drupal' => '0',

      'update_test_subtheme' => '1_0',

      'update_test_basetheme' => '1_1-sec',

    );

    $this->refreshUpdateStatus($xml_mapping);

    $this->assertText(t('Security update required!'));

    $this->assertRaw(l(t('Update test base theme'), 'http://example.com/project/update_test_basetheme'), 'Link to the Update test base theme project appears.');

  }

  /**

   * Tests that the admin theme is always notified about security updates.

   */

  function testUpdateAdminThemeSecurityUpdate() {

    // Disable the admin theme.

    db_update('system')

      ->fields(array('status' => 0))

      ->condition('type', 'theme')

      ->condition('name', 'update_test_%', 'LIKE')

      ->execute();

    variable_set('admin_theme', 'update_test_admintheme');

    // Define the initial state for core and the themes.

    $system_info = array(

      '#all' => array(

        'version' => '7.0',

      ),

      'update_test_admintheme' => array(

        'project' => 'update_test_admintheme',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

      'update_test_basetheme' => array(

        'project' => 'update_test_basetheme',

        'version' => '7.x-1.1',

        'hidden' => FALSE,

      ),

      'update_test_subtheme' => array(

        'project' => 'update_test_subtheme',

        'version' => '7.x-1.0',

        'hidden' => FALSE,

      ),

    );

    variable_set('update_test_system_info', $system_info);

    variable_set('update_check_disabled', FALSE);

    $xml_mapping = array(

      // This is enough because we don't check the update status of the admin

      // theme. We want to check that the admin theme is included in the list.

      'drupal' => '0',

    );

    $this->refreshUpdateStatus($xml_mapping);

    // The admin theme is displayed even if it's disabled.

    $this->assertText('update_test_admintheme', "The admin theme is checked for update even if it's disabled");

    // The other disabled themes are not displayed.

    $this->assertNoText('update_test_basetheme', 'Disabled theme is not checked for update in the list.');

    $this->assertNoText('update_test_subtheme', 'Disabled theme is not checked for update in the list.');

  }

  /**

   * Tests that disabled themes are only shown when desired.

   */

  function testUpdateShowDisabledThemes() {

    // Make sure all the update_test_* themes are disabled.

    db_update('system')

      ->fields(array('status' => 0))

      ->condition('type', 'theme')

      ->condition('name', 'update_test_%', 'LIKE')

      ->execute();

    // Define the initial state for core and the test contrib themes.

    $system_info = array(

      // We want core to be version 7.0.

      '#all' => array(

        'version' => '7.0',