modules/country_code/country_code.test

<?php
// $Id: country_code.test,v 1.25 2008/11/13 12:16:37 snpower Exp $

/**
 * @file
 * Test file for the country code module.
 */

class CountryCodeTestCase extends DrupalWebTestCase {

  /**
   * Implementation of getInfo().
   */
  function getInfo() {
    return array(
      'name' => t('Country code'),
      'description' => t('Test functionality of the country code module.'),
      'group' => t('Country code')
    );
  }

  /**
   * Implementation of setUp().
   */
  function setUp() {
    parent::setUp('locale', 'translation', 'site_country', 'country_code');
    $this->admin_user = $admin_user = $this->drupalCreateUser(array('administer languages', 'administer content types', 'administer site configuration', 'access administration pages', 'administer blocks'));
    $this->translator = $translator = $this->drupalCreateUser(array('create story content', 'edit own story content', 'translate content'));
    $this->visitor = $visitor = $this->drupalCreateUser();
    $this->drupalLogin($this->admin_user);
    $this->addLanguage('fr');
    // Set the default country - note, this also adds it!
    variable_set('site_country_default_country', 'ie');
  }

  /**
   * Implementation of tearDown().
   */
  function tearDown() {
    $this->removeLanguage('fr');
    $this->removeCountries(TRUE);
    parent::tearDown();
  }

  /**
   * Test adding, deleting and updating of countries.
   */
  function testCountryCodeCountryAdmin() {
    // Log in the admin user and visit the country code main settings page.
    $this->drupalGet('admin/settings/country-code/configure');
    $this->assertResponse(200, t('Admin user has access to country code settings.'));

    // Visit the country code settings pages.
    $this->drupalGet('admin/settings/country-code');
    $this->assertResponse(200, t('Admin user has access to country code settings.'));

    // Ensure 'ie' country is present, is enabled and is the default.
    // This is the country set in the setUp() as the site default.
    $this->assertText(t('Ireland'));
    $country = country_code_country_load('ie');
    $this->assertTrue($country['country'] == 'ie', t('Site default country is present in country_code_country table.'));
    $this->assertTrue($country['enabled'] == 1, t('Site default country is enabled.'));
    $this->assertTrue(variable_get('site_country_default_country', '') == 'ie', t('Site default country is set correctly.'));


    // Add countries.
    $this->clickLink(t('Add country'));
    $this->assertResponse('200', t('Admin user has access to add countries.'));

    $this->addCountry('ca', TRUE);
    $this->addCountry('us');
    $this->addCountry('fr', FALSE); // Add a disabled country.

    // Check we can enable and disable the country 'France' via the overview
    // page.
    $this->changeCountryStatus('fr', TRUE); // Enable it.
    $this->changeCountryStatus('fr', FALSE); // Disable it.

    // Check we can change the default country via the overview page.
    $this->changeDefaultCountry('us');
    // Try to disable a default country.
    $this->changeCountryStatus('us', FALSE, TRUE);

    // Check we can enable and disable the country 'France' via the edit page.
    $this->drupalGet('admin/settings/country-code-country/fr');
    $this->assertResponse(200, t('Admin user has access to edit country code settings.'));
    $this->drupalPost(NULL, array('enabled' => 1), t('Save'));
    $country = country_code_country_load('fr');
    $this->assertTrue($country['enabled'] == 1, t('Country successfully enabled.'));

    $this->drupalGet('admin/settings/country-code-country/fr');
    $this->drupalPost(NULL, array('enabled' => FALSE), t('Save'));
    $country = country_code_country_load('fr');
    $this->assertTrue($country['enabled'] == 0, t('Country successfully disabled.'));

    // Check we can remove a country.
    $this->removeCountry('fr');
  }


  /**
   * Test the main country code configuration page.
   *
   * Tests for changing default user's country/language option have been moved
   * to testUserEditForm().
   * TODO: split this up so we're also testing the functionality.
   */
  function testCountryCodeGeneralAdmin() {
    // Test changing of fallback country.
    $this->changeCountryFallback('default');
    $this->changeCountryFallback('xx');

    // Test changing of country by path option.
    $this->changeCountryPathOption(1);
    $this->changeCountryPathOption(0);

    // Test changing of user's browser language option.
    $this->changeUserBrowserLanguageOption(0);
    $this->changeUserBrowserLanguageOption(1);

    // Test changing of translation links on node option.
    $this->changeNodeTranslationLinksOption(0);
    $this->changeNodeTranslationLinksOption(1);
  }

  /**
   * Test user default country settings.
   */
  function testUserDefaultCountry() {

    // Enable countries and languages.
    $this->changeUserDefaultCountryOption(1);
    $this->addCountry('ca');
    $this->addCountry('us');
    $this->addLanguage('es');
    $this->addCountryLanguage('en', 'ca');
    $this->addCountryLanguage('fr', 'ca');
    $this->addCountryLanguage('en', 'us');
    $this->addCountryLanguage('es', 'us');

    // Enable the language switcher block.
    $this->drupalGet('admin/build/block');
    $this->assertText(t('Language switcher'));
    $edit = array();
    $edit['locale_0[region]'] = 'left';
    $this->drupalPost('admin/build/block', $edit, t('Save blocks'));
    $this->assertText(t('The block settings have been updated.'), t('Language switcher block successfully moved to left region.'));

    // The language switcher block doesn't show up without path negotiation.
    $edit = array();
    $edit['language_negotiation'] = 15;
    $this->drupalPost('admin/settings/language/configure', $edit, t('Save settings'));

    // Visit the front page with no country set, ensure all languages are available.
    $this->drupalGet('node');
    $this->assertText(t('English'), t('English found in language switcher block'));
    $this->assertNoText(t('English (us)'), t('US English not found in language switcher block'));
    $this->assertText(t('Français'), t('French found in language switcher block'));
    $this->assertNoText(t('Français (ca)'), t('Canadian French not found in language switcher block'));
    $this->assertText(t('Español'), t('Spanish found in language switcher block'));

    // Change the user country default to Canada.
    $this->drupalGet('user/' . $this->admin_user->uid . '/edit');

    $edit = array();
    $edit['country_code'] = 'ca';
    $this->drupalPost('user/' . $this->admin_user->uid . '/edit', $edit, t('Save'));

    // Assert that languages for Canada appear. And that languages for other
    // countries don't appear.

    $this->drupalGet('node');
    $this->assertText(t('English'), t('English found in language switcher block.'));
    $this->assertNoText(t('English (ca)'), t('Canadian English not found in Language switcher block.'));
    $this->assertNoText(t('English (us)'), t('US English not found in language switcher block.'));
    $this->assertText(t('Français'), t('French found in language switcher block.'));
    $this->assertNoText(t('Français (ca)'), t('Canadian French not found in language switcher block.'));
    $this->assertNoText(t('Español'), t('Spanish not found in language switcher block.'));
  }

  /**
   * Enable three countries, then assign languages to those countries.
   */
  function testCountryLanguages() {
    // Add countries.
    $this->addCountry('ca');
    $this->addCountry('us');
    $this->addCountry('fr', FALSE); // Add a disabled country.

    // Enable English for Canada.
    $this->addCountryLanguage('en', 'ca');

    // Enable French for Canada.
    $this->addCountryLanguage('fr', 'ca');

    // Enable English for United States.
    $this->addCountryLanguage('en', 'us');

    // Enable French for France, so we can check disabled countries can still
    // have languages added.
    $this->addCountryLanguage('fr', 'fr');

    // Set Story content type to use multilingual support with translation.
    $this->drupalGet('admin/content/node-type/story');
    $edit = array();
    $edit['language_content_type'] = 2;

    $this->drupalPost('admin/content/node-type/story', $edit, t('Save content type'));
    $this->assertRaw(t('The content type %type has been updated.', array('%type' => 'Story')), t('Story content type has been updated.'));
  }

  /**
   * Test country switcher block.
   */
  function testCountrySwitcherBlock() {
    // Add a some countries.
    $this->addCountry('ca');
    $this->addCountry('us');

    // Get list of enabled countries.
    $countries = country_code_countries(TRUE, TRUE);

    // Visit the block administration page.
    $this->drupalGet('admin/build/block');
    $this->assertResponse(200, t('Admin user has access to block configuration page.'));

    // Ensure 'country switcher' block appears and enable it.
    $this->assertRaw(t('Country switcher'), t('Country switcher block installed.'));
    $edit = array();
    $edit['country_code_0[region]'] = 'left';
    $this->drupalPost('admin/build/block', $edit, t('Save blocks'));
    $this->assertText(t('The block settings have been updated.'), t('Country switcher block successfully moved to left region.'));

    // Ensure countries appear in the block.
    $this->assertRaw('href="' . url('ca/admin/build/block') . '"', t('Country switcher block visible.'));

    // Ensure we can switch countries.
    $this->clickLink($countries['ca']->name);

    // Check the URL to confirm.
    $this->assertTrue(strpos($this->getURL(), 'ca/admin/build/block') == TRUE, t('Switched countries successfully.'));

    // Ensure we can switch again.  Need a second switch to ensure we weren't
    // previously viewing the page with the other country set.
    $this->clickLink($countries['us']->name);

    // Check the URL to confirm.
    $this->assertTrue(strpos($this->getURL(), 'us/admin/build/block') == TRUE, t('Switched countries successfully.'));
  }

  /**
   * Test changes to user edit form.
   *
   * TODO: check user default country / language options actually work.
   */
  function testUserEditForm() {
    // Add some countries and languages.
    $this->addCountry('ca');
    $this->addCountry('us');
    $this->addCountryLanguage('en', 'ca');
    $this->addCountryLanguage('fr', 'ca');
    $this->addCountryLanguage('en', 'us');

    // Visit the user settings page.
    $this->drupalGet('user/' . $this->admin_user->uid . '/edit');
    $this->assertResponse(200, t('User can edit their profile.'));

    // Ensure language selection appears by default, and country doesn't.
    $this->assertRaw('<fieldset><legend>Language settings</legend>', t('Language settings appear by default.'));
    $this->assertNoRaw('<fieldset><legend>Country settings</legend>', t("Country settings don't appear by default."));

    // Enable country setting and ensure user can modify their default country.
    $this->changeUserDefaultCountryOption(1); // Enable country option.
    $this->drupalGet('user/' . $this->admin_user->uid . '/edit');
    $this->assertRaw('<fieldset><legend>Country settings</legend>', t('Country settings appear.'));

    // Change user's default country.
    $this->changeUserDefaultCountry($this->admin_user, 'xx');
    $this->changeUserDefaultCountry($this->admin_user, 'ca');

    // Change user's default language - need 2 separate posts as Canadian
    // langauges not available until default country has changed.
    $this->changeUserDefaultLanguage($this->admin_user, 'fr-ca');

    // Disable language option and ensure it doesn't appear on the user edit
    // profile form.
    $this->changeUserDefaultLanguageOption(0); // Disable language option.
    $this->drupalGet('user/' . $this->admin_user->uid . '/edit');
    $this->assertNoRaw('<fieldset><legend>Language settings</legend>', t("Language settings don't appear."));

    // Restore language / country settings.
    $this->changeUserDefaultCountryOption(0); // Disable country option.
    $this->changeUserDefaultLanguageOption(1); // Enable language option.
    $this->drupalGet('user/' . $this->admin_user->uid . '/edit');
    $this->assertRaw('<fieldset><legend>Language settings</legend>', t('Language settings appear.'));
    $this->assertNoRaw('<fieldset><legend>Country settings</legend>', t("Country settings don't appear."));
  }

  /**
   * Enable a country.
   *
   * @param $country_code
   *   A two digit country code.
   * @param $enable_country
   *   Whether or not the country should be enabled.
   */
  function addCountry($country_code, $enable_country = TRUE) {
    $edit = array();
    $edit['country'] = $country_code;
    $edit['enabled'] = $enable_country;
    $this->drupalPost('admin/settings/country-code/add', $edit, t('Add country'));

    // Load the country from the database.
    $country = country_code_country_load($country_code);
    $this->assertTrue($country['country'] == $country_code, t('Country code returned from database.'));
    $this->drupalGet('admin/settings/country-code');
    $this->assertText($country['name'], t('Country is displayed in overview.'));
    $this->assertTrue($country['enabled'] == $enable_country, t('Country status set successfully.'));
  }

  /**
   * Enable a country language.
   *
   * @param $language_code
   *   A two digit language code.
   * @param $country_code
   *   A two digit country code.
   * @param $create_country_language
   *   Whether or not a new country language should be created.
   */
  function addCountryLanguage($language_code, $country_code, $create_country_language = TRUE) {
    $edit = array();
    $edit['language'] = $language_code;
    $this->drupalPost('admin/settings/country-code-country/' . $country_code . '/languages/add', $edit, t('Add language'));
    $country_language = $language_code . '-' . $country_code;
    $this->assertTrue(country_code_language_exists($country_language), t('New country-language was enabled.'));
  }

  /**
   * Enable the specified language if it has not been already.
   *
   * @param string $language_code
   *   The language code to enable.
   */
  function addLanguage($language_code) {
    // Check to make sure that language has not already been installed.
    $this->drupalGet('admin/settings/language');

    if (strpos($this->drupalGetContent(), 'enabled[' . $language_code . ']') === FALSE) {
      // Doesn't have language installed so add it.
      $edit = array();
      $edit['langcode'] = $language_code;
      $this->drupalPost('admin/settings/language/add', $edit, t('Add language'));

      $languages = language_list('language', TRUE); // Make sure not using cached version.
      $this->assertTrue(array_key_exists($language_code, $languages), t('Language was installed successfully.'));

      if (array_key_exists($language_code, $languages)) {
        $this->assertRaw(t('The language %language has been created and can now be used.', array('%language' => $languages[$language_code]->name)), t('Language has been created.'));
      }
    }
    else {
      // Ensure that it is enabled.
      $this->drupalPost(NULL, array('enabled[' . $language_code . ']' => TRUE), t('Save configuration'));

      $this->assertRaw(t('Configuration saved.'), t('Language %language successfully enabled.', array('%language' => $language_code)));
    }
  }

  /**
   * Disable the specified language if it has not been already.
   *
   * @param string $language_code
   *   The language code to disable.
   */
  function disableLanguage($language_code) {
    // Check to make sure that language has not already been removed.
    $this->drupalGet('admin/settings/language');

    if (strpos($this->drupalGetContent(), 'enabled[' . $language_code . ']') == TRUE) {
      // Language is installed, so disable it.
      $this->drupalPost(NULL, array('enabled[' . $language_code . ']' => FALSE), t('Save configuration'));
      $this->assertRaw(t('Configuration saved.'), t('Language %language successfully disabled.', array('%language' => $language_code)));
    }
  }

  /**
   * Remove the specified language if it has not been already.
   *
   * @param string $language_code
   *   The language code to remove.
   */
  function removeLanguage($language_code) {
    // Check to make sure that language has not already been removed.
    $this->drupalGet('admin/settings/language');

    // Check if we can disable the language first.
    $this->disableLanguage($language_code);

    if (strpos($this->drupalGetContent(), 'enabled[' . $language_code . ']') == TRUE) {
      $languages = language_list('language', TRUE); // Make sure not using cached version.
      $this->drupalGet('admin/settings/language/delete/' . $language_code);
      $this->drupalPost(NULL, array(), t('Delete'));
      $this->assertRaw(t('The language %language has been removed.', array('%language' => $languages[$language_code]->name)), t('Language %language successfully deleted.', array('%language' => $languages[$language_code]->name)));
    }
  }

  /**
   * Change the status of the specified country.
   *
   * @param string $country_code
   *   The country code to disable.
   * @param string $status
   *   The country's new status.
   * @param string $default
   *   Whether or not the country is the default country.
   */
  function changeCountryStatus($country_code, $status, $default = FALSE) {
    // Check to make sure that country exists.
    $this->drupalGet('admin/settings/country-code');
    if (strpos($this->drupalGetContent(), 'enabled[' . $country_code . ']') == TRUE) {
      $this->drupalPost(NULL, array('enabled[' . $country_code . ']' => $status), t('Save configuration'));
      $country = country_code_country_load($country_code);
      if ($default) {
        $this->assertTrue($country['enabled'] == 1, $status ? t('Country %country successfully enabled.', array('%country' => $country['name'])) : t('Country %country successfully not disabled.', array('%country' => $country['name'])));
      }
      else {
        $this->assertTrue($country['enabled'] == $status, $status ? t('Country %country successfully enabled.', array('%country' => $country['name'])) : t('Country %country successfully disabled.', array('%country' => $country['name'])));
      }
    }
  }

  /**
   * Change the default country to be the specified country.
   *
   * @param string $country_code
   *   The country code to make the default.
   */
  function changeDefaultCountry($country_code) {
    // Check to make sure that country exists.
    $this->drupalGet('admin/settings/country-code');
    if (strpos($this->drupalGetContent(), 'enabled[' . $country_code . ']') == TRUE) {
      $this->drupalPost(NULL, array('site_default' => $country_code), t('Save configuration'));
      $this->assertRaw('name="site_default" value="' . $country_code . '"  checked="checked"', t('Default country successfully set to %country.', array('%country' => $country_code)));
    }
  }


  /**
   * Remove the specified country if it has not been already.
   *
   * @param string $country_code
   *   The country code to remove.
   * @param string $force
   *   Force removal of all countries for tearDown().
   */
  function removeCountry($country_code, $force = FALSE) {
    // Check to make sure that country has not already been removed.
    $this->drupalGet('admin/settings/country-code');

    if (strpos($this->drupalGetContent(), 'enabled[' . $country_code . ']') == TRUE) {
      $country_count = count(country_code_countries(FALSE, TRUE));
      $country = country_code_country_load($country_code);
      $this->drupalGet('admin/settings/country-code/delete/' . $country_code);
      $this->drupalPost(NULL, array(), t('Delete'));
      if ($country_count == 1) {
        $this->assertRaw(t('The country %country could not be removed as it is the default and last country.', array('%country' => $country['name'])), t('Country %country successfully not deleted.', array('%country' => $country_code)));
        if ($force) {
          db_query('DELETE FROM {country_code_country}');
        }
      }
      else {
        $this->assertRaw(t('The country %country has been removed.', array('%country' => $country['name'])), t('Country %country successfully deleted.', array('%country' => $country_code)));
      }
    }
  }

  /**
   * Remove all the configured countries.
   *
   * @param string $force
   *   Force removal of all countries for tearDown().
   */
  function removeCountries($force = FALSE) {
    // Get list of all configured countries.
    $countries = country_code_countries(TRUE);
    foreach ($countries as $country_code => $country) {
      $this->removeCountry($country_code, $force);
    }
  }


  /**
   * Change the country fallback option.
   *
   * @param string $fallback
   *   'xx' for Global, 'default' for Default country.
   */
  function changeCountryFallback($fallback) {
    $this->drupalGet('admin/settings/country-code/configure');
    $this->drupalPost(NULL, array('country_code_fallback' => $fallback), t('Save configuration'));
    $current_setting = variable_get('country_code_fallback', 'xx');
    $this->assertTrue($current_setting == $fallback, t('Country fallback option changed successfully.'));
  }

  /**
   * Change the user default country option.
   *
   * @param string $enabled
   *   Whether or not the user can specify a default country in their account.
   */
  function changeUserDefaultCountryOption($enabled) {
    $this->drupalGet('admin/settings/country-code/configure');
    $this->drupalPost(NULL, array('country_code_user_country' => $enabled), t('Save configuration'));
    $current_setting = variable_get('country_code_user_country', 0);
    $this->assertTrue($current_setting == $enabled, $enabled ? t('User default country option successfully enabled.') : t('User default country option successfully disabled.'));
  }

  /**
   * Set the country by path for initial or external links.
   *
   * @param string $enabled
   *   Whether or not this feature is enabled.
   */
  function changeCountryPathOption($enabled) {
    $this->drupalGet('admin/settings/country-code/configure');
    $this->drupalPost(NULL, array('country_code_external' => $enabled), t('Save configuration'));
    $current_setting = variable_get('country_code_external', 0);
    $this->assertTrue($current_setting == $enabled, $enabled ? t('Country by path option successfully enabled.') : t('Country by path option successfully disabled.'));
  }

  /**
   * Change the user default language option.
   *
   * @param string $enabled
   *   Whether or not the user can specify a default language in their account.
   */
  function changeUserDefaultLanguageOption($enabled) {
    $this->drupalGet('admin/settings/country-code/configure');
    $this->drupalPost(NULL, array('country_code_user_language' => $enabled), t('Save configuration'));
    $current_setting = variable_get('country_code_user_language', 1);
    $this->assertTrue($current_setting == $enabled, $enabled ? t('User default language option successfully enabled.') : t('User default language option successfully disabled.'));
  }

  /**
   * Change the user browser language option.
   *
   * @param string $enabled
   *   Whether or not the user's browser language is taken into consideration.
   */
  function changeUserBrowserLanguageOption($enabled) {
    $this->drupalGet('admin/settings/country-code/configure');
    $this->drupalPost(NULL, array('country_code_browser_language' => $enabled), t('Save configuration'));
    $current_setting = variable_get('country_code_browser_language', 1);
    $this->assertTrue($current_setting == $enabled, $enabled ? t('User browser language option successfully enabled.') : t('User browser language option successfully disabled.'));
  }

  /**
   * Control whether or not links to translations appear in the node links.
   *
   * @param string $enabled
   *   Whether or not the translation links appear on nodes.
   */
  function changeNodeTranslationLinksOption($enabled) {
    $this->drupalGet('admin/settings/country-code/configure');
    $this->drupalPost(NULL, array('country_code_node_links' => $enabled), t('Save configuration'));
    $current_setting = variable_get('country_code_node_links', 1);
    $this->assertTrue($current_setting == $enabled, $enabled ? t('Translation links option successfully enabled.') : t('Translation links option successfully disabled.'));
  }

  /**
   * Modify the user's default language.
   *
   * Requires the option to be enabled at admin/settings/country-code/configure
   * @param string $user
   *   The user object to modify.
   * @param string $language
   *   The language code to set.
   */
  function changeUserDefaultLanguage($user, $language) {
    $edit = array();
    $edit['language'] = $language;
    $this->drupalPost('user/' . $user->uid . '/edit', $edit, t('Save'));
    $updated_user = user_load($user->uid);
    $this->assertTrue($updated_user->language == $language, t("User's default language successfully updated to %language.", array('%language' => $language)));
  }

  /**
   * Modify the user's default country.
   *
   * Requires the option to be enabled at admin/settings/country-code/configure
   * @param string $user
   *   The user object to modify.
   * @param string $country_code
   *   The country code to set.
   */
  function changeUserDefaultCountry($user, $country_code) {
    $edit = array();
    $edit['country_code'] = $country_code;
    $this->drupalPost('user/' . $user->uid . '/edit', $edit, t('Save'));
    $updated_user = user_load($user->uid);
    $this->assertTrue($updated_user->country_code == $country_code, t("User's default country successfully updated to %country.", array('%country' => $country_code)));
  }

  /**
   * Create a page in the specified language.
   *
   * @param string $title
   *   Title of page in specified language.
   * @param string $body
   *   Body of page in specified language.
   * @param string $language
   *   Language code.
   */
  function createPage($title, $body, $language) {
    $edit = array();
    $edit['title'] = $title;
    $edit['body'] = $body;
    $edit['language'] = $language;
    $this->drupalPost('node/add/page', $edit, t('Save'));
    $this->assertRaw(t('Page %title has been created.', array('%title' => $edit['title'])), t('Page created.'));

    // Check to make sure the node was created.
    $node = node_load(array('title' => $edit['title']));
    $this->assertTrue($node, t('Node found in database.'));

    return $node;
  }

  /**
   * Create a translation for the specified page in the specified language.
   *
   * @param integer $nid
   *   Node id of page to create translation for.
   * @param string $title
   *   Title of page in specified language.
   * @param string $body
   *   Body of page in specified language.
   * @param string $language
   *    Language code.
   */
  function createTranslation($nid, $title, $body, $language) {
    $this->drupalGet('node/add/page', array('query' => array('translation' => $nid, 'language' => $language)));

    $edit = array();
    $edit['title'] = $title;
    $edit['body'] = $body;
    $this->drupalPost(NULL, $edit, t('Save'));
    $this->assertRaw(t('Page %title has been created.', array('%title' => $edit['title'])), t('Translation created.'));

    // Check to make sure that translation was successful.
    $node = node_load(array('title' => $edit['title']));
    $this->assertTrue($node, t('Node found in database.'));

    return $node;
  }
}