You are here

Home » API reference » Backup and Migrate 7.3 » BmTestBase.test

abstract class BmTestBase in Backup and Migrate 7.3

Base class for testing a module's custom tags.

Hierarchy

Expanded class hierarchy of BmTestBase

File

tests/BmTestBase.test, line 11
Shared functionality to make the rest of the tests simpler.

View source 
abstract class BmTestBase extends DrupalWebTestCase {

  /**
   * {@inheritdoc}
   */
  public function setUp(array $modules = array()) {
    $modules[] = 'backup_migrate';
    parent::setUp($modules);
  }

  /**
   * Log in as user 1.
   *
   * The benefit of doing this is that it ignores permissions entirely, so the
   * raw functionality can be tested.
   */
  protected function loginUser1() {

    // Load user 1.
    $account = user_load(1, TRUE);

    // Reset the password.
    $password = user_password();
    $edit = array(
      'pass' => $password,
    );
    user_save($account, $edit);
    $account->pass_raw = $password;

    // Login.
    $this
      ->drupalLogin($account);
  }

  /**
   * {@inheritdoc}
   */
  protected function verbose($message, $title = NULL) {

    // Handle arrays, objects, etc.
    if (!is_string($message)) {
      $message = "<pre>\n" . print_r($message, TRUE) . "\n</pre>\n";
    }

    // Optional title to go before the output.
    if (!empty($title)) {
      $title = '<h2>' . check_plain($title) . "</h2>\n";
    }
    parent::verbose($title . $message);
  }

  /**
   * Confirm that a selector has the expected items.
   */
  protected function assertSelectOptions($select_id, array $options, $message = '') {
    $elements = $this
      ->xpath('//select[@id=:id]//option', array(
      ':id' => $select_id,
    ));
    $results = $this
      ->assertEqual(count($elements), count($options), t('The same number of items were found as were requested'));
    $this
      ->verbose($elements);
    foreach ($options as $option) {
      $elements = $this
        ->xpath('//select[@id=:id]//option[@value=:option]', array(
        ':id' => $select_id,
        ':option' => $option,
      ));
      $this
        ->verbose($elements);
      $results *= $this
        ->assertTrue(isset($elements[0]), $message ? $message : t('Option @option for field @id is present.', array(
        '@option' => $option,
        '@id' => $select_id,
      )), t('Browser'));
    }
    return $results;
  }

  /**
   * Confirm that a specific selector does not have items selected.
   */
  protected function assertNoOptionsSelected($id, $message = '') {
    $elements = $this
      ->xpath('//select[@id=:id]//option[@selected="selected"]', array(
      ':id' => $id,
    ));
    return $this
      ->assertTrue(!isset($elements[0]), $message ? $message : t('Field @id does not have any selected items.', array(
      '@id' => $id,
    )), t('Browser'));
  }

  /**
   * Work out which compressor systems are supported by PHP.
   *
   * @return array
   *   The list of supported compressors. Will always include the item 'none'.
   */
  protected function supportedCompressors() {
    $items = array(
      'none',
    );

    // Work out which systems are supported.
    if (@function_exists("gzencode")) {
      $items[] = 'gzip';
    }
    if (@function_exists("bzcompress")) {
      $items[] = 'bzip';
    }
    if (class_exists('ZipArchive')) {
      $items[] = 'zip';
    }
    return $items;
  }

  /**
   * Get a list of the files in a specific destination.
   *
   * @param string $destination_id
   *   The ID of the destination to check. Defaults to the manual file path.
   *
   * @return array
   *   The backup files found in the requested backup destination.
   */
  protected function listBackupFiles($destination_id = 'manual') {
    require_once dirname(__FILE__) . '/../includes/destinations.inc';
    $items = array();

    // Load the destination object.
    $destination = backup_migrate_get_destination($destination_id);
    if (!empty($destination)) {
      $items = $destination
        ->list_files();
    }
    return $items;
  }

  /**
   * Run a specific backup.
   *
   * @param string $destination_id
   *   The ID of the destination to check. Defaults to the manual file path.
   * @param string $source_id
   *   The ID of the source to check. Defaults to the database.
   */
  protected function runBackup($destination_id = 'manual', $source_id = 'db') {
    $this
      ->drupalGet(BACKUP_MIGRATE_MENU_PATH);
    $this
      ->assertResponse(200);
    $edit = array(
      'destination_id' => $destination_id,
      'source_id' => $source_id,
    );
    $this
      ->drupalPost(NULL, $edit, 'Backup now');
    $this
      ->assertResponse(200);

    // Confirm the response is as expected. This is split up into separate
    // pieces because it'd be more effort than is necessary right now to confirm
    // what the exact filename is.
    if ($source_id === 'db') {
      $this
        ->assertText('Default Database backed up successfully');
    }
    else {
      $this
        ->assertText(' backed up successfully');
    }
    $this
      ->assertText('in destination');
    if ($source_id === 'db') {
      $this
        ->assertLink('download');
      $this
        ->assertLink('restore');
      $this
        ->assertLink('delete');
    }
  }

  /**
   * Delete all of the files in a specific backup destination.
   *
   * @param string $destination_id
   *   The ID of the destination to check. Defaults to the manual file path.
   */
  protected function deleteBackups($destination_id = 'manual') {
    $destination = backup_migrate_get_destination($destination_id);
    $files = $this
      ->listBackupFiles($destination_id);
    if (!empty($files)) {
      foreach ($files as $file_id => $file) {
        $destination
          ->delete_file($file_id);
      }
    }
  }

  /**
   * Work out whether a backup filename includes a timestamp.
   *
   * @param object $file
   *   The backup file to examine.
   *
   * @return mixed
   *   Returns 1 if found, 0 if not found, FALSE if an error occurs.
   */
  protected function fileHasTimestamp($file) {
    require_once dirname(__FILE__) . '/../includes/files.inc';

    // Get the default filename, this is used later.
    $default_filename = _backup_migrate_default_filename();
    $ext = implode('.', $file->ext);
    $pattern = "/{$default_filename}-(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d)-(\\d\\d)-(\\d\\d).{$ext}/";
    return preg_match($pattern, $file->file_info['filename']);
  }

  /**
   * Confirm that a backup filename includes a timestamp.
   *
   * @param object $file
   *   The backup file to examine.
   *
   * @return bool
   *   Indicates whether the file includes a timestamp.
   */
  protected function assertFileTimestamp($file) {
    return $this
      ->assertTrue($this
      ->fileHasTimestamp($file));
  }

  /**
   * Confirm that a backup filename does not include a timestamp.
   *
   * @param object $file
   *   The backup file to examine.
   *
   * @return bool
   *   Indicates whether the file does not include a timestamp.
   */
  protected function assertNoFileTimestamp($file) {
    return !$this
      ->assertFalse($this
      ->fileHasTimestamp($file));
  }

  /**
   * Get a profile.
   *
   * @param string $profile_id
   *   The name of the profile to load. Defaults to 'default'.
   *
   * @return object
   *   The profile object.
   */
  protected function getProfile($profile_id = 'default') {
    require_once dirname(__FILE__) . '/../includes/profiles.inc';
    return backup_migrate_get_profile($profile_id);
  }

  /**
   * Confirm the most recently sent e-mail(s) contain the expected string.
   *
   * @param string $field_name
   *   Name of field or message property to assert: subject, body, id, etc.
   * @param string $string
   *   String to search for.
   * @param int $expected
   *   Number of times $string should occur in the field.
   * @param int $email_depth
   *   Number of emails to search for string, starting with most recent.
   *
   * @return bool
   *   TRUE on pass, FALSE on fail.
   *
   * @see DrupalWebTestCase::assertMailString()
   */
  protected function assertMailStringCount($field_name, $string, $expected, $email_depth) {
    $mails = $this
      ->drupalGetMails();
    $number_of_mails = count($mails);
    $string_count = 0;
    for ($i = $number_of_mails - 1; $i >= $number_of_mails - $email_depth && $i >= 0; $i--) {
      $mail = $mails[$i];

      // Normalize whitespace, as it isn't eacy to know what the mail system
      // might have done. Any run of whitespace becomes a single space.
      $normalized_mail = preg_replace('/\\s+/', ' ', $mail[$field_name]);
      $normalized_string = preg_replace('/\\s+/', ' ', $string);
      $string_count += substr_count($normalized_mail, $normalized_string);
    }
    $mail_count = min($number_of_mails, $email_depth);
    $message = format_plural($mail_count, 'Text "@needle" was found @stringcount times in field "@field" of the most recent email message.', 'Text "@needle" was found @stringcount times in field "@field" of the @mailcount most recent email messages.', array(
      '@needle' => $string,
      '@stringcount' => $string_count,
      '@field' => $field_name,
      '@mailcount' => $mail_count,
    ));
    return $this
      ->assertTrue($string_count === $expected, $message);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BmTestBase::assertFileTimestamp protected function Confirm that a backup filename includes a timestamp.
BmTestBase::assertMailStringCount protected function Confirm the most recently sent e-mail(s) contain the expected string.
BmTestBase::assertNoFileTimestamp protected function Confirm that a backup filename does not include a timestamp.
BmTestBase::assertNoOptionsSelected protected function Confirm that a specific selector does not have items selected.
BmTestBase::assertSelectOptions protected function Confirm that a selector has the expected items.
BmTestBase::deleteBackups protected function Delete all of the files in a specific backup destination.
BmTestBase::fileHasTimestamp protected function Work out whether a backup filename includes a timestamp.
BmTestBase::getProfile protected function Get a profile.
BmTestBase::listBackupFiles protected function Get a list of the files in a specific destination.
BmTestBase::loginUser1 protected function Log in as user 1.
BmTestBase::runBackup protected function Run a specific backup.
BmTestBase::setUp public function Sets up a Drupal site for running functional and integration tests. Overrides DrupalWebTestCase::setUp 5
BmTestBase::supportedCompressors protected function Work out which compressor systems are supported by PHP.
BmTestBase::verbose protected function Logs a verbose message in a text file. Overrides DrupalTestCase::verbose
DrupalTestCase::$assertions protected property Assertions thrown in that test case.
DrupalTestCase::$databasePrefix protected property The database prefix of this test run.
DrupalTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
DrupalTestCase::$results public property Current results of this test case.
DrupalTestCase::$setup protected property Flag to indicate whether the test has been set up.
DrupalTestCase::$setupDatabasePrefix protected property
DrupalTestCase::$setupEnvironment protected property
DrupalTestCase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
DrupalTestCase::$testId protected property The test run ID.
DrupalTestCase::$timeLimit protected property Time limit for the test.
DrupalTestCase::$useSetupInstallationCache public property Whether to cache the installation part of the setUp() method.
DrupalTestCase::$useSetupModulesCache public property Whether to cache the modules installation part of the setUp() method.
DrupalTestCase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
DrupalTestCase::assert protected function Internal helper: stores the assert.
DrupalTestCase::assertEqual protected function Check to see if two values are equal.
DrupalTestCase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdentical protected function Check to see if two values are identical.
DrupalTestCase::assertNotEqual protected function Check to see if two values are not equal.
DrupalTestCase::assertNotIdentical protected function Check to see if two values are not identical.
DrupalTestCase::assertNotNull protected function Check to see if a value is not NULL.
DrupalTestCase::assertNull protected function Check to see if a value is NULL.
DrupalTestCase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssert public static function Delete an assertion record by message ID.
DrupalTestCase::error protected function Fire an error assertion. 1
DrupalTestCase::errorHandler public function Handle errors during test runs. 1
DrupalTestCase::exceptionHandler protected function Handle exceptions.
DrupalTestCase::fail protected function Fire an assertion that is always negative.
DrupalTestCase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
DrupalTestCase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
DrupalTestCase::insertAssert public static function Store an assertion from outside the testing context.
DrupalTestCase::pass protected function Fire an assertion that is always positive.
DrupalTestCase::randomName public static function Generates a random string containing letters and numbers.
DrupalTestCase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::run public function Run all tests in this class.
DrupalWebTestCase::$additionalCurlOptions protected property Additional cURL options.
DrupalWebTestCase::$content protected property The content of the page currently loaded in the internal browser.
DrupalWebTestCase::$cookieFile protected property The current cookie file used by cURL.
DrupalWebTestCase::$cookies protected property The cookies of the page currently loaded in the internal browser.
DrupalWebTestCase::$curlHandle protected property The handle of the current cURL connection.
DrupalWebTestCase::$drupalSettings protected property The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
DrupalWebTestCase::$elements protected property The parsed version of the page.
DrupalWebTestCase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
DrupalWebTestCase::$headers protected property The headers of the page currently loaded in the internal browser.
DrupalWebTestCase::$httpauth_credentials protected property HTTP authentication credentials (<username>:<password>).
DrupalWebTestCase::$httpauth_method protected property HTTP authentication method
DrupalWebTestCase::$loggedInUser protected property The current user logged in using the internal browser.
DrupalWebTestCase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing purposes.
DrupalWebTestCase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing purposes.
DrupalWebTestCase::$plainTextContent protected property The content of the page currently loaded in the internal browser (plain text version).
DrupalWebTestCase::$profile protected property The profile to install as a basis for testing. 20
DrupalWebTestCase::$redirect_count protected property The number of redirects followed during the handling of a request.
DrupalWebTestCase::$session_id protected property The current session ID, if available.
DrupalWebTestCase::$session_name protected property The current session name, if available.
DrupalWebTestCase::$url protected property The URL currently loaded in the internal browser.
DrupalWebTestCase::assertField protected function Asserts that a field exists with the given name or ID.
DrupalWebTestCase::assertFieldById protected function Asserts that a field exists in the current page with the given ID and value.
DrupalWebTestCase::assertFieldByName protected function Asserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLink protected function Pass if a link with the specified label is found, and optional with the specified index.
DrupalWebTestCase::assertLinkByHref protected function Pass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMail protected function Asserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPattern protected function Asserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailString protected function Asserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoField protected function Asserts that a field does not exist with the given name or ID.
DrupalWebTestCase::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
DrupalWebTestCase::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPath protected function Asserts that a field doesn't exist or its value doesn't match, by XPath.
DrupalWebTestCase::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLink protected function Pass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHref protected function Pass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPattern protected function Will trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRaw protected function Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertNoResponse protected function Asserts the page did not return the specified response code.
DrupalWebTestCase::assertNoText protected function Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertNoTitle protected function Pass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueText protected function Pass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelected protected function Asserts that a select option in the current page is checked.
DrupalWebTestCase::assertPattern protected function Will trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRaw protected function Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponse protected function Asserts the page responds with the specified response code.
DrupalWebTestCase::assertText protected function Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertTextHelper protected function Helper for assertText and assertNoText.
DrupalWebTestCase::assertThemeOutput protected function Asserts themed output.
DrupalWebTestCase::assertTitle protected function Pass if the page title is the given string.
DrupalWebTestCase::assertUniqueText protected function Pass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrl protected function Pass if the internal browser's URL matches the given path.
DrupalWebTestCase::buildXPathQuery protected function Builds an XPath query.
DrupalWebTestCase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
DrupalWebTestCase::checkForMetaRefresh protected function Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
DrupalWebTestCase::checkPermissions protected function Check to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLink protected function Follows a link by name.
DrupalWebTestCase::constructFieldXpath protected function Helper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::copySetupCache protected function Copy the setup cache from/to another table and files directory.
DrupalWebTestCase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlClose protected function Close the cURL handler and unset the handler.
DrupalWebTestCase::curlExec protected function Initializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitialize protected function Initializes the cURL connection.
DrupalWebTestCase::drupalCompareFiles protected function Compare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentType protected function Creates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNode protected function Creates a node based on default settings.
DrupalWebTestCase::drupalCreateRole protected function Creates a role with specified permissions.
DrupalWebTestCase::drupalCreateUser protected function Create a user with a given set of permissions.
DrupalWebTestCase::drupalGet protected function Retrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAX protected function Retrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContent protected function Gets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeader protected function Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed…
DrupalWebTestCase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the…
DrupalWebTestCase::drupalGetMails protected function Gets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitle function Get a node from the database based on its title.
DrupalWebTestCase::drupalGetSettings protected function Gets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFiles protected function Get a list files that can be used in tests.
DrupalWebTestCase::drupalGetToken protected function Generate a token for the currently logged in user.
DrupalWebTestCase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLogin protected function Log in a user with the internal browser.
DrupalWebTestCase::drupalLogout protected function
DrupalWebTestCase::drupalPost protected function Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAX protected function Execute an Ajax submission.
DrupalWebTestCase::drupalSetContent protected function Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page.
DrupalWebTestCase::drupalSetSettings protected function Sets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
DrupalWebTestCase::getAllOptions protected function Get all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItem protected function Get the selected value from a select field.
DrupalWebTestCase::getSetupCacheKey protected function Returns the cache key used for the setup caching.
DrupalWebTestCase::getUrl protected function Get the current URL from the cURL handler.
DrupalWebTestCase::handleForm protected function Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type.
DrupalWebTestCase::loadSetupCache protected function Copies the cached tables and files for a cached installation setup.
DrupalWebTestCase::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistry protected function Preload the registry from the testing site.
DrupalWebTestCase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
DrupalWebTestCase::prepareEnvironment protected function Prepares the current environment for running the test.
DrupalWebTestCase::recursiveDirectoryCopy protected function Recursively copy one directory to another.
DrupalWebTestCase::refreshVariables protected function Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread. 1
DrupalWebTestCase::resetAll protected function Reset all data structures after having enabled new modules.
DrupalWebTestCase::storeSetupCache protected function Store the installation setup to a cache.
DrupalWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. 6
DrupalWebTestCase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpath protected function Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page.
DrupalWebTestCase::__construct function Constructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct 1